@smthrs/triggers 0.0.0-stage → 1.0.0-rc.3

package/src/migrations/0001_triggers.ts

@@ -0,0 +1,43 @@
+/** @since 0.1.0 */
+
+import * as Dialect from "@smthrs/database/Dialect"
+import * as Effect from "effect/Effect"
+import * as SqlClient from "effect/unstable/sql/SqlClient"
+
+/**
+ * Creates the `flows_triggers` and `flows_trigger_fires` tables.
+ *
+ * A named export rather than `export default`: the CommonJS build reads a
+ * default import of a sibling module as the whole exports object, so the
+ * migrator received `{ default }` instead of this Effect.
+ *
+ * @category migrations
+ * @since 0.1.0
+ */
+export const triggers: Effect.Effect<void, unknown, SqlClient.SqlClient> = Effect.gen(function*() {
+  const sql = yield* SqlClient.SqlClient
+  yield* sql`CREATE TABLE IF NOT EXISTS flows_triggers (
+    trigger_id TEXT PRIMARY KEY,
+    flow_id TEXT NOT NULL,
+    input_json TEXT NOT NULL,
+    cron TEXT NOT NULL,
+    timezone TEXT,
+    overlap TEXT NOT NULL CHECK (overlap IN ('skip', 'buffer-one', 'supersede')),
+    catch_up TEXT NOT NULL CHECK (catch_up IN ('none', 'one', 'all')),
+    max_catch_up ${Dialect.integer(sql)} NOT NULL CHECK (max_catch_up >= 0),
+    enabled ${Dialect.integer(sql)} NOT NULL CHECK (enabled IN (0, 1)),
+    revision ${Dialect.integer(sql)} NOT NULL,
+    last_fired_at_ms ${Dialect.integer(sql)},
+    pending_at_ms ${Dialect.integer(sql)},
+    active_run_id TEXT
+  )`
+  yield* sql`CREATE TABLE IF NOT EXISTS flows_trigger_fires (
+    trigger_id TEXT NOT NULL,
+    occurrence_at_ms ${Dialect.integer(sql)} NOT NULL,
+    outcome TEXT,
+    run_id TEXT,
+    error TEXT,
+    PRIMARY KEY (trigger_id, occurrence_at_ms),
+    FOREIGN KEY (trigger_id) REFERENCES flows_triggers (trigger_id)
+  )`
+})

package/src/migrations/0002_reservation_lease.ts

@@ -0,0 +1,20 @@
+/** @since 0.1.0 */
+
+import * as Dialect from "@smthrs/database/Dialect"
+import * as Effect from "effect/Effect"
+import * as SqlClient from "effect/unstable/sql/SqlClient"
+
+/**
+ * Adds `active_claimed_at_ms`, the lease start of a launch reservation.
+ *
+ * A named export rather than `export default`: the CommonJS build reads a
+ * default import of a sibling module as the whole exports object, so the
+ * migrator received `{ default }` instead of this Effect.
+ *
+ * @category migrations
+ * @since 0.1.0
+ */
+export const reservationLease: Effect.Effect<void, unknown, SqlClient.SqlClient> = Effect.gen(function*() {
+  const sql = yield* SqlClient.SqlClient
+  yield* sql`ALTER TABLE flows_triggers ADD COLUMN active_claimed_at_ms ${Dialect.integer(sql)}`
+})

package/src/migrations/0003_heartbeat.ts

@@ -0,0 +1,24 @@
+/** @since 1.0.0-rc.0 */
+
+import * as Dialect from "@smthrs/database/Dialect"
+import * as Effect from "effect/Effect"
+import * as SqlClient from "effect/unstable/sql/SqlClient"
+
+/**
+ * Creates `flows_scheduler_heartbeat`, one row per scheduler host holding the
+ * last poll it recorded, so a listing can say whether anything is listening.
+ *
+ * A named export rather than `export default`: the CommonJS build reads a
+ * default import of a sibling module as the whole exports object, so the
+ * migrator received `{ default }` instead of this Effect.
+ *
+ * @category migrations
+ * @since 1.0.0-rc.0
+ */
+export const schedulerHeartbeat: Effect.Effect<void, unknown, SqlClient.SqlClient> = Effect.gen(function*() {
+  const sql = yield* SqlClient.SqlClient
+  yield* sql`CREATE TABLE IF NOT EXISTS flows_scheduler_heartbeat (
+    host TEXT PRIMARY KEY,
+    ticked_at_ms ${Dialect.integer(sql)} NOT NULL
+  )`
+})

package/src/migrations/0004_fire_run_index.ts

@@ -0,0 +1,21 @@
+/** @since 1.0.0-rc.1 */
+
+import * as Effect from "effect/Effect"
+import * as SqlClient from "effect/unstable/sql/SqlClient"
+
+/**
+ * Indexes `flows_trigger_fires` by `run_id`, so a fires listing filtered to
+ * one run and the prune's active-run check read an index instead of the
+ * whole ledger.
+ *
+ * A named export rather than `export default`: the CommonJS build reads a
+ * default import of a sibling module as the whole exports object, so the
+ * migrator received `{ default }` instead of this Effect.
+ *
+ * @category migrations
+ * @since 1.0.0-rc.1
+ */
+export const fireRunIndex: Effect.Effect<void, unknown, SqlClient.SqlClient> = Effect.gen(function*() {
+  const sql = yield* SqlClient.SqlClient
+  yield* sql`CREATE INDEX IF NOT EXISTS flows_trigger_fires_run_id ON flows_trigger_fires (run_id)`
+})

package/src/migrations/index.ts

@@ -0,0 +1,40 @@
+/** @since 0.1.0 */
+
+import * as Layer from "effect/Layer"
+import * as Migrator from "effect/unstable/sql/Migrator"
+import { triggers } from "./0001_triggers.ts"
+import { reservationLease } from "./0002_reservation_lease.ts"
+import { schedulerHeartbeat } from "./0003_heartbeat.ts"
+import { fireRunIndex } from "./0004_fire_run_index.ts"
+
+/**
+ * The migration record {@link run} applies, keyed by migration file name.
+ *
+ * Exported so a test and the release smoke can assert that every entry is the
+ * migration Effect itself in both the ESM and the CommonJS build.
+ *
+ * @category migrations
+ * @since 1.0.0-rc.0
+ */
+export const migrations = {
+  "0001_triggers": triggers,
+  "0002_reservation_lease": reservationLease,
+  "0003_heartbeat": schedulerHeartbeat,
+  "0004_fire_run_index": fireRunIndex
+}
+
+/**
+ * Applies the triggers schema migrations.
+ *
+ * @category migrations
+ * @since 0.1.0
+ */
+export const run = Migrator.make({})({ loader: Migrator.fromRecord(migrations), table: "flows_trigger_migrations" })
+
+/**
+ * Runs {@link run} once as a layer.
+ *
+ * @category layers
+ * @since 0.1.0
+ */
+export const layer = Layer.effectDiscard(run)