@blamejs/core 0.7.18 → 0.7.19

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.
Files changed (167) hide show
  1. package/CHANGELOG.md +425 -423
  2. package/README.md +150 -150
  3. package/bin/blamejs.js +0 -0
  4. package/index.js +310 -308
  5. package/lib/api-key.js +660 -660
  6. package/lib/api-snapshot.js +338 -338
  7. package/lib/app-shutdown.js +385 -385
  8. package/lib/app.js +365 -365
  9. package/lib/archive.js +250 -250
  10. package/lib/atomic-file.js +544 -544
  11. package/lib/audit-chain.js +177 -177
  12. package/lib/audit-sign.js +344 -344
  13. package/lib/audit-tools.js +677 -677
  14. package/lib/audit.js +766 -766
  15. package/lib/auth/jwt-external.js +365 -0
  16. package/lib/auth/jwt.js +337 -311
  17. package/lib/auth/lockout.js +436 -436
  18. package/lib/auth/oauth.js +721 -721
  19. package/lib/auth/passkey.js +181 -181
  20. package/lib/auth/password.js +628 -594
  21. package/lib/backup/bundle.js +217 -217
  22. package/lib/backup/crypto.js +176 -176
  23. package/lib/backup/index.js +515 -515
  24. package/lib/backup/manifest.js +282 -282
  25. package/lib/break-glass.js +1338 -1338
  26. package/lib/bundler.js +441 -441
  27. package/lib/cache-redis.js +256 -256
  28. package/lib/cache.js +1206 -1206
  29. package/lib/canonical-json.js +115 -115
  30. package/lib/chain-writer.js +234 -234
  31. package/lib/cli-helpers.js +206 -206
  32. package/lib/cli.js +2334 -2334
  33. package/lib/cluster-provider-db.js +317 -317
  34. package/lib/cluster-storage.js +226 -226
  35. package/lib/cluster.js +703 -703
  36. package/lib/config-drift.js +301 -301
  37. package/lib/consent.js +222 -222
  38. package/lib/constants.js +191 -191
  39. package/lib/cookies.js +315 -315
  40. package/lib/credential-hash.js +322 -322
  41. package/lib/crypto.js +266 -266
  42. package/lib/csv.js +275 -275
  43. package/lib/db-declare-row-policy.js +267 -267
  44. package/lib/db-declare-view.js +420 -420
  45. package/lib/db-query.js +406 -406
  46. package/lib/db-schema.js +319 -319
  47. package/lib/db.js +1288 -1288
  48. package/lib/deprecate.js +222 -222
  49. package/lib/dev.js +335 -335
  50. package/lib/dual-control.js +473 -473
  51. package/lib/error-page.js +420 -420
  52. package/lib/external-db-migrate.js +441 -441
  53. package/lib/external-db.js +1061 -1061
  54. package/lib/file-type.js +273 -273
  55. package/lib/forms.js +422 -422
  56. package/lib/framework-error.js +293 -293
  57. package/lib/framework-schema.js +717 -717
  58. package/lib/handlers.js +350 -350
  59. package/lib/http-client-cookie-jar.js +508 -508
  60. package/lib/http-client.js +1195 -1195
  61. package/lib/i18n.js +878 -878
  62. package/lib/jobs.js +185 -185
  63. package/lib/log-stream-cloudwatch.js +369 -369
  64. package/lib/log-stream-local.js +146 -146
  65. package/lib/log-stream-otlp-grpc.js +410 -410
  66. package/lib/log-stream-otlp.js +286 -286
  67. package/lib/log-stream-syslog.js +302 -302
  68. package/lib/log-stream-webhook.js +199 -199
  69. package/lib/log-stream.js +330 -330
  70. package/lib/log.js +500 -500
  71. package/lib/mail-bounce.js +528 -528
  72. package/lib/mail-dkim.js +369 -369
  73. package/lib/mail.js +981 -981
  74. package/lib/metrics.js +683 -683
  75. package/lib/middleware/api-encrypt.js +936 -936
  76. package/lib/middleware/attach-user.js +157 -157
  77. package/lib/middleware/bearer-auth.js +152 -0
  78. package/lib/middleware/body-parser.js +1170 -1170
  79. package/lib/middleware/bot-guard.js +178 -178
  80. package/lib/middleware/compression.js +452 -452
  81. package/lib/middleware/cors.js +314 -314
  82. package/lib/middleware/csp-nonce.js +348 -348
  83. package/lib/middleware/csrf-protect.js +316 -316
  84. package/lib/middleware/db-role-for.js +264 -264
  85. package/lib/middleware/health.js +392 -392
  86. package/lib/middleware/index.js +82 -79
  87. package/lib/middleware/rate-limit.js +358 -358
  88. package/lib/middleware/request-id.js +61 -61
  89. package/lib/middleware/request-log.js +168 -168
  90. package/lib/middleware/require-auth.js +104 -104
  91. package/lib/middleware/security-headers.js +116 -116
  92. package/lib/middleware/sse.js +166 -166
  93. package/lib/migrations.js +383 -383
  94. package/lib/mtls-ca.js +518 -518
  95. package/lib/mtls-engine-default.js +481 -481
  96. package/lib/network-dns.js +632 -632
  97. package/lib/network-heartbeat.js +290 -290
  98. package/lib/network-nts.js +574 -574
  99. package/lib/network-proxy.js +265 -265
  100. package/lib/network-tls.js +328 -328
  101. package/lib/network.js +233 -233
  102. package/lib/notify.js +612 -612
  103. package/lib/ntp-check.js +229 -229
  104. package/lib/numeric-bounds.js +111 -111
  105. package/lib/object-store/azure-blob-bucket-ops.js +349 -349
  106. package/lib/object-store/azure-blob.js +488 -488
  107. package/lib/object-store/gcs-bucket-ops.js +351 -351
  108. package/lib/object-store/gcs.js +519 -519
  109. package/lib/object-store/http-put.js +153 -153
  110. package/lib/object-store/index.js +197 -197
  111. package/lib/object-store/sigv4-bucket-ops.js +1092 -1092
  112. package/lib/object-store/sigv4.js +903 -903
  113. package/lib/observability.js +151 -151
  114. package/lib/otel-export.js +269 -269
  115. package/lib/pagination.js +464 -464
  116. package/lib/parsers/index.js +80 -80
  117. package/lib/parsers/safe-env.js +642 -642
  118. package/lib/parsers/safe-ini.js +292 -292
  119. package/lib/parsers/safe-toml.js +784 -784
  120. package/lib/parsers/safe-xml.js +390 -390
  121. package/lib/parsers/safe-yaml.js +1015 -1015
  122. package/lib/permissions.js +708 -708
  123. package/lib/pqc-agent.js +87 -87
  124. package/lib/pqc-gate.js +279 -279
  125. package/lib/protobuf-encoder.js +190 -190
  126. package/lib/protocol-dispatcher.js +161 -161
  127. package/lib/pubsub-redis.js +167 -167
  128. package/lib/pubsub.js +429 -429
  129. package/lib/queue-local.js +476 -476
  130. package/lib/queue-redis.js +745 -745
  131. package/lib/queue-sqs.js +319 -319
  132. package/lib/queue.js +695 -695
  133. package/lib/redis-client.js +519 -519
  134. package/lib/request-helpers.js +340 -340
  135. package/lib/restore-bundle.js +237 -237
  136. package/lib/restore-rollback.js +259 -259
  137. package/lib/restore.js +409 -409
  138. package/lib/retry.js +376 -376
  139. package/lib/router.js +748 -748
  140. package/lib/safe-async.js +735 -735
  141. package/lib/safe-buffer.js +237 -237
  142. package/lib/safe-json.js +541 -541
  143. package/lib/safe-schema.js +1266 -1266
  144. package/lib/safe-url.js +159 -159
  145. package/lib/scheduler.js +706 -706
  146. package/lib/security-assert.js +373 -373
  147. package/lib/seeders.js +618 -618
  148. package/lib/session.js +535 -478
  149. package/lib/slug.js +269 -269
  150. package/lib/ssrf-guard.js +401 -401
  151. package/lib/storage.js +471 -471
  152. package/lib/subject.js +281 -281
  153. package/lib/template.js +791 -791
  154. package/lib/testing.js +798 -798
  155. package/lib/time.js +310 -310
  156. package/lib/totp.js +302 -302
  157. package/lib/tracing.js +494 -494
  158. package/lib/uuid.js +132 -132
  159. package/lib/validate-opts.js +340 -340
  160. package/lib/vault/index.js +308 -308
  161. package/lib/vault/rotate.js +784 -784
  162. package/lib/vault/wrap.js +296 -296
  163. package/lib/vendor/noble-ciphers.cjs +9 -9
  164. package/lib/webhook.js +595 -595
  165. package/lib/websocket.js +1048 -1048
  166. package/package.json +77 -77
  167. package/sbom.cyclonedx.json +7 -7
package/lib/migrations.js CHANGED
@@ -1,383 +1,383 @@
1
- "use strict";
2
- /**
3
- * migrations — public migration runner with up / down / status.
4
- *
5
- * Wraps the schema-runner already inside lib/db-schema.js (which db.js
6
- * uses on init for forward-only auto-apply) and adds the rollback +
7
- * status surface operators want for ops workflows: CI applies pending
8
- * migrations, an emergency runbook rolls back the most-recent N, a
9
- * dashboard reports applied vs pending.
10
- *
11
- * Migration file format (filename pattern: NNNN-<slug>.js):
12
- *
13
- * // migrations/0001-create-users.js
14
- * module.exports = {
15
- * description: "Create users table",
16
- * up: function (db) { db["exec"]("CREATE TABLE users ( ... )"); },
17
- * down: function (db) { db["exec"]("DROP TABLE users"); },
18
- * };
19
- *
20
- * `up` is required; `down` is optional. A migration without `down`
21
- * cannot be rolled back through this primitive — calling rollback on
22
- * it surfaces a clear error so the operator knows to write the
23
- * down-script (or restore from backup).
24
- *
25
- * var migrations = b.migrations.create({
26
- * db: b.db, // optional; defaults to b.db
27
- * dir: "./migrations",
28
- * });
29
- *
30
- * await migrations.up(); // → { applied, skipped }
31
- * await migrations.down({ steps:1 }); // → { reverted }
32
- * migrations.status(); // → { applied: [...], pending: [...] }
33
- *
34
- * Each migration runs inside a transaction; failure rolls back the
35
- * single migration and stops. _blamejs_migrations records:
36
- * { name, description, appliedAt }
37
- * with `name` being the filename. Rollback removes the row after
38
- * down() succeeds.
39
- */
40
-
41
- var path = require("path");
42
- var atomicFile = require("./atomic-file");
43
- var dbSchema = require("./db-schema");
44
- var lazyRequire = require("./lazy-require");
45
- var { boot } = require("./log");
46
- var migrationFiles = require("./migration-files");
47
- var numericBounds = require("./numeric-bounds");
48
- var dbModule = lazyRequire(function () { return require("./db"); });
49
- var validateOpts = require("./validate-opts");
50
- var { FrameworkError } = require("./framework-error");
51
-
52
- var log = boot("migrations");
53
-
54
- class MigrationError extends FrameworkError {
55
- constructor(code, message, permanent) {
56
- super(message, code);
57
- this.name = "MigrationError";
58
- this.permanent = !!permanent;
59
- this.isMigrationError = true;
60
- }
61
- }
62
-
63
- var MIGRATIONS_TABLE = "_blamejs_migrations";
64
- // Always interpolate identifiers wrapped in `"..."` so a reserved-word
65
- // or whitespace-bearing name resolves correctly (defense-in-depth even
66
- // though our constant is bare-identifier-shaped).
67
- var Q_MIGRATIONS_TABLE = '"' + MIGRATIONS_TABLE + '"';
68
- // Filename grammar: leading numeric prefix (any width), then '-', then a
69
- // non-empty body, then '.js'. Numeric prefix orders execution. Letters
70
- // in the body include hyphens, underscores, and alphanumerics; anything
71
- // else is rejected so an operator can't sneak path tricks into require.
72
- // Length capped before the regex test so a hostile directory listing
73
- // can't drive the engine against an unbounded filename string.
74
- var FILE_RE = migrationFiles.MIGRATION_FILE_RE;
75
- var FILE_NAME_MAX = 255;
76
-
77
- function _isMigrationFile(name) {
78
- return typeof name === "string" &&
79
- name.length > 0 &&
80
- name.length <= FILE_NAME_MAX &&
81
- FILE_RE.test(name);
82
- }
83
-
84
- // Bracket-notation wrapper for the SQLite handle's exec method. The
85
- // rest of the framework uses db["exec"] to avoid hook false-positives
86
- // matching the literal '.exec(' token; mirror that here.
87
- var _runSql = dbSchema.runSqlOnHandle;
88
-
89
- function _ensureTable(db) {
90
- _runSql(db,
91
- "CREATE TABLE IF NOT EXISTS " + Q_MIGRATIONS_TABLE + " (" +
92
- " name TEXT PRIMARY KEY," +
93
- " description TEXT," +
94
- " appliedAt TEXT NOT NULL" +
95
- ")"
96
- );
97
- }
98
-
99
- // Single-row advisory-lock table. Two processes running `migrate up`
100
- // concurrently against the same DB race on this table: the winner of
101
- // the INSERT acquires the lock; the loser sees a UNIQUE violation and
102
- // the operator gets a clear "lock held by other process" error.
103
- var LOCK_TABLE = "_blamejs_migrations_lock";
104
- var Q_LOCK_TABLE = '"' + LOCK_TABLE + '"';
105
-
106
- function _ensureLockTable(db) {
107
- _runSql(db,
108
- "CREATE TABLE IF NOT EXISTS " + Q_LOCK_TABLE + " (" +
109
- " scope TEXT PRIMARY KEY," +
110
- " lockedAt INTEGER NOT NULL," +
111
- " lockedBy TEXT NOT NULL," +
112
- " CHECK (scope = 'lock')" +
113
- ")"
114
- );
115
- }
116
-
117
- function _lockHolderId() {
118
- // process.pid + hostname identifies the process holding the lock;
119
- // a hung deploy can be diagnosed by checking the lock row's lockedBy.
120
- return String(process.pid) + "@" + (require("node:os").hostname() || "unknown");
121
- }
122
-
123
- function _acquireLock(db, opts) {
124
- _ensureLockTable(db);
125
- var holder = _lockHolderId();
126
- var nowMs = Date.now();
127
- // staleAfterMs gates whether an existing lock is considered stale.
128
- // 0 (the default) means "never replace — wait for the operator".
129
- // Pre-fix Infinity was accepted but degenerate `(now - lockedAt) >
130
- // Infinity` to always-false, identical to 0 but with an obscured
131
- // typo. Reject Infinity / NaN / non-integer / negative — operators
132
- // wanting "never" pass 0 explicitly.
133
- var staleAfterMs;
134
- if (!opts || opts.staleAfterMs === undefined) {
135
- staleAfterMs = 0;
136
- } else if (!numericBounds.isNonNegativeFiniteInt(opts.staleAfterMs)) {
137
- throw new Error("migrations.acquireLock: staleAfterMs must be a " +
138
- "non-negative finite integer; got " + numericBounds.shape(opts.staleAfterMs));
139
- } else {
140
- staleAfterMs = opts.staleAfterMs;
141
- }
142
- // Try to insert; if there's a stale lock, optionally force-replace it.
143
- try {
144
- db.prepare(
145
- "INSERT INTO " + Q_LOCK_TABLE + " (scope, lockedAt, lockedBy) VALUES ('lock', ?, ?)"
146
- ).run(nowMs, holder);
147
- return holder;
148
- } catch {
149
- // PRIMARY KEY conflict → existing lock. Inspect it.
150
- var existing = db.prepare(
151
- "SELECT lockedAt, lockedBy FROM " + Q_LOCK_TABLE + " WHERE scope = 'lock'"
152
- ).get();
153
- if (!existing) {
154
- // Race window between INSERT failure and SELECT — try once more.
155
- try {
156
- db.prepare(
157
- "INSERT INTO " + Q_LOCK_TABLE + " (scope, lockedAt, lockedBy) VALUES ('lock', ?, ?)"
158
- ).run(nowMs, holder);
159
- return holder;
160
- } catch (e2) {
161
- throw new MigrationError("migrations/lock-busy",
162
- "could not acquire migration lock: " + ((e2 && e2.message) || String(e2)),
163
- true);
164
- }
165
- }
166
- var ageMs = nowMs - Number(existing.lockedAt);
167
- if (staleAfterMs > 0 && ageMs > staleAfterMs) {
168
- // Force-replace the stale lock. Requires DELETE + INSERT in a
169
- // single transaction so the next process can't slip in between.
170
- _runSql(db, "BEGIN IMMEDIATE");
171
- try {
172
- db.prepare("DELETE FROM " + Q_LOCK_TABLE + " WHERE scope = 'lock' AND lockedAt = ?")
173
- .run(existing.lockedAt);
174
- db.prepare(
175
- "INSERT INTO " + Q_LOCK_TABLE + " (scope, lockedAt, lockedBy) VALUES ('lock', ?, ?)"
176
- ).run(nowMs, holder);
177
- _runSql(db, "COMMIT");
178
- return holder;
179
- } catch (forceErr) {
180
- try { _runSql(db, "ROLLBACK"); }
181
- catch (rollbackErr) {
182
- log.debug("rollback-failed", {
183
- op: "lock-stale-replace",
184
- error: rollbackErr && rollbackErr.message,
185
- });
186
- }
187
- throw new MigrationError("migrations/lock-stale-replace-failed",
188
- "could not replace stale lock: " + ((forceErr && forceErr.message) || String(forceErr)),
189
- true);
190
- }
191
- }
192
- throw new MigrationError("migrations/lock-held",
193
- "migration lock is held by " + existing.lockedBy +
194
- " (acquired " + ageMs + "ms ago). Another process is running migrations" +
195
- " — wait for it to finish, or pass staleAfterMs to force-replace stale locks.",
196
- true);
197
- }
198
- }
199
-
200
- function _releaseLock(db, holder) {
201
- // Only release our own lock — a process whose deploy was killed
202
- // shouldn't have its lock cleared by an unrelated next deploy unless
203
- // the operator explicitly used the staleAfterMs path.
204
- try {
205
- db.prepare(
206
- "DELETE FROM " + Q_LOCK_TABLE + " WHERE scope = 'lock' AND lockedBy = ?"
207
- ).run(holder);
208
- } catch (_e) { /* best-effort release; operator can DELETE manually */ }
209
- }
210
-
211
- function _withLock(db, opts, fn) {
212
- var holder = _acquireLock(db, opts);
213
- try { return fn(); }
214
- finally { _releaseLock(db, holder); }
215
- }
216
-
217
- function _list(dir) {
218
- return atomicFile.listDir(dir, {
219
- filter: _isMigrationFile,
220
- }).map(function (e) { return e.name; }).sort();
221
- }
222
-
223
- function _resolveDb(opts) {
224
- if (opts && opts.db && typeof opts.db.prepare === "function") return opts.db;
225
- // Fall back to the framework's singleton db when one isn't passed —
226
- // operator-side wiring usually does `b.migrations.create({ dir })`.
227
- var d = dbModule();
228
- if (typeof d.prepare !== "function") {
229
- throw new MigrationError("migrations/no-db",
230
- "no db handle: pass opts.db or initialize b.db before create()",
231
- true);
232
- }
233
- return d;
234
- }
235
-
236
- function _loadMigration(file, dir) {
237
- var fullPath = path.join(dir, file);
238
- // Drop the require cache for this path before loading so a test that
239
- // changes a migration file between calls picks up the new content.
240
- // Production deployments would always restart the process, but this
241
- // keeps test fixtures sane.
242
- try { delete require.cache[require.resolve(fullPath)]; } catch (_e) { /* not yet cached */ }
243
- var mod;
244
- try { mod = require(fullPath); }
245
- catch (e) {
246
- throw new MigrationError("migrations/load-failed",
247
- "migration '" + file + "' failed to load: " + ((e && e.message) || String(e)),
248
- true);
249
- }
250
- if (!mod || typeof mod.up !== "function") {
251
- throw new MigrationError("migrations/missing-up",
252
- "migration '" + file + "' must export an `up(db)` function", true);
253
- }
254
- return mod;
255
- }
256
-
257
- var _txn = dbSchema.runInTransaction;
258
-
259
- function create(opts) {
260
- opts = opts || {};
261
- validateOpts(opts, ["dir", "db", "staleAfterMs"], "b.migrations");
262
- if (typeof opts.dir !== "string" || opts.dir.length === 0) {
263
- throw new MigrationError("migrations/no-dir",
264
- "migrations.create requires opts.dir (path to migrations directory)",
265
- true);
266
- }
267
- var dir = opts.dir;
268
-
269
- function _appliedRows() {
270
- var db = _resolveDb(opts);
271
- _ensureTable(db);
272
- return db.prepare(
273
- "SELECT name, description, appliedAt FROM " + Q_MIGRATIONS_TABLE +
274
- " ORDER BY appliedAt ASC, name ASC"
275
- ).all();
276
- }
277
-
278
- function status() {
279
- var applied = _appliedRows();
280
- var appliedNames = new Set(applied.map(function (r) { return r.name; }));
281
- var files = _list(dir);
282
- var pending = files.filter(function (f) { return !appliedNames.has(f); });
283
- return {
284
- applied: applied,
285
- pending: pending,
286
- total: files.length,
287
- };
288
- }
289
-
290
- function up() {
291
- var db = _resolveDb(opts);
292
- _ensureTable(db);
293
- return _withLock(db, opts, function () {
294
- var appliedSet = new Set(
295
- db.prepare("SELECT name FROM " + Q_MIGRATIONS_TABLE).all()
296
- .map(function (r) { return r.name; })
297
- );
298
- var files = _list(dir);
299
- var applied = [];
300
- var skipped = [];
301
- for (var i = 0; i < files.length; i++) {
302
- var file = files[i];
303
- if (appliedSet.has(file)) { skipped.push(file); continue; }
304
- var mod = _loadMigration(file, dir);
305
- try {
306
- _txn(db, function () {
307
- mod.up(db);
308
- db.prepare(
309
- "INSERT INTO " + Q_MIGRATIONS_TABLE +
310
- " (name, description, appliedAt) VALUES (?, ?, ?)"
311
- ).run(file, mod.description || "", new Date().toISOString());
312
- });
313
- } catch (e) {
314
- throw new MigrationError("migrations/up-failed",
315
- "migration '" + file + "' failed: " + ((e && e.message) || String(e)),
316
- true);
317
- }
318
- applied.push(file);
319
- }
320
- return { applied: applied, skipped: skipped };
321
- });
322
- }
323
-
324
- function down(opts2) {
325
- opts2 = opts2 || {};
326
- var steps = opts2.steps === undefined ? 1 : Number(opts2.steps);
327
- if (!Number.isFinite(steps) || steps < 1 || Math.floor(steps) !== steps) {
328
- throw new MigrationError("migrations/bad-steps",
329
- "down: steps must be a positive integer (got " + opts2.steps + ")",
330
- true);
331
- }
332
- var db = _resolveDb(opts);
333
- _ensureTable(db);
334
- return _withLock(db, opts, function () {
335
- // Most-recent applied first (reverse chronological by appliedAt
336
- // then by name as a stable tiebreaker for fixtures with identical
337
- // timestamps).
338
- var rows = db.prepare(
339
- "SELECT name FROM " + Q_MIGRATIONS_TABLE +
340
- " ORDER BY appliedAt DESC, name DESC LIMIT ?"
341
- ).all(steps);
342
-
343
- var reverted = [];
344
- for (var i = 0; i < rows.length; i++) {
345
- var file = rows[i].name;
346
- var mod = _loadMigration(file, dir);
347
- if (typeof mod.down !== "function") {
348
- throw new MigrationError("migrations/no-down",
349
- "migration '" + file + "' has no `down(db)` function — " +
350
- "rollback unsupported. Restore from backup or write a down().",
351
- true);
352
- }
353
- try {
354
- _txn(db, function () {
355
- mod.down(db);
356
- db.prepare("DELETE FROM " + Q_MIGRATIONS_TABLE + " WHERE name = ?").run(file);
357
- });
358
- } catch (e) {
359
- throw new MigrationError("migrations/down-failed",
360
- "rollback of '" + file + "' failed: " + ((e && e.message) || String(e)),
361
- true);
362
- }
363
- reverted.push(file);
364
- }
365
- return { reverted: reverted };
366
- });
367
- }
368
-
369
- return {
370
- up: up,
371
- down: down,
372
- status: status,
373
- dir: dir,
374
- };
375
- }
376
-
377
- module.exports = {
378
- create: create,
379
- MigrationError: MigrationError,
380
- MIGRATIONS_TABLE: MIGRATIONS_TABLE,
381
- LOCK_TABLE: LOCK_TABLE,
382
- FILE_RE: FILE_RE,
383
- };
1
+ "use strict";
2
+ /**
3
+ * migrations — public migration runner with up / down / status.
4
+ *
5
+ * Wraps the schema-runner already inside lib/db-schema.js (which db.js
6
+ * uses on init for forward-only auto-apply) and adds the rollback +
7
+ * status surface operators want for ops workflows: CI applies pending
8
+ * migrations, an emergency runbook rolls back the most-recent N, a
9
+ * dashboard reports applied vs pending.
10
+ *
11
+ * Migration file format (filename pattern: NNNN-<slug>.js):
12
+ *
13
+ * // migrations/0001-create-users.js
14
+ * module.exports = {
15
+ * description: "Create users table",
16
+ * up: function (db) { db["exec"]("CREATE TABLE users ( ... )"); },
17
+ * down: function (db) { db["exec"]("DROP TABLE users"); },
18
+ * };
19
+ *
20
+ * `up` is required; `down` is optional. A migration without `down`
21
+ * cannot be rolled back through this primitive — calling rollback on
22
+ * it surfaces a clear error so the operator knows to write the
23
+ * down-script (or restore from backup).
24
+ *
25
+ * var migrations = b.migrations.create({
26
+ * db: b.db, // optional; defaults to b.db
27
+ * dir: "./migrations",
28
+ * });
29
+ *
30
+ * await migrations.up(); // → { applied, skipped }
31
+ * await migrations.down({ steps:1 }); // → { reverted }
32
+ * migrations.status(); // → { applied: [...], pending: [...] }
33
+ *
34
+ * Each migration runs inside a transaction; failure rolls back the
35
+ * single migration and stops. _blamejs_migrations records:
36
+ * { name, description, appliedAt }
37
+ * with `name` being the filename. Rollback removes the row after
38
+ * down() succeeds.
39
+ */
40
+
41
+ var path = require("path");
42
+ var atomicFile = require("./atomic-file");
43
+ var dbSchema = require("./db-schema");
44
+ var lazyRequire = require("./lazy-require");
45
+ var { boot } = require("./log");
46
+ var migrationFiles = require("./migration-files");
47
+ var numericBounds = require("./numeric-bounds");
48
+ var dbModule = lazyRequire(function () { return require("./db"); });
49
+ var validateOpts = require("./validate-opts");
50
+ var { FrameworkError } = require("./framework-error");
51
+
52
+ var log = boot("migrations");
53
+
54
+ class MigrationError extends FrameworkError {
55
+ constructor(code, message, permanent) {
56
+ super(message, code);
57
+ this.name = "MigrationError";
58
+ this.permanent = !!permanent;
59
+ this.isMigrationError = true;
60
+ }
61
+ }
62
+
63
+ var MIGRATIONS_TABLE = "_blamejs_migrations";
64
+ // Always interpolate identifiers wrapped in `"..."` so a reserved-word
65
+ // or whitespace-bearing name resolves correctly (defense-in-depth even
66
+ // though our constant is bare-identifier-shaped).
67
+ var Q_MIGRATIONS_TABLE = '"' + MIGRATIONS_TABLE + '"';
68
+ // Filename grammar: leading numeric prefix (any width), then '-', then a
69
+ // non-empty body, then '.js'. Numeric prefix orders execution. Letters
70
+ // in the body include hyphens, underscores, and alphanumerics; anything
71
+ // else is rejected so an operator can't sneak path tricks into require.
72
+ // Length capped before the regex test so a hostile directory listing
73
+ // can't drive the engine against an unbounded filename string.
74
+ var FILE_RE = migrationFiles.MIGRATION_FILE_RE;
75
+ var FILE_NAME_MAX = 255;
76
+
77
+ function _isMigrationFile(name) {
78
+ return typeof name === "string" &&
79
+ name.length > 0 &&
80
+ name.length <= FILE_NAME_MAX &&
81
+ FILE_RE.test(name);
82
+ }
83
+
84
+ // Bracket-notation wrapper for the SQLite handle's exec method. The
85
+ // rest of the framework uses db["exec"] to avoid hook false-positives
86
+ // matching the literal '.exec(' token; mirror that here.
87
+ var _runSql = dbSchema.runSqlOnHandle;
88
+
89
+ function _ensureTable(db) {
90
+ _runSql(db,
91
+ "CREATE TABLE IF NOT EXISTS " + Q_MIGRATIONS_TABLE + " (" +
92
+ " name TEXT PRIMARY KEY," +
93
+ " description TEXT," +
94
+ " appliedAt TEXT NOT NULL" +
95
+ ")"
96
+ );
97
+ }
98
+
99
+ // Single-row advisory-lock table. Two processes running `migrate up`
100
+ // concurrently against the same DB race on this table: the winner of
101
+ // the INSERT acquires the lock; the loser sees a UNIQUE violation and
102
+ // the operator gets a clear "lock held by other process" error.
103
+ var LOCK_TABLE = "_blamejs_migrations_lock";
104
+ var Q_LOCK_TABLE = '"' + LOCK_TABLE + '"';
105
+
106
+ function _ensureLockTable(db) {
107
+ _runSql(db,
108
+ "CREATE TABLE IF NOT EXISTS " + Q_LOCK_TABLE + " (" +
109
+ " scope TEXT PRIMARY KEY," +
110
+ " lockedAt INTEGER NOT NULL," +
111
+ " lockedBy TEXT NOT NULL," +
112
+ " CHECK (scope = 'lock')" +
113
+ ")"
114
+ );
115
+ }
116
+
117
+ function _lockHolderId() {
118
+ // process.pid + hostname identifies the process holding the lock;
119
+ // a hung deploy can be diagnosed by checking the lock row's lockedBy.
120
+ return String(process.pid) + "@" + (require("node:os").hostname() || "unknown");
121
+ }
122
+
123
+ function _acquireLock(db, opts) {
124
+ _ensureLockTable(db);
125
+ var holder = _lockHolderId();
126
+ var nowMs = Date.now();
127
+ // staleAfterMs gates whether an existing lock is considered stale.
128
+ // 0 (the default) means "never replace — wait for the operator".
129
+ // Pre-fix Infinity was accepted but degenerate `(now - lockedAt) >
130
+ // Infinity` to always-false, identical to 0 but with an obscured
131
+ // typo. Reject Infinity / NaN / non-integer / negative — operators
132
+ // wanting "never" pass 0 explicitly.
133
+ var staleAfterMs;
134
+ if (!opts || opts.staleAfterMs === undefined) {
135
+ staleAfterMs = 0;
136
+ } else if (!numericBounds.isNonNegativeFiniteInt(opts.staleAfterMs)) {
137
+ throw new Error("migrations.acquireLock: staleAfterMs must be a " +
138
+ "non-negative finite integer; got " + numericBounds.shape(opts.staleAfterMs));
139
+ } else {
140
+ staleAfterMs = opts.staleAfterMs;
141
+ }
142
+ // Try to insert; if there's a stale lock, optionally force-replace it.
143
+ try {
144
+ db.prepare(
145
+ "INSERT INTO " + Q_LOCK_TABLE + " (scope, lockedAt, lockedBy) VALUES ('lock', ?, ?)"
146
+ ).run(nowMs, holder);
147
+ return holder;
148
+ } catch {
149
+ // PRIMARY KEY conflict → existing lock. Inspect it.
150
+ var existing = db.prepare(
151
+ "SELECT lockedAt, lockedBy FROM " + Q_LOCK_TABLE + " WHERE scope = 'lock'"
152
+ ).get();
153
+ if (!existing) {
154
+ // Race window between INSERT failure and SELECT — try once more.
155
+ try {
156
+ db.prepare(
157
+ "INSERT INTO " + Q_LOCK_TABLE + " (scope, lockedAt, lockedBy) VALUES ('lock', ?, ?)"
158
+ ).run(nowMs, holder);
159
+ return holder;
160
+ } catch (e2) {
161
+ throw new MigrationError("migrations/lock-busy",
162
+ "could not acquire migration lock: " + ((e2 && e2.message) || String(e2)),
163
+ true);
164
+ }
165
+ }
166
+ var ageMs = nowMs - Number(existing.lockedAt);
167
+ if (staleAfterMs > 0 && ageMs > staleAfterMs) {
168
+ // Force-replace the stale lock. Requires DELETE + INSERT in a
169
+ // single transaction so the next process can't slip in between.
170
+ _runSql(db, "BEGIN IMMEDIATE");
171
+ try {
172
+ db.prepare("DELETE FROM " + Q_LOCK_TABLE + " WHERE scope = 'lock' AND lockedAt = ?")
173
+ .run(existing.lockedAt);
174
+ db.prepare(
175
+ "INSERT INTO " + Q_LOCK_TABLE + " (scope, lockedAt, lockedBy) VALUES ('lock', ?, ?)"
176
+ ).run(nowMs, holder);
177
+ _runSql(db, "COMMIT");
178
+ return holder;
179
+ } catch (forceErr) {
180
+ try { _runSql(db, "ROLLBACK"); }
181
+ catch (rollbackErr) {
182
+ log.debug("rollback-failed", {
183
+ op: "lock-stale-replace",
184
+ error: rollbackErr && rollbackErr.message,
185
+ });
186
+ }
187
+ throw new MigrationError("migrations/lock-stale-replace-failed",
188
+ "could not replace stale lock: " + ((forceErr && forceErr.message) || String(forceErr)),
189
+ true);
190
+ }
191
+ }
192
+ throw new MigrationError("migrations/lock-held",
193
+ "migration lock is held by " + existing.lockedBy +
194
+ " (acquired " + ageMs + "ms ago). Another process is running migrations" +
195
+ " — wait for it to finish, or pass staleAfterMs to force-replace stale locks.",
196
+ true);
197
+ }
198
+ }
199
+
200
+ function _releaseLock(db, holder) {
201
+ // Only release our own lock — a process whose deploy was killed
202
+ // shouldn't have its lock cleared by an unrelated next deploy unless
203
+ // the operator explicitly used the staleAfterMs path.
204
+ try {
205
+ db.prepare(
206
+ "DELETE FROM " + Q_LOCK_TABLE + " WHERE scope = 'lock' AND lockedBy = ?"
207
+ ).run(holder);
208
+ } catch (_e) { /* best-effort release; operator can DELETE manually */ }
209
+ }
210
+
211
+ function _withLock(db, opts, fn) {
212
+ var holder = _acquireLock(db, opts);
213
+ try { return fn(); }
214
+ finally { _releaseLock(db, holder); }
215
+ }
216
+
217
+ function _list(dir) {
218
+ return atomicFile.listDir(dir, {
219
+ filter: _isMigrationFile,
220
+ }).map(function (e) { return e.name; }).sort();
221
+ }
222
+
223
+ function _resolveDb(opts) {
224
+ if (opts && opts.db && typeof opts.db.prepare === "function") return opts.db;
225
+ // Fall back to the framework's singleton db when one isn't passed —
226
+ // operator-side wiring usually does `b.migrations.create({ dir })`.
227
+ var d = dbModule();
228
+ if (typeof d.prepare !== "function") {
229
+ throw new MigrationError("migrations/no-db",
230
+ "no db handle: pass opts.db or initialize b.db before create()",
231
+ true);
232
+ }
233
+ return d;
234
+ }
235
+
236
+ function _loadMigration(file, dir) {
237
+ var fullPath = path.join(dir, file);
238
+ // Drop the require cache for this path before loading so a test that
239
+ // changes a migration file between calls picks up the new content.
240
+ // Production deployments would always restart the process, but this
241
+ // keeps test fixtures sane.
242
+ try { delete require.cache[require.resolve(fullPath)]; } catch (_e) { /* not yet cached */ }
243
+ var mod;
244
+ try { mod = require(fullPath); }
245
+ catch (e) {
246
+ throw new MigrationError("migrations/load-failed",
247
+ "migration '" + file + "' failed to load: " + ((e && e.message) || String(e)),
248
+ true);
249
+ }
250
+ if (!mod || typeof mod.up !== "function") {
251
+ throw new MigrationError("migrations/missing-up",
252
+ "migration '" + file + "' must export an `up(db)` function", true);
253
+ }
254
+ return mod;
255
+ }
256
+
257
+ var _txn = dbSchema.runInTransaction;
258
+
259
+ function create(opts) {
260
+ opts = opts || {};
261
+ validateOpts(opts, ["dir", "db", "staleAfterMs"], "b.migrations");
262
+ if (typeof opts.dir !== "string" || opts.dir.length === 0) {
263
+ throw new MigrationError("migrations/no-dir",
264
+ "migrations.create requires opts.dir (path to migrations directory)",
265
+ true);
266
+ }
267
+ var dir = opts.dir;
268
+
269
+ function _appliedRows() {
270
+ var db = _resolveDb(opts);
271
+ _ensureTable(db);
272
+ return db.prepare(
273
+ "SELECT name, description, appliedAt FROM " + Q_MIGRATIONS_TABLE +
274
+ " ORDER BY appliedAt ASC, name ASC"
275
+ ).all();
276
+ }
277
+
278
+ function status() {
279
+ var applied = _appliedRows();
280
+ var appliedNames = new Set(applied.map(function (r) { return r.name; }));
281
+ var files = _list(dir);
282
+ var pending = files.filter(function (f) { return !appliedNames.has(f); });
283
+ return {
284
+ applied: applied,
285
+ pending: pending,
286
+ total: files.length,
287
+ };
288
+ }
289
+
290
+ function up() {
291
+ var db = _resolveDb(opts);
292
+ _ensureTable(db);
293
+ return _withLock(db, opts, function () {
294
+ var appliedSet = new Set(
295
+ db.prepare("SELECT name FROM " + Q_MIGRATIONS_TABLE).all()
296
+ .map(function (r) { return r.name; })
297
+ );
298
+ var files = _list(dir);
299
+ var applied = [];
300
+ var skipped = [];
301
+ for (var i = 0; i < files.length; i++) {
302
+ var file = files[i];
303
+ if (appliedSet.has(file)) { skipped.push(file); continue; }
304
+ var mod = _loadMigration(file, dir);
305
+ try {
306
+ _txn(db, function () {
307
+ mod.up(db);
308
+ db.prepare(
309
+ "INSERT INTO " + Q_MIGRATIONS_TABLE +
310
+ " (name, description, appliedAt) VALUES (?, ?, ?)"
311
+ ).run(file, mod.description || "", new Date().toISOString());
312
+ });
313
+ } catch (e) {
314
+ throw new MigrationError("migrations/up-failed",
315
+ "migration '" + file + "' failed: " + ((e && e.message) || String(e)),
316
+ true);
317
+ }
318
+ applied.push(file);
319
+ }
320
+ return { applied: applied, skipped: skipped };
321
+ });
322
+ }
323
+
324
+ function down(opts2) {
325
+ opts2 = opts2 || {};
326
+ var steps = opts2.steps === undefined ? 1 : Number(opts2.steps);
327
+ if (!Number.isFinite(steps) || steps < 1 || Math.floor(steps) !== steps) {
328
+ throw new MigrationError("migrations/bad-steps",
329
+ "down: steps must be a positive integer (got " + opts2.steps + ")",
330
+ true);
331
+ }
332
+ var db = _resolveDb(opts);
333
+ _ensureTable(db);
334
+ return _withLock(db, opts, function () {
335
+ // Most-recent applied first (reverse chronological by appliedAt
336
+ // then by name as a stable tiebreaker for fixtures with identical
337
+ // timestamps).
338
+ var rows = db.prepare(
339
+ "SELECT name FROM " + Q_MIGRATIONS_TABLE +
340
+ " ORDER BY appliedAt DESC, name DESC LIMIT ?"
341
+ ).all(steps);
342
+
343
+ var reverted = [];
344
+ for (var i = 0; i < rows.length; i++) {
345
+ var file = rows[i].name;
346
+ var mod = _loadMigration(file, dir);
347
+ if (typeof mod.down !== "function") {
348
+ throw new MigrationError("migrations/no-down",
349
+ "migration '" + file + "' has no `down(db)` function — " +
350
+ "rollback unsupported. Restore from backup or write a down().",
351
+ true);
352
+ }
353
+ try {
354
+ _txn(db, function () {
355
+ mod.down(db);
356
+ db.prepare("DELETE FROM " + Q_MIGRATIONS_TABLE + " WHERE name = ?").run(file);
357
+ });
358
+ } catch (e) {
359
+ throw new MigrationError("migrations/down-failed",
360
+ "rollback of '" + file + "' failed: " + ((e && e.message) || String(e)),
361
+ true);
362
+ }
363
+ reverted.push(file);
364
+ }
365
+ return { reverted: reverted };
366
+ });
367
+ }
368
+
369
+ return {
370
+ up: up,
371
+ down: down,
372
+ status: status,
373
+ dir: dir,
374
+ };
375
+ }
376
+
377
+ module.exports = {
378
+ create: create,
379
+ MigrationError: MigrationError,
380
+ MIGRATIONS_TABLE: MIGRATIONS_TABLE,
381
+ LOCK_TABLE: LOCK_TABLE,
382
+ FILE_RE: FILE_RE,
383
+ };