VercelのCRON実行について

設定

以下をプロジェクトルートに設定する。

{
  "crons": [
    {
      "path": "/api/test",
      "schedule": "0 10 * * *"
    }
  ]
}

無料プランだと、1日1回という制限があるので、1日1回の制限を超えたスケジューラーの設定をすると、そもそもデプロイで失敗します。

認証

Vercelのenvironment varibalesにCRON_SECRETを設定する。

The value of the variable will be automatically sent as an Authorization header when Vercel invokes your cron job.

Vercelが cron job を実行する際に、Authorizationヘッダーを自動で付与します。

そのため、jobの方のプログラム側でもそれを受け取るようにする必要があります。
自身のターミナルなどから実行する場合は、明示的に自分で設定する必要があります。

curl実行サンプル

参考:
curl https://your-vercel-project.vercel.app/api/your-api-path -H "Authorization: Bearer {api token}"

プログラム

公式参照のコード

import type { NextRequest } from 'next/server';
 
export function GET(request: NextRequest) {
  const authHeader = request.headers.get('authorization');
  if (authHeader !== `Bearer ${process.env.CRON_SECRET}`) {
    return new Response('Unauthorized', {
      status: 401,
    });
  }
 
  return Response.json({ success: true });
}

このようにすることで、無防備に開放されることはないのでちゃんと設定しておきましょう。

配置場所は、app router を使っている場合、app/api/{your-api-path}/route.ts になります。
上記パスに該当プログラムを書くことで実行できるようになります。

手動実行

Vercelのプロジェクトの中にある以下から実行できます。
事前にCRON JOBSのenableをONにしておく必要があります。

ログ

以下からログを確認できます。

無料プランだと現時点から1時間分のログしか確認できないので注意
CSVやJSONとして出力できるので、必要に応じて出力するシステムを作る必要があるかもしれません。

参考

https://vercel.com/docs/cron-jobs/manage-cron-jobs

https://vercel.com/docs/runtime-logs#view-runtime-logs

https://qiita.com/SatouHa/items/9e98407f27e5a5a59af1

https://harusame.dev/blog/posts/vercel-cron-jobs-batch/