From 04698631ebbd90b40223cd884a7bb659884f1dcb Mon Sep 17 00:00:00 2001 From: Saravana Achu Mac Date: Mon, 4 May 2026 16:32:22 -0700 Subject: [PATCH] docs(audit): mark config warning sweep --- docs/AUDIT_PLATFORM.md | 22 ++++++------ docs/AUDIT_WARNING_COMPLETION_CHECKLIST.md | 41 +++++++++++++--------- docs/HANDOVER.md | 15 ++++---- 3 files changed, 42 insertions(+), 36 deletions(-) diff --git a/docs/AUDIT_PLATFORM.md b/docs/AUDIT_PLATFORM.md index 883024bd..b7c2d6b4 100644 --- a/docs/AUDIT_PLATFORM.md +++ b/docs/AUDIT_PLATFORM.md @@ -17,7 +17,7 @@ Legend: ๐Ÿ”ด critical ยท ๐ŸŸ  high ยท ๐ŸŸก medium ยท ๐ŸŸข low ยท | `pnpm install -r` | โœ… pass | No warnings when `GITEA_NPM_TOKEN` is exported after sourcing `~/.zshrc`. | | `pnpm typecheck` | โœ… pass | All TS sources compile (`tsc --noEmit`). | | `pnpm test` | โœ… pass | ~2,200 tests across 18+ test suites; one cowork-service `EPIPE` flake cleared on focused rerun. | -| `pnpm lint` | โœ… pass | Workspace lint exits 0 with 0 errors / 157 warnings after `1089597`. See section W. | +| `pnpm lint` | โœ… pass | Workspace lint exits 0 with 0 errors / 155 warnings after `5b0fbc2`. See section W. | ## A. Lint pipeline blockers (fixed by this audit) @@ -57,7 +57,7 @@ The stale handoff note expected 85 pre-existing errors, but a live rerun on Remaining lint output is warnings only. The largest groups are still `no-console` in CLI tools, code generators, and diagnostic/runtime review areas -(`create-app`, `keyvault`, `sidecar-monitor`, platform `gen-module`, +(`create-app`, `sidecar-monitor`, platform `gen-module`, `migrate-referrals`, push notifications, and diagnostics modules). These are case-by-case judgment calls and not blocking. @@ -71,19 +71,21 @@ Follow-up package sweeps on 2026-05-04: deep-link diagnostics with narrow lint justifications. - `1089597` cleared the remaining admin-web React hook/image/unused-symbol warnings. +- `5b0fbc2` documented intentional `@bytelyst/config` Key Vault startup + diagnostics with narrow lint justifications. -Post-admin sweep verification reran admin-web lint/typecheck/test/build and -workspace lint; all pass. Workspace lint remains at **0 errors** with **157 +Post-config sweep verification reran config build/test/lint and workspace lint; +all pass. Workspace lint remains at **0 errors** with **155 warnings**. ## R. Repo-state observations (not fixed) -| # | Observation | Severity | Status | -| --- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------: | :----------------: | -| R1 | Working tree had 3 uncommitted edits when the audit started: `docker-compose.ecosystem.yml` (removes `nomgap-web` from Docker), `products/nomgap/product.json` (replaces flag set + adds containers), `services/platform-service/src/modules/flags/seed.ts` (+14 lines of flags). These look like an in-progress nomgap-on-Vercel migration. **Not touched** โ€” out of audit scope and missing context. | โ€” | โฌœ | -| R2 | Local `main` was 17 commits behind `origin/main` at the start of the session. Backup branch `backup/main-20260504-062733` was taken from `origin/main` (the source of truth) โ€” local stale main was _not_ backed up. | ๐ŸŸข | โœ… (backup exists) | -| R3 | `.npmrc` references `${GITEA_NPM_TOKEN}`. On this machine `~/.zshrc` defines the token but does not export it, so use `source ~/.zshrc && export GITEA_NPM_TOKEN` before `pnpm`; this silences the WARN. | ๐ŸŸข | โœ… documented | -| R4 | Earlier `pnpm install -r` reported peer warnings for `@azure/core-client@^1.10.0`. A live rerun with the token exported reported no peer warnings. | ๐ŸŸข | โœ… verified | +| # | Observation | Severity | Status | +| --- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------: | :----------------: | +| R1 | Working tree had 3 uncommitted edits when the audit started: `docker-compose.ecosystem.yml`, `products/nomgap/product.json`, and `services/platform-service/src/modules/flags/seed.ts`. These were finalized separately in `b440330` (`chore(nomgap): finalize product deployment config`). Current working tree is clean after `5b0fbc2`. | โ€” | โœ… | +| R2 | Local `main` was 17 commits behind `origin/main` at the start of the session. Backup branch `backup/main-20260504-062733` was taken from `origin/main` (the source of truth) โ€” local stale main was _not_ backed up. | ๐ŸŸข | โœ… (backup exists) | +| R3 | `.npmrc` references `${GITEA_NPM_TOKEN}`. On this machine `~/.zshrc` defines the token but does not export it, so use `source ~/.zshrc && export GITEA_NPM_TOKEN` before `pnpm`; this silences the WARN. | ๐ŸŸข | โœ… documented | +| R4 | Earlier `pnpm install -r` reported peer warnings for `@azure/core-client@^1.10.0`. A live rerun with the token exported reported no peer warnings. | ๐ŸŸข | โœ… verified | --- diff --git a/docs/AUDIT_WARNING_COMPLETION_CHECKLIST.md b/docs/AUDIT_WARNING_COMPLETION_CHECKLIST.md index a1aeefb5..eb9f1d26 100644 --- a/docs/AUDIT_WARNING_COMPLETION_CHECKLIST.md +++ b/docs/AUDIT_WARNING_COMPLETION_CHECKLIST.md @@ -14,13 +14,13 @@ by accident. As of the latest local sweep: -| Gate | Current state | Notes | -| ---------------------------------- | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `pnpm install -r --prefer-offline` | Pass | Run with `source ~/.zshrc && export GITEA_NPM_TOKEN`. | -| `pnpm typecheck` | Pass | All workspace TypeScript compiles. | -| `pnpm test` | Pass with known load sensitivity | Full suite passes; isolated reruns cleared prior transient platform/cowork timeouts. | -| `pnpm lint` | Pass | `0` errors. Latest lint rerun after `1089597`: `157` warnings. | -| Known untouched WIP | Present | Do not touch `docker-compose.ecosystem.yml`, `products/nomgap/product.json`, `services/platform-service/src/modules/flags/seed.ts`, or incidental `pnpm-lock.yaml` churn unless explicitly assigned. | +| Gate | Current state | Notes | +| ---------------------------------- | -------------------------------- | ----------------------------------------------------------------------------------------------------------------- | +| `pnpm install -r --prefer-offline` | Pass | Run with `source ~/.zshrc && export GITEA_NPM_TOKEN`. | +| `pnpm typecheck` | Pass | All workspace TypeScript compiles. | +| `pnpm test` | Pass with known load sensitivity | Full suite passes; isolated reruns cleared prior transient platform/cowork timeouts. | +| `pnpm lint` | Pass | `0` errors. Latest lint rerun after `5b0fbc2`: `155` warnings. | +| Known untouched WIP | Clear | Prior nomgap deployment WIP was finalized separately in `b440330`; current working tree is clean after `5b0fbc2`. | Recent warning-cleanup commits: @@ -36,6 +36,7 @@ Recent warning-cleanup commits: | `04d2398` | `@bytelyst/tracker-web` | Removed roadmap console/module warnings. | | `5fb4921` | `@bytelyst/broadcast-client` | Documented deep-link diagnostics. | | `1089597` | `@bytelyst/admin-web` | Cleared remaining W2 dashboard warnings. | +| `5b0fbc2` | `@bytelyst/config` | Documented Key Vault diagnostics. | ## Agent Execution Protocol @@ -58,11 +59,9 @@ checklist. ``` - [ ] Confirm `pnpm lint` exits `0`. -- [ ] Confirm the only pre-existing uncommitted files are still: - - `docker-compose.ecosystem.yml` - - `products/nomgap/product.json` - - `services/platform-service/src/modules/flags/seed.ts` - - `pnpm-lock.yaml` +- [ ] Confirm the working tree is clean before editing. The prior nomgap WIP + files were finalized in `b440330`; if they are dirty again, treat that as + new work and do not include them in warning-sweep commits. - [ ] Pick one unchecked workstream item or one coherent group of adjacent items. - [ ] Add your in-progress marker in the table below before editing, using @@ -391,7 +390,13 @@ behavior, CLI output, or noise. `pnpm --filter @bytelyst/broadcast-client test`, `pnpm --filter @bytelyst/broadcast-client exec eslint . --ext .ts,.tsx`, `pnpm typecheck`, `pnpm test`, and `pnpm lint`. -- [ ] `packages/config/src/keyvault.ts`: review console usage. +- [x] `packages/config/src/keyvault.ts`: review console usage. Done in + `5b0fbc2`; warning delta `-2`; retained startup Key Vault fallback + diagnostics with narrow lint justifications and verified with + `pnpm --filter @bytelyst/config build`, + `pnpm --filter @bytelyst/config test`, + `pnpm --filter @bytelyst/config exec eslint . --ext .ts,.tsx`, and + `pnpm lint`. - [ ] `packages/create-app/src/generators/agents-md.ts`: classify as generator/CLI. - [ ] `packages/create-app/src/generators/api-routes.ts`: classify as @@ -473,10 +478,11 @@ Goal: keep future agents aligned with the true baseline. `/tmp/lint-*.log` path and warning count. Post-agent reconciliation reran `pnpm lint`; current baseline is `0` errors / `173` warnings. - [x] Include commit hashes in this checklist for every completed batch. The - current completed batch set is `db4257f`, `021f053`, `04d2398`, and - `5fb4921`. -- [ ] Keep "do not touch nomgap WIP" instructions visible until those files are - resolved by their owner. + current completed batch set is `db4257f`, `021f053`, `04d2398`, + `5fb4921`, `1089597`, and `5b0fbc2`. +- [x] Keep "do not touch nomgap WIP" instructions visible until those files are + resolved by their owner. Done after `b440330`; nomgap deployment config + is now committed and the working tree is clean. ## Suggested Next 25 Concrete Tasks @@ -520,3 +526,4 @@ Goal: keep future agents aligned with the true baseline. | 2026-05-04 | `04d2398` | Cleared tracker-web roadmap lint warnings. | Removed 5 workspace warnings; tracker scoped lint is 0 warnings. | | 2026-05-04 | `5fb4921` | Documented broadcast deep-link diagnostics. | Removed 2 no-console warnings; workspace lint `176` -> `174`. | | 2026-05-04 | `1089597` | Cleared remaining admin-web W2 warnings. | Removed 16 admin-web warnings; workspace lint `173` -> `157`. | +| 2026-05-04 | `5b0fbc2` | Documented config Key Vault diagnostics. | Removed 2 no-console warnings; workspace lint `157` -> `155`. | diff --git a/docs/HANDOVER.md b/docs/HANDOVER.md index cb26a6ba..9458ab0f 100644 --- a/docs/HANDOVER.md +++ b/docs/HANDOVER.md @@ -12,7 +12,7 @@ A tooling-backed audit was performed across all 69 workspace packages. `pnpm install / typecheck / lint` pass cleanly on the current workspace. `pnpm lint` was previously failing fast at one package, but a structural eslint config fix + 13 mechanical lint fixes made the lint pipeline run end-to-end. -A fresh rerun on 2026-05-04 shows **0 lint errors / 157 warnings**; the old +A fresh rerun on 2026-05-04 shows **0 lint errors / 155 warnings**; the old 85-error P-sweep handoff is stale. --- @@ -25,7 +25,7 @@ A fresh rerun on 2026-05-04 shows **0 lint errors / 157 warnings**; the old | `pnpm typecheck` | โœ… pass | All 69 packages compile | | `pnpm test` | โœ… pass | ~2,200 tests; cowork-service `EPIPE` flake cleared on focused rerun | | `pnpm lint` (pipeline) | โœ… runs end-to-end | Was bailing fast; this audit unblocked it | -| `pnpm lint` (errors) | โœ… 0 | 157 warnings remain โ€” see `docs/AUDIT_PLATFORM.md` section W | +| `pnpm lint` (errors) | โœ… 0 | 155 warnings remain โ€” see `docs/AUDIT_PLATFORM.md` section W | --- @@ -46,17 +46,14 @@ The audit session's tooling runs all relied on this being sourced. ### 2. Working tree state at handover -Three files are uncommitted and **were intentionally left alone** by the -audit โ€” they're an in-progress nomgap-on-Vercel migration by another -contributor: +The nomgap deployment edits that were previously uncommitted were finalized in +`b440330` (`chore(nomgap): finalize product deployment config`): - `docker-compose.ecosystem.yml` โ€” removes `nomgap-web` from the Docker stack - `products/nomgap/product.json` โ€” replaces flag set, restructures containers - `services/platform-service/src/modules/flags/seed.ts` โ€” adds 14 lines of seed flags -Plus `pnpm-lock.yaml` regenerated by the audit's `pnpm install -r` run -(+2,938/-8,520 lines โ€” large but expected). **Don't commit the lockfile -without inspecting it** โ€” it likely upgraded transitive versions. +The current working tree is clean after `5b0fbc2`. ### 3. The audit doc is the source of truth @@ -68,7 +65,7 @@ without inspecting it** โ€” it likely upgraded transitive versions. feedback warnings (`db4257f`), predictive campaign event typing (`021f053`), tracker roadmap/config warnings (`04d2398`), and broadcast-client deep-link diagnostics (`5fb4921`). The remaining admin-web W2 warnings were cleared in - `1089597`. + `1089597`, and config Key Vault diagnostics were documented in `5b0fbc2`. - **Section R** (housekeeping): token export and peer-warning observations are documented/verified. For the live warning checklist and parallel-agent workflow, use