Skip to content

chore: remove internal references from comments and metadata - #705

Open
nik13 wants to merge 2 commits into
devfrom
chore/spec-metadata-cleanup
Open

nik13 wants to merge 2 commits into
devfrom
chore/spec-metadata-cleanup

Conversation

@nik13

@nik13 nik13 commented Nov 13, 2026

Copy link
Copy Markdown
Contributor

What does this PR do?

Removes internal references from comments and metadata in the auto-instrumentation spec and its copies, and adds a check that fails if an absolute local path (/Volumes/ or /Users/) appears in the spec folder or in the two shipped copies of the privacy catalog. No behaviour change.

Why?

Such references do not belong in a public repository.

How was it tested?

Run in a clean Linux sandbox, at the base commit and at this branch:

  • The new path check fails on the tests-only commit and passes at the head of this branch.
  • @traceai/fi-core: the same 2,313 test ids run on both sides with the same outcomes. The only difference is 7 test titles renamed in round6.test.ts, which pass on both sides.
  • @traceai/auto: the only difference between the two sides is the new path check, which passes.
  • The catalog copies stay byte-identical (spec/auto-instrumentation/sync.py passes on both sides).

The launcher bundle did not build in that sandbox, at the base and at this branch alike, so the launcher tests that need it could not run there. This pull request's own checks run the real job.

  • Unit tests added / updated (pytest or vitest)
  • Integration tests pass (or N/A — no gateway behavior changed): run by this pull request's checks
  • ruff check / mypy / npm run typecheck / npm run lint all pass
  • Public types, env vars, or SDK behavior changes are documented in the relevant README: N/A, no behaviour change

Checklist

  • Branch is off main: this branch targets dev, like the other package fixes
  • Commit messages follow Conventional Commits (feat:, fix:, docs:, chore: …)
  • No TODOs or commented-out code left in
  • No real API keys or secrets in the diff
  • If prose was added or changed: checked against docs/VOCABULARY.md

Notes for reviewers

  • One pinned test digest of the catalog in privacyRuntimePerfEquivalence.test.ts changes with the catalog text; the test logic is unchanged.
  • The fixtures/round6/ folder name is structural and is left as it is.

Read every file in spec/auto-instrumentation and the two shipped privacy.json copies, and fail if any line names an absolute /Volumes/ or /Users/ path.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant