Skip to content

Commit

Permalink
revert "Apply react-server condition for pages api (#57459)" (#57500)
Browse files Browse the repository at this point in the history
This reverts commit 6b18f39.

<!-- 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 #

-->
  • Loading branch information
feedthejim authored Oct 26, 2023
1 parent c7d02f4 commit 3e7f96e
Show file tree
Hide file tree
Showing 4 changed files with 59 additions and 45 deletions.
26 changes: 17 additions & 9 deletions packages/next/src/build/webpack-config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -454,12 +454,13 @@ export default async function getBaseWebpackConfig(
].filter(Boolean)
: []

const swcLoaderForMiddlewareLayer =
// When using Babel, we will have to use SWC to do the optimization
// for middleware to tree shake the unused default optimized imports like "next/server".
// This will cause some performance overhead but
// acceptable as Babel will not be recommended.
[swcServerLayerLoader, babelLoader].filter(Boolean)
const swcLoaderForMiddlewareLayer = useSWCLoader
? swcServerLayerLoader
: // When using Babel, we will have to use SWC to do the optimization
// for middleware to tree shake the unused default optimized imports like "next/server".
// This will cause some performance overhead but
// acceptable as Babel will not be recommended.
[swcServerLayerLoader, babelLoader]

// client components layers: SSR + browser
const swcLoaderForClientLayer = [
Expand Down Expand Up @@ -487,9 +488,16 @@ export default async function getBaseWebpackConfig(
: []),
]

// Loader for API routes will also apply react-server export condition for bundling,
// and the API checks for server side only APIs.
const loaderForAPIRoutes = [swcServerLayerLoader, babelLoader].filter(Boolean)
// Loader for API routes needs to be differently configured as it shouldn't
// have RSC transpiler enabled, so syntax checks such as invalid imports won't
// be performed.
const loaderForAPIRoutes =
hasAppDir && useSWCLoader
? getSwcLoader({
serverComponents: false,
isReactServerLayer: false,
})
: defaultLoaders.babel

const pageExtensions = config.pageExtensions

Expand Down
4 changes: 4 additions & 0 deletions test/e2e/app-dir/rsc-basic/pages/api/import-test.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
// You can still import React and Next's client component APIs from the server
// they won't be poisoned by the environment.
// eslint-disable-next-line no-unused-vars
import { useState } from 'react'
import 'next/headers'

export default function (_, res) {
Expand Down
72 changes: 37 additions & 35 deletions test/e2e/module-layer/index.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { createNextDescribe } from 'e2e-utils'
import { check, getRedboxSource, hasRedbox } from 'next-test-utils'
import { getRedboxSource, hasRedbox } from 'next-test-utils'

createNextDescribe(
'module layer',
Expand Down Expand Up @@ -68,49 +68,51 @@ createNextDescribe(
// Should error for using mixed (with client-only) in server targets
if (isNextDev) {
describe('no server-only in server targets', () => {
it('should error when import client-only in middleware', async () => {
const middlewareFile = 'middleware.js'
const middlewareContent = await next.readFile(middlewareFile)
const middlewareFile = 'middleware.js'
// const pagesApiFile = 'pages/api/hello.js'
let middlewareContent = ''
// let pagesApiContent = ''

beforeAll(async () => {
await next.stop()

middlewareContent = await next.readFile(middlewareFile)
// pagesApiContent = await next.readFile(pagesApiFile)

await next.patchFile(
middlewareFile,
middlewareContent.replace(
"// import './lib/mixed-lib'",
"import './lib/mixed-lib'"
)
middlewareContent
// .replace("import 'server-only'", "// import 'server-only'")
.replace(
"// import './lib/mixed-lib'",
"import './lib/mixed-lib'"
)
)
const browser = await next.browser('/')

expect(await hasRedbox(browser, true)).toBe(true)
expect(await getRedboxSource(browser)).toContain(
`You're importing a component that imports client-only. It only works in a Client Component but none of its parents are marked with "use client", so they're Server Components by default.`
)
// await next.patchFile(
// pagesApiFile,
// pagesApiContent
// .replace("import 'server-only'", "// import 'server-only'")
// .replace(
// "// import '../../lib/mixed-lib'",
// "import '../../lib/mixed-lib'"
// )
// )

await next.start()
})
afterAll(async () => {
await next.patchFile(middlewareFile, middlewareContent)
// await next.patchFile(pagesApiFile, pagesApiContent)
})

it('should error when import client-only in pages/api', async () => {
const pagesApiFile = 'pages/api/mixed.js'
const pagesApiContent = await next.readFile(pagesApiFile)
await next.patchFile(
pagesApiFile,
pagesApiContent.replace(
"// import 'client-only'",
"import 'client-only'"
)
)

const existingCliOutputLength = next.cliOutput.length
await check(async () => {
await next.fetch('/api/mixed')
const newCliOutput = next.cliOutput.slice(existingCliOutputLength)
expect(newCliOutput).toContain('./pages/api/mixed.js')
expect(newCliOutput).toContain(
`You're importing a component that imports client-only. It only works in a Client Component but none of its parents are marked with "use client", so they're Server Components by default.`
)
return 'success'
}, 'success')
it('should error when import client-only in middleware', async () => {
const browser = await next.browser('/')

await next.patchFile(pagesApiFile, pagesApiContent)
expect(await hasRedbox(browser, true)).toBe(true)
expect(await getRedboxSource(browser)).toContain(
`You're importing a component that imports client-only. It only works in a Client Component but none of its parents are marked with "use client", so they're Server Components by default.`
)
})
})
}
Expand Down
2 changes: 1 addition & 1 deletion test/e2e/module-layer/pages/api/mixed.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// import 'client-only'
import '../../lib/mixed-lib'

export default function handler(req, res) {
return res.send('pages/api/mixed.js:')
Expand Down

0 comments on commit 3e7f96e

Please sign in to comment.