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

Use SWC to valid client next/navigation hooks usage in server components (#63160)

### What

Use SWC to check invalid client hooks of `next/navigation` imports in
server components.
Follow up of #62456 

Remove the runtime error APIs for `next/navigation` rsc version.
Add `next/navigation` react-server version alias in turbopack.

This PR also refactored the invalid server layer APIs detection into a
map, where key is import path and value is an array of client APIs.
During the traversing we will get the import source easily, this makes
extending the logic much easier

### Why

Previously we're using the runtime error to check it, but it has to run
first then the error will be thrown. If we error first in build time
with this check it's much faster and we this align on both side between
webpack and turbopack.
parent 8ef121df
...@@ -624,6 +624,7 @@ async fn rsc_aliases( ...@@ -624,6 +624,7 @@ async fn rsc_aliases(
"react-server-dom-webpack/server.node" => format!("next/dist/server/future/route-modules/app-page/vendored/rsc/react-server-dom-turbopack-server-node"), "react-server-dom-webpack/server.node" => format!("next/dist/server/future/route-modules/app-page/vendored/rsc/react-server-dom-turbopack-server-node"),
"react-server-dom-turbopack/server.edge" => format!("next/dist/server/future/route-modules/app-page/vendored/rsc/react-server-dom-turbopack-server-edge"), "react-server-dom-turbopack/server.edge" => format!("next/dist/server/future/route-modules/app-page/vendored/rsc/react-server-dom-turbopack-server-edge"),
"react-server-dom-turbopack/server.node" => format!("next/dist/server/future/route-modules/app-page/vendored/rsc/react-server-dom-turbopack-server-node"), "react-server-dom-turbopack/server.node" => format!("next/dist/server/future/route-modules/app-page/vendored/rsc/react-server-dom-turbopack-server-node"),
"next/navigation" => format!("next/dist/api/navigation.react-server"),
// Needed to make `react-dom/server` work. // Needed to make `react-dom/server` work.
"next/dist/compiled/react" => format!("next/dist/compiled/react/index.js"), "next/dist/compiled/react" => format!("next/dist/compiled/react/index.js"),
......
...@@ -473,8 +473,7 @@ struct ReactServerComponentValidator { ...@@ -473,8 +473,7 @@ struct ReactServerComponentValidator {
app_dir: Option<PathBuf>, app_dir: Option<PathBuf>,
invalid_server_imports: Vec<JsWord>, invalid_server_imports: Vec<JsWord>,
invalid_client_imports: Vec<JsWord>, invalid_client_imports: Vec<JsWord>,
invalid_server_react_apis: Vec<JsWord>, invalid_server_lib_apis_mapping: HashMap<&'static str, Vec<&'static str>>,
invalid_server_react_dom_apis: Vec<JsWord>,
pub directive_import_collection: Option<(bool, bool, Vec<ModuleImports>, Vec<String>)>, pub directive_import_collection: Option<(bool, bool, Vec<ModuleImports>, Vec<String>)>,
} }
...@@ -485,6 +484,56 @@ impl ReactServerComponentValidator { ...@@ -485,6 +484,56 @@ impl ReactServerComponentValidator {
filepath: filename, filepath: filename,
app_dir, app_dir,
directive_import_collection: None, directive_import_collection: None,
// react -> [apis]
// react-dom -> [apis]
// next/navigation -> [apis]
invalid_server_lib_apis_mapping: [
(
"react",
vec![
"Component",
"createContext",
"createFactory",
"PureComponent",
"useDeferredValue",
"useEffect",
"useImperativeHandle",
"useInsertionEffect",
"useLayoutEffect",
"useReducer",
"useRef",
"useState",
"useSyncExternalStore",
"useTransition",
"useOptimistic",
],
),
(
"react-dom",
vec![
"findDOMNode",
"flushSync",
"unstable_batchedUpdates",
"useFormStatus",
"useFormState",
],
),
(
"next/navigation",
vec![
"useSearchParams",
"usePathname",
"useSelectedLayoutSegment",
"useSelectedLayoutSegments",
"useParams",
"useRouter",
"useServerInsertedHTML",
"ServerInsertedHTMLContext",
],
),
]
.into(),
invalid_server_imports: vec![ invalid_server_imports: vec![
JsWord::from("client-only"), JsWord::from("client-only"),
JsWord::from("react-dom/client"), JsWord::from("react-dom/client"),
...@@ -492,30 +541,6 @@ impl ReactServerComponentValidator { ...@@ -492,30 +541,6 @@ impl ReactServerComponentValidator {
JsWord::from("next/router"), JsWord::from("next/router"),
], ],
invalid_client_imports: vec![JsWord::from("server-only"), JsWord::from("next/headers")], invalid_client_imports: vec![JsWord::from("server-only"), JsWord::from("next/headers")],
invalid_server_react_dom_apis: vec![
JsWord::from("findDOMNode"),
JsWord::from("flushSync"),
JsWord::from("unstable_batchedUpdates"),
JsWord::from("useFormStatus"),
JsWord::from("useFormState"),
],
invalid_server_react_apis: vec![
JsWord::from("Component"),
JsWord::from("createContext"),
JsWord::from("createFactory"),
JsWord::from("PureComponent"),
JsWord::from("useDeferredValue"),
JsWord::from("useEffect"),
JsWord::from("useImperativeHandle"),
JsWord::from("useInsertionEffect"),
JsWord::from("useLayoutEffect"),
JsWord::from("useReducer"),
JsWord::from("useRef"),
JsWord::from("useState"),
JsWord::from("useSyncExternalStore"),
JsWord::from("useTransition"),
JsWord::from("useOptimistic"),
],
} }
} }
...@@ -523,6 +548,28 @@ impl ReactServerComponentValidator { ...@@ -523,6 +548,28 @@ impl ReactServerComponentValidator {
Regex::new(r"node_modules[\\/]").unwrap().is_match(filepath) Regex::new(r"node_modules[\\/]").unwrap().is_match(filepath)
} }
// Asserts the server lib apis
// e.g.
// assert_invalid_server_lib_apis("react", import)
// assert_invalid_server_lib_apis("react-dom", import)
fn assert_invalid_server_lib_apis(&self, import_source: String, import: &ModuleImports) {
// keys of invalid_server_lib_apis_mapping
let invalid_apis = self
.invalid_server_lib_apis_mapping
.get(import_source.as_str());
if let Some(invalid_apis) = invalid_apis {
for specifier in &import.specifiers {
if invalid_apis.contains(&specifier.0.as_str()) {
report_error(
&self.app_dir,
&self.filepath,
RSCErrorKind::NextRscErrReactApi((specifier.0.to_string(), specifier.1)),
);
}
}
}
}
fn assert_server_graph(&self, imports: &[ModuleImports], module: &Module) { fn assert_server_graph(&self, imports: &[ModuleImports], module: &Module) {
// If the // If the
if self.is_from_node_modules(&self.filepath) { if self.is_from_node_modules(&self.filepath) {
...@@ -530,41 +577,16 @@ impl ReactServerComponentValidator { ...@@ -530,41 +577,16 @@ impl ReactServerComponentValidator {
} }
for import in imports { for import in imports {
let source = import.source.0.clone(); let source = import.source.0.clone();
let source_str = source.to_string();
if self.invalid_server_imports.contains(&source) { if self.invalid_server_imports.contains(&source) {
report_error( report_error(
&self.app_dir, &self.app_dir,
&self.filepath, &self.filepath,
RSCErrorKind::NextRscErrServerImport((source.to_string(), import.source.1)), RSCErrorKind::NextRscErrServerImport((source_str.clone(), import.source.1)),
); );
} }
if source == *"react" {
for specifier in &import.specifiers { self.assert_invalid_server_lib_apis(source_str, import);
if self.invalid_server_react_apis.contains(&specifier.0) {
report_error(
&self.app_dir,
&self.filepath,
RSCErrorKind::NextRscErrReactApi((
specifier.0.to_string(),
specifier.1,
)),
);
}
}
}
if source == *"react-dom" {
for specifier in &import.specifiers {
if self.invalid_server_react_dom_apis.contains(&specifier.0) {
report_error(
&self.app_dir,
&self.filepath,
RSCErrorKind::NextRscErrReactApi((
specifier.0.to_string(),
specifier.1,
)),
);
}
}
}
} }
self.assert_invalid_api(module, false); self.assert_invalid_api(module, false);
......
import { errorClientApi } from '../client/components/client-hook-in-server-component-error'
export function useSearchParams() {
errorClientApi('useSearchParams')
}
export function usePathname() {
errorClientApi('usePathname')
}
export function useSelectedLayoutSegment() {
errorClientApi('useSelectedLayoutSegment')
}
export function useSelectedLayoutSegments() {
errorClientApi('useSelectedLayoutSegments')
}
export function useParams() {
errorClientApi('useParams')
}
export function useRouter() {
errorClientApi('useRouter')
}
export function useServerInsertedHTML() {
errorClientApi('useServerInsertedHTML')
}
export function ServerInsertedHTMLContext() {
errorClientApi('ServerInsertedHTMLContext')
}
export * from '../client/components/navigation.react-server' export * from '../client/components/navigation.react-server'
import React from 'react'
export function errorClientApi(api: string) {
const message = `${api} only works in Client Components. Add the "use client" directive at the top of the file to use it. Read more: https://nextjs.org/docs/messages/react-client-hook-in-server-component`
throw new Error(message)
}
export function clientHookInServerComponentError(
hookName: string
): void | never {
if (process.env.NODE_ENV !== 'production') {
// If useState is undefined we're in a server component
if (!React.useState) {
errorClientApi(hookName)
}
}
}
...@@ -10,7 +10,6 @@ import { ...@@ -10,7 +10,6 @@ import {
PathnameContext, PathnameContext,
PathParamsContext, PathParamsContext,
} from '../../shared/lib/hooks-client-context.shared-runtime' } from '../../shared/lib/hooks-client-context.shared-runtime'
import { clientHookInServerComponentError } from './client-hook-in-server-component-error'
import { getSegmentValue } from './router-reducer/reducers/get-segment-value' import { getSegmentValue } from './router-reducer/reducers/get-segment-value'
import { PAGE_SEGMENT_KEY, DEFAULT_SEGMENT_KEY } from '../../shared/lib/segment' import { PAGE_SEGMENT_KEY, DEFAULT_SEGMENT_KEY } from '../../shared/lib/segment'
import { ReadonlyURLSearchParams } from './navigation.react-server' import { ReadonlyURLSearchParams } from './navigation.react-server'
...@@ -36,7 +35,6 @@ import { ReadonlyURLSearchParams } from './navigation.react-server' ...@@ -36,7 +35,6 @@ import { ReadonlyURLSearchParams } from './navigation.react-server'
* Read more: [Next.js Docs: `useSearchParams`](https://nextjs.org/docs/app/api-reference/functions/use-search-params) * Read more: [Next.js Docs: `useSearchParams`](https://nextjs.org/docs/app/api-reference/functions/use-search-params)
*/ */
function useSearchParams(): ReadonlyURLSearchParams { function useSearchParams(): ReadonlyURLSearchParams {
clientHookInServerComponentError('useSearchParams')
const searchParams = useContext(SearchParamsContext) const searchParams = useContext(SearchParamsContext)
// In the case where this is `null`, the compat types added in // In the case where this is `null`, the compat types added in
...@@ -81,7 +79,6 @@ function useSearchParams(): ReadonlyURLSearchParams { ...@@ -81,7 +79,6 @@ function useSearchParams(): ReadonlyURLSearchParams {
* Read more: [Next.js Docs: `usePathname`](https://nextjs.org/docs/app/api-reference/functions/use-pathname) * Read more: [Next.js Docs: `usePathname`](https://nextjs.org/docs/app/api-reference/functions/use-pathname)
*/ */
function usePathname(): string { function usePathname(): string {
clientHookInServerComponentError('usePathname')
// In the case where this is `null`, the compat types added in `next-env.d.ts` // In the case where this is `null`, the compat types added in `next-env.d.ts`
// will add a new overload that changes the return type to include `null`. // will add a new overload that changes the return type to include `null`.
return useContext(PathnameContext) as string return useContext(PathnameContext) as string
...@@ -111,7 +108,6 @@ import { ...@@ -111,7 +108,6 @@ import {
* Read more: [Next.js Docs: `useRouter`](https://nextjs.org/docs/app/api-reference/functions/use-router) * Read more: [Next.js Docs: `useRouter`](https://nextjs.org/docs/app/api-reference/functions/use-router)
*/ */
function useRouter(): AppRouterInstance { function useRouter(): AppRouterInstance {
clientHookInServerComponentError('useRouter')
const router = useContext(AppRouterContext) const router = useContext(AppRouterContext)
if (router === null) { if (router === null) {
throw new Error('invariant expected app router to be mounted') throw new Error('invariant expected app router to be mounted')
...@@ -142,8 +138,6 @@ interface Params { ...@@ -142,8 +138,6 @@ interface Params {
* Read more: [Next.js Docs: `useParams`](https://nextjs.org/docs/app/api-reference/functions/use-params) * Read more: [Next.js Docs: `useParams`](https://nextjs.org/docs/app/api-reference/functions/use-params)
*/ */
function useParams<T extends Params = Params>(): T { function useParams<T extends Params = Params>(): T {
clientHookInServerComponentError('useParams')
return useContext(PathParamsContext) as T return useContext(PathParamsContext) as T
} }
...@@ -210,7 +204,6 @@ function getSelectedLayoutSegmentPath( ...@@ -210,7 +204,6 @@ function getSelectedLayoutSegmentPath(
function useSelectedLayoutSegments( function useSelectedLayoutSegments(
parallelRouteKey: string = 'children' parallelRouteKey: string = 'children'
): string[] { ): string[] {
clientHookInServerComponentError('useSelectedLayoutSegments')
const context = useContext(LayoutRouterContext) const context = useContext(LayoutRouterContext)
// @ts-expect-error This only happens in `pages`. Type is overwritten in navigation.d.ts // @ts-expect-error This only happens in `pages`. Type is overwritten in navigation.d.ts
if (!context) return null if (!context) return null
...@@ -239,7 +232,6 @@ function useSelectedLayoutSegments( ...@@ -239,7 +232,6 @@ function useSelectedLayoutSegments(
function useSelectedLayoutSegment( function useSelectedLayoutSegment(
parallelRouteKey: string = 'children' parallelRouteKey: string = 'children'
): string | null { ): string | null {
clientHookInServerComponentError('useSelectedLayoutSegment')
const selectedLayoutSegments = useSelectedLayoutSegments(parallelRouteKey) const selectedLayoutSegments = useSelectedLayoutSegments(parallelRouteKey)
if (!selectedLayoutSegments || selectedLayoutSegments.length === 0) { if (!selectedLayoutSegments || selectedLayoutSegments.length === 0) {
......
...@@ -521,17 +521,16 @@ describe('Error Overlay for server components', () => { ...@@ -521,17 +521,16 @@ describe('Error Overlay for server components', () => {
}) })
}) })
describe('Next.js component hooks called in Server Component', () => { describe('Next.js navigation client hooks called in Server Component', () => {
it.each([ it.each([
// TODO-APP: add test for useParams ['useParams'],
// ["useParams"],
['useRouter'], ['useRouter'],
['usePathname'],
['useSearchParams'], ['useSearchParams'],
['useSelectedLayoutSegment'], ['useSelectedLayoutSegment'],
['useSelectedLayoutSegments'], ['useSelectedLayoutSegments'],
['usePathname'],
])('should show error when %s is called', async (hook: string) => { ])('should show error when %s is called', async (hook: string) => {
const { browser, cleanup } = await sandbox( const { session, cleanup } = await sandbox(
next, next,
new Map([ new Map([
[ [
...@@ -539,7 +538,6 @@ describe('Error Overlay for server components', () => { ...@@ -539,7 +538,6 @@ describe('Error Overlay for server components', () => {
outdent` outdent`
import { ${hook} } from 'next/navigation' import { ${hook} } from 'next/navigation'
export default function Page() { export default function Page() {
${hook}()
return "Hello world" return "Hello world"
} }
`, `,
...@@ -547,19 +545,15 @@ describe('Error Overlay for server components', () => { ...@@ -547,19 +545,15 @@ describe('Error Overlay for server components', () => {
]) ])
) )
await check(async () => { expect(await session.hasRedbox()).toBe(true)
expect( // In webpack when the message too long it gets truncated with ` | ` with new lines.
await browser // So we need to check for the first part of the message.
.waitForElementByCss('#nextjs__container_errors_desc') const normalizedSource = await session.getRedboxSource()
.text() expect(normalizedSource).toContain(
).toContain( `You're importing a component that needs ${hook}. It only works in a Client Component but none of its parents are marked with "use client"`
`Error: ${hook} only works in Client Components. Add the "use client" directive at the top of the file to use it. Read more: https://nextjs.org/docs/messages/react-client-hook-in-server-component` )
) expect(normalizedSource).toContain(
return 'success' `import { ${hook} } from 'next/navigation'`
}, 'success')
expect(next.cliOutput).toContain(
`Error: ${hook} only works in Client Components. Add the "use client" directive at the top of the file to use it. Read more: https://nextjs.org/docs/messages/react-client-hook-in-server-component`
) )
await cleanup() await cleanup()
......
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