GitHub Actionsのcronで、Zennの記事を自動公開しています。cronは、予定の時刻ぴったりには動きません。この記事は、公開の記録から、実際にどれくらい遅れたかを数えた結果と、その遅れを前提に、公開の頻度を変えたとき、間隔のガードをどう見直したかの記録です。
「前回から26時間あけば公開」のガードが、cronの遅れで破られた話は、別の記事に書きました。ここでは、その続きです。
前提: 公開の仕組み
- GitHub Actionsが、決まった時刻に、キューの先頭の記事を公開する
- Zennは、「前回の公開から24時間以内」の記事公開に、上限がある
- そこで、スクリプトに、「前回の公開から◯時間たっていなければ、公開しない」というガードを入れている
- 前回の公開時刻は、
.github/last-published-at.jsonに、スクリプトが書く
// 前回の公開から MIN_INTERVAL_HOURS 時間たっていなければ、何もせず終了する
const lastAt = new Date(lastData.publishedAt);
const hoursSince = (Date.now() - lastAt.getTime()) / (1000 * 60 * 60);
if (hoursSince < MIN_INTERVAL_HOURS) {
console.log('前回の公開から間隔が足りないので、今回は公開しません。');
return;
}
毎日cronを動かして、2日に1本のペースにするために、ガードは47時間にしていました(24時間後の実行は見送られ、48時間後の実行で公開される)。
起きたこと: 10月19日に、実行が約2時間遅れた
cronの指定は、毎日00:00(UTC)です。10月18日の公開は、記録上00:07で、数分の遅れでした。
ところが、10月19日の実行は、02:07に動きました。スクリプトが記録した前回の公開時刻は、**実際に動いた02:07**でした。
このとき、私は、次の枠も、18日と同じく00:07ごろに動くと考えました。すると、記録された02:07から数えて、46時間しかたっていません。ガードは47時間なので、**「次の公開は、1日遅れ」**になると判断しました。
そこで、last-published-at.jsonの値を、実際に動いた時刻(02:07)ではなく、本来の枠(00:07)に書き換えました。手での対応です。
あとから記録を見ると、補正は要らなかった
実際には、次の枠(10月21日)の実行も、約2時間遅れました(02:16)。補正しなかった場合の間隔は、48時間09分です。47時間のガードは、通っていました。
つまり、このときの補正は、結果として、要りませんでした。私は、「遅れは、その日だけのもの」と、決めつけていました。
記録を数えると、10月19日以降の公開は、すべて遅れていました。
| 公開の日(UTC) | 記録された時刻(UTC) | 枠(00:00)からの遅れ | 前回の公開との間隔 |
|---|---|---|---|
| 10/18 | 00:07 | 0時間07分 | - |
| 10/19 | 02:07 | 2時間08分 | 26時間00分 |
| 10/21 | 02:16 | 2時間17分 | 48時間09分 |
| 10/23 | 02:17 | 2時間17分 | 48時間00分 |
| 10/25 | 02:01 | 2時間02分 | 47時間45分 |
| 10/27 | 02:40 | 2時間40分 | 48時間39分 |
| 10/29 | 03:11 | 3時間11分 | 48時間31分 |
| 10/31 | 02:58 | 2時間59分 | 47時間48分 |
| 11/02 | 02:58 | 2時間59分 | 48時間00分 |
| 11/04 | 03:36 | 3時間36分 | 48時間38分 |
| 11/06 | 03:53 | 3時間54分 | 48時間17分 |
(「記録された時刻」は、自動公開のコミット時刻です。10/19の間隔は、当時のガードが26時間だったときのものです。10/19以降の実行は、10回とも、2時間02分〜3時間54分の遅れでした。)
数えて分かったのは、次の2点です。
- 遅れは、その日だけではなく、毎回、2〜4時間ありました。10/21以降、前回との間隔は、47時間45分〜48時間39分でした
- 47時間のガードの余裕は、最短の間隔(10/25の47時間45分)に対して、45分しかありませんでした
毎日cronで、ガードが「公開のペース」を決めていたころは、この45分が、1日遅れになるかどうかの境目でした。
週3回にしたとき、ガードも見直した
11月1日に、公開の頻度を、**週3回(月・水・金)**に変えました。cronも、毎日ではなく、曜日を固定しました。
on:
schedule:
- cron: '0 0 * * 1,3,5'
ここで、ガードの意味が変わりました。
| 毎日cron | 曜日固定のcron | |
|---|---|---|
| 実行の頻度 | 毎日 | 月・水・金だけ |
| 「何日おきに公開するか」を決めるもの | ガード(47時間) | cronの曜日 |
| ガードの役目 | 24時間後の実行を見送る | 手動実行などで、24時間以内に2本出ないようにする |
毎日cronのときは、ガードが、ペースそのものを決めていました。そのため、目標(48時間)の少し手前の47時間にする必要があり、余裕は、数十分でした。
曜日固定のcronでは、ペースは、cronが決めます。ガードは、最後の安全装置です。月曜から水曜までは、約48時間あきます。cronが数時間遅れても通るように、40時間にしました。
const MIN_INTERVAL_HOURS = 40;
その後: 週3回の最初の3回
40時間のガードで動いた最初の3回(11/2、11/4、11/6)は、すべて、ガードを通って、公開されました。前回との間隔は、次のとおりです。
- 11/2: 48時間00分
- 11/4: 48時間38分
- 11/6: 48時間17分
ガードの40時間に対する余裕は、最短でも、8時間17分です。47時間のころの45分とは、桁が違います。
間隔は、**48時間+(今回の遅れ−前回の遅れ)**になります(私の計算です)。40時間を下回るのは、前回より8時間以上早く動いたときだけです。この記録では、遅れが2時間02分〜3時間54分の範囲に収まっていたので、そうなっていません。
考え方のまとめ
- ガードの値は、スケジュールの形で決まる。毎日cron+「2日おき」なら、ガードがペースを作り、余裕は、遅れの幅の分しかない。曜日固定なら、ガードは安全装置で、余裕を大きく取れる
- 遅れを、「その日だけのもの」と決めつけない。私は、10/19の遅れを一度きりと考えて、記録を手で直しました。数えてみると、毎回遅れていて、直す必要はありませんでした。判断の前に、記録を数えるほうが、確実でした
- 前回の時刻を、遅れた実行時刻のまま記録しても、この記録では、問題は起きなかった。ただし、それは、遅れが、毎回、同じ向きに、2〜4時間だったからです
確かめていないこと
- cronの遅れが、GitHub側の、どんな条件で出るのか(混雑、時間帯など)。この記事では、原因を断定していません
- 遅れが2〜4時間にそろっていたのは、私の1つのリポジトリの、約3週間の記録です。ほかの環境や時期では、違う可能性があります
- 「記録された時刻」は、スクリプトの実行時刻(コミット時刻)です。Actionsの実行画面の開始時刻との差は、確かめていません
- 記録する時刻を、「本来の枠」に丸める仕組みは、まだ入れていません。この記録では、必要になっていません
この記事はZennにも投稿しています。