@crvouga/ mockingbird-service-fcm (英语)

本地模拟器。 真正的API合同. 部分 嘲笑鸟。 。 。 .

国家模拟器 Firebase 云传 HTTP v1 发送 API (POST /v1/projects/{project_id}/messages:send),电话 firebase-admin 生产。 项目、出入证和登记证都是固定的。 没有FCM沙盒。 这个软件包是 status: "wip"。 。 。 .

• 行动范围: 支助
• 合同openapi.yaml)取自FCM REST参考文献和Firebase-admin 12.7.0 / 13.5.0.

安装

npm install -D @crvouga/mockingbird-service-fcm

仅限无害环境管理。 节点 22或 Bun 1.2. 无土生属地. 给它服务 npx mockingbird-fcm serve, (中文(简体) ), createServer 从 ./server (节点),或 createRuntime 与任何获取服务器.

使用量

firebase-admin 硬码 https://fcm.googleapis.com。将其指向模拟器 createAdminTransport (单位:千美元) https.Agent 拨打仿真器 enableLegacyHttpTransport() 所以,多播送荣誉 该代理. send 已经是 HTTP/1.1。 固定项目是 demo-project,固定设备符号是 fixture-device-token任何持枪者,将被接受,直到你打开 strict。 。 。 .

import { deleteApp, initializeApp } from "firebase-admin/app"
import { getMessaging } from "firebase-admin/messaging"
import { createServer } from "@crvouga/mockingbird-service-fcm/server"
import { createAdminTransport } from "@crvouga/mockingbird-service-fcm/admin"

// Test setup: the emulator, plus a credential and an agent that reach it.
const fcm = await createServer()
const transport = await createAdminTransport({ origin: fcm.url, token: "fixture-token" })

// The application's firebase-admin app. Only its credential and httpAgent change.
const app = initializeApp({
  projectId: "demo-project",
  credential: transport.credential,
  httpAgent: transport.agent,
})
const messaging = getMessaging(app)
messaging.enableLegacyHttpTransport()
const name = await messaging.send({
  token: "fixture-device-token",
  notification: { title: "Hello", body: "World" },
})
// name → "projects/demo-project/messages/<id>"

// Test control: every message the emulator accepted.
const outbox = await (await fetch(`${fcm.url}/__admin/outbox`)).json()
void outbox

await deleteApp(app)
await transport.close()
await fcm.close()

路线

管理员

逻辑消息时间是 clockOffsetMs 加上全过程运行时钟. POST /__admin/clock 仍然移动每个命名空间。 记录,断层,出箱,收件箱,以及消息代号均为每个取名空间.

预设

POST /__admin/faults {"preset": "<name>"}每个目标 SendMessage数字 :

命名空间

x-mockingbird-namespace页:1 /__admin/ns/<name>/ 前缀,或 PUT /__admin/credentials (接发者-取名空间. 列于 settings.credentials 仅授权该项目. strict: true 拒绝未列入清单的持有人。 网友:无. 设备收件箱是一个测试控制,而不是回调.

SDK 错误代码

火炮基地地图 error.details[].errorCode 何时 @type 实值 type.googleapis.com/google.firebase.fcm.v1.FcmError,否则 error.status. 两种绘图方法与对错误代码名称的天真解读不同,模拟器遵循火地-admin 12.7.0和13.5.0:

• A JSON 401 具有地位 UNAUTHENTICATED 没有 Fcm 细节变成 messaging/third-party-auth-error。 。 。 . messaging/authentication-error sDK对非JSON 401的用法.
• Fcm 错误 DEADLINE_EXCEEDED sDK报告不在邮件地图中 messaging/unknown-error。 。 。 . UNAVAILABLE 实值 messaging/server-unavailable。 。 。 .

INVALID_ARGUMENT, (中文(简体) ), SENDER_ID_MISMATCH, (中文(简体) ), QUOTA_EXCEEDED, (中文(简体) ), UNAVAILABLE,以及 INTERNAL 地图到 messaging/invalid-argument, (中文(简体) ), messaging/mismatched-credential, (中文(简体) ), messaging/message-rate-exceeded, (中文(简体) ), messaging/server-unavailable,以及 messaging/internal-error二. 现况 PERMISSION_DENIED (另一个项目的持有人)也是 messaging/mismatched-credential。 。 。 .

故意不模拟

• Firebase Auth, Firestore, 实时数据库,主机,远程配置,分析,以及客户端安装API.
• 主题和条件发送,以及主题订阅管理.
• APN和Android运输,真设备,应用回调,通知渲染,徽章,和声.
• 生产配额和Google未公布的重试时间表. 行政主管SDK自己的重试(503, ECONNRESET, (中文(简体) ), ETIMEDOUT)是留给SDK的.

API 密码

部分 嘲笑鸟。 。 。 .