@h-ai/scheduler 1.0.0-beta.30 → 1.0.0-beta.32
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.en.md +10 -299
- package/README.ja.md +9 -298
- package/README.md +10 -299
- package/dist/index.js +11 -8
- package/dist/index.js.map +1 -1
- package/package.json +3 -3
package/README.ja.md
CHANGED
|
@@ -4,316 +4,27 @@
|
|
|
4
4
|
|
|
5
5
|
[フレームワークのホーム](../../README.ja.md) · 関連モジュール:[@h-ai/core](../core/README.ja.md) · [@h-ai/reldb](../reldb/README.ja.md)
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
`scheduler` は cron スケジュールに従って JavaScript の処理や HTTP API を実行します。タスク設定と実行ログをデータベースに保存し、実行前後にアプリが指定した処理も呼び出せます。
|
|
8
8
|
|
|
9
9
|
## クイックスタート
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
`pnpm add @h-ai/scheduler @h-ai/reldb` でインストールします。
|
|
12
12
|
|
|
13
|
-
-
|
|
13
|
+
[最小構成の導入手順](../../docs/usage/function/scheduler.ja.md#quick-start)を参照してください。
|
|
14
14
|
|
|
15
|
-
|
|
16
|
-
import { reldb } from '@h-ai/reldb'
|
|
17
|
-
import { scheduler } from '@h-ai/scheduler'
|
|
15
|
+
## 設定一覧
|
|
18
16
|
|
|
19
|
-
|
|
17
|
+
生成したプロジェクトでは、タスクを探す間隔と実行権の有効期間を `config/_scheduler.yml` に記述します。アプリの起動コードがファイルを読み込み、設定オブジェクトを `scheduler.init(config)` に渡します。
|
|
20
18
|
|
|
21
|
-
|
|
22
|
-
enableDb: true,
|
|
23
|
-
maxLogs: 1000,
|
|
24
|
-
retentionDays: 30,
|
|
25
|
-
hooks: {
|
|
26
|
-
onTaskStart(event) {
|
|
27
|
-
void event
|
|
28
|
-
},
|
|
29
|
-
},
|
|
30
|
-
})
|
|
31
|
-
|
|
32
|
-
await scheduler.register({
|
|
33
|
-
id: 'health-check',
|
|
34
|
-
name: '健康检查',
|
|
35
|
-
description: '每 5 分钟执行一次系统健康检查',
|
|
36
|
-
cron: '*/5 * * * *',
|
|
37
|
-
params: { channel: 'ops' },
|
|
38
|
-
handler: {
|
|
39
|
-
kind: 'api',
|
|
40
|
-
url: 'https://api.example.com/health',
|
|
41
|
-
method: 'GET',
|
|
42
|
-
timeout: 10000,
|
|
43
|
-
},
|
|
44
|
-
})
|
|
45
|
-
|
|
46
|
-
await scheduler.register({
|
|
47
|
-
id: 'cleanup',
|
|
48
|
-
name: '清理过期数据',
|
|
49
|
-
description: '每日凌晨执行过期数据清理',
|
|
50
|
-
cron: '0 2 * * *',
|
|
51
|
-
deleteAfterRun: true,
|
|
52
|
-
params: { source: 'nightly' },
|
|
53
|
-
handler: {
|
|
54
|
-
kind: 'js',
|
|
55
|
-
code: '(context) => ({ taskId: context.taskId, params: context.params })',
|
|
56
|
-
},
|
|
57
|
-
})
|
|
58
|
-
|
|
59
|
-
scheduler.start()
|
|
60
|
-
|
|
61
|
-
const manualResult = await scheduler.trigger('cleanup', { source: 'admin-console' })
|
|
62
|
-
const logs = await scheduler.getLogs({
|
|
63
|
-
triggerType: 'manual',
|
|
64
|
-
triggerSource: 'admin-console',
|
|
65
|
-
startedAfter: Date.now() - 24 * 60 * 60 * 1000,
|
|
66
|
-
})
|
|
67
|
-
|
|
68
|
-
scheduler.stop()
|
|
69
|
-
await scheduler.close()
|
|
70
|
-
```
|
|
19
|
+
設定の入口、既定値、指定できる値、反映の条件は[設定一覧](../../docs/usage/configuration/scheduler.ja.md)を参照してください。
|
|
71
20
|
|
|
72
21
|
## 機能
|
|
73
22
|
|
|
74
|
-
-
|
|
75
|
-
- HTTP、信頼できる JavaScript、アプリ Hook に対応し、再試行とキャンセルを提供。
|
|
76
|
-
- 共有 DB による定義・実行状態・更新可能リースの永続化と結果不明の隔離。
|
|
77
|
-
|
|
78
|
-
### 操作と入出力
|
|
79
|
-
|
|
80
|
-
本節の完全な初期化手順を先に実行します。例の業務値はホストが検証・認可し、非同期領域結果は success を確認してから data を読みます。void はデータなし完了、null は不存在、同期ファクトリー/ツールは表の型を直接返します。
|
|
81
|
-
|
|
82
|
-
#### scheduler
|
|
83
|
-
|
|
84
|
-
定義管理はタスク・ID・ID+差分・引数なし再読込から void HaiResult。tasks は最終成功の読取専用像で、認可や DB の現在値ではない。
|
|
85
|
-
|
|
86
|
-
| 入口 | 入力引数 | 成功結果 | 呼出し例 |
|
|
87
|
-
| ------------------------ | --------------- | -------- | ---------------------------------------------------------------------------------------------- |
|
|
88
|
-
| `scheduler.register` | task | `void` | `await scheduler.register({ id: 'daily', name: 'Daily', cron: '0 2 * * *', timezone: 'UTC' })` |
|
|
89
|
-
| `scheduler.unregister` | taskId | `void` | `await scheduler.unregister('daily')` |
|
|
90
|
-
| `scheduler.updateTask` | taskId, updates | `void` | `await scheduler.updateTask('daily', { enabled: false })` |
|
|
91
|
-
| `scheduler.refreshTasks` | 引数なし | `void` | `await scheduler.refreshTasks()` |
|
|
92
|
-
|
|
93
|
-
#### scheduler
|
|
94
|
-
|
|
95
|
-
start/stop は同期 HaiResult、trigger は ID/パラメーターから試行ログ、getLogs は条件/ページから一覧。stop は進行中副作用を取り消さない。
|
|
96
|
-
|
|
97
|
-
| 入口 | 入力引数 | 成功結果 | 呼出し例 |
|
|
98
|
-
| ------------------- | --------------- | ----------------------------------- | ---------------------------------------------------- |
|
|
99
|
-
| `scheduler.start` | 引数なし | `void` | `scheduler.start()` |
|
|
100
|
-
| `scheduler.stop` | 引数なし | `void` | `scheduler.stop()` |
|
|
101
|
-
| `scheduler.trigger` | taskId, options | `TaskExecutionLog` | `await scheduler.trigger('daily')` |
|
|
102
|
-
| `scheduler.getLogs` | options | `PaginatedResult<TaskExecutionLog>` | `await scheduler.getLogs({ page: 1, pageSize: 20 })` |
|
|
103
|
-
|
|
104
|
-
#### scheduler
|
|
105
|
-
|
|
106
|
-
業務/イベント callback の設定・引数なし解除は同期 HaiResult。Hook は signal と外部効果の冪等性を守る。
|
|
107
|
-
|
|
108
|
-
| 入口 | 入力引数 | 成功結果 | 呼出し例 |
|
|
109
|
-
| ---------------------- | -------- | -------- | ------------------------------- |
|
|
110
|
-
| `scheduler.setHooks` | hooks | `void` | `scheduler.setHooks(taskHooks)` |
|
|
111
|
-
| `scheduler.clearHooks` | 引数なし | `void` | `scheduler.clearHooks()` |
|
|
112
|
-
|
|
113
|
-
#### scheduler.execution
|
|
114
|
-
|
|
115
|
-
実行台帳。get は occurrenceId から項目/null、list は limit/offset から配列、repairLog は ID でログを冪等補修、resolveUnknown は ID・裁定・expectedUpdatedAt で条件付き解放し void。
|
|
116
|
-
|
|
117
|
-
| 入口 | 入力引数 | 成功結果 | 呼出し例 |
|
|
118
|
-
| ------------------------------------- | ------------------------ | --------------------------------- | -------------------------------------------------------------------------------------------------- |
|
|
119
|
-
| `scheduler.execution.get` | occurrenceId | `SchedulerExecutionEntry \| null` | `await scheduler.execution.get(occurrenceId)` |
|
|
120
|
-
| `scheduler.execution.listUnknown` | options | `SchedulerExecutionEntry[]` | `await scheduler.execution.listUnknown({ limit: 20, offset: 0 })` |
|
|
121
|
-
| `scheduler.execution.listLogFailures` | options | `SchedulerExecutionEntry[]` | `await scheduler.execution.listLogFailures({ limit: 20, offset: 0 })` |
|
|
122
|
-
| `scheduler.execution.repairLog` | occurrenceId | `void` | `await scheduler.execution.repairLog(occurrenceId)` |
|
|
123
|
-
| `scheduler.execution.resolveUnknown` | occurrenceId, resolution | `void` | `await scheduler.execution.resolveUnknown(occurrenceId, { status: 'success', expectedUpdatedAt })` |
|
|
124
|
-
|
|
125
|
-
### 共通タスクモデル
|
|
126
|
-
|
|
127
|
-
```ts
|
|
128
|
-
interface TaskDefinition {
|
|
129
|
-
id: string
|
|
130
|
-
name: string
|
|
131
|
-
description?: string
|
|
132
|
-
cron: string
|
|
133
|
-
timezone?: string // IANA 时区,例如 Asia/Shanghai;省略时为 UTC,不读取节点 TZ
|
|
134
|
-
enabled?: boolean
|
|
135
|
-
deleteAfterRun?: boolean
|
|
136
|
-
idempotent?: boolean
|
|
137
|
-
retry?: {
|
|
138
|
-
maxAttempts: number
|
|
139
|
-
backoffMs?: number[]
|
|
140
|
-
}
|
|
141
|
-
params?: Record<string, unknown>
|
|
142
|
-
handler?: ApiTaskConfig | JsTaskConfig
|
|
143
|
-
}
|
|
144
|
-
|
|
145
|
-
interface ApiTaskConfig {
|
|
146
|
-
kind: 'api'
|
|
147
|
-
url: string
|
|
148
|
-
method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH'
|
|
149
|
-
headers?: Record<string, string>
|
|
150
|
-
body?: unknown
|
|
151
|
-
maxResponseBytes?: number
|
|
152
|
-
timeout?: number
|
|
153
|
-
}
|
|
154
|
-
|
|
155
|
-
interface JsTaskConfig {
|
|
156
|
-
kind: 'js'
|
|
157
|
-
code: string // JS 函数字符串
|
|
158
|
-
timeout?: number
|
|
159
|
-
}
|
|
160
|
-
```
|
|
161
|
-
|
|
162
|
-
補足:
|
|
163
|
-
|
|
164
|
-
- `kind: 'js'` を含むすべてのタスクを DB に永続化できます。
|
|
165
|
-
- JS タスクは実行時にコンパイルし、ソース単位でキャッシュして毎回の再コンパイルを避けます。
|
|
166
|
-
- `handler` は省略可能で、その場合は共通の `hooks.onTaskExecute` で実行します。
|
|
167
|
-
|
|
168
|
-
> ⚠️ **セキュリティ注意**:`kind: 'js'` は信頼できるサーバー側コード専用です。Node.js の `vm` による実行は**安全なサンドボックスではありません**。ユーザー、テナント、管理画面から任意の JS 文字列を直接受け付けないでください。設定可能なタスクには `kind: 'api'` または `hooks.onTaskExecute` を優先してください。
|
|
169
|
-
|
|
170
|
-
### タスクのライフサイクル Hook
|
|
171
|
-
|
|
172
|
-
初期化時に渡すか、実行時に `setHooks()` で設定します:
|
|
173
|
-
|
|
174
|
-
```ts
|
|
175
|
-
await scheduler.init({
|
|
176
|
-
enableDb: true,
|
|
177
|
-
hooks: {
|
|
178
|
-
onTaskStart(event) {
|
|
179
|
-
void event
|
|
180
|
-
},
|
|
181
|
-
async onTaskExecute(event) {
|
|
182
|
-
return { via: 'hook', source: event.context.trigger.source }
|
|
183
|
-
},
|
|
184
|
-
onTaskInterrupted(event) {
|
|
185
|
-
void event
|
|
186
|
-
},
|
|
187
|
-
onTaskFinish(event) {
|
|
188
|
-
void event
|
|
189
|
-
},
|
|
190
|
-
},
|
|
191
|
-
})
|
|
192
|
-
```
|
|
193
|
-
|
|
194
|
-
### 実行ログ
|
|
195
|
-
|
|
196
|
-
実行元でログを絞り込めます:
|
|
197
|
-
|
|
198
|
-
```ts
|
|
199
|
-
const logs = await scheduler.getLogs({
|
|
200
|
-
taskId: 'cleanup',
|
|
201
|
-
triggerType: 'manual',
|
|
202
|
-
triggerSource: 'admin-console',
|
|
203
|
-
startedAfter: Date.now() - 24 * 60 * 60 * 1000,
|
|
204
|
-
startedBefore: Date.now(),
|
|
205
|
-
pagination: { page: 1, pageSize: 20 },
|
|
206
|
-
})
|
|
207
|
-
```
|
|
208
|
-
|
|
209
|
-
実行ログは初期化時に自動削除方針を設定できます:
|
|
210
|
-
|
|
211
|
-
- `maxLogs`:最大 N 件を保持。
|
|
212
|
-
- `retentionDays`:直近 N 日分のみを保持。
|
|
213
|
-
|
|
214
|
-
### API 一覧
|
|
215
|
-
|
|
216
|
-
- `init(config?)`
|
|
217
|
-
- `register(task)`
|
|
218
|
-
- `unregister(taskId)`
|
|
219
|
-
- `updateTask(taskId, updates)`
|
|
220
|
-
- `refreshTasks()`
|
|
221
|
-
- `start()` / `stop()`
|
|
222
|
-
- `trigger(taskId, { source?, idempotencyKey? })`
|
|
223
|
-
- `getLogs(options?)`
|
|
224
|
-
- `execution.listLogFailures(options?)` / `execution.repairLog(occurrenceId)`
|
|
225
|
-
- `execution.get(occurrenceId)` / `execution.listUnknown(options?)` / `execution.resolveUnknown(occurrenceId, input)`
|
|
226
|
-
- `setHooks(hooks)` / `clearHooks()`
|
|
227
|
-
- `tasks` / `hooks` / `config` / `isInitialized` / `isRunning`
|
|
228
|
-
- `close()`
|
|
229
|
-
|
|
230
|
-
### 実行時の動作と制約
|
|
231
|
-
|
|
232
|
-
各ノードは同じ共有 RelDB を先に初期化します。ホスト間の本番運用は PostgreSQL/MySQL、SQLite は同じファイルを正しく共有するローカルプロセス向けです。定義、実行 journal、タスク占有、リースを永続化し、`enableDb` は true のみです。キャッシュは不要です。`leaseMs` は既定 300000、範囲 1000~86400000 ミリ秒で実行中に更新します。cron、手動、次周期は同じタスク枠を使い、期限切れ owner は復活・コミットできません。`tasks` は最後に成功した定義スナップショットで、読取失敗や削除・無効化・変更は旧試行を中断します。外部副作用は自動で戻りません。
|
|
233
|
-
|
|
234
|
-
`context.occurrenceId` は永続化された発生 ID で、同じ cron 分と再試行で共通です。手動では 1~128 文字の `idempotencyKey` で元の記録を再利用し、省略時は別発生になります。`executionToken` は取得ごとに変わり、`sequence` / `attempt` が世代を示します。API は `Idempotency-Key`、`X-Scheduler-Sequence`、`X-Scheduler-Attempt`、`X-Scheduler-Task`(ID を percent-encoding)を上書きします。取得済みのライフサイクルイベントも `event.context` を提供し、副作用には同じキーによる排除が必要です。
|
|
235
|
-
|
|
236
|
-
PostgreSQL では、同じ分内の再起動や複数ノードでの同時取得により、既存の実行記録や使用中のタスク枠に行き当たることがあります。スケジューラーはこれらを通常の競合として処理します。`scheduler.execution.get(occurrenceId)` で実行状態を確認し、重複実行を防ぐために実行台帳と一意制約を保持してください。
|
|
237
|
-
|
|
238
|
-
`idempotent` の既定は false。受信側が排除台帳と全副作用をアトミックに永続化する場合だけ true にします。期限切れ実行は true のとき同 occurrenceId で引継ぎ、非冪等実行、または保存済み retry.maxAttempts(既定 1、範囲 1–100、初回と復旧を含む)の予算を使い切った場合は `unknown` となりタスク枠を保持します。停止中の旧プロセスが送った外部操作をリースで撤回できず、ヘッダーだけでは排除できません。再試行もこの宣言に従います。
|
|
239
|
-
|
|
240
|
-
正規状態は `scheduler.execution.get(occurrenceId)`、不明一覧は `listUnknown({ limit, offset })`(limit 1~100、offset 0~1000000)で確認します。信頼された担当者が外部効果を照合し旧 runner の終了を確認してから、`resolveUnknown(id, { status: 'success' | 'discarded', expectedUpdatedAt })` の CAS で枠を解放します。不明実行を直接再投入しないでください。`log.occurrenceId` が照会用受領記録で、`getLogs` は試行の観測ログです。ログ保持は journal と排除履歴を削除しません。
|
|
241
|
-
|
|
242
|
-
各試行のログ `id` は固定 UUID です。`persistence.status` は業務 `status` と独立し、`persisted` はログと確認記録の保存済み、`pending` は業務終態の確定後にログ補完待ち、`unconfirmed` は確定済み業務結果を前提にできない状態です。有効な owner とリースの条件で終態と全試行を保存してからログへ投影し、失効ノードは成功を投影できません。ログ失敗を理由に業務成功を失敗へ変更したり、業務を再実行したりしません。
|
|
243
|
-
|
|
244
|
-
補完後は pending 一覧が縮小するため、処理中に offset を進めず、offset=0 のバッチを繰り返し取得してください。
|
|
245
|
-
|
|
246
|
-
信頼されたサーバーは `execution.listLogFailures({ limit, offset })`(listUnknown と同じ上限)で pending を監視し、`execution.repairLog(occurrenceId)` で共有 journal から補完します。別ノード・再起動後・同時呼び出しも可能で、固定主キーと全内容の照合によりコミット後の応答消失を排除します。`LOG_PERSIST_FAILED`(032)は pending を維持して安全な警告を出します。終態の保存前に DB 全体が停止した場合は unknown の外部効果を照合し、復元可能な結果があると仮定しないでください。補完と保持処理は業務 Hook を呼ばず、保持失敗は警告のみです。`onTaskFinish` は未確定のローカル業務終了通知で、保存確認は trigger の戻り値と execution.get.logPersistence を使います。
|
|
247
|
-
|
|
248
|
-
取得前の競合・スキップの interrupted は観測ログで、補完できる確定終態はありません。応答が確認できなければ unconfirmed です。JSON 列で MySQL の 255 文字制限を避け、完全な結果と全再試行を保持します。実行台帳は観測ログから独立します。終了は補完処理を待つため、DB より先に scheduler を終了してください。
|
|
249
|
-
|
|
250
|
-
```ts
|
|
251
|
-
const result = await scheduler.trigger('cleanup', { idempotencyKey: 'cleanup-2026-10-23' })
|
|
252
|
-
if (!result.success)
|
|
253
|
-
return result
|
|
254
|
-
if (result.data.persistence.status === 'pending' && result.data.occurrenceId) {
|
|
255
|
-
const repaired = await scheduler.execution.repairLog(result.data.occurrenceId)
|
|
256
|
-
if (!repaired.success)
|
|
257
|
-
return repaired
|
|
258
|
-
}
|
|
259
|
-
// 不用日志补写失败重新 trigger 业务;定期按页扫描 listLogFailures。
|
|
260
|
-
```
|
|
261
|
-
|
|
262
|
-
`await scheduler.close()` は受付を止め、HTTP、JS Worker、再試行待機をキャンセルし、実行チェーンの終了後に状態を解放します。再初期化は終了完了を待ちます。すべてのイベントが `signal` を提供し、Hook はキャンセルを監視して外部への副作用を停止する必要があります。同じスレッドの業務コードは強制終了できないため、Hook でイベントループをブロックしないでください。キャンセルされた旧実行は再試行・自動削除・新インスタンスの Hook 呼び出しを行いません。scheduler の終了完了まで DB を維持し、その後に依存モジュールを終了します。
|
|
263
|
-
|
|
264
|
-
JS 文字列は呼び出しごとの独立 Worker で実行します。`timeout` は起動を含めて既定 30000 ms です。時間超過時はスレッドを終了し、終了を待ってから失敗記録・再試行を行います。同期の無限ループでもメインイベントループをブロックしません。コンテキストと戻り値は構造化クローンに対応する必要があります。Worker 内の `vm` も安全なサンドボックスではなく、信頼できるサーバー側コードのみを使用します。
|
|
265
|
-
|
|
266
|
-
API タスクの `timeout`(既定 30000 ms)はリクエストと応答本文全体の読み取りを含みます。`ApiTaskConfig.maxResponseBytes` は受信バイト上限で、正の安全な整数、既定は 1048576(1 MiB)です。`maxResponseBytes: 10 * 1024 * 1024` なら最大 10 MiB を許可し、不正値は送信前に失敗します。タイムアウト・上限超過・非成功 HTTP 応答は既定では unknown となり、冪等性を宣言した場合だけ有限回再試行します。
|
|
267
|
-
|
|
268
|
-
`init()` は全タスクの読み込み完了後にのみ成功します。空 ID、重複 ID(保存済みタスクとの重複を含む)、不正な cron、DB 読み取り失敗、保存タスクの解析失敗では失敗を返し、初期化状態を消去します。設定・データを修正してから再初期化し、既存の DB タスクを `tasks` に重複宣言しないでください。
|
|
269
|
-
|
|
270
|
-
cron は分単位で照合し、同じ分から永続 occurrenceId を生成します。遅延 tick でも現在の分を実行中に一度確認します。
|
|
271
|
-
|
|
272
|
-
取得・開始・更新・完了・期限切れ検索・隔離の期限は、同じ SQL 文内でデータベース時刻から計算・検証します。PostgreSQL は clock_timestamp、MySQL は SYSDATE(3)、SQLite はストレージ側 now を使用し、先に時刻を読むだけでは最終条件を代替できません。cron の分 occurrence と式の照合も DB 時刻を使用します。timezone の省略時は UTC、明示した IANA 時区は壁時計の解釈だけを変更し、ノードの TZ は識別子や照合を変えません。Node の Date.now は診断専用です。ノード間で数時間の差があっても早期引継ぎや失効 owner の復活を許可せず、行ロック待機後も期限を検証します。DB 自体の時刻は運用側で信頼性を保ち、外部効果が不明な場合は自動再実行せず照合してください。
|
|
273
|
-
|
|
274
|
-
### 任意の連携
|
|
275
|
-
|
|
276
|
-
Reach 通知を実行するタスクでは、調度ロックやタスク完了だけで外部配信の一意性は保証できません。[Reach キューの意味](../reach/README.ja.md) に従い、永続化された queueId を使ってください。HTTP 受信側は副作用と重複排除を原子的に保存し、SMTP/SMS の配信中の結果不明は手動照合します。スケジューラーの再試行で無条件に再送しないでください。
|
|
277
|
-
|
|
278
|
-
### 定義の整合性と永続化の準備
|
|
279
|
-
|
|
280
|
-
定義の更新読込、登録、変更、削除は、変更に必要な読込と保存を含めプロセス内で受付順に調整します。正当な並行登録はスナップショットの交錯だけでは失敗せず、実際の DB 障害は失敗として返します。close は入口と runner を停止し、読取待機と未着手の書込を中止して、開始済みの永続書込を待ってから状態を解放します。遅延スナップショットは反映しません。業務コールバックはこのキューを占有しません。ノード間の整合性は引き続き共有 DB、バージョンとリースで保証し、この調整を分散ロックの代替にしません。
|
|
281
|
-
|
|
282
|
-
RelDB の初期化後に `scheduler.init()` でタスク、実行、ログの各テーブルを作成・検証します。構造が一致しない場合は初期化に失敗します。実行台帳と観測ログは用途に応じて管理してください。
|
|
283
|
-
|
|
284
|
-
## 設定
|
|
285
|
-
|
|
286
|
-
ライフサイクル。init にバックエンド/業務設定を渡し成功後に使用します。借用依存先の解放前に close の完了を待ち、正確な戻り値は例と公開署名に従います。
|
|
287
|
-
|
|
288
|
-
設定はホストが読込・検証してから渡します。秘密はサーバーの非公開環境に保存し、利用場面に応じてバックエンド・容量・期限・ログを選びます。変更後は再初期化の結果を確認してください。
|
|
289
|
-
|
|
290
|
-
[項目別の用途・適用場面・例](../../docs/usage/configuration/operations.md).
|
|
291
|
-
|
|
292
|
-
## エラー処理
|
|
293
|
-
|
|
294
|
-
領域操作は result.success を確認し、失敗時はモジュールのエラー定義と安全な説明を使います。コード・関連 ID・秘匿した原因をサーバーログに残します。同期ツール・ファクトリー・ストリーム反復・ライフサイクルは各署名に従い、Promise 完了だけで成功と判断しません。回復条件は各機能を参照してください。
|
|
295
|
-
|
|
296
|
-
`close()` を除くすべての公開 API は `HaiResult<T>` を返します。
|
|
23
|
+
[API 一覧](../../docs/usage/function/scheduler.ja.md#api-reference)で、呼び出し方、入力、戻り値、使用例を確認できます。
|
|
297
24
|
|
|
298
|
-
|
|
25
|
+
## データ構造
|
|
299
26
|
|
|
300
|
-
|
|
301
|
-
| ----------------------------------------- | ------------------- | -------------------- |
|
|
302
|
-
| `HaiSchedulerError.NOT_INITIALIZED` | `hai:scheduler:010` | 未初期化 |
|
|
303
|
-
| `HaiSchedulerError.INIT_FAILED` | `hai:scheduler:011` | 初期化に失敗 |
|
|
304
|
-
| `HaiSchedulerError.CONFIG_ERROR` | `hai:scheduler:012` | 設定エラー |
|
|
305
|
-
| `HaiSchedulerError.TASK_NOT_FOUND` | `hai:scheduler:020` | タスクが存在しない |
|
|
306
|
-
| `HaiSchedulerError.TASK_ALREADY_EXISTS` | `hai:scheduler:021` | タスクが既に存在する |
|
|
307
|
-
| `HaiSchedulerError.INVALID_CRON` | `hai:scheduler:022` | 無効な Cron 式 |
|
|
308
|
-
| `HaiSchedulerError.EXECUTION_FAILED` | `hai:scheduler:023` | 実行に失敗 |
|
|
309
|
-
| `HaiSchedulerError.JS_EXECUTION_FAILED` | `hai:scheduler:024` | JS 実行に失敗 |
|
|
310
|
-
| `HaiSchedulerError.API_EXECUTION_FAILED` | `hai:scheduler:025` | API 実行に失敗 |
|
|
311
|
-
| `HaiSchedulerError.DB_SAVE_FAILED` | `hai:scheduler:026` | DB 保存に失敗 |
|
|
312
|
-
| `HaiSchedulerError.ALREADY_RUNNING` | `hai:scheduler:027` | 実行中 |
|
|
313
|
-
| `HaiSchedulerError.NOT_RUNNING` | `hai:scheduler:028` | 実行していない |
|
|
314
|
-
| `HaiSchedulerError.JS_COMPILE_FAILED` | `hai:scheduler:030` | JS コンパイルに失敗 |
|
|
315
|
-
| `HaiSchedulerError.HOOK_EXECUTION_FAILED` | `hai:scheduler:031` | Hook 実行に失敗 |
|
|
316
|
-
| `HaiSchedulerError.LOG_PERSIST_FAILED` | `hai:scheduler:032` | ログ保存未確認 |
|
|
27
|
+
タスク、実行ログ、分散リース、復旧状態については[データ構造](../../docs/usage/data/scheduler.ja.md)を参照してください。
|
|
317
28
|
|
|
318
29
|
## 開発とテスト
|
|
319
30
|
|