cron triggerについて

developers.cloudflare.com

wrangler.ymlなどにcron設定を書くとその設定に従って以下の用に定義した関数を実行してくれる

時間設定

wrangler.ymlに設定するのはこんな感じ（ドキュメントに書かれているサンプル）

[triggers]
# Schedule cron triggers:
# - At every 3rd minute
# - At 3PM on first day of the month
# - At 11:59PM on the last weekday of the month
crons = [ "*/3 * * * *", "0 15 1 * *", "59 23 LW * *" ]

cronsに設定できる時間は3つまでらしい

実装

初期のテンプレートだとsrc/index.tsにscheduled関数を定義するとそれが実行される

export default {
  async scheduled(event: ScheduledEvent, env: SlackEdgeAppEnv, ctx: ExecutionContext): Promise<void> {
  // 処理 
};

eventには実行された時間と発火したcronの設定値（"*/3 * * * *"のようなもの）が入っている。なのでevent.cronの値を見て3つで出し分ける事も可能だと思う。

実際に作ってみる

実際に実行するときはcloudflareに環境変数として設定するがローカルでテストする時のために.dev.varsにtoken設定などを書いておく

SLACK_BOT_TOKEN=xoxb-xxxxx
SLACK_SIGNING_SECRET=xapp-xxxxx

scheduleのコードは以下。exec関数でslackに投稿するデータの取得や組み立て、投稿までを行っている。

import { SlackApp, SlackEdgeAppEnv } from "slack-cloudflare-workers";
import * as xxx from "./features/xxx/index";

export default {
  async scheduled(
    _event: ScheduledEvent,
    env: SlackEdgeAppEnv,
    _ctx: ExecutionContext,
  ): Promise<void> {
    try {
      const app = new SlackApp({ env });
      await xxx.exec(app);
      console.log("done");
    } catch (e) {
      console.error(e);
      throw e;
    }
  },
};


// execの中のイメージ
export function exec(app: SlackApp<SlackEdgeAppEnv>) {
  const data = await xxxApi();
  const text = processing(data);
  await app.client.chat.postMessage({
    channel: "random",
    text,
  });

これだけで簡単に投稿することができた

テスト

wrangler devを実行する際に--test-scheduledというオプションを付けることでschedule発火用のエンドポイントが出てくる。

developers.cloudflare.com

実行後以下のようにリクエストを投げることでscheduled関数を実行させることができる

curl "http://localhost:8787/__scheduled?cron=0+0+*+*+*"

疑問点

cron triggerで実行しconsole.logでログを出すようにしてみたがどこで確認できるのかわからず、失敗した時のデバッグで困った。

またcronの設定のTZについてUTC固定？なので日本時間で実行する場合は+9時間後に実行される事に注意する必要がある。

ゆずめも

メモ的なブログです。主に勉強した事について書いてます。

slackに毎日情報を流しているbotをcloudflare workersに移植してみる

cron triggerについて

時間設定

実装

実際に作ってみる

テスト

疑問点