-
Notifications
You must be signed in to change notification settings - Fork 30k
Externalize node binary modules for app router #70330
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| import type { webpack } from 'next/dist/compiled/webpack/webpack' | ||
|
|
||
| export default function nextErrorBrowserBinaryLoader( | ||
| this: webpack.LoaderContext<any> | ||
| ) { | ||
| const { resourcePath, rootContext } = this | ||
| const relativePath = resourcePath.slice(rootContext.length + 1) | ||
| throw new Error( | ||
| `Node.js binary module ./${relativePath} is not supported in the browser. Please only use the module on server side` | ||
| ) | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| import type { webpack } from 'next/dist/compiled/webpack/webpack' | ||
| import path from 'path' | ||
|
|
||
| export default function nextErrorBrowserBinaryLoader( | ||
| this: webpack.LoaderContext<any> | ||
| ) { | ||
| let relativePath = path.relative(this.rootContext, this.resourcePath) | ||
| if (!relativePath.startsWith('.')) { | ||
| relativePath = './' + relativePath | ||
| } | ||
| return `module.exports = __non_webpack_require__(${JSON.stringify(relativePath)})` | ||
| } |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| import { ReactNode } from 'react' | ||
| export default function Root({ children }: { children: ReactNode }) { | ||
| return ( | ||
| <html> | ||
| <body>{children}</body> | ||
| </html> | ||
| ) | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| 'use client' | ||
|
|
||
| import { foo } from 'foo-browser-import-binary' | ||
|
|
||
| export default function Page() { | ||
| return <p>{foo()}</p> | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| import { nextTestSetup } from 'e2e-utils' | ||
| import { | ||
| assertHasRedbox, | ||
| getRedboxDescription, | ||
| getRedboxSource, | ||
| } from 'next-test-utils' | ||
| ;(process.env.TURBOPACK ? describe.skip : describe)( | ||
| 'externalize-node-binary-browser-error', | ||
| () => { | ||
| const { next } = nextTestSetup({ | ||
| files: __dirname, | ||
| }) | ||
|
|
||
| it('should error when import node binary on browser side', async () => { | ||
| const browser = await next.browser('/') | ||
| await assertHasRedbox(browser) | ||
| const redbox = { | ||
| description: await getRedboxDescription(browser), | ||
| source: await getRedboxSource(browser), | ||
| } | ||
|
|
||
| expect(redbox.description).toBe('Failed to compile') | ||
| expect(redbox.source).toMatchInlineSnapshot(` | ||
| "./node_modules/foo-browser-import-binary/binary.node | ||
| Error: Node.js binary module ./node_modules/foo-browser-import-binary/binary.node is not supported in the browser. Please only use the module on server side" | ||
| `) | ||
| }) | ||
| } | ||
| ) |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| import { ReactNode } from 'react' | ||
| export default function Root({ children }: { children: ReactNode }) { | ||
| return ( | ||
| <html> | ||
| <body>{children}</body> | ||
| </html> | ||
| ) | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| import { foo } from 'foo' | ||
|
|
||
| export default function Page() { | ||
| return <p>{foo()}</p> | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| import { nextTestSetup } from 'e2e-utils' | ||
|
|
||
| describe('externalize-node-binary', () => { | ||
| const { next } = nextTestSetup({ | ||
| files: __dirname, | ||
| }) | ||
|
|
||
| it('should render correctly when node_modules require node binary module', async () => { | ||
| const { status } = await next.fetch('/') | ||
| expect(status).toBe(200) | ||
|
|
||
| const browser = await next.browser('/') | ||
| expect(await browser.elementByCss('p').text()).toBe('I am foo') | ||
| }) | ||
| }) |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Uh oh!
There was an error while loading. Please reload this page.