@intentius/sql-yodeler 0.10.1 → 0.11.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.
- package/README.md +4 -4
- package/dist/apply-steps/index.d.ts +2 -2
- package/dist/apply-steps/index.js +7 -7
- package/dist/apply-steps/index.js.map +1 -1
- package/dist/bin.js +8 -0
- package/dist/bin.js.map +1 -1
- package/dist/chant/apply.d.ts +0 -2
- package/dist/chant/apply.js +3 -4
- package/dist/chant/apply.js.map +1 -1
- package/dist/chant/build.js +3 -1
- package/dist/chant/build.js.map +1 -1
- package/dist/chant/confirm.d.ts +43 -0
- package/dist/chant/confirm.js +78 -0
- package/dist/chant/confirm.js.map +1 -0
- package/dist/chant/drift.d.ts +0 -2
- package/dist/chant/drift.js +2 -3
- package/dist/chant/drift.js.map +1 -1
- package/dist/chant/gated-request.d.ts +153 -0
- package/dist/chant/gated-request.js +91 -0
- package/dist/chant/gated-request.js.map +1 -0
- package/dist/chant/plan.d.ts +4 -6
- package/dist/chant/plan.js +8 -7
- package/dist/chant/plan.js.map +1 -1
- package/dist/chant/process.d.ts +5 -0
- package/dist/chant/process.js +5 -0
- package/dist/chant/process.js.map +1 -1
- package/dist/chant/stored-plan.d.ts +23 -0
- package/dist/chant/stored-plan.js +33 -0
- package/dist/chant/stored-plan.js.map +1 -0
- package/dist/chant-floor-version.d.ts +14 -0
- package/dist/chant-floor-version.js +15 -0
- package/dist/chant-floor-version.js.map +1 -0
- package/dist/chant-floor.d.ts +42 -0
- package/dist/chant-floor.js +82 -0
- package/dist/chant-floor.js.map +1 -0
- package/dist/check/run.js +2 -2
- package/dist/check/run.js.map +1 -1
- package/dist/ci/check-hooks.d.ts +65 -0
- package/dist/ci/check-hooks.js +101 -0
- package/dist/ci/check-hooks.js.map +1 -0
- package/dist/ci/login.d.ts +45 -0
- package/dist/ci/login.js +55 -0
- package/dist/ci/login.js.map +1 -1
- package/dist/ci/render.d.ts +127 -8
- package/dist/ci/render.js +254 -27
- package/dist/ci/render.js.map +1 -1
- package/dist/ci-words.d.ts +93 -0
- package/dist/ci-words.js +71 -0
- package/dist/ci-words.js.map +1 -0
- package/dist/cli.js +10 -1
- package/dist/cli.js.map +1 -1
- package/dist/command.js +2 -1
- package/dist/command.js.map +1 -1
- package/dist/commands/apply.d.ts +1 -1
- package/dist/commands/apply.js +44 -39
- package/dist/commands/apply.js.map +1 -1
- package/dist/commands/approve.d.ts +0 -2
- package/dist/commands/approve.js +72 -55
- package/dist/commands/approve.js.map +1 -1
- package/dist/commands/chant.d.ts +26 -0
- package/dist/commands/chant.js +37 -0
- package/dist/commands/chant.js.map +1 -0
- package/dist/commands/check.js +13 -10
- package/dist/commands/check.js.map +1 -1
- package/dist/commands/checkpoint.js +4 -5
- package/dist/commands/checkpoint.js.map +1 -1
- package/dist/commands/cleanup.d.ts +2 -0
- package/dist/commands/cleanup.js +82 -3
- package/dist/commands/cleanup.js.map +1 -1
- package/dist/commands/config.js +8 -8
- package/dist/commands/config.js.map +1 -1
- package/dist/commands/docs.js +2 -3
- package/dist/commands/docs.js.map +1 -1
- package/dist/commands/index.js +2 -0
- package/dist/commands/index.js.map +1 -1
- package/dist/commands/init.js +85 -20
- package/dist/commands/init.js.map +1 -1
- package/dist/commands/lint.js +16 -11
- package/dist/commands/lint.js.map +1 -1
- package/dist/commands/mcp.js +14 -0
- package/dist/commands/mcp.js.map +1 -1
- package/dist/commands/new.d.ts +0 -2
- package/dist/commands/new.js +8 -10
- package/dist/commands/new.js.map +1 -1
- package/dist/commands/override.js +14 -16
- package/dist/commands/override.js.map +1 -1
- package/dist/commands/plan.js +14 -10
- package/dist/commands/plan.js.map +1 -1
- package/dist/commands/rebase.js +10 -10
- package/dist/commands/rebase.js.map +1 -1
- package/dist/commands/repair.js +4 -4
- package/dist/commands/report.d.ts +0 -2
- package/dist/commands/report.js +4 -6
- package/dist/commands/report.js.map +1 -1
- package/dist/commands/revert.js +19 -17
- package/dist/commands/revert.js.map +1 -1
- package/dist/commands/status.d.ts +0 -4
- package/dist/commands/status.js +9 -11
- package/dist/commands/status.js.map +1 -1
- package/dist/commands/test.js +5 -5
- package/dist/commands/upgrade.d.ts +39 -0
- package/dist/commands/upgrade.js +197 -0
- package/dist/commands/upgrade.js.map +1 -0
- package/dist/config/define.d.ts +22 -3
- package/dist/config/define.js +1 -0
- package/dist/config/define.js.map +1 -1
- package/dist/config/load.js +8 -4
- package/dist/config/load.js.map +1 -1
- package/dist/credentials.d.ts +15 -20
- package/dist/credentials.js +7 -7
- package/dist/credentials.js.map +1 -1
- package/dist/declarative/plan.d.ts +8 -0
- package/dist/declarative/plan.js +35 -2
- package/dist/declarative/plan.js.map +1 -1
- package/dist/exit.d.ts +54 -15
- package/dist/exit.js +95 -22
- package/dist/exit.js.map +1 -1
- package/dist/history/lock.d.ts +10 -6
- package/dist/history/lock.js +16 -10
- package/dist/history/lock.js.map +1 -1
- package/dist/init/adopt.js +11 -11
- package/dist/init/adopt.js.map +1 -1
- package/dist/init/baseline.js +4 -4
- package/dist/init/baseline.js.map +1 -1
- package/dist/init/second.d.ts +5 -1
- package/dist/init/second.js +9 -6
- package/dist/init/second.js.map +1 -1
- package/dist/lint/annotations.d.ts +15 -5
- package/dist/lint/annotations.js +21 -5
- package/dist/lint/annotations.js.map +1 -1
- package/dist/lint/report.d.ts +0 -2
- package/dist/lint/report.js +2 -3
- package/dist/lint/report.js.map +1 -1
- package/dist/mcp/chant-hook.d.ts +40 -0
- package/dist/mcp/chant-hook.js +75 -0
- package/dist/mcp/chant-hook.js.map +1 -0
- package/dist/mcp/tools.js +1 -1
- package/dist/migrations/document.d.ts +1 -1
- package/dist/pr/model.js +2 -2
- package/dist/pr/model.js.map +1 -1
- package/dist/pr/note.d.ts +72 -0
- package/dist/pr/note.js +206 -0
- package/dist/pr/note.js.map +1 -0
- package/dist/pr/render.d.ts +6 -0
- package/dist/pr/render.js +2 -2
- package/dist/pr/render.js.map +1 -1
- package/dist/project.d.ts +11 -2
- package/dist/project.js +14 -3
- package/dist/project.js.map +1 -1
- package/dist/rebase/index.d.ts +0 -2
- package/dist/rebase/index.js +8 -9
- package/dist/rebase/index.js.map +1 -1
- package/dist/rebase/repair.d.ts +0 -2
- package/dist/rebase/repair.js +7 -9
- package/dist/rebase/repair.js.map +1 -1
- package/dist/replay/replay.d.ts +1 -5
- package/dist/replay/replay.js +3 -7
- package/dist/replay/replay.js.map +1 -1
- package/dist/replay/report.js +3 -2
- package/dist/replay/report.js.map +1 -1
- package/dist/replay/shared.js +3 -4
- package/dist/replay/shared.js.map +1 -1
- package/dist/report/audit.d.ts +65 -1
- package/dist/report/audit.js +73 -3
- package/dist/report/audit.js.map +1 -1
- package/dist/report/model.d.ts +15 -1
- package/dist/report/model.js +101 -2
- package/dist/report/model.js.map +1 -1
- package/dist/schemas.d.ts +1 -1
- package/dist/steps/kinds.d.ts +1 -1
- package/dist/steps/kinds.js +1 -1
- package/dist/tenants/wave.js +5 -5
- package/dist/tenants/wave.js.map +1 -1
- package/dist/testing/report.d.ts +0 -2
- package/dist/testing/report.js +2 -3
- package/dist/testing/report.js.map +1 -1
- package/dist/testing/run.js +6 -7
- package/dist/testing/run.js.map +1 -1
- package/dist/versioned/approval.d.ts +0 -2
- package/dist/versioned/approval.js +6 -5
- package/dist/versioned/approval.js.map +1 -1
- package/dist/versioned/checks.d.ts +1 -1
- package/dist/versioned/checks.js +4 -5
- package/dist/versioned/checks.js.map +1 -1
- package/dist/versioned/engine.d.ts +2 -4
- package/dist/versioned/engine.js +10 -12
- package/dist/versioned/engine.js.map +1 -1
- package/dist/versioned/index.d.ts +1 -1
- package/dist/versioned/index.js +3 -4
- package/dist/versioned/index.js.map +1 -1
- package/dist/versioned/op.js +3 -2
- package/dist/versioned/op.js.map +1 -1
- package/dist/versioned/policy.d.ts +1 -1
- package/dist/versioned/policy.js +5 -5
- package/dist/versioned/policy.js.map +1 -1
- package/dist/versioned/revert.js +11 -11
- package/dist/versioned/revert.js.map +1 -1
- package/dist/versioned/stand-down.d.ts +15 -1
- package/dist/versioned/stand-down.js +29 -1
- package/dist/versioned/stand-down.js.map +1 -1
- package/dist/waves/index.d.ts +1 -1
- package/dist/waves/index.js +26 -12
- package/dist/waves/index.js.map +1 -1
- package/dist/waves/promotion.d.ts +1 -1
- package/dist/waves/promotion.js +6 -6
- package/dist/waves/promotion.js.map +1 -1
- package/package.json +9 -7
- package/schemas/check.schema.json +1 -1
- package/schemas/lint.schema.json +1 -1
- package/schemas/plan.schema.json +1 -1
- package/schemas/report.schema.json +1 -1
package/dist/exit.js
CHANGED
|
@@ -1,28 +1,101 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* yodel's exit codes
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
2
|
+
* yodel's exit codes are chant's one exit-code table (#288, chant#4553), so a
|
|
3
|
+
* pipeline reads the same number from yodel, terragucci and plywood. Every
|
|
4
|
+
* command exits by these names; each command's `--help` lists the ones it can
|
|
5
|
+
* return. `yodel --help` and docs/cli.md print {@link EXIT_CODES}, and
|
|
6
|
+
* test/exit-codes.test.ts keeps them in agreement.
|
|
7
|
+
*
|
|
8
|
+
* The table is chant's `CHANT_EXIT`, read from `@intentius/chant/exit-codes`
|
|
9
|
+
* by {@link useChantExitTable} when the installed chant has it. Code 9 (`misplaced`, chant#4624) is read the same way. A chant
|
|
10
|
+
* released before that subpath has no table to read, so yodel keeps
|
|
11
|
+
* {@link FALLBACK_EXIT}, the same numbers.
|
|
6
12
|
*/
|
|
7
|
-
|
|
8
|
-
export const
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
13
|
+
/** chant's table, as chant#4553 set it and chant#4624 extended it with 9: the fallback for a chant that does not export it. */
|
|
14
|
+
export const FALLBACK_EXIT = {
|
|
15
|
+
done: 0,
|
|
16
|
+
failed: 1,
|
|
17
|
+
drift: 2,
|
|
18
|
+
waiting: 3,
|
|
19
|
+
moved: 4,
|
|
20
|
+
held: 5,
|
|
21
|
+
superseded: 6,
|
|
22
|
+
denied: 7,
|
|
23
|
+
declined: 8,
|
|
24
|
+
misplaced: 9,
|
|
25
|
+
};
|
|
26
|
+
/** The names a chant table must carry for yodel to read it. */
|
|
27
|
+
const REQUIRED = ["done", "failed", "drift", "waiting", "moved", "held", "superseded", "denied", "declined", "misplaced"];
|
|
28
|
+
/* The codes are live bindings: each starts at the fallback's number, and useChantExitTable() sets them from chant's table. */
|
|
29
|
+
/** Done, or nothing to do. */
|
|
30
|
+
export let EXIT_OK = FALLBACK_EXIT.done;
|
|
31
|
+
/** Something broke, or a refusal no approval fixes. Usage and config errors too. */
|
|
32
|
+
export let EXIT_FAILED = FALLBACK_EXIT.failed;
|
|
33
|
+
/** Drift found, for `yodel drift`. */
|
|
34
|
+
export let EXIT_DRIFT = FALLBACK_EXIT.drift;
|
|
35
|
+
/** Stopped for a person: a gate, pending migrations, a migration the required environment has not applied, a step yodel will not run itself. */
|
|
36
|
+
export let EXIT_WAITING = FALLBACK_EXIT.waiting;
|
|
37
|
+
/** The approved plan no longer matches the plan that would apply now. */
|
|
38
|
+
export let EXIT_MOVED = FALLBACK_EXIT.moved;
|
|
15
39
|
/** Another apply holds the lock. */
|
|
16
|
-
export
|
|
17
|
-
/**
|
|
18
|
-
export
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
40
|
+
export let EXIT_HELD = FALLBACK_EXIT.held;
|
|
41
|
+
/** A newer push applies instead. yodel itself does not return it: `yodel apply --stand-down` exits 0. */
|
|
42
|
+
export let EXIT_SUPERSEDED = FALLBACK_EXIT.superseded;
|
|
43
|
+
/** A policy rule denies the plan and no override counts. */
|
|
44
|
+
export let EXIT_DENIED = FALLBACK_EXIT.denied;
|
|
45
|
+
/** An answer at a confirmation that does not approve. */
|
|
46
|
+
export let EXIT_DECLINED = FALLBACK_EXIT.declined;
|
|
47
|
+
/** A job guard refused: the job runs where it is not set to run (`chant ci check-job`). yodel itself does not return it: the guard in a generated job exits 9 before yodel starts. */
|
|
48
|
+
export let EXIT_MISPLACED = FALLBACK_EXIT.misplaced;
|
|
49
|
+
/** Each code yodel returns and what it means, one line each. */
|
|
50
|
+
export let EXIT_CODES = exitCodes();
|
|
51
|
+
function exitCodes() {
|
|
52
|
+
return [
|
|
53
|
+
[EXIT_OK, "done, or nothing to do"],
|
|
54
|
+
[EXIT_FAILED, "failed, or refused for a reason no approval fixes: a bad config, a checksum mismatch, an applied migration gone from the directory, an out-of-order migration, a fork or another problem in the migrations directory, an environment whose reader and writer are one identity, a command that writes run with an environment's reader, lint errors"],
|
|
55
|
+
[EXIT_DRIFT, "for yodel drift, drift found"],
|
|
56
|
+
[EXIT_WAITING, "waiting for a person: apply stopped at its approval gate, status found pending migrations, a migration the environment it must run on first has not applied, a change that needs an Op yodel does not run, a manual step"],
|
|
57
|
+
[EXIT_MOVED, "the plan moved: the approved plan, or the one a wave decided on, is not the plan that would apply now; nothing applied"],
|
|
58
|
+
[EXIT_HELD, "another apply holds the lock"],
|
|
59
|
+
[EXIT_DENIED, "a policy rule denies the plan and no override counts; nothing applied"],
|
|
60
|
+
[EXIT_DECLINED, "yodel approve: the answer was not the environment's name; nothing approved"],
|
|
61
|
+
];
|
|
62
|
+
}
|
|
63
|
+
let loaded;
|
|
64
|
+
/**
|
|
65
|
+
* Reads chant's table from the installed chant, once, and sets every code
|
|
66
|
+
* from it. The import is lazy and its specifier a variable, so a published
|
|
67
|
+
* chant without `@intentius/chant/exit-codes` (before chant#4553's release)
|
|
68
|
+
* leaves the fallback in place. `main()` calls it before any verb runs.
|
|
69
|
+
* Resolves to which table the codes came from.
|
|
70
|
+
*/
|
|
71
|
+
export function useChantExitTable() {
|
|
72
|
+
loaded ??= (async () => {
|
|
73
|
+
const specifier = "@intentius/chant/exit-codes";
|
|
74
|
+
let table;
|
|
75
|
+
try {
|
|
76
|
+
table = (await import(specifier)).CHANT_EXIT;
|
|
77
|
+
}
|
|
78
|
+
catch {
|
|
79
|
+
return "fallback";
|
|
80
|
+
}
|
|
81
|
+
if (!table || !REQUIRED.every((name) => typeof table[name] === "number"))
|
|
82
|
+
return "fallback";
|
|
83
|
+
const code = (name) => table[name];
|
|
84
|
+
EXIT_OK = code("done");
|
|
85
|
+
EXIT_FAILED = code("failed");
|
|
86
|
+
EXIT_DRIFT = code("drift");
|
|
87
|
+
EXIT_WAITING = code("waiting");
|
|
88
|
+
EXIT_MOVED = code("moved");
|
|
89
|
+
EXIT_HELD = code("held");
|
|
90
|
+
EXIT_SUPERSEDED = code("superseded");
|
|
91
|
+
EXIT_DENIED = code("denied");
|
|
92
|
+
EXIT_DECLINED = code("declined");
|
|
93
|
+
EXIT_MISPLACED = code("misplaced");
|
|
94
|
+
EXIT_CODES = exitCodes();
|
|
95
|
+
return "chant";
|
|
96
|
+
})();
|
|
97
|
+
return loaded;
|
|
98
|
+
}
|
|
26
99
|
/** Why `yodel plan` exits 0 with pending migrations, where `yodel status` exits 3. */
|
|
27
100
|
export const PLAN_PENDING_NOTE = "yodel plan exits 0 when migrations are pending: it reports, and a CI job that posts the plan on a pull request should not fail because the pull request adds a migration. To gate on pending migrations, use yodel status.";
|
|
28
101
|
//# sourceMappingURL=exit.js.map
|
package/dist/exit.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"exit.js","sourceRoot":"","sources":["../src/exit.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"exit.js","sourceRoot":"","sources":["../src/exit.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,+HAA+H;AAC/H,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,IAAI,EAAE,CAAC;IACP,MAAM,EAAE,CAAC;IACT,KAAK,EAAE,CAAC;IACR,OAAO,EAAE,CAAC;IACV,KAAK,EAAE,CAAC;IACR,IAAI,EAAE,CAAC;IACP,UAAU,EAAE,CAAC;IACb,MAAM,EAAE,CAAC;IACT,QAAQ,EAAE,CAAC;IACX,SAAS,EAAE,CAAC;CACJ,CAAC;AAEX,+DAA+D;AAC/D,MAAM,QAAQ,GAA4B,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;AAKnJ,8HAA8H;AAE9H,8BAA8B;AAC9B,MAAM,CAAC,IAAI,OAAO,GAAW,aAAa,CAAC,IAAI,CAAC;AAChD,oFAAoF;AACpF,MAAM,CAAC,IAAI,WAAW,GAAW,aAAa,CAAC,MAAM,CAAC;AACtD,sCAAsC;AACtC,MAAM,CAAC,IAAI,UAAU,GAAW,aAAa,CAAC,KAAK,CAAC;AACpD,gJAAgJ;AAChJ,MAAM,CAAC,IAAI,YAAY,GAAW,aAAa,CAAC,OAAO,CAAC;AACxD,yEAAyE;AACzE,MAAM,CAAC,IAAI,UAAU,GAAW,aAAa,CAAC,KAAK,CAAC;AACpD,oCAAoC;AACpC,MAAM,CAAC,IAAI,SAAS,GAAW,aAAa,CAAC,IAAI,CAAC;AAClD,yGAAyG;AACzG,MAAM,CAAC,IAAI,eAAe,GAAW,aAAa,CAAC,UAAU,CAAC;AAC9D,4DAA4D;AAC5D,MAAM,CAAC,IAAI,WAAW,GAAW,aAAa,CAAC,MAAM,CAAC;AACtD,yDAAyD;AACzD,MAAM,CAAC,IAAI,aAAa,GAAW,aAAa,CAAC,QAAQ,CAAC;AAC1D,sLAAsL;AACtL,MAAM,CAAC,IAAI,cAAc,GAAW,aAAa,CAAC,SAAS,CAAC;AAE5D,gEAAgE;AAChE,MAAM,CAAC,IAAI,UAAU,GAA6C,SAAS,EAAE,CAAC;AAE9E,SAAS,SAAS;IAChB,OAAO;QACL,CAAC,OAAO,EAAE,wBAAwB,CAAC;QACnC,CAAC,WAAW,EAAE,oVAAoV,CAAC;QACnW,CAAC,UAAU,EAAE,8BAA8B,CAAC;QAC5C,CAAC,YAAY,EAAE,0NAA0N,CAAC;QAC1O,CAAC,UAAU,EAAE,wHAAwH,CAAC;QACtI,CAAC,SAAS,EAAE,8BAA8B,CAAC;QAC3C,CAAC,WAAW,EAAE,uEAAuE,CAAC;QACtF,CAAC,aAAa,EAAE,4EAA4E,CAAC;KAC9F,CAAC;AACJ,CAAC;AAED,IAAI,MAAiD,CAAC;AAEtD;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB;IAC/B,MAAM,KAAK,CAAC,KAAK,IAAI,EAAE;QACrB,MAAM,SAAS,GAAG,6BAA6B,CAAC;QAChD,IAAI,KAAqD,CAAC;QAC1D,IAAI,CAAC;YACH,KAAK,GAAI,CAAC,MAAM,MAAM,CAAC,SAAS,CAAC,CAAyD,CAAC,UAAU,CAAC;QACxG,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,UAAU,CAAC;QACpB,CAAC;QACD,IAAI,CAAC,KAAK,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,QAAQ,CAAC;YAAE,OAAO,UAAU,CAAC;QAC5F,MAAM,IAAI,GAAG,CAAC,IAAc,EAAU,EAAE,CAAC,KAAK,CAAC,IAAI,CAAW,CAAC;QAC/D,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;QACvB,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7B,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;QAC3B,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;QAC/B,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;QAC3B,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;QACzB,eAAe,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC;QACrC,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7B,aAAa,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC;QACjC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC;QACnC,UAAU,GAAG,SAAS,EAAE,CAAC;QACzB,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC,EAAE,CAAC;IACL,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,sFAAsF;AACtF,MAAM,CAAC,MAAM,iBAAiB,GAC5B,4NAA4N,CAAC"}
|
package/dist/history/lock.d.ts
CHANGED
|
@@ -19,10 +19,16 @@
|
|
|
19
19
|
* The row names its owner and an expiry. A runner that holds it extends the
|
|
20
20
|
* expiry while it works (a heartbeat every third of the TTL) and deletes the
|
|
21
21
|
* row when done. A runner that finds an expired row deletes that row (by its
|
|
22
|
-
* owner, so it never deletes a newer one
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
* before its next statement.
|
|
22
|
+
* owner, so it never deletes a newer one, and only while it is still
|
|
23
|
+
* expired) and inserts its own; two runners racing for an expired lock both
|
|
24
|
+
* delete, and only one insert succeeds. A heartbeat that finds the row gone
|
|
25
|
+
* or someone else's stops the apply before its next statement.
|
|
26
|
+
*
|
|
27
|
+
* The expiry is in the delete's WHERE, not only in the read before it: the
|
|
28
|
+
* holder can heartbeat between the two (#283). In strict mode the delete is
|
|
29
|
+
* a Keeper remove at the version its own scan read, so the predicate and the
|
|
30
|
+
* remove are one step, and a row the holder has just extended is left
|
|
31
|
+
* alone.
|
|
26
32
|
*
|
|
27
33
|
* KeeperMap needs Keeper and the server setting `keeper_map_path_prefix`.
|
|
28
34
|
*
|
|
@@ -46,8 +52,6 @@
|
|
|
46
52
|
import { YodelError } from "../project.js";
|
|
47
53
|
import { type ClickHousePort } from "./client.js";
|
|
48
54
|
import { type HistoryTopology } from "./topology.js";
|
|
49
|
-
/** Exit code: another apply holds the lock. */
|
|
50
|
-
export declare const LOCKED = 5;
|
|
51
55
|
/** The lock row's key: one apply lock per history database. */
|
|
52
56
|
export declare const LOCK_NAME = "apply";
|
|
53
57
|
/** Default lock TTL. */
|
package/dist/history/lock.js
CHANGED
|
@@ -19,10 +19,16 @@
|
|
|
19
19
|
* The row names its owner and an expiry. A runner that holds it extends the
|
|
20
20
|
* expiry while it works (a heartbeat every third of the TTL) and deletes the
|
|
21
21
|
* row when done. A runner that finds an expired row deletes that row (by its
|
|
22
|
-
* owner, so it never deletes a newer one
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
* before its next statement.
|
|
22
|
+
* owner, so it never deletes a newer one, and only while it is still
|
|
23
|
+
* expired) and inserts its own; two runners racing for an expired lock both
|
|
24
|
+
* delete, and only one insert succeeds. A heartbeat that finds the row gone
|
|
25
|
+
* or someone else's stops the apply before its next statement.
|
|
26
|
+
*
|
|
27
|
+
* The expiry is in the delete's WHERE, not only in the read before it: the
|
|
28
|
+
* holder can heartbeat between the two (#283). In strict mode the delete is
|
|
29
|
+
* a Keeper remove at the version its own scan read, so the predicate and the
|
|
30
|
+
* remove are one step, and a row the holder has just extended is left
|
|
31
|
+
* alone.
|
|
26
32
|
*
|
|
27
33
|
* KeeperMap needs Keeper and the server setting `keeper_map_path_prefix`.
|
|
28
34
|
*
|
|
@@ -51,8 +57,7 @@ import { YodelError } from "../project.js";
|
|
|
51
57
|
import { serverMessage } from "./client.js";
|
|
52
58
|
import { databaseDdl, ident, literal, LOCK_TABLE, lockTableDdl } from "./ddl.js";
|
|
53
59
|
import { describeTopology } from "./topology.js";
|
|
54
|
-
|
|
55
|
-
export const LOCKED = 5;
|
|
60
|
+
import { EXIT_HELD } from "../exit.js";
|
|
56
61
|
/** The lock row's key: one apply lock per history database. */
|
|
57
62
|
export const LOCK_NAME = "apply";
|
|
58
63
|
/** Default lock TTL. */
|
|
@@ -68,7 +73,7 @@ export class LockHeldError extends YodelError {
|
|
|
68
73
|
waited) {
|
|
69
74
|
super(`another apply holds the lock (${where}): owner ${holder}, ${where.startsWith("Postgres advisory lock") ? "since" : "until"} ${expiresAt} UTC. ` +
|
|
70
75
|
(waited ? `This run ${waited}. ` : "") +
|
|
71
|
-
`Wait for it, or once you know it is not running, clear it with: ${clear}`,
|
|
76
|
+
`Wait for it, or once you know it is not running, clear it with: ${clear}`, EXIT_HELD);
|
|
72
77
|
this.holder = holder;
|
|
73
78
|
this.expiresAt = expiresAt;
|
|
74
79
|
this.where = where;
|
|
@@ -79,7 +84,7 @@ export class LockHeldError extends YodelError {
|
|
|
79
84
|
}
|
|
80
85
|
export class LockLostError extends YodelError {
|
|
81
86
|
constructor(where) {
|
|
82
|
-
super(`the apply lock (${where}) is no longer held by this run (it expired and another run took it); stopped before the next statement`,
|
|
87
|
+
super(`the apply lock (${where}) is no longer held by this run (it expired and another run took it); stopped before the next statement`, EXIT_HELD);
|
|
83
88
|
this.name = "LockLostError";
|
|
84
89
|
}
|
|
85
90
|
}
|
|
@@ -129,9 +134,10 @@ async function keeperLock(port, options, ttlMs) {
|
|
|
129
134
|
throw new LockHeldError(held.owner, held.until, where, clear);
|
|
130
135
|
if (attempt >= 3)
|
|
131
136
|
throw new LockHeldError(held?.owner ?? "(unknown)", held?.until ?? "(unknown)", where, clear);
|
|
132
|
-
// Expired (or released between the insert and the read): delete that owner's row, never a newer one
|
|
137
|
+
// Expired (or released between the insert and the read): delete that owner's row, never a newer one nor one it has
|
|
138
|
+
// renewed since the read, and try again.
|
|
133
139
|
if (held)
|
|
134
|
-
await port.query(`ALTER TABLE ${table} DELETE WHERE name = ${literal(LOCK_NAME)} AND owner = ${literal(held.owner)}`, { settings: STRICT });
|
|
140
|
+
await port.query(`ALTER TABLE ${table} DELETE WHERE name = ${literal(LOCK_NAME)} AND owner = ${literal(held.owner)} AND expires_at < now64(3)`, { settings: STRICT });
|
|
135
141
|
}
|
|
136
142
|
}
|
|
137
143
|
return {
|
package/dist/history/lock.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"lock.js","sourceRoot":"","sources":["../../src/history/lock.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"lock.js","sourceRoot":"","sources":["../../src/history/lock.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AAEH,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACrD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACzE,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAuB,MAAM,aAAa,CAAC;AACjE,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACjF,OAAO,EAAE,gBAAgB,EAAwB,MAAM,eAAe,CAAC;AACvE,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAGvC,+DAA+D;AAC/D,MAAM,CAAC,MAAM,SAAS,GAAG,OAAO,CAAC;AAEjC,wBAAwB;AACxB,MAAM,CAAC,MAAM,mBAAmB,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAgBlD,MAAM,OAAO,aAAc,SAAQ,UAAU;IAEhC;IACA;IACA;IACA;IAEA;IANX,YACW,MAAc,EACd,SAAiB,EACjB,KAAa,EACb,KAAa;IACtB,0EAA0E;IACjE,MAAe;QAExB,KAAK,CACH,iCAAiC,KAAK,YAAY,MAAM,KAAK,KAAK,CAAC,UAAU,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,IAAI,SAAS,QAAQ;YAC9I,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,MAAM,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;YACtC,mEAAmE,KAAK,EAAE,EAC5E,SAAS,CACV,CAAC;QAZO,WAAM,GAAN,MAAM,CAAQ;QACd,cAAS,GAAT,SAAS,CAAQ;QACjB,UAAK,GAAL,KAAK,CAAQ;QACb,UAAK,GAAL,KAAK,CAAQ;QAEb,WAAM,GAAN,MAAM,CAAS;QAQxB,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;IAC9B,CAAC;CACF;AAED,MAAM,OAAO,aAAc,SAAQ,UAAU;IAC3C,YAAY,KAAa;QACvB,KAAK,CAAC,mBAAmB,KAAK,yGAAyG,EAAE,SAAS,CAAC,CAAC;QACpJ,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;IAC9B,CAAC;CACF;AAcD,0FAA0F;AAC1F,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,MAAc,EAAU,EAAE,CAAC,GAAG,MAAM,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,UAAU,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;AAEpH,MAAM,YAAY,GAAG,CAAC,CAAU,EAAE,EAAE,CAAC,6BAA6B,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;AAC1F,MAAM,oBAAoB,GAAG,CAAC,CAAU,EAAE,EAAE,CAAC,8HAA8H,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;AAEnM,MAAM,MAAM,GAAG,EAAE,sBAAsB,EAAE,GAAG,EAAE,YAAY,EAAE,GAAG,EAAE,CAAC;AAElE,8EAA8E;AAC9E,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,IAAoB,EAAE,OAAoB;IAC1E,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,mBAAmB,CAAC;IACnD,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;IACvC,IAAI,CAAC;QACH,MAAM,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1C,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC;YAAE,MAAM,CAAC,CAAC;QACtC,MAAM,GAAG,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,8BAA8B,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,wCAAwC,EAAE,EAAE,CAAC,CAAC;QACtJ,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACvC,MAAM,IAAI,UAAU,CAClB,YAAY,gBAAgB,CAAC,OAAO,CAAC,QAAQ,CAAC,+EAA+E,GAAG,IAAI;gBAClI,4DAA4D,CAC/D,CAAC;QACJ,CAAC;QACD,OAAO,SAAS,CAAC,OAAO,EAAE,KAAK,EAAE,gCAAgC,GAAG,0GAA0G,CAAC,CAAC;IAClL,CAAC;IACD,OAAO,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;AAC1C,CAAC;AAED,KAAK,UAAU,UAAU,CAAC,IAAoB,EAAE,OAAoB,EAAE,KAAa;IACjF,MAAM,KAAK,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,UAAU,EAAE,CAAC;IACzD,MAAM,KAAK,GAAG,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACxC,MAAM,KAAK,GAAG,aAAa,OAAO,CAAC,QAAQ,IAAI,UAAU,EAAE,CAAC;IAC5D,MAAM,KAAK,GAAG,eAAe,KAAK,yBAAyB,SAAS,GAAG,CAAC;IACxE,MAAM,KAAK,GAAG,oCAAoC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC;IACnE,MAAM,IAAI,GAAG,KAAK,IAAI,EAAE,CACtB,CAAC,MAAM,IAAI,CAAC,KAAK;IACf,kHAAkH;IAClH,sFAAsF,KAAK,iBAAiB,OAAO,CAAC,SAAS,CAAC,EAAE,CACjI,CAAC,CAAC,CAAC,CAAC,CAAC;IAER,KAAK,IAAI,OAAO,GAAG,CAAC,GAAI,OAAO,EAAE,EAAE,CAAC;QAClC,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,KAAK,CAAC,eAAe,KAAK,kDAAkD,OAAO,CAAC,SAAS,CAAC,KAAK,OAAO,CAAC,KAAK,CAAC,eAAe,KAAK,EAAE,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;YAC1K,MAAM;QACR,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;gBAAE,MAAM,CAAC,CAAC;YAC9B,MAAM,IAAI,GAAG,MAAM,IAAI,EAAE,CAAC;YAC1B,IAAI,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;gBAAE,MAAM,IAAI,aAAa,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;YACtG,IAAI,OAAO,IAAI,CAAC;gBAAE,MAAM,IAAI,aAAa,CAAC,IAAI,EAAE,KAAK,IAAI,WAAW,EAAE,IAAI,EAAE,KAAK,IAAI,WAAW,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;YAChH,mHAAmH;YACnH,yCAAyC;YACzC,IAAI,IAAI;gBAAE,MAAM,IAAI,CAAC,KAAK,CAAC,eAAe,KAAK,wBAAwB,OAAO,CAAC,SAAS,CAAC,gBAAgB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,4BAA4B,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;QAClL,CAAC;IACH,CAAC;IAED,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,KAAK;QACL,KAAK;QACL,KAAK,CAAC,SAAS;YACb,MAAM,IAAI,CAAC,KAAK,CAAC,eAAe,KAAK,wBAAwB,KAAK,iBAAiB,OAAO,CAAC,SAAS,CAAC,gBAAgB,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;YAC7J,MAAM,IAAI,GAAG,MAAM,IAAI,EAAE,CAAC;YAC1B,IAAI,IAAI,EAAE,KAAK,KAAK,KAAK;gBAAE,MAAM,IAAI,aAAa,CAAC,KAAK,CAAC,CAAC;QAC5D,CAAC;QACD,KAAK,CAAC,OAAO;YACX,MAAM,IAAI,CAAC,KAAK,CAAC,eAAe,KAAK,wBAAwB,OAAO,CAAC,SAAS,CAAC,gBAAgB,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;QACzI,CAAC;KACF,CAAC;AACJ,CAAC;AAQD,+DAA+D;AAC/D,MAAM,UAAU,aAAa,CAAC,OAAiE;IAC7F,MAAM,GAAG,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,KAAK,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAChH,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,GAAG,OAAO,CAAC,QAAQ,IAAI,GAAG,OAAO,CAAC,CAAC;AACpG,CAAC;AAED,SAAS,YAAY,CAAC,IAAY;IAChC,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAa,CAAC;IAC5D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,SAAS,CAAC,OAAoB,EAAE,KAAa,EAAE,MAAc;IACpE,MAAM,IAAI,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;IACpC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACjD,MAAM,KAAK,GAAG,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACxC,MAAM,KAAK,GAAG,mBAAmB,IAAI,EAAE,CAAC;IACxC,MAAM,IAAI,GAAG,GAAW,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,CAAC,WAAW,EAAE,EAAqB,CAAC,CAAC;IAErK,KAAK,IAAI,OAAO,GAAG,CAAC,GAAI,OAAO,EAAE,EAAE,CAAC;QAClC,IAAI,CAAC;YACH,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;YAC5C,MAAM;QACR,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAK,CAA2B,CAAC,IAAI,KAAK,QAAQ;gBAAE,MAAM,CAAC,CAAC;YAC5D,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;YAChC,MAAM,OAAO,GAAG,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACjE,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC;gBAAE,MAAM,IAAI,aAAa,CAAC,IAAI,EAAE,KAAK,IAAI,cAAc,EAAE,IAAI,EAAE,SAAS,IAAI,WAAW,EAAE,KAAK,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC;YAC1I,MAAM,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED,OAAO;QACL,IAAI,EAAE,OAAO;QACb,KAAK;QACL,KAAK;QACL,MAAM;QACN,SAAS;YACP,IAAI,YAAY,CAAC,IAAI,CAAC,EAAE,KAAK,KAAK,KAAK;gBAAE,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;YACzF,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;YAC5B,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;QAC3B,CAAC;QACD,OAAO;YACL,IAAI,YAAY,CAAC,IAAI,CAAC,EAAE,KAAK,KAAK,KAAK;gBAAE,MAAM,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;YACvE,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;QAC3B,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAI,IAAU,EAAE,KAAa,EAAE,IAA+C;IAC1G,IAAI,IAAa,CAAC;IAClB,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE;QAC7B,IAAI,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,CAAC,CAAU,EAAE,EAAE;YACpC,IAAI,KAAK,CAAC,CAAC;QACb,CAAC,CAAC,CAAC;IACL,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1C,KAAK,CAAC,KAAK,EAAE,CAAC;IACd,MAAM,IAAI,GAAG,KAAK,IAAI,EAAE;QACtB,IAAI,IAAI,KAAK,SAAS;YAAE,MAAM,IAAI,YAAY,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC3F,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;IACzB,CAAC,CAAC;IACF,IAAI,CAAC;QACH,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;YAAS,CAAC;QACT,aAAa,CAAC,KAAK,CAAC,CAAC;QACrB,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAC9C,CAAC;AACH,CAAC"}
|
package/dist/init/adopt.js
CHANGED
|
@@ -26,12 +26,12 @@
|
|
|
26
26
|
* history database (schema) and table when they were not there.
|
|
27
27
|
*/
|
|
28
28
|
import { join, relative } from "node:path";
|
|
29
|
-
import { loadProject, YodelError } from "../project.js";
|
|
29
|
+
import { loadProject, YodelError, yodelRefusal } from "../project.js";
|
|
30
30
|
import { buildSchema } from "../chant/build.js";
|
|
31
31
|
import { planEnvironment, renderPlan } from "../chant/plan.js";
|
|
32
32
|
import { createMigration, MIGRATIONS_DIR, writeMigration } from "../migrations/index.js";
|
|
33
33
|
import { environmentSettings } from "../config/settings.js";
|
|
34
|
-
import { closeVersioned, hasMigrations, openVersioned
|
|
34
|
+
import { closeVersioned, hasMigrations, openVersioned } from "../versioned/index.js";
|
|
35
35
|
import { BASELINE_NAME, checkHistoryEmpty, recordBaseline } from "./baseline.js";
|
|
36
36
|
import { declarationFiles, Journal } from "./files.js";
|
|
37
37
|
import { describeImported, importLive } from "./live.js";
|
|
@@ -41,23 +41,23 @@ export const schemaDir = (project) => join(project.dir, project.config.sourceDir
|
|
|
41
41
|
/** The refusals that need no server: a schema already declared, migrations already there, a ClickHouse scope that would take in the history. */
|
|
42
42
|
export function preflight(project, env, options = {}) {
|
|
43
43
|
if (hasMigrations(project)) {
|
|
44
|
-
throw
|
|
44
|
+
throw yodelRefusal(`refused: ${join(project.dir, MIGRATIONS_DIR)} already holds migrations; init writes the first one (the baseline), so it adopts a database only in a project with none. Nothing was written.`);
|
|
45
45
|
}
|
|
46
46
|
const dir = schemaDir(project);
|
|
47
47
|
const existing = declarationFiles(dir);
|
|
48
48
|
if (existing.length > 0 && !options.force) {
|
|
49
|
-
throw
|
|
50
|
-
`init writes the declarations from the live database there. Pass --force to overwrite (files the import does not write are kept, and are built with it). Nothing was written
|
|
49
|
+
throw yodelRefusal(`refused: ${relative(project.dir, dir) || "."} already declares a schema (${existing.slice(0, 3).join(", ")}${existing.length > 3 ? ", ..." : ""}); ` +
|
|
50
|
+
`init writes the declarations from the live database there. Pass --force to overwrite (files the import does not write are kept, and are built with it). Nothing was written.`);
|
|
51
51
|
}
|
|
52
52
|
const { historyDatabase } = environmentSettings(project, env.name, options.processEnv);
|
|
53
53
|
const [key, what] = project.dialect === "postgres" ? ["schemas", "schema"] : ["databases", "database"];
|
|
54
54
|
const scope = project.dialect === "postgres" ? env.profile.schemas : env.profile.databases;
|
|
55
55
|
if (!scope || scope.length === 0) {
|
|
56
|
-
throw
|
|
57
|
-
`List the ${key} this project owns in sql.profiles.${env.name}.${key}. Nothing was written
|
|
56
|
+
throw yodelRefusal(`refused: sql.profiles.${env.name} names no ${key}, so the import would read every ${what} on the server, the history's (${historyDatabase}) included. ` +
|
|
57
|
+
`List the ${key} this project owns in sql.profiles.${env.name}.${key}. Nothing was written.`);
|
|
58
58
|
}
|
|
59
59
|
if (scope.includes(historyDatabase)) {
|
|
60
|
-
throw
|
|
60
|
+
throw yodelRefusal(`refused: sql.profiles.${env.name}.${key} includes ${historyDatabase}, the history's ${what} (yodel.config.ts environments.${env.name}.history.database, else YODEL_HISTORY_DATABASE); the history is yodel's, never part of the declared schema. Nothing was written.`);
|
|
61
61
|
}
|
|
62
62
|
}
|
|
63
63
|
/**
|
|
@@ -71,10 +71,10 @@ const planIsEmpty = (plan, leftOut = []) => plan.diff.changes.every((c) => leftO
|
|
|
71
71
|
export function unsupportedRefusal(environment, unsupported, skip) {
|
|
72
72
|
if (unsupported.length === 0 || skip)
|
|
73
73
|
return undefined;
|
|
74
|
-
return
|
|
74
|
+
return yodelRefusal(`refused: ${environment} holds ${String(unsupported.length)} object${unsupported.length === 1 ? "" : "s"} of a kind chant's sql lexicon cannot declare:\n` +
|
|
75
75
|
unsupported.map((u) => ` ${u}`).join("\n") +
|
|
76
76
|
`\nAdopting without them would leave them out of the declared schema, and drift would never report them. ` +
|
|
77
|
-
`Pass --skip-unsupported to adopt the rest and record these in the baseline's note. Nothing was written
|
|
77
|
+
`Pass --skip-unsupported to adopt the rest and record these in the baseline's note. Nothing was written.`);
|
|
78
78
|
}
|
|
79
79
|
/** Adopts `env`'s live database into the project; see the module comment. */
|
|
80
80
|
export async function adopt(project, env, options = {}) {
|
|
@@ -108,7 +108,7 @@ async function adoptWith(project, env, venv, options, processEnv, log) {
|
|
|
108
108
|
live = await importLive(project, env, processEnv, true);
|
|
109
109
|
}
|
|
110
110
|
if (live.ir.resources.length === 0) {
|
|
111
|
-
throw
|
|
111
|
+
throw yodelRefusal(`refused: ${env.name} holds no objects in its scope (sql.profiles.${env.name}); there is nothing to adopt. Declare a schema and run yodel new instead. Nothing was written.`);
|
|
112
112
|
}
|
|
113
113
|
const objects = [...describeImported(live.ir), ...(live.access ?? [])];
|
|
114
114
|
log(`read ${String(objects.length)} object(s) from ${env.name}`);
|
package/dist/init/adopt.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"adopt.js","sourceRoot":"","sources":["../../src/init/adopt.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,UAAU,EAAkC,MAAM,eAAe,CAAC;
|
|
1
|
+
{"version":3,"file":"adopt.js","sourceRoot":"","sources":["../../src/init/adopt.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,UAAU,EAAkC,YAAY,EAAE,MAAM,eAAe,CAAC;AACtG,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,UAAU,EAAa,MAAM,kBAAkB,CAAC;AAC1E,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,cAAc,EAAkB,MAAM,wBAAwB,CAAC;AACzG,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,aAAa,EAAqB,MAAM,uBAAuB,CAAC;AAExG,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AACjF,OAAO,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACzD,OAAO,EAAE,mBAAmB,EAAoB,MAAM,kBAAkB,CAAC;AA+BzE,oFAAoF;AACpF,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,OAAgB,EAAU,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,MAAM,CAAC,SAAS,IAAI,KAAK,CAAC,CAAC;AAE5G,gJAAgJ;AAChJ,MAAM,UAAU,SAAS,CAAC,OAAgB,EAAE,GAAgB,EAAE,UAA+D,EAAE;IAC7H,IAAI,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3B,MAAM,YAAY,CAChB,YAAY,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,cAAc,CAAC,gJAAgJ,CAC9L,CAAC;IACJ,CAAC;IACD,MAAM,GAAG,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;IAC/B,MAAM,QAAQ,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;IACvC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QAC1C,MAAM,YAAY,CAChB,YAAY,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,GAAG,+BAA+B,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK;YACnJ,8KAA8K,CACjL,CAAC;IACJ,CAAC;IACD,MAAM,EAAE,eAAe,EAAE,GAAG,mBAAmB,CAAC,OAAO,EAAE,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IACvF,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,OAAO,CAAC,OAAO,KAAK,UAAU,CAAC,CAAC,CAAE,CAAC,SAAS,EAAE,QAAQ,CAAW,CAAC,CAAC,CAAE,CAAC,WAAW,EAAE,UAAU,CAAW,CAAC;IAC7H,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,KAAK,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC;IAC3F,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACjC,MAAM,YAAY,CAChB,yBAAyB,GAAG,CAAC,IAAI,aAAa,GAAG,oCAAoC,IAAI,kCAAkC,eAAe,cAAc;YACtJ,YAAY,GAAG,sCAAsC,GAAG,CAAC,IAAI,IAAI,GAAG,wBAAwB,CAC/F,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;QACpC,MAAM,YAAY,CAChB,yBAAyB,GAAG,CAAC,IAAI,IAAI,GAAG,aAAa,eAAe,mBAAmB,IAAI,kCAAkC,GAAG,CAAC,IAAI,kIAAkI,CACxQ,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,WAAW,GAAG,CAAC,IAAU,EAAE,UAA6B,EAAE,EAAW,EAAE,CAC3E,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC;AAE1F,wIAAwI;AACxI,MAAM,UAAU,kBAAkB,CAAC,WAAmB,EAAE,WAA8B,EAAE,IAAa;IACnG,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI;QAAE,OAAO,SAAS,CAAC;IACvD,OAAO,YAAY,CACjB,YAAY,WAAW,UAAU,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,UAAU,WAAW,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,kDAAkD;QACxJ,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QAC3C,0GAA0G;QAC1G,yGAAyG,CAC5G,CAAC;AACJ,CAAC;AAED,6EAA6E;AAC7E,MAAM,CAAC,KAAK,UAAU,KAAK,CAAC,OAAgB,EAAE,GAAgB,EAAE,UAAwB,EAAE;IACxF,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,GAAG,CAAC;IACrD,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAC7C,SAAS,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;IAE1G,MAAM,IAAI,GAAiB,MAAM,aAAa,CAAC,OAAO,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;IACzE,IAAI,CAAC;QACH,MAAM,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAC9B,OAAO,MAAM,SAAS,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,CAAC,CAAC;IACvE,CAAC;YAAS,CAAC;QACT,MAAM,cAAc,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;AACH,CAAC;AAED,KAAK,UAAU,SAAS,CAAC,OAAgB,EAAE,GAAgB,EAAE,IAAkB,EAAE,OAAqB,EAAE,UAA6B,EAAE,GAA2B;IAChK,IAAI,WAAW,GAAa,EAAE,CAAC;IAC/B,IAAI,IAA4C,CAAC;IACjD,IAAI,CAAC;QACH,IAAI,GAAG,MAAM,UAAU,CAAC,OAAO,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;IACpD,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,OAAO,GAAI,CAAiD,EAAE,OAAO,CAAC;QAC5E,IAAI,CAAC,CAAC,CAAC,YAAY,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,0BAA0B,IAAI,CAAC,OAAO;YAAE,MAAM,CAAC,CAAC;QACxF,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;QAC/C,MAAM,OAAO,GAAG,kBAAkB,CAAC,GAAG,CAAC,IAAI,EAAE,WAAW,EAAE,OAAO,CAAC,eAAe,KAAK,IAAI,CAAC,CAAC;QAC5F,IAAI,OAAO;YAAE,MAAM,OAAO,CAAC;QAC3B,GAAG,CAAC,4CAA4C,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC1E,IAAI,GAAG,MAAM,UAAU,CAAC,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;IAC1D,CAAC;IACD,IAAI,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACnC,MAAM,YAAY,CAAC,YAAY,GAAG,CAAC,IAAI,gDAAgD,GAAG,CAAC,IAAI,gGAAgG,CAAC,CAAC;IACnM,CAAC;IACD,MAAM,OAAO,GAAG,CAAC,GAAG,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,CAAC;IACvE,GAAG,CAAC,QAAQ,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,mBAAmB,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;IAEjE,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;IAC9B,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;QAC/B,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACnB,MAAM,WAAW,GAAa,EAAE,CAAC;QACjC,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;YAC/B,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC;YAC/B,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;QAChD,CAAC;QACD,GAAG,CAAC,SAAS,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAEvC,sGAAsG;QACtG,MAAM,OAAO,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC/C,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,OAAO,EAAE,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,CAAC;QAC9D,IAAI,IAAwC,CAAC;QAC7C,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,CAAC;YAC7E,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;gBACrC,MAAM,IAAI,UAAU,CAClB,mEAAmE,GAAG,CAAC,IAAI,wDAAwD;oBACjI,+EAA+E,MAAM,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,CAAC,IAAI,eAAe,CAAC,EAAE,CAC/I,CAAC;YACJ,CAAC;YACD,GAAG,CAAC,mBAAmB,GAAG,CAAC,IAAI,aAAa,CAAC,CAAC;YAC9C,IAAI,GAAG,eAAe,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,aAAa,EAAE,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;QACrI,CAAC;gBAAS,CAAC;YACT,KAAK,CAAC,OAAO,EAAE,CAAC;QAClB,CAAC;QACD,IAAI,IAAI,CAAC,EAAE,KAAK,SAAS;YAAE,MAAM,IAAI,UAAU,CAAC,8DAA8D,CAAC,CAAC;QAEhH,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;QACrD,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC1B,MAAM,IAAI,GAAG,cAAc,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAC9C,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACtB,MAAM,SAAS,GAAc,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC;QACpJ,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC;QAChD,GAAG,CAAC,SAAS,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,MAAM,CAAC,UAAU,CAAC,aAAa,UAAU,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;QAE5G,MAAM,IAAI,GAAG;YACX,WAAW,EAAE,GAAG,CAAC,IAAI;YACrB,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,OAAO;YACP,WAAW;YACX,WAAW;YACX,aAAa,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC;YAC1C,QAAQ,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,UAAU,EAAE;YACvE,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC;QACF,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,MAAM,cAAc,CAAC,IAAI,EAAE,SAAS,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;QACrF,IAAI,IAAI,CAAC,MAAM;YAAE,GAAG,CAAC,SAAS,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QAC7C,GAAG,CAAC,YAAY,IAAI,CAAC,EAAE,eAAe,IAAI,CAAC,QAAQ,CAAC,QAAQ,wDAAwD,CAAC,CAAC;QACtH,OAAO,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC;IAChF,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,CAAC,IAAI,EAAE,CAAC;QACf,MAAM,CAAC,CAAC;IACV,CAAC;AACH,CAAC"}
|
package/dist/init/baseline.js
CHANGED
|
@@ -20,9 +20,9 @@
|
|
|
20
20
|
* note is what says it was adopted.
|
|
21
21
|
*/
|
|
22
22
|
import { randomUUID } from "node:crypto";
|
|
23
|
-
import { YodelError } from "../project.js";
|
|
23
|
+
import { YodelError, yodelRefusal } from "../project.js";
|
|
24
24
|
import { appliedBy, MIGRATION_ROW, withLock } from "../history/index.js";
|
|
25
|
-
import {
|
|
25
|
+
import {} from "../versioned/index.js";
|
|
26
26
|
/** The baseline migration's name: its id is `<YYYYMMDDTHHMM>-baseline`. */
|
|
27
27
|
export const BASELINE_NAME = "baseline";
|
|
28
28
|
/** The start of a baseline row's `note`. */
|
|
@@ -57,8 +57,8 @@ export function historyRefusal(state, location) {
|
|
|
57
57
|
if (state.migrations.length === 0)
|
|
58
58
|
return undefined;
|
|
59
59
|
const ids = state.migrations.map((m) => m.id);
|
|
60
|
-
return
|
|
61
|
-
`this environment is already under versioned migrations, so there is nothing to adopt. Nothing was written
|
|
60
|
+
return yodelRefusal(`refused: the history (${location}) already records ${ids.length === 1 ? "a migration" : `${String(ids.length)} migrations`} (${ids.slice(0, 3).join(", ")}${ids.length > 3 ? ", ..." : ""}); ` +
|
|
61
|
+
`this environment is already under versioned migrations, so there is nothing to adopt. Nothing was written.`);
|
|
62
62
|
}
|
|
63
63
|
/** Reads the history without the lock, for a refusal before anything is written. */
|
|
64
64
|
export async function checkHistoryEmpty(venv) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"baseline.js","sourceRoot":"","sources":["../../src/init/baseline.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;
|
|
1
|
+
{"version":3,"file":"baseline.js","sourceRoot":"","sources":["../../src/init/baseline.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAEzD,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,QAAQ,EAAmB,MAAM,qBAAqB,CAAC;AAC1F,OAAO,EAAqB,MAAM,uBAAuB,CAAC;AAE1D,2EAA2E;AAC3E,MAAM,CAAC,MAAM,aAAa,GAAG,UAAU,CAAC;AAExC,4CAA4C;AAC5C,MAAM,CAAC,MAAM,aAAa,GAAG,UAAU,CAAC;AAExC,uCAAuC;AACvC,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,WAAmB,EAAU,EAAE,CAC1D,GAAG,aAAa,yDAAyD,WAAW,+BAA+B,CAAC;AAEtH,gDAAgD;AAChD,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,GAAsC,EAAW,EAAE,CAC/E,GAAG,CAAC,IAAI,KAAK,WAAW,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,aAAa,IAAI,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,aAAa,GAAG,CAAC,CAAC,CAAC;AAEvG,0DAA0D;AAC1D,MAAM,UAAU,WAAW,CAAC,CAAgD,EAAE,KAA0G;IACtL,IAAI,CAAC,CAAC,MAAM,KAAK,IAAI;QAAE,MAAM,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,MAAM,4CAA4C,CAAC,CAAC;IACrH,OAAO;QACL,GAAG,EAAE,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,CAAC,KAAK;QACnB,IAAI,EAAE,WAAW;QACjB,YAAY,EAAE,CAAC,CAAC,EAAE;QAClB,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE,CAAC,CAAC,QAAQ;QACpB,eAAe,EAAE,aAAa;QAC9B,aAAa,EAAE,EAAE;QACjB,MAAM,EAAE,WAAW;QACnB,KAAK,EAAE,EAAE;QACT,UAAU,EAAE,KAAK,CAAC,SAAS;QAC3B,WAAW,EAAE,EAAE;QACf,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC,iDAAiD,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC;KAC9K,CAAC;AACJ,CAAC;AAED,+GAA+G;AAC/G,MAAM,UAAU,cAAc,CAAC,KAAgD,EAAE,QAAgB;IAC/F,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IACpD,MAAM,GAAG,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC9C,OAAO,YAAY,CACjB,yBAAyB,QAAQ,qBAAqB,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,aAAa,KAAK,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK;QAC7L,4GAA4G,CAC/G,CAAC;AACJ,CAAC;AAED,oFAAoF;AACpF,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,IAAkB;IACxD,MAAM,OAAO,GAAG,cAAc,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,UAAU,CAAC,CAAC;IAC9F,IAAI,OAAO;QAAE,MAAM,OAAO,CAAC;AAC7B,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,IAAkB,EAAE,CAAY,EAAE,aAAgC,OAAO,CAAC,GAAG,EAAE,UAA6B,EAAE;IACjJ,MAAM,EAAE,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;IACjC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IAC/C,OAAO,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,KAAK,IAAI,EAAE;QAC/C,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QAC1B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACvC,MAAM,OAAO,GAAG,cAAc,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,UAAU,CAAC,CAAC;QAC3E,IAAI,OAAO;YAAE,MAAM,OAAO,CAAC;QAC3B,MAAM,GAAG,GAAG,WAAW,CAAC,CAAC,EAAE,EAAE,GAAG,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;QAClI,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAC/B,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;IAChH,CAAC,CAAC,CAAC;AACL,CAAC"}
|
package/dist/init/second.d.ts
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
*
|
|
6
6
|
* The baseline is the project's first migration. The environment's live
|
|
7
7
|
* schema is planned against the schema the baseline records, offline from
|
|
8
|
-
* `migration.json`: the plan must be empty. A difference refuses (exit
|
|
8
|
+
* `migration.json`: the plan must be empty. A difference refuses (exit 1),
|
|
9
9
|
* naming each object and what differs, and nothing is recorded.
|
|
10
10
|
*
|
|
11
11
|
* The record goes through the environment's migrations Op, as `yodel
|
|
@@ -25,6 +25,10 @@ import { type HistoryRow } from "../history/index.js";
|
|
|
25
25
|
import type { VersionedEnv } from "../versioned/engine.js";
|
|
26
26
|
/** chant's plan-digest kind for recording a baseline: never an apply's or a revert's. */
|
|
27
27
|
export declare const BASELINE_DIGEST_KIND = "yodel-baseline";
|
|
28
|
+
/** The kind of gated request (chant#4551) a baseline record is asked for under. */
|
|
29
|
+
export declare const BASELINE_REQUEST = "sql-baseline";
|
|
30
|
+
/** The gate a baseline record waits at as a gated request: the migrations gate's name with -baseline. */
|
|
31
|
+
export declare const baselineGate: (gate: string) => string;
|
|
28
32
|
/** The note a baseline row recorded by `yodel init --baseline` carries. */
|
|
29
33
|
export declare const recordedBaselineNote: (environment: string) => string;
|
|
30
34
|
/** The project's baseline: its first migration. Refuses a project with none. */
|
package/dist/init/second.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
*
|
|
6
6
|
* The baseline is the project's first migration. The environment's live
|
|
7
7
|
* schema is planned against the schema the baseline records, offline from
|
|
8
|
-
* `migration.json`: the plan must be empty. A difference refuses (exit
|
|
8
|
+
* `migration.json`: the plan must be empty. A difference refuses (exit 1),
|
|
9
9
|
* naming each object and what differs, and nothing is recorded.
|
|
10
10
|
*
|
|
11
11
|
* The record goes through the environment's migrations Op, as `yodel
|
|
@@ -22,8 +22,7 @@ import { mkdtempSync, rmSync, writeFileSync } from "node:fs";
|
|
|
22
22
|
import { tmpdir } from "node:os";
|
|
23
23
|
import { join } from "node:path";
|
|
24
24
|
import { randomUUID } from "node:crypto";
|
|
25
|
-
import { YodelError } from "../project.js";
|
|
26
|
-
import { EXIT_REFUSED } from "../exit.js";
|
|
25
|
+
import { YodelError, yodelRefusal } from "../project.js";
|
|
27
26
|
import { planEnvironment, renderPlan, unreadableOf } from "../chant/plan.js";
|
|
28
27
|
import { declarativeRefusal } from "../config/settings.js";
|
|
29
28
|
import { appliedBy, withLock } from "../history/index.js";
|
|
@@ -32,13 +31,17 @@ import { BASELINE_ENV } from "../versioned/op.js";
|
|
|
32
31
|
import { baselineRow, historyRefusal } from "./baseline.js";
|
|
33
32
|
/** chant's plan-digest kind for recording a baseline: never an apply's or a revert's. */
|
|
34
33
|
export const BASELINE_DIGEST_KIND = "yodel-baseline";
|
|
34
|
+
/** The kind of gated request (chant#4551) a baseline record is asked for under. */
|
|
35
|
+
export const BASELINE_REQUEST = "sql-baseline";
|
|
36
|
+
/** The gate a baseline record waits at as a gated request: the migrations gate's name with -baseline. */
|
|
37
|
+
export const baselineGate = (gate) => `${gate}-baseline`;
|
|
35
38
|
/** The note a baseline row recorded by `yodel init --baseline` carries. */
|
|
36
39
|
export const recordedBaselineNote = (environment) => `baseline: recorded by yodel init --baseline ${environment}, whose live schema matched the schema it records; its statements were not run`;
|
|
37
40
|
/** The project's baseline: its first migration. Refuses a project with none. */
|
|
38
41
|
export function projectBaseline(ordered) {
|
|
39
42
|
const first = ordered[0];
|
|
40
43
|
if (!first) {
|
|
41
|
-
throw
|
|
44
|
+
throw yodelRefusal("refused: the project has no migrations, so there is no baseline to record; adopt an environment with yodel init --from <env> first. Nothing was recorded.");
|
|
42
45
|
}
|
|
43
46
|
return first;
|
|
44
47
|
}
|
|
@@ -83,9 +86,9 @@ export async function compareBaseline(project, env, baseline, processEnv = proce
|
|
|
83
86
|
}
|
|
84
87
|
/** The refusal for a difference: names each one, and records nothing. */
|
|
85
88
|
export function differenceRefusal(env, baseline, cmp) {
|
|
86
|
-
return
|
|
89
|
+
return yodelRefusal(`refused: ${env}'s live schema is not the schema ${baseline} records, so the baseline cannot be recorded applied there. ` +
|
|
87
90
|
`${String(cmp.differences.length)} difference${cmp.differences.length === 1 ? "" : "s"}:\n${cmp.differences.map((d) => ` ${d}`).join("\n")}\n` +
|
|
88
|
-
`Make ${env} hold the baseline's schema (or empty it, and let yodel apply run the baseline), then run yodel init --baseline ${env} again. Nothing was recorded
|
|
91
|
+
`Make ${env} hold the baseline's schema (or empty it, and let yodel apply run the baseline), then run yodel init --baseline ${env} again. Nothing was recorded.`);
|
|
89
92
|
}
|
|
90
93
|
/** Refuses when `env`'s history records anything: the baseline is the first thing a history records. */
|
|
91
94
|
async function historyEmpty(venv) {
|
package/dist/init/second.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"second.js","sourceRoot":"","sources":["../../src/init/second.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAC7D,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,UAAU,EAAkC,
|
|
1
|
+
{"version":3,"file":"second.js","sourceRoot":"","sources":["../../src/init/second.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAC7D,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,UAAU,EAAkC,YAAY,EAAE,MAAM,eAAe,CAAC;AAGzF,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAC7E,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAE3D,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAmB,MAAM,qBAAqB,CAAC;AAC3E,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAE5D,yFAAyF;AACzF,MAAM,CAAC,MAAM,oBAAoB,GAAG,gBAAgB,CAAC;AAErD,mFAAmF;AACnF,MAAM,CAAC,MAAM,gBAAgB,GAAG,cAAc,CAAC;AAE/C,yGAAyG;AACzG,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,GAAG,IAAI,WAAW,CAAC;AAEzE,2EAA2E;AAC3E,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,WAAmB,EAAU,EAAE,CAClE,+CAA+C,WAAW,gFAAgF,CAAC;AAE7I,gFAAgF;AAChF,MAAM,UAAU,eAAe,CAAC,OAA6B;IAC3D,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACzB,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,YAAY,CAChB,2JAA2J,CAC5J,CAAC;IACJ,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,4HAA4H;AAC5H,MAAM,UAAU,qBAAqB,CAAC,OAAgB,EAAE,GAAgB;IACtE,OAAO,kBAAkB,CAAC,OAAO,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;AAC/C,CAAC;AAED,yGAAyG;AACzG,SAAS,aAAa,CAAC,MAAmB;IACxC,MAAM,GAAG,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,iBAAiB,CAAC,CAAC,CAAC;IAC3D,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;IACtC,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5C,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACrG,CAAC;AAED,qFAAqF;AACrF,MAAM,UAAU,cAAc,CAAC,CAAmB;IAChD,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,IAAI,QAAQ,wBAAwB,CAAC,CAAC,KAAK,IAAI,QAAQ,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC;IAC7J,OAAO,GAAG,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,KAAK,GAAG,MAAM,KAAK,CAAC,CAAC,IAAI,GAAG,CAAC;AACvD,CAAC;AASD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,OAAgB,EAAE,GAAgB,EAAE,QAAmB,EAAE,aAAgC,OAAO,CAAC,GAAG;IACxI,MAAM,KAAK,GAAG,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACtD,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,CAAC;QAC7E,MAAM,OAAO,GAAuB,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5E,MAAM,WAAW,GAAG;YAClB,GAAG,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC;YAC9B,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,IAAI,4BAA4B,CAAC,CAAC,MAAM,GAAG,CAAC;SAChG,CAAC;QACF,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,EAAE,WAAW,EAAE,CAAC;QACrD,OAAO,EAAE,WAAW,EAAE,CAAC,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC,IAAI,EAAE,WAAW,QAAQ,CAAC,EAAE,YAAY,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;IAChI,CAAC;YAAS,CAAC;QACT,KAAK,CAAC,OAAO,EAAE,CAAC;IAClB,CAAC;AACH,CAAC;AAED,yEAAyE;AACzE,MAAM,UAAU,iBAAiB,CAAC,GAAW,EAAE,QAAgB,EAAE,GAAuB;IACtF,OAAO,YAAY,CACjB,YAAY,GAAG,oCAAoC,QAAQ,8DAA8D;QACvH,GAAG,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,MAAM,CAAC,cAAc,GAAG,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI;QAC/I,QAAQ,GAAG,mHAAmH,GAAG,+BAA+B,CACnK,CAAC;AACJ,CAAC;AAED,wGAAwG;AACxG,KAAK,UAAU,YAAY,CAAC,IAAkB;IAC5C,MAAM,OAAO,GAAG,cAAc,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,UAAU,CAAC,CAAC;IAC9F,IAAI,OAAO;QAAE,MAAM,OAAO,CAAC;AAC7B,CAAC;AAED,oHAAoH;AACpH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,IAAkB,EAAE,QAA4C;IACnG,MAAM,EAAE,iBAAiB,EAAE,GAAG,MAAM,MAAM,CAAC,wCAAwC,CAAC,CAAC;IACrF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC;IACjD,OAAO,iBAAiB,CAAC,oBAAoB,EAAE;QAC7C,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,eAAe,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ;QACvC,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC7C,QAAQ,EAAE,EAAE,EAAE,EAAE,QAAQ,CAAC,EAAE,EAAE,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE;QAC1D,IAAI;KACL,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,OAAgB,EAAE,GAAgB,EAAE,IAAkB,EAAE,QAAmB,EAAE,aAAgC,OAAO,CAAC,GAAG;IACzJ,MAAM,OAAO,GAAG,qBAAqB,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IACpD,IAAI,OAAO;QAAE,MAAM,OAAO,CAAC;IAC3B,MAAM,YAAY,CAAC,IAAI,CAAC,CAAC;IACzB,MAAM,GAAG,GAAG,MAAM,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;IACtE,IAAI,GAAG,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC;QAAE,MAAM,iBAAiB,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IACpF,OAAO,cAAc,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AACxC,CAAC;AAWD,8HAA8H;AAC9H,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,OAAgB,EAAE,GAAgB,EAAE,IAAkB,EAAE,QAAmB,EAAE,OAA8B;IAC/I,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,GAAG,CAAC;IACrD,MAAM,EAAE,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;IACjC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IAC/C,IAAI,IAAI,CAAC,MAAM;QAAE,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACrD,OAAO,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,KAAK,IAAI,EAAE;QAC/C,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;QAC5E,IAAI,CAAC,CAAC,MAAM,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC;YACxD,MAAM,IAAI,UAAU,CAAC,6DAA6D,OAAO,CAAC,cAAc,SAAS,MAAM,sDAAsD,GAAG,CAAC,IAAI,SAAS,CAAC,CAAC;QAClM,CAAC;QACD,MAAM,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC9B,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QAC1B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACvC,MAAM,OAAO,GAAG,cAAc,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,UAAU,CAAC,CAAC;QAC3E,IAAI,OAAO;YAAE,MAAM,OAAO,CAAC;QAC3B,MAAM,GAAG,GAAG,EAAE,GAAG,WAAW,CAAC,QAAQ,EAAE,EAAE,GAAG,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,WAAW,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1L,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAC/B,OAAO,CAAC,GAAG,CAAC,YAAY,QAAQ,CAAC,EAAE,eAAe,IAAI,CAAC,QAAQ,CAAC,QAAQ,wDAAwD,CAAC,CAAC;QAClI,OAAO,GAAG,CAAC;IACb,CAAC,CAAC,CAAC;AACL,CAAC;AAED,yFAAyF;AACzF,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,GAAsB,EAAsB,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,SAAS,CAAC"}
|
|
@@ -9,17 +9,27 @@
|
|
|
9
9
|
*
|
|
10
10
|
* A finding in a migration points at its migration.sql, on the statement's
|
|
11
11
|
* line when the rule knows it (line 1 otherwise); a finding about the whole
|
|
12
|
-
* directory points at no file
|
|
12
|
+
* directory points at no file, and so does a declarative project's (#249),
|
|
13
|
+
* since the build of src/ does not say which file declared an object.
|
|
14
|
+
* Paths are relative to `root`, the
|
|
13
15
|
* repository's checkout (GITHUB_WORKSPACE, CI_PROJECT_DIR), with `/`.
|
|
14
16
|
*/
|
|
15
17
|
import type { Finding, LintReport } from "./check.js";
|
|
16
18
|
/** The formats `yodel lint --format` prints. */
|
|
17
19
|
export declare const LINT_FORMATS: readonly ["text", "json", "github", "gitlab"];
|
|
20
|
+
/**
|
|
21
|
+
* `--format forge` (#294): the format of the forge the job runs on, read
|
|
22
|
+
* from its variables, so one check hook serves every forge. `gitlab` under
|
|
23
|
+
* GitLab CI, `github` under GitHub or Forgejo Actions (both set
|
|
24
|
+
* `GITHUB_ACTIONS`), else `text`.
|
|
25
|
+
*/
|
|
26
|
+
export declare const FORGE_FORMAT = "forge";
|
|
27
|
+
export declare function forgeFormat(env?: NodeJS.ProcessEnv): "text" | "github" | "gitlab";
|
|
18
28
|
export type LintFormat = (typeof LINT_FORMATS)[number];
|
|
19
29
|
/** Where `yodel lint --format gitlab` writes the code quality report, unless --output says otherwise. */
|
|
20
30
|
export declare const CODE_QUALITY_FILE = "gl-code-quality-report.json";
|
|
21
|
-
/** The file a finding is about, relative to `root`; undefined for one about the directory as a whole. */
|
|
22
|
-
export declare function findingPath(report: Pick<LintReport, "dir">, f: Pick<Finding, "migration" | "file">, root: string): string | undefined;
|
|
31
|
+
/** The file a finding is about, relative to `root`; undefined for one about the directory as a whole, or in a declarative report, whose `migration` names the declared schema or a plan. */
|
|
32
|
+
export declare function findingPath(report: Pick<LintReport, "dir" | "declarative">, f: Pick<Finding, "migration" | "file">, root: string): string | undefined;
|
|
23
33
|
/**
|
|
24
34
|
* One workflow command per finding: `error` and `warning` at the finding's
|
|
25
35
|
* level, `notice` for a silenced one (it fails nothing, but a reviewer sees
|
|
@@ -41,8 +51,8 @@ export interface CodeQualityIssue {
|
|
|
41
51
|
}
|
|
42
52
|
/**
|
|
43
53
|
* GitLab's code quality report: an error is `major`, a warning `minor` and
|
|
44
|
-
* a silenced finding `info`. A finding about the directory as a whole
|
|
45
|
-
* placed on the
|
|
54
|
+
* a silenced finding `info`. A finding about the directory as a whole, or
|
|
55
|
+
* a declarative project's, is placed on the report's directory. The fingerprint is the rule, the
|
|
46
56
|
* place and the message, so the same finding on two pipelines is one issue
|
|
47
57
|
* to GitLab and a fixed one shows as resolved.
|
|
48
58
|
*/
|