-
Notifications
You must be signed in to change notification settings - Fork 27.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implement
typeof window
inlining for Turbopack (#66128)
## What? Update: Implemented a feature in Turbopack for `typeof window` inlining: vercel/turborepo#8211. Verified the changes in that PR + this PR fix the test 💯 Turbopack upgrade: * vercel/turborepo#8081 <!-- Alexander Lyon - add support for upload speed / remaining in the cache upload step --> * vercel/turborepo#7673 <!-- Alexander Lyon - [turbo-trace] add additional filter modes for allocs over time --> * vercel/turborepo#8191 <!-- Will Binns-Smith - Turbopack: Register react refresh exports in module factory --> * vercel/turborepo#8195 <!-- Donny/강동윤 - feat: Remove lint for `grid-template-areas`" --> * vercel/turborepo#8207 <!-- Benjamin Woodruff - chore: Remove unused `base16` dependency and dead `hex` wrapper function --> * vercel/turborepo#8185 <!-- Tim Neutkens - Update contributing guide to mention snapshot test updating --> * vercel/turborepo#8211 <!-- Tim Neutkens - Add option for inlining typeof window --> * vercel/turborepo#8214 <!-- Will Binns-Smith - Revert "Turbopack: Register react refresh exports in module factory (#8191)" --> --- Previous PR description:: Implements a failing test for issue #66058. The test only fails when using Turbopack. While digging into that issue I found that `typeof window` replacement is either not applied or does not cause `import()` or `require()` to be removed. In the reproduction that approach is used to load a particular package only in Node.js and another only in the browser. <!-- Thanks for opening a PR! Your contribution is much appreciated. To make sure your PR is handled as smoothly as possible we request that you follow the checklist sections below. Choose the right checklist for the change(s) that you're making: ## For Contributors ### Improving Documentation - Run `pnpm prettier-fix` to fix formatting issues before opening the PR. - Read the Docs Contribution Guide to ensure your contribution follows the docs guidelines: https://nextjs.org/docs/community/contribution-guide ### Adding or Updating Examples - The "examples guidelines" are followed from our contributing doc https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md - Make sure the linting passes by running `pnpm build && pnpm lint`. See https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md ### Fixing a bug - Related issues linked using `fixes #number` - Tests added. See: https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ### Adding a feature - Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. (A discussion must be opened, see https://github.com/vercel/next.js/discussions/new?category=ideas) - Related issues/discussions are linked using `fixes #number` - e2e tests added (https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs) - Documentation added - Telemetry added. In case of a feature if it's used or not. - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ## For Maintainers - Minimal description (aim for explaining to someone not on the team to understand the PR) - When linking to a Slack thread, you might want to share details of the conclusion - Link both the Linear (Fixes NEXT-xxx) and the GitHub issues - Add review comments if necessary to explain to the reviewer the logic behind a change ### What? ### Why? ### How? Closes NEXT- Fixes # -->
- Loading branch information
1 parent
20201a1
commit 216ce33
Showing
15 changed files
with
123 additions
and
276 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains 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
This file contains 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
This file contains 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
This file contains 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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
export default function Root({ children }) { | ||
return ( | ||
<html> | ||
<body>{children}</body> | ||
</html> | ||
) | ||
} |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
'use client' | ||
if (typeof window !== 'undefined') { | ||
import('my-differentiated-files/browser').then((mod) => { | ||
console.log({ TEST: mod.default }) | ||
}) | ||
} | ||
|
||
export default function Page() { | ||
return <h1>Page loaded</h1> | ||
} |
Binary file not shown.
1 change: 1 addition & 0 deletions
1
test/e2e/app-dir/typeof-window/my-differentiated-files/my-file-browser.js
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
export default 'BROWSER' |
1 change: 1 addition & 0 deletions
1
test/e2e/app-dir/typeof-window/my-differentiated-files/my-file-server.js
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
export default 'SERVER' |
14 changes: 14 additions & 0 deletions
14
test/e2e/app-dir/typeof-window/my-differentiated-files/package.json
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
{ | ||
"name": "my-differentiated-files", | ||
"type": "module", | ||
"exports": { | ||
"./browser": { | ||
"browser": "./my-file-browser.js", | ||
"node": null | ||
}, | ||
"./server": { | ||
"browser": null, | ||
"node": "./my-file-server.js" | ||
} | ||
} | ||
} |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
/** | ||
* @type {import('next').NextConfig} | ||
*/ | ||
const nextConfig = {} | ||
|
||
module.exports = nextConfig |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
{ | ||
"private": true, | ||
"dependencies": { | ||
"my-differentiated-files": "file:./my-differentiated-files.tar" | ||
} | ||
} |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
import { nextTestSetup } from 'e2e-utils' | ||
import path from 'path' | ||
|
||
describe('typeof-window', () => { | ||
const { next } = nextTestSetup({ | ||
files: __dirname, | ||
dependencies: { | ||
'my-differentiated-files': `file:${path.join(__dirname, 'my-differentiated-files.tar')}`, | ||
}, | ||
}) | ||
|
||
it('should work using cheerio', async () => { | ||
const $ = await next.render$('/') | ||
expect($('h1').text()).toBe('Page loaded') | ||
}) | ||
}) |