feat(events): schema, CRUD and the core action registry (Phase 1)
EVENTS_PLAN.md Phase 1. Six of the nine core tables — the ones that do not
depend on the module contract — plus definitions CRUD, publish, archive, and
the action registry with core as its first registrant.
**Nothing dispatches.** There is no runner until Phase 2, so a run row is
created and stays `scheduled`. That is this phase's correct answer and the
surface renders it verbatim rather than hiding it.
Schema (`db/schema.sql`, append-only):
event_series, event_definitions, event_versions, event_runs,
event_run_steps, event_run_log. The four that need a writer —
event_action_settings, event_run_budget, event_run_resources,
event_run_participants — arrive with the phases that give them one.
Registry (`modules/registries.js` + `config/coreEventActions.js`):
registerEventActions staging and commit, with its own id namespace, the
closed risk and reversibility sets, revert() required iff and only iff
reversible: 'ledger', a bounded budgetMs and a param shape whose every
entry needs a type and an example. perform/revert/cost are stripped from
everything the catalog serves. Core declares core.announce, core.wait and
core.cue through the same staging area a module will use.
It is reachable ONLY by registerCore(): loader.js builds its own api facade
and has no method that delegates here, so no module can call it and
MODULE_API_VERSION is untouched. Phase 7 adds the facade and the bump.
Surface (13 routes under /api/v1/admin/events):
Reads staff-wide; publish, archive and run creation admin-only from this
phase per EVENTS.md §N2, even though the switchboard they will consult does
not exist yet — a button that is admin-only later and open now is a gate
nobody notices was missing. The live run controls and `verify` are absent
rather than stubbed, because nothing is in flight yet.
Four things the build settled, all recorded in docs:
- event_definitions gained a `spec` column. A draft's working copy cannot
be an event_versions row: that table is immutable and a run pins one.
- The spec validator must accept its own output. It added `actionVersion`
and `dormant` and then refused them as unknown keys, which would have made
the second save of any definition — and publish's re-validation —
impossible. A test caught it; both are now accepted and recomputed.
- A param's `example` is required, optional params included, matching
registerEventTriggers. It is the authoring form's placeholder.
- Two routes the §API-surface table did not name: GET /admin/events/:id and
GET /admin/events/series.
Core's three perform() bodies answer { ok: false, retry: false } rather than
{ ok: true }: `ok: true` on an action that did nothing is a recorded world
change that did not occur, which is the exact mistake §F's failure default
exists to prevent.
`conditions.checkLiteral` is exported and reused for step-param type checking
— one switch over the six types, so "is this a datetime" has one answer.
Verified: 44 new tests, whole server suite, `npm run check:modules`, routes
manifest and swagger regenerated (the manifest diff is +13 routes, zero moved).
Docs: RunicGateway/docs#209
Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
105
server/src/model/events/eventRuns.db.js
Normal file
105
server/src/model/events/eventRuns.db.js
Normal file
@@ -0,0 +1,105 @@
|
||||
// ── event_runs — SQL only ──────────────────────────────────────────────────
|
||||
//
|
||||
// EVENTS.md §D and §E. Phase 1 writes exactly one kind of row — a `scheduled`
|
||||
// occurrence — and reads them back for the admin surface. **The claim, the CAS
|
||||
// transitions and the lease reclaim are Phase 2's** and are deliberately not
|
||||
// stubbed here: a half-written claim is worse than no claim, because it reads as
|
||||
// protection.
|
||||
//
|
||||
// What Phase 1 does own is the INSERT, and it owns the important half of it:
|
||||
// materialisation is `INSERT IGNORE` against `UNIQUE (definition_id, scope,
|
||||
// scheduled_for)`, so a second attempt at one occurrence writes nothing and
|
||||
// answers honestly rather than raising a duplicate-key error a caller has to
|
||||
// interpret.
|
||||
|
||||
const { query } = require('../../utils/db')
|
||||
const { parseJson } = require('./eventJson')
|
||||
|
||||
const hydrate = (row) => row && { ...row, params: parseJson(row.params, null), rehearsal: Boolean(row.rehearsal) }
|
||||
|
||||
const SELECT_LIST = `
|
||||
SELECT r.*, d.title AS definition_title, d.slug AS definition_slug, v.version AS version_number
|
||||
FROM event_runs r
|
||||
JOIN event_definitions d ON d.id = r.definition_id
|
||||
JOIN event_versions v ON v.id = r.version_id
|
||||
`
|
||||
|
||||
/**
|
||||
* The admin run list. Newest occurrence first, across every definition.
|
||||
*
|
||||
* `limit` is interpolated after an integer coercion rather than bound, because
|
||||
* MariaDB will not take a placeholder in LIMIT on a prepared statement. It never
|
||||
* reaches SQL as anything but a number.
|
||||
*/
|
||||
const list = async ({ definitionId = null, status = null, limit = 100 } = {}) => {
|
||||
const where = []
|
||||
const args = []
|
||||
if (definitionId) {
|
||||
where.push('r.definition_id = ?')
|
||||
args.push(definitionId)
|
||||
}
|
||||
if (status) {
|
||||
where.push('r.status = ?')
|
||||
args.push(status)
|
||||
}
|
||||
const clause = where.length ? `WHERE ${where.join(' AND ')}` : ''
|
||||
const n = Math.min(Math.max(Number(limit) || 100, 1), 500)
|
||||
const rows = await query(
|
||||
`${SELECT_LIST} ${clause} ORDER BY r.scheduled_for DESC, r.id DESC LIMIT ${n}`,
|
||||
args,
|
||||
)
|
||||
return rows.map(hydrate)
|
||||
}
|
||||
|
||||
const getById = async (id) => {
|
||||
const [row] = await query(`${SELECT_LIST} WHERE r.id = ?`, [id])
|
||||
return hydrate(row)
|
||||
}
|
||||
|
||||
/**
|
||||
* Materialise one occurrence. Answers the row id, or `null` when one already
|
||||
* existed — which is not an error and is the ordinary answer under a tick that
|
||||
* overran into the next one.
|
||||
*/
|
||||
const materialise = async (run) => {
|
||||
const result = await query(
|
||||
`INSERT IGNORE INTO event_runs
|
||||
(definition_id, version_id, scope, scheduled_for, timezone, concurrency_key,
|
||||
params, rehearsal, started_by)
|
||||
VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?)`,
|
||||
[
|
||||
run.definition_id,
|
||||
run.version_id,
|
||||
run.scope || '',
|
||||
run.scheduled_for,
|
||||
run.timezone || 'UTC',
|
||||
run.concurrency_key,
|
||||
run.params === null || run.params === undefined ? null : JSON.stringify(run.params),
|
||||
run.rehearsal ? 1 : 0,
|
||||
run.started_by,
|
||||
],
|
||||
)
|
||||
return Number(result?.affectedRows || 0) === 1 ? result.insertId : null
|
||||
}
|
||||
|
||||
/** The occurrence the unique key names, whether or not this call created it. */
|
||||
const findOccurrence = async (definitionId, scope, scheduledFor) => {
|
||||
const [row] = await query(
|
||||
`${SELECT_LIST} WHERE r.definition_id = ? AND r.scope = ? AND r.scheduled_for = ?`,
|
||||
[definitionId, scope || '', scheduledFor],
|
||||
)
|
||||
return hydrate(row)
|
||||
}
|
||||
|
||||
/** Is anything of this definition not yet terminal? The archive pre-check. */
|
||||
const countActiveForDefinition = async (definitionId) => {
|
||||
const [row] = await query(
|
||||
`SELECT COUNT(*) AS n FROM event_runs
|
||||
WHERE definition_id = ?
|
||||
AND status IN ('scheduled','starting','running','paused','ending')`,
|
||||
[definitionId],
|
||||
)
|
||||
return Number(row?.n || 0)
|
||||
}
|
||||
|
||||
module.exports = { list, getById, materialise, findOccurrence, countActiveForDefinition }
|
||||
Reference in New Issue
Block a user