3.8 KiB
3.8 KiB
Tasks — @suaveplan/api-secrets-env
Every checkbox MUST reflect work actually done in this change.
0. Pre-flight (non-negotiable)
- 0.1 Confirm clean working tree (
git statusreports nothing) and no in-flight worktrees with uncommitted work (git worktree listthengit statusin each) - 0.2 If any worktrees exist under
.claude/worktrees/, account for each one: still-active agent, work-pending-merge, or stale-and-prune. Stale worktrees MUST be removed (git worktree remove) before opening a new one — code that has been lost twice on main is the failure mode this guards against. - 0.3 Confirm the package set in
MANIFEST.mdmatchesfind packages -maxdepth 3 -name package.jsoncount. Drift here means a prior change archived without regenerating the manifest.
1. Spec authoring
- 1.1 Read design doc (§3, §4, §5.2a, §12.2, §13.4)
- 1.2 Read
openspec/changes/api-secrets/for upstream contract - 1.3 Read
openspec/AGENTS.mdSections 13 and 14 - 1.4 Draft
proposal.md - 1.5 Draft
specs/api-secrets-env/spec.md - 1.6 Every requirement carries
**Verified by:**
2. Implementation
- 2.1 Scaffold
packages/api/api-secrets-env/(deps: api-secrets, api-types, api-worker-rpc, error, data-masking, zod) - 2.2
src/options/env-secrets-options.ts— Zod schema - 2.3
src/factory/create-env-secrets.ts— direct surface; Bun.env → process.env fallback - 2.4
src/proxy/create-env-secrets-worker-proxy.ts— proxy surface; worker never reads env directly - 2.5
src/manifest-validation/validate-against-manifest.ts— fail-fast checker - 2.6
src/redaction/redaction.ts— wires@suaveplan/data-maskingfor log/error output - 2.7
src/error-codes.ts—SECRETS_ENV_*codes viadefineCodes - 2.8
src/index.ts— explicit named re-exports
3. Tests
- 3.1
src/factory/create-env-secrets.test.ts - 3.2
src/factory/create-env-secrets.spec-conformance.test.ts— direct conformance - 3.3
src/proxy/create-env-secrets-worker-proxy.test.ts - 3.4
src/proxy/create-env-secrets-worker-proxy.spec-conformance.test.ts— proxy conformance - 3.5
src/manifest-validation/validate-against-manifest.test.ts - 3.6
src/redaction/redaction.test.ts - 3.7 Every
it(...)carries{ timeout: 5000 }
4. Documentation
- 4.1 Sibling
.mdper implementation.ts - 4.2 README documents the fail-fast contract and the
prefixpattern for namespacing - 4.3 README explicitly says: "values never appear in logs/errors — only names"
5. Pre-archive verification (5-gate triple)
- 5.1
bun run check— clean - 5.2
bunx turbo lint typecheck test --filter=@suaveplan/api-secrets-env— green - 5.3
bunx turbo test:coverage --filter=@suaveplan/api-secrets-env— 100/100/100/100 - 5.4
bun scripts/openspec-conformance.ts @suaveplan/api-secrets-env— exit 0 - 5.5
bunx turbo build --filter=@suaveplan/api-secrets-env— green
6. Pre-archive 7-row checklist
- 6.1
expectTypeOfassertsget(name)returnsstring | undefined - 6.2 Zod schema at
EnvSecretsOptionsboundary AND at manifest validation - 6.3 Every
SECRETS_ENV_*code thrown by at least one production path - 6.4 Strict-mode (
caseSensitiveon/off) tested both ways - 6.5 OTel instruments (
api.secrets.get_total{source=env,outcome}, names only — never values) asserted with in-memoryMeterProvider - 6.6 Manifest validation dedup tested (running twice with identical manifest produces identical outcome)
- 6.7 No retroactive tick
7. Archive
- 7.1 Fold into
openspec/specs/api-secrets-env/spec.md - 7.2 Move to
openspec/archive/<yyyy-mm-dd>-api-secrets-env/ - 7.3 Tick Stage 4 box in umbrella tasks
- 7.4 Refresh
MANIFEST.md