Skip to content

Commit

Permalink
Fix crypto import in edge runtime with Turbopack (#65171)
Browse files Browse the repository at this point in the history
## 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
  • Loading branch information
timneutkens committed Apr 30, 2024
1 parent 49e561e commit bbd8452
Show file tree
Hide file tree
Showing 4 changed files with 173 additions and 1 deletion.
3 changes: 2 additions & 1 deletion packages/next-swc/crates/next-core/src/next_import_map.rs
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,12 @@ use crate::{
/// This is not identical to the list of entire node.js internals, refer
/// https://vercel.com/docs/functions/runtimes/edge-runtime#compatible-node.js-modules
/// for the allowed imports.
const EDGE_UNSUPPORTED_NODE_INTERNALS: [&str; 43] = [
const EDGE_UNSUPPORTED_NODE_INTERNALS: [&str; 44] = [
"child_process",
"cluster",
"console",
"constants",
"crypto",
"dgram",
"diagnostics_channel",
"dns",
Expand Down
31 changes: 31 additions & 0 deletions test/development/basic/node-builtins.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -167,4 +167,35 @@ describe('node builtins', () => {
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,
}
`)
})
})
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export default function Page() {
return <h1>Middleware Test</h1>
}
137 changes: 137 additions & 0 deletions test/development/basic/node-builtins/middleware.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
// Unsupported in edge
import { Writable } from 'stream'
import path from 'path'
import crypto from 'crypto'
import vm from 'vm'
import constants from 'constants'
import domain from 'domain'
import http from 'http'
import https from 'https'
import os from 'os'
// TODO: These are accidentally polyfilled in edge runtime currently.
// import punycode from 'punycode'
// import process from 'process'
// import querystring from 'querystring'
// import stringDecoder from 'string_decoder'
import sys from 'sys'
import timers from 'timers'
import tty from 'tty'
import zlib from 'zlib'
import 'setimmediate'
// Supported in edge
import { Buffer } from 'buffer'
import assert from 'assert'
import util from 'util'
import { EventEmitter } from 'events'

// Other imports
import { NextResponse } from 'next/server'

export default async function middleware(request) {
if (request.nextUrl.pathname !== '/middleware-test') {
return
}
const response = NextResponse.next()

let emitted = false
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter()
// Only do this once so we don't loop forever
myEmitter.once('myEvent', (_event, _listener) => {
emitted = true
})
myEmitter.emit('myEvent')

assert.ok(emitted)
assert.ok(!!util.promisify)
assert.ok(true)

const supportedResult = {
assert: true,
buffer: Buffer.from('hello world').toString('utf8'),
eventEmitter: true,
util: true,
}

response.headers.set('supported-result', JSON.stringify(supportedResult))

// TODO: These are accidentally polyfilled in edge runtime currently.
// assert.throws(() => {
// console.log(punycode)
// })
// assert.throws(() => {
// console.log(process.title)
// })
// assert.throws(() => {
// console.log(querystring)
// })
// assert.throws(() => {
// console.log(stringDecoder)
// })

assert.throws(() => {
console.log(domain)
})
assert.throws(() => {
console.log(http)
})
assert.throws(() => {
console.log(https)
})
assert.throws(() => {
console.log(zlib.Gzip)
})
assert.throws(() => {
console.log(constants.E2BIG)
})
assert.throws(() => {
console.log(crypto.createHash)
})
assert.throws(() => {
console.log(os.hostname)
})
assert.throws(() => {
console.log(path.join)
})
assert.throws(() => {
console.log(vm)
})
assert.throws(() => {
console.log(tty.isatty)
})
assert.throws(() => {
console.log(timers.clearImmediate)
})
assert.throws(() => {
console.log(Writable)
})
assert.throws(() => {
console.log(sys)
})

const unsupportedResult = {
// TODO: these are accidentally polyfilled in edge runtime currently.
// punycode: false,
// process: false,
// querystring: false,
// stringDecoder: false,

domain: false,
http: false,
https: false,
zlib: false,
constants: false,
crypto: false,
os: false,
path: false,

vm: false,
tty: false,
timers: false,
stream: false,
}

response.headers.set('unsupported-result', JSON.stringify(unsupportedResult))

return response
}

0 comments on commit bbd8452

Please sign in to comment.