fix: assign globals to self
#1823
Merged
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 netlify-plugin-nextjs-export-demo ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✅ Deploy Preview for nextjs-plugin-custom-routes-demo ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✅ Deploy Preview for netlify-plugin-nextjs-static-root-demo ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✅ Deploy Preview for netlify-plugin-nextjs-next-auth-demo ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✅ Deploy Preview for netlify-plugin-nextjs-nx-monorepo-demo ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✅ Deploy Preview for netlify-plugin-nextjs-demo ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✅ Deploy Preview for next-plugin-canary ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✅ Deploy Preview for next-plugin-edge-middleware ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✅ Deploy Preview for next-i18next-demo ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
ericapisani
suggested changes
Dec 1, 2022
There was a problem hiding this comment.
Small thing.
I also tried tested in a local environment (ntl dev) and ran into a TypeError:
TypeError: this._headers.getAll is not a function
full stack trace for debugging:
[next-dev] TypeError: this._headers.getAll is not a function
at new ResponseCookies (file:///Users/ericapisani/netlify/next-runtime/demos/middleware/.netlify/middleware.js#10:809:39)
at new NextResponse2 (file:///Users/ericapisani/netlify/next-runtime/demos/middleware/.netlify/middleware.js#10:998:20)
at Function.next (file:///Users/ericapisani/netlify/next-runtime/demos/middleware/.netlify/middleware.js#10:1053:16)
at middleware (file:///Users/ericapisani/netlify/next-runtime/demos/middleware/.netlify/middleware.js#10:1632:45)
at Object.handler [as function] (file:///Users/ericapisani/netlify/next-runtime/demos/middleware/.netlify/edge-functions/next-dev/index.js:75:28)
at async FunctionChain.runFunction (https://637cf7ce9214b300099b3aa8--edge.netlify.app/bootstrap/function_chain.ts:298:24)
at async FunctionChain.run (https://637cf7ce9214b300099b3aa8--edge.netlify.app/bootstrap/function_chain.ts:251:22)
at async handleRequest (https://637cf7ce9214b300099b3aa8--edge.netlify.app/bootstrap/handler.ts:59:22)
at async Server.#respond (https://deno.land/[email protected]/http/server.ts:298:18)
| @@ -118,6 +116,9 @@ const fetch = async (url, init) => { | |||
| } | |||
| } | |||
|
|
|||
| // Next edge runtime uses "self" as a function-scoped global-like object, but some of the older polyfills expect it to equal globalThis | |||
| const self = { ...globalThis, fetch } | |||
There was a problem hiding this comment.
Nit: Could we add a permalink to where the Next stub polyfill replacement occurs in case we need to investigate something related to it in the future?
There was a problem hiding this comment.
Added a link to the docs
|
@ericapisani Was that with |
ascorbic
force-pushed
the
mk/self-global
branch
from
818aa89 to
7b4fff8
Compare
|
@ascorbic It wasn't when I originally posted my comment but trying it again with |
ericapisani
approved these changes
Dec 2, 2022
Merged
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.
Summary
Next.js middleware and edge functions define
selfas a global-like, function-scoped object. However some of Next's built-in polyfill stubs expectselfto have browser globals. These polyfills aren't supposed to be needed in edge runtime, but Next automatically includes them if a site has certain dependencies (e.g.unfetch). This means that for those sites, edge functions were failing because those globals were missing.This PR adds globals to
self, meaning they're available if the polyfill needs them.Test plan
This PR adds
isomorphic-unfetchto the middleware demo site, to simulate this bug. To test it, visit the middleware demo and load/shows/222. The response headers should includex-example-server.Relevant links (GitHub issues, Notion docs, etc.) or a picture of cute animal
Fixes https://github.com/netlify/pod-ecosystem-frameworks/issues/315
Standard checks:
🧪 Once merged, make sure to update the version if needed and that it was published correctly.