Skip to content

fix(observability-map): narrow the required check and the report bot's comment lookup - #4507

Merged
1stvamp merged 3 commits into
mainfrom
fix/obsmap-review-ci
Aug 5, 2026
Merged

fix(observability-map): narrow the required check and the report bot's comment lookup#4507
1stvamp merged 3 commits into
mainfrom
fix/obsmap-review-ci

Conversation

@1stvamp

@1stvamp 1stvamp commented Aug 5, 2026

Copy link
Copy Markdown
Member

Findings addressed

  • Report bot edited the wrong comment. The comment-lookup step matched on the marker body text with no author predicate, so it would silently PATCH a human's comment that happened to quote the marker (GitHub gates comment editing on write access, not authorship, so it never 403'd). Now constrained to .user.login == "github-actions[bot]", the same identity helm-prerelease.yml already pins.
  • A required check asserted facts about the whole webapp namespace. webappSymbols.test.ts asserted that nobody anywhere in apps/webapp (walking locals, params, object keys) declares names like createJWT/updateEnvVars, so an unrelated PR naming a local variable failed a required check with a message pointing at nothing. Those negative self-tests move onto a package-owned fixture tree; the positive resolution assertions stay required (their absence rotted the tool before) but now name the list to edit.
  • The suite ran twice on shared paths. obsmap and internal path filters shared four generic paths (package.json, both lockfiles, pr_checks.yml), so any lockfile bump ran the observability-map suite in both jobs. Dropped from obsmap (where internal already covers them). The test that should have caught it only checked the package's own source path; it now asserts the two filters' path intersection is empty.
  • PR-comment footer reworded: it said the report gates nothing, which is true of the report but misled now that the tool's test suite does gate webapp PRs. Names both failure directions and where to read the rules.
  • Nightly corpus comment corrected (stale entry count; the failure-notification gap is documented, not silently implied).

Review

Two adversarial reviewers ran over the diff; both findings were verified and fixed: a hollow fixture assertion (a shared name satisfied either walker branch — now one name per declaration form, revert-confirmed) and a filter-intersection test that could be fooled by apostrophes in comment prose (now strips comment lines first). Full package suite green (877 passed), typecheck and format clean.

…s comment lookup

Four findings from Nick's post-merge review of #4455.

The report bot found its own comment by marker text with no author predicate, so
it silently edited a human's comment that happened to quote the marker. GitHub
gates comment editing on write access, not authorship, so this never failed
loudly. Matched on .user.login now, the same identity helm-prerelease.yml pins
through peter-evans/find-comment.

The package's test suite asserted that nobody anywhere in the webapp declares
createJWT, signJWT, setImpersonation or updateEnvVars, walking locals and
parameters and object keys. Naming a local variable failed a required check with
a message that pointed at nothing. Those two negative self-tests move onto a
fixture tree, which proves the predicate can fail without holding the webapp's
namespace hostage. The positive assertions stay required, because their absence
is what rotted the tool before, but each now names the list to edit.

The obsmap and internal path filters shared four generic paths, so any lockfile
bump ran this suite twice. Dropped from obsmap, where internal already covers
them. The test that should have caught it only checked the package's own source
path, so it now asserts the filters' set intersection is empty. Editing
pr_checks.yml alone no longer fires the obsmap job live, which is the accepted
trade-off.

The PR comment's footer said nothing here gates the merge. True of the report,
misleading now that the suite gates webapp pull requests, so it names both
failure directions and where to read the rules.
@changeset-bot

changeset-bot Bot commented Aug 5, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: c664eb9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@1stvamp 1stvamp changed the title Follow-up to Nick's post-merge review of #4455, covering the CI and test-scoping findings. (The scanner-calibration findings from the same review are separate; this PR is the CI/workflow batch.) fix(observability-map): narrow the required check and the report bot's comment lookup Aug 5, 2026
@coderabbitai

coderabbitai Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 61ac7acd-2ed5-46f2-8587-a08c8ca8fd9b

📥 Commits

Reviewing files that changed from the base of the PR and between 0df50af and c664eb9.

📒 Files selected for processing (3)
  • .github/workflows/observability-map.yml
  • internal-packages/observability-map/INTERNALS.md
  • internal-packages/observability-map/README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/observability-map.yml
📜 Recent review details
⏰ Context from checks skipped due to timeout. (21)
  • GitHub Check: 🧬 Mutation corpus
  • GitHub Check: webapp / 🧪 Unit Tests: Webapp (7, 12)
  • GitHub Check: webapp / 🧪 Unit Tests: Webapp (1, 12)
  • GitHub Check: webapp / 🧪 Unit Tests: Webapp (2, 12)
  • GitHub Check: webapp / 🧪 Unit Tests: Webapp (12, 12)
  • GitHub Check: webapp / 🧪 Unit Tests: Webapp (6, 12)
  • GitHub Check: webapp / 🧪 Unit Tests: Webapp (4, 12)
  • GitHub Check: webapp / 🧪 Unit Tests: Webapp (3, 12)
  • GitHub Check: webapp / 🧪 Unit Tests: Webapp (9, 12)
  • GitHub Check: webapp / 🧪 Unit Tests: Webapp (5, 12)
  • GitHub Check: webapp / 🧪 Unit Tests: Webapp (10, 12)
  • GitHub Check: webapp / 🧪 Unit Tests: Webapp (8, 12)
  • GitHub Check: webapp / 🧪 Unit Tests: Webapp (11, 12)
  • GitHub Check: e2e-webapp / 🧪 E2E Tests: Webapp
  • GitHub Check: internal / 🧪 Unit Tests: Internal
  • GitHub Check: packages / 🧪 Unit Tests: Packages (3, 3)
  • GitHub Check: packages / 🧪 Unit Tests: Packages (2, 3)
  • GitHub Check: e2e / 🧪 CLI v3 tests (warp-windows-latest-x64-8x - npm)
  • GitHub Check: packages / 🧪 Unit Tests: Packages (1, 3)
  • GitHub Check: sdk-compat / Cloudflare Workers
  • GitHub Check: e2e / 🧪 CLI v3 tests (warp-windows-latest-x64-8x - pnpm)
🔇 Additional comments (2)
internal-packages/observability-map/README.md (1)

34-40: LGTM!

Also applies to: 94-94, 105-115

internal-packages/observability-map/INTERNALS.md (1)

500-501: LGTM!


Walkthrough

The observability-map tests now scan caller-provided source and route roots with fixture coverage for declarations and route segments. Report comment lookup requires the marker and github-actions[bot] author, while report renderers use a shared footer. CI filters now avoid overlapping paths. Documentation describes report-only behavior, required tests, corpus details, and nightly notification behavior.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the two primary changes: narrowing the required check and restricting report-bot comment lookup.
Description check ✅ Passed The description explains the addressed findings, implementation scope, documentation updates, and test results, although it omits the template checklist and screenshots.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/obsmap-review-ci

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

coderabbitai[bot]

This comment was marked as resolved.

The fixture asserted the local and the member declaration forms but not the
function declaration, so deleting that branch of the walker left the fixture
test green and failed only the live-tree assertions the fixture exists to
replace. Assert `helper` too, so each branch is pinned by its own name.
Revert-confirmed: removing the branch now fails the fixture test.
@1stvamp
1stvamp marked this pull request as ready for review August 5, 2026 19:21
devin-ai-integration[bot]

This comment was marked as resolved.

… timings

Updating the workflow's entry count left three prose figures behind: the README
said 44 rewrites applied and 43 defended, and both the README and INTERNALS said
four and a half minutes. The corpus has 53 entries.

The worse one was not a count. The README claimed one hole is open when
KNOWN_GAPS has two, so the document under-reported what the corpus cannot
defend, which is the one thing it has to be honest about. The second gap,
dead-conjunction-instanceof-if, is now written out beside the first with its
reason.

Timings measured rather than scaled: the corpus step is about 1.7 minutes on
CI's runner and about 8 on a laptop, so the earlier five-minute figure in the
workflow was wrong too. Replaced the single numbers with the range, since an
exact figure is machine-dependent and nothing asserts it.
@1stvamp
1stvamp merged commit 66940c0 into main Aug 5, 2026
53 checks passed
@1stvamp
1stvamp deleted the fix/obsmap-review-ci branch August 5, 2026 21:36
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.

2 participants