Add the node condition to import resolution (#50007)

This adds the `node` condition, so that importing a node module that uses `exports` with a `node` specified will prioritize that file. Eg, [uuid](https://github.com/uuidjs/uuid/blob/4de23a60/package.json#L25-L31)'s `package.json` will now resolve to the `./dist/esm-node/index.js` in our SSR builds, instead of the default `./dist/esm-browser/index.js` Fixes WEB-1051
vercel · May 23, 2023 · 1e86c8b · 1e86c8b
1 parent df85ad1
commit 1e86c8b
Show file tree

Hide file tree

Showing 31 changed files with 422 additions and 4 deletions.
diff --git a/packages/next-swc/crates/next-core/src/next_server/context.rs b/packages/next-swc/crates/next-core/src/next_server/context.rs
@@ -102,7 +102,7 @@ pub async fn get_server_resolve_options_context(
                 enable_node_externals: true,
                 enable_node_native_modules: true,
                 module: true,
-                custom_conditions: vec![mode.node_env().to_string()],
+                custom_conditions: vec![mode.node_env().to_string(), "node".to_string()],
                 import_map: Some(next_server_import_map),
                 plugins: vec![
                     external_cjs_modules_plugin.into(),
@@ -126,7 +126,11 @@ pub async fn get_server_resolve_options_context(
                 enable_node_externals: true,
                 enable_node_native_modules: true,
                 module: true,
-                custom_conditions: vec![mode.node_env().to_string()],
+                custom_conditions: vec![
+                    mode.node_env().to_string(),
+                    // TODO!
+                    "node".to_string(),
+                ],
                 import_map: Some(next_server_import_map),
                 plugins: vec![
                     server_component_externals_plugin.into(),
@@ -150,7 +154,12 @@ pub async fn get_server_resolve_options_context(
                 enable_node_externals: true,
                 enable_node_native_modules: true,
                 module: true,
-                custom_conditions: vec![mode.node_env().to_string(), "react-server".to_string()],
+                custom_conditions: vec![
+                    mode.node_env().to_string(),
+                    "react-server".to_string(),
+                    // TODO
+                    "node".to_string(),
+                ],
                 import_map: Some(next_server_import_map),
                 plugins: vec![
                     server_component_externals_plugin.into(),
@@ -172,7 +181,7 @@ pub async fn get_server_resolve_options_context(
             let resolve_options_context = ResolveOptionsContext {
                 enable_node_modules: Some(root_dir),
                 module: true,
-                custom_conditions: vec![mode.node_env().to_string()],
+                custom_conditions: vec![mode.node_env().to_string(), "node".to_string()],
                 import_map: Some(next_server_import_map),
                 plugins: vec![
                     server_component_externals_plugin.into(),

diff --git a/...crates/next-dev-tests/tests/integration/next/import/conditions/input/app/app-edge/page.js b/...crates/next-dev-tests/tests/integration/next/import/conditions/input/app/app-edge/page.js
@@ -0,0 +1,11 @@
+import edgeThenNode from 'edge-then-node'
+import nodeThenEdge from 'node-then-edge'
+
+export const runtime = 'edge'
+
+export default function AppEdge() {
+  return JSON.stringify({
+    edgeThenNode,
+    nodeThenEdge,
+  })
+}
diff --git a/...ates/next-dev-tests/tests/integration/next/import/conditions/input/app/app-nodejs/page.js b/...ates/next-dev-tests/tests/integration/next/import/conditions/input/app/app-nodejs/page.js
@@ -0,0 +1,11 @@
+import edgeThenNode from 'edge-then-node'
+import nodeThenEdge from 'node-then-edge'
+
+export const runtime = 'nodejs'
+
+export default function AppNodeJs() {
+  return JSON.stringify({
+    edgeThenNode,
+    nodeThenEdge,
+  })
+}
diff --git a/...t-swc/crates/next-dev-tests/tests/integration/next/import/conditions/input/app/layout.tsx b/...t-swc/crates/next-dev-tests/tests/integration/next/import/conditions/input/app/layout.tsx
@@ -0,0 +1,7 @@
+export default function RootLayout({ children }: { children: any }) {
+  return (
+    <html>
+      <body>{children}</body>
+    </html>
+  )
+}
diff --git a/...-swc/crates/next-dev-tests/tests/integration/next/import/conditions/input/app/loading.tsx b/...-swc/crates/next-dev-tests/tests/integration/next/import/conditions/input/app/loading.tsx
@@ -0,0 +1,3 @@
+export default function Loading() {
+  return <>Loading</>
+}
diff --git a/...ext-swc/crates/next-dev-tests/tests/integration/next/import/conditions/input/app/page.tsx b/...ext-swc/crates/next-dev-tests/tests/integration/next/import/conditions/input/app/page.tsx
@@ -0,0 +1,9 @@
+import Test from './test'
+
+export default function Page() {
+  return (
+    <div>
+      <Test />
+    </div>
+  )
+}
diff --git a/...tes/next-dev-tests/tests/integration/next/import/conditions/input/app/route-edge/route.js b/...tes/next-dev-tests/tests/integration/next/import/conditions/input/app/route-edge/route.js
@@ -0,0 +1,11 @@
+import edgeThenNode from 'edge-then-node'
+import nodeThenEdge from 'node-then-edge'
+
+export const runtime = 'edge'
+
+export function GET() {
+  return Response.json({
+    edgeThenNode,
+    nodeThenEdge,
+  })
+}
diff --git a/...s/next-dev-tests/tests/integration/next/import/conditions/input/app/route-nodejs/route.js b/...s/next-dev-tests/tests/integration/next/import/conditions/input/app/route-nodejs/route.js
@@ -0,0 +1,11 @@
+import edgeThenNode from 'edge-then-node'
+import nodeThenEdge from 'node-then-edge'
+
+export const runtime = 'nodejs'
+
+export function GET() {
+  return Response.json({
+    edgeThenNode,
+    nodeThenEdge,
+  })
+}
diff --git a/...next-swc/crates/next-dev-tests/tests/integration/next/import/conditions/input/app/test.js b/...next-swc/crates/next-dev-tests/tests/integration/next/import/conditions/input/app/test.js
@@ -0,0 +1,103 @@
+'use client'
+
+import { useTestHarness } from '@turbo/pack-test-harness'
+
+export default function Test() {
+  useTestHarness(runTests)
+}
+
+async function getJson(url) {
+  const res = await fetch(url)
+  const text = await res.text()
+  const jsonText = /(\{[^}]*\})/.exec(text)
+  return JSON.parse(jsonText[0].replace(/&quot;/g, '"'))
+}
+
+function runTests() {
+  it('page with nodejs runtime should import node conditions', async () => {
+    const json = await getJson('/page-nodejs')
+    expect(json).toMatchObject({
+      edgeThenNode: 'node',
+      nodeThenEdge: 'node',
+    })
+  })
+
+  it('page with edge runtime should import edge conditions', async () => {
+    const json = await getJson('/page-edge')
+    // TODO We don't currently support edge config in page rendering.
+    // When we do, this needs to be updated.
+    expect(json).not.toMatchObject({
+      edgeThenNode: 'edge',
+      nodeThenEdge: 'edge',
+    })
+    // TODO: delete this.
+    expect(json).toMatchObject({
+      edgeThenNode: 'node',
+      nodeThenEdge: 'node',
+    })
+  })
+
+  it('page api with nodejs runtime should import node conditions', async () => {
+    const json = await getJson('/api/api-nodejs')
+    expect(json).toMatchObject({
+      edgeThenNode: 'node',
+      nodeThenEdge: 'node',
+    })
+  })
+
+  it('page api with edge runtime should import edge conditions', async () => {
+    const json = await getJson('/api/api-edge')
+    expect(json).toMatchObject({
+      edgeThenNode: 'edge',
+      nodeThenEdge: 'edge',
+    })
+  })
+
+  it('app with nodejs runtime should import node conditions', async () => {
+    const json = await getJson('/app-nodejs')
+    expect(json).toMatchObject({
+      edgeThenNode: 'node',
+      nodeThenEdge: 'node',
+    })
+  })
+
+  it('app with edge runtime should import edge conditions', async () => {
+    const json = await getJson('/app-edge')
+    // TODO We don't currently support edge config in app rendering.
+    // When we do, this needs to be updated.
+    expect(json).not.toMatchObject({
+      edgeThenNode: 'edge',
+      nodeThenEdge: 'edge',
+    })
+    // TODO: delete this.
+    expect(json).toMatchObject({
+      edgeThenNode: 'node',
+      nodeThenEdge: 'node',
+    })
+  })
+
+  it('app route with nodejs runtime should import node conditions', async () => {
+    const json = await getJson('/route-nodejs')
+    expect(json).toMatchObject({
+      edgeThenNode: 'node',
+      nodeThenEdge: 'node',
+    })
+  })
+
+  it('app route with edge runtime should import edge conditions', async () => {
+    const json = await getJson('/route-edge')
+    expect(json).toMatchObject({
+      edgeThenNode: 'edge',
+      nodeThenEdge: 'edge',
+    })
+  })
+
+  it('middleware should import edge conditions', async () => {
+    const res = await fetch('/middleware')
+    const json = await res.json()
+    expect(json).toMatchObject({
+      edgeThenNode: 'edge',
+      nodeThenEdge: 'edge',
+    })
+  })
+}
diff --git a/...s/next-dev-tests/tests/integration/next/import/conditions/input/edge-then-node/default.js b/...s/next-dev-tests/tests/integration/next/import/conditions/input/edge-then-node/default.js
@@ -0,0 +1 @@
+module.exports = 'default'
diff --git a/...ates/next-dev-tests/tests/integration/next/import/conditions/input/edge-then-node/edge.js b/...ates/next-dev-tests/tests/integration/next/import/conditions/input/edge-then-node/edge.js
@@ -0,0 +1 @@
+module.exports = 'edge'
diff --git a/...ates/next-dev-tests/tests/integration/next/import/conditions/input/edge-then-node/main.js b/...ates/next-dev-tests/tests/integration/next/import/conditions/input/edge-then-node/main.js
@@ -0,0 +1 @@
+module.exports = 'main'
diff --git a/...ates/next-dev-tests/tests/integration/next/import/conditions/input/edge-then-node/node.js b/...ates/next-dev-tests/tests/integration/next/import/conditions/input/edge-then-node/node.js
@@ -0,0 +1 @@
+module.exports = 'node'
diff --git a/...next-dev-tests/tests/integration/next/import/conditions/input/edge-then-node/package.json b/...next-dev-tests/tests/integration/next/import/conditions/input/edge-then-node/package.json
@@ -0,0 +1,10 @@
+{
+  "main": "main.js",
+  "exports": {
+    ".": {
+      "edge-light": "./edge.js",
+      "node": "./node.js",
+      "default": "./default.js"
+    }
+  }
+}
diff --git a/...xt-swc/crates/next-dev-tests/tests/integration/next/import/conditions/input/middleware.js b/...xt-swc/crates/next-dev-tests/tests/integration/next/import/conditions/input/middleware.js
@@ -0,0 +1,13 @@
+import edgeThenNode from 'edge-then-node'
+import nodeThenEdge from 'node-then-edge'
+
+export const config = {
+  matcher: '/middleware',
+}
+
+export function middleware() {
+  return Response.json({
+    edgeThenNode,
+    nodeThenEdge,
+  })
+}
diff --git a/...s/next-dev-tests/tests/integration/next/import/conditions/input/node-then-edge/default.js b/...s/next-dev-tests/tests/integration/next/import/conditions/input/node-then-edge/default.js
@@ -0,0 +1 @@
+module.exports = 'default'
diff --git a/...ates/next-dev-tests/tests/integration/next/import/conditions/input/node-then-edge/edge.js b/...ates/next-dev-tests/tests/integration/next/import/conditions/input/node-then-edge/edge.js
@@ -0,0 +1 @@
+module.exports = 'edge'
diff --git a/...ates/next-dev-tests/tests/integration/next/import/conditions/input/node-then-edge/main.js b/...ates/next-dev-tests/tests/integration/next/import/conditions/input/node-then-edge/main.js
@@ -0,0 +1 @@
+module.exports = 'main'
diff --git a/...ates/next-dev-tests/tests/integration/next/import/conditions/input/node-then-edge/node.js b/...ates/next-dev-tests/tests/integration/next/import/conditions/input/node-then-edge/node.js
@@ -0,0 +1 @@
+module.exports = 'node'
diff --git a/...next-dev-tests/tests/integration/next/import/conditions/input/node-then-edge/package.json b/...next-dev-tests/tests/integration/next/import/conditions/input/node-then-edge/package.json
@@ -0,0 +1,10 @@
+{
+  "main": "main.js",
+  "exports": {
+    ".": {
+      "node": "./node.js",
+      "edge-light": "./edge.js",
+      "default": "./default.js"
+    }
+  }
+}
diff --git a/...next-dev-tests/tests/integration/next/import/conditions/input/node_modules/edge-then-node b/...next-dev-tests/tests/integration/next/import/conditions/input/node_modules/edge-then-node
diff --git a/...next-dev-tests/tests/integration/next/import/conditions/input/node_modules/node-then-edge b/...next-dev-tests/tests/integration/next/import/conditions/input/node_modules/node-then-edge
diff --git a/...ext-swc/crates/next-dev-tests/tests/integration/next/import/conditions/input/package.json b/...ext-swc/crates/next-dev-tests/tests/integration/next/import/conditions/input/package.json
@@ -0,0 +1,6 @@
+{
+  "dependencies": {
+    "edge-then-node": "file:edge-then-node",
+    "node-then-edge": "file:node-then-edge"
+  }
+}
diff --git a/...rates/next-dev-tests/tests/integration/next/import/conditions/input/pages/api/api-edge.js b/...rates/next-dev-tests/tests/integration/next/import/conditions/input/pages/api/api-edge.js
@@ -0,0 +1,14 @@
+import edgeThenNode from 'edge-then-node'
+import nodeThenEdge from 'node-then-edge'
+
+export const config = {
+  runtime: 'edge',
+}
+
+export default function ApiEdge() {
+  return Response.json({
+    NEXT_RUNTIME: process.env.NEXT_RUNTIME,
+    edgeThenNode,
+    nodeThenEdge,
+  })
+}
diff --git a/...tes/next-dev-tests/tests/integration/next/import/conditions/input/pages/api/api-nodejs.js b/...tes/next-dev-tests/tests/integration/next/import/conditions/input/pages/api/api-nodejs.js
@@ -0,0 +1,14 @@
+import edgeThenNode from 'edge-then-node'
+import nodeThenEdge from 'node-then-edge'
+
+export const config = {
+  runtime: 'nodejs',
+}
+
+export default function ApiNodeJs(req, res) {
+  res.status(200).json({
+    NEXT_RUNTIME: process.env.NEXT_RUNTIME,
+    edgeThenNode,
+    nodeThenEdge,
+  })
+}
diff --git a/...c/crates/next-dev-tests/tests/integration/next/import/conditions/input/pages/page-edge.js b/...c/crates/next-dev-tests/tests/integration/next/import/conditions/input/pages/page-edge.js
@@ -0,0 +1,13 @@
+import edgeThenNode from 'edge-then-node'
+import nodeThenEdge from 'node-then-edge'
+
+export const config = {
+  runtime: 'experimental-edge',
+}
+
+export default function PageEdge() {
+  return JSON.stringify({
+    edgeThenNode,
+    nodeThenEdge,
+  })
+}
diff --git a/...crates/next-dev-tests/tests/integration/next/import/conditions/input/pages/page-nodejs.js b/...crates/next-dev-tests/tests/integration/next/import/conditions/input/pages/page-nodejs.js
@@ -0,0 +1,13 @@
+import edgeThenNode from 'edge-then-node'
+import nodeThenEdge from 'node-then-edge'
+
+export const config = {
+  runtime: 'nodejs',
+}
+
+export default function PageNodeJs() {
+  return JSON.stringify({
+    edgeThenNode,
+    nodeThenEdge,
+  })
+}
diff --git a/...xt/import/conditions/issues/error TP1003 require.resolve(__q____q____q____star-76ea5d.txt b/...xt/import/conditions/issues/error TP1003 require.resolve(__q____q____q____star-76ea5d.txt
@@ -0,0 +1,35 @@
+PlainIssue {
+    severity: Warning,
+    context: "[project]/packages/next/dist/compiled/edge-runtime/index.js",
+    category: "parse",
+    title: "error TP1003 require.resolve(???*0*, {\"paths\": [???*1*]}) is not statically analyse-able",
+    description: "- *0* arguments[1]\n  ⚠\u{fe0f}  function calls are not analysed yet\n- *1* ???*2*[\"dirname\"](a)\n  ⚠\u{fe0f}  unknown callee object\n- *2* ???(17)\n  ⚠\u{fe0f}  unknown callee",
+    detail: "",
+    documentation_link: "",
+    source: Some(
+        PlainIssueSource {
+            asset: PlainAsset {
+                ident: "[project]/packages/next/dist/compiled/edge-runtime/index.js",
+            },
+            start: SourcePos {
+                line: 0,
+                column: 6730,
+            },
+            end: SourcePos {
+                line: 0,
+                column: 6730,
+            },
+        },
+    ),
+    sub_issues: [],
+    processing_path: Some(
+        [
+            PlainIssueProcessingPathItem {
+                context: Some(
+                    "[project]/packages/next-swc/crates/next-dev-tests/tests/temp/next/import/conditions/input/app",
+                ),
+                description: "Next.js App Route /route-nodejs",
+            },
+        ],
+    ),
+}