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

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

状态模拟器 特维利奥 测试套房: 查看 v2 手机验证, 校验 v2 手机 OTP (与真实的状态机器:错误的代码,尝试限制,在模拟器时钟上10分钟的过期), 可编程事件与发件箱,并呼叫录音。 也签下Twilio的字 输入短消息和语音网呼到你的应用程序。 每个产品都在一个港口上服务。 一个套房读取 检察官办公室来自行政飞机,而不是绕过核查(E2E_OTP_BYPASS_*) (中文(简体) ).

• 行动范围: 支助
• 合同openapi.yaml由Twilio的API 引用我们的消费者 打电话 搜索 v2 响应会被对照活的 API 检查字节 (单位:千美元)scripts/parity.ts,录入 test/fixtures/lookups.live.json) (中文(简体) ).

安装

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

仅限无害环境管理。 节点 22或 Bun 1.2. 查询验证用途 libphonenumber-js (Twilio的电话) 寻找是libphone数字。 给它服务 npx mockingbird-twilio serve,与 createServer 从 ./server (节点),或与 createRuntime 在任何获取服务器中.

使用量

npx mockingbird-twilio serve --port 8798 \
  --app-url http://127.0.0.1:3000 \
  --public-base-url "$TWILIO_VOICE_WEBHOOK_BASE_URL" \
  --account-sid "$TWILIO_ACCOUNT_SID" --auth-token "$TWILIO_AUTH_TOKEN" \
  --caller-id "$TWILIO_VOICE_CALLER_ID"

对准应用软件(G-T1)

twilio-node为每种产品建立主机(api.twilio.com, (中文(简体) ), verify.twilio.com, (中文(简体) ), lookups.twilio.com) (中文(简体) ). 模拟器将主机作为第一个路径段 : {emulator}/api/2010-04-01/…, (中文(简体) ), {emulator}/verify/v2/…, (中文(简体) ), {emulator}/lookups/v2/…。通过时 new Twilio(...) a 一个 httpClient 重写 URL. twilioMockUrl 重写 :

import twilio from "twilio"
import { twilioMockUrl } from "@crvouga/mockingbird-service-twilio"
import { createServer } from "@crvouga/mockingbird-service-twilio/server"

const server = await createServer() // or process.env.TWILIO_API_BASE_URL, e.g. http://127.0.0.1:8798

type RequestOptions = Parameters<twilio.RequestClient["request"]>[0]

/** https://verify.twilio.com/v2/Services/VA…/Verifications → {base}/verify/v2/Services/VA…/Verifications */
class MockRequestClient extends twilio.RequestClient {
  override request(opts: RequestOptions): Promise<never> {
    const uri = twilioMockUrl(opts.uri, server.url)
    return super.request({ ...opts, uri }) as Promise<never>
  }
}

// The app's own Twilio client. Only its HTTP client changes.
const client = twilio("AC00000000000000000000000000000000", "fixture-token", {
  httpClient: new MockRequestClient(),
})
const lookup = await client.lookups.v2.phoneNumbers("+12025550123").fetch()
// lookup.valid === true, lookup.nationalFormat === "(202) 555-0123"
await server.close()

示例类型检查用twilio 5.13.1 或 后; 5.1.0 运行方式相同,但是它的 exports 地图隐藏打字方式 moduleResolution: nodenext。 。 。 .

模拟器也通过 Host 头曰. 满足它的要求 lookups.twilio.com (通过 DNS 覆盖或代理) 且没有前缀 /lookups/…。录音 适配器为生 fetch 联 合 国 https://api.twilio.com/2010-04-01/… 变成 twilioMockUrl(url, TWILIO_API_BASE_URL)。 。 。 . RecordingUrl 在网络呼声中保持犬形 https://api.twilio.com 格式,适配器检查.

在测试中读取检察官办公室

import twilio from "twilio"
import { twilioMockUrl } from "@crvouga/mockingbird-service-twilio"
import { createServer } from "@crvouga/mockingbird-service-twilio/server"

// Test setup: the emulator, and the app's Twilio client pointed at it as above.
const server = await createServer()
type RequestOptions = Parameters<twilio.RequestClient["request"]>[0]
class MockRequestClient extends twilio.RequestClient {
  override request(opts: RequestOptions): Promise<never> {
    const uri = twilioMockUrl(opts.uri, server.url)
    return super.request({ ...opts, uri }) as Promise<never>
  }
}
const client = twilio("AC00000000000000000000000000000000", "fixture-token", {
  httpClient: new MockRequestClient(),
})
const verify = client.verify.v2.services("VA00000000000000000000000000000000")

// The app sends the code.
const verification = await verify.verifications.create({ to: "+12025550123", channel: "sms" })

// The test reads it from the admin plane, the way a user reads the SMS.
const latest = await fetch(`${server.url}/__admin/verify/+12025550123/latest`)
const { code } = (await latest.json()) as { code: string; sid: string; status: string }

// The app checks it.
const check = await verify.verificationChecks.create({ verificationSid: verification.sid, code })
// check.status === "approved"
await server.close()

路线

错误使用Twilio的身体, {code, message, more_info, status},与 X-Twilio-Error-Code。 。 。 . 认证为 HTTP Basic: a AC… (或 SK…)用户名和不空密码. 与 accounts (或 --account-sid 加号 --auth-token只有这些对被接受。 失踪或 错误的证书是401 20003。对于错误的符号,信息匹配活的: authentication failed, auth token is not valid for account AC…。 。 。 .

网络呼声(S8.4)

模拟器标志进入了网络 X-Twilio-Signature。签名为基数64 HMAC- SHA1( 自动令牌, 公共 URL + 排序) key+value 参数),与 twilio.validateRequest它的标志反对 公共基础 URL 应用程序配置 (单位:千美元)--public-base-url,也就是说. TWILIO_VOICE_WEBHOOK_BASE_URL),而不是本地主机地址它帖子 改为: Twilio不重试这些webhooks,所以仿真器每发一次.

每个体域都覆盖默认值. 管理员的回答列出了每个发送的应用程序状态 和反应机构(如:. <Response/>) (中文(简体) ). 事件类型 PUT /__admin/webhook-endpoints 过滤器是 sms.inbound 财务报告和审定财务报表 voice.{twiml,disclosure,status,recording}。 。 。 .

管理员(超过标准合同)

错误预设( E)POST /__admin/faults {"preset": "<name>", "count"?: n, "latencyMs"?: n}; 以 GET /__admin/faults/presets,并读 hits 编号 : remaining 从 GET /__admin/faults) (中文(简体) ). 预设适用于调用命名空间. verify_5xx (开始和检查答案) 20500, (中文(简体) ), sms_drop_before_accept (Messages.json在信件存在前将套接字放下;仍然注册为 sms_socket_drop, (中文(简体) ), sms_accepted_then_socket_drop (信件和发件箱项被存储,然后套接字在任何响应字节之前关闭), sms_4xx (400个) 21211, (中文(简体) ), sms_429 (429个) 20429 与 Retry-After: 1, (中文(简体) ), sms_5xx (500个) 20500,没有 Retry-After, (中文(简体) ), sms_missing_sid (201人,其身体省略) sid收发箱里还有留言, lookup_5xx (503个) 20503; EMR 未打开), webhook_duplicate, (中文(简体) ), webhook_drop. Messages.json上的503是同一个有代码的信封 20503 财务报告和审定财务报表 Retry-After (标准过失,不是单独的预设). 状态断层没有存储信息.

命名空间

Twilio SDK 无法添加信头, 所以套房会选择命名空间 账户数字 : PUT /__admin/credentials {"credentials": {"<TWILIO_ACCOUNT_SID>": "<namespace>"}}名称空间 也可以来自 x-mockingbird-namespace 标题或一个 /__admin/ns/<name> 基础 URL 前缀 (单位:千美元)twilioMockUrl 保留前缀).

故意不模拟

• 发送: 保留信息 queued编号 :accepted,没有发送状态回调(我们的消费者集没有) statusCallback),并且没有出现语音通话,会议或媒体流.
• 信件收藏 DateSent 过滤器(模拟器从未发送消息).
• 付费的搜索数据包( E)Fields=line_type_intelligence, (中文(简体) ), caller_name,)总是 null。 。 。 .
• 接受和记录除短信以外的核查频道,但无任何消息。 校验 服务配置(代码长度、友好名称、速率限制桶)是全局的,设置为 PUT /__admin/verify。 。 。 .
• 账户:任何 AC… sid是它自己的账户,而路径的 {AccountSid} 没有 与证书核对.
• libphonenumber-js从它的元数据中去掉"局部"长度. 模拟器恢复它们 NANP (7)和 GB (4–6,8),这足以用于虚构的数字测试. 其他国家 可能回答 TOO_SHORT 特维利奥回答的地方 INVALID_BUT_POSSIBLE。 。 。 .

API 密码

部分 嘲笑鸟。 。 。 .