mirror of
https://github.com/vercel/next.js.git
synced 2026-09-20 02:25:18 +08:00
Tim Neutkens
bbd8452d6b
## What? Ensures just importing `crypto` does not error, only when it is used it shows an error in the edge runtime. This matches webpack behavior. The `crypto` module was missing the list of unsupported packages in the Next.js Turbopack integration. Fixes #64464 Fixes PACK-2954 ## TODO While adding tests for this issue I found another bug that only happens with webpack. Specifically these 4 packages are accidentally being polyfilled even when they're not set up to be polyfilled. i.e. there's no npm package installed for polyfilling them through aliasing or such. Even in that case `punycode`, `process`, `querystring`, and `string_decorder` get polyfilled regardless, this causes the newly added test to fail. Removing the polyfills would be potentially breaking so we'll want to change it in Next.js 15 instead. <!-- 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 # --> Closes NEXT-3252
202 lines
6.9 KiB
TypeScript
202 lines
6.9 KiB
TypeScript
import { join } from 'path'
|
|
import { nextTestSetup } from 'e2e-utils'
|
|
|
|
describe('node builtins', () => {
|
|
const { next } = nextTestSetup({
|
|
files: join(__dirname, 'node-builtins'),
|
|
})
|
|
|
|
it('should have polyfilled node.js builtins for the browser correctly', async () => {
|
|
const browser = await next.browser('/')
|
|
|
|
await browser.waitForCondition('window.didRender', 15000)
|
|
|
|
const data = await browser
|
|
.waitForElementByCss('#node-browser-polyfills')
|
|
.text()
|
|
const parsedData = JSON.parse(data)
|
|
|
|
expect(parsedData.vm).toBe(105)
|
|
expect(parsedData.hash).toBe(
|
|
'b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9'
|
|
)
|
|
expect(parsedData.buffer).toBe('hello world')
|
|
expect(parsedData.stream).toBe(true)
|
|
expect(parsedData.assert).toBe(true)
|
|
expect(parsedData.constants).toBe(7)
|
|
expect(parsedData.domain).toBe(true)
|
|
expect(parsedData.http).toBe(true)
|
|
expect(parsedData.https).toBe(true)
|
|
expect(parsedData.os).toBe('\n')
|
|
expect(parsedData.path).toBe('/hello/world/test.txt')
|
|
expect(parsedData.process).toBe('browser')
|
|
expect(parsedData.querystring).toBe('a=b')
|
|
expect(parsedData.stringDecoder).toBe(true)
|
|
expect(parsedData.sys).toBe(true)
|
|
expect(parsedData.timers).toBe(true)
|
|
})
|
|
|
|
it('should have polyfilled node.js builtins for the browser correctly in client component', async () => {
|
|
const browser = await next.browser('/client-component')
|
|
|
|
await browser.waitForCondition('window.didRender', 15000)
|
|
|
|
const data = await browser
|
|
.waitForElementByCss('#node-browser-polyfills')
|
|
.text()
|
|
const parsedData = JSON.parse(data)
|
|
|
|
expect(parsedData.vm).toBe(105)
|
|
expect(parsedData.hash).toBe(
|
|
'b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9'
|
|
)
|
|
expect(parsedData.buffer).toBe('hello world')
|
|
expect(parsedData.stream).toBe(true)
|
|
expect(parsedData.assert).toBe(true)
|
|
expect(parsedData.constants).toBe(7)
|
|
expect(parsedData.domain).toBe(true)
|
|
expect(parsedData.http).toBe(true)
|
|
expect(parsedData.https).toBe(true)
|
|
expect(parsedData.os).toBe('\n')
|
|
expect(parsedData.path).toBe('/hello/world/test.txt')
|
|
expect(parsedData.process).toBe('browser')
|
|
expect(parsedData.querystring).toBe('a=b')
|
|
expect(parsedData.stringDecoder).toBe(true)
|
|
expect(parsedData.sys).toBe(true)
|
|
expect(parsedData.timers).toBe(true)
|
|
})
|
|
|
|
it('should support node.js builtins', async () => {
|
|
const $ = await next.render$('/server')
|
|
|
|
const data = $('#node-browser-polyfills').text()
|
|
const parsedData = JSON.parse(data)
|
|
|
|
expect(parsedData.vm).toBe(105)
|
|
expect(parsedData.hash).toBe(
|
|
'b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9'
|
|
)
|
|
expect(parsedData.buffer).toBe('hello world')
|
|
expect(parsedData.stream).toBe(true)
|
|
expect(parsedData.assert).toBe(true)
|
|
expect(parsedData.constants).toBe(7)
|
|
expect(parsedData.domain).toBe(true)
|
|
expect(parsedData.http).toBe(true)
|
|
expect(parsedData.https).toBe(true)
|
|
expect(parsedData.os).toBe('\n')
|
|
expect(parsedData.path).toBe('/hello/world/test.txt')
|
|
expect(parsedData.process).toInclude('next-server')
|
|
expect(parsedData.querystring).toBe('a=b')
|
|
expect(parsedData.stringDecoder).toBe(true)
|
|
expect(parsedData.sys).toBe(true)
|
|
expect(parsedData.timers).toBe(true)
|
|
})
|
|
|
|
it('should support node.js builtins prefixed by node:', async () => {
|
|
const $ = await next.render$('/server-node-schema')
|
|
|
|
const data = $('#node-browser-polyfills').text()
|
|
const parsedData = JSON.parse(data)
|
|
|
|
expect(parsedData.vm).toBe(105)
|
|
expect(parsedData.hash).toBe(
|
|
'b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9'
|
|
)
|
|
expect(parsedData.buffer).toBe('hello world')
|
|
expect(parsedData.stream).toBe(true)
|
|
expect(parsedData.assert).toBe(true)
|
|
expect(parsedData.constants).toBe(7)
|
|
expect(parsedData.domain).toBe(true)
|
|
expect(parsedData.http).toBe(true)
|
|
expect(parsedData.https).toBe(true)
|
|
expect(parsedData.os).toBe('\n')
|
|
expect(parsedData.path).toBe('/hello/world/test.txt')
|
|
expect(parsedData.process).toInclude('next-server')
|
|
expect(parsedData.querystring).toBe('a=b')
|
|
expect(parsedData.stringDecoder).toBe(true)
|
|
expect(parsedData.sys).toBe(true)
|
|
expect(parsedData.timers).toBe(true)
|
|
})
|
|
|
|
it('should support node.js builtins in server component', async () => {
|
|
const $ = await next.render$('/server-component')
|
|
|
|
const data = $('#node-browser-polyfills').text()
|
|
const parsedData = JSON.parse(data)
|
|
|
|
expect(parsedData.vm).toBe(105)
|
|
expect(parsedData.hash).toBe(
|
|
'b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9'
|
|
)
|
|
expect(parsedData.buffer).toBe('hello world')
|
|
expect(parsedData.stream).toBe(true)
|
|
expect(parsedData.assert).toBe(true)
|
|
expect(parsedData.constants).toBe(7)
|
|
expect(parsedData.domain).toBe(true)
|
|
expect(parsedData.http).toBe(true)
|
|
expect(parsedData.https).toBe(true)
|
|
expect(parsedData.os).toBe('\n')
|
|
expect(parsedData.path).toBe('/hello/world/test.txt')
|
|
expect(parsedData.querystring).toBe('a=b')
|
|
expect(parsedData.stringDecoder).toBe(true)
|
|
expect(parsedData.sys).toBe(true)
|
|
expect(parsedData.timers).toBe(true)
|
|
})
|
|
|
|
it('should support node.js builtins prefixed by node: in server component', async () => {
|
|
const $ = await next.render$('/server-component/node-schema')
|
|
|
|
const data = $('#node-browser-polyfills').text()
|
|
const parsedData = JSON.parse(data)
|
|
|
|
expect(parsedData.vm).toBe(105)
|
|
expect(parsedData.hash).toBe(
|
|
'b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9'
|
|
)
|
|
expect(parsedData.buffer).toBe('hello world')
|
|
expect(parsedData.stream).toBe(true)
|
|
expect(parsedData.assert).toBe(true)
|
|
expect(parsedData.constants).toBe(7)
|
|
expect(parsedData.domain).toBe(true)
|
|
expect(parsedData.http).toBe(true)
|
|
expect(parsedData.https).toBe(true)
|
|
expect(parsedData.os).toBe('\n')
|
|
expect(parsedData.path).toBe('/hello/world/test.txt')
|
|
expect(parsedData.querystring).toBe('a=b')
|
|
expect(parsedData.stringDecoder).toBe(true)
|
|
expect(parsedData.sys).toBe(true)
|
|
expect(parsedData.timers).toBe(true)
|
|
})
|
|
|
|
it('should throw when unsupported builtins are used in middleware', async () => {
|
|
const res = await next.fetch('/middleware-test')
|
|
expect(res.status).toBe(200)
|
|
expect(JSON.parse(res.headers.get('supported-result')))
|
|
.toMatchInlineSnapshot(`
|
|
{
|
|
"assert": true,
|
|
"buffer": "hello world",
|
|
"eventEmitter": true,
|
|
"util": true,
|
|
}
|
|
`)
|
|
expect(JSON.parse(res.headers.get('unsupported-result')))
|
|
.toMatchInlineSnapshot(`
|
|
{
|
|
"constants": false,
|
|
"crypto": false,
|
|
"domain": false,
|
|
"http": false,
|
|
"https": false,
|
|
"os": false,
|
|
"path": false,
|
|
"stream": false,
|
|
"timers": false,
|
|
"tty": false,
|
|
"vm": false,
|
|
"zlib": false,
|
|
}
|
|
`)
|
|
})
|
|
})
|