Unverified Commit ffc0e541 authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

Allow server-only in server targets and client-only in client components…

Allow server-only in server targets  and client-only in client components targets to be available (#55394)

Users want to use `server-only` to restrict the middleware / app routes / pages api, but now it's failing as we're treating them as different webpack layers, but validating the `server-only` only with server components layers.

Here we modify the rules a bit to let everyone can use "server-only" for the bundles that targeting server-side.

For next-swc transformer, we introduce the new option `bundleType` which only has `"server" | "client" | "default"` 3 values:
* - `server`  for server-side targets, like server components, app routes, pages api, middleware
* - `client`   for client components targets such as client components app pages, or page routes under pages directory.
* - `default` for environment like jest, we don't validate module graph with swc, replaced the `disable_checks` introduced  [#54891](https://github.com/vercel/next.js/pull/54891).

Refactor a bit webpack-config to adapt to the new rules, after that `server-only` will be able to used in the server-side targets conventions like middleware and `pages/api`

Fixes #43700
Fixes #54549
Fixes #52833

Closes NEXT-1616
Closes NEXT-1607
Closes NEXT-1385
parent b2facf58
...@@ -46,7 +46,8 @@ use turbopack_binding::swc::{ ...@@ -46,7 +46,8 @@ use turbopack_binding::swc::{
SyntaxContext, SyntaxContext,
}, },
ecma::{ ecma::{
ast::EsVersion, parser::parse_file_as_module, transforms::base::pass::noop, visit::Fold, ast::EsVersion, atoms::JsWord, parser::parse_file_as_module,
transforms::base::pass::noop, visit::Fold,
}, },
}, },
custom_transform::modularize_imports, custom_transform::modularize_imports,
...@@ -97,7 +98,7 @@ pub struct TransformOptions { ...@@ -97,7 +98,7 @@ pub struct TransformOptions {
pub is_server: bool, pub is_server: bool,
#[serde(default)] #[serde(default)]
pub disable_checks: bool, pub bundle_target: JsWord,
#[serde(default)] #[serde(default)]
pub server_components: Option<react_server_components::Config>, pub server_components: Option<react_server_components::Config>,
...@@ -198,7 +199,7 @@ where ...@@ -198,7 +199,7 @@ where
config.clone(), config.clone(),
comments.clone(), comments.clone(),
opts.app_dir.clone(), opts.app_dir.clone(),
opts.disable_checks opts.bundle_target.clone()
)), )),
_ => Either::Right(noop()), _ => Either::Right(noop()),
}, },
......
...@@ -50,7 +50,7 @@ struct ReactServerComponents<C: Comments> { ...@@ -50,7 +50,7 @@ struct ReactServerComponents<C: Comments> {
invalid_client_imports: Vec<JsWord>, invalid_client_imports: Vec<JsWord>,
invalid_server_react_apis: Vec<JsWord>, invalid_server_react_apis: Vec<JsWord>,
invalid_server_react_dom_apis: Vec<JsWord>, invalid_server_react_dom_apis: Vec<JsWord>,
disable_checks: bool, bundle_target: String,
} }
struct ModuleImports { struct ModuleImports {
...@@ -67,15 +67,25 @@ impl<C: Comments> VisitMut for ReactServerComponents<C> { ...@@ -67,15 +67,25 @@ impl<C: Comments> VisitMut for ReactServerComponents<C> {
let is_cjs = contains_cjs(module); let is_cjs = contains_cjs(module);
if self.is_server { if self.is_server {
if !is_client_entry { if is_client_entry {
self.assert_server_graph(&imports, module);
} else {
self.to_module_ref(module, is_cjs); self.to_module_ref(module, is_cjs);
return; return;
} else if self.bundle_target == "server" {
// Only assert server graph if file's bundle target is "server", e.g.
// * server components pages
// * pages bundles on SSR layer
// * middleware
// * app/pages api routes
self.assert_server_graph(&imports, module);
} }
} else { } else {
if !is_action_file { // Only assert client graph if the file is not an action file,
self.assert_client_graph(&imports, module); // and bundle target is "client" e.g.
// * client components pages
// * pages bundles on browser layer
if !is_action_file && self.bundle_target == "client" {
self.assert_client_graph(&imports);
self.assert_invalid_api(module, true);
} }
if is_client_entry { if is_client_entry {
self.prepend_comment_node(module, is_cjs); self.prepend_comment_node(module, is_cjs);
...@@ -129,7 +139,7 @@ impl<C: Comments> ReactServerComponents<C> { ...@@ -129,7 +139,7 @@ impl<C: Comments> ReactServerComponents<C> {
if is_action_file { if is_action_file {
panic_both_directives(expr_stmt.span) panic_both_directives(expr_stmt.span)
} }
} else if !self.disable_checks { } else if self.bundle_target != "default" {
HANDLER.with(|handler| { HANDLER.with(|handler| {
handler handler
.struct_span_err( .struct_span_err(
...@@ -334,9 +344,6 @@ impl<C: Comments> ReactServerComponents<C> { ...@@ -334,9 +344,6 @@ impl<C: Comments> ReactServerComponents<C> {
} }
fn assert_server_graph(&self, imports: &[ModuleImports], module: &Module) { fn assert_server_graph(&self, imports: &[ModuleImports], module: &Module) {
if self.disable_checks {
return;
}
for import in imports { for import in imports {
let source = import.source.0.clone(); let source = import.source.0.clone();
if self.invalid_server_imports.contains(&source) { if self.invalid_server_imports.contains(&source) {
...@@ -408,10 +415,7 @@ impl<C: Comments> ReactServerComponents<C> { ...@@ -408,10 +415,7 @@ impl<C: Comments> ReactServerComponents<C> {
} }
} }
fn assert_client_graph(&self, imports: &[ModuleImports], module: &Module) { fn assert_client_graph(&self, imports: &[ModuleImports]) {
if self.disable_checks {
return;
}
for import in imports { for import in imports {
let source = import.source.0.clone(); let source = import.source.0.clone();
if self.invalid_client_imports.contains(&source) { if self.invalid_client_imports.contains(&source) {
...@@ -425,8 +429,6 @@ impl<C: Comments> ReactServerComponents<C> { ...@@ -425,8 +429,6 @@ impl<C: Comments> ReactServerComponents<C> {
}) })
} }
} }
self.assert_invalid_api(module, true);
} }
fn assert_invalid_api(&self, module: &Module, is_client_entry: bool) { fn assert_invalid_api(&self, module: &Module, is_client_entry: bool) {
...@@ -567,17 +569,17 @@ pub fn server_components<C: Comments>( ...@@ -567,17 +569,17 @@ pub fn server_components<C: Comments>(
config: Config, config: Config,
comments: C, comments: C,
app_dir: Option<PathBuf>, app_dir: Option<PathBuf>,
disable_checks: bool, bundle_target: JsWord,
) -> impl Fold + VisitMut { ) -> impl Fold + VisitMut {
let is_server: bool = match &config { let is_server: bool = match &config {
Config::WithOptions(x) => x.is_server, Config::WithOptions(x) => x.is_server,
_ => true, _ => true,
}; };
as_folder(ReactServerComponents { as_folder(ReactServerComponents {
disable_checks,
is_server, is_server,
comments, comments,
filepath: filename.to_string(), filepath: filename.to_string(),
bundle_target: bundle_target.to_string(),
app_dir, app_dir,
export_names: vec![], export_names: vec![],
invalid_server_imports: vec![ invalid_server_imports: vec![
......
...@@ -97,7 +97,7 @@ fn react_server_components_server_graph_errors(input: PathBuf) { ...@@ -97,7 +97,7 @@ fn react_server_components_server_graph_errors(input: PathBuf) {
), ),
tr.comments.as_ref().clone(), tr.comments.as_ref().clone(),
None, None,
false, String::from("server").into(),
) )
}, },
&input, &input,
...@@ -122,7 +122,7 @@ fn react_server_components_client_graph_errors(input: PathBuf) { ...@@ -122,7 +122,7 @@ fn react_server_components_client_graph_errors(input: PathBuf) {
), ),
tr.comments.as_ref().clone(), tr.comments.as_ref().clone(),
None, None,
false, String::from("client").into(),
) )
}, },
&input, &input,
...@@ -169,7 +169,7 @@ fn react_server_actions_server_errors(input: PathBuf) { ...@@ -169,7 +169,7 @@ fn react_server_actions_server_errors(input: PathBuf) {
), ),
tr.comments.as_ref().clone(), tr.comments.as_ref().clone(),
None, None,
false String::from("default").into(),
), ),
server_actions( server_actions(
&FileName::Real("/app/item.js".into()), &FileName::Real("/app/item.js".into()),
...@@ -205,7 +205,7 @@ fn react_server_actions_client_errors(input: PathBuf) { ...@@ -205,7 +205,7 @@ fn react_server_actions_client_errors(input: PathBuf) {
), ),
tr.comments.as_ref().clone(), tr.comments.as_ref().clone(),
None, None,
false String::from("client").into(),
), ),
server_actions( server_actions(
&FileName::Real("/app/item.js".into()), &FileName::Real("/app/item.js".into()),
......
...@@ -326,7 +326,7 @@ fn react_server_components_server_graph_fixture(input: PathBuf) { ...@@ -326,7 +326,7 @@ fn react_server_components_server_graph_fixture(input: PathBuf) {
), ),
tr.comments.as_ref().clone(), tr.comments.as_ref().clone(),
None, None,
false, String::from("default").into(),
) )
}, },
&input, &input,
...@@ -348,7 +348,7 @@ fn react_server_components_no_checks_server_graph_fixture(input: PathBuf) { ...@@ -348,7 +348,7 @@ fn react_server_components_no_checks_server_graph_fixture(input: PathBuf) {
), ),
tr.comments.as_ref().clone(), tr.comments.as_ref().clone(),
None, None,
true, String::from("default").into(),
) )
}, },
&input, &input,
...@@ -370,7 +370,7 @@ fn react_server_components_client_graph_fixture(input: PathBuf) { ...@@ -370,7 +370,7 @@ fn react_server_components_client_graph_fixture(input: PathBuf) {
), ),
tr.comments.as_ref().clone(), tr.comments.as_ref().clone(),
None, None,
false, String::from("default").into(),
) )
}, },
&input, &input,
...@@ -392,7 +392,7 @@ fn react_server_components_no_checks_client_graph_fixture(input: PathBuf) { ...@@ -392,7 +392,7 @@ fn react_server_components_no_checks_client_graph_fixture(input: PathBuf) {
), ),
tr.comments.as_ref().clone(), tr.comments.as_ref().clone(),
None, None,
true, String::from("default").into(),
) )
}, },
&input, &input,
......
...@@ -81,7 +81,7 @@ fn test(input: &Path, minify: bool) { ...@@ -81,7 +81,7 @@ fn test(input: &Path, minify: bool) {
auto_modularize_imports: None, auto_modularize_imports: None,
optimize_barrel_exports: None, optimize_barrel_exports: None,
optimize_server_react: None, optimize_server_react: None,
disable_checks: false, bundle_target: String::from("default").into(),
}; };
let unresolved_mark = Mark::new(); let unresolved_mark = Mark::new();
......
...@@ -5,6 +5,8 @@ import type { ...@@ -5,6 +5,8 @@ import type {
StyledComponentsConfig, StyledComponentsConfig,
} from '../../server/config-shared' } from '../../server/config-shared'
type BundleType = 'client' | 'server' | 'default'
const nextDistPath = const nextDistPath =
/(next[\\/]dist[\\/]shared[\\/]lib)|(next[\\/]dist[\\/]client)|(next[\\/]dist[\\/]pages)/ /(next[\\/]dist[\\/]shared[\\/]lib)|(next[\\/]dist[\\/]client)|(next[\\/]dist[\\/]pages)/
...@@ -42,6 +44,7 @@ function getBaseSWCOptions({ ...@@ -42,6 +44,7 @@ function getBaseSWCOptions({
jsConfig, jsConfig,
swcCacheDir, swcCacheDir,
isServerLayer, isServerLayer,
bundleTarget,
hasServerComponents, hasServerComponents,
isServerActionsEnabled, isServerActionsEnabled,
}: { }: {
...@@ -55,6 +58,7 @@ function getBaseSWCOptions({ ...@@ -55,6 +58,7 @@ function getBaseSWCOptions({
compilerOptions: NextConfig['compiler'] compilerOptions: NextConfig['compiler']
resolvedBaseUrl?: string resolvedBaseUrl?: string
jsConfig: any jsConfig: any
bundleTarget: BundleType
swcCacheDir?: string swcCacheDir?: string
isServerLayer?: boolean isServerLayer?: boolean
hasServerComponents?: boolean hasServerComponents?: boolean
...@@ -184,7 +188,7 @@ function getBaseSWCOptions({ ...@@ -184,7 +188,7 @@ function getBaseSWCOptions({
isServer: !!isServerLayer, isServer: !!isServerLayer,
} }
: undefined, : undefined,
disableChecks: false, bundleTarget,
} }
} }
...@@ -274,13 +278,14 @@ export function getJestSWCOptions({ ...@@ -274,13 +278,14 @@ export function getJestSWCOptions({
resolvedBaseUrl, resolvedBaseUrl,
// Don't apply server layer transformations for Jest // Don't apply server layer transformations for Jest
isServerLayer: false, isServerLayer: false,
// Disable server / client graph assertions for Jest
bundleTarget: 'default',
}) })
const isNextDist = nextDistPath.test(filename) const isNextDist = nextDistPath.test(filename)
return { return {
...baseOptions, ...baseOptions,
disableChecks: true,
env: { env: {
targets: { targets: {
// Targets the current version of Node.js // Targets the current version of Node.js
...@@ -317,6 +322,7 @@ export function getLoaderSWCOptions({ ...@@ -317,6 +322,7 @@ export function getLoaderSWCOptions({
isServerLayer, isServerLayer,
isServerActionsEnabled, isServerActionsEnabled,
optimizeBarrelExports, optimizeBarrelExports,
bundleTarget = 'client',
}: // This is not passed yet as "paths" resolving is handled by webpack currently. }: // This is not passed yet as "paths" resolving is handled by webpack currently.
// resolvedBaseUrl, // resolvedBaseUrl,
{ {
...@@ -338,6 +344,7 @@ export function getLoaderSWCOptions({ ...@@ -338,6 +344,7 @@ export function getLoaderSWCOptions({
supportedBrowsers: string[] supportedBrowsers: string[]
swcCacheDir: string swcCacheDir: string
relativeFilePathFromRoot: string relativeFilePathFromRoot: string
bundleTarget: BundleType
hasServerComponents?: boolean hasServerComponents?: boolean
isServerLayer: boolean isServerLayer: boolean
isServerActionsEnabled?: boolean isServerActionsEnabled?: boolean
...@@ -357,6 +364,7 @@ export function getLoaderSWCOptions({ ...@@ -357,6 +364,7 @@ export function getLoaderSWCOptions({
hasServerComponents, hasServerComponents,
isServerLayer, isServerLayer,
isServerActionsEnabled, isServerActionsEnabled,
bundleTarget,
}) })
baseOptions.fontLoaders = { baseOptions.fontLoaders = {
fontLoaders: [ fontLoaders: [
......
...@@ -15,6 +15,7 @@ import type { ...@@ -15,6 +15,7 @@ import type {
MiddlewareManifest, MiddlewareManifest,
} from './webpack/plugins/middleware-plugin' } from './webpack/plugins/middleware-plugin'
import type { StaticGenerationAsyncStorage } from '../client/components/static-generation-async-storage.external' import type { StaticGenerationAsyncStorage } from '../client/components/static-generation-async-storage.external'
import type { WebpackLayerName } from '../lib/constants'
import '../server/require-hook' import '../server/require-hook'
import '../server/node-polyfill-fetch' import '../server/node-polyfill-fetch'
...@@ -35,6 +36,7 @@ import { ...@@ -35,6 +36,7 @@ import {
SERVER_PROPS_SSG_CONFLICT, SERVER_PROPS_SSG_CONFLICT,
MIDDLEWARE_FILENAME, MIDDLEWARE_FILENAME,
INSTRUMENTATION_HOOK_FILENAME, INSTRUMENTATION_HOOK_FILENAME,
WEBPACK_LAYERS,
} from '../lib/constants' } from '../lib/constants'
import { MODERN_BROWSERSLIST_TARGET } from '../shared/lib/constants' import { MODERN_BROWSERSLIST_TARGET } from '../shared/lib/constants'
import prettyBytes from '../lib/pretty-bytes' import prettyBytes from '../lib/pretty-bytes'
...@@ -2116,3 +2118,15 @@ export function getSupportedBrowsers( ...@@ -2116,3 +2118,15 @@ export function getSupportedBrowsers(
// Uses modern browsers as the default. // Uses modern browsers as the default.
return MODERN_BROWSERSLIST_TARGET return MODERN_BROWSERSLIST_TARGET
} }
export function isWebpackServerLayer(
layer: WebpackLayerName | null | undefined
): boolean {
return Boolean(layer && WEBPACK_LAYERS.GROUP.server.includes(layer as any))
}
export function isWebpackDefaultLayer(
layer: WebpackLayerName | null | undefined
): boolean {
return layer === null || layer === undefined
}
This diff is collapsed.
...@@ -54,6 +54,7 @@ async function loaderTransform( ...@@ -54,6 +54,7 @@ async function loaderTransform(
hasServerComponents, hasServerComponents,
isServerLayer, isServerLayer,
optimizeBarrelExports, optimizeBarrelExports,
bundleTarget,
} = loaderOptions } = loaderOptions
const isPageFile = filename.startsWith(pagesDir) const isPageFile = filename.startsWith(pagesDir)
const relativeFilePathFromRoot = path.relative(rootDir, filename) const relativeFilePathFromRoot = path.relative(rootDir, filename)
...@@ -86,6 +87,7 @@ async function loaderTransform( ...@@ -86,6 +87,7 @@ async function loaderTransform(
isServerActionsEnabled: nextConfig?.experimental?.serverActions, isServerActionsEnabled: nextConfig?.experimental?.serverActions,
isServerLayer, isServerLayer,
optimizeBarrelExports, optimizeBarrelExports,
bundleTarget,
}) })
const programmaticOptions = { const programmaticOptions = {
......
...@@ -113,7 +113,7 @@ const WEBPACK_LAYERS_NAMES = { ...@@ -113,7 +113,7 @@ const WEBPACK_LAYERS_NAMES = {
/** /**
* The browser client bundle layer for actions. * The browser client bundle layer for actions.
*/ */
actionBrowser: 'actionBrowser', actionBrowser: 'action-browser',
/** /**
* The layer for the API routes. * The layer for the API routes.
*/ */
...@@ -143,7 +143,7 @@ const WEBPACK_LAYERS_NAMES = { ...@@ -143,7 +143,7 @@ const WEBPACK_LAYERS_NAMES = {
export type WebpackLayerName = export type WebpackLayerName =
(typeof WEBPACK_LAYERS_NAMES)[keyof typeof WEBPACK_LAYERS_NAMES] (typeof WEBPACK_LAYERS_NAMES)[keyof typeof WEBPACK_LAYERS_NAMES]
export const WEBPACK_LAYERS = { const WEBPACK_LAYERS = {
...WEBPACK_LAYERS_NAMES, ...WEBPACK_LAYERS_NAMES,
GROUP: { GROUP: {
server: [ server: [
...@@ -152,12 +152,24 @@ export const WEBPACK_LAYERS = { ...@@ -152,12 +152,24 @@ export const WEBPACK_LAYERS = {
WEBPACK_LAYERS_NAMES.appMetadataRoute, WEBPACK_LAYERS_NAMES.appMetadataRoute,
WEBPACK_LAYERS_NAMES.appRouteHandler, WEBPACK_LAYERS_NAMES.appRouteHandler,
], ],
serverTarget: [
// all GROUP.server
WEBPACK_LAYERS_NAMES.reactServerComponents,
WEBPACK_LAYERS_NAMES.actionBrowser,
WEBPACK_LAYERS_NAMES.appMetadataRoute,
WEBPACK_LAYERS_NAMES.appRouteHandler,
// plus middleware and pages api
WEBPACK_LAYERS_NAMES.middleware,
WEBPACK_LAYERS_NAMES.api,
],
}, },
} }
export const WEBPACK_RESOURCE_QUERIES = { const WEBPACK_RESOURCE_QUERIES = {
edgeSSREntry: '__next_edge_ssr_entry__', edgeSSREntry: '__next_edge_ssr_entry__',
metadata: '__next_metadata__', metadata: '__next_metadata__',
metadataRoute: '__next_metadata_route__', metadataRoute: '__next_metadata_route__',
metadataImageMeta: '__next_metadata_image_meta__', metadataImageMeta: '__next_metadata_image_meta__',
} }
export { WEBPACK_LAYERS, WEBPACK_RESOURCE_QUERIES }
'use client'
import 'client-only'
export default function Page() {
return 'app/client-edge/page.js'
}
export const runtime = 'edge'
'use client'
import 'client-only'
export default function Page() {
return 'app/client/page.js'
}
import 'server-only'
export function GET() {
return new Response('app-route-edge/route.js')
}
export const runtime = 'edge'
import 'server-only'
export function GET() {
return new Response('app-route/route.js')
}
import 'server-only'
export default function Page() {
return 'app/server-edge/page.js'
}
export const runtime = 'edge'
import 'server-only'
export default function Page() {
return 'app/server/page.js'
}
export default function RootLayout({ children }) {
return (
<html lang="en">
<body>{children}</body>
</html>
)
}
import { createNextDescribe } from 'e2e-utils'
createNextDescribe(
'module layer',
{
files: __dirname,
},
({ next, isNextStart }) => {
it('should render routes marked with restriction marks without errors', async () => {
const routes = [
// app client components pages
'/app/client',
'/app/client-edge',
// app sever components pages
'/app/server',
'/app/server-edge',
// app routes
'/app/route',
'/app/route-edge',
// pages/api
'/api/hello',
'/api/hello-edge',
]
for (const route of routes) {
const { status } = await next.fetch(route)
expect([route, status]).toEqual([route, 200])
}
})
if (isNextStart) {
it('should log the build info properly', async () => {
const cliOutput = next.cliOutput
expect(cliOutput).toContain('Middleware')
const functionsManifest = JSON.parse(
await next.readFile('.next/server/functions-config-manifest.json')
)
expect(functionsManifest.functions).toContainKeys([
'/app/route-edge',
'/api/hello-edge',
'/app/client-edge',
'/app/server-edge',
])
const pagesManifest = JSON.parse(
await next.readFile('.next/server/pages-manifest.json')
)
const middlewareManifest = JSON.parse(
await next.readFile('.next/server/middleware-manifest.json')
)
expect(middlewareManifest.middleware).toBeTruthy()
expect(pagesManifest).toContainKeys([
'/api/hello-edge',
'/pages-ssr',
'/api/hello',
])
})
}
}
)
import 'server-only'
import { NextResponse } from 'next/server'
export function middleware() {
return NextResponse.next()
}
import 'server-only'
export default function handler() {
return new Response('api/hello-edge.js')
}
export const runtime = 'edge'
import 'server-only'
export default function handler(req, res) {
return res.send('api/hello.js')
}
import 'client-only'
export default function Page() {
return 'pages/pages-ssr.js'
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment