@workerstack/database 0.22.0 → 0.22.1

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 (112) hide show
  1. package/README.md +46 -7
  2. package/package.json +3 -2
  3. package/src/cli/args.ts +4 -2
  4. package/src/cli/codegen.ts +2 -2
  5. package/src/cli/comb-config.ts +8 -3
  6. package/src/cli/file-path.ts +25 -0
  7. package/src/cli/migrate-apply.ts +5 -21
  8. package/src/cli/migrate-d1.ts +5 -1
  9. package/src/cli/migrate-json.ts +48 -0
  10. package/src/cli/migrate.ts +26 -4
  11. package/src/migrate/core/apply.ts +63 -22
  12. package/src/migrate/core/atlas-apply-runs.ts +15 -26
  13. package/src/migrate/core/cleanup.ts +22 -10
  14. package/src/migrate/core/d1-engine-child.mjs +27 -11
  15. package/src/migrate/core/d1-history.ts +23 -26
  16. package/src/migrate/core/d1-wrangler-error.ts +24 -1
  17. package/src/migrate/core/pg-replay-commit.ts +41 -38
  18. package/src/migrate/core/pg-replay-drops.ts +17 -32
  19. package/src/migrate/core/pg-replay-hidden.ts +75 -0
  20. package/src/migrate/core/pg-replay-roles.ts +2 -4
  21. package/src/migrate/core/pg-replay.ts +21 -19
  22. package/src/migrate/core/pg-server-snapshot.ts +4 -24
  23. package/src/migrate/core/proof-readers.ts +80 -0
  24. package/src/migrate/core/proof-run.ts +19 -5
  25. package/src/migrate/core/proof-scope.ts +27 -14
  26. package/src/migrate/core/sql-code.ts +36 -5
  27. package/src/migrate/core/sql-scan.ts +7 -1
  28. package/src/migrate/core/sqlite-keywords.ts +70 -0
  29. package/src/migrate/core/stopped.ts +70 -0
  30. package/src/migrate/core/trigger-write.d.mts +7 -0
  31. package/src/migrate/core/trigger-write.mjs +42 -0
  32. package/src/query/cursor-mint.ts +11 -18
  33. package/src/query/cursor-refusals.ts +22 -11
  34. package/src/query/descriptions.ts +4 -9
  35. package/src/query/filter-parse.ts +80 -22
  36. package/src/query/filter-validate.ts +10 -13
  37. package/src/query/filter.ts +40 -18
  38. package/src/query/list-extras.ts +7 -10
  39. package/src/query/list-schema.ts +0 -2
  40. package/src/query/merged.ts +3 -2
  41. package/src/query/pagination.ts +30 -6
  42. package/src/query/rounded-key.ts +5 -8
  43. package/src/query/schema-params.ts +12 -5
  44. package/src/query/select-validate.ts +7 -4
  45. package/src/query/sqlite/cursor-fit.ts +10 -2
  46. package/src/query/trusted.ts +7 -2
  47. package/types/cli/args.d.ts.map +1 -1
  48. package/types/cli/comb-config.d.ts +5 -2
  49. package/types/cli/comb-config.d.ts.map +1 -1
  50. package/types/cli/file-path.d.ts +11 -0
  51. package/types/cli/file-path.d.ts.map +1 -0
  52. package/types/cli/migrate-apply.d.ts +1 -0
  53. package/types/cli/migrate-apply.d.ts.map +1 -1
  54. package/types/cli/migrate-d1.d.ts.map +1 -1
  55. package/types/cli/migrate-json.d.ts +4 -0
  56. package/types/cli/migrate-json.d.ts.map +1 -0
  57. package/types/cli/migrate.d.ts.map +1 -1
  58. package/types/migrate/core/apply.d.ts +3 -2
  59. package/types/migrate/core/apply.d.ts.map +1 -1
  60. package/types/migrate/core/atlas-apply-runs.d.ts +6 -0
  61. package/types/migrate/core/atlas-apply-runs.d.ts.map +1 -1
  62. package/types/migrate/core/cleanup.d.ts +16 -4
  63. package/types/migrate/core/cleanup.d.ts.map +1 -1
  64. package/types/migrate/core/d1-history.d.ts.map +1 -1
  65. package/types/migrate/core/d1-wrangler-error.d.ts +11 -0
  66. package/types/migrate/core/d1-wrangler-error.d.ts.map +1 -1
  67. package/types/migrate/core/pg-replay-commit.d.ts +14 -9
  68. package/types/migrate/core/pg-replay-commit.d.ts.map +1 -1
  69. package/types/migrate/core/pg-replay-drops.d.ts +7 -12
  70. package/types/migrate/core/pg-replay-drops.d.ts.map +1 -1
  71. package/types/migrate/core/pg-replay-hidden.d.ts +36 -0
  72. package/types/migrate/core/pg-replay-hidden.d.ts.map +1 -0
  73. package/types/migrate/core/pg-replay-roles.d.ts +2 -4
  74. package/types/migrate/core/pg-replay-roles.d.ts.map +1 -1
  75. package/types/migrate/core/pg-replay.d.ts.map +1 -1
  76. package/types/migrate/core/pg-server-snapshot.d.ts +4 -11
  77. package/types/migrate/core/pg-server-snapshot.d.ts.map +1 -1
  78. package/types/migrate/core/proof-readers.d.ts +19 -0
  79. package/types/migrate/core/proof-readers.d.ts.map +1 -0
  80. package/types/migrate/core/proof-run.d.ts.map +1 -1
  81. package/types/migrate/core/proof-scope.d.ts +15 -7
  82. package/types/migrate/core/proof-scope.d.ts.map +1 -1
  83. package/types/migrate/core/sql-code.d.ts +7 -3
  84. package/types/migrate/core/sql-code.d.ts.map +1 -1
  85. package/types/migrate/core/sql-scan.d.ts.map +1 -1
  86. package/types/migrate/core/sqlite-keywords.d.ts +11 -0
  87. package/types/migrate/core/sqlite-keywords.d.ts.map +1 -0
  88. package/types/migrate/core/stopped.d.ts +23 -0
  89. package/types/migrate/core/stopped.d.ts.map +1 -0
  90. package/types/query/cursor-mint.d.ts.map +1 -1
  91. package/types/query/cursor-refusals.d.ts +17 -1
  92. package/types/query/cursor-refusals.d.ts.map +1 -1
  93. package/types/query/descriptions.d.ts +1 -1
  94. package/types/query/descriptions.d.ts.map +1 -1
  95. package/types/query/filter-parse.d.ts +15 -4
  96. package/types/query/filter-parse.d.ts.map +1 -1
  97. package/types/query/filter-validate.d.ts +1 -1
  98. package/types/query/filter-validate.d.ts.map +1 -1
  99. package/types/query/filter.d.ts +9 -1
  100. package/types/query/filter.d.ts.map +1 -1
  101. package/types/query/list-extras.d.ts.map +1 -1
  102. package/types/query/list-schema.d.ts.map +1 -1
  103. package/types/query/merged.d.ts.map +1 -1
  104. package/types/query/pagination.d.ts +13 -1
  105. package/types/query/pagination.d.ts.map +1 -1
  106. package/types/query/rounded-key.d.ts +2 -11
  107. package/types/query/rounded-key.d.ts.map +1 -1
  108. package/types/query/schema-params.d.ts.map +1 -1
  109. package/types/query/select-validate.d.ts.map +1 -1
  110. package/types/query/sqlite/cursor-fit.d.ts.map +1 -1
  111. package/types/query/trusted.d.ts +1 -1
  112. package/types/query/trusted.d.ts.map +1 -1
@@ -6,8 +6,10 @@
6
6
  */
7
7
  import { chainText } from "../../error-chain.ts"
8
8
  import type { Connection } from "../types.ts"
9
+ import { pastStop } from "./cleanup.ts"
9
10
  import { HASH_VERSION } from "./parse.ts"
10
11
  import { Refused } from "./refused.ts"
12
+ import { whileStoppable } from "./stopped.ts"
11
13
  import { isTransient } from "./transient.ts"
12
14
  import { type RetryOptions, withRetry } from "./utils.ts"
13
15
 
@@ -24,19 +26,39 @@ const TABLE = `(
24
26
  hash_v INTEGER
25
27
  )`
26
28
 
27
- /** Whether a unique index of comb's history holds its hash alone, as comb's table did before 0.13 */
28
- export async function hashUnique(conn: Connection): Promise<boolean> {
29
+ /** Whether a unique index of comb's history holds `column` alone */
30
+ async function uniqueOn(conn: Connection, column: string): Promise<boolean> {
29
31
  const list = await conn.execute("PRAGMA index_list(__drizzle_migrations)")
30
32
  const unique = list.rows.filter((row) => Number(row[list.columns.indexOf("unique")]) === 1)
31
33
  for (const index of unique) {
32
34
  const name = String(index[list.columns.indexOf("name")])
33
35
  const info = await conn.execute(`PRAGMA index_info("${name.replaceAll('"', '""')}")`)
34
36
  const columns = info.rows.map((row) => String(row[info.columns.indexOf("name")]))
35
- if (columns.length === 1 && columns[0] === "hash") return true
37
+ if (columns.length === 1 && columns[0] === column) return true
36
38
  }
37
39
  return false
38
40
  }
39
41
 
42
+ /** Whether a unique index of comb's history holds its hash alone, as comb's table did before 0.13 */
43
+ export const hashUnique = (conn: Connection): Promise<boolean> => uniqueOn(conn, "hash")
44
+
45
+ /**
46
+ * A name recorded once, whoever made the table: a history drizzle's migrator made gains `name` by ALTER
47
+ * and no UNIQUE with it, so nothing would refuse a second run's record of a file the first applied.
48
+ * Refused, naming the files, when the history already holds one twice
49
+ */
50
+ async function keepNameUnique(conn: Connection): Promise<void> {
51
+ if (await uniqueOn(conn, "name")) return
52
+ const twice = await conn.execute(
53
+ "SELECT name FROM __drizzle_migrations WHERE name IS NOT NULL GROUP BY name HAVING count(*) > 1 ORDER BY name",
54
+ )
55
+ if (twice.rows.length > 0)
56
+ throw new Error(
57
+ `__drizzle_migrations records ${twice.rows.map((row) => String(row[0])).join(", ")} more than once, so comb cannot keep a file from being recorded twice: delete the extra rows of each (keep the first), then run it again`,
58
+ )
59
+ await conn.execute("CREATE UNIQUE INDEX IF NOT EXISTS __drizzle_migrations_name ON __drizzle_migrations (name)")
60
+ }
61
+
40
62
  /**
41
63
  * comb's history, made where it is missing, named from 0.11, and from a history before 0.13
42
64
  * rebuilt in one batch: every row and id kept, each row `renamed` lists taking its new name,
@@ -55,7 +77,7 @@ export async function ensureMigrationsTable(
55
77
  /* a history 0.20 or earlier wrote gains it too, every row it holds left without it */
56
78
  if (!has("hash_v")) await conn.execute("ALTER TABLE __drizzle_migrations ADD COLUMN hash_v INTEGER")
57
79
  /* a history from before 0.13 holds each hash once: rebuilt, in one batch, with every row and id kept */
58
- if (!(await hashUnique(conn))) return
80
+ if (!(await hashUnique(conn))) return keepNameUnique(conn)
59
81
  /* a history made without AUTOINCREMENT has no counter; its largest id is where the new one starts */
60
82
  const sequenced = await conn.execute("SELECT 1 FROM sqlite_master WHERE name = 'sqlite_sequence'")
61
83
  const counted =
@@ -151,7 +173,8 @@ class Unconfirmed extends Error {}
151
173
  * record it wrote says it ran, so a retry reads the history first and runs nothing again.
152
174
  * When no read of `history` answers after a batch that failed transiently, the failure is an Unconfirmed.
153
175
  * The record goes first, so a batch whose file another run recorded while it waited for the lock
154
- * fails on the name at once and runs nothing; the history then says so, and it is that run's.
176
+ * fails on the name's unique index at once and runs nothing (ensureMigrationsTable keeps one on every
177
+ * history, whoever made the table); the history then says so, and it is that run's.
155
178
  * Returns who applied it.
156
179
  */
157
180
  export async function applyRecorded(
@@ -207,24 +230,42 @@ export async function applyEach(
207
230
  { history, print, retry }: ApplyOptions & { print: (line: string) => void },
208
231
  ): Promise<void> {
209
232
  const names = migrations.map(({ filename }) => filename)
210
- for (const [at, migration] of migrations.entries()) {
211
- print(`Apply: ${migration.filename}`)
212
- try {
213
- const conn = await open()
233
+ /* the files that committed, and the batch under way, which a stop waits for: it commits or fails whole */
234
+ let done = 0
235
+ let batching: Promise<unknown> = Promise.resolve()
236
+ const read = async () => {
237
+ await batching.catch(() => {
238
+ // reason: a batch that failed committed nothing, which the count it left already says
239
+ })
240
+ return { applied: names.slice(0, done), pending: names.slice(done) }
241
+ }
242
+ await whileStoppable({ names, print, read }, async () => {
243
+ for (const [at, migration] of migrations.entries()) {
244
+ /* a stop parks the run here, whichever connection the next file would open */
245
+ await pastStop()
246
+ print(`Apply: ${migration.filename}`)
214
247
  try {
215
- if ((await applyRecorded(conn, migration, { history, retry })) === "another run")
216
- print(`Skip (applied by another run): ${migration.filename}`)
217
- } finally {
218
- await conn.close()
248
+ const conn = await open()
249
+ try {
250
+ /* counted with the batch, so a stop that waited for it reads the count it made */
251
+ const batch = applyRecorded(conn, migration, { history, retry }).then((who) => {
252
+ done++
253
+ return who
254
+ })
255
+ batching = batch
256
+ if ((await batch) === "another run") print(`Skip (applied by another run): ${migration.filename}`)
257
+ } finally {
258
+ await conn.close()
259
+ }
260
+ } catch (error) {
261
+ const applied = names.slice(0, at)
262
+ if (applied.length > 0) print(`Applied before the failure: ${applied.join(", ")}`)
263
+ /* withRetry throws an Error, whatever the batch threw; so does a connection that would not open */
264
+ const message = (error as Error).message
265
+ if (error instanceof Unconfirmed)
266
+ throw new Refused(message, { applied, pending: names.slice(at + 1), unknown: [migration.filename] })
267
+ throw new Refused(message, { applied, pending: names.slice(at) })
219
268
  }
220
- } catch (error) {
221
- const done = names.slice(0, at)
222
- if (done.length > 0) print(`Applied before the failure: ${done.join(", ")}`)
223
- /* withRetry throws an Error, whatever the batch threw; so does a connection that would not open */
224
- const message = (error as Error).message
225
- if (error instanceof Unconfirmed)
226
- throw new Refused(message, { applied: done, pending: names.slice(at + 1), unknown: [migration.filename] })
227
- throw new Refused(message, { applied: done, pending: names.slice(at) })
228
269
  }
229
- }
270
+ })
230
271
  }
@@ -4,11 +4,11 @@
4
4
  * reading of a file proves what it leaves on its session: a trigger, a default, a DO block's EXECUTE
5
5
  * or code the target holds can each run a SET that outlives its COMMIT.
6
6
  */
7
- import { hold } from "./cleanup.ts"
8
7
  import { type Foreign, ownHistory } from "./atlas-foreign.ts"
9
8
  import { type AtlasFile, type AtlasStatus, checkHistory } from "./atlas-history.ts"
10
9
  import { APPLY_FORMAT, NON_LINEAR, reported } from "./atlas-report.ts"
11
10
  import { atlas, type AtlasCommand, atlasStatus } from "./atlas-status.ts"
11
+ import { whileStoppable } from "./stopped.ts"
12
12
 
13
13
  /**
14
14
  * After an Atlas call that ran no file and said nothing, once this apply ran `applied`: done once
@@ -29,27 +29,17 @@ async function ranNothing(
29
29
  }
30
30
 
31
31
  /**
32
- * What SIGINT or SIGTERM runs once it stopped this apply's Atlas call and that call ended (cleanup.ts
33
- * runs a child's step before this one): the history read once more, and which approved
34
- * files it records and which it does not, printed; no further call starts, and the process then ends
35
- * by the signal
32
+ * The approved files the history records and those it does not, read once Atlas's call ended after a
33
+ * stop signal (cleanup.ts runs a child's step before this apply's): what stopped.ts reports
36
34
  */
37
- const stoppedBy =
35
+ const found =
38
36
  (options: AtlasCommand, copy: string, { approved, foreign }: { approved: ReadonlySet<string>; foreign: Foreign }) =>
39
- async (signal: NodeJS.Signals): Promise<void> => {
40
- try {
41
- const { pending } = ownHistory(await atlasStatus(options, copy), foreign, copy)
42
- const left = new Set(pending.map((file) => file.Name))
43
- const [ran, not] = [
44
- [...approved].filter((name) => !left.has(name)),
45
- [...approved].filter((name) => left.has(name)),
46
- ]
47
- options.print(
48
- `Stopped by ${signal}: applied ${ran.join(", ") || "none"}; not applied ${not.join(", ") || "none"}`,
49
- )
50
- } catch (error) {
51
- // reason: a history read that fails must not hide the stop: the line says what comb could not read, and the process still ends by the signal
52
- options.print(`Stopped by ${signal}: comb could not read what was applied: ${(error as Error).message}`)
37
+ async (): Promise<{ applied: string[]; pending: string[] }> => {
38
+ const { pending } = ownHistory(await atlasStatus(options, copy), foreign, copy)
39
+ const left = new Set(pending.map((file) => file.Name))
40
+ return {
41
+ applied: [...approved].filter((name) => !left.has(name)),
42
+ pending: [...approved].filter((name) => left.has(name)),
53
43
  }
54
44
  }
55
45
 
@@ -67,12 +57,11 @@ async function applyRuns(
67
57
  { foreign, report, status }: { foreign: Foreign; report: Parameters<typeof checkHistory>[2]; status: AtlasStatus },
68
58
  ): Promise<string[]> {
69
59
  const approved = new Set(status.pending.map((file) => file.Name))
70
- const release = hold(stoppedBy(options, copy, { approved, foreign }))
71
- try {
72
- return await callEach(options, copy, { approved, foreign, report })
73
- } finally {
74
- release()
75
- }
60
+ /* no further call starts, and the process then ends by the signal, after the report: a stop parks this loop */
61
+ return whileStoppable(
62
+ { names: [...approved], print: options.print, read: found(options, copy, { approved, foreign }) },
63
+ () => callEach(options, copy, { approved, foreign, report }),
64
+ )
76
65
  }
77
66
 
78
67
  /** applyRuns' calls, each of the first file still pending, until every approved file ran */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * comb's one cleanup rule: what a run makes outside itself (a scratch
3
- * directory, a replay database) is held here until the run lets it go, and SIGINT or SIGTERM runs
3
+ * directory, a replay database) is held here until the run lets it go, and a stop signal runs
4
4
  * every step still held before the process ends as the signal would. A scratch directory is named
5
5
  * for the process that made it, so a later run removes one a killed process left at once, by
6
6
  * whether that process still runs.
@@ -11,14 +11,25 @@ import fs from "node:fs"
11
11
  import os from "node:os"
12
12
  import path from "node:path"
13
13
 
14
- /** A step a signal runs, told which signal came */
15
- type Step = (signal: NodeJS.Signals) => unknown
14
+ /**
15
+ * A step a signal runs, told which signal came and what the steps that ran before it returned, in
16
+ * that order: a step held first runs last, and reads what the steps held after it found out
17
+ */
18
+ type Step = (signal: NodeJS.Signals, earlier: readonly unknown[]) => unknown
16
19
 
17
20
  // per-process-constant: what this process holds now
18
21
  const held = /* @__PURE__ */ new Set<Step>()
19
22
 
20
- /* the signals a held step runs on: a Ctrl-C, and what a supervisor, a container stop or a CI step timeout sends */
21
- const SIGNALS = ["SIGINT", "SIGTERM"] as const
23
+ /**
24
+ * The signals a held step runs on: every one whose default action ends the process and that a
25
+ * terminal or a supervisor sends. A Ctrl-C (SIGINT), a Ctrl-\ (SIGQUIT), a container stop or a CI
26
+ * step timeout (SIGTERM), and a terminal's hangup, as an SSH drop sends it (SIGHUP): a child in a
27
+ * group of its own gets none of them from the terminal, so comb's forward is its only signal.
28
+ */
29
+ export const STOP_SIGNALS = ["SIGHUP", "SIGINT", "SIGQUIT", "SIGTERM"] as const
30
+
31
+ /** One of STOP_SIGNALS */
32
+ export type StopSignal = (typeof STOP_SIGNALS)[number]
22
33
 
23
34
  // per-process-constant: the steps a signal is running, so a step's own work goes on while what it stops waits
24
35
  const inStep = /* @__PURE__ */ new AsyncLocalStorage<true>()
@@ -45,9 +56,10 @@ function newGate(): Gate {
45
56
 
46
57
  /** Every step, last held first, each once the one before ends: a child stops before the scratch it used goes */
47
58
  async function runSteps(steps: readonly Step[], signal: NodeJS.Signals): Promise<void> {
59
+ const returned: unknown[] = []
48
60
  for (const step of steps.toReversed()) {
49
61
  try {
50
- await step(signal)
62
+ returned.push(await step(signal, [...returned]))
51
63
  } catch {
52
64
  // reason: one step that fails must not keep the rest from cleaning up; the process ends either way
53
65
  }
@@ -77,7 +89,7 @@ function stop(signal: NodeJS.Signals): void {
77
89
  gate = undefined
78
90
  if (process.listenerCount(signal) > 1) return current.let()
79
91
  /* both gone before the signal comes again, so it ends the process, and what waits for this stop waits on */
80
- for (const each of SIGNALS) process.off(each, stop)
92
+ for (const each of STOP_SIGNALS) process.off(each, stop)
81
93
  process.kill(process.pid, signal)
82
94
  })
83
95
  }
@@ -101,11 +113,11 @@ export function pastStop(): Promise<void> {
101
113
  }
102
114
 
103
115
  /**
104
- * Hold `step` until the release this returns, so SIGINT and SIGTERM run it before the process ends.
116
+ * Hold `step` until the release this returns, so a stop signal runs it before the process ends.
105
117
  * The listener is read from the process, not remembered: a host that removed every listener gets it back.
106
118
  */
107
119
  export function hold(step: Step): () => void {
108
- for (const signal of SIGNALS) if (!process.listeners(signal).includes(stop)) process.on(signal, stop)
120
+ for (const signal of STOP_SIGNALS) if (!process.listeners(signal).includes(stop)) process.on(signal, stop)
109
121
  held.add(step)
110
122
  return () => void held.delete(step)
111
123
  }
@@ -199,7 +211,7 @@ export type Scratch = { dir: string; remove(): void }
199
211
 
200
212
  /**
201
213
  * A new directory under the temp directory that only this user can open (0700), named `prefix`, this
202
- * process's pid and host mark, and removed by `remove`, or by SIGINT or SIGTERM before it. A
214
+ * process's pid and host mark, and removed by `remove`, or by a stop signal before it. A
203
215
  * process's first scratch of a prefix sweeps what killed runs left.
204
216
  */
205
217
  export function scratchDir(prefix: string): Scratch {
@@ -9,10 +9,12 @@
9
9
  * Then each file as wrangler sends it, the file and the history row it appends, through wrangler's
10
10
  * `splitSqlQuery`, in one batch. D1 resolves a function in a trigger body, a view or a generated
11
11
  * column only when a statement uses it, so EXPLAIN then compiles each view, and each table's INSERT,
12
- * UPDATE and DELETE, the file made or changed. What D1 refuses comes back in D1's own words.
12
+ * UPDATE and DELETE, the file made or changed; a view takes only the writes its INSTEAD OF triggers fire
13
+ * on (trigger-write.mjs). What D1 refuses comes back in D1's own words.
13
14
  */
14
15
  import { readFileSync } from "node:fs"
15
16
  import { pathToFileURL } from "node:url"
17
+ import { EVENTS, quote, triggerEvent, writeOf } from "./trigger-write.mjs"
16
18
 
17
19
  /**
18
20
  * @typedef {{ all(): Promise<{ results?: Array<Record<string, unknown>> | undefined }> }} D1Statement
@@ -27,9 +29,6 @@ import { pathToFileURL } from "node:url"
27
29
  * @typedef {import("./d1-engine-child.d.mts").ProofResult} ProofResult
28
30
  */
29
31
 
30
- /** @param {string} name */
31
- const quote = (name) => `"${name.replaceAll('"', '""')}"`
32
-
33
32
  /**
34
33
  * D1's own words for a failure: the cause wrangler's client wraps, when there is one
35
34
  * @param {unknown} error
@@ -87,7 +86,8 @@ async function isRowTable(db, table) {
87
86
  * @returns {Promise<string[]>}
88
87
  */
89
88
  async function probes(db, before) {
90
- const changed = [...(await master(db))].filter(([key, object]) => before.get(key)?.sql !== object.sql)
89
+ const after = [...(await master(db))]
90
+ const changed = after.filter(([key, object]) => before.get(key)?.sql !== object.sql)
91
91
  const views = changed.filter(([, object]) => object.type === "view").map(([, object]) => object.table)
92
92
  const tables = new Set(changed.filter(([, object]) => object.type === "trigger").map(([, object]) => object.table))
93
93
  for (const [, object] of changed)
@@ -96,16 +96,32 @@ async function probes(db, before) {
96
96
  const writes = []
97
97
  for (const table of tables) {
98
98
  const { results = [] } = await db.prepare(`PRAGMA table_xinfo(${quote(table)})`).all()
99
- const columns = results.filter((row) => row["hidden"] === 0).map((row) => quote(String(row["name"])))
100
- writes.push(
101
- `EXPLAIN INSERT INTO ${quote(table)} DEFAULT VALUES`,
102
- `EXPLAIN UPDATE ${quote(table)} SET ${columns.map((column) => `${column} = ${column}`).join(", ")}`,
103
- `EXPLAIN DELETE FROM ${quote(table)}`,
104
- )
99
+ const columns = results.filter((row) => row["hidden"] === 0).map((row) => String(row["name"]))
100
+ for (const event of eventsOf(after, table)) writes.push(`EXPLAIN ${writeOf(table, event, columns)}`)
105
101
  }
106
102
  return [...views.map((view) => `EXPLAIN SELECT * FROM ${quote(view)}`), ...writes]
107
103
  }
108
104
 
105
+ /**
106
+ * `name` as SQLite compares names, ASCII letters folded alone: a trigger's tbl_name is spelled as its ON clause was
107
+ * @param {string} name
108
+ */
109
+ const fold = (name) => name.replace(/[A-Z]/g, (letter) => letter.toLowerCase())
110
+
111
+ /**
112
+ * The writes `table` takes in the schema `objects`: a table every one, a view each its triggers fire on
113
+ * @param {ReadonlyArray<[string, SchemaObject]>} objects
114
+ * @param {string} table
115
+ */
116
+ function eventsOf(objects, table) {
117
+ const on = objects.filter(([, object]) => fold(object.table) === fold(table))
118
+ if (!on.some(([, object]) => object.type === "view")) return EVENTS
119
+ const fired = new Set(
120
+ on.filter(([, object]) => object.type === "trigger").map(([, object]) => triggerEvent(object.sql)),
121
+ )
122
+ return EVENTS.filter((event) => fired.has(event))
123
+ }
124
+
109
125
  /**
110
126
  * The scratch D1 a proof runs on: what it holds is replayed on a fresh one when workerd crashes,
111
127
  * which a disconnect shows ("other side closed"), not a D1 error
@@ -15,7 +15,7 @@ import { executeAll } from "../drivers/d1.ts"
15
15
  import { lockedOut } from "../drivers/d1-lock.ts"
16
16
  import { assertLocalExists, type D1Target, localMissing, type ReadConfig, resolveBinding } from "./d1-binding.ts"
17
17
  import { d1Files, refuseSwallowing } from "./d1-files.ts"
18
- import { applyFailure, wranglerError } from "./d1-wrangler-error.ts"
18
+ import { refuseUnlike } from "./d1-wrangler-error.ts"
19
19
  import { D1_HASH_INTENT_TABLE, D1_HASH_TABLE, DRIZZLE_HISTORY_TABLE } from "./d1-history-tables.ts"
20
20
  import {
21
21
  type Hashed,
@@ -37,8 +37,9 @@ import { orphanMessage } from "./history-match.ts"
37
37
  import { generateMigrationHash, migrationHashes } from "./parse.ts"
38
38
  import { proveOnD1 } from "./d1-engine.ts"
39
39
  import { planApply } from "./plan-apply.ts"
40
- import { runPeer } from "./process.ts"
40
+ import { type RunResult, runPeer } from "./process.ts"
41
41
  import { Refused } from "./refused.ts"
42
+ import { whileStoppable } from "./stopped.ts"
42
43
 
43
44
  /** The files `__drizzle_migrations` records that the migrations table does not */
44
45
  function recordedByDrizzle(
@@ -129,27 +130,6 @@ async function appliedAfter(
129
130
  }
130
131
  }
131
132
 
132
- /** Refuse a failed run, or one whose table gained (`added`) other than the `names` checked, naming a file never checked */
133
- function refuseUnlike(
134
- ran: { code: number; stderr: string; stdout: string },
135
- { added, locked, names, table }: { added: string[]; locked: boolean; names: string[]; table: string },
136
- ): void {
137
- const unchecked = added.filter((name) => !names.includes(name))
138
- const rest = names.filter((name) => !added.includes(name))
139
- const also =
140
- unchecked.length === 0
141
- ? ""
142
- : `; wrangler also applied ${unchecked.join(", ")}, which comb never checked and holds no hash for: check each against git, then run comb migrate baseline <db> --hashes`
143
- const now = { applied: added, pending: rest }
144
- if (ran.code !== 0) throw new Refused(`wrangler d1 migrations apply failed: ${applyFailure(ran, locked)}${also}`, now)
145
- if (unchecked.length > 0 || rest.length > 0) {
146
- throw new Refused(
147
- `wrangler recorded ${added.join(", ") || "nothing"} in ${table}, where comb checked ${names.join(", ")}; wrangler said: ${wranglerError(ran)}${also}`,
148
- now,
149
- )
150
- }
151
- }
152
-
153
133
  type D1Apply = {
154
134
  approve(migration: ParsedMigration): Promise<Approval>
155
135
  /** only check: apply nothing */
@@ -158,6 +138,25 @@ type D1Apply = {
158
138
  read: ReadConfig
159
139
  }
160
140
 
141
+ /**
142
+ * wrangler's apply of `names`, each announced first. A stop signal ends its run, and the table then
143
+ * says which of them it recorded (stopped.ts)
144
+ */
145
+ async function wranglerApply(
146
+ target: D1Target,
147
+ { print, read }: D1Apply,
148
+ { names, table }: { names: string[]; table: string },
149
+ ): Promise<RunResult> {
150
+ for (const name of names) print(`Apply: ${name}`)
151
+ const found = async () => {
152
+ const recorded = await appliedAfter(target, read, { names, ok: false, table })
153
+ return { applied: names.filter((name) => recorded.has(name)), pending: names.filter((name) => !recorded.has(name)) }
154
+ }
155
+ return whileStoppable({ names, print, read: found }, () =>
156
+ runPeer(target.exec, target.wrangler)(["d1", "migrations", "apply", target.name, ...target.flags], { input: "" }),
157
+ )
158
+ }
159
+
161
160
  /** Check the pending migrations and, unless only checking, apply them through wrangler; returns them */
162
161
  async function applyD1(target: D1Target, options: D1Apply): Promise<string[]> {
163
162
  const { applied, hasIntents, marks, settle, table } = await history(options.read, target, {
@@ -193,9 +192,7 @@ async function applyD1(target: D1Target, options: D1Apply): Promise<string[]> {
193
192
  /* the intents go first: a lost record then fails before wrangler applies anything */
194
193
  const hashed = pending.map(({ migration, name }) => ({ hash: migration.hash, marked: true, name }))
195
194
  await target.conn.batch([...settleStatements(settle, hasIntents, marks), ...intentStatements(hashed)])
196
- for (const name of names) options.print(`Apply: ${name}`)
197
- const apply = ["d1", "migrations", "apply", target.name, ...target.flags]
198
- const ran = await runPeer(target.exec, target.wrangler)(apply, { input: "" })
195
+ const ran = await wranglerApply(target, options, { names, table })
199
196
  /* asked before anything else runs, while the lock that failed the apply is most likely still held */
200
197
  const locked = ran.code !== 0 && target.flags.includes("--local") && (await lockedOut(ran, target.held))
201
198
  const after = await appliedAfter(target, options.read, { names, ok: ran.code === 0, table })
@@ -1,7 +1,9 @@
1
1
  /**
2
- * What a failed `wrangler d1 migrations apply` says, read for the refusal comb gives.
2
+ * What a failed `wrangler d1 migrations apply` says, read for the refusal comb gives, and the refusal
3
+ * of a run whose table records other than the files comb checked.
3
4
  */
4
5
  import { LOCKER } from "../drivers/d1-lock.ts"
6
+ import { Refused } from "./refused.ts"
5
7
 
6
8
  type Ran = { stderr: string; stdout: string }
7
9
 
@@ -23,3 +25,24 @@ export function applyFailure(ran: Ran, locked: boolean): string {
23
25
  ? `the local D1 database was locked by ${LOCKER} while wrangler applied: let it finish and rerun`
24
26
  : wranglerError(ran)
25
27
  }
28
+
29
+ /** Refuse a failed run, or one whose table gained (`added`) other than the `names` checked, naming a file never checked */
30
+ export function refuseUnlike(
31
+ ran: { code: number; stderr: string; stdout: string },
32
+ { added, locked, names, table }: { added: string[]; locked: boolean; names: string[]; table: string },
33
+ ): void {
34
+ const unchecked = added.filter((name) => !names.includes(name))
35
+ const rest = names.filter((name) => !added.includes(name))
36
+ const also =
37
+ unchecked.length === 0
38
+ ? ""
39
+ : `; wrangler also applied ${unchecked.join(", ")}, which comb never checked and holds no hash for: check each against git, then run comb migrate baseline <db> --hashes`
40
+ const now = { applied: added, pending: rest }
41
+ if (ran.code !== 0) throw new Refused(`wrangler d1 migrations apply failed: ${applyFailure(ran, locked)}${also}`, now)
42
+ if (unchecked.length > 0 || rest.length > 0) {
43
+ throw new Refused(
44
+ `wrangler recorded ${added.join(", ") || "nothing"} in ${table}, where comb checked ${names.join(", ")}; wrangler said: ${wranglerError(ran)}${also}`,
45
+ now,
46
+ )
47
+ }
48
+ }
@@ -2,12 +2,14 @@
2
2
  * The replay's transactions and the reads around them (pg-replay.ts): a file's or comb's own
3
3
  * statement's transaction, refused before its COMMIT when this backend's counts show it wrote past
4
4
  * its database, and the server's shared catalogs read as committed around it and around
5
- * every bare statement, a change there the file's when it is to an object the file names;
5
+ * every bare statement, a change there the file's when it is to the replay's own database, or to an
6
+ * object the file names beside a statement that can run code comb cannot read;
6
7
  * a `txmode none` file's statement in a transaction of its own first, bare only when
7
8
  * Postgres runs it outside a block alone.
8
9
  */
9
10
  import { adopt, bareAgain, type Run } from "./pg-replay-roles.ts"
10
- import { added, type Snapshot, snapshot, snapshotChanges, subscriptionsIn } from "./pg-server-snapshot.ts"
11
+ import { type Hidden, runsHidden } from "./pg-replay-hidden.ts"
12
+ import { type Snapshot, snapshot, snapshotChanges, subscriptionsIn } from "./pg-server-snapshot.ts"
11
13
  import {
12
14
  type Change,
13
15
  catalogsOf,
@@ -31,12 +33,13 @@ async function begin(run: Run): Promise<void> {
31
33
  }
32
34
 
33
35
  /**
34
- * Where a replayed transaction or bare statement is: its file's name and the names it spells, the
35
- * statement, if bare, and what a refusal stops; told each role the transaction adds that the replay
36
- * adopts
36
+ * Where a replayed transaction or bare statement is: its file's name and the names it spells, what
37
+ * its statements so far can run that comb cannot read (`hidden`), the statement, if bare, and what a
38
+ * refusal stops; told each role the transaction adds that the replay adopts
37
39
  */
38
40
  type At = {
39
41
  adopted?: ((role: string) => void) | undefined
42
+ hidden: Hidden
40
43
  name: string
41
44
  names: ReadonlySet<string>
42
45
  sent: string | undefined
@@ -46,52 +49,52 @@ type At = {
46
49
  /* the words that name devUrl's role in a file, as namesIn folds them: CURRENT_USER and its kin */
47
50
  const SESSION_ROLE = ["current_role", "current_user", "session_user", "user"]
48
51
 
52
+ /** The objects the file `names`, devUrl's role among them where it names that by keyword */
53
+ function spelled(run: Run, names: ReadonlySet<string>): Set<string> {
54
+ const its = new Set(names)
55
+ if (SESSION_ROLE.some((word) => names.has(word))) its.add(run.role)
56
+ return its
57
+ }
58
+
49
59
  /**
50
- * The server's shared catalogs read as committed against the last read: a change since to an object
51
- * the file `name` names (`names`), while `sent` or the whole file ran, is refused, and a role or
52
- * database it added is the cleanup's; a change to any other is another session's. The
53
- * replay's own database is the file's whatever it spells, as only this replay runs in it, and is
54
- * the cleanup's too. `read` is that read when the caller took it
60
+ * The server's shared catalogs read as committed against the last read: a change since to the
61
+ * replay's own database, or to what it holds, is the file's, as only this replay runs in it, and the
62
+ * cleanup drops it. A change to an object the file names is the file's when its statements so far
63
+ * can run code comb cannot read (pg-replay-hidden.ts), the one way a change past the database gets by
64
+ * the counts, and is refused, but no cleanup drops it: Postgres keeps no creator for a role or a
65
+ * database, and another session may have made it. A change to any other object, or beside statements
66
+ * that run only what their parse says, is another session's. `read` is that read when the caller took it
55
67
  */
56
68
  async function window(run: Run, at: At, read?: Snapshot): Promise<void> {
57
- strayed(run, at, read ?? (await snapshot(run.admin)))
69
+ const now = read ?? (await snapshot(run.admin))
70
+ strayed(run, { ...at, hid: await hides(run, at, now) }, now)
58
71
  }
59
72
 
73
+ /* whether a change in `now` to an object the file names may be the file's, as its statements can run code comb cannot read */
74
+ const hides = (run: Run, { hidden, names }: At, now: Snapshot): boolean | Promise<boolean> =>
75
+ snapshotChanges(run.seen, now, spelled(run, names)).length > 0 && runsHidden(run.sql, hidden)
76
+
60
77
  /**
61
78
  * window's verdict on `now`, the server's shared catalogs as committed after the file or `sent`,
62
- * against the last read; kept apart from window's await, as v8 miscounts a branch after an await
79
+ * against the last read, the objects the file names counted when it `hid` code comb cannot read;
80
+ * kept apart from window's await, as v8 miscounts a branch after an await
63
81
  */
64
- function strayed(run: Run, { name, names, sent, stops }: At, now: Snapshot): void {
65
- const its = new Set([...names, run.database])
66
- if (SESSION_ROLE.some((word) => names.has(word))) its.add(run.role)
67
- const changes = snapshotChanges(run.seen, now, its)
68
- const { databases, roles, slots } = added(run.seen, now, its)
82
+ function strayed(run: Run, { hid, name, names, sent, stops }: At & { hid: boolean }, now: Snapshot): void {
83
+ const replays = new Set([run.database])
84
+ const changes = snapshotChanges(run.seen, now, hid ? new Set([...spelled(run, names), ...replays]) : replays)
85
+ const own = new Set(snapshotChanges(run.seen, now, replays))
69
86
  const within = subscriptionsIn(run.seen, now, run.database)
70
87
  run.seen = now
71
88
  if (changes.length === 0) return
72
- run.strays.databases.push(...databases)
73
- run.strays.roles.push(...roles)
74
- run.strays.slots.push(...slots)
75
- const own = `database ${run.database} `
76
- const strays = [
77
- ...roles.map((role) => `role ${role}`),
78
- ...databases.map((database) => `database ${database} unless a session is in it`),
79
- ...slots.map((slot) => `replication slot ${slot} unless a session holds it`),
80
- ]
81
- const replays =
82
- changes.some((change) => change.startsWith(own)) || within.length > 0
89
+ const dropped =
90
+ own.size > 0
83
91
  ? `; comb drops the database it replays in${within.length === 0 ? "" : `, and ${within.join(", ")} in it`}`
84
92
  : ""
85
- const dropped = `${strays.length === 0 ? "" : `; comb drops ${strays.join(", ")}, which the file added`}${replays}`
86
- /* the read is committed, so a change it shows to an object the file did not add stays */
87
- const dropping = new Set([
88
- ...roles.map((role) => `role ${role} added`),
89
- ...databases.map((d) => `database ${d} added`),
90
- ...slots.map((slot) => `replication slot ${slot} added`),
91
- ...within.map((subject) => `${subject} added`),
92
- ])
93
- const kept = changes.filter((change) => !dropping.has(change) && !change.startsWith(own))
94
- const left = kept.length === 0 ? "" : `; devUrl's server keeps ${kept.join(", ")}, which comb cannot undo`
93
+ const kept = changes.filter((change) => !own.has(change))
94
+ const left =
95
+ kept.length === 0
96
+ ? ""
97
+ : `; comb leaves ${kept.join(", ")} on devUrl's server, as another session may have made ${kept.length === 1 ? "that change" : "those changes"}: undo there each that is the file's`
95
98
  throw new ReplayFailed(
96
99
  `${name}: devUrl's server changed past the database the replay runs in while ${sent === undefined ? "the file" : JSON.stringify(sent)} ran: ${changes.join(", ")}. A change made there, from inside a DO block, a function, EXECUTE or CALL, or over a second connection such as dblink's, apply would make on the target's server, so comb refuses the file; write the change as a statement of its own, which the replay leaves out and apply runs${dropped}${left}; ${stops}`,
97
100
  )