fix: populate value for Netlify React Router context in dev #550
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for remix-edge ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for remix-serverless ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
serhalp
force-pushed
the
fix/react-router-middleware-dev
branch
from
7c1fbbc to
63e18b1
Compare
Follow-up to #546. Since the `netlifyRouterContext.set()` call was occurring in the server entry point built for production but not in dev, and no default value was set for the context at construction time, using middleware in dev would throw. There's no ergonomic way to set up a `.set()` call dynamically on a context in dev, as far as I can tell. This leaves the default value set at construction time as our only option. To make this work, we can use the global `Netlify.context`. However, this is only accessible during a request-response lifecycle, not in module scope at module init time. So this commit simply changes `netlifyRouterContext` to a function `getNetlifyRouterContext()` so that we can lazily construct the context with a default value of `Netlify.context` during a request lifecycle. To be clear, the Netlify router context will only work in local dev when using either the Netlify CLI or `@netlify/vite-plugin`.
serhalp
force-pushed
the
fix/react-router-middleware-dev
branch
2 times, most recently
from
cd9a5a9 to
83292a9
Compare
serhalp
force-pushed
the
fix/react-router-middleware-dev
branch
from
83292a9 to
df7719a
Compare
pieh
approved these changes
Oct 20, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Follow-up to #546.
Since the
netlifyRouterContext.set()call was occurring in the server entry point built for production but not in dev, and no default value was set for the context at construction time, using middleware in dev would throw.There's no ergonomic way to set up a
.set()call dynamically on a context in dev, as far as I can tell. This leaves the default value set at construction time as our only option.To make this work, we can use the global
Netlify.context. However, this is only accessible during a request-response lifecycle, not in module scope at module init time. So this commit simply changesnetlifyRouterContextto a proxy so that we can lazily evaluate the context properties fromNetlify.contextduring a request lifecycle.To be clear, the Netlify router context will only work in local dev when using either the Netlify CLI or
@netlify/vite-plugin.Related Tickets & Documents
Follow-up to #546
See also netlify/react-router-template#12
QA Instructions, Screenshots, Recordings
Clone netlify/react-router-template#12,
npm linkthis PR, and runnpx netlify devandnpx netlify deploy. Both work.