通知先が止まったときの処理を、テストで確かめる

本物の通知を送らず、503エラーと200成功を再現し、記録が分かれることを確認します。

目次

通知先が止まったときの動作は、テスト環境にエラー応答を返させて確認できます。この実習では、503という「今は処理できない」応答と、200という成功の応答を再現し、それぞれの結果を正しく記録できるか確かめます。

実際のメールやチャットは送信しません。テスト用の環境が、指定した返事を代わりに返します。

先に用意するもの

共通の練習用サイトを準備します。教材の publish-check がプラグイン、weekend-note がそれを使うサイトです。完成コードは教材に入っています。このページでは、該当する処理を読んで動かし、一部を変更して確かめます。

対象はEmDash 1.4.0、プラグインCLI 0.13.5、テスト用パッケージ 0.2.11、Vitest 4.1.0、Node.js 24.22.1です。macOSで実行しました。Windowsで試す場合はコマンドプロンプトを使ってください。Windows実機での確認はまだ行っていません。

1. 通信先と権限を確認する

publish-check/emdash-plugin.jsonc には、network:request と allowedHosts の notify.example.com が入っています。外部通信を使うことと、通信する相手を宣言する設定です。

notify.example.com は説明用の仮のホスト名です。実サービスのURLへ変更せず、この教材ではテストだけで呼び出します。作者のURLやpublisherの識別子も教材用で、プラグインを配布するための登録情報ではありません。

2. 成功・HTTPエラー・接続失敗を分ける

publish-check/src/plugin.ts の routes にある、次の部分を読みます。抜粋なので、ファイル全体には上書きしません。

'notify-test': {
      permission: 'plugins:manage',
      handler: async (_route, ctx) => {
        try {
          const response = await ctx.http!.fetch('https://notify.example.com/hooks', {
            method: 'POST', headers: { 'Content-Type': 'application/json' },
            body: JSON.stringify({ message: '練習用の通知です' }),
          });
          const result = { ok: response.ok, status: response.status };
          await ctx.kv.set('last-notify', result);
          return result;
        } catch {
          const result = { ok: false, status: 0 };
          await ctx.kv.set('last-notify', result);
          return result;
        }
      },
    },

response.ok は、通信先からの返事(HTTP応答)が成功を表す範囲かを示します。503でも応答自体は返ってくるので、catch だけでは失敗を拾えません。status と一緒に保存します。

接続できないなどの理由で通信そのものにエラーが起きた場合は、例外を扱う catch の処理へ進み、この教材では status: 0 と記録します。0はこの例で決めた記録用の値で、相手が返したHTTPステータスではありません。

permission: 'plugins:manage' は、この呼び出しをプラグイン管理権限のある利用者に限定する指定です。誰でも使える公開URLにしていません。

3. 503と200を再現する

publish-check/tests/plugin.test.ts には、次のテストが入っています。

it('通知先の503を記録し、成功扱いにしない', async () => {
  const user = await host.fixtures.user({ email: 'editor@example.com', role: 'admin' });
  await host.http.respond('https://notify.example.com/hooks', new Response('Unavailable', { status: 503 }));
  const response = await host.actions.routes.request('notify-test', { user, headers: { 'X-EmDash-Request': '1' } });
  expect(response.ok).toBe(true);
  expect(await host.inspect.kv.get('last-notify')).toEqual({ ok: false, status: 503 });
  expect(host.http.requests()).toHaveLength(1);
});
it('通知先の200を成功として記録する', async () => {
  const user = await host.fixtures.user({ email: 'editor@example.com', role: 'admin' });
  await host.http.respond('https://notify.example.com/hooks', new Response('OK', { status: 200 }));
  await host.actions.routes.request('notify-test', { user, headers: { 'X-EmDash-Request': '1' } });
  expect(await host.inspect.kv.get('last-notify')).toEqual({ ok: true, status: 200 });
});

host.http.respond が、実際の通信の代わりに返す内容です。上のテストでは503、下では200に変えています。プラグインの処理を呼び出せたことと、その処理の中で通知が成功したことも分けて確認します。

publish-check で実行します。

npm test -- -t "通知先の"

2 passed が成功の目印です。503では { ok: false, status: 503 }、200では { ok: true, status: 200 } が保存されることを確認しています。

実運用へ進む場合

この例は最後の結果を残すだけです。失敗した通知を自動で送り直す機能や、複数の通知を順番に処理する仕組みは含めていません。運用するなら、送った内容の識別番号、再送回数、重複送信の防止、担当者が失敗を知る方法も必要です。連携失敗への備えへ進んでください。

テストは1回で終了します。実サービスへの接続を確認した結果とは区別して扱います。

公式の参照元

関連ガイド

メニュー
ホーム公式ドキュメント (別タブで開く)

キーワードを入力すると、ガイドの内容から探せます。