@quickback-dev/cli 0.50.1 → 0.50.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/commands/canary.d.ts +23 -0
- package/dist/commands/canary.d.ts.map +1 -0
- package/dist/commands/canary.js +138 -0
- package/dist/commands/canary.js.map +1 -0
- package/dist/docs/content.js +2 -2
- package/dist/docs/content.js.map +1 -1
- package/dist/index.js +7 -1
- package/dist/index.js.map +1 -1
- package/dist/lib/neon-canary.d.ts +65 -0
- package/dist/lib/neon-canary.d.ts.map +1 -0
- package/dist/lib/neon-canary.js +113 -0
- package/dist/lib/neon-canary.js.map +1 -0
- package/dist/lib/neon-canary.test.d.ts +2 -0
- package/dist/lib/neon-canary.test.d.ts.map +1 -0
- package/dist/lib/neon-canary.test.js +150 -0
- package/dist/lib/neon-canary.test.js.map +1 -0
- package/dist/lib/neon-target.d.ts +89 -0
- package/dist/lib/neon-target.d.ts.map +1 -0
- package/dist/lib/neon-target.js +68 -0
- package/dist/lib/neon-target.js.map +1 -0
- package/dist/lib/neon-target.test.d.ts +2 -0
- package/dist/lib/neon-target.test.d.ts.map +1 -0
- package/dist/lib/neon-target.test.js +100 -0
- package/dist/lib/neon-target.test.js.map +1 -0
- package/dist/lib/neon.d.ts +152 -0
- package/dist/lib/neon.d.ts.map +1 -0
- package/dist/lib/neon.js +171 -0
- package/dist/lib/neon.js.map +1 -0
- package/dist/lib/neon.test.d.ts +2 -0
- package/dist/lib/neon.test.d.ts.map +1 -0
- package/dist/lib/neon.test.js +154 -0
- package/dist/lib/neon.test.js.map +1 -0
- package/dist/skill/docs/changelog.md +26 -0
- package/dist/skill/docs/compiler/targets/hono-api/database/neon.md +85 -19
- package/package.json +1 -1
- package/src/skill/docs/changelog.md +26 -0
- package/src/skill/docs/compiler/targets/hono-api/database/neon.md +85 -19
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* `quickback canary <env>` — Neon branch-canary migration verification.
|
|
3
|
+
*
|
|
4
|
+
* Opt-in, additive step for Neon (Postgres) projects. Given a target
|
|
5
|
+
* environment mapped to a Neon branch (via `providers.database.environments.
|
|
6
|
+
* <env>.branch` in quickback.config.ts), it:
|
|
7
|
+
*
|
|
8
|
+
* 1. Branches the env's Neon branch (copy-on-write).
|
|
9
|
+
* 2. Applies the pending drizzle migrations to the branch.
|
|
10
|
+
* 3. Diffs the branch schema vs its parent and prints the DDL that would land.
|
|
11
|
+
* 4. With `--apply`, applies the verified migrations to the real env DB.
|
|
12
|
+
* 5. Always discards the canary branch.
|
|
13
|
+
*
|
|
14
|
+
* When branching is NOT configured (no env mapping, no NEON_PROJECT_ID, or no
|
|
15
|
+
* NEON_API_KEY) the command is a no-op that points the user at the plain deploy
|
|
16
|
+
* path — existing behavior is untouched.
|
|
17
|
+
*
|
|
18
|
+
* Requires `NEON_API_KEY` (and `NEON_PROJECT_ID` unless `neon.projectId` is in
|
|
19
|
+
* config) in the environment. This is the CI-native gate: run it as a required
|
|
20
|
+
* check on the deploy workflow before `wrangler deploy`.
|
|
21
|
+
*/
|
|
22
|
+
export declare function canary(args: string[]): Promise<void>;
|
|
23
|
+
//# sourceMappingURL=canary.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"canary.d.ts","sourceRoot":"","sources":["../../src/commands/canary.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAuCH,wBAAsB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAoE1D"}
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* `quickback canary <env>` — Neon branch-canary migration verification.
|
|
3
|
+
*
|
|
4
|
+
* Opt-in, additive step for Neon (Postgres) projects. Given a target
|
|
5
|
+
* environment mapped to a Neon branch (via `providers.database.environments.
|
|
6
|
+
* <env>.branch` in quickback.config.ts), it:
|
|
7
|
+
*
|
|
8
|
+
* 1. Branches the env's Neon branch (copy-on-write).
|
|
9
|
+
* 2. Applies the pending drizzle migrations to the branch.
|
|
10
|
+
* 3. Diffs the branch schema vs its parent and prints the DDL that would land.
|
|
11
|
+
* 4. With `--apply`, applies the verified migrations to the real env DB.
|
|
12
|
+
* 5. Always discards the canary branch.
|
|
13
|
+
*
|
|
14
|
+
* When branching is NOT configured (no env mapping, no NEON_PROJECT_ID, or no
|
|
15
|
+
* NEON_API_KEY) the command is a no-op that points the user at the plain deploy
|
|
16
|
+
* path — existing behavior is untouched.
|
|
17
|
+
*
|
|
18
|
+
* Requires `NEON_API_KEY` (and `NEON_PROJECT_ID` unless `neon.projectId` is in
|
|
19
|
+
* config) in the environment. This is the CI-native gate: run it as a required
|
|
20
|
+
* check on the deploy workflow before `wrangler deploy`.
|
|
21
|
+
*/
|
|
22
|
+
import { join, dirname } from 'path';
|
|
23
|
+
import pc from 'picocolors';
|
|
24
|
+
import { findConfigPath, loadConfig } from '../lib/file-loader.js';
|
|
25
|
+
import { NeonClient } from '../lib/neon.js';
|
|
26
|
+
import { resolveNeonTarget } from '../lib/neon-target.js';
|
|
27
|
+
import { runNeonCanary } from '../lib/neon-canary.js';
|
|
28
|
+
import { runCommand } from '../lib/shell.js';
|
|
29
|
+
const consoleLogger = {
|
|
30
|
+
info: (m) => console.log(pc.gray(` ${m}`)),
|
|
31
|
+
warn: (m) => console.warn(pc.yellow(` ⚠ ${m}`)),
|
|
32
|
+
ddl: (diff) => {
|
|
33
|
+
console.log(pc.bold('\n Schema diff (canary vs parent):\n'));
|
|
34
|
+
console.log(diff.replace(/^/gm, ' '));
|
|
35
|
+
console.log();
|
|
36
|
+
},
|
|
37
|
+
};
|
|
38
|
+
/**
|
|
39
|
+
* Production migration runner: drizzle-kit migrate, with the connection string
|
|
40
|
+
* exported as DATABASE_URL/DATABASE_MIGRATION_URL for the run. Neon projects'
|
|
41
|
+
* generated drizzle.config.ts reads `DATABASE_MIGRATION_URL ?? DATABASE_URL`.
|
|
42
|
+
*/
|
|
43
|
+
function makeDrizzleMigrationRunner(outputDir) {
|
|
44
|
+
return async ({ connectionString }) => {
|
|
45
|
+
await runCommand('npx drizzle-kit migrate', {
|
|
46
|
+
cwd: outputDir,
|
|
47
|
+
env: {
|
|
48
|
+
...process.env,
|
|
49
|
+
DATABASE_URL: connectionString,
|
|
50
|
+
DATABASE_MIGRATION_URL: connectionString,
|
|
51
|
+
},
|
|
52
|
+
});
|
|
53
|
+
};
|
|
54
|
+
}
|
|
55
|
+
export async function canary(args) {
|
|
56
|
+
const positional = args.filter((a) => !a.startsWith('-'));
|
|
57
|
+
const env = positional[0];
|
|
58
|
+
const apply = args.includes('--apply');
|
|
59
|
+
if (!env || env === 'help' || args.includes('-h') || args.includes('--help')) {
|
|
60
|
+
printHelp();
|
|
61
|
+
return;
|
|
62
|
+
}
|
|
63
|
+
const configPath = await findConfigPath();
|
|
64
|
+
if (!configPath) {
|
|
65
|
+
console.error(pc.red('quickback.config.ts not found. Run from a quickback project directory.'));
|
|
66
|
+
process.exit(1);
|
|
67
|
+
}
|
|
68
|
+
const quickbackDir = dirname(configPath);
|
|
69
|
+
const projectRoot = configPath.includes('/quickback/') ? dirname(quickbackDir) : process.cwd();
|
|
70
|
+
const config = await loadConfig(configPath);
|
|
71
|
+
const outputDir = config.build?.outputDir
|
|
72
|
+
? join(quickbackDir, config.build.outputDir)
|
|
73
|
+
: projectRoot;
|
|
74
|
+
const target = resolveNeonTarget({ env, config });
|
|
75
|
+
if (!target) {
|
|
76
|
+
// Behavior-preserving: unconfigured → no canary, no error, plain path.
|
|
77
|
+
console.log(pc.yellow(`\nNeon branching not configured for env "${env}" — skipping canary.`));
|
|
78
|
+
console.log(pc.gray('\nTo enable it:'));
|
|
79
|
+
console.log(pc.gray(` • Map the env to a Neon branch: providers.database.environments.${env}.branch in quickback.config.ts`));
|
|
80
|
+
console.log(pc.gray(' • Set NEON_API_KEY (and NEON_PROJECT_ID, or neon.projectId in config)'));
|
|
81
|
+
console.log(pc.gray('\nDeploy normally with `npx wrangler deploy` — the canary is an additive gate.\n'));
|
|
82
|
+
return;
|
|
83
|
+
}
|
|
84
|
+
const client = new NeonClient({
|
|
85
|
+
apiKey: target.apiKey,
|
|
86
|
+
projectId: target.projectId,
|
|
87
|
+
baseUrl: target.baseUrl,
|
|
88
|
+
});
|
|
89
|
+
console.log(pc.bold(`\nNeon canary — env "${env}" (branch "${target.parentBranch}", project ${target.projectId})\n`));
|
|
90
|
+
try {
|
|
91
|
+
const result = await runNeonCanary({
|
|
92
|
+
client,
|
|
93
|
+
target,
|
|
94
|
+
apply,
|
|
95
|
+
runMigrations: makeDrizzleMigrationRunner(outputDir),
|
|
96
|
+
logger: consoleLogger,
|
|
97
|
+
});
|
|
98
|
+
if (!result.hasChanges) {
|
|
99
|
+
console.log(pc.green('\n✓ Canary verified: migrations apply cleanly, no schema drift.\n'));
|
|
100
|
+
}
|
|
101
|
+
else if (result.applied) {
|
|
102
|
+
console.log(pc.green('\n✓ Canary verified and migrations applied to the real database.\n'));
|
|
103
|
+
}
|
|
104
|
+
else {
|
|
105
|
+
console.log(pc.green('\n✓ Canary verified. ') + pc.gray('Re-run with --apply to apply to the real database.\n'));
|
|
106
|
+
}
|
|
107
|
+
if (!result.cleanedUp && result.branchId) {
|
|
108
|
+
process.exitCode = 2; // gate should notice a leaked branch
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
catch (err) {
|
|
112
|
+
console.error(pc.red(`\n✖ Canary failed: ${err instanceof Error ? err.message : String(err)}`));
|
|
113
|
+
console.error(pc.gray('The real database was NOT modified unless the failure occurred during --apply.'));
|
|
114
|
+
process.exit(1);
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
function printHelp() {
|
|
118
|
+
console.log(`
|
|
119
|
+
${pc.bold('quickback canary <env> [--apply]')}
|
|
120
|
+
|
|
121
|
+
Verify pending drizzle migrations against a Neon copy-on-write branch of the
|
|
122
|
+
target environment BEFORE touching the real database.
|
|
123
|
+
|
|
124
|
+
${pc.bold('ARGUMENTS')}
|
|
125
|
+
${pc.cyan('<env>')} Environment name mapped to a Neon branch via
|
|
126
|
+
providers.database.environments.<env>.branch in quickback.config.ts
|
|
127
|
+
|
|
128
|
+
${pc.bold('FLAGS')}
|
|
129
|
+
${pc.cyan('--apply')} Apply the verified migrations to the real env DB after the diff
|
|
130
|
+
${pc.cyan('-h, --help')} Show this help
|
|
131
|
+
|
|
132
|
+
${pc.bold('ENVIRONMENT')}
|
|
133
|
+
${pc.cyan('NEON_API_KEY')} Neon API key (required)
|
|
134
|
+
${pc.cyan('NEON_PROJECT_ID')} Neon project id (or set neon.projectId in config)
|
|
135
|
+
${pc.cyan('NEON_API_BASE')} Override the Neon REST base (optional)
|
|
136
|
+
`);
|
|
137
|
+
}
|
|
138
|
+
//# sourceMappingURL=canary.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"canary.js","sourceRoot":"","sources":["../../src/commands/canary.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AACrC,OAAO,EAAE,MAAM,YAAY,CAAC;AAE5B,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,aAAa,EAA2C,MAAM,uBAAuB,CAAC;AAC/F,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,MAAM,aAAa,GAAiB;IAClC,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC3C,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAChD,GAAG,EAAE,CAAC,IAAI,EAAE,EAAE;QACZ,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAC,CAAC;QAC9D,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;QACzC,OAAO,CAAC,GAAG,EAAE,CAAC;IAChB,CAAC;CACF,CAAC;AAEF;;;;GAIG;AACH,SAAS,0BAA0B,CAAC,SAAiB;IACnD,OAAO,KAAK,EAAE,EAAE,gBAAgB,EAAE,EAAE,EAAE;QACpC,MAAM,UAAU,CAAC,yBAAyB,EAAE;YAC1C,GAAG,EAAE,SAAS;YACd,GAAG,EAAE;gBACH,GAAG,OAAO,CAAC,GAAG;gBACd,YAAY,EAAE,gBAAgB;gBAC9B,sBAAsB,EAAE,gBAAgB;aACzC;SACF,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,MAAM,CAAC,IAAc;IACzC,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;IAC1D,MAAM,GAAG,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;IAC1B,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;IAEvC,IAAI,CAAC,GAAG,IAAI,GAAG,KAAK,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC7E,SAAS,EAAE,CAAC;QACZ,OAAO;IACT,CAAC;IAED,MAAM,UAAU,GAAG,MAAM,cAAc,EAAE,CAAC;IAC1C,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,wEAAwE,CAAC,CAAC,CAAC;QAChG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,MAAM,YAAY,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IACzC,MAAM,WAAW,GAAG,UAAU,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;IAE/F,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,UAAU,CAAC,CAAC;IAC5C,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,EAAE,SAAS;QACvC,CAAC,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,KAAK,CAAC,SAAmB,CAAC;QACtD,CAAC,CAAC,WAAW,CAAC;IAEhB,MAAM,MAAM,GAAG,iBAAiB,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC;IAClD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,uEAAuE;QACvE,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,4CAA4C,GAAG,sBAAsB,CAAC,CAAC,CAAC;QAC9F,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;QACxC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,qEAAqE,GAAG,gCAAgC,CAAC,CAAC,CAAC;QAC/H,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,yEAAyE,CAAC,CAAC,CAAC;QAChG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,kFAAkF,CAAC,CAAC,CAAC;QACzG,OAAO;IACT,CAAC;IAED,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC;QAC5B,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,OAAO,EAAE,MAAM,CAAC,OAAO;KACxB,CAAC,CAAC;IAEH,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,wBAAwB,GAAG,cAAc,MAAM,CAAC,YAAY,cAAc,MAAM,CAAC,SAAS,KAAK,CAAC,CAAC,CAAC;IAEtH,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC;YACjC,MAAM;YACN,MAAM;YACN,KAAK;YACL,aAAa,EAAE,0BAA0B,CAAC,SAAS,CAAC;YACpD,MAAM,EAAE,aAAa;SACtB,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;YACvB,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,mEAAmE,CAAC,CAAC,CAAC;QAC7F,CAAC;aAAM,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YAC1B,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,oEAAoE,CAAC,CAAC,CAAC;QAC9F,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,uBAAuB,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,sDAAsD,CAAC,CAAC,CAAC;QACnH,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;YACzC,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,qCAAqC;QAC7D,CAAC;IACH,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,sBAAsB,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;QAChG,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,gFAAgF,CAAC,CAAC,CAAC;QACzG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC;AAED,SAAS,SAAS;IAChB,OAAO,CAAC,GAAG,CAAC;EACZ,EAAE,CAAC,IAAI,CAAC,kCAAkC,CAAC;;;;;EAK3C,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC;IAClB,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC;;;EAGlB,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC;IACd,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC;IAClB,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC;;EAEvB,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC;IACpB,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC;IACvB,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC;IAC1B,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC;CAC3B,CAAC,CAAC;AACH,CAAC"}
|