File size: 7,420 Bytes
5cb63c1 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 | import type { DatabaseSync } from "node:sqlite";
import { isDeepStrictEqual } from "node:util";
import type { OpenClawStateDatabase } from "../../state/openclaw-state-db-contract.js";
import { resolveCronJobConfigRevision } from "../config-revision.js";
import type { CronJobState, CronStoredJob, CronStoreFile } from "../types.js";
import { deleteCronQuarantinedJobsFromDatabase, saveCronQuarantinedJobs } from "./quarantine.js";
import {
deleteCronJobRowInDatabase,
loadedCronStoreFromRows,
loadCronRows,
replaceCronRows,
upsertCronJobRow,
updateCronRuntimeRows,
} from "./row-codec.js";
import {
loadCronRuntimeAuthorities,
repairCronRuntimeAuthorityRows,
replaceCronRuntimeAuthorityRows,
} from "./runtime-authority-store.js";
import { CronJobsStoreChangedError } from "./save-error.js";
import type {
CronStoreChangesOptions,
CronStoreSaveOptions,
PreparedCronStoreChanges,
} from "./save.types.js";
import type { CronStoreTransactionHooks } from "./transaction-hooks.types.js";
function mergeCronRuntimeChanges(
previous: CronJobState,
next: CronJobState,
current: CronJobState,
): CronJobState {
const merged = structuredClone(current);
for (const key of new Set([...Object.keys(previous), ...Object.keys(next)])) {
if (isDeepStrictEqual(Reflect.get(previous, key), Reflect.get(next, key))) {
continue;
}
if (Object.hasOwn(next, key)) {
Reflect.set(merged, key, structuredClone(Reflect.get(next, key)));
} else {
Reflect.deleteProperty(merged, key);
}
}
if (previous.runningAtMs !== next.runningAtMs) {
merged.runningReceiptId =
next.runningAtMs === current.runningAtMs ? current.runningReceiptId : next.runningReceiptId;
}
return merged;
}
function mergeCronRuntimeAuthority(
previous: CronStoredJob,
next: CronStoredJob,
current: CronStoredJob,
): CronStoredJob {
const merged = { ...next };
const source =
!isDeepStrictEqual(previous.runtimeAuthority, next.runtimeAuthority) ||
previous.runtimeAuthorityRecoveryRequired !== next.runtimeAuthorityRecoveryRequired
? next
: current;
if (source.runtimeAuthority) {
merged.runtimeAuthority = source.runtimeAuthority;
} else {
delete merged.runtimeAuthority;
}
if (source.runtimeAuthorityRecoveryRequired === true) {
merged.runtimeAuthorityRecoveryRequired = true;
} else {
delete merged.runtimeAuthorityRecoveryRequired;
}
return merged;
}
export function prepareCronStoreChanges(
previous: CronStoreFile,
next: CronStoreFile,
): PreparedCronStoreChanges {
const previousById = new Map(previous.jobs.map((job) => [job.id, job] as const));
const nextById = new Map(next.jobs.map((job) => [job.id, job] as const));
const changedIds = new Set(
[...new Set([...previousById.keys(), ...nextById.keys()])].filter(
(jobId) => !isDeepStrictEqual(previousById.get(jobId), nextById.get(jobId)),
),
);
return { previousById, nextById, changedIds };
}
/** Applies prepared changes inside the caller's synchronous write transaction. */
export function saveCronStoreChangesInDatabase(
db: DatabaseSync,
storeKey: string,
resolvedStorePath: string,
prepared: PreparedCronStoreChanges,
opts?: CronStoreChangesOptions,
hooks?: CronStoreTransactionHooks,
): CronStoreFile {
const { previousById, nextById, changedIds } = prepared;
const rows = loadCronRows(db, storeKey);
const rowsById = new Map(rows.map((row) => [row.job_id, row] as const));
const currentJobs = loadedCronStoreFromRows(rows).store.jobs;
const authority = loadCronRuntimeAuthorities({ db, storeKey, jobs: currentJobs });
if (authority.repairJobIds.length > 0) {
repairCronRuntimeAuthorityRows({
db,
storeKey,
jobs: currentJobs,
jobIds: authority.repairJobIds,
});
}
const currentById = new Map(currentJobs.map((job) => [job.id, job] as const));
hooks?.beforeWrite?.(db);
let nextSortOrder = rows.reduce((max, row) => Math.max(max, row.sort_order), -1) + 1;
for (const jobId of changedIds) {
const before = previousById.get(jobId);
const after = nextById.get(jobId);
const current = currentById.get(jobId);
if (
before &&
current &&
resolveCronJobConfigRevision(current) !== resolveCronJobConfigRevision(before)
) {
throw new CronJobsStoreChangedError(resolvedStorePath);
}
if (!after) {
if (current) {
deleteCronJobRowInDatabase(db, storeKey, jobId);
}
currentById.delete(jobId);
continue;
}
if (before) {
if (!current) {
throw new CronJobsStoreChangedError(resolvedStorePath);
}
} else if (current && opts?.preserveConcurrentAdds) {
continue;
} else if (current) {
throw new CronJobsStoreChangedError(resolvedStorePath);
}
const merged: CronStoredJob = current
? {
...mergeCronRuntimeAuthority(before ?? after, after, current),
state: mergeCronRuntimeChanges(before?.state ?? {}, after.state, current.state),
updatedAtMs: Math.max(after.updatedAtMs, current.updatedAtMs),
}
: after;
const persisted = upsertCronJobRow(
db,
storeKey,
merged,
rowsById.get(jobId)?.sort_order ?? nextSortOrder++,
);
replaceCronRuntimeAuthorityRows({ db, storeKey, jobs: [persisted] });
currentById.set(jobId, persisted);
}
hooks?.afterWrite?.(db);
return { version: 1, jobs: [...currentById.values()] } satisfies CronStoreFile;
}
export function replaceCronStoreRowsInDatabase(
db: DatabaseSync,
storeKey: string,
store: CronStoreFile,
preserveRuntimeState: boolean,
): void {
const replaced = replaceCronRows(db, storeKey, store, { preserveRuntimeState });
replaceCronRuntimeAuthorityRows({
db,
storeKey,
jobs: replaced.jobs,
preserveExistingForJobIds: preserveRuntimeState ? replaced.existingJobIds : undefined,
writeMissingForJobIds: preserveRuntimeState ? replaced.legacyAuthorityJobIds : undefined,
});
}
export function isCronRuntimeOnlySave(opts?: CronStoreSaveOptions): boolean {
return (
opts?.stateOnly === true &&
!opts.quarantine?.entries.length &&
!opts.deleteQuarantineEntries?.length
);
}
/** Persists a validated store inside the caller's synchronous write transaction. */
export function saveCronStoreInDatabase(
database: OpenClawStateDatabase,
storeKey: string,
store: CronStoreFile,
opts?: CronStoreSaveOptions,
hooks?: CronStoreTransactionHooks,
): void {
const stateOnly = isCronRuntimeOnlySave(opts);
hooks?.beforeWrite?.(database.db);
if (opts?.quarantine?.entries.length) {
saveCronQuarantinedJobs({
storePath: storeKey,
entries: opts.quarantine.entries,
nowMs: opts.quarantine.nowMs,
database,
});
}
if (opts?.deleteQuarantineEntries?.length) {
deleteCronQuarantinedJobsFromDatabase({
database: database.db,
storePath: storeKey,
entries: opts.deleteQuarantineEntries,
});
}
// Hot-path timer updates mutate runtime columns only; malformed-row
// quarantine and full replacement commit together or roll back together.
if (stateOnly) {
updateCronRuntimeRows(database.db, storeKey, store);
hooks?.afterWrite?.(database.db);
return;
}
replaceCronStoreRowsInDatabase(database.db, storeKey, store, opts?.preserveRuntimeState === true);
hooks?.afterWrite?.(database.db);
}
|