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

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

国家模拟器 EMQX. 5 测试套房和本地开发的MQTT经纪人:一个MQTT 5 tCP和WebSocket的经纪人(/mqtt),EMQX的密码和JWT认证与JWT ACLs, 持续会话带有离线的 QoS 1 队列, 而两个 REST v5 端点只发布 客户需求(POST /api/v5/publish, (中文(简体) ), DELETE /api/v5/clients/{clientid}) (中文(简体) ). 它在测试中运行 在 OS 指定端口上的进程,没有安装经纪人、 Docker 或本地二进制和会话 到期时间跟随一个时钟 套房移动而不是等待.

• 行动覆盖( HTTP): 支助
• 没有EM Q经纪人作为甲骨文,所以行为跟随 MQTT 5.0 规格,则 EMQX文档 和EMQX 5.8.6 来源。 什麽 未结算者列于下 未核实。 。 。 .

安装

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

仅限无害环境管理。 节点 22或 Bun 1.2. 无土生属地. 给它服务 npx mockingbird-emqx serve 或者说 createServer 从 ./server (节点和邦). createRuntime (默认条目)是可移植的: 它服务于 REST API over fetch 和 MQTT 通过 runtime.attach没有听者.

使用量

将应用程序的 MQTT URL 指向 mqttUrl (或 wsUrl),其EMQX API来源于 url,并给它 您在此配置的 API 密钥、 MQTT 用户和 JWT 密钥 .

import { createServer } from "@crvouga/mockingbird-service-emqx/server"
import mqtt from "mqtt"

const emqx = await createServer({
  settings: {
    apiKeys: [{ key: "test-key", secret: "test-secret" }],
    users: [{ username: "service", password: "service-password", superuser: true }],
    jwt: { secret: "test-jwt-secret" }, // HS256 token in the CONNECT password
    authorization: { noMatch: "deny" },
  },
})
// emqx.url      http://127.0.0.1:<port>       REST API and /__admin
// emqx.mqttUrl  mqtt://127.0.0.1:<port>       MQTT 5 over TCP
// emqx.wsUrl    ws://127.0.0.1:<port>/mqtt    MQTT 5 over WebSocket

const client = await mqtt.connectAsync(emqx.mqttUrl, {
  protocolVersion: 5,
  clientId: "device-1",
  clean: false,
  properties: { sessionExpiryInterval: 600 },
  username: "service",
  password: "service-password",
})
await client.subscribeAsync("space:example", { qos: 1 })

// EMQX publishes no JavaScript SDK for its REST API, so the publisher calls it over HTTP.
await fetch(`${emqx.url}/api/v5/publish`, {
  method: "POST",
  headers: {
    authorization: `Basic ${btoa("test-key:test-secret")}`,
    "content-type": "application/json",
  },
  body: JSON.stringify({ topic: "space:example", payload: "hello", qos: 1, retain: false }),
})

// Test control: move time instead of waiting for a session to expire.
await fetch(`${emqx.url}/__admin/clock`, { method: "POST", body: '{"advance": "600s"}' })

await client.endAsync()
await emqx.close() // closes every listener and drops every client

npx mockingbird-emqx serve --port 8850 --mqtt-port 1883 \
  --api-key test-key:test-secret --mqtt-user service:service-password \
  --jwt-secret test-jwt-secret --no-match deny

每个 createServer() 是它自己拥有自己的港口的经纪人,其中两个没有分享任何东西。 下 邦顿, mqtt节点 WebSocket 传输没有启动( Bun) ws 没有 createWebSocketStream,所以连接到 wsUrl 与库的浏览器传输 (单位:千美元)new MqttClient((c) => browserStreamBuilder(c, options), options) 从 mqtt/lib/connect/ws, (中文(简体) ), 或用途 connectStream(runtime) 从 ./server 用于无套接字连接。 在平原的节点上 mqtt.connect("ws://…/mqtt") 工作时.

MQTT 数据

MQTT 5.0 在TCP和WebSocket上运行 /mqtt (副议定书) mqtt,还有 mqtt-v3, (中文(简体) ), mqtt-v3.1.1, (中文(简体) ), mqtt-v5; 没有更新的升级被解答 400,正如 EM 所做的那样 fail_if_no_subprotocol) (中文(简体) ). 两种运输方式都达到相同的会话.

JWT ACL. (英语). 标志 acl 索赔(可配置名称)先问:

• 对象形式, {"pub": [...], "sub": [...], "all": [...]}: 允许列出的主题 其它的都被否认了.
• 名单表, [{"permission": "allow" | "deny", "action": "pub" | "sub" | "all", "topic": "…", "qos"?: [0, 1], "retain"?: false}]: 第一个匹配规则决定;一个没有匹配规则的主题 归为 authorization.noMatch (单位:千美元)allow 默认, 如 EMQX 5; EMQX 6 更改了默认 改为 deny) (中文(简体) ).

ACL 主题为 MQTT 过滤器 ${clientid} 财务报告和审定财务报表 ${username} 扩大; eq <topic> 比较 从字面上说 请求的过滤器按文字匹配, 所以规则 a/+ 涵盖a 订阅 a/# (EMQX emqx_topic:match/2) (中文(简体) ). 一个超级用户来自 users 跳过 授权。 与 authorization.denyAction: "disconnect" 拒绝操作结束 连接到 DISCONNECT 0x87 换句话说.

模拟器的模型 经纪人做什么 一个话题,没有其他的: space:example 是一个 主题级别。 将应用程序的逻辑名称映射到主题上是客户端的工作.

路线

每条路线都需要 Authorization: Basic <api key>:<secret>与 apiKeys 清空任意一对 被接受; 丢失的页眉总是被拒绝.

管理员(超过标准合同)

错误预设( E)POST /__admin/faults {"preset": "<name>", "count"?: n}· ; GET /__admin/faults/presets: connect_bad_credentials (结束) 0x86, (中文(简体) ), connect_not_authorized (单位:千美元)0x87, (中文(简体) ), connect_server_unavailable (单位:千美元)0x88, (中文(简体) ), publish_unavailable (REST发布答案) 503 {"reason_code": 131, "message": "failed_to_dispatch"}, (中文(简体) ), api_unauthorized (每一次紧急呼叫) 答题 401) (中文(简体) ). CONNECT是故障操作 MqttConnect,所以任何原因代码都可以是 强制 : {"operationId": "MqttConnect", "effect": "connack", "params": {"reasonCode": 151}}。 。 。 .

命名空间

平行工人通过命名空间孤立自己. HTTP : (韩语) x-mockingbird-namespace页:1 /__admin/ns/<name> aPI 来源或 API 密钥上的前缀 (单位:千美元)PUT /__admin/credentials {"credentials": {"<api key>": "<namespace>"}}. MQTT: WebSocket (英语) 網址 ws://…/__admin/ns/<name>/mqtt,或CONNECT用户名所按的同一证书地图, 然后,它的客户身份。 未映射的客户端使用默认的名称空间 .

未核实

取自EMQX 5.8.6 来源或未打开,未观察到在经纪人身上:

• 这个 message 计划文本 400 (EMQ) 打印其配置库的错误; 模拟器 指纹 {"kind": "validation_error", "path": "root.<field>", "reason": …}),基础差64 载荷和未知路径 404。 。 。 .
• EM 强制整数 payload 以至其小数字符串;模拟者拒绝.
• CONNACK接收最大值是EMQQ min(client's, 32);模拟器总是发出32.
• 这个 is_superuser 符号索赔不读取.

故意不模拟

• MQTT 3.1和3.1.1:这种CONNECT以协议的回码被拒绝.
• QoS 2: CONNACK表示最大QoS 1,一个QoS 2的订阅获得QoS 1,一个QoS 2 发布是回答 DISCONNECT 0x9B.EMQX本身支持QoS 2.
• 保留信件: CONNACK 表示保留可用 0, 保留的出版物被回答 分解系统 0x9A,以及 retain: true 记录显示 400。 。 。 .
• 将信件(收录于CONNECT,从未出版),共享订阅,增强 认证( AUTH ), 留守超时( PINGREQ 已回答; 使用已死亡的运算切换) 连接、 消息过期、 和外出主题别名 .
• 公用钥匙和JWKS代号、密码散列、以及核证人或授权人以外的 内置数据库和JWT.
• 集群、仪表板及其登录标志、规则引擎、桥梁、计费、TLS和 听众配置 .

API 密码

部分 嘲笑鸟。 。 。 .