Honoで作ったCloudflare Workersアプリに、スケジュールタスクを追加する

かなりの小ネタですが、知っていると便利かなと思ったのでまとめました。

HonoはAPI機能に特化しているフレームワーク

当たり前といえば当たり前なのですが、Honoを使う場合、Cloudflare WorkersはAPIを提供するために使うことになります。

たとえばこんな感じですね。Expressライクで、Cloudflareの環境変数・bindingsなどをよしなに処理してくれるのはとてもありがたい存在です。

import { Hono } from 'hono'

const app = new Hono()

app.get('/', (c) => c.text('Hello Hono!'))
export default app

Cloudflare WorkersをHonoなしで作ったことがある方は、Cloudflare WorkersでAPIを作る際に、fetch関数をexportする必要があることをご存知かと思います。Honoも内部的にはこの仕組みを持っていて、通常export default appと書く部分は、次のように書き換えることもできます。

export default {
    fetch: app.fetch
}

fetchだけHonoにすることで、scheduledなども利用できる

export defaultする中身を、Cloudflare Workersが要求する実装にすれば、Honoの有無に関わらず必要なAPIやcronジョブを動かすことができます。ということは、export defaultの中身に、fetch以外のハンドラーを追加することで、Honoとバッチ・cronジョブなどを同居できます。

export default {
    fetch: app.fetch,
    scheduled: async (event, env, ctx) => {
        ctx.waitUntil(doSomeTaskOnASchedule());
      },
}

関数の型をつける場合は、Exportする関数用の型がユースケースごとに用意されていますので、それを使いましょう。

const scheduled: ExportedHandlerScheduledHandler = async (event, env, ctx) => {
    ctx.waitUntil(doSomeTaskOnASchedule());
  }
export default {
    fetch: app.fetch,
    scheduled
}

おわりに

Hono自体はREST APIの提供に特化していますので、Pull RequestやIssueなどでschedule等に対応してもらうのは違うかなぁと思っています。それをするとAWS LambdaやDenoなどにデプロイした時はどうなるの？みたいな議論もでてきそうですし。

それよりは、fetch関数の提供に集中してもらいつつ、再利用したい処理やBindなどがある場合は、scheduleなどの関数を差し込んでやるほうがよいかなと思います。