@xemahq/repo-build-tooling 0.22.0 → 0.24.0
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 +1 -1
- package/package.json +6 -4
- package/src/install-git-hooks.mjs +323 -0
- package/src/install-git-hooks.test.mjs +85 -0
- package/src/prepush-sanity.mjs +122 -17
- package/src/prepush-sanity.test.mjs +42 -1
package/README.md
CHANGED
|
@@ -34,7 +34,7 @@ pnpm exec xema-scrub-swagger-paths dist
|
|
|
34
34
|
| `xema-arm64-supplement-needed` | Decides whether an arm64 supplement is still owed at `REGISTRY/IMAGE:CONTENT_TAG` (env: `REGISTRY`, `IMAGE`, `CONTENT_TAG`, `REGISTRY_USER`, `REGISTRY_TOKEN`). `needed=false` only when the coordinate serves an index whose linux/arm64 child is proven by its own image config; any other resolvable state is `needed=true`; a 401/403/5xx or an unresolvable child is an error. Writes `needed=true\|false` to `$GITHUB_OUTPUT`. Replaces the generated `arm64-supplement-needed.mjs` copy. |
|
|
35
35
|
| `xema-promote-image --service <name> --dev-ref <repo> --release-ref <repo> --tag <tag> --commit <sha> --main-ref <ref> --signer-repository <owner/repo> --develop-workflow <file> --release-workflow <file>... [--release-index-workflow <file>] --promotion-predicate-out <path> -- <tag command>` | Publishes the develop image's digest under the release tag instead of rebuilding: `reused` (the release digest carries an `image-promotion/v1` attestation signed by a `--release-workflow` identity on main, with exactly one verified statement about the digest and a `ghcr.io/<owner>/dev/<name>` source; no dev-ref probe), `copied` (the proven develop digest, digest-preserving; fails closed if the release digest differs) or `miss` (build it; a reuse whose release digest has no `image-promotion/v1` attestation, a legacy image, is a miss with `reason=reuse-no-promotion` on the stdout line; with `--release-index-workflow`, a release tag that names an image index signed by that workflow on main, with exactly one `linux/amd64` child whose own digest passes that same reuse check, is instead `reused` with `evidence=release-index`, `digest` = the amd64 child A, `index_digest` = the index D and no predicate, but only when A's selected promotion statement promotes `--commit` itself (a rerun; a later commit with the same content takes the existing miss and attests its own promotion). On `evidence=release-index` the caller skips sign/attest, tags `:<sha>` and `main-<sha>` to the amd64 subject `digest` (release-arm64 resolves `:<sha>` to it and verifies its promotion), and points only the content tag (and `latest`, if it moves it) at the index `index_digest`. Any failed step keeps the miss, and two amd64 children are an error; a signature or identity failure, or a source outside `dev/`, is an error; a copy whose dev digest carries no SLSA v1 provenance at all, an image reused on develop from before provenance, is a miss with `reason=copy-no-develop-provenance`, while provenance that is present but fails a leg is an error). A develop digest is proven only if its SLSA v1 provenance is signed by the develop workflow at `refs/heads/develop`, its revision is an ancestor of the main ref, and the tag command prints the same tag at that revision and at `--commit`; any failed leg is an error, never a miss. On every non-miss result it writes the `https://xema.dev/attestations/image-promotion/v1` predicate for the caller to attest: a copy states the facts just proved; a reuse states this run's `release` and `promotedCommit` and carries `source` and `developProvenance` from the earlier promotion. Writes `result`, `digest`, `source`, `revision`, `evidence`, `provenance_digest`, `promotion_predicate`, `promotion_predicate_type` to `$GITHUB_OUTPUT`. Needs `docker`, `cosign` (major v2, the same as the develop attest step and xema-deploy's verify; it runs `cosign version` first and refuses any other major or an unparsable version), `git` and full history. It does not sign |
|
|
36
36
|
| `xema-check-no-vendored-deps` | Fails on a `workspace:` range for a package the repository does not own |
|
|
37
|
-
| `xema-prepush-sanity` | Lefthook `pre-push`: turbo `lint` and `typecheck` on what the push changes plus dependents (root `lint` only without turbo;
|
|
37
|
+
| `xema-prepush-sanity` | Lefthook `pre-push`: turbo `lint` and `typecheck` on what the push changes plus dependents, and `test` and `openapi:current` (where defined) only on the packages the push changed; a fleet-wide change runs only `lint` and `typecheck` on the full graph; root `lint` only without turbo; a park-only push (`refs/xema-session/*`) skips |
|
|
38
38
|
| `xema-check-workspace-ranges` | Fails on a `workspace:` range the local package does not satisfy |
|
|
39
39
|
|
|
40
40
|
`xema-composed-image members --write|--check` accepts `--manifests <glob>` (repeatable, default `**/xema-biome.json`), `--canonical-dockerfile <path>` and `--cross-repo-manifest <path>`. `xema-composed-image dockerfile` requires `--copy`, `--cache-id` and `--build-source`; it pins the version of this tool itself, and there is no flag for it (`--tooling-version` is refused as an unknown option). `dockerfile --prebuilt` renders the Dockerfile and `Dockerfile.dockerignore` of an image assembled from `stage <dir> [--output <rel>]… [--also <pkg>]…` output (requires `--cache-id`, `--build-source`; `--copy` and `--stage-dir` optional); `load --each` loads every member in its own process. `stage` and `filters` accept `--also <workspace package name>` (repeatable): the package's closure is built and staged (built outputs only, no Prisma checks) alongside the members; an unknown name is refused. `pnpm-context <dir> (--subject <svc>… | --image-dir <composed>)` runs on the CI runner after `pnpm install --frozen-lockfile` and builds the offline `xema-pnpm` build context (`staged.json`, `corepack/pnpm.tgz`, and, with `--image-dir` only, a warmed `cache/` of registry metadata; `--subject` writes no `cache/` and `staged.json` says `cache: false`); it prints `XEMA_PNPM_CONTEXT=<dir>` and `XEMA_PNPM_STORE=<store root>` on stdout (everything else on stderr) and refuses a non-empty `<dir>`. `dockerfile --prebuilt` renders an OFFLINE image: every install RUN is `--network=none` and reads the runner's pnpm store and the `pnpm-context` output as the named build contexts `xema-pnpm-store` and `xema-pnpm`; without them the build fails with a message (no network fallback). `pnpm rebuild` runs only for `onlyBuiltDependencies` in the members' prod closure (less prisma, @prisma/client, @prisma/engines, @nestjs/core, esbuild, @swc/core) and the render needs `pnpm install` first; a node-gyp module with no optional prebuilt packages is refused. `pnpm-context --image-dir` reads the deps stage's COPY directories from the committed Dockerfile. Run `xema-composed-image` with no arguments for the full usage.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xemahq/repo-build-tooling",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.24.0",
|
|
4
4
|
"description": "Dev-time build tooling shared by every Xema repository. Ships as plain ESM, depending only on @xemahq/release-policy for registry access, so the published artifact is the reviewed source.",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"author": "Neuralchowder Inc. <developer@xema.dev> (https://xema.dev)",
|
|
@@ -25,6 +25,7 @@
|
|
|
25
25
|
"xema-check-no-vendored-deps": "src/check-no-vendored-deps.mjs",
|
|
26
26
|
"xema-check-workspace-ranges": "src/check-workspace-range-matches-local.mjs",
|
|
27
27
|
"xema-composed-image": "src/composed-image.mjs",
|
|
28
|
+
"xema-install-git-hooks": "src/install-git-hooks.mjs",
|
|
28
29
|
"xema-prepush-sanity": "src/prepush-sanity.mjs",
|
|
29
30
|
"xema-promote-image": "src/promote-image.mjs",
|
|
30
31
|
"xema-readiness": "src/readiness.mjs",
|
|
@@ -37,6 +38,7 @@
|
|
|
37
38
|
"./check-no-vendored-deps": "./src/check-no-vendored-deps.mjs",
|
|
38
39
|
"./check-workspace-range-matches-local": "./src/check-workspace-range-matches-local.mjs",
|
|
39
40
|
"./composed-image": "./src/composed-image.mjs",
|
|
41
|
+
"./install-git-hooks": "./src/install-git-hooks.mjs",
|
|
40
42
|
"./package.json": "./package.json",
|
|
41
43
|
"./prepush-sanity": "./src/prepush-sanity.mjs",
|
|
42
44
|
"./promote-image": "./src/promote-image.mjs",
|
|
@@ -46,12 +48,12 @@
|
|
|
46
48
|
"./service-image": "./src/service-image.mjs"
|
|
47
49
|
},
|
|
48
50
|
"dependencies": {
|
|
49
|
-
"@xemahq/release-policy": "^
|
|
51
|
+
"@xemahq/release-policy": "^16.0.0"
|
|
50
52
|
},
|
|
51
53
|
"scripts": {
|
|
52
|
-
"test": "node src/scrub-swagger-plugin-paths.mjs --self-test && node --test src/check-workspace-range-matches-local.test.mjs && node --test src/check-no-vendored-deps.test.mjs && node --test src/readiness.test.mjs && node --test src/composed-image.test.mjs && node --test src/composed-image-coordinate-cli.test.mjs && node --test src/declaration-refusal.test.mjs && node --test src/smoke-refusal.test.mjs && node --test src/load-image.test.mjs && node --test src/composed-image-coordinate.test.mjs && node --test src/composed-image-dockerfile.test.mjs && node --test src/service-bootstrap.test.mjs && node --test src/service-bootstrap-protocols.test.mjs && node --test src/composed-image-prebuilt-dockerfile.test.mjs && node --test src/composed-image-in-image-closure.test.mjs && node --test src/composed-image-stage.test.mjs && node --test src/composed-image-pnpm-context.test.mjs && node --test src/composed-image-sync-injected.test.mjs && node --test src/composed-image-prisma-check.test.mjs && node --test src/composed-image-prisma-engine.test.mjs && node --test src/composed-migrate.test.mjs && node --test src/promote-image.test.mjs && node --test src/arm64-supplement-needed.test.mjs && node --test src/prepush-sanity.test.mjs && node --test src/service-image.test.mjs"
|
|
54
|
+
"test": "node src/scrub-swagger-plugin-paths.mjs --self-test && node --test src/check-workspace-range-matches-local.test.mjs && node --test src/check-no-vendored-deps.test.mjs && node --test src/readiness.test.mjs && node --test src/composed-image.test.mjs && node --test src/composed-image-coordinate-cli.test.mjs && node --test src/declaration-refusal.test.mjs && node --test src/smoke-refusal.test.mjs && node --test src/load-image.test.mjs && node --test src/composed-image-coordinate.test.mjs && node --test src/composed-image-dockerfile.test.mjs && node --test src/service-bootstrap.test.mjs && node --test src/service-bootstrap-protocols.test.mjs && node --test src/composed-image-prebuilt-dockerfile.test.mjs && node --test src/composed-image-in-image-closure.test.mjs && node --test src/composed-image-stage.test.mjs && node --test src/composed-image-pnpm-context.test.mjs && node --test src/composed-image-sync-injected.test.mjs && node --test src/composed-image-prisma-check.test.mjs && node --test src/composed-image-prisma-engine.test.mjs && node --test src/composed-migrate.test.mjs && node --test src/promote-image.test.mjs && node --test src/arm64-supplement-needed.test.mjs && node --test src/prepush-sanity.test.mjs && node --test src/service-image.test.mjs && node --test src/install-git-hooks.test.mjs"
|
|
53
55
|
},
|
|
54
56
|
"xemaRelease": {
|
|
55
|
-
"sourceDigest": "sha256:
|
|
57
|
+
"sourceDigest": "sha256:5a6b2b46f5f22f0becd6c31ddb6992e245b73fd5d510228a90c51b30ac0ce8df"
|
|
56
58
|
}
|
|
57
59
|
}
|
|
@@ -0,0 +1,323 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
// ═══════════════════════════════════════════════════════════════════════════
|
|
3
|
+
// `xema-install-git-hooks` — run from `prepare`: install the lefthook git hooks, but only where hooks can exist.
|
|
4
|
+
//
|
|
5
|
+
// `prepare` runs on EVERY `pnpm install`, and one of those installs happens
|
|
6
|
+
// inside the service Docker image build, which has neither a `.git` directory
|
|
7
|
+
// (the build context excludes it) nor a `git` binary. A bare
|
|
8
|
+
// `"prepare": "lefthook install"` therefore fails the image build outright:
|
|
9
|
+
//
|
|
10
|
+
// . prepare: Error: exec: "git": executable file not found in $PATH
|
|
11
|
+
// ERROR: failed to solve: process "... pnpm install --offline
|
|
12
|
+
// --filter ${SERVICE}... --frozen-lockfile" exit code: 1
|
|
13
|
+
//
|
|
14
|
+
// That is not a hook problem to work around — it is a category error. Git
|
|
15
|
+
// hooks are a property of a developer's WORKING TREE; an image build has no
|
|
16
|
+
// working tree to hook, so there is nothing to install and nothing has gone
|
|
17
|
+
// wrong. This script says exactly that, out loud, and exits 0.
|
|
18
|
+
//
|
|
19
|
+
// What it does NOT do is swallow a real failure. In an actual git work tree
|
|
20
|
+
// the install must succeed: a non-zero `lefthook install` propagates, because
|
|
21
|
+
// a developer whose pre-push hook silently failed to install is a developer
|
|
22
|
+
// who finds out from CI instead. The two outcomes are distinguished by a
|
|
23
|
+
// deterministic fact — "is there a git work tree here" — never by an `|| true`.
|
|
24
|
+
//
|
|
25
|
+
// ── WHY THIS SCRIPT RESOLVES THE BINARY ITSELF ────────────────────────────
|
|
26
|
+
//
|
|
27
|
+
// It used to `spawnSync('lefthook', …)`, i.e. rely on PATH / the caller's
|
|
28
|
+
// `.bin/`. Inside the AGGREGATOR checkout that is unreachable for a carved
|
|
29
|
+
// repository, and the failure was silent in both halves:
|
|
30
|
+
//
|
|
31
|
+
// 1. `lefthook install` bakes an ABSOLUTE path to the binary that ran it
|
|
32
|
+
// into the generated hook (measured: re-running `install` from a
|
|
33
|
+
// different binary rewrites that line). A carved repo's hook was baked by
|
|
34
|
+
// a `pnpm install` run INSIDE that repo — the escape hatch — so it points
|
|
35
|
+
// at `repos/<repo>/node_modules/.pnpm/lefthook-*/bin/lefthook`.
|
|
36
|
+
// 2. That store is exactly what `.claude/rules/package-store-ownership.md`
|
|
37
|
+
// forbids and `tooling/dev/repair-package-stores.mjs` deletes. Afterwards
|
|
38
|
+
// the baked path dangles, and every remaining fallback in lefthook's
|
|
39
|
+
// generated hook misses too: lefthook is not on PATH, and a carved repo
|
|
40
|
+
// root is not an aggregator workspace member, so it has no `node_modules`
|
|
41
|
+
// and no `.bin/` at all.
|
|
42
|
+
// 3. lefthook's generated hook ends its search with
|
|
43
|
+
// `echo "Can't find lefthook in PATH"` — and NO non-zero exit. So the
|
|
44
|
+
// hook printed a warning and returned 0. Measured 2026-08-17: every one
|
|
45
|
+
// of the ten carved repositories' `pre-push` hooks was in this state, so
|
|
46
|
+
// every local push in this checkout was unguarded while LOOKING guarded.
|
|
47
|
+
//
|
|
48
|
+
// The fix is the pattern `package-store-ownership.md` already documents for
|
|
49
|
+
// carved root scripts: resolve by PATH-INDEPENDENT node resolution instead of
|
|
50
|
+
// a binary name. `createRequire(...).resolve('lefthook/bin/index.js')` walks up
|
|
51
|
+
// from this file — `repos/<repo>/node_modules` (absent) → the aggregator's
|
|
52
|
+
// `node_modules` (present) — and in a standalone clone it finds the repo's own
|
|
53
|
+
// copy on the first hop. Same script, both topologies, no per-machine config.
|
|
54
|
+
//
|
|
55
|
+
// ── AND WHY IT HARDENS THE GENERATED HOOK ─────────────────────────────────
|
|
56
|
+
//
|
|
57
|
+
// Resolving the binary fixes today's breakage. It does not fix the SHAPE of
|
|
58
|
+
// the defect: a baked absolute path can dangle again — another store repair,
|
|
59
|
+
// a `pnpm store prune`, a different machine, a moved checkout — and lefthook's
|
|
60
|
+
// template would once more warn-and-return-0. A gate whose only failure mode
|
|
61
|
+
// is a message nobody reads is the failure this repository names most often.
|
|
62
|
+
//
|
|
63
|
+
// So after installing, every generated hook's dead-end branch is rewritten to
|
|
64
|
+
// print the reason and `exit 1`. An unresolvable lefthook now REFUSES the
|
|
65
|
+
// push instead of waving it through; `git push --no-verify` remains the
|
|
66
|
+
// deliberate, visible bypass.
|
|
67
|
+
//
|
|
68
|
+
// The rewrite ASSERTS rather than assumes: the marker must be present exactly
|
|
69
|
+
// once in freshly generated content, and if lefthook's template ever changes
|
|
70
|
+
// so it is not, this fails loudly instead of leaving hooks quietly unhardened.
|
|
71
|
+
//
|
|
72
|
+
// ── AND WHY IT SWEEPS SUBMODULES ──────────────────────────────────────────
|
|
73
|
+
//
|
|
74
|
+
// A carved repository's root is not an aggregator workspace member, so its own
|
|
75
|
+
// `prepare` NEVER runs from an aggregator install — which is why the fix above
|
|
76
|
+
// would otherwise be inert in the only checkout that has the bug. The
|
|
77
|
+
// aggregator install already owns every `node_modules` beneath `repos/`
|
|
78
|
+
// (`package-store-ownership.md`); it therefore owns the hooks baked against
|
|
79
|
+
// them. Each submodule that carries a lefthook config gets the same install +
|
|
80
|
+
// hardening, from the same resolved binary.
|
|
81
|
+
//
|
|
82
|
+
// In a standalone carved clone this loop is naturally inert — those
|
|
83
|
+
// repositories have no submodules — so one byte-identical script serves both.
|
|
84
|
+
// ═══════════════════════════════════════════════════════════════════════════
|
|
85
|
+
|
|
86
|
+
import { spawnSync } from 'node:child_process';
|
|
87
|
+
import { createRequire } from 'node:module';
|
|
88
|
+
import { existsSync, readdirSync, readFileSync, statSync, writeFileSync } from 'node:fs';
|
|
89
|
+
import { dirname, join, resolve } from 'node:path';
|
|
90
|
+
|
|
91
|
+
/** Printed with a stable prefix so the reason is greppable in build logs. */
|
|
92
|
+
const TAG = '[prepare:git-hooks]';
|
|
93
|
+
|
|
94
|
+
/** The directory `prepare` runs in: the repository (or aggregator) root. */
|
|
95
|
+
const ROOT = process.cwd();
|
|
96
|
+
|
|
97
|
+
function skip(reason) {
|
|
98
|
+
console.log(`${TAG} skipped — ${reason}. Nothing to install here.`);
|
|
99
|
+
process.exit(0);
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
function die(message) {
|
|
103
|
+
console.error(`${TAG} ${message}`);
|
|
104
|
+
process.exit(1);
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
// ── 1. Is there anything to hook at all? ──────────────────────────────────
|
|
108
|
+
//
|
|
109
|
+
// `git rev-parse --git-dir` is the cheapest total answer to "is this a git
|
|
110
|
+
// work tree": it is non-zero outside one, and ENOENT when git is absent
|
|
111
|
+
// entirely. Both are the same verdict — no tree, no hooks.
|
|
112
|
+
// This is a dev tool, not service code, so it may read the process env.
|
|
113
|
+
if (process.env.CI === 'true' || process.env.GITHUB_ACTIONS === 'true') {
|
|
114
|
+
skip("CI runner: git hooks belong to a developer's working tree");
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
const probe = spawnSync('git', ['rev-parse', '--git-dir'], { stdio: 'ignore' });
|
|
118
|
+
|
|
119
|
+
if (probe.error?.code === 'ENOENT') {
|
|
120
|
+
skip('no `git` executable on PATH (image build / CI container)');
|
|
121
|
+
}
|
|
122
|
+
if (probe.error) {
|
|
123
|
+
skip(`could not probe for a git work tree (${probe.error.message})`);
|
|
124
|
+
}
|
|
125
|
+
if (probe.status !== 0) {
|
|
126
|
+
skip('not inside a git work tree (installed as a dependency or tarball)');
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
// ── 2. One-time migration off the hand-rolled `.husky/` directory ─────────
|
|
130
|
+
//
|
|
131
|
+
// This repository used to point `core.hooksPath` at a tracked `.husky/`, wired
|
|
132
|
+
// up by every developer running `git config core.hooksPath .husky` BY HAND —
|
|
133
|
+
// which is why almost nobody was wired up. lefthook writes into `.git/hooks`,
|
|
134
|
+
// and a stale `core.hooksPath` silently wins over it, so the install would
|
|
135
|
+
// report success while no hook ever fired.
|
|
136
|
+
//
|
|
137
|
+
// Cleared ONLY when it points at a directory that no longer exists. A
|
|
138
|
+
// `core.hooksPath` someone set deliberately, to somewhere real, is left alone.
|
|
139
|
+
const hooksPath = spawnSync('git', ['config', '--get', 'core.hooksPath'], {
|
|
140
|
+
encoding: 'utf8',
|
|
141
|
+
});
|
|
142
|
+
const configured = (hooksPath.stdout ?? '').trim();
|
|
143
|
+
if (configured.length > 0 && !existsSync(configured)) {
|
|
144
|
+
console.log(
|
|
145
|
+
`${TAG} clearing core.hooksPath -> ${configured} (that directory is gone; ` +
|
|
146
|
+
'it would silently win over the hooks installed below)',
|
|
147
|
+
);
|
|
148
|
+
const unset = spawnSync('git', ['config', '--unset', 'core.hooksPath'], {
|
|
149
|
+
stdio: 'inherit',
|
|
150
|
+
});
|
|
151
|
+
if (unset.status !== 0) {
|
|
152
|
+
die(
|
|
153
|
+
'could not clear core.hooksPath. Run `git config --unset core.hooksPath` ' +
|
|
154
|
+
'yourself, or the hooks below will not fire.',
|
|
155
|
+
);
|
|
156
|
+
}
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
// ── 3. Resolve the lefthook launcher, PATH-independently ──────────────────
|
|
160
|
+
//
|
|
161
|
+
// See the header. `lefthook`'s npm package exposes `bin/index.js`, a Node
|
|
162
|
+
// launcher that execs the platform binary; the binary reports its OWN absolute
|
|
163
|
+
// path to `lefthook install`, which is the path that gets baked into the hook.
|
|
164
|
+
// So resolving the launcher is enough to fix what gets baked.
|
|
165
|
+
//
|
|
166
|
+
// Resolved from the repository root, not from this file: when installed as a
|
|
167
|
+
// dependency this file lives in a package store that cannot see the repo's
|
|
168
|
+
// own `lefthook` devDependency.
|
|
169
|
+
const require = createRequire(join(ROOT, 'package.json'));
|
|
170
|
+
|
|
171
|
+
let launcher;
|
|
172
|
+
try {
|
|
173
|
+
launcher = require.resolve('lefthook/bin/index.js');
|
|
174
|
+
} catch {
|
|
175
|
+
// Reachable when the tree was installed with `--ignore-scripts` semantics or
|
|
176
|
+
// a filtered/production install that omits root devDependencies. Loud, but
|
|
177
|
+
// not fatal: the hooks are a dev affordance, and the install itself is fine.
|
|
178
|
+
skip('`lefthook` is not installed (root devDependencies were not installed)');
|
|
179
|
+
}
|
|
180
|
+
|
|
181
|
+
// ── 4. Hardening the generated hook ───────────────────────────────────────
|
|
182
|
+
|
|
183
|
+
/**
|
|
184
|
+
* lefthook's dead end. Present verbatim in every hook it generates (2.1.10),
|
|
185
|
+
* as the `else` arm of the binary search in `call_lefthook`. It prints and
|
|
186
|
+
* falls out of the function, so the hook exits 0 and the operation proceeds
|
|
187
|
+
* completely unverified.
|
|
188
|
+
*/
|
|
189
|
+
const DEAD_END = ' echo "Can\'t find lefthook in PATH"\n';
|
|
190
|
+
|
|
191
|
+
/** Proof our rewrite is already applied — makes the pass idempotent. */
|
|
192
|
+
const SENTINEL = '# xema:lefthook-unresolved-is-fatal';
|
|
193
|
+
|
|
194
|
+
/**
|
|
195
|
+
* The replacement. Single-quoted so nothing in it is expanded by `sh`, and
|
|
196
|
+
* written to stderr because that is where a refusal belongs. `exit 1` inside a
|
|
197
|
+
* shell function exits the whole hook, which is exactly the intent.
|
|
198
|
+
*/
|
|
199
|
+
const REFUSAL = [
|
|
200
|
+
` ${SENTINEL}`,
|
|
201
|
+
" echo 'lefthook is installed as a git hook here, but its binary cannot' >&2",
|
|
202
|
+
" echo 'be found — so THIS HOOK JUST VERIFIED NOTHING.' >&2",
|
|
203
|
+
" echo '' >&2",
|
|
204
|
+
" echo 'Refusing the operation rather than letting it through unguarded.' >&2",
|
|
205
|
+
" echo '' >&2",
|
|
206
|
+
" echo ' Fix: run `pnpm install` in the checkout that owns this tree' >&2",
|
|
207
|
+
" echo ' node_modules. That re-runs prepare, which re-bakes this' >&2",
|
|
208
|
+
" echo ' hook against a binary that exists.' >&2",
|
|
209
|
+
" echo ' Deliberate bypass: git push --no-verify' >&2",
|
|
210
|
+
' exit 1',
|
|
211
|
+
'',
|
|
212
|
+
].join('\n');
|
|
213
|
+
|
|
214
|
+
/**
|
|
215
|
+
* Rewrite one generated hook so an unresolvable lefthook is fatal.
|
|
216
|
+
* @returns {'hardened'|'already'} never silently "nothing to do".
|
|
217
|
+
*/
|
|
218
|
+
function hardenHookFile(file) {
|
|
219
|
+
const source = readFileSync(file, 'utf8');
|
|
220
|
+
|
|
221
|
+
if (source.includes(SENTINEL)) return 'already';
|
|
222
|
+
|
|
223
|
+
const occurrences = source.split(DEAD_END).length - 1;
|
|
224
|
+
if (occurrences !== 1) {
|
|
225
|
+
die(
|
|
226
|
+
`cannot harden ${file}: expected lefthook's "can't find" branch exactly ` +
|
|
227
|
+
`once, found ${occurrences}. lefthook's hook template has changed — ` +
|
|
228
|
+
're-derive this rewrite rather than leaving hooks unhardened.',
|
|
229
|
+
);
|
|
230
|
+
}
|
|
231
|
+
|
|
232
|
+
writeFileSync(file, source.replace(DEAD_END, REFUSAL), { mode: 0o755 });
|
|
233
|
+
return 'hardened';
|
|
234
|
+
}
|
|
235
|
+
|
|
236
|
+
// ── 5. Install + harden, here and in every hooked submodule ───────────────
|
|
237
|
+
|
|
238
|
+
/** Absolute path to a work tree's hooks directory, per git itself. */
|
|
239
|
+
function hooksDirOf(cwd) {
|
|
240
|
+
const out = spawnSync(
|
|
241
|
+
'git',
|
|
242
|
+
['rev-parse', '--path-format=absolute', '--git-path', 'hooks'],
|
|
243
|
+
{ cwd, encoding: 'utf8' },
|
|
244
|
+
);
|
|
245
|
+
if (out.status !== 0) return null;
|
|
246
|
+
const dir = (out.stdout ?? '').trim();
|
|
247
|
+
return dir.length > 0 ? dir : null;
|
|
248
|
+
}
|
|
249
|
+
|
|
250
|
+
function installIn(cwd, label) {
|
|
251
|
+
const install = spawnSync(process.execPath, [launcher, 'install'], {
|
|
252
|
+
cwd,
|
|
253
|
+
stdio: 'inherit',
|
|
254
|
+
});
|
|
255
|
+
|
|
256
|
+
if (install.error) {
|
|
257
|
+
die(`failed to run \`lefthook install\` in ${label}: ${install.error.message}`);
|
|
258
|
+
}
|
|
259
|
+
if (install.status !== 0) {
|
|
260
|
+
die(
|
|
261
|
+
`\`lefthook install\` exited ${install.status} in ${label}. Git hooks are ` +
|
|
262
|
+
'NOT installed; fix this rather than pushing without them.',
|
|
263
|
+
);
|
|
264
|
+
}
|
|
265
|
+
|
|
266
|
+
const dir = hooksDirOf(cwd);
|
|
267
|
+
if (dir === null || !existsSync(dir)) {
|
|
268
|
+
die(`\`lefthook install\` reported success in ${label} but ${dir ?? 'its hooks directory'} does not exist.`);
|
|
269
|
+
}
|
|
270
|
+
|
|
271
|
+
// Harden every hook lefthook generated — identified by the search function
|
|
272
|
+
// it writes, so a pre-existing hand-written hook is never touched.
|
|
273
|
+
let hardened = 0;
|
|
274
|
+
for (const name of readdirSync(dir)) {
|
|
275
|
+
if (name.endsWith('.sample')) continue;
|
|
276
|
+
const file = join(dir, name);
|
|
277
|
+
if (!statSync(file).isFile()) continue;
|
|
278
|
+
const body = readFileSync(file, 'utf8');
|
|
279
|
+
if (!body.includes('call_lefthook')) continue;
|
|
280
|
+
if (hardenHookFile(file) === 'hardened') hardened += 1;
|
|
281
|
+
}
|
|
282
|
+
|
|
283
|
+
if (hardened > 0) {
|
|
284
|
+
console.log(`${TAG} ${label}: hardened ${hardened} hook(s) — an unresolvable lefthook now exits 1.`);
|
|
285
|
+
}
|
|
286
|
+
}
|
|
287
|
+
|
|
288
|
+
installIn(ROOT, '.');
|
|
289
|
+
|
|
290
|
+
// Submodules that carry their own lefthook config. Read from `.gitmodules`
|
|
291
|
+
// rather than `git submodule foreach`, which would spawn a shell per entry
|
|
292
|
+
// across a 28-submodule tree for a question two greps answer.
|
|
293
|
+
const CONFIGS = ['lefthook.yml', 'lefthook.yaml', '.lefthook.yml', '.lefthook.yaml'];
|
|
294
|
+
|
|
295
|
+
const gitmodules = resolve(ROOT, '.gitmodules');
|
|
296
|
+
if (existsSync(gitmodules)) {
|
|
297
|
+
const listed = spawnSync(
|
|
298
|
+
'git',
|
|
299
|
+
['config', '--file', gitmodules, '--get-regexp', String.raw`^submodule\..*\.path$`],
|
|
300
|
+
{ encoding: 'utf8' },
|
|
301
|
+
);
|
|
302
|
+
|
|
303
|
+
// Exit 1 means "no matching keys", which is a legitimate empty answer.
|
|
304
|
+
if (listed.status !== 0 && listed.status !== 1) {
|
|
305
|
+
die(`could not read submodule paths from ${gitmodules} (exit ${listed.status}).`);
|
|
306
|
+
}
|
|
307
|
+
|
|
308
|
+
const paths = (listed.stdout ?? '')
|
|
309
|
+
.split('\n')
|
|
310
|
+
.map((line) => line.split(' ').slice(1).join(' ').trim())
|
|
311
|
+
.filter((p) => p.length > 0);
|
|
312
|
+
|
|
313
|
+
for (const rel of paths) {
|
|
314
|
+
const dir = resolve(dirname(gitmodules), rel);
|
|
315
|
+
if (!CONFIGS.some((name) => existsSync(join(dir, name)))) continue;
|
|
316
|
+
// An uninitialised submodule is an empty directory, not a work tree.
|
|
317
|
+
if (spawnSync('git', ['rev-parse', '--git-dir'], { cwd: dir, stdio: 'ignore' }).status !== 0) {
|
|
318
|
+
console.log(`${TAG} ${rel}: not initialised — skipping (run \`git submodule update --init\`).`);
|
|
319
|
+
continue;
|
|
320
|
+
}
|
|
321
|
+
installIn(dir, rel);
|
|
322
|
+
}
|
|
323
|
+
}
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
import assert from 'node:assert/strict';
|
|
2
|
+
import { spawnSync } from 'node:child_process';
|
|
3
|
+
import { mkdirSync, mkdtempSync, readFileSync, rmSync, writeFileSync, existsSync } from 'node:fs';
|
|
4
|
+
import { tmpdir } from 'node:os';
|
|
5
|
+
import { dirname, join } from 'node:path';
|
|
6
|
+
import { after, describe, it } from 'node:test';
|
|
7
|
+
import { fileURLToPath } from 'node:url';
|
|
8
|
+
|
|
9
|
+
const SCRIPT = join(dirname(fileURLToPath(import.meta.url)), 'install-git-hooks.mjs');
|
|
10
|
+
const made = [];
|
|
11
|
+
|
|
12
|
+
after(() => {
|
|
13
|
+
for (const dir of made) rmSync(dir, { recursive: true, force: true });
|
|
14
|
+
});
|
|
15
|
+
|
|
16
|
+
function tempDir() {
|
|
17
|
+
const dir = mkdtempSync(join(tmpdir(), 'xema-hooks-'));
|
|
18
|
+
made.push(dir);
|
|
19
|
+
return dir;
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
function run(cwd, env = {}) {
|
|
23
|
+
const base = { ...process.env, CI: '', GITHUB_ACTIONS: '' };
|
|
24
|
+
return spawnSync(process.execPath, [SCRIPT], { cwd, env: { ...base, ...env }, encoding: 'utf8' });
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
/** A git work tree whose `lefthook` is a stub that writes a lefthook-shaped hook. */
|
|
28
|
+
function repoWithFakeLefthook() {
|
|
29
|
+
const dir = tempDir();
|
|
30
|
+
spawnSync('git', ['init', '-q'], { cwd: dir });
|
|
31
|
+
writeFileSync(join(dir, 'package.json'), '{}');
|
|
32
|
+
const bin = join(dir, 'node_modules', 'lefthook', 'bin');
|
|
33
|
+
mkdirSync(bin, { recursive: true });
|
|
34
|
+
writeFileSync(join(dir, 'node_modules', 'lefthook', 'package.json'), '{"name":"lefthook"}');
|
|
35
|
+
writeFileSync(
|
|
36
|
+
join(bin, 'index.js'),
|
|
37
|
+
[
|
|
38
|
+
"const fs = require('node:fs');",
|
|
39
|
+
"fs.mkdirSync('.git/hooks', { recursive: true });",
|
|
40
|
+
"fs.writeFileSync('.git/hooks/pre-push', 'call_lefthook() {\\n if x; then\\n :\\n else\\n echo \"Can\\'t find lefthook in PATH\"\\n fi\\n}\\n');",
|
|
41
|
+
].join('\n'),
|
|
42
|
+
);
|
|
43
|
+
return dir;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
describe('xema-install-git-hooks', () => {
|
|
47
|
+
for (const env of [{ CI: 'true' }, { GITHUB_ACTIONS: 'true' }]) {
|
|
48
|
+
it(`is a no-op on CI (${Object.keys(env)[0]})`, () => {
|
|
49
|
+
const dir = repoWithFakeLefthook();
|
|
50
|
+
const out = run(dir, env);
|
|
51
|
+
assert.equal(out.status, 0);
|
|
52
|
+
assert.match(out.stdout, /skipped — CI runner/);
|
|
53
|
+
assert.equal(existsSync(join(dir, '.git', 'hooks', 'pre-push')), false);
|
|
54
|
+
});
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
it('is a no-op outside a git work tree', () => {
|
|
58
|
+
const dir = tempDir();
|
|
59
|
+
const out = run(dir, { GIT_CEILING_DIRECTORIES: dirname(dir) });
|
|
60
|
+
assert.equal(out.status, 0);
|
|
61
|
+
assert.match(out.stdout, /not inside a git work tree/);
|
|
62
|
+
});
|
|
63
|
+
|
|
64
|
+
it('skips when lefthook is not installed', () => {
|
|
65
|
+
const dir = tempDir();
|
|
66
|
+
spawnSync('git', ['init', '-q'], { cwd: dir });
|
|
67
|
+
writeFileSync(join(dir, 'package.json'), '{}');
|
|
68
|
+
const out = run(dir);
|
|
69
|
+
assert.equal(out.status, 0);
|
|
70
|
+
assert.match(out.stdout, /`lefthook` is not installed/);
|
|
71
|
+
});
|
|
72
|
+
|
|
73
|
+
it('installs and hardens the hook outside CI, idempotently', () => {
|
|
74
|
+
const dir = repoWithFakeLefthook();
|
|
75
|
+
const first = run(dir);
|
|
76
|
+
assert.equal(first.status, 0, first.stderr);
|
|
77
|
+
assert.match(first.stdout, /hardened 1 hook/);
|
|
78
|
+
const hook = readFileSync(join(dir, '.git', 'hooks', 'pre-push'), 'utf8');
|
|
79
|
+
assert.match(hook, /xema:lefthook-unresolved-is-fatal/);
|
|
80
|
+
assert.match(hook, /exit 1/);
|
|
81
|
+
// Re-running regenerates then re-hardens; the stub rewrites the hook each time.
|
|
82
|
+
const second = run(dir);
|
|
83
|
+
assert.equal(second.status, 0, second.stderr);
|
|
84
|
+
});
|
|
85
|
+
});
|
package/src/prepush-sanity.mjs
CHANGED
|
@@ -4,8 +4,12 @@
|
|
|
4
4
|
// 10-13/10-14). One verb for every repository's lefthook `pre-push`, so the
|
|
5
5
|
// logic is not copied per repo.
|
|
6
6
|
//
|
|
7
|
-
// With turbo (a `turbo.json` and a turbo dependency): turbo `lint
|
|
8
|
-
//
|
|
7
|
+
// With turbo (a `turbo.json` and a turbo dependency): turbo `lint`, `typecheck`,
|
|
8
|
+
// `test` (unit) and `openapi:current`, each where turbo.json defines it (D136: a cheap
|
|
9
|
+
// pre-push let a stale openapi spec through, and every red costs ~1h of CI). `lint` and
|
|
10
|
+
// `typecheck` run on the packages the pushed commits change plus their dependents; `test`
|
|
11
|
+
// and `openapi:current` only on the packages the push itself changes, and one line names the
|
|
12
|
+
// dependents whose tests are left to CI (an affected-set run took 36 min for a widely used package). A change to the lockfile,
|
|
9
13
|
// turbo.json, or anything in the root package.json other than its `scripts`
|
|
10
14
|
// table invalidates everything and runs the full graph. A repo whose turbo carries no `lint` task also runs its root `lint`
|
|
11
15
|
// script. Without turbo: the root `lint` script only (typecheck needs a build, which the hook never runs; CI has it).
|
|
@@ -17,7 +21,9 @@
|
|
|
17
21
|
// session park (`refs/xema-session/*`) grades nothing either: a park is not a
|
|
18
22
|
// landing, and the work is graded when it lands on a branch.
|
|
19
23
|
//
|
|
20
|
-
//
|
|
24
|
+
// A fleet-wide change runs `lint` and `typecheck` on the full graph and says it
|
|
25
|
+
// leaves `test` and `openapi:current` to CI: never the full suite. Never builds
|
|
26
|
+
// for its own sake, never runs docker, image builds or `pnpm check`.
|
|
21
27
|
//
|
|
22
28
|
// Usage (lefthook `pre-push` with `use_stdin: true`):
|
|
23
29
|
// xema-prepush-sanity
|
|
@@ -62,11 +68,68 @@ export function stripJsonc(text) {
|
|
|
62
68
|
return out;
|
|
63
69
|
}
|
|
64
70
|
|
|
71
|
+
/** The tasks pre-push runs on the affected packages, in this order, where turbo.json defines them. */
|
|
72
|
+
export const SANITY_TASKS = ['lint', 'typecheck', 'test', 'openapi:current'];
|
|
73
|
+
/** The subset that also runs on the full graph and on dependents; the rest would be the full suite, which is CI's. */
|
|
74
|
+
export const FULL_GRAPH_TASKS = ['lint', 'typecheck'];
|
|
75
|
+
|
|
76
|
+
/** Package directories (a package.json below the root) among tracked file paths; node_modules never counts. */
|
|
77
|
+
export function packageDirs(files) {
|
|
78
|
+
return [...new Set(files.filter((f) => f.endsWith('/package.json') && !f.includes('node_modules/')).map((f) => f.slice(0, -'/package.json'.length)))];
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
/** Paths no task reads: root-level markdown and changesets. */
|
|
82
|
+
export function isInert(path) {
|
|
83
|
+
return /^[^/]*\.md$/.test(path) || path.startsWith('.changeset/');
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
/** Changed paths that sit in no workspace package and that some task may read (tsconfig.base.json, biome.json, tooling/**). They invalidate every package. */
|
|
87
|
+
export function outsidePackages(changed, dirs) {
|
|
88
|
+
return changed.filter((p) => !isInert(p) && !dirs.some((d) => p.startsWith(`${d}/`)));
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
/** A push with changes whose plan holds no task checked nothing, and must say so rather than pass; null when it is fine. */
|
|
92
|
+
export function emptyPlanFailure(changed, plannedTasks) {
|
|
93
|
+
if (changed.length === 0 || plannedTasks > 0) return null;
|
|
94
|
+
return `no task was planned for a push that changes ${changed.slice(0, 10).join(', ')}${changed.length > 10 ? ` (+${changed.length - 10} more)` : ''} — nothing was checked`;
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
/**
|
|
98
|
+
* The turbo runs for a push. `range` '' is the full graph: lint and typecheck only. Otherwise lint and
|
|
99
|
+
* typecheck run on the affected set (changed packages plus dependents), while test and openapi:current
|
|
100
|
+
* run only on the packages the push itself changed: a widely used package has dozens of dependents and
|
|
101
|
+
* their tests cost ~36 min (authorization-nest: 78 packages, 195 tasks). CI runs those.
|
|
102
|
+
*/
|
|
103
|
+
export function planRuns(tasks, range) {
|
|
104
|
+
if (!range) {
|
|
105
|
+
const full = tasks.filter((t) => FULL_GRAPH_TASKS.includes(t));
|
|
106
|
+
return { runs: full.length > 0 ? [{ tasks: full, filter: null }] : [], leftToCi: tasks.filter((t) => !FULL_GRAPH_TASKS.includes(t)) };
|
|
107
|
+
}
|
|
108
|
+
const affected = tasks.filter((t) => FULL_GRAPH_TASKS.includes(t));
|
|
109
|
+
const changedOnly = tasks.filter((t) => !FULL_GRAPH_TASKS.includes(t));
|
|
110
|
+
const runs = [];
|
|
111
|
+
if (affected.length > 0) runs.push({ tasks: affected, filter: `...[${range}]` });
|
|
112
|
+
if (changedOnly.length > 0) runs.push({ tasks: changedOnly, filter: `[${range}]` });
|
|
113
|
+
return { runs, leftToCi: [] };
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
/** Package names in `affected` that are not in `changed`, sorted; the root workspace `//` is never a package. */
|
|
117
|
+
export function dependentsOnly(affected, changed) {
|
|
118
|
+
const own = new Set(changed);
|
|
119
|
+
return [...new Set(affected)].filter((n) => n !== '//' && !own.has(n)).sort();
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
/** The one line naming the dependents whose test and openapi:current are left to CI. */
|
|
123
|
+
export function dependentsLine(dependents, tasks) {
|
|
124
|
+
if (dependents.length === 0 || tasks.length === 0) return '';
|
|
125
|
+
return `pre-push: ${tasks.join(' ')} ran only on the changed packages; ${dependents.length} dependent(s) are left to CI: ${dependents.join(', ')}`;
|
|
126
|
+
}
|
|
127
|
+
|
|
65
128
|
/** The sanity tasks a turbo.json defines. An unparsable file throws: "no tasks" would report green. */
|
|
66
129
|
export function turboTasks(text) {
|
|
67
130
|
const cfg = JSON.parse(stripJsonc(text));
|
|
68
131
|
const defined = cfg.tasks ?? cfg.pipeline ?? {};
|
|
69
|
-
return
|
|
132
|
+
return SANITY_TASKS.filter((t) => t in defined);
|
|
70
133
|
}
|
|
71
134
|
|
|
72
135
|
/** The refs git writes on a pre-push hook's stdin, one sha graded once, deletes dropped. */
|
|
@@ -178,9 +241,19 @@ function rangeFor(ctx, base, sha) {
|
|
|
178
241
|
console.error('pre-push: lockfile, turbo.json or root package.json beyond its scripts changed — fleet-wide, running the FULL graph.');
|
|
179
242
|
return '';
|
|
180
243
|
}
|
|
244
|
+
const files = (rev) => (ctx.gitOut(['ls-tree', '-r', '--name-only', rev]) ?? '').split('\n').filter(Boolean);
|
|
245
|
+
const outside = outsidePackages(changed, packageDirs([...files(base), ...files(sha)]));
|
|
246
|
+
if (outside.length > 0) {
|
|
247
|
+
console.error(`pre-push: ${outside.slice(0, 10).join(', ')}${outside.length > 10 ? ` (+${outside.length - 10} more)` : ''} sit outside any workspace package — fleet-wide, running the FULL graph.`);
|
|
248
|
+
return '';
|
|
249
|
+
}
|
|
181
250
|
return `${base}...${sha}`;
|
|
182
251
|
}
|
|
183
252
|
|
|
253
|
+
function changedPaths(ctx, base, sha) {
|
|
254
|
+
return base ? (ctx.gitOut(['diff', '--name-only', `${base}...${sha}`]) ?? '').split('\n').filter(Boolean) : [];
|
|
255
|
+
}
|
|
256
|
+
|
|
184
257
|
function turboBin(root, env) {
|
|
185
258
|
const local = join(root, 'node_modules', '.bin', 'turbo');
|
|
186
259
|
if (existsSync(local)) return local;
|
|
@@ -205,8 +278,22 @@ function hasRootLint(dir) {
|
|
|
205
278
|
}
|
|
206
279
|
}
|
|
207
280
|
|
|
281
|
+
/** How many tasks turbo plans for `tasks` under `filter`. */
|
|
282
|
+
function dryTaskCount(ctx, bin, dir, tasks, filter) {
|
|
283
|
+
const dry = spawnSync(bin, ['run', ...tasks, `--filter=${filter}`, '--dry=json'], { cwd: dir, env: ctx.env, encoding: 'utf8', maxBuffer: 1 << 28 });
|
|
284
|
+
if (dry.status !== 0) throw new Error(`turbo --dry=json failed for --filter=${filter}`);
|
|
285
|
+
return (JSON.parse(dry.stdout).tasks ?? []).length;
|
|
286
|
+
}
|
|
287
|
+
|
|
288
|
+
/** Package names turbo would run `tasks` for under `filter`; an unreadable plan throws rather than hide a dependent. */
|
|
289
|
+
function dryPackages(ctx, bin, dir, tasks, filter) {
|
|
290
|
+
const dry = spawnSync(bin, ['run', ...tasks, `--filter=${filter}`, '--dry=json'], { cwd: dir, env: ctx.env, encoding: 'utf8', maxBuffer: 1 << 28 });
|
|
291
|
+
if (dry.status !== 0) throw new Error(`turbo --dry=json failed for --filter=${filter}`);
|
|
292
|
+
return JSON.parse(dry.stdout).packages ?? [];
|
|
293
|
+
}
|
|
294
|
+
|
|
208
295
|
/** Run the sanity tasks in `dir`; `range` '' is the full graph. Returns the verdict. */
|
|
209
|
-
function runHere(ctx, dir, range, bin) {
|
|
296
|
+
function runHere(ctx, dir, range, bin, changed) {
|
|
210
297
|
if (!bin) {
|
|
211
298
|
// Without turbo nothing orders the builds a workspace typecheck needs, and the hook never
|
|
212
299
|
// builds: typecheck there is CI's.
|
|
@@ -221,16 +308,29 @@ function runHere(ctx, dir, range, bin) {
|
|
|
221
308
|
return false;
|
|
222
309
|
}
|
|
223
310
|
if (tasks.length === 0) {
|
|
224
|
-
console.log(
|
|
311
|
+
console.log(`pre-push: turbo.json defines none of ${SANITY_TASKS.join(', ')} — FAILED`);
|
|
225
312
|
return false;
|
|
226
313
|
}
|
|
227
|
-
let ok;
|
|
228
314
|
if (range) {
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
315
|
+
const failure = emptyPlanFailure(changed, dryTaskCount(ctx, bin, dir, tasks, `...[${range}]`));
|
|
316
|
+
if (failure) {
|
|
317
|
+
console.log(`pre-push: ${failure} — FAILED`);
|
|
318
|
+
return false;
|
|
319
|
+
}
|
|
320
|
+
}
|
|
321
|
+
const { runs, leftToCi } = planRuns(tasks, range);
|
|
322
|
+
if (leftToCi.length > 0) console.log(`pre-push: ${leftToCi.join(' ')} not run on the full graph — that is the full suite, CI runs it.`);
|
|
323
|
+
let ok = true;
|
|
324
|
+
for (const run of runs) {
|
|
325
|
+
const where = run.filter ? (run.filter.startsWith('...') ? `affected by ${range}, plus dependents` : `only the packages ${range} changes`) : 'full graph';
|
|
326
|
+
console.log(`pre-push: turbo run ${run.tasks.join(' ')} (${where})`);
|
|
327
|
+
const filterArgs = run.filter ? [`--filter=${run.filter}`] : [];
|
|
328
|
+
ok = ctx.inherit(bin, ['run', ...run.tasks, ...filterArgs, '--continue=dependencies-successful'], dir) && ok;
|
|
329
|
+
}
|
|
330
|
+
if (range) {
|
|
331
|
+
const changedOnly = tasks.filter((t) => !FULL_GRAPH_TASKS.includes(t));
|
|
332
|
+
const line = dependentsLine(dependentsOnly(dryPackages(ctx, bin, dir, tasks, `...[${range}]`), dryPackages(ctx, bin, dir, tasks, `[${range}]`)), changedOnly);
|
|
333
|
+
if (line) console.log(line);
|
|
234
334
|
}
|
|
235
335
|
// Lint that turbo does not carry is the root `lint` script CI runs.
|
|
236
336
|
if (!tasks.includes('lint') && hasRootLint(dir)) {
|
|
@@ -272,7 +372,7 @@ function exportTo(ctx, rev, dir) {
|
|
|
272
372
|
return spawnSync('sh', ['-c', 'git archive "$1" | tar -x -C "$2"', 'sh', rev, dir], { cwd: ctx.root, env: ctx.env }).status === 0;
|
|
273
373
|
}
|
|
274
374
|
|
|
275
|
-
function gradeFromExport(ctx, sha, base, range, bin) {
|
|
375
|
+
function gradeFromExport(ctx, sha, base, range, bin, changed) {
|
|
276
376
|
const scratch = mkdtempSync(join(tmpdir(), 'xema-prepush-'));
|
|
277
377
|
try {
|
|
278
378
|
const sh = (args) => ctx.git(['-c', 'user.email=gate@local', '-c', 'user.name=gate', ...args], scratch).status === 0;
|
|
@@ -289,7 +389,7 @@ function gradeFromExport(ctx, sha, base, range, bin) {
|
|
|
289
389
|
console.log('pre-push: install of the export failed');
|
|
290
390
|
return false;
|
|
291
391
|
}
|
|
292
|
-
return runHere(ctx, scratch, exportRange, bin);
|
|
392
|
+
return runHere(ctx, scratch, exportRange, bin, changed);
|
|
293
393
|
} finally {
|
|
294
394
|
rmSync(scratch, { recursive: true, force: true });
|
|
295
395
|
}
|
|
@@ -299,12 +399,17 @@ function gradeSha(ctx, ref, bin) {
|
|
|
299
399
|
const { sha } = ref;
|
|
300
400
|
const base = pickBase(ctx, ref);
|
|
301
401
|
const range = rangeFor(ctx, base, sha);
|
|
402
|
+
const changed = changedPaths(ctx, base, sha);
|
|
403
|
+
if (range && changed.length > 0 && changed.every(isInert)) {
|
|
404
|
+
console.log(`pre-push: only paths no task reads changed (${changed.slice(0, 10).join(', ')}) — nothing to grade.`);
|
|
405
|
+
return true;
|
|
406
|
+
}
|
|
302
407
|
const head = (ctx.gitOut(['rev-parse', 'HEAD']) ?? '').trim();
|
|
303
408
|
const short = (rev) => (ctx.gitOut(['rev-parse', '--short', rev]) ?? rev).trim();
|
|
304
409
|
const clean = (ctx.gitOut(['status', '--porcelain']) ?? '') === '';
|
|
305
410
|
if (sha === head && clean) {
|
|
306
411
|
console.log(`pre-push: grading HEAD ${short(head)} in place (clean tree).`);
|
|
307
|
-
return runHere(ctx, ctx.root, range, bin);
|
|
412
|
+
return runHere(ctx, ctx.root, range, bin, changed);
|
|
308
413
|
}
|
|
309
414
|
if (bin) {
|
|
310
415
|
let tasks = [];
|
|
@@ -315,7 +420,7 @@ function gradeSha(ctx, ref, bin) {
|
|
|
315
420
|
}
|
|
316
421
|
if (tasks.length > 0 && inPlaceSafe(ctx, sha, range, tasks, bin)) {
|
|
317
422
|
console.log(`pre-push: grading ${short(sha)} in place — no differing path is in a package this run reads.`);
|
|
318
|
-
return runHere(ctx, ctx.root, range, bin);
|
|
423
|
+
return runHere(ctx, ctx.root, range, bin, changed);
|
|
319
424
|
}
|
|
320
425
|
}
|
|
321
426
|
console.log(
|
|
@@ -323,7 +428,7 @@ function gradeSha(ctx, ref, bin) {
|
|
|
323
428
|
? `pre-push: grading ${short(sha)} from an export — the tree is dirty, so it is not what is being pushed.`
|
|
324
429
|
: `pre-push: grading ${short(sha)} from an export — the commit being PUSHED, which is not HEAD ${short(head)}.`,
|
|
325
430
|
);
|
|
326
|
-
return gradeFromExport(ctx, sha, base, bin ? range : '', bin);
|
|
431
|
+
return gradeFromExport(ctx, sha, base, bin ? range : '', bin, changed);
|
|
327
432
|
}
|
|
328
433
|
|
|
329
434
|
export function main(stdin) {
|
|
@@ -5,7 +5,7 @@ import { tmpdir } from 'node:os';
|
|
|
5
5
|
import { join } from 'node:path';
|
|
6
6
|
import { test } from 'node:test';
|
|
7
7
|
import { fileURLToPath } from 'node:url';
|
|
8
|
-
import { blockingPath, isFleetWide, parkOnly, parseRefs, scriptsOnlyChange, stripJsonc, turboCacheDir, turboTasks } from './prepush-sanity.mjs';
|
|
8
|
+
import { blockingPath, dependentsLine, emptyPlanFailure, isInert, outsidePackages, packageDirs, dependentsOnly, isFleetWide, planRuns, parkOnly, parseRefs, scriptsOnlyChange, stripJsonc, turboCacheDir, turboTasks } from './prepush-sanity.mjs';
|
|
9
9
|
|
|
10
10
|
const VERB = fileURLToPath(new URL('./prepush-sanity.mjs', import.meta.url));
|
|
11
11
|
const SHA_A = 'a'.repeat(40);
|
|
@@ -18,6 +18,7 @@ test('stripJsonc drops comments outside strings only', () => {
|
|
|
18
18
|
|
|
19
19
|
test('turboTasks keeps lint and typecheck, and throws on unparsable turbo.json', () => {
|
|
20
20
|
assert.deepEqual(turboTasks('{"tasks":{"build":{},"typecheck":{},"lint":{}}}'), ['lint', 'typecheck']);
|
|
21
|
+
assert.deepEqual(turboTasks('{"tasks":{"openapi:current":{},"test":{},"build":{},"typecheck":{},"lint":{}}}'), ['lint', 'typecheck', 'test', 'openapi:current']);
|
|
21
22
|
assert.deepEqual(turboTasks('{"pipeline":{"typecheck":{}}}'), ['typecheck']);
|
|
22
23
|
assert.throws(() => turboTasks('{ nope'));
|
|
23
24
|
});
|
|
@@ -162,3 +163,43 @@ test('a park-only push skips and says why; a park beside develop still grades',
|
|
|
162
163
|
rmSync(r.dir, { recursive: true, force: true });
|
|
163
164
|
}
|
|
164
165
|
});
|
|
166
|
+
|
|
167
|
+
test('planRuns: affected set for lint and typecheck, changed packages only for test and openapi:current', () => {
|
|
168
|
+
const tasks = ['lint', 'typecheck', 'test', 'openapi:current'];
|
|
169
|
+
assert.deepEqual(planRuns(tasks, 'A...B'), {
|
|
170
|
+
runs: [
|
|
171
|
+
{ tasks: ['lint', 'typecheck'], filter: '...[A...B]' },
|
|
172
|
+
{ tasks: ['test', 'openapi:current'], filter: '[A...B]' },
|
|
173
|
+
],
|
|
174
|
+
leftToCi: [],
|
|
175
|
+
});
|
|
176
|
+
assert.deepEqual(planRuns(['test'], 'A...B').runs, [{ tasks: ['test'], filter: '[A...B]' }]);
|
|
177
|
+
});
|
|
178
|
+
|
|
179
|
+
test('planRuns: a root-file change runs lint and typecheck on all and leaves the rest to CI', () => {
|
|
180
|
+
assert.deepEqual(planRuns(['lint', 'typecheck', 'test'], ''), { runs: [{ tasks: ['lint', 'typecheck'], filter: null }], leftToCi: ['test'] });
|
|
181
|
+
assert.deepEqual(planRuns(['test'], ''), { runs: [], leftToCi: ['test'] });
|
|
182
|
+
});
|
|
183
|
+
|
|
184
|
+
test('dependentsOnly and dependentsLine name the dependents left to CI', () => {
|
|
185
|
+
const dependents = dependentsOnly(['//', 'b', 'a', 'c', 'a'], ['c']);
|
|
186
|
+
assert.deepEqual(dependents, ['a', 'b']);
|
|
187
|
+
assert.match(dependentsLine(dependents, ['test', 'openapi:current']), /test openapi:current ran only on the changed packages; 2 dependent\(s\) are left to CI: a, b/);
|
|
188
|
+
assert.equal(dependentsLine([], ['test']), '');
|
|
189
|
+
assert.equal(dependentsLine(['a'], []), '');
|
|
190
|
+
});
|
|
191
|
+
|
|
192
|
+
test('a path outside every workspace package is fleet-wide; package files and inert files are not', () => {
|
|
193
|
+
const dirs = packageDirs(['package.json', 'packages/a/package.json', 'packages/a/node_modules/x/package.json', 'apps/b/package.json']);
|
|
194
|
+
assert.deepEqual(dirs.sort(), ['apps/b', 'packages/a']);
|
|
195
|
+
assert.deepEqual(outsidePackages(['tsconfig.base.json', 'biome.json', 'tooling/ci/x.mjs'], dirs), ['tsconfig.base.json', 'biome.json', 'tooling/ci/x.mjs']);
|
|
196
|
+
assert.deepEqual(outsidePackages(['packages/a/src/x.ts', 'apps/b/package.json', 'README.md', '.changeset/x.md'], dirs), []);
|
|
197
|
+
assert.equal(isInert('README.md'), true);
|
|
198
|
+
assert.equal(isInert('tooling/README.md'), false);
|
|
199
|
+
});
|
|
200
|
+
|
|
201
|
+
test('zero planned tasks for a push with changes is a failure naming the paths, never green', () => {
|
|
202
|
+
assert.match(emptyPlanFailure(['tsconfig.base.json'], 0), /tsconfig\.base\.json.*nothing was checked/);
|
|
203
|
+
assert.equal(emptyPlanFailure(['packages/a/x.ts'], 3), null);
|
|
204
|
+
assert.equal(emptyPlanFailure([], 0), null);
|
|
205
|
+
});
|