{{ message }}
Repository navigation
Expand file tree
/
Copy pathconfig-api-compare.ts
More file actions
434 lines (393 loc) · 15.1 KB
/
Copy pathconfig-api-compare.ts
File metadata and controls
434 lines (393 loc) · 15.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
/**
* Diffs `@supabase/config`'s compiled `.d.ts` surface between a PR's base and head commits.
*
* Usage:
* bun tools/config-api-compare.ts [--base <ref>]
*
* Base ref resolution, in order: `--base`, then `GITHUB_BASE_REF` under `origin/`, then
* `origin/develop`. Resolves `git merge-base HEAD <base>`, fetching a missing base ref at depth 1
* first; if HEAD's own checkout is also shallow, unshallows (or deepens) and retries once before
* skipping the compare.
*
* Emits declarations twice with the same compiler settings — head from `packages/config/src`
* directly, base from a `git archive` of the merge-base extracted under `packages/config` (so
* dependency resolution reuses the current install) — then diffs the two `.d.ts` trees.
*
* Advisory only; the hard release-time gate is `tools/config-release-gate.ts`.
*
* Exit codes: 0 identical (or compare skipped), 1 surface differs, 2 tool failure.
*/
import { cp, mkdir, mkdtemp, rm } from "node:fs/promises";
import { tmpdir } from "node:os";
import path from "node:path";
import process from "node:process";
import { parseArgs } from "node:util";
import {
type CompareResult,
countByStatus,
countDeclarationFiles,
diffDeclarationTrees,
renderDiffDetailsBlocks,
writeStepSummary,
} from "./lib/dts-diff.ts";
const repoRoot = path.resolve(import.meta.dir, "..");
const packageRoot = path.join(repoRoot, "packages", "config");
const tscBinPath = path.join(packageRoot, "node_modules", ".bin", "tsc");
interface GitResult {
readonly exitCode: number;
readonly stdout: string;
readonly stderr: string;
}
async function runGit(args: readonly string[], cwd: string): Promise<GitResult> {
const proc = Bun.spawn(["git", ...args], { cwd, stdout: "pipe", stderr: "pipe" });
const [exitCode, stdout, stderr] = await Promise.all([
proc.exited,
new Response(proc.stdout).text(),
new Response(proc.stderr).text(),
]);
return { exitCode, stdout, stderr };
}
function requireBinaries(names: readonly string[]): void {
const missing = names.filter((name) => Bun.which(name) === null);
if (missing.length > 0) {
throw new Error(`this tool requires ${missing.join(", ")} on PATH.`);
}
}
/** `--base` wins; else `GITHUB_BASE_REF` (a PR's base branch name, no remote prefix) under `origin/`; else `origin/develop`. */
function resolveBaseRef(cliBase: string | undefined): string {
if (cliBase) {
return cliBase;
}
const githubBaseRef = process.env.GITHUB_BASE_REF;
if (githubBaseRef) {
return `origin/${githubBaseRef}`;
}
return "origin/develop";
}
type MergeBaseResolution =
| { readonly kind: "resolved"; readonly sha: string }
| { readonly kind: "skip"; readonly reason: string };
/**
* Resolves `git merge-base HEAD <baseRef>`. Fetches a missing `origin/<branch>` ref at depth 1,
* unshallowing the checkout if that still isn't enough to find a common ancestor.
*/
async function resolveMergeBase(baseRef: string): Promise<MergeBaseResolution> {
const attempt = await runGit(["merge-base", "HEAD", baseRef], repoRoot);
if (attempt.exitCode === 0) {
return { kind: "resolved", sha: attempt.stdout.trim() };
}
if (!baseRef.startsWith("origin/")) {
throw new Error(
`could not resolve base ref "${baseRef}" (git merge-base: ${attempt.stderr.trim()}). Pass a ` +
`ref that already exists locally, or one under "origin/" so it can be fetched.`,
);
}
const branchName = baseRef.slice("origin/".length);
console.warn(
`[config-api-compare] ${baseRef} did not resolve locally (${attempt.stderr.trim()}); fetching ` +
`origin/${branchName} at depth 1...`,
);
const fetch = await runGit(
["fetch", "--depth=1", "origin", `+${branchName}:refs/remotes/origin/${branchName}`],
repoRoot,
);
if (fetch.exitCode !== 0) {
throw new Error(`git fetch --depth=1 origin ${branchName} failed: ${fetch.stderr.trim()}`);
}
const retry = await runGit(["merge-base", "HEAD", baseRef], repoRoot);
if (retry.exitCode === 0) {
return { kind: "resolved", sha: retry.stdout.trim() };
}
const isShallow = await runGit(["rev-parse", "--is-shallow-repository"], repoRoot);
if (isShallow.stdout.trim() !== "true") {
throw new Error(
`could not resolve base ref "${baseRef}" even after fetching origin/${branchName}: ` +
retry.stderr.trim(),
);
}
console.warn(
`[config-api-compare] HEAD's own checkout is shallow, so a depth-1 ${baseRef} fetch can't ` +
"produce a common ancestor; unshallowing before retrying merge-base...",
);
const unshallow = await runGit(["fetch", "--unshallow", "origin", branchName], repoRoot);
if (unshallow.exitCode !== 0) {
console.warn(
`[config-api-compare] git fetch --unshallow failed (${unshallow.stderr.trim()}); falling ` +
"back to git fetch --deepen=100000...",
);
const deepen = await runGit(["fetch", "--deepen=100000", "origin"], repoRoot);
if (deepen.exitCode !== 0) {
return {
kind: "skip",
reason:
`could not unshallow (${unshallow.stderr.trim()}) or deepen ` +
`(${deepen.stderr.trim()}) the checkout to resolve a merge-base against ${baseRef}.`,
};
}
}
const fullFetch = await runGit(
["fetch", "origin", `+${branchName}:refs/remotes/origin/${branchName}`],
repoRoot,
);
if (fullFetch.exitCode !== 0) {
return {
kind: "skip",
reason: `could not fully fetch origin/${branchName} after unshallowing: ${fullFetch.stderr.trim()}.`,
};
}
const finalRetry = await runGit(["merge-base", "HEAD", baseRef], repoRoot);
if (finalRetry.exitCode === 0) {
return { kind: "resolved", sha: finalRetry.stdout.trim() };
}
return {
kind: "skip",
reason:
`could not resolve a merge-base between HEAD and ${baseRef} even after unshallowing ` +
`(git merge-base: ${finalRetry.stderr.trim()}).`,
};
}
async function shortSha(rev: string): Promise<string> {
const result = await runGit(["rev-parse", "--short", rev], repoRoot);
return result.exitCode === 0 ? result.stdout.trim() : rev;
}
async function pathExistsAtRev(rev: string, relativePath: string): Promise<boolean> {
const proc = Bun.spawn(["git", "cat-file", "-e", `${rev}:${relativePath}`], {
cwd: repoRoot,
stdout: "ignore",
stderr: "ignore",
});
return (await proc.exited) === 0;
}
/**
* `git archive <rev> <relativePaths>` piped straight into `tar -x`, stripping
* the shared `packages/config/` prefix (2 path components) so the extracted
* tree lands directly under `destDir`.
*/
async function archiveAndExtract(
rev: string,
relativePaths: readonly string[],
destDir: string,
): Promise<void> {
const archiveProc = Bun.spawn(["git", "archive", rev, ...relativePaths], {
cwd: repoRoot,
stdout: "pipe",
stderr: "pipe",
});
const tarProc = Bun.spawn(["tar", "-x", "-C", destDir, "--strip-components=2"], {
stdin: archiveProc.stdout,
stdout: "pipe",
stderr: "pipe",
});
const [archiveExitCode, tarExitCode, archiveStderr, tarStderr] = await Promise.all([
archiveProc.exited,
tarProc.exited,
new Response(archiveProc.stderr).text(),
new Response(tarProc.stderr).text(),
]);
if (archiveExitCode !== 0) {
throw new Error(
`git archive ${rev} ${relativePaths.join(" ")} failed: ${archiveStderr.trim()}`,
);
}
if (tarExitCode !== 0) {
throw new Error(`tar extraction into ${destDir} failed: ${tarStderr.trim()}`);
}
}
/**
* Materializes the base revision's `packages/config/src` under `baseExtractDir`, inside
* `packages/config`, so tsc's node_modules walk reaches the current install. `tsconfig.build.json`
* stays the head copy so `extends` resolves; the declarations config uses the base's own copy
* when present, else the head copy.
*/
async function extractBaseTree(mergeBase: string, baseExtractDir: string): Promise<void> {
await mkdir(baseExtractDir, { recursive: true });
const srcRelativePath = "packages/config/src";
const declarationsRelativePath = "packages/config/tsconfig.declarations.json";
if (!(await pathExistsAtRev(mergeBase, srcRelativePath))) {
throw new Error(`base revision ${mergeBase} has no ${srcRelativePath} — cannot compare`);
}
const hasDeclarationsConfig = await pathExistsAtRev(mergeBase, declarationsRelativePath);
const archivePaths = hasDeclarationsConfig
? [srcRelativePath, declarationsRelativePath]
: [srcRelativePath];
await archiveAndExtract(mergeBase, archivePaths, baseExtractDir);
await cp(
path.join(packageRoot, "tsconfig.build.json"),
path.join(baseExtractDir, "tsconfig.build.json"),
);
if (!hasDeclarationsConfig) {
console.warn(
`[config-api-compare] base revision ${await shortSha(mergeBase)} predates ` +
"tsconfig.declarations.json — using the HEAD copy for emit settings.",
);
await cp(
path.join(packageRoot, "tsconfig.declarations.json"),
path.join(baseExtractDir, "tsconfig.declarations.json"),
);
}
}
interface EmitResult {
readonly exitCode: number;
readonly stdout: string;
readonly stderr: string;
readonly fileCount: number;
}
/**
* Spawns this package's own `node_modules/.bin/tsc` directly: a bun-shimmed `PATH` can route
* `pnpm exec tsc` through Bun's `node:sqlite`-less Node-compat layer. `noEmitOnError` defaults to
* false, so declarations still emit against an old, non-type-checking base tree; only a fully
* empty output counts as failure.
*/
async function emitDeclarations(
projectPath: string,
outDir: string,
cwd: string,
): Promise<EmitResult> {
const proc = Bun.spawn([tscBinPath, "-p", projectPath, "--outDir", outDir], {
cwd,
stdout: "pipe",
stderr: "pipe",
});
const [exitCode, stdout, stderr] = await Promise.all([
proc.exited,
new Response(proc.stdout).text(),
new Response(proc.stderr).text(),
]);
const fileCount = await countDeclarationFiles(outDir);
return { exitCode, stdout, stderr, fileCount };
}
function renderTextReport(baseLabel: string, headLabel: string, result: CompareResult): string {
const lines: string[] = [`Config type-surface diff: ${baseLabel} -> ${headLabel}`, ""];
if (result.identical) {
lines.push("No type-surface differences.");
return lines.join("\n");
}
lines.push(
`Added: ${countByStatus(result.entries, "added")}, ` +
`Removed: ${countByStatus(result.entries, "removed")}, ` +
`Changed: ${countByStatus(result.entries, "changed")}`,
"",
);
for (const entry of result.entries) {
lines.push(`--- ${entry.status} ${entry.path} ---`, entry.diff.trimEnd(), "");
}
return lines.join("\n");
}
function renderMarkdownSummary(
baseLabel: string,
headLabel: string,
result: CompareResult,
): string {
const lines: string[] = [
"## Config type-surface diff (advisory)",
"",
`Comparing \`${baseLabel}\` against \`${headLabel}\` for \`@supabase/config\`'s compiled ` +
"declaration surface. Advisory only — the release-time hard gate is " +
"`tools/config-release-gate.ts`, run by the Release Config workflow (CLI-2233).",
"",
];
if (result.identical) {
lines.push("No type-surface differences.");
return lines.join("\n");
}
lines.push(
`**${countByStatus(result.entries, "added")} added, ` +
`${countByStatus(result.entries, "removed")} removed, ` +
`${countByStatus(result.entries, "changed")} changed**`,
"",
);
lines.push(...renderDiffDetailsBlocks(result.entries));
return lines.join("\n");
}
function renderShallowHistorySkippedSummary(
baseRef: string,
headLabel: string,
reason: string,
): string {
return [
"## Config type-surface diff (advisory)",
"",
`⚠️ Compare skipped (shallow history): could not resolve a merge-base between \`${headLabel}\` ` +
`and \`${baseRef}\`: ${reason}`,
].join("\n");
}
function renderSkippedSummary(baseLabel: string, headLabel: string, baseEmit: EmitResult): string {
return [
"## Config type-surface diff (advisory)",
"",
`⚠️ Compare skipped: the base revision (\`${baseLabel}\`) declaration emit produced zero ` +
`\`.d.ts\` files against \`${headLabel}\` (tsc exit ${baseEmit.exitCode}). Old source failing ` +
'to emit against the current install\'s dependencies is treated as "nothing to compare" ' +
"rather than a false positive.",
].join("\n");
}
async function main(): Promise<number> {
requireBinaries(["git", "tar", "diff"]);
const { values } = parseArgs({ options: { base: { type: "string" } } });
const baseRef = resolveBaseRef(values.base);
const mergeBaseResolution = await resolveMergeBase(baseRef);
if (mergeBaseResolution.kind === "skip") {
const headLabel = await shortSha("HEAD");
console.warn(`[config-api-compare] WARNING: ${mergeBaseResolution.reason}`);
await writeStepSummary(
renderShallowHistorySkippedSummary(baseRef, headLabel, mergeBaseResolution.reason),
);
return 0;
}
const mergeBase = mergeBaseResolution.sha;
const [baseLabel, headLabel] = await Promise.all([shortSha(mergeBase), shortSha("HEAD")]);
console.log(
`[config-api-compare] comparing merge-base ${baseLabel} (of ${baseRef}) against HEAD ${headLabel}...`,
);
const compareDir = path.join(packageRoot, ".api-compare");
const baseExtractDir = path.join(compareDir, "base");
const headOutDir = await mkdtemp(path.join(tmpdir(), "supabase-config-api-compare-head-"));
const baseOutDir = await mkdtemp(path.join(tmpdir(), "supabase-config-api-compare-base-"));
try {
await rm(compareDir, { recursive: true, force: true });
console.log("[config-api-compare] emitting head declarations...");
const headEmit = await emitDeclarations(
path.join(packageRoot, "tsconfig.declarations.json"),
headOutDir,
packageRoot,
);
if (headEmit.fileCount === 0) {
throw new Error(
`head declaration emit produced zero .d.ts files (tsc exit ${headEmit.exitCode}):\n` +
`${headEmit.stdout}\n${headEmit.stderr}`,
);
}
console.log("[config-api-compare] extracting and emitting base declarations...");
await extractBaseTree(mergeBase, baseExtractDir);
const baseEmit = await emitDeclarations(
path.join(baseExtractDir, "tsconfig.declarations.json"),
baseOutDir,
baseExtractDir,
);
if (baseEmit.fileCount === 0) {
console.warn(
`[config-api-compare] WARNING: base declaration emit produced zero .d.ts files (tsc exit ` +
`${baseEmit.exitCode}) — skipping the compare rather than reporting a false surface diff.\n` +
baseEmit.stderr,
);
await writeStepSummary(renderSkippedSummary(baseLabel, headLabel, baseEmit));
return 0;
}
const result = await diffDeclarationTrees(headOutDir, baseOutDir);
console.log(renderTextReport(baseLabel, headLabel, result));
await writeStepSummary(renderMarkdownSummary(baseLabel, headLabel, result));
return result.identical ? 0 : 1;
} finally {
await Promise.all([
rm(compareDir, { recursive: true, force: true }),
rm(headOutDir, { recursive: true, force: true }),
rm(baseOutDir, { recursive: true, force: true }),
]);
}
}
try {
process.exit(await main());
} catch (error) {
console.error(`[config-api-compare] ${error instanceof Error ? error.message : String(error)}`);
process.exit(2);
}
You can’t perform that action at this time.