@1aboveio/engineering-skills 0.0.0-stage → 0.1.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 +28 -2
- package/package.json +34 -4
- package/skills/better-review/LICENSE +3 -0
- package/skills/better-review/SKILL.md +249 -0
- package/skills/better-review/agents/openai.yaml +9 -0
- package/skills/better-review/references/domain-hazards.md +53 -0
- package/skills/better-review/references/passes.md +147 -0
- package/skills/better-review/references/result.md +151 -0
- package/skills/better-review/release-check.mjs +93 -0
- package/skills/better-review/scripts/pr-context.mjs +212 -0
- package/skills/better-review/scripts/pr-context.test.mjs +168 -0
- package/skills/better-review/scripts/rereview-scope.mjs +503 -0
- package/skills/better-review/scripts/rereview-scope.test.mjs +587 -0
- package/skills/better-review/scripts/scan-diff.mjs +365 -0
- package/skills/better-review/scripts/scan-diff.test.mjs +414 -0
- package/skills/better-review/scripts/vendor-sync.test.mjs +96 -0
- package/skills/e2e-test/LICENSE +3 -0
- package/skills/e2e-test/SKILL.md +98 -0
- package/skills/e2e-test/assets/ci-gates.cloudbuild.yaml +24 -0
- package/skills/e2e-test/references/authoring/auth-flows.md +159 -0
- package/skills/e2e-test/references/authoring/playwright-config.md +73 -0
- package/skills/e2e-test/references/authoring/playwright-patterns.md +144 -0
- package/skills/e2e-test/references/ci-integration.md +25 -0
- package/skills/e2e-test/references/ci-playwright-container.md +290 -0
- package/skills/e2e-test/references/presentation-sweep.md +104 -0
- package/skills/e2e-test/references/reviewing.md +41 -0
- package/skills/e2e-test/references/route-manifest.md +51 -0
- package/skills/e2e-test/release-check.mjs +93 -0
- package/skills/e2e-test/scripts/detect-routes-nextjs.mjs +200 -0
- package/skills/e2e-test/scripts/presentation-checks.mjs +171 -0
- package/skills/e2e-test/scripts/presentation-checks.test.mjs +106 -0
- package/skills/e2e-test/scripts/presentation-perceivability.mjs +179 -0
- package/skills/e2e-test/scripts/presentation-perceivability.test.mjs +117 -0
- package/skills/e2e-test/scripts/presentation-reachability.mjs +154 -0
- package/skills/e2e-test/scripts/presentation-reachability.test.mjs +69 -0
- package/skills/e2e-test/scripts/presentation-render-health.mjs +141 -0
- package/skills/e2e-test/scripts/presentation-render-health.test.mjs +98 -0
- package/skills/e2e-test/scripts/presentation-sweep.mjs +147 -0
- package/skills/e2e-test/scripts/presentation-sweep.test.mjs +71 -0
- package/skills/e2e-test/scripts/presentation-temporal.mjs +127 -0
- package/skills/e2e-test/scripts/presentation-temporal.test.mjs +59 -0
- package/skills/e2e-test/scripts/project-route-manifest.mjs +82 -0
- package/skills/e2e-test/scripts/project-route-manifest.test.mjs +76 -0
- package/skills/e2e-test/scripts/validate-manifest.mjs +106 -0
- package/skills/engineering-runtime/LICENSE +3 -0
- package/skills/engineering-runtime/SKILL.md +11 -0
- package/skills/engineering-runtime/agents/openai.yaml +6 -0
- package/skills/engineering-runtime/coherence/workflow.json +597 -0
- package/skills/engineering-runtime/engineering-runtime.test.mjs +68 -0
- package/skills/engineering-runtime/release-check.mjs +93 -0
- package/skills/engineering-runtime/scripts/exact-head-artifact.mjs +131 -0
- package/skills/engineering-runtime/scripts/head-check-set.mjs +398 -0
- package/skills/engineering-runtime/scripts/invocation-policy.mjs +187 -0
- package/skills/engineering-runtime/scripts/invocation-policy.test.mjs +95 -0
- package/skills/engineering-runtime/scripts/main-module.mjs +79 -0
- package/skills/engineering-runtime/scripts/main-module.test.mjs +288 -0
- package/skills/engineering-runtime/scripts/mergify-yaml.mjs +11 -0
- package/skills/engineering-runtime/scripts/package-lock.json +43 -0
- package/skills/engineering-runtime/scripts/package.json +10 -0
- package/skills/engineering-runtime/scripts/required-check-plan.mjs +223 -0
- package/skills/engineering-runtime/scripts/required-check-plan.test.mjs +96 -0
- package/skills/engineering-runtime/scripts/review-completion.mjs +56 -0
- package/skills/engineering-runtime/scripts/workflow-coherence.mjs +595 -0
- package/skills/engineering-runtime/scripts/workflow-policy.mjs +189 -0
- package/skills/engineering-runtime/scripts/yaml-mapping.mjs +18 -0
- package/skills/ensure-coverage/LICENSE +3 -0
- package/skills/ensure-coverage/SKILL.md +129 -0
- package/skills/ensure-coverage/references/breadth/coverage-ledger.md +92 -0
- package/skills/ensure-coverage/references/breadth/inventory-contract.md +85 -0
- package/skills/ensure-coverage/references/breadth/surface-baseline.md +44 -0
- package/skills/ensure-coverage/references/breadth/surface-discovery.md +16 -0
- package/skills/ensure-coverage/references/depth/characterization.md +68 -0
- package/skills/ensure-coverage/references/depth/coverage.config.example.json +19 -0
- package/skills/ensure-coverage/references/depth/grading.md +35 -0
- package/skills/ensure-coverage/references/depth/mock-policy.md +57 -0
- package/skills/ensure-coverage/references/depth/test-smells.md +39 -0
- package/skills/ensure-coverage/references/enforcement/ci-contract.md +44 -0
- package/skills/ensure-coverage/references/examples/coverage-ledger.md +110 -0
- package/skills/ensure-coverage/references/examples/refund-flow.md +35 -0
- package/skills/ensure-coverage/references/presentation/axis.md +64 -0
- package/skills/ensure-coverage/references/process/audit-mode.md +27 -0
- package/skills/ensure-coverage/references/process/output-template.md +139 -0
- package/skills/ensure-coverage/references/process/test-strategy.md +56 -0
- package/skills/ensure-coverage/release-check.mjs +93 -0
- package/skills/ensure-coverage/schemas/coverage-config.schema.json +67 -0
- package/skills/ensure-coverage/schemas/coverage-file.schema.json +140 -0
- package/skills/ensure-coverage/scripts/README.md +99 -0
- package/skills/ensure-coverage/scripts/adapters/nextjs-inventory.mjs +182 -0
- package/skills/ensure-coverage/scripts/adapters/nextjs-inventory.test.mjs +96 -0
- package/skills/ensure-coverage/scripts/check-quarantine-expiry.mjs +105 -0
- package/skills/ensure-coverage/scripts/check-quarantine-expiry.test.mjs +47 -0
- package/skills/ensure-coverage/scripts/ci-audit.mjs +137 -0
- package/skills/ensure-coverage/scripts/ci-audit.test.mjs +86 -0
- package/skills/ensure-coverage/scripts/coverage-ledger.mjs +674 -0
- package/skills/ensure-coverage/scripts/coverage-ledger.test.mjs +447 -0
- package/skills/ensure-coverage/scripts/design-parity.mjs +591 -0
- package/skills/ensure-coverage/scripts/design-parity.test.mjs +552 -0
- package/skills/ensure-coverage/scripts/lint-tests.mjs +282 -0
- package/skills/ensure-coverage/scripts/lint-tests.test.mjs +289 -0
- package/skills/ensure-coverage/scripts/mock-policy-config.mjs +176 -0
- package/skills/ensure-coverage/scripts/mock-policy-config.test.mjs +119 -0
- package/skills/ensure-coverage/scripts/package.json +19 -0
- package/skills/golden-path/LICENSE +3 -0
- package/skills/golden-path/SKILL.md +230 -0
- package/skills/golden-path/agents/openai.yaml +3 -0
- package/skills/golden-path/assets/golden-paths.example.json +57 -0
- package/skills/golden-path/references/contract.md +239 -0
- package/skills/golden-path/references/migration.md +111 -0
- package/skills/golden-path/release-check.mjs +93 -0
- package/skills/golden-path/scripts/golden-path-core.mjs +1779 -0
- package/skills/golden-path/scripts/golden-path.mjs +6 -0
- package/skills/golden-path/scripts/golden-path.test.mjs +1457 -0
- package/skills/harness-runtime/LICENSE +3 -0
- package/skills/harness-runtime/SKILL.md +19 -0
- package/skills/harness-runtime/agents/openai.yaml +6 -0
- package/skills/harness-runtime/bin/discover-models.mjs +4 -0
- package/skills/harness-runtime/bin/model-catalog.mjs +4 -0
- package/skills/harness-runtime/contracts.md +15 -0
- package/skills/harness-runtime/discover-models.mjs +392 -0
- package/skills/harness-runtime/discover-models.test.mjs +363 -0
- package/skills/harness-runtime/fixtures/native-question-schemas.json +33 -0
- package/skills/harness-runtime/fixtures/question-responses.json +54 -0
- package/skills/harness-runtime/harness-runtime.test.mjs +967 -0
- package/skills/harness-runtime/index.mjs +767 -0
- package/skills/harness-runtime/model-catalog-seed.test.mjs +829 -0
- package/skills/harness-runtime/model-catalog.mjs +787 -0
- package/skills/harness-runtime/model-catalog.test.mjs +366 -0
- package/skills/harness-runtime/native-question-contracts.md +37 -0
- package/skills/harness-runtime/references/model-catalog-seed.json +408 -0
- package/skills/harness-runtime/references/model-catalog.md +57 -0
- package/skills/harness-runtime/release-check.mjs +93 -0
- package/skills/resolve-issues/LICENSE +3 -0
- package/skills/resolve-issues/SKILL.md +250 -0
- package/skills/resolve-issues/agents/openai.yaml +9 -0
- package/skills/resolve-issues/plugin-hooks.json +17 -0
- package/skills/resolve-issues/references/canary.md +28 -0
- package/skills/resolve-issues/references/ci.md +105 -0
- package/skills/resolve-issues/references/done.md +25 -0
- package/skills/resolve-issues/references/dropbox.md +90 -0
- package/skills/resolve-issues/references/expire.md +318 -0
- package/skills/resolve-issues/references/exploration.md +202 -0
- package/skills/resolve-issues/references/implementation.md +303 -0
- package/skills/resolve-issues/references/preflight.md +445 -0
- package/skills/resolve-issues/references/review.md +228 -0
- package/skills/resolve-issues/references/shared-modules.md +44 -0
- package/skills/resolve-issues/references/task-plan.md +264 -0
- package/skills/resolve-issues/release-check.mjs +93 -0
- package/skills/resolve-issues/scripts/cleanup-runs.mjs +364 -0
- package/skills/resolve-issues/scripts/cleanup-runs.test.mjs +280 -0
- package/skills/resolve-issues/scripts/discover-models.mjs +9 -0
- package/skills/resolve-issues/scripts/dropbox.mjs +473 -0
- package/skills/resolve-issues/scripts/dropbox.test.mjs +346 -0
- package/skills/resolve-issues/scripts/findings-reuse.mjs +98 -0
- package/skills/resolve-issues/scripts/findings-reuse.test.mjs +88 -0
- package/skills/resolve-issues/scripts/github-reviews.mjs +384 -0
- package/skills/resolve-issues/scripts/github-reviews.test.mjs +264 -0
- package/skills/resolve-issues/scripts/install-hooks.mjs +135 -0
- package/skills/resolve-issues/scripts/install-hooks.test.mjs +79 -0
- package/skills/resolve-issues/scripts/issue-tree.mjs +162 -0
- package/skills/resolve-issues/scripts/issue-tree.test.mjs +107 -0
- package/skills/resolve-issues/scripts/manual-invocation.test.mjs +14 -0
- package/skills/resolve-issues/scripts/model-catalog.mjs +9 -0
- package/skills/resolve-issues/scripts/next-actions-capacity.test.mjs +149 -0
- package/skills/resolve-issues/scripts/next-actions.mjs +856 -0
- package/skills/resolve-issues/scripts/next-actions.test.mjs +915 -0
- package/skills/resolve-issues/scripts/plan-sync.mjs +269 -0
- package/skills/resolve-issues/scripts/plan-sync.test.mjs +156 -0
- package/skills/resolve-issues/scripts/preflight-models.mjs +736 -0
- package/skills/resolve-issues/scripts/preflight-models.test.mjs +448 -0
- package/skills/resolve-issues/scripts/ready-check.mjs +185 -0
- package/skills/resolve-issues/scripts/ready-check.test.mjs +217 -0
- package/skills/resolve-issues/scripts/rehydrate.mjs +98 -0
- package/skills/resolve-issues/scripts/rehydrate.test.mjs +91 -0
- package/skills/resolve-issues/scripts/review-verdict.mjs +509 -0
- package/skills/resolve-issues/scripts/review-verdict.test.mjs +1060 -0
- package/skills/resolve-issues/scripts/size-check.mjs +492 -0
- package/skills/resolve-issues/scripts/size-check.test.mjs +458 -0
- package/skills/resolve-release/LICENSE +3 -0
- package/skills/resolve-release/SKILL.md +215 -0
- package/skills/resolve-release/agents/openai.yaml +8 -0
- package/skills/resolve-release/flows/cloud-run-canary.md +13 -0
- package/skills/resolve-release/flows/cloud-run.md +7 -0
- package/skills/resolve-release/flows/root-tag-npm.md +13 -0
- package/skills/resolve-release/flows/workspace-npm.md +22 -0
- package/skills/resolve-release/references/canary.md +51 -0
- package/skills/resolve-release/references/candidate.md +41 -0
- package/skills/resolve-release/references/cut.md +131 -0
- package/skills/resolve-release/references/dark-launch.md +66 -0
- package/skills/resolve-release/references/flows.md +150 -0
- package/skills/resolve-release/references/preflight.md +154 -0
- package/skills/resolve-release/references/prepared-metadata.md +260 -0
- package/skills/resolve-release/references/promotion.md +82 -0
- package/skills/resolve-release/references/publish.md +232 -0
- package/skills/resolve-release/references/workspace-npm.md +103 -0
- package/skills/resolve-release/release-check.mjs +93 -0
- package/skills/resolve-release/scripts/apply.mjs +212 -0
- package/skills/resolve-release/scripts/apply.test.mjs +99 -0
- package/skills/resolve-release/scripts/dark-flags.mjs +134 -0
- package/skills/resolve-release/scripts/dark-flags.test.mjs +100 -0
- package/skills/resolve-release/scripts/flow.mjs +500 -0
- package/skills/resolve-release/scripts/flow.test.mjs +340 -0
- package/skills/resolve-release/scripts/green-head.mjs +231 -0
- package/skills/resolve-release/scripts/green-head.test.mjs +101 -0
- package/skills/resolve-release/scripts/npm-version-absence.mjs +138 -0
- package/skills/resolve-release/scripts/npm-version-absence.test.mjs +426 -0
- package/skills/resolve-release/scripts/plan-npm.test.mjs +659 -0
- package/skills/resolve-release/scripts/plan-toml-boundary.test.mjs +317 -0
- package/skills/resolve-release/scripts/plan-uv.test.mjs +291 -0
- package/skills/resolve-release/scripts/plan.mjs +806 -0
- package/skills/resolve-release/scripts/plan.test.mjs +428 -0
- package/skills/rush-issues/LICENSE +3 -0
- package/skills/rush-issues/SKILL.md +58 -0
- package/skills/rush-issues/agents/openai.yaml +8 -0
- package/skills/rush-issues/rehydrate.mjs +10 -0
- package/skills/rush-issues/release-check.mjs +93 -0
- package/skills/rush-release/LICENSE +3 -0
- package/skills/rush-release/SKILL.md +35 -0
- package/skills/rush-release/agents/openai.yaml +8 -0
- package/skills/rush-release/release-check.mjs +93 -0
- package/skills/test-quality/LICENSE +3 -0
- package/skills/test-quality/SKILL.md +79 -0
- package/skills/test-quality/references/audit.md +80 -0
- package/skills/test-quality/references/lint.md +24 -0
- package/skills/test-quality/references/principles.md +143 -0
- package/skills/test-quality/references/testing-conventions.md +9 -0
- package/skills/test-quality/release-check.mjs +93 -0
- package/skills/test-quality/scripts/lint-tests.mjs +574 -0
- package/skills/test-quality/scripts/lint-tests.test.mjs +591 -0
- package/skills/test-quality/scripts/mock-policy-config.mjs +176 -0
- package/skills/test-quality/scripts/mock-policy-config.test.mjs +119 -0
- package/skills/test-quality/scripts/persist-conventions-core.mjs +117 -0
- package/skills/test-quality/scripts/persist-conventions.mjs +17 -0
- package/skills/test-quality/scripts/persist-conventions.test.mjs +104 -0
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
import { test } from 'node:test'
|
|
2
|
+
import assert from 'node:assert/strict'
|
|
3
|
+
import { mkdirSync, mkdtempSync, readFileSync, writeFileSync } from 'node:fs'
|
|
4
|
+
import { tmpdir } from 'node:os'
|
|
5
|
+
import { join } from 'node:path'
|
|
6
|
+
import { applyRelease, bumpPyproject, insertChangelog } from './apply.mjs'
|
|
7
|
+
|
|
8
|
+
test('insertChangelog cuts Unreleased and keeps handwritten notes', () => {
|
|
9
|
+
const before = `# Changelog\n\n## [Unreleased]\n\n- operator note\n\n## [1.0.0] - 2026-01-01\n`
|
|
10
|
+
const after = insertChangelog(before, {
|
|
11
|
+
version: '1.1.0',
|
|
12
|
+
date: '2026-08-24',
|
|
13
|
+
section: '## [1.1.0] - 2026-08-24\n\n### Added\n- export csv\n',
|
|
14
|
+
})
|
|
15
|
+
assert.match(after, /## \[Unreleased\]\n\n## \[1\.1\.0\] - 2026-08-24/)
|
|
16
|
+
assert.match(after, /export csv/)
|
|
17
|
+
assert.match(after, /operator note/)
|
|
18
|
+
assert.match(after, /## \[1\.0\.0\]/)
|
|
19
|
+
assert.equal((after.match(/## \[1\.1\.0\]/g) || []).length, 1)
|
|
20
|
+
})
|
|
21
|
+
|
|
22
|
+
test('insertChangelog is idempotent only when the recorded section is present', () => {
|
|
23
|
+
const section = '## [1.1.0] - 2026-08-24\n\n### Added\n- export csv'
|
|
24
|
+
const md = `# Changelog\n\n${section}\n`
|
|
25
|
+
assert.equal(insertChangelog(md, { version: '1.1.0', date: '2026-08-24', section }), md)
|
|
26
|
+
assert.throws(
|
|
27
|
+
() => insertChangelog(md, {
|
|
28
|
+
version: '1.1.0',
|
|
29
|
+
date: '2026-08-24',
|
|
30
|
+
section: '## [1.1.0] - 2026-08-24\n\n### Added\n- missing entry',
|
|
31
|
+
}),
|
|
32
|
+
/does not match the recorded plan/,
|
|
33
|
+
)
|
|
34
|
+
})
|
|
35
|
+
|
|
36
|
+
test('bumpPyproject replaces [project] version only', () => {
|
|
37
|
+
const text = '[build-system]\nrequires = ["setuptools"]\n\n[project]\nname = "demo"\nversion = "0.1.0"\n'
|
|
38
|
+
assert.match(bumpPyproject(text, '0.2.0'), /\[project\]\nname = "demo"\nversion = "0\.2\.0"/)
|
|
39
|
+
})
|
|
40
|
+
|
|
41
|
+
test('applyRelease writes changelog and identity files', () => {
|
|
42
|
+
const cwd = mkdtempSync(join(tmpdir(), 'rush-release-apply-'))
|
|
43
|
+
writeFileSync(join(cwd, 'package.json'), `${JSON.stringify({ name: 'demo', version: '1.2.0' }, null, 2)}\n`)
|
|
44
|
+
writeFileSync(join(cwd, 'package-lock.json'), `${JSON.stringify({ name: 'demo', version: '1.2.0', packages: { '': { name: 'demo', version: '1.2.0' } } }, null, 2)}\n`)
|
|
45
|
+
writeFileSync(join(cwd, 'VERSION'), '1.2.0\n')
|
|
46
|
+
writeFileSync(join(cwd, 'CHANGELOG.md'), '# Changelog\n\n## [Unreleased]\n\n')
|
|
47
|
+
const result = applyRelease({
|
|
48
|
+
version: '1.3.0',
|
|
49
|
+
date: '2026-08-24',
|
|
50
|
+
cwd,
|
|
51
|
+
changelogSection: '## [1.3.0] - 2026-08-24\n\n### Added\n- export csv\n',
|
|
52
|
+
})
|
|
53
|
+
assert.deepEqual(result.changed.sort(), ['CHANGELOG.md', 'VERSION', 'package-lock.json', 'package.json'])
|
|
54
|
+
assert.equal(JSON.parse(readFileSync(join(cwd, 'package.json'), 'utf8')).version, '1.3.0')
|
|
55
|
+
assert.equal(JSON.parse(readFileSync(join(cwd, 'package-lock.json'), 'utf8')).packages[''].version, '1.3.0')
|
|
56
|
+
assert.equal(readFileSync(join(cwd, 'VERSION'), 'utf8'), '1.3.0\n')
|
|
57
|
+
assert.match(readFileSync(join(cwd, 'CHANGELOG.md'), 'utf8'), /export csv/)
|
|
58
|
+
})
|
|
59
|
+
|
|
60
|
+
test('applyRelease refuses to discard the recorded plan changelog', () => {
|
|
61
|
+
assert.throws(
|
|
62
|
+
() => applyRelease({ version: '1.3.0', date: '2026-08-24' }),
|
|
63
|
+
/requires the recorded plan changelog/,
|
|
64
|
+
)
|
|
65
|
+
})
|
|
66
|
+
|
|
67
|
+
test('applyRelease delegates a distribution release without adding a version to the private root package', () => {
|
|
68
|
+
const cwd = mkdtempSync(join(tmpdir(), 'rush-release-distribution-apply-'))
|
|
69
|
+
mkdirSync(join(cwd, 'skills/distribution'), { recursive: true })
|
|
70
|
+
writeFileSync(join(cwd, 'package.json'), `${JSON.stringify({ name: 'private-root', private: true }, null, 2)}\n`)
|
|
71
|
+
writeFileSync(join(cwd, 'skills/distribution/manifest.json'), `${JSON.stringify({
|
|
72
|
+
releaseVersion: '0.19.0',
|
|
73
|
+
sources: [{ renderTargets: [{ id: 'private-checkout', revision: 'main' }] }],
|
|
74
|
+
}, null, 2)}\n`)
|
|
75
|
+
writeFileSync(join(cwd, 'CHANGELOG.md'), '# Changelog\n\n')
|
|
76
|
+
const calls = []
|
|
77
|
+
|
|
78
|
+
const result = applyRelease({
|
|
79
|
+
version: '0.19.1',
|
|
80
|
+
date: '2026-08-30',
|
|
81
|
+
cwd,
|
|
82
|
+
changelogSection: '## [0.19.1] - 2026-08-30\n\n### Changed\n- manual trigger only\n',
|
|
83
|
+
cutDistribution: (options) => {
|
|
84
|
+
calls.push(options)
|
|
85
|
+
return ['skills/distribution/manifest.json', 'skills/engineering/engineering-runtime/coherence/workflow.json']
|
|
86
|
+
},
|
|
87
|
+
})
|
|
88
|
+
|
|
89
|
+
assert.deepEqual(calls, [{ version: '0.19.1', cwd }])
|
|
90
|
+
assert.deepEqual(result.changed, [
|
|
91
|
+
'CHANGELOG.md',
|
|
92
|
+
'skills/distribution/manifest.json',
|
|
93
|
+
'skills/engineering/engineering-runtime/coherence/workflow.json',
|
|
94
|
+
])
|
|
95
|
+
assert.deepEqual(JSON.parse(readFileSync(join(cwd, 'package.json'), 'utf8')), {
|
|
96
|
+
name: 'private-root',
|
|
97
|
+
private: true,
|
|
98
|
+
})
|
|
99
|
+
})
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
// Dark launch: which flags ship switched off in this release, and are they still off live.
|
|
3
|
+
//
|
|
4
|
+
// Usage:
|
|
5
|
+
// node dark-flags.mjs list --registry <path> --sha <sha> [--base <tag>] [--json]
|
|
6
|
+
// node dark-flags.mjs check --flags <list.json> --observed <observed.json> [--json]
|
|
7
|
+
//
|
|
8
|
+
// A registry is JSON or YAML: { flags: { <name>: { default: false, description: "..." } } }.
|
|
9
|
+
// A flag ships dark when it is in the registry at <sha> but not at <base>, or when a commit
|
|
10
|
+
// in <base>..<sha> carries a `Dark-Launch: <name>` trailer.
|
|
11
|
+
//
|
|
12
|
+
// Exit: 0 ok · 1 invalid registry / flag not off / git failed · 2 usage
|
|
13
|
+
import { readFileSync } from 'node:fs'
|
|
14
|
+
import { spawnSync } from 'node:child_process'
|
|
15
|
+
import { isMainModule } from '../../engineering-runtime/scripts/main-module.mjs'
|
|
16
|
+
import { parseYamlMapping } from '../../engineering-runtime/scripts/yaml-mapping.mjs'
|
|
17
|
+
|
|
18
|
+
const OFF_VALUES = new Set([false, 0, 'off', 'false', 'disabled', '0'])
|
|
19
|
+
|
|
20
|
+
export function isOff(value) {
|
|
21
|
+
return OFF_VALUES.has(typeof value === 'string' ? value.trim().toLowerCase() : value)
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
export function parseRegistry(text, label = 'flag registry') {
|
|
25
|
+
const root = parseYamlMapping(text, label)
|
|
26
|
+
const flags = root.flags
|
|
27
|
+
if (!flags || typeof flags !== 'object' || Array.isArray(flags)) throw new Error(`${label} needs a "flags" mapping`)
|
|
28
|
+
for (const [name, entry] of Object.entries(flags)) {
|
|
29
|
+
if (!entry || typeof entry !== 'object' || !('default' in entry)) throw new Error(`${label}: flag ${name} needs a default`)
|
|
30
|
+
}
|
|
31
|
+
return flags
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
export function darkFlags({ registryAtSha, registryAtBase = {}, trailerNames = [] }) {
|
|
35
|
+
const errors = []
|
|
36
|
+
const names = new Set(Object.keys(registryAtSha).filter((name) => !(name in registryAtBase)))
|
|
37
|
+
for (const name of trailerNames) {
|
|
38
|
+
if (!(name in registryAtSha)) errors.push(`Dark-Launch trailer names ${name}, which is not in the flag registry`)
|
|
39
|
+
else names.add(name)
|
|
40
|
+
}
|
|
41
|
+
const flags = [...names].sort().map((name) => {
|
|
42
|
+
const entry = registryAtSha[name]
|
|
43
|
+
const summary = String(entry.description || name).trim()
|
|
44
|
+
if (!isOff(entry.default)) errors.push(`flag ${name} ships with default ${JSON.stringify(entry.default)}; a dark flag defaults to off`)
|
|
45
|
+
return { name, summary, default: entry.default }
|
|
46
|
+
})
|
|
47
|
+
return { flags, errors }
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
export function checkLive(flags, observed) {
|
|
51
|
+
const failures = []
|
|
52
|
+
for (const { name } of flags) {
|
|
53
|
+
if (!(name in observed)) failures.push(`${name}: no live reading`)
|
|
54
|
+
else if (!isOff(observed[name])) failures.push(`${name}: live value ${JSON.stringify(observed[name])} is not off`)
|
|
55
|
+
}
|
|
56
|
+
return { ok: failures.length === 0, failures }
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
function git(args, cwd, allowFail = false) {
|
|
60
|
+
const result = spawnSync('git', args, { encoding: 'utf8', cwd })
|
|
61
|
+
if (result.status !== 0) {
|
|
62
|
+
if (allowFail) return null
|
|
63
|
+
const err = new Error(result.stderr.trim() || `git ${args.join(' ')} failed`)
|
|
64
|
+
err.exitCode = 1
|
|
65
|
+
throw err
|
|
66
|
+
}
|
|
67
|
+
return result.stdout
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
export function listDarkFlags({ registry, sha, base = null, cwd = process.cwd() }) {
|
|
71
|
+
const atSha = git(['show', `${sha}:${registry}`], cwd, true)
|
|
72
|
+
if (atSha === null) {
|
|
73
|
+
const err = new Error(`flag registry ${registry} does not exist at ${sha}`)
|
|
74
|
+
err.exitCode = 1
|
|
75
|
+
throw err
|
|
76
|
+
}
|
|
77
|
+
const atBase = base ? git(['show', `${base}:${registry}`], cwd, true) : null
|
|
78
|
+
const range = base ? `${base}..${sha}` : sha
|
|
79
|
+
const trailerNames = git(['log', range, '--format=%(trailers:key=Dark-Launch,valueonly,separator=%x0a)'], cwd)
|
|
80
|
+
.split('\n').map((line) => line.trim()).filter(Boolean)
|
|
81
|
+
return darkFlags({
|
|
82
|
+
registryAtSha: parseRegistry(atSha, `${registry}@${sha}`),
|
|
83
|
+
registryAtBase: atBase === null ? {} : parseRegistry(atBase, `${registry}@${base}`),
|
|
84
|
+
trailerNames: [...new Set(trailerNames)],
|
|
85
|
+
})
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
function usage(message) {
|
|
89
|
+
const err = new Error(message)
|
|
90
|
+
err.exitCode = 2
|
|
91
|
+
return err
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
function parseArgs(argv) {
|
|
95
|
+
const [command, ...rest] = argv
|
|
96
|
+
const opts = { command, json: false }
|
|
97
|
+
for (let i = 0; i < rest.length; i += 1) {
|
|
98
|
+
const arg = rest[i]
|
|
99
|
+
if (arg === '--json') opts.json = true
|
|
100
|
+
else if (['--registry', '--sha', '--base', '--flags', '--observed'].includes(arg)) {
|
|
101
|
+
if (rest[i + 1] === undefined) throw usage(`${arg} needs a value`)
|
|
102
|
+
opts[arg.slice(2)] = rest[++i]
|
|
103
|
+
} else throw usage(`unknown argument: ${arg}`)
|
|
104
|
+
}
|
|
105
|
+
if (command === 'list' && (!opts.registry || !opts.sha)) throw usage('list needs --registry and --sha')
|
|
106
|
+
if (command === 'check' && (!opts.flags || !opts.observed)) throw usage('check needs --flags and --observed')
|
|
107
|
+
if (!['list', 'check'].includes(command)) throw usage('usage: dark-flags.mjs list|check [options]')
|
|
108
|
+
return opts
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
export function main(argv = process.argv.slice(2), { cwd = process.cwd() } = {}) {
|
|
112
|
+
const opts = parseArgs(argv)
|
|
113
|
+
if (opts.command === 'list') {
|
|
114
|
+
const result = listDarkFlags({ registry: opts.registry, sha: opts.sha, base: opts.base || null, cwd })
|
|
115
|
+
process.stdout.write(opts.json
|
|
116
|
+
? `${JSON.stringify(result, null, 2)}\n`
|
|
117
|
+
: `${result.flags.map((flag) => `${flag.name}: ${flag.summary}`).join('\n') || 'no dark flags'}\n${result.errors.map((e) => `error: ${e}`).join('\n')}`)
|
|
118
|
+
return result.errors.length ? 1 : 0
|
|
119
|
+
}
|
|
120
|
+
const listed = JSON.parse(readFileSync(opts.flags, 'utf8'))
|
|
121
|
+
const flags = Array.isArray(listed) ? listed : listed.flags
|
|
122
|
+
const result = checkLive(flags, JSON.parse(readFileSync(opts.observed, 'utf8')))
|
|
123
|
+
process.stdout.write(opts.json ? `${JSON.stringify(result, null, 2)}\n` : `${result.ok ? 'all dark flags off' : result.failures.join('\n')}\n`)
|
|
124
|
+
return result.ok ? 0 : 1
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
if (isMainModule(import.meta.url)) {
|
|
128
|
+
try {
|
|
129
|
+
process.exitCode = main()
|
|
130
|
+
} catch (error) {
|
|
131
|
+
process.stderr.write(`${error.message}\n`)
|
|
132
|
+
process.exitCode = error.exitCode || 1
|
|
133
|
+
}
|
|
134
|
+
}
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
import { test } from 'node:test'
|
|
2
|
+
import assert from 'node:assert/strict'
|
|
3
|
+
import { mkdirSync, mkdtempSync, writeFileSync } from 'node:fs'
|
|
4
|
+
import { tmpdir } from 'node:os'
|
|
5
|
+
import { join } from 'node:path'
|
|
6
|
+
import { spawnSync } from 'node:child_process'
|
|
7
|
+
import { checkLive, darkFlags, isOff, listDarkFlags, parseRegistry } from './dark-flags.mjs'
|
|
8
|
+
|
|
9
|
+
const SCRIPT = join(import.meta.dirname, 'dark-flags.mjs')
|
|
10
|
+
|
|
11
|
+
function git(cwd, args) {
|
|
12
|
+
const result = spawnSync('git', args, { cwd, encoding: 'utf8' })
|
|
13
|
+
assert.equal(result.status, 0, result.stderr)
|
|
14
|
+
return result.stdout
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
function registry(cwd, flags) {
|
|
18
|
+
writeFileSync(join(cwd, 'config', 'flags.json'), `${JSON.stringify({ flags }, null, 2)}\n`)
|
|
19
|
+
git(cwd, ['add', 'config/flags.json'])
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
function repo() {
|
|
23
|
+
const cwd = mkdtempSync(join(tmpdir(), 'resolve-release-dark-'))
|
|
24
|
+
git(cwd, ['init', '-b', 'main'])
|
|
25
|
+
git(cwd, ['config', 'user.email', 'dev@example.com'])
|
|
26
|
+
git(cwd, ['config', 'user.name', 'Dev'])
|
|
27
|
+
git(cwd, ['config', 'commit.gpgsign', 'false'])
|
|
28
|
+
mkdirSync(join(cwd, 'config'))
|
|
29
|
+
registry(cwd, { 'old-search': { default: true, description: 'Search (launched)' } })
|
|
30
|
+
git(cwd, ['commit', '-m', 'chore: init'])
|
|
31
|
+
git(cwd, ['tag', 'v1.0.0'])
|
|
32
|
+
return cwd
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
test('off means off, and nothing else does', () => {
|
|
36
|
+
for (const value of [false, 0, 'off', 'OFF', 'false', 'disabled', '0']) assert.equal(isOff(value), true, String(value))
|
|
37
|
+
for (const value of [true, 1, 'on', 'true', 'enabled', null, undefined, '']) assert.equal(isOff(value), false, String(value))
|
|
38
|
+
})
|
|
39
|
+
|
|
40
|
+
test('a registry needs a flags mapping and a default per flag', () => {
|
|
41
|
+
assert.throws(() => parseRegistry('{"flags": []}'), /"flags" mapping/)
|
|
42
|
+
assert.throws(() => parseRegistry('flags:\n x: {description: y}\n'), /flag x needs a default/)
|
|
43
|
+
assert.deepEqual(Object.keys(parseRegistry('flags:\n x: {default: off}\n')), ['x'])
|
|
44
|
+
})
|
|
45
|
+
|
|
46
|
+
test('new registry entries and Dark-Launch trailers ship dark; each must default off', () => {
|
|
47
|
+
const result = darkFlags({
|
|
48
|
+
registryAtBase: { launched: { default: true } },
|
|
49
|
+
registryAtSha: {
|
|
50
|
+
launched: { default: true },
|
|
51
|
+
'bulk-refunds': { default: false, description: 'Bulk refunds' },
|
|
52
|
+
'new-nav': { default: 'on' },
|
|
53
|
+
},
|
|
54
|
+
trailerNames: ['launched', 'ghost'],
|
|
55
|
+
})
|
|
56
|
+
assert.deepEqual(result.flags.map((flag) => flag.name), ['bulk-refunds', 'launched', 'new-nav'])
|
|
57
|
+
assert.equal(result.flags[0].summary, 'Bulk refunds')
|
|
58
|
+
assert.deepEqual(result.errors.sort(), [
|
|
59
|
+
'Dark-Launch trailer names ghost, which is not in the flag registry',
|
|
60
|
+
'flag launched ships with default true; a dark flag defaults to off',
|
|
61
|
+
'flag new-nav ships with default "on"; a dark flag defaults to off',
|
|
62
|
+
])
|
|
63
|
+
})
|
|
64
|
+
|
|
65
|
+
test('the live check fails on a flag that is on or unread', () => {
|
|
66
|
+
const flags = [{ name: 'a' }, { name: 'b' }, { name: 'c' }]
|
|
67
|
+
assert.deepEqual(checkLive(flags, { a: false, b: 'off', c: 0 }), { ok: true, failures: [] })
|
|
68
|
+
assert.deepEqual(checkLive(flags, { a: false, b: 'on' }).failures, ['b: live value "on" is not off', 'c: no live reading'])
|
|
69
|
+
})
|
|
70
|
+
|
|
71
|
+
test('listing reads the registry at both refs and the trailers in between', () => {
|
|
72
|
+
const cwd = repo()
|
|
73
|
+
registry(cwd, {
|
|
74
|
+
'old-search': { default: true, description: 'Search (launched)' },
|
|
75
|
+
'bulk-refunds': { default: false, description: 'Bulk refunds' },
|
|
76
|
+
})
|
|
77
|
+
git(cwd, ['commit', '-m', 'feat: bulk refunds\n\nDark-Launch: bulk-refunds'])
|
|
78
|
+
const result = listDarkFlags({ registry: 'config/flags.json', sha: 'HEAD', base: 'v1.0.0', cwd })
|
|
79
|
+
assert.deepEqual(result, { flags: [{ name: 'bulk-refunds', summary: 'Bulk refunds', default: false }], errors: [] })
|
|
80
|
+
|
|
81
|
+
const cli = spawnSync('node', [SCRIPT, 'list', '--registry', 'config/flags.json', '--sha', 'HEAD', '--base', 'v1.0.0', '--json'], { cwd, encoding: 'utf8' })
|
|
82
|
+
assert.equal(cli.status, 0, cli.stderr)
|
|
83
|
+
assert.equal(JSON.parse(cli.stdout).flags[0].name, 'bulk-refunds')
|
|
84
|
+
|
|
85
|
+
const missing = spawnSync('node', [SCRIPT, 'list', '--registry', 'nope.json', '--sha', 'HEAD'], { cwd, encoding: 'utf8' })
|
|
86
|
+
assert.equal(missing.status, 1)
|
|
87
|
+
assert.match(missing.stderr, /does not exist at HEAD/)
|
|
88
|
+
})
|
|
89
|
+
|
|
90
|
+
test('the check CLI exits non-zero when a dark flag is live', () => {
|
|
91
|
+
const cwd = mkdtempSync(join(tmpdir(), 'resolve-release-dark-check-'))
|
|
92
|
+
writeFileSync(join(cwd, 'list.json'), JSON.stringify({ flags: [{ name: 'bulk-refunds', summary: 'Bulk refunds' }] }))
|
|
93
|
+
writeFileSync(join(cwd, 'off.json'), JSON.stringify({ 'bulk-refunds': false }))
|
|
94
|
+
writeFileSync(join(cwd, 'on.json'), JSON.stringify({ 'bulk-refunds': true }))
|
|
95
|
+
const check = (observed) => spawnSync('node', [SCRIPT, 'check', '--flags', 'list.json', '--observed', observed], { cwd, encoding: 'utf8' })
|
|
96
|
+
assert.equal(check('off.json').status, 0)
|
|
97
|
+
const live = check('on.json')
|
|
98
|
+
assert.equal(live.status, 1)
|
|
99
|
+
assert.match(live.stdout, /bulk-refunds: live value true is not off/)
|
|
100
|
+
})
|