fix(router-core): fix dangling references in published declarations - #8207
Conversation
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
View your CI Pipeline Execution ↗ for commit 86dd9b4
☁️ Nx Cloud last updated this comment at |
🚀 Changeset Version Preview6 package(s) bumped directly, 18 bumped as dependents. 🟩 Patch bumps
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Team Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 10 included reviews per hour; 6 remain after this review. 📝 WalkthroughWalkthroughThe change marks the SSR dehydrated match context field as internal, preserves the ChangesRouter core declarations
Estimated code review effort: 2 (Simple) | ~10 minutes Merge Risk: ⚪ Minimal · up to This update removes the internal dehydrated context field from published declarations while retaining runtime serialization behavior and the exported URL helper. It adds ESM and CommonJS declaration-consumer coverage, with no remaining merge-readiness risk identified. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 88621b3cd8
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Sheraff
changed the title
This reverts commit 2bc6b55.
Sheraff
changed the title
![nx-cloud[bot]](https://avatars.githubusercontent.com/in/80458?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Merging this PR will regress 7 benchmarks
|
Bundle Size BenchmarksThis pull request does not affect bundle size in any measured scenario. |
Sheraff
changed the title
Sheraff
changed the title
|
Note GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer. |
There was a problem hiding this comment.
Important
At least one additional CI pipeline execution has run since the conclusion below was written and it may no longer be applicable.
Nx Cloud is proposing a fix for your failed CI:
We exclude tests/declarations/** from vitest's typecheck to fix the 6 TypeCheckError: Cannot find module '@TanStack/router-core' unhandled errors that caused test:unit to exit with code 1. The consumer.cts and consumer.mts fixtures are designed to be compiled by tsc6 -p tests/declarations/tsconfig.json (part of test:build) and rely on published package exports resolving to a built dist/ directory, a context that does not exist during test:unit.
Tip
✅ We verified this fix by re-running @tanstack/router-core:test:unit.
diff --git a/packages/router-core/vite.config.ts b/packages/router-core/vite.config.ts
index 97859dda..d1842574 100644
--- a/packages/router-core/vite.config.ts
+++ b/packages/router-core/vite.config.ts
@@ -19,7 +19,7 @@ const config = defineConfig({
dir: './tests',
watch: false,
environment: 'jsdom',
- typecheck: { enabled: true },
+ typecheck: { enabled: true, exclude: ['**/declarations/**'] },
// Perf tests are gated by env var and excluded from default runs.
// To run: RUN_BACKPRESSURE_PERF=1 pnpm vitest run transformStreamBackpressure
exclude:
Or Apply changes locally with:
npx nx-cloud apply-locally vOWk-TKG9
Apply fix locally with your editor ↗ View interactive diff ↗
🎓 Learn more about Self-Healing CI on nx.dev
1 participant
🎯 Changes
Fixes #8203.
Consumers using
skipLibCheck: falsefail to typecheck because the publishedDehydratedMatch.bdeclaration referencesMakeRouteMatch['__beforeLoadContext'], which is stripped bystripInternal. Markbas internal too, so declaration generation omits the dangling reference. The field remains available to the router's serialization and hydration code.Keep the declaration of
isAbsoluteUrl, which is exported from router-core and imported by the framework bindings. Stripping it leaves another dangling reference in the package entry point. Update the React hydration fixture to explicitly include the internal context field in its serialized match type. These changes do not alter runtime behavior.Include a router-core patch changeset.
Validation:
pnpm test:eslint,pnpm test:types, andpnpm test:unit.test:build, including publint and Are the Types Wrong.skipLibCheck: falseon TypeScript 6 and 7.cf166d1): 90 of 92 files are byte-identical, and the remaining two differ only by the removed@internalcomment.✅ Checklist
🚀 Release Impact