@pramen/server 0.0.58 → 0.0.60
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/dist/cli.js +99 -2
- package/dist/durable-object.d.ts +2 -0
- package/dist/durable-object.js +48 -0
- package/dist/index.d.ts +5 -3
- package/dist/index.js +4 -2
- package/dist/pramen.d.ts +7 -1
- package/dist/pramen.js +2 -0
- package/dist/runtime/data-migrations.d.ts +88 -0
- package/dist/runtime/data-migrations.js +256 -0
- package/dist/runtime/mail.d.ts +34 -2
- package/dist/runtime/mail.js +82 -9
- package/dist/sdk/acl.d.ts +13 -5
- package/dist/sdk/acl.js +13 -5
- package/dist/sdk/handlers.d.ts +41 -0
- package/dist/sdk/iso-timestamps.d.ts +54 -0
- package/dist/sdk/iso-timestamps.js +119 -0
- package/dist/sdk/schema.d.ts +39 -3
- package/dist/sdk/schema.js +40 -4
- package/dist/worker.js +88 -1
- package/package.json +1 -1
- package/src/cli.ts +125 -4
- package/src/durable-object.ts +53 -0
- package/src/index.ts +6 -3
- package/src/pramen.ts +9 -1
- package/src/runtime/data-migrations.ts +343 -0
- package/src/runtime/mail.ts +80 -9
- package/src/sdk/acl.ts +13 -5
- package/src/sdk/handlers.ts +43 -0
- package/src/sdk/iso-timestamps.ts +146 -0
- package/src/sdk/schema.ts +41 -4
- package/src/worker.ts +89 -1
|
@@ -0,0 +1,256 @@
|
|
|
1
|
+
// Data migrations — the imperative, recorded half of schema evolution.
|
|
2
|
+
//
|
|
3
|
+
// `migrate()` (runtime/migrate.ts) is declarative: it diffs the live table shape against
|
|
4
|
+
// the declared schema and enacts the structural delta. A diff between two SHAPES can only
|
|
5
|
+
// ever express structure, never TRANSFORMATION — it cannot split `name` into
|
|
6
|
+
// `firstName`/`lastName`, backfill the nullable column `ADD COLUMN` just created (SQLite
|
|
7
|
+
// can't add NOT NULL to a populated table, so every new column starts as a hole), rewrite
|
|
8
|
+
// `priceHalers` → `priceCzk`, or normalize a `t.json()` blob whose shape changed.
|
|
9
|
+
//
|
|
10
|
+
// So: structure stays declarative, data becomes imperative, ordered, and RECORDED. Each
|
|
11
|
+
// `app.migrations` entry runs at most once per `(id, partition)`, its ledger row written in
|
|
12
|
+
// `_pramen_migrations` in the SAME transaction as the work. That is what makes a
|
|
13
|
+
// non-idempotent transformation safe, and it is precisely why `app.bootstrap` cannot be
|
|
14
|
+
// stretched to cover this (bootstrap runs on EVERY boot, must be idempotent, and swallows
|
|
15
|
+
// its errors).
|
|
16
|
+
//
|
|
17
|
+
// Fail closed. A throwing migration records no ledger row, does not let the boot complete,
|
|
18
|
+
// and propagates — the tenant's request fails and the migration is retried on the next
|
|
19
|
+
// fetch. This mirrors migrate()'s "withhold the schema hash on a skip" invariant: the store
|
|
20
|
+
// is never marked as having reached a state it did not reach.
|
|
21
|
+
//
|
|
22
|
+
// CLAIM FIRST, UNDER A LEASE. The ledger row is taken BEFORE the work — one atomic upsert
|
|
23
|
+
// that inserts a pending row, or steals one whose lease has expired, or does nothing — and
|
|
24
|
+
// the migration runs only if that statement won the row. On the DO this is merely bookkeeping
|
|
25
|
+
// order inside one transaction. On D1 it is what makes the once-only contract hold at all:
|
|
26
|
+
// there is no single writer and no interactive transaction, `d1Ready` is per-isolate, so two
|
|
27
|
+
// cold isolates racing a `SET n = n * 2` backfill would each read an empty ledger, each run
|
|
28
|
+
// it, and quadruple the data. The conflicting upsert is the lock.
|
|
29
|
+
//
|
|
30
|
+
// The row therefore has two states, distinguished by `leaseUntil`: IN FLIGHT (non-NULL — a
|
|
31
|
+
// runner holds it until that instant) and APPLIED (NULL). Only an applied row counts as
|
|
32
|
+
// applied, so an in-flight migration reads as pending everywhere, including the admin ledger.
|
|
33
|
+
//
|
|
34
|
+
// A runner that finds a LIVE lease does not skip — skipping would let it serve traffic
|
|
35
|
+
// against half-migrated data, and would strand the migration entirely if the holder then
|
|
36
|
+
// failed. It waits for the holder, up to WAIT_BUDGET_MS, and then either proceeds (the holder
|
|
37
|
+
// committed), takes the row (the holder released it), or fails closed. A holder that dies
|
|
38
|
+
// without releasing — an isolate evicted mid-backfill, which no compensating DELETE can
|
|
39
|
+
// cover — is recovered by the lease simply expiring.
|
|
40
|
+
//
|
|
41
|
+
// Written against the `Driver`/`Dialect` seam only (no `cloudflare:workers`), so the same
|
|
42
|
+
// runner drives the DO boot path and the D1/Worker path.
|
|
43
|
+
import { DEFAULT_PARTITION, partitionsOf } from "../sdk/schema";
|
|
44
|
+
export const MIGRATIONS_TABLE = "_pramen_migrations";
|
|
45
|
+
/** Create the ledger if absent. Idempotent — run on every boot before the runner and from
|
|
46
|
+
* the /__migrations endpoint (a DO that has never applied one still answers). Internal
|
|
47
|
+
* table (`_pramen_` prefix), so `isInternalTable()` keeps the migrator's hands off it.
|
|
48
|
+
*
|
|
49
|
+
* `partition` is a reserved-ish word in some engines, so every identifier goes through
|
|
50
|
+
* `dialect.id(...)` (the single `quoteIdent` source of truth) rather than being interpolated
|
|
51
|
+
* bare — here and in every query below. */
|
|
52
|
+
export async function ensureMigrationsTable(driver) {
|
|
53
|
+
const d = driver.dialect;
|
|
54
|
+
const t = d.id(MIGRATIONS_TABLE);
|
|
55
|
+
await driver.exec(`CREATE TABLE IF NOT EXISTS ${t} (` +
|
|
56
|
+
`${d.id("id")} TEXT NOT NULL, ${d.id("partition")} TEXT NOT NULL, ${d.id("appliedAt")} TEXT NOT NULL, ` +
|
|
57
|
+
`${d.id("leaseUntil")} INTEGER, PRIMARY KEY (${d.id("id")}, ${d.id("partition")}))`, []);
|
|
58
|
+
// `leaseUntil` was added after the table's first shape. Probe for it with a zero-row SELECT
|
|
59
|
+
// rather than PRAGMA table_info: the PRAGMA is what workerd's DO SQLite authorizer starts
|
|
60
|
+
// rejecting (SQLITE_AUTH) once the alarm API has run in the object, and this runs on every
|
|
61
|
+
// boot. Adding a nullable column is a plain ALTER — no rebuild, and existing rows read as
|
|
62
|
+
// applied, which is what they are.
|
|
63
|
+
const hasLease = await driver
|
|
64
|
+
.exec(`SELECT ${d.id("leaseUntil")} FROM ${t} LIMIT 0`, [])
|
|
65
|
+
.then(() => true)
|
|
66
|
+
.catch(() => false);
|
|
67
|
+
if (!hasLease)
|
|
68
|
+
await driver.exec(`ALTER TABLE ${t} ADD COLUMN ${d.id("leaseUntil")} INTEGER`, []);
|
|
69
|
+
}
|
|
70
|
+
/** Ledger rows for one partition — or every partition when `partition` is omitted (the D1
|
|
71
|
+
* store, which holds one shared ledger for all of them). Oldest first. */
|
|
72
|
+
export async function appliedMigrations(driver, partition) {
|
|
73
|
+
const d = driver.dialect;
|
|
74
|
+
// `leaseUntil IS NULL` is the definition of applied: a row a runner is still holding is
|
|
75
|
+
// in flight, and must read as PENDING everywhere — the admin ledger and the CLI included.
|
|
76
|
+
const scope = partition === undefined ? "" : ` AND ${d.id("partition")} = ${d.placeholder(1)}`;
|
|
77
|
+
const where = ` WHERE ${d.id("leaseUntil")} IS NULL${scope}`;
|
|
78
|
+
const rows = await driver.exec(`SELECT ${d.id("id")}, ${d.id("partition")}, ${d.id("appliedAt")} FROM ${d.id(MIGRATIONS_TABLE)}${where} ` +
|
|
79
|
+
`ORDER BY ${d.id("appliedAt")}, ${d.id("id")}`, partition === undefined ? [] : [d.encode(partition)]);
|
|
80
|
+
return rows.map((r) => ({ id: String(r.id), partition: String(r.partition), appliedAt: String(r.appliedAt) }));
|
|
81
|
+
}
|
|
82
|
+
/** The migrations that belong to `partition`: an entry with no declared partition belongs
|
|
83
|
+
* to the default one. Both boot paths select through this, so "which partition owns this
|
|
84
|
+
* migration" is answered in exactly one place. */
|
|
85
|
+
export function migrationsForPartition(migrations, partition) {
|
|
86
|
+
return migrations.filter((m) => (m.partition ?? DEFAULT_PARTITION) === partition);
|
|
87
|
+
}
|
|
88
|
+
export const DEFAULT_LEASE = { ttlMs: 60_000, waitMs: 5_000, pollMs: 100 };
|
|
89
|
+
/** Run every pending migration, in DECLARATION order, each inside its own
|
|
90
|
+
* `driver.transaction()`, CLAIMING its ledger row before it runs the work — so "the work
|
|
91
|
+
* happened" and "the work is recorded" cannot come apart on a substrate with real
|
|
92
|
+
* transactions (the DO), and cannot double-run on one without (D1). A migration whose claim
|
|
93
|
+
* loses the race (another isolate holds it, or a previous boot applied it) is skipped.
|
|
94
|
+
*
|
|
95
|
+
* D1 CAVEAT: `D1Driver.transaction(fn)` is `fn()` (D1 has no interactive transactions), so
|
|
96
|
+
* there the claim and the work do NOT commit together. A throw therefore RELEASES the claim
|
|
97
|
+
* explicitly (a compensating DELETE, issued inside the transaction so the DO simply rolls it
|
|
98
|
+
* back with everything else) — otherwise a failed migration would stay marked as applied,
|
|
99
|
+
* which is the one outcome the fail-closed contract exists to prevent. A holder that dies
|
|
100
|
+
* without reaching that DELETE is covered by the lease expiring instead. Prefer SQL that
|
|
101
|
+
* tolerates a re-run (`WHERE col IS NULL`) when the D1 store is in play: a mid-flight failure
|
|
102
|
+
* leaves the partial writes behind.
|
|
103
|
+
*
|
|
104
|
+
* Fails CLOSED: the first throw aborts the run, so migrations declared after it do not run
|
|
105
|
+
* either (order is a contract — a later one may depend on an earlier one's output). */
|
|
106
|
+
export async function runDataMigrations(driver, migrations, opts) {
|
|
107
|
+
const applied = [];
|
|
108
|
+
const skipped = [];
|
|
109
|
+
const pending = opts.partition === undefined ? migrations : migrationsForPartition(migrations, opts.partition);
|
|
110
|
+
if (pending.length === 0)
|
|
111
|
+
return { applied, skipped };
|
|
112
|
+
const lease = { ...DEFAULT_LEASE, ...opts.lease };
|
|
113
|
+
await ensureMigrationsTable(driver);
|
|
114
|
+
const done = new Set((await appliedMigrations(driver, opts.partition)).map((r) => ledgerKey(r.id, r.partition)));
|
|
115
|
+
for (const m of pending) {
|
|
116
|
+
const partition = m.partition ?? DEFAULT_PARTITION;
|
|
117
|
+
// The cheap pre-check: skip without opening a transaction for what a previous boot
|
|
118
|
+
// already applied (the common case — every boot after the first). `claim` is what
|
|
119
|
+
// actually decides; this only keeps the steady state free of no-op transactions.
|
|
120
|
+
if (done.has(ledgerKey(m.id, partition))) {
|
|
121
|
+
skipped.push(m.id);
|
|
122
|
+
continue;
|
|
123
|
+
}
|
|
124
|
+
let ran = false;
|
|
125
|
+
try {
|
|
126
|
+
await driver.transaction(async () => {
|
|
127
|
+
// Take the row, waiting out any live lease. "applied" means another runner finished
|
|
128
|
+
// it while we waited — nothing left to do, and we now know the data IS migrated.
|
|
129
|
+
if ((await acquire(driver, m.id, partition, lease)) === "applied")
|
|
130
|
+
return;
|
|
131
|
+
ran = true;
|
|
132
|
+
try {
|
|
133
|
+
await m.up(opts.makeContext(partition));
|
|
134
|
+
await complete(driver, m.id, partition);
|
|
135
|
+
}
|
|
136
|
+
catch (e) {
|
|
137
|
+
await release(driver, m.id, partition); // no-op on the DO (rolled back anyway)
|
|
138
|
+
throw e;
|
|
139
|
+
}
|
|
140
|
+
});
|
|
141
|
+
}
|
|
142
|
+
catch (e) {
|
|
143
|
+
// Name the migration in the message: the raw SQL error alone gives no clue WHICH of
|
|
144
|
+
// an ordered list failed, and the boot it aborted is the tenant's first request.
|
|
145
|
+
throw new Error(`[pramen] data migration ${JSON.stringify(m.id)} failed (partition=${partition}): ` +
|
|
146
|
+
`${e instanceof Error ? e.message : String(e)}`, { cause: e });
|
|
147
|
+
}
|
|
148
|
+
if (!ran) {
|
|
149
|
+
skipped.push(m.id);
|
|
150
|
+
continue;
|
|
151
|
+
}
|
|
152
|
+
console.log(`[pramen] data migration ${JSON.stringify(m.id)} applied (partition=${partition})`);
|
|
153
|
+
applied.push(m.id);
|
|
154
|
+
}
|
|
155
|
+
return { applied, skipped };
|
|
156
|
+
}
|
|
157
|
+
/** The ledger is keyed by (id, partition) — the same reason the schema hash is
|
|
158
|
+
* `schema_hash:<partition>`: partitions are independent DOs and must not thrash each
|
|
159
|
+
* other's state. NUL-joined, so no (id, partition) pair can collide with another. */
|
|
160
|
+
const ledgerKey = (id, partition) => `${id}\u0000${partition}`;
|
|
161
|
+
/** ONE atomic statement that does all three things a claim must: insert the row when the
|
|
162
|
+
* migration is pending, STEAL it when a previous holder's lease has expired (that holder is
|
|
163
|
+
* presumed dead — an isolate evicted mid-backfill releases nothing), and do nothing when the
|
|
164
|
+
* row is applied or a live lease holds it. `RETURNING` fires only when a row was actually
|
|
165
|
+
* written, so it reports which happened. The upsert's `WHERE` is what confines the steal to
|
|
166
|
+
* an expired lease: without it this would be a plain overwrite and two live runners would
|
|
167
|
+
* both "win". */
|
|
168
|
+
async function tryClaim(driver, id, partition, now, ttlMs) {
|
|
169
|
+
const d = driver.dialect;
|
|
170
|
+
const t = d.id(MIGRATIONS_TABLE);
|
|
171
|
+
const params = [id, partition, new Date(now).toISOString(), now + ttlMs, now];
|
|
172
|
+
const rows = await driver.exec(`INSERT INTO ${t} (${d.id("id")}, ${d.id("partition")}, ${d.id("appliedAt")}, ${d.id("leaseUntil")}) ` +
|
|
173
|
+
`VALUES (${d.placeholder(1)}, ${d.placeholder(2)}, ${d.placeholder(3)}, ${d.placeholder(4)}) ` +
|
|
174
|
+
`ON CONFLICT (${d.id("id")}, ${d.id("partition")}) DO UPDATE SET ` +
|
|
175
|
+
`${d.id("appliedAt")} = excluded.${d.id("appliedAt")}, ${d.id("leaseUntil")} = excluded.${d.id("leaseUntil")} ` +
|
|
176
|
+
`WHERE ${t}.${d.id("leaseUntil")} IS NOT NULL AND ${t}.${d.id("leaseUntil")} <= ${d.placeholder(5)} ` +
|
|
177
|
+
`RETURNING ${d.id("id")}`, params.map((v) => d.encode(v)));
|
|
178
|
+
if (rows.length > 0)
|
|
179
|
+
return "claimed";
|
|
180
|
+
// Nothing written — so the row exists and we did not qualify. Which of the two is it?
|
|
181
|
+
const [row] = await driver.exec(`SELECT ${d.id("leaseUntil")} FROM ${t} WHERE ${d.id("id")} = ${d.placeholder(1)} AND ${d.id("partition")} = ${d.placeholder(2)}`, [id, partition].map((v) => d.encode(v)));
|
|
182
|
+
// Gone between the two statements (a holder released it) — contended, not applied.
|
|
183
|
+
if (!row)
|
|
184
|
+
return "held";
|
|
185
|
+
return row.leaseUntil == null ? "applied" : "held";
|
|
186
|
+
}
|
|
187
|
+
/** Take the row, waiting out a live lease. Returns "applied" when someone else finished it
|
|
188
|
+
* while we waited — in which case the caller must NOT run the migration, but CAN proceed
|
|
189
|
+
* knowing the data is migrated. That distinction is the point: skipping a live lease outright
|
|
190
|
+
* (the previous behavior) let a runner serve traffic against half-migrated data, and stranded
|
|
191
|
+
* the migration on that isolate entirely if the holder then failed.
|
|
192
|
+
*
|
|
193
|
+
* On the DO this never waits — one Durable Object is a single writer and the migration runs
|
|
194
|
+
* inside `blockConcurrencyWhile`, so a second concurrent first-fetch is queued by the platform
|
|
195
|
+
* rather than contending here. The wait exists for D1, where nothing serializes isolates. */
|
|
196
|
+
async function acquire(driver, id, partition, lease) {
|
|
197
|
+
const deadline = Date.now() + lease.waitMs;
|
|
198
|
+
for (;;) {
|
|
199
|
+
const outcome = await tryClaim(driver, id, partition, Date.now(), lease.ttlMs);
|
|
200
|
+
if (outcome !== "held")
|
|
201
|
+
return outcome;
|
|
202
|
+
if (Date.now() >= deadline) {
|
|
203
|
+
// Fail closed rather than guess. Another runner is mid-flight; the request retries and
|
|
204
|
+
// will usually find it applied. Serving on through a migration we know is unfinished is
|
|
205
|
+
// the one thing that must not happen.
|
|
206
|
+
throw new Error(`another runner holds the lease and did not finish within ${lease.waitMs}ms`);
|
|
207
|
+
}
|
|
208
|
+
await new Promise((r) => setTimeout(r, lease.pollMs));
|
|
209
|
+
}
|
|
210
|
+
}
|
|
211
|
+
/** Mark the migration applied: drop the lease (NULL is the definition of applied) and stamp
|
|
212
|
+
* the instant the work actually committed rather than the one the claim was taken. */
|
|
213
|
+
async function complete(driver, id, partition) {
|
|
214
|
+
const d = driver.dialect;
|
|
215
|
+
await driver.exec(`UPDATE ${d.id(MIGRATIONS_TABLE)} SET ${d.id("appliedAt")} = ${d.placeholder(1)}, ${d.id("leaseUntil")} = NULL ` +
|
|
216
|
+
`WHERE ${d.id("id")} = ${d.placeholder(2)} AND ${d.id("partition")} = ${d.placeholder(3)}`, [new Date().toISOString(), id, partition].map((v) => d.encode(v)));
|
|
217
|
+
}
|
|
218
|
+
/** Give the claim back after a failed `up()`, so the next runner retries immediately instead
|
|
219
|
+
* of waiting out the lease. Only observable where `transaction()` does not roll back (D1); on
|
|
220
|
+
* the DO the enclosing transaction discards this along with the claim itself. Guarded on
|
|
221
|
+
* `leaseUntil IS NOT NULL` so it can only ever delete an IN-FLIGHT row — never an applied one,
|
|
222
|
+
* whatever else has happened to the ledger in between. */
|
|
223
|
+
async function release(driver, id, partition) {
|
|
224
|
+
const d = driver.dialect;
|
|
225
|
+
await driver.exec(`DELETE FROM ${d.id(MIGRATIONS_TABLE)} WHERE ${d.id("id")} = ${d.placeholder(1)} AND ${d.id("partition")} = ${d.placeholder(2)} ` +
|
|
226
|
+
`AND ${d.id("leaseUntil")} IS NOT NULL`, [id, partition].map((v) => d.encode(v)));
|
|
227
|
+
}
|
|
228
|
+
/** Static validation, called from `createPramen` next to `validateTriggerTasks` — these are
|
|
229
|
+
* declaration bugs, and the only honest time to surface them is before a single tenant has
|
|
230
|
+
* booted. Throws on the first violation:
|
|
231
|
+
*
|
|
232
|
+
* - an empty id (the ledger key would be meaningless);
|
|
233
|
+
* - a duplicate id — ids are GLOBALLY unique across the array, not per partition, so a
|
|
234
|
+
* copy-pasted id can never quietly mark a different migration as already applied;
|
|
235
|
+
* - a declared `partition` no entity lives in — the migration would be dead code on the
|
|
236
|
+
* DO path (no DO serves that partition) while still running on D1. */
|
|
237
|
+
export function validateMigrations(schema, migrations) {
|
|
238
|
+
if (!migrations?.length)
|
|
239
|
+
return;
|
|
240
|
+
const known = new Set(partitionsOf(schema));
|
|
241
|
+
known.add(DEFAULT_PARTITION); // always addressable, even for a schema with no entities
|
|
242
|
+
const seen = new Set();
|
|
243
|
+
for (const m of migrations) {
|
|
244
|
+
if (!m.id)
|
|
245
|
+
throw new Error("app.migrations: every migration needs a non-empty, stable `id` (it is the ledger key).");
|
|
246
|
+
if (seen.has(m.id)) {
|
|
247
|
+
throw new Error(`app.migrations: duplicate id ${JSON.stringify(m.id)}. Ids are the ledger key and must be globally ` +
|
|
248
|
+
`unique — a reused id makes one of the two silently a no-op.`);
|
|
249
|
+
}
|
|
250
|
+
seen.add(m.id);
|
|
251
|
+
if (m.partition !== undefined && !known.has(m.partition)) {
|
|
252
|
+
throw new Error(`app.migrations: migration ${JSON.stringify(m.id)} declares partition ${JSON.stringify(m.partition)}, ` +
|
|
253
|
+
`which no entity lives in. Known partitions: ${[...known].join(", ")}.`);
|
|
254
|
+
}
|
|
255
|
+
}
|
|
256
|
+
}
|
package/dist/runtime/mail.d.ts
CHANGED
|
@@ -47,6 +47,33 @@ export declare class CloudflareEmailAdapter implements MailAdapter {
|
|
|
47
47
|
from: MailAddress;
|
|
48
48
|
}): Promise<void>;
|
|
49
49
|
}
|
|
50
|
+
/** Mailgun — an HTTP transport, for when Cloudflare Email Sending cannot be used.
|
|
51
|
+
*
|
|
52
|
+
* Worth the key for one reason: Cloudflare will only send from a domain that is a zone
|
|
53
|
+
* in the same account, and some accounts additionally refuse any recipient that is not a
|
|
54
|
+
* verified destination in Email Routing ("destination address is not a verified
|
|
55
|
+
* address"). That is workable for a handful of operators and hopeless for real users.
|
|
56
|
+
* Mailgun asks the domain be verified once, then delivers to anyone.
|
|
57
|
+
*
|
|
58
|
+
* A non-2xx THROWS, deliberately: `ctx.mail.send` is normally called from a task, and a
|
|
59
|
+
* throw is what makes the outbox retry and then dead-letter visibly. Swallowing the
|
|
60
|
+
* status would turn a bounced sign-in link into silence. The response body rides along
|
|
61
|
+
* in the message because Mailgun's 400s are specific and worth reading ("not a valid
|
|
62
|
+
* address", "domain not found"); the key never does. */
|
|
63
|
+
export declare class MailgunAdapter implements MailAdapter {
|
|
64
|
+
private readonly apiKey;
|
|
65
|
+
private readonly domain;
|
|
66
|
+
/** `https://api.eu.mailgun.net` for an EU-region account; the two are separate
|
|
67
|
+
* deployments and a key from one 401s against the other. */
|
|
68
|
+
private readonly apiBase;
|
|
69
|
+
constructor(apiKey: string, domain: string,
|
|
70
|
+
/** `https://api.eu.mailgun.net` for an EU-region account; the two are separate
|
|
71
|
+
* deployments and a key from one 401s against the other. */
|
|
72
|
+
apiBase?: string);
|
|
73
|
+
send(message: MailMessage & {
|
|
74
|
+
from: MailAddress;
|
|
75
|
+
}): Promise<void>;
|
|
76
|
+
}
|
|
50
77
|
/** Dev/test transport: stash the message in KV under `mail:<recipient>` so an e2e suite
|
|
51
78
|
* (or a dashboard) can read the "inbox" instead of really sending. */
|
|
52
79
|
export declare class KvMailAdapter implements MailAdapter {
|
|
@@ -73,9 +100,14 @@ export declare class UnconfiguredMailAdapter implements MailAdapter {
|
|
|
73
100
|
send(): Promise<void>;
|
|
74
101
|
}
|
|
75
102
|
/** Build `ctx.mail` from the environment:
|
|
76
|
-
* - `
|
|
103
|
+
* - `MAILGUN_API_KEY` + `MAILGUN_DOMAIN` + `MAIL_FROM` → Mailgun (real send).
|
|
104
|
+
* - else `EMAIL` binding + `MAIL_FROM` → Cloudflare Email Sending (real send).
|
|
77
105
|
* - else `MAIL_CAPTURE=true` → capture (KV inbox if a Kv is given, else in-memory) with
|
|
78
106
|
* a synthetic dev sender — an EXPLICIT dev opt-in, never the production default.
|
|
79
107
|
* - else → fail closed: a `send` throws (so a missing-MAIL_FROM prod doesn't silently
|
|
80
|
-
* stash security emails in KV).
|
|
108
|
+
* stash security emails in KV).
|
|
109
|
+
*
|
|
110
|
+
* Mailgun outranks the binding on purpose. The binding tends to be present because the
|
|
111
|
+
* infrastructure declares it, whereas an API key is only ever there because somebody put
|
|
112
|
+
* it there — so when both exist, the key is the newer decision. */
|
|
81
113
|
export declare function createMail(env: EnvBag, kv?: Kv): Mail;
|
package/dist/runtime/mail.js
CHANGED
|
@@ -5,10 +5,15 @@
|
|
|
5
5
|
//
|
|
6
6
|
// await ctx.mail.send({ to: "u@x.com", subject: "Welcome", text: "…" });
|
|
7
7
|
//
|
|
8
|
-
//
|
|
9
|
-
//
|
|
10
|
-
//
|
|
11
|
-
//
|
|
8
|
+
// Two real transports. Cloudflare Email Sending (the `send_email`/`EMAIL` binding) needs
|
|
9
|
+
// no API keys, but it can only send FROM a domain that is a zone in the same account,
|
|
10
|
+
// and on some accounts only TO addresses verified in Email Routing — which rules it out
|
|
11
|
+
// whenever the recipients are ordinary people. Mailgun is the way out of both: an HTTP
|
|
12
|
+
// API, any recipient, at the cost of a key. Configure it and it wins.
|
|
13
|
+
//
|
|
14
|
+
// With neither configured (local/dev), mail is captured instead of sent — to KV (so an
|
|
15
|
+
// e2e/dashboard can read the "inbox") or in-memory — so handlers work unchanged
|
|
16
|
+
// off-platform.
|
|
12
17
|
/** The `ctx.mail` facade: resolves the sender, validates, and delegates to the adapter. */
|
|
13
18
|
export class Mail {
|
|
14
19
|
adapter;
|
|
@@ -49,6 +54,60 @@ export class CloudflareEmailAdapter {
|
|
|
49
54
|
});
|
|
50
55
|
}
|
|
51
56
|
}
|
|
57
|
+
/** Mailgun — an HTTP transport, for when Cloudflare Email Sending cannot be used.
|
|
58
|
+
*
|
|
59
|
+
* Worth the key for one reason: Cloudflare will only send from a domain that is a zone
|
|
60
|
+
* in the same account, and some accounts additionally refuse any recipient that is not a
|
|
61
|
+
* verified destination in Email Routing ("destination address is not a verified
|
|
62
|
+
* address"). That is workable for a handful of operators and hopeless for real users.
|
|
63
|
+
* Mailgun asks the domain be verified once, then delivers to anyone.
|
|
64
|
+
*
|
|
65
|
+
* A non-2xx THROWS, deliberately: `ctx.mail.send` is normally called from a task, and a
|
|
66
|
+
* throw is what makes the outbox retry and then dead-letter visibly. Swallowing the
|
|
67
|
+
* status would turn a bounced sign-in link into silence. The response body rides along
|
|
68
|
+
* in the message because Mailgun's 400s are specific and worth reading ("not a valid
|
|
69
|
+
* address", "domain not found"); the key never does. */
|
|
70
|
+
export class MailgunAdapter {
|
|
71
|
+
apiKey;
|
|
72
|
+
domain;
|
|
73
|
+
apiBase;
|
|
74
|
+
constructor(apiKey, domain,
|
|
75
|
+
/** `https://api.eu.mailgun.net` for an EU-region account; the two are separate
|
|
76
|
+
* deployments and a key from one 401s against the other. */
|
|
77
|
+
apiBase = "https://api.mailgun.net") {
|
|
78
|
+
this.apiKey = apiKey;
|
|
79
|
+
this.domain = domain;
|
|
80
|
+
this.apiBase = apiBase;
|
|
81
|
+
}
|
|
82
|
+
async send(message) {
|
|
83
|
+
const body = new URLSearchParams();
|
|
84
|
+
body.set("from", message.from.name ? `${message.from.name} <${message.from.email}>` : message.from.email);
|
|
85
|
+
for (const to of Array.isArray(message.to) ? message.to : [message.to])
|
|
86
|
+
body.append("to", to);
|
|
87
|
+
body.set("subject", message.subject);
|
|
88
|
+
if (message.text)
|
|
89
|
+
body.set("text", message.text);
|
|
90
|
+
if (message.html)
|
|
91
|
+
body.set("html", message.html);
|
|
92
|
+
if (message.replyTo) {
|
|
93
|
+
const r = message.replyTo;
|
|
94
|
+
body.set("h:Reply-To", typeof r === "string" ? r : r.name ? `${r.name} <${r.email}>` : r.email);
|
|
95
|
+
}
|
|
96
|
+
const res = await fetch(`${this.apiBase.replace(/\/+$/, "")}/v3/${encodeURIComponent(this.domain)}/messages`, {
|
|
97
|
+
method: "POST",
|
|
98
|
+
headers: {
|
|
99
|
+
// `api` is the literal username Mailgun expects; the key is the password.
|
|
100
|
+
authorization: `Basic ${btoa(`api:${this.apiKey}`)}`,
|
|
101
|
+
"content-type": "application/x-www-form-urlencoded",
|
|
102
|
+
},
|
|
103
|
+
body,
|
|
104
|
+
});
|
|
105
|
+
if (!res.ok) {
|
|
106
|
+
const detail = await res.text().catch(() => "");
|
|
107
|
+
throw new Error(`mailgun: send failed (${res.status})${detail ? ` — ${detail.slice(0, 300)}` : ""}`);
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
}
|
|
52
111
|
/** Dev/test transport: stash the message in KV under `mail:<recipient>` so an e2e suite
|
|
53
112
|
* (or a dashboard) can read the "inbox" instead of really sending. */
|
|
54
113
|
export class KvMailAdapter {
|
|
@@ -76,21 +135,35 @@ export class MemoryMailAdapter {
|
|
|
76
135
|
* instead of delivering them. Mirrors how files fail closed without FILES_SECRET. */
|
|
77
136
|
export class UnconfiguredMailAdapter {
|
|
78
137
|
async send() {
|
|
79
|
-
throw new Error("ctx.mail: no transport configured — set MAIL_FROM
|
|
80
|
-
"or MAIL_CAPTURE=true to capture in dev.");
|
|
138
|
+
throw new Error("ctx.mail: no transport configured — set MAIL_FROM with either the EMAIL binding " +
|
|
139
|
+
"or MAILGUN_API_KEY + MAILGUN_DOMAIN to send, or MAIL_CAPTURE=true to capture in dev.");
|
|
81
140
|
}
|
|
82
141
|
}
|
|
83
142
|
/** Build `ctx.mail` from the environment:
|
|
84
|
-
* - `
|
|
143
|
+
* - `MAILGUN_API_KEY` + `MAILGUN_DOMAIN` + `MAIL_FROM` → Mailgun (real send).
|
|
144
|
+
* - else `EMAIL` binding + `MAIL_FROM` → Cloudflare Email Sending (real send).
|
|
85
145
|
* - else `MAIL_CAPTURE=true` → capture (KV inbox if a Kv is given, else in-memory) with
|
|
86
146
|
* a synthetic dev sender — an EXPLICIT dev opt-in, never the production default.
|
|
87
147
|
* - else → fail closed: a `send` throws (so a missing-MAIL_FROM prod doesn't silently
|
|
88
|
-
* stash security emails in KV).
|
|
148
|
+
* stash security emails in KV).
|
|
149
|
+
*
|
|
150
|
+
* Mailgun outranks the binding on purpose. The binding tends to be present because the
|
|
151
|
+
* infrastructure declares it, whereas an API key is only ever there because somebody put
|
|
152
|
+
* it there — so when both exist, the key is the newer decision. */
|
|
89
153
|
export function createMail(env, kv) {
|
|
90
154
|
const binding = env.EMAIL;
|
|
91
155
|
const fromAddr = typeof env.MAIL_FROM === "string" && env.MAIL_FROM ? env.MAIL_FROM : undefined;
|
|
156
|
+
const str = (k) => typeof env[k] === "string" && env[k] ? env[k] : undefined;
|
|
157
|
+
const name = typeof env.MAIL_FROM_NAME === "string" ? env.MAIL_FROM_NAME : undefined;
|
|
158
|
+
const mailgunKey = str("MAILGUN_API_KEY");
|
|
159
|
+
const mailgunDomain = str("MAILGUN_DOMAIN");
|
|
160
|
+
if (mailgunKey && mailgunDomain && fromAddr) {
|
|
161
|
+
return new Mail(new MailgunAdapter(mailgunKey, mailgunDomain, str("MAILGUN_API_BASE")), {
|
|
162
|
+
email: fromAddr,
|
|
163
|
+
name,
|
|
164
|
+
});
|
|
165
|
+
}
|
|
92
166
|
if (binding && fromAddr) {
|
|
93
|
-
const name = typeof env.MAIL_FROM_NAME === "string" ? env.MAIL_FROM_NAME : undefined;
|
|
94
167
|
return new Mail(new CloudflareEmailAdapter(binding), { email: fromAddr, name });
|
|
95
168
|
}
|
|
96
169
|
if (env.MAIL_CAPTURE === "true") {
|
package/dist/sdk/acl.d.ts
CHANGED
|
@@ -44,11 +44,19 @@ export interface NowMarker {
|
|
|
44
44
|
* future timestamp is non-null, so a scheduled row would be readable the moment it
|
|
45
45
|
* is saved.
|
|
46
46
|
*
|
|
47
|
-
* Comparison is lexicographic TEXT, which is exact
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
*
|
|
47
|
+
* Comparison is lexicographic TEXT, which is exact WITHIN one format and wrong across two.
|
|
48
|
+
* Both `'YYYY-MM-DD HH:MM:SS'` and the ISO form open with the same date, so values on
|
|
49
|
+
* different dates still order correctly — it is the SAME date that breaks, where index 10
|
|
50
|
+
* decides and a space (0x20) always sorts below `T` (0x54). A space-form value dated today
|
|
51
|
+
* therefore compares as less than this marker whatever its time-of-day, so a row scheduled
|
|
52
|
+
* for later today reads as already past. The column must hold ISO-8601 UTC —
|
|
53
|
+
* `new Date().toISOString()`.
|
|
54
|
+
*
|
|
55
|
+
* `expr.now()` produces exactly that, so a column defaulted with it is directly comparable
|
|
56
|
+
* here. It did NOT always: it emitted the `datetime('now')` space form, and a policy over
|
|
57
|
+
* such a column was a time boundary that silently did not hold. A store written by a build
|
|
58
|
+
* from before that change still holds space-form values until
|
|
59
|
+
* `isoTimestampBackfill()` rewrites them. */
|
|
52
60
|
export declare function $now(): NowMarker;
|
|
53
61
|
export declare function isNowMarker(v: WhereValue): v is NowMarker;
|
|
54
62
|
export interface AllowMarker {
|
package/dist/sdk/acl.js
CHANGED
|
@@ -40,11 +40,19 @@ const NOW_MARKER = Symbol.for("pramen.nowMarker");
|
|
|
40
40
|
* future timestamp is non-null, so a scheduled row would be readable the moment it
|
|
41
41
|
* is saved.
|
|
42
42
|
*
|
|
43
|
-
* Comparison is lexicographic TEXT, which is exact
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
43
|
+
* Comparison is lexicographic TEXT, which is exact WITHIN one format and wrong across two.
|
|
44
|
+
* Both `'YYYY-MM-DD HH:MM:SS'` and the ISO form open with the same date, so values on
|
|
45
|
+
* different dates still order correctly — it is the SAME date that breaks, where index 10
|
|
46
|
+
* decides and a space (0x20) always sorts below `T` (0x54). A space-form value dated today
|
|
47
|
+
* therefore compares as less than this marker whatever its time-of-day, so a row scheduled
|
|
48
|
+
* for later today reads as already past. The column must hold ISO-8601 UTC —
|
|
49
|
+
* `new Date().toISOString()`.
|
|
50
|
+
*
|
|
51
|
+
* `expr.now()` produces exactly that, so a column defaulted with it is directly comparable
|
|
52
|
+
* here. It did NOT always: it emitted the `datetime('now')` space form, and a policy over
|
|
53
|
+
* such a column was a time boundary that silently did not hold. A store written by a build
|
|
54
|
+
* from before that change still holds space-form values until
|
|
55
|
+
* `isoTimestampBackfill()` rewrites them. */
|
|
48
56
|
export function $now() {
|
|
49
57
|
return { [NOW_MARKER]: true };
|
|
50
58
|
}
|
package/dist/sdk/handlers.d.ts
CHANGED
|
@@ -73,6 +73,47 @@ export interface BootstrapContext<S extends SchemaDef = SchemaDef> {
|
|
|
73
73
|
* blind-insert. A thrown error is logged and swallowed so a broken reconcile can't brick a
|
|
74
74
|
* tenant's boot; it simply retries on the next boot. Set as `app.bootstrap`. */
|
|
75
75
|
export type BootstrapFn = (ctx: BootstrapContext) => void | Promise<void>;
|
|
76
|
+
/** Context handed to a data migration's `up()`. Same privileged, SYSTEM-scoped shape as
|
|
77
|
+
* `BootstrapContext` (ACL bypassed, triggers suppressed) but scoped to the migration's
|
|
78
|
+
* own `partition` — each partition-DO runs its own partition's migrations, so `db`/`driver`
|
|
79
|
+
* here address exactly that DO's tables. */
|
|
80
|
+
export interface MigrationContext<S extends SchemaDef = SchemaDef> {
|
|
81
|
+
/** System-scoped Db (ACL bypassed), triggers suppressed, scoped to `partition`. */
|
|
82
|
+
readonly db: Db<S>;
|
|
83
|
+
/** Raw driver — a bulk `UPDATE`/`INSERT … SELECT` is usually the right tool for a
|
|
84
|
+
* backfill; going row-by-row through `db` on a large table is what blows the DO's
|
|
85
|
+
* wall-clock budget. */
|
|
86
|
+
readonly driver: Driver;
|
|
87
|
+
readonly schema: S;
|
|
88
|
+
/** The partition this migration is running (and being recorded) under. */
|
|
89
|
+
readonly partition: string;
|
|
90
|
+
}
|
|
91
|
+
/** One imperative, ORDERED, recorded-once transformation of existing DATA — the half a
|
|
92
|
+
* declarative diff cannot express: split a column, backfill the nullable column `ADD COLUMN`
|
|
93
|
+
* just created, rewrite units, normalize a `t.json()` blob after its shape changed.
|
|
94
|
+
*
|
|
95
|
+
* The deliberate inverse of `BootstrapFn` on every axis that matters: it runs ONCE ever
|
|
96
|
+
* (recorded in `_pramen_migrations` keyed by `(id, partition)`), so it need NOT be
|
|
97
|
+
* idempotent — a backfill that would double a value on a second run is exactly what this
|
|
98
|
+
* exists for; and a throw is NOT swallowed. It fails CLOSED: no ledger row, the boot does
|
|
99
|
+
* not complete, the request fails, and the migration is retried on the tenant's next fetch.
|
|
100
|
+
* Silently marking a half-finished backfill as done is the one outcome worth bricking a
|
|
101
|
+
* boot to avoid.
|
|
102
|
+
*
|
|
103
|
+
* Runs after `migrate()` (so the column exists) and before `app.bootstrap`. There are no
|
|
104
|
+
* DOWN migrations. Set as `app.migrations`. */
|
|
105
|
+
export interface DataMigration {
|
|
106
|
+
/** Stable, unique, never reused — this is the ledger key. Deleting an id from the array
|
|
107
|
+
* does NOT un-apply it; and a cold tenant is unmigrated until touched, so an id can only
|
|
108
|
+
* be pruned once EVERY live tenant reports it applied (`pramen migrations status
|
|
109
|
+
* --all-tenants`). */
|
|
110
|
+
id: string;
|
|
111
|
+
/** Restrict to one partition; default = the default partition. Only that partition's DO
|
|
112
|
+
* runs it (its tables live in no other DO). The D1 store is one shared database with no
|
|
113
|
+
* partition split, so there every migration runs — still recorded under this key. */
|
|
114
|
+
partition?: string;
|
|
115
|
+
up(ctx: MigrationContext): void | Promise<void>;
|
|
116
|
+
}
|
|
76
117
|
/** The deferred-side-effects facade handed to handlers as `ctx.tasks`. */
|
|
77
118
|
export interface Tasks {
|
|
78
119
|
/** Enqueue a task to run after commit. `kind` selects the `app.tasks` handler;
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
import type { DataMigration } from "./handlers";
|
|
2
|
+
import type { SchemaDef } from "./schema";
|
|
3
|
+
/** The old default's SQL, for recognizing a column that carried it. */
|
|
4
|
+
export declare const LEGACY_NOW_SQL = "datetime('now')";
|
|
5
|
+
/** Columns to rewrite beyond the ones the schema identifies, as `{ table: [column, …] }`.
|
|
6
|
+
*
|
|
7
|
+
* The schema can only find columns whose DEFAULT is `expr.now()`. A column written by
|
|
8
|
+
* HANDLER code in the same space form — `@pramen/cms` stamped `cms_pages.publishedAt` that
|
|
9
|
+
* way — has no marker on it at all, so the app has to name it. `@pramen/cms` exports its
|
|
10
|
+
* own set as `CMS_LEGACY_TIMESTAMP_COLUMNS`. */
|
|
11
|
+
export type ExtraTimestampColumns = Readonly<Record<string, readonly string[]>>;
|
|
12
|
+
export interface IsoTimestampBackfillOpts {
|
|
13
|
+
/** Ledger id. Defaults to `pramen:iso-timestamps`. Override only if you have already
|
|
14
|
+
* used that id for something else — it is the key that makes this run once. */
|
|
15
|
+
id?: string;
|
|
16
|
+
/** Partition to run in. A partition-DO only sees its own tables, so an app with several
|
|
17
|
+
* partitions declares one of these per partition, each with its own id. */
|
|
18
|
+
partition?: string;
|
|
19
|
+
/** Columns the schema cannot identify — see {@link ExtraTimestampColumns}. */
|
|
20
|
+
extraColumns?: ExtraTimestampColumns;
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* A `DataMigration` that rewrites space-form timestamps to ISO-8601 in place.
|
|
24
|
+
*
|
|
25
|
+
* ```ts
|
|
26
|
+
* import { isoTimestampBackfill } from "@pramen/server";
|
|
27
|
+
* import { CMS_LEGACY_TIMESTAMP_COLUMNS } from "@pramen/cms";
|
|
28
|
+
*
|
|
29
|
+
* export const app = {
|
|
30
|
+
* migrations: [isoTimestampBackfill({ extraColumns: CMS_LEGACY_TIMESTAMP_COLUMNS })],
|
|
31
|
+
* // …
|
|
32
|
+
* };
|
|
33
|
+
* ```
|
|
34
|
+
*
|
|
35
|
+
* A **new** deployment can declare it too and pay nothing: every `UPDATE` matches no rows.
|
|
36
|
+
* Declaring it unconditionally is the cheaper habit, because "was this store ever written
|
|
37
|
+
* by an older build?" is not a question the code can answer later.
|
|
38
|
+
*
|
|
39
|
+
* It is not idempotent-by-accident, it is idempotent-by-shape: the `WHERE` matches only the
|
|
40
|
+
* space form, and what it writes is not the space form. That matters because a data
|
|
41
|
+
* migration is not required to be idempotent (it is recorded once) but this one runs over
|
|
42
|
+
* columns an app may also be writing, and a second pass must not corrupt a converted value.
|
|
43
|
+
*/
|
|
44
|
+
export declare function isoTimestampBackfill(opts?: IsoTimestampBackfillOpts): DataMigration;
|
|
45
|
+
/**
|
|
46
|
+
* Which `(table, column)` pairs this migration touches — the schema's `expr.now()` columns
|
|
47
|
+
* in `partition`, plus whatever the app named.
|
|
48
|
+
*
|
|
49
|
+
* Exported for the tests and for anyone who wants to see the list before running it. An
|
|
50
|
+
* extra column naming a table or column that is not in the schema is IGNORED rather than
|
|
51
|
+
* throwing: the list is a hand-written constant an app may keep across a schema change, and
|
|
52
|
+
* failing the whole boot over a stale entry in it would be a worse outcome than skipping it.
|
|
53
|
+
*/
|
|
54
|
+
export declare function timestampColumns(schema: SchemaDef, partition?: string, extra?: ExtraTimestampColumns): Map<string, string[]>;
|