first commit

test/integration/jsconfig-paths/.gitignore

@@ -0,0 +1 @@
+!node_modules

test/integration/jsconfig-paths/components/hello.js

@@ -0,0 +1,5 @@
+import React from 'react'
+
+export function Hello() {
+  return <>Hello</>
+}

test/integration/jsconfig-paths/components/world.js

@@ -0,0 +1,5 @@
+import React from 'react'
+
+export function World() {
+  return <>World</>
+}

test/integration/jsconfig-paths/jsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "@c/*": ["components/*"],
+      "@lib/*": ["lib/a/*", "lib/b/*"],
+      "@mycomponent": ["components/hello.js"]
+    }
+  },
+  "exclude": ["node_modules", "**/*.test.ts", "**/*.test.tsx"]
+}

test/integration/jsconfig-paths/lib/a/api.js

@@ -0,0 +1,5 @@
+import data from 'mypackage/data'
+
+console.log(data)
+
+export default () => 'Hello from a'

test/integration/jsconfig-paths/lib/b/api.js

@@ -0,0 +1 @@
+export default () => 'Hello from b'

test/integration/jsconfig-paths/lib/b/b-only.js

@@ -0,0 +1 @@
+export default () => 'Hello from only b'

test/integration/jsconfig-paths/next.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  onDemandEntries: {
+    // Make sure entries are not getting disposed.
+    maxInactiveAge: 1000 * 60 * 60,
+  },
+}

test/integration/jsconfig-paths/node_modules/mypackage/data.js

@@ -0,0 +1,3 @@
+module.exports = {
+  hello: 'world',
+}

test/integration/jsconfig-paths/node_modules/mypackage/myfile.js

@@ -0,0 +1,3 @@
+module.exports = {
+  hello: 'world',
+}

test/integration/jsconfig-paths/pages/basic-alias.js

@@ -0,0 +1,17 @@
+import React from 'react'
+import { World } from '@c/world'
+
+// prevent static generation
+export function getServerSideProps() {
+  return {
+    props: {},
+  }
+}
+
+export default function HelloPage() {
+  return (
+    <div>
+      <World />
+    </div>
+  )
+}

test/integration/jsconfig-paths/pages/resolve-fallback.js

@@ -0,0 +1,13 @@
+import React from 'react'
+import api from '@lib/b-only'
+
+// prevent static generation
+export function getServerSideProps() {
+  return {
+    props: {},
+  }
+}
+
+export default function ResolveOrder() {
+  return <div>{api()}</div>
+}

test/integration/jsconfig-paths/pages/resolve-order.js

@@ -0,0 +1,13 @@
+import React from 'react'
+import api from '@lib/api'
+
+// prevent static generation
+export function getServerSideProps() {
+  return {
+    props: {},
+  }
+}
+
+export default function ResolveOrder() {
+  return <div>{api()}</div>
+}

test/integration/jsconfig-paths/pages/single-alias.js

@@ -0,0 +1,16 @@
+import { Hello } from '@mycomponent'
+
+// prevent static generation
+export function getServerSideProps() {
+  return {
+    props: {},
+  }
+}
+
+export default function SingleAlias() {
+  return (
+    <div>
+      <Hello />
+    </div>
+  )
+}

test/integration/jsconfig-paths/test/index.test.ts

@@ -0,0 +1,159 @@
+/* eslint-env jest */
+
+import fs from 'fs-extra'
+import { join } from 'path'
+import cheerio from 'cheerio'
+import stripAnsi from 'next/dist/compiled/strip-ansi'
+import * as path from 'path'
+import {
+  renderViaHTTP,
+  findPort,
+  launchApp,
+  nextBuild,
+  killApp,
+  retry,
+  File,
+} from 'next-test-utils'
+import * as JSON5 from 'json5'
+
+const appDir = join(__dirname, '..')
+let appPort
+let app
+
+async function get$(path, query?: any) {
+  const html = await renderViaHTTP(appPort, path, query)
+  return cheerio.load(html)
+}
+
+function runTests() {
+  describe('default behavior', () => {
+    let output = ''
+
+    beforeAll(async () => {
+      appPort = await findPort()
+      app = await launchApp(appDir, appPort, {
+        onStderr(msg) {
+          output += msg || ''
+        },
+        onStdout(msg) {
+          output += msg || ''
+        },
+      })
+    })
+    afterAll(() => killApp(app))
+
+    it('should alias components', async () => {
+      const $ = await get$('/basic-alias')
+      expect($('body').text()).toMatch(/World/)
+    })
+
+    it('should resolve the first item in the array first', async () => {
+      const $ = await get$('/resolve-order')
+      expect($('body').text()).toMatch(/Hello from a/)
+    })
+
+    it('should resolve the second item as fallback', async () => {
+      const $ = await get$('/resolve-fallback')
+      expect($('body').text()).toMatch(/Hello from only b/)
+    })
+
+    it('should resolve a single matching alias', async () => {
+      const $ = await get$('/single-alias')
+      expect($('body').text()).toMatch(/Hello/)
+    })
+
+    it('should have correct module not found error', async () => {
+      const basicPage = join(appDir, 'pages/basic-alias.js')
+      const contents = await fs.readFile(basicPage, 'utf8')
+
+      try {
+        await fs.writeFile(basicPage, contents.replace('@c/world', '@c/worldd'))
+
+        await retry(async () => {
+          await renderViaHTTP(appPort, '/basic-alias')
+          expect(stripAnsi(output)).toMatch(
+            /Module not found: Can't resolve '@c\/worldd'/
+          )
+        })
+      } finally {
+        await fs.writeFile(basicPage, contents)
+      }
+    })
+  })
+
+  describe('should build', () => {
+    ;(process.env.TURBOPACK_DEV ? describe.skip : describe)(
+      'production mode',
+      () => {
+        beforeAll(async () => {
+          await nextBuild(appDir)
+        })
+        it('should trace correctly', async () => {
+          const singleAliasTrace = await fs.readJSON(
+            join(appDir, '.next/server/pages/single-alias.js.nft.json')
+          )
+          const resolveOrderTrace = await fs.readJSON(
+            join(appDir, '.next/server/pages/resolve-order.js.nft.json')
+          )
+          const resolveFallbackTrace = await fs.readJSON(
+            join(appDir, '.next/server/pages/resolve-fallback.js.nft.json')
+          )
+          const basicAliasTrace = await fs.readJSON(
+            join(appDir, '.next/server/pages/basic-alias.js.nft.json')
+          )
+
+          expect(
+            singleAliasTrace.files.some((file) =>
+              file.includes('components/hello.js')
+            )
+          ).toBe(false)
+          expect(
+            resolveOrderTrace.files.some((file) =>
+              file.includes('lib/a/api.js')
+            )
+          ).toBe(false)
+          expect(
+            resolveOrderTrace.files.some((file) =>
+              file.includes('mypackage/data.js')
+            )
+          ).toBe(true)
+          expect(
+            resolveFallbackTrace.files.some((file) =>
+              file.includes('lib/b/b-only.js')
+            )
+          ).toBe(false)
+          expect(
+            basicAliasTrace.files.some((file) =>
+              file.includes('components/world.js')
+            )
+          ).toBe(false)
+        })
+      }
+    )
+  })
+}
+
+describe('jsconfig paths', () => {
+  runTests()
+})
+
+const jsconfig = new File(path.resolve(__dirname, '../jsconfig.json'))
+
+describe('jsconfig paths without baseurl', () => {
+  beforeAll(() => {
+    const jsconfigContent = JSON5.parse(jsconfig.originalContent)
+    delete jsconfigContent.compilerOptions.baseUrl
+    jsconfigContent.compilerOptions.paths = {
+      '@c/*': ['./components/*'],
+      '@lib/*': ['./lib/a/*', './lib/b/*'],
+      '@mycomponent': ['./components/hello.js'],
+    }
+    jsconfig.write(JSON.stringify(jsconfigContent, null, 2))
+  })
+
+  afterAll(() => {
+    jsconfig.restore()
+  })
+
+  runTests()
+})