Commit Graph

2 Commits

Author SHA1 Message Date
diegosouzapw
6991024935 Merge FASE 2: env audit
Resolves conflict in scripts/check/check-env-doc-sync.mjs (FASE 1 moved it from scripts/ to scripts/check/, FASE 2 modified it at the old path). Applies FASE 2's strict checker version at the new path, fixes __dirname-based REPO_ROOT to traverse two levels up, and updates the unit test import to the new path.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-13 16:02:44 -03:00
diegosouzapw
b43ab4d4c3 test(env): make check-env-doc-sync strict + unit test
Rewrites scripts/check-env-doc-sync.mjs so the default mode is strict
(non-zero exit on drift between code references, .env.example, and
docs/ENVIRONMENT.md). The previous "report-only" behavior is still
available via --lenient for ad-hoc local diagnostics.

Highlights:

- Strict mode fails when any of these three sets is non-empty:
    1. process.env vars referenced in src/, open-sse/, bin/, scripts/,
       electron/main.js, electron/preload.js but missing from
       .env.example.
    2. .env.example vars missing from docs/ENVIRONMENT.md.
    3. docs/ENVIRONMENT.md vars missing from .env.example.
- Allowlists are explicit and curated:
    * `IGNORE_FROM_CODE` — system vars (NODE_ENV, PATH, ...), Next.js
      internals, CI runner injections, doctor placeholders, and aliases
      handled by fallback ordering.
    * `DOC_ONLY_ALLOWLIST` — vars intentionally documented in
      ENVIRONMENT.md but absent from .env.example (Audit section,
      legacy aliases, future-supported hooks, `CHANGEME` default value).
    * `ENV_ONLY_ALLOWLIST` — reserved for future use; currently empty.
- The checker now exposes a programmatic `runEnvDocSync({ envExampleText,
  envDocText, codeVars, ignore, docOnlyAllowlist, envOnlyAllowlist })`
  entry point that other Node tests can import without touching disk.
  Helpers `parseEnvExampleVars` and `parseEnvDocVars` are exported so
  fixtures can validate the regex contract.

Test coverage in tests/unit/check-env-doc-sync.test.ts (13 cases):

- Parses env.example assignments (commented and uncommented), rejects
  prose, and rejects backtick literals that aren't SHOUTY env names.
- Drives runEnvDocSync against in-memory fixtures for every drift
  direction (code-missing-env, env-missing-doc, doc-missing-env) and
  asserts the allowlists / ignore set behave as expected.
- Calls runEnvDocSync() with no overrides to assert the live
  .env.example, docs/ENVIRONMENT.md and source-code references stay in
  sync. This is the same check that runs in pre-commit / CI, so the
  unit-test failure surfaces drift before reviewers do.

.env.example: documents `AWS_REGION` and `AWS_DEFAULT_REGION` so
Bedrock/Kiro/audio-speech callers stay in the contract.

docs/ENVIRONMENT.md: adds rows for AWS_REGION / AWS_DEFAULT_REGION
inside §20 Provider-Specific Settings.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-13 12:11:01 -03:00