Skip to content

Commit

Permalink
Fix filesystempublicroutes test for Turbopack (#61132)
Browse files Browse the repository at this point in the history
## What?

`exportPathMap` didn't work when Turbopack was enabled because the
`serializeNextConfig` function mutates the original values, overriding
`exportPathMap`.

This PR changes the serialization to copy the object and mutate only the
copied object.

Also refactored the test that was checking `_next`, the better way to
test that is to have the page render something dynamically, which is
what is added in this PR.

<!-- 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-2225
  • Loading branch information
timneutkens authored Jan 25, 2024
1 parent fdd1586 commit 9cc7167
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 31 deletions.
12 changes: 8 additions & 4 deletions packages/next/src/build/swc/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1056,7 +1056,8 @@ function bindingToApi(binding: any, _wasm: boolean) {
nextConfig: NextConfigComplete,
projectPath: string
): Promise<string> {
let nextConfigSerializable = nextConfig as any
// Avoid mutating the existing `nextConfig` object.
let nextConfigSerializable = { ...(nextConfig as any) }

nextConfigSerializable.generateBuildId =
await nextConfig.generateBuildId?.()
Expand Down Expand Up @@ -1091,9 +1092,12 @@ function bindingToApi(binding: any, _wasm: boolean) {
: undefined

// loaderFile is an absolute path, we need it to be relative for turbopack.
if (nextConfig.images.loaderFile) {
nextConfig.images.loaderFile =
'./' + path.relative(projectPath, nextConfig.images.loaderFile)
if (nextConfigSerializable.images.loaderFile) {
nextConfigSerializable.images = {
...nextConfig.images,
loaderFile:
'./' + path.relative(projectPath, nextConfig.images.loaderFile),
}
}

return JSON.stringify(nextConfigSerializable, null, 2)
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1,14 @@
export default () => <div>exportpathmap was here</div>
import { useEffect } from 'react'
import { useState } from 'react'
export default function ExportPathMapRoute() {
const [mounted, setMounted] = useState(false)
useEffect(() => {
setMounted(true)
}, [])
return (
<div>
<h1>exportpathmap was here</h1>
{mounted ? <div id="page-was-loaded">Hello World</div> : null}
</div>
)
}
29 changes: 8 additions & 21 deletions test/integration/filesystempublicroutes/test/index.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,8 @@

import { join } from 'path'
import getPort from 'get-port'
import {
fetchViaHTTP,
initNextServerScript,
killApp,
getPageFileFromBuildManifest,
} from 'next-test-utils'
import { fetchViaHTTP, initNextServerScript, killApp } from 'next-test-utils'
import webdriver from 'next-webdriver'

const appDir = join(__dirname, '../')
let appPort
Expand Down Expand Up @@ -40,23 +36,14 @@ describe('FileSystemPublicRoutes', () => {
const res = await fetch('/exportpathmap-route')
expect(res.status).toBe(200)
const body = await res.text()
expect(body).toMatch(
process.env.TURBOPACK ? /turbopack/ : /exportpathmap was here/
)
expect(body).toMatch(/exportpathmap was here/)
})

it('should still handle /_next routes', async () => {
await fetch('/exportpathmap-route') // make sure it's built
const pageFile = getPageFileFromBuildManifest(
appDir,
'/exportpathmap-route'
)
const res = await fetch(join('/_next', pageFile))
expect(res.status).toBe(200)
const body = await res.text()
expect(body).toMatch(
process.env.TURBOPACK ? /turbopack/ : /exportpathmap was here/
)
it('should serve JavaScript files correctly', async () => {
const browser = await webdriver(context.appPort, '/exportpathmap-route')

const text = await browser.waitForElementByCss('#page-was-loaded').text()
expect(text).toBe('Hello World')
})

it('should route to public folder files', async () => {
Expand Down
9 changes: 4 additions & 5 deletions test/turbopack-tests-manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -10749,13 +10749,12 @@
},
"test/integration/filesystempublicroutes/test/index.test.js": {
"passed": [
"FileSystemPublicRoutes should route to public folder files",
"FileSystemPublicRoutes should still handle /_next routes"
],
"failed": [
"FileSystemPublicRoutes should not route to the index page",
"FileSystemPublicRoutes should route to exportPathMap defined routes in development"
"FileSystemPublicRoutes should route to exportPathMap defined routes in development",
"FileSystemPublicRoutes should route to public folder files",
"FileSystemPublicRoutes should serve JavaScript files correctly"
],
"failed": [],
"pending": [],
"flakey": [],
"runtimeError": false
Expand Down

0 comments on commit 9cc7167

Please sign in to comment.