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

Implement loadable with lazy and suspense for next dynamic (#42589)

### Summary

Migrate `next/dynamic` to implementation based on `React.lazy` and
`Suspense`. Then it becomes easier to migrate the existing code in pages
to layouts. Then we can support both `ssr` and `loading` option for
`next/dynamic`.

For `loading` option, it will work like `Suspense`'s `fallback` property

```js
<Suspense fallback={loading}>
  <DynamicComponent />
 </Suspense>
```

For `ssr` option, by default `React.lazy` supports SSR, but we'll
disable the `ssr: false` case for dynamic import in server components
since there's no client side involved.

Then we don't need `suspense` option anymore as react >= 18 is always
required. Mark it as deprecated.

It also supports to load client component dynamically in server
components now.

#### Code code changes
* switch loadable component to `lazy` + `Suspense`
* will make sure it's retuning a module from `loader()` to
`loader().then(mod => ({ default: mod.default || mod }))` since `lazy()`
only accepts loader returning a module
* Inside suspense boundary, throwing an error for ssr: false, catch the
error on server and client side and ignore it.
* Ignore options like ssr: false for server components since they're on
server, doesn't make sense
* Remove legacy dynamic related transform
#### Feature changes
* `next/dynamic` will work in the same way across the board (appDir and
pages)
* For the throwing error, will make it become a API that throws error
later in the future, so users can customize more with `Suspense`
* You can load client components now in server components with dynamic.
Resolves #43147

#### Tests
* existing dynamic tests all work
* add case: import client component and load through next/dynamic in
server components

### Issues
parent a704b71c
...@@ -185,7 +185,6 @@ where ...@@ -185,7 +185,6 @@ where
next_dynamic::next_dynamic( next_dynamic::next_dynamic(
opts.is_development, opts.is_development,
opts.is_server, opts.is_server,
opts.server_components.is_some(),
file.name.clone(), file.name.clone(),
opts.pages_dir.clone() opts.pages_dir.clone()
), ),
......
...@@ -5,26 +5,23 @@ use pathdiff::diff_paths; ...@@ -5,26 +5,23 @@ use pathdiff::diff_paths;
use swc_core::{ use swc_core::{
common::{errors::HANDLER, FileName, DUMMY_SP}, common::{errors::HANDLER, FileName, DUMMY_SP},
ecma::ast::{ ecma::ast::{
ArrayLit, ArrowExpr, BinExpr, BinaryOp, BlockStmtOrExpr, Bool, CallExpr, Callee, Expr, ArrayLit, ArrowExpr, BinExpr, BinaryOp, BlockStmtOrExpr, CallExpr, Callee, Expr,
ExprOrSpread, Id, Ident, ImportDecl, ImportSpecifier, KeyValueProp, Lit, MemberExpr, ExprOrSpread, Id, Ident, ImportDecl, ImportSpecifier, KeyValueProp, Lit, MemberExpr,
MemberProp, Null, ObjectLit, Prop, PropName, PropOrSpread, Str, Tpl, MemberProp, ObjectLit, Prop, PropName, PropOrSpread, Str, Tpl,
}, },
ecma::atoms::js_word, ecma::atoms::js_word,
ecma::utils::ExprFactory,
ecma::visit::{Fold, FoldWith}, ecma::visit::{Fold, FoldWith},
}; };
pub fn next_dynamic( pub fn next_dynamic(
is_development: bool, is_development: bool,
is_server: bool, is_server: bool,
is_server_components: bool,
filename: FileName, filename: FileName,
pages_dir: Option<PathBuf>, pages_dir: Option<PathBuf>,
) -> impl Fold { ) -> impl Fold {
NextDynamicPatcher { NextDynamicPatcher {
is_development, is_development,
is_server, is_server,
is_server_components,
pages_dir, pages_dir,
filename, filename,
dynamic_bindings: vec![], dynamic_bindings: vec![],
...@@ -37,7 +34,6 @@ pub fn next_dynamic( ...@@ -37,7 +34,6 @@ pub fn next_dynamic(
struct NextDynamicPatcher { struct NextDynamicPatcher {
is_development: bool, is_development: bool,
is_server: bool, is_server: bool,
is_server_components: bool,
pages_dir: Option<PathBuf>, pages_dir: Option<PathBuf>,
filename: FileName, filename: FileName,
dynamic_bindings: Vec<Id>, dynamic_bindings: Vec<Id>,
...@@ -233,70 +229,16 @@ impl Fold for NextDynamicPatcher { ...@@ -233,70 +229,16 @@ impl Fold for NextDynamicPatcher {
value: generated, value: generated,
})))]; })))];
let mut has_ssr_false = false;
let mut has_suspense = false;
if expr.args.len() == 2 { if expr.args.len() == 2 {
if let Expr::Object(ObjectLit { if let Expr::Object(ObjectLit {
props: options_props, props: options_props,
.. ..
}) = &*expr.args[1].expr }) = &*expr.args[1].expr
{ {
for prop in options_props.iter() {
if let Some(KeyValueProp { key, value }) = match prop {
PropOrSpread::Prop(prop) => match &**prop {
Prop::KeyValue(key_value_prop) => Some(key_value_prop),
_ => None,
},
_ => None,
} {
if let Some(Ident {
sym,
span: _,
optional: _,
}) = match key {
PropName::Ident(ident) => Some(ident),
_ => None,
} {
if sym == "ssr" {
if let Some(Lit::Bool(Bool {
value: false,
span: _,
})) = value.as_lit()
{
has_ssr_false = true
}
}
if sym == "suspense" {
if let Some(Lit::Bool(Bool {
value: true,
span: _,
})) = value.as_lit()
{
has_suspense = true
}
}
}
}
}
props.extend(options_props.iter().cloned()); props.extend(options_props.iter().cloned());
} }
} }
// Don't strip the `loader` argument if suspense is true
// See https://github.com/vercel/next.js/issues/36636 for background.
// Also don't strip the `loader` argument for server components (both
// server/client layers), since they're aliased to a
// React.lazy implementation.
if has_ssr_false
&& !has_suspense
&& self.is_server
&& !self.is_server_components
{
expr.args[0] = Lit::Null(Null { span: DUMMY_SP }).as_arg();
}
let second_arg = ExprOrSpread { let second_arg = ExprOrSpread {
spread: None, spread: None,
expr: Box::new(Expr::Object(ObjectLit { expr: Box::new(Expr::Object(ObjectLit {
......
...@@ -46,7 +46,6 @@ fn next_dynamic_errors(input: PathBuf) { ...@@ -46,7 +46,6 @@ fn next_dynamic_errors(input: PathBuf) {
next_dynamic( next_dynamic(
true, true,
false, false,
false,
FileName::Real(PathBuf::from("/some-project/src/some-file.js")), FileName::Real(PathBuf::from("/some-project/src/some-file.js")),
Some("/some-project/src".into()), Some("/some-project/src".into()),
) )
......
...@@ -49,7 +49,6 @@ fn next_dynamic_fixture(input: PathBuf) { ...@@ -49,7 +49,6 @@ fn next_dynamic_fixture(input: PathBuf) {
next_dynamic( next_dynamic(
true, true,
false, false,
false,
FileName::Real(PathBuf::from("/some-project/src/some-file.js")), FileName::Real(PathBuf::from("/some-project/src/some-file.js")),
Some("/some-project/src".into()), Some("/some-project/src".into()),
) )
...@@ -62,7 +61,6 @@ fn next_dynamic_fixture(input: PathBuf) { ...@@ -62,7 +61,6 @@ fn next_dynamic_fixture(input: PathBuf) {
syntax(), syntax(),
&|_tr| { &|_tr| {
next_dynamic( next_dynamic(
false,
false, false,
false, false,
FileName::Real(PathBuf::from("/some-project/src/some-file.js")), FileName::Real(PathBuf::from("/some-project/src/some-file.js")),
...@@ -79,7 +77,6 @@ fn next_dynamic_fixture(input: PathBuf) { ...@@ -79,7 +77,6 @@ fn next_dynamic_fixture(input: PathBuf) {
next_dynamic( next_dynamic(
false, false,
true, true,
false,
FileName::Real(PathBuf::from("/some-project/src/some-file.js")), FileName::Real(PathBuf::from("/some-project/src/some-file.js")),
Some("/some-project/src".into()), Some("/some-project/src".into()),
) )
......
import dynamic from 'next/dynamic'; import dynamic from 'next/dynamic';
const DynamicComponentWithCustomLoading = dynamic(()=>import('../components/hello') const DynamicComponentWithCustomLoading = dynamic(()=>import('../components/hello'), {
, {
loadableGenerated: { loadableGenerated: {
modules: [ modules: [
"some-file.js -> " + "../components/hello" "some-file.js -> " + "../components/hello"
...@@ -8,7 +7,7 @@ const DynamicComponentWithCustomLoading = dynamic(()=>import('../components/hell ...@@ -8,7 +7,7 @@ const DynamicComponentWithCustomLoading = dynamic(()=>import('../components/hell
}, },
loading: ()=><p >...</p> loading: ()=><p >...</p>
}); });
const DynamicClientOnlyComponent = dynamic(null, { const DynamicClientOnlyComponent = dynamic(()=>import('../components/hello'), {
loadableGenerated: { loadableGenerated: {
modules: [ modules: [
"some-file.js -> " + "../components/hello" "some-file.js -> " + "../components/hello"
...@@ -16,8 +15,7 @@ const DynamicClientOnlyComponent = dynamic(null, { ...@@ -16,8 +15,7 @@ const DynamicClientOnlyComponent = dynamic(null, {
}, },
ssr: false ssr: false
}); });
const DynamicClientOnlyComponentWithSuspense = dynamic(()=>import('../components/hello') const DynamicClientOnlyComponentWithSuspense = dynamic(()=>import('../components/hello'), {
, {
loadableGenerated: { loadableGenerated: {
modules: [ modules: [
"some-file.js -> " + "../components/hello" "some-file.js -> " + "../components/hello"
......
import dynamic from 'next/dynamic'; import dynamic from 'next/dynamic';
const DynamicComponent = dynamic(null, { const DynamicComponent = dynamic(()=>handleImport(import('./components/hello')), {
loadableGenerated: { loadableGenerated: {
modules: [ modules: [
"some-file.js -> " + "./components/hello" "some-file.js -> " + "./components/hello"
] ]
}, },
loading: ()=>null loading: ()=>null,
,
ssr: false ssr: false
}); });
...@@ -128,7 +128,7 @@ function getBaseSWCOptions({ ...@@ -128,7 +128,7 @@ function getBaseSWCOptions({
? { ? {
isServer: !!isServerLayer, isServer: !!isServerLayer,
} }
: false, : undefined,
} }
} }
......
...@@ -1707,26 +1707,8 @@ export default async function getBaseWebpackConfig( ...@@ -1707,26 +1707,8 @@ export default async function getBaseWebpackConfig(
}, },
] ]
: []), : []),
// Alias `next/dynamic` to React.lazy implementation for RSC
...(hasServerComponents ...(hasServerComponents
? [ ? [
{
test: codeCondition.test,
issuerLayer(layer: string) {
return (
layer === WEBPACK_LAYERS.client ||
layer === WEBPACK_LAYERS.server
)
},
resolve: {
alias: {
// Alias `next/dynamic` to React.lazy implementation for RSC
[require.resolve('next/dynamic')]: require.resolve(
'next/dist/client/components/dynamic'
),
},
},
},
{ {
// Alias react-dom for ReactDOM.preload usage. // Alias react-dom for ReactDOM.preload usage.
// Alias react for switching between default set and share subset. // Alias react for switching between default set and share subset.
......
...@@ -7,6 +7,7 @@ import { createFromReadableStream } from 'next/dist/compiled/react-server-dom-we ...@@ -7,6 +7,7 @@ import { createFromReadableStream } from 'next/dist/compiled/react-server-dom-we
import { HeadManagerContext } from '../shared/lib/head-manager-context' import { HeadManagerContext } from '../shared/lib/head-manager-context'
import { GlobalLayoutRouterContext } from '../shared/lib/app-router-context' import { GlobalLayoutRouterContext } from '../shared/lib/app-router-context'
import { NEXT_DYNAMIC_NO_SSR_CODE } from '../shared/lib/no-ssr-error'
/// <reference types="react-dom/experimental" /> /// <reference types="react-dom/experimental" />
...@@ -116,6 +117,23 @@ if (document.readyState === 'loading') { ...@@ -116,6 +117,23 @@ if (document.readyState === 'loading') {
DOMContentLoaded() DOMContentLoaded()
} }
function onRecoverableError(err: any) {
// Using default react onRecoverableError
// x-ref: https://github.com/facebook/react/blob/d4bc16a7d69eb2ea38a88c8ac0b461d5f72cdcab/packages/react-dom/src/client/ReactDOMRoot.js#L83
const defaultOnRecoverableError =
typeof reportError === 'function'
? // In modern browsers, reportError will dispatch an error event,
// emulating an uncaught JavaScript error.
reportError
: (error: any) => {
window.console.error(error)
}
// Skip certain custom errors which are not expected to be reported on client
if (err.digest === NEXT_DYNAMIC_NO_SSR_CODE) return
defaultOnRecoverableError(err)
}
const nextServerDataLoadingGlobal = ((self as any).__next_f = const nextServerDataLoadingGlobal = ((self as any).__next_f =
(self as any).__next_f || []) (self as any).__next_f || [])
nextServerDataLoadingGlobal.forEach(nextServerDataCallback) nextServerDataLoadingGlobal.forEach(nextServerDataCallback)
...@@ -193,7 +211,9 @@ export function hydrate() { ...@@ -193,7 +211,9 @@ export function hydrate() {
if (rootLayoutMissingTagsError) { if (rootLayoutMissingTagsError) {
const reactRootElement = document.createElement('div') const reactRootElement = document.createElement('div')
document.body.appendChild(reactRootElement) document.body.appendChild(reactRootElement)
const reactRoot = (ReactDOMClient as any).createRoot(reactRootElement) const reactRoot = (ReactDOMClient as any).createRoot(reactRootElement, {
onRecoverableError,
})
reactRoot.render( reactRoot.render(
<GlobalLayoutRouterContext.Provider <GlobalLayoutRouterContext.Provider
...@@ -234,11 +254,14 @@ export function hydrate() { ...@@ -234,11 +254,14 @@ export function hydrate() {
</StrictModeIfEnabled> </StrictModeIfEnabled>
) )
const options = {
onRecoverableError,
}
const isError = document.documentElement.id === '__next_error__' const isError = document.documentElement.id === '__next_error__'
const reactRoot = isError const reactRoot = isError
? (ReactDOMClient as any).createRoot(appElement) ? (ReactDOMClient as any).createRoot(appElement, options)
: (React as any).startTransition(() => : (React as any).startTransition(() =>
(ReactDOMClient as any).hydrateRoot(appElement, reactEl) (ReactDOMClient as any).hydrateRoot(appElement, reactEl, options)
) )
if (isError) { if (isError) {
reactRoot.render(reactEl) reactRoot.render(reactEl)
......
import React from 'react'
export type LoaderComponent<P = {}> = Promise<{
default: React.ComponentType<P>
}>
export type Loader<P = {}> = () => LoaderComponent<P>
export type DynamicOptions<P = {}> = {
loader?: Loader<P>
}
export type LoadableComponent<P = {}> = React.ComponentType<P>
export default function dynamic<P = {}>(
loader: Loader<P>
): React.ComponentType<P> {
return React.lazy(loader)
}
...@@ -359,7 +359,7 @@ class RedirectErrorBoundary extends React.Component< ...@@ -359,7 +359,7 @@ class RedirectErrorBoundary extends React.Component<
} }
static getDerivedStateFromError(error: any) { static getDerivedStateFromError(error: any) {
if (error.digest?.startsWith('NEXT_REDIRECT')) { if (error?.digest?.startsWith('NEXT_REDIRECT')) {
const url = error.digest.split(';')[1] const url = error.digest.split(';')[1]
return { redirect: url } return { redirect: url }
} }
...@@ -400,7 +400,7 @@ class NotFoundErrorBoundary extends React.Component< ...@@ -400,7 +400,7 @@ class NotFoundErrorBoundary extends React.Component<
} }
static getDerivedStateFromError(error: any) { static getDerivedStateFromError(error: any) {
if (error.digest === 'NEXT_NOT_FOUND') { if (error?.digest === 'NEXT_NOT_FOUND') {
return { notFoundTriggered: true } return { notFoundTriggered: true }
} }
// Re-throw if error is not for 404 // Re-throw if error is not for 404
......
...@@ -43,6 +43,7 @@ import { ...@@ -43,6 +43,7 @@ import {
PathnameContextProviderAdapter, PathnameContextProviderAdapter,
} from '../shared/lib/router/adapters' } from '../shared/lib/router/adapters'
import { SearchParamsContext } from '../shared/lib/hooks-client-context' import { SearchParamsContext } from '../shared/lib/hooks-client-context'
import { NEXT_DYNAMIC_NO_SSR_CODE } from '../shared/lib/no-ssr-error'
/// <reference types="react-dom/experimental" /> /// <reference types="react-dom/experimental" />
...@@ -510,7 +511,13 @@ function renderReactElement( ...@@ -510,7 +511,13 @@ function renderReactElement(
const reactEl = fn(shouldHydrate ? markHydrateComplete : markRenderComplete) const reactEl = fn(shouldHydrate ? markHydrateComplete : markRenderComplete)
if (!reactRoot) { if (!reactRoot) {
// Unlike with createRoot, you don't need a separate root.render() call here // Unlike with createRoot, you don't need a separate root.render() call here
reactRoot = ReactDOM.hydrateRoot(domEl, reactEl) reactRoot = ReactDOM.hydrateRoot(domEl, reactEl, {
onRecoverableError(err: any) {
// Skip certain custom errors which are not expected to throw on client
if (err.message === NEXT_DYNAMIC_NO_SSR_CODE) return
throw err
},
})
// TODO: Remove shouldHydrate variable when React 18 is stable as it can depend on `reactRoot` existing // TODO: Remove shouldHydrate variable when React 18 is stable as it can depend on `reactRoot` existing
shouldHydrate = false shouldHydrate = false
} else { } else {
......
...@@ -32,6 +32,7 @@ import { normalizeAppPath } from '../shared/lib/router/utils/app-paths' ...@@ -32,6 +32,7 @@ import { normalizeAppPath } from '../shared/lib/router/utils/app-paths'
import { REDIRECT_ERROR_CODE } from '../client/components/redirect' import { REDIRECT_ERROR_CODE } from '../client/components/redirect'
import { DYNAMIC_ERROR_CODE } from '../client/components/hooks-server-context' import { DYNAMIC_ERROR_CODE } from '../client/components/hooks-server-context'
import { NOT_FOUND_ERROR_CODE } from '../client/components/not-found' import { NOT_FOUND_ERROR_CODE } from '../client/components/not-found'
import { NEXT_DYNAMIC_NO_SSR_CODE } from '../shared/lib/no-ssr-error'
import { IncrementalCache } from '../server/lib/incremental-cache' import { IncrementalCache } from '../server/lib/incremental-cache'
loadRequireHook() loadRequireHook()
...@@ -370,6 +371,7 @@ export default async function exportPage({ ...@@ -370,6 +371,7 @@ export default async function exportPage({
if ( if (
err.digest !== DYNAMIC_ERROR_CODE && err.digest !== DYNAMIC_ERROR_CODE &&
err.digest !== NOT_FOUND_ERROR_CODE && err.digest !== NOT_FOUND_ERROR_CODE &&
err.digest !== NEXT_DYNAMIC_NO_SSR_CODE &&
!err.digest?.startsWith(REDIRECT_ERROR_CODE) !err.digest?.startsWith(REDIRECT_ERROR_CODE)
) { ) {
throw err throw err
...@@ -420,14 +422,20 @@ export default async function exportPage({ ...@@ -420,14 +422,20 @@ export default async function exportPage({
if (optimizeCss) { if (optimizeCss) {
process.env.__NEXT_OPTIMIZE_CSS = JSON.stringify(true) process.env.__NEXT_OPTIMIZE_CSS = JSON.stringify(true)
} }
renderResult = await renderMethod( try {
req, renderResult = await renderMethod(
res, req,
page, res,
query, page,
// @ts-ignore query,
curRenderOpts // @ts-ignore
) curRenderOpts
)
} catch (err: any) {
if (err.digest !== NEXT_DYNAMIC_NO_SSR_CODE) {
throw err
}
}
} }
results.ssgNotFound = (curRenderOpts as any).isNotFound results.ssgNotFound = (curRenderOpts as any).isNotFound
...@@ -470,15 +478,22 @@ export default async function exportPage({ ...@@ -470,15 +478,22 @@ export default async function exportPage({
try { try {
await promises.access(ampHtmlFilepath) await promises.access(ampHtmlFilepath)
} catch (_) { } catch (_) {
let ampRenderResult
// make sure it doesn't exist from manual mapping // make sure it doesn't exist from manual mapping
let ampRenderResult = await renderMethod( try {
req, ampRenderResult = await renderMethod(
res, req,
page, res,
// @ts-ignore page,
{ ...query, amp: '1' }, // @ts-ignore
curRenderOpts as any { ...query, amp: '1' },
) curRenderOpts as any
)
} catch (err: any) {
if (err.digest !== NEXT_DYNAMIC_NO_SSR_CODE) {
throw err
}
}
const ampHtml = ampRenderResult const ampHtml = ampRenderResult
? ampRenderResult.toUnchunkedString() ? ampRenderResult.toUnchunkedString()
......
...@@ -35,6 +35,7 @@ import { REDIRECT_ERROR_CODE } from '../client/components/redirect' ...@@ -35,6 +35,7 @@ import { REDIRECT_ERROR_CODE } from '../client/components/redirect'
import { RequestCookies } from './web/spec-extension/cookies' import { RequestCookies } from './web/spec-extension/cookies'
import { DYNAMIC_ERROR_CODE } from '../client/components/hooks-server-context' import { DYNAMIC_ERROR_CODE } from '../client/components/hooks-server-context'
import { NOT_FOUND_ERROR_CODE } from '../client/components/not-found' import { NOT_FOUND_ERROR_CODE } from '../client/components/not-found'
import { NEXT_DYNAMIC_NO_SSR_CODE } from '../shared/lib/no-ssr-error'
import { HeadManagerContext } from '../shared/lib/head-manager-context' import { HeadManagerContext } from '../shared/lib/head-manager-context'
import { Writable } from 'stream' import { Writable } from 'stream'
import stringHash from 'next/dist/compiled/string-hash' import stringHash from 'next/dist/compiled/string-hash'
...@@ -216,9 +217,11 @@ function createErrorHandler( ...@@ -216,9 +217,11 @@ function createErrorHandler(
if (allCapturedErrors) allCapturedErrors.push(err) if (allCapturedErrors) allCapturedErrors.push(err)
if ( if (
err.digest === DYNAMIC_ERROR_CODE || err &&
err.digest === NOT_FOUND_ERROR_CODE || (err.digest === DYNAMIC_ERROR_CODE ||
err.digest?.startsWith(REDIRECT_ERROR_CODE) err.digest === NOT_FOUND_ERROR_CODE ||
err.digest === NEXT_DYNAMIC_NO_SSR_CODE ||
err.digest?.startsWith(REDIRECT_ERROR_CODE))
) { ) {
return err.digest return err.digest
} }
......
...@@ -89,6 +89,7 @@ import { ...@@ -89,6 +89,7 @@ import {
} from '../shared/lib/router/adapters' } from '../shared/lib/router/adapters'
import { AppRouterContext } from '../shared/lib/app-router-context' import { AppRouterContext } from '../shared/lib/app-router-context'
import { SearchParamsContext } from '../shared/lib/hooks-client-context' import { SearchParamsContext } from '../shared/lib/hooks-client-context'
import { NEXT_DYNAMIC_NO_SSR_CODE } from '../shared/lib/no-ssr-error'
let tryGetPreviewData: typeof import('./api-utils/node').tryGetPreviewData let tryGetPreviewData: typeof import('./api-utils/node').tryGetPreviewData
let warn: typeof import('../build/output/log').warn let warn: typeof import('../build/output/log').warn
...@@ -1244,6 +1245,13 @@ export async function renderToHTML( ...@@ -1244,6 +1245,13 @@ export async function renderToHTML(
return await renderToInitialStream({ return await renderToInitialStream({
ReactDOMServer, ReactDOMServer,
element: content, element: content,
streamOptions: {
onError(streamingErr: any) {
if (streamingErr?.digest === NEXT_DYNAMIC_NO_SSR_CODE) {
return streamingErr.digest
}
},
},
}) })
} }
......
'use client'
import React from 'react'
import { NEXT_DYNAMIC_NO_SSR_CODE } from './no-ssr-error'
export function suspense() {
const error = new Error(NEXT_DYNAMIC_NO_SSR_CODE)
;(error as any).digest = NEXT_DYNAMIC_NO_SSR_CODE
throw error
}
type Child = React.ReactElement<any, any>
export default function NoSSR({ children }: { children: Child }): Child {
if (typeof window === 'undefined') {
suspense()
}
return children
}
import React from 'react' import React, { lazy, Suspense } from 'react'
import Loadable from './loadable' import Loadable from './loadable'
import NoSSR from './dynamic-no-ssr'
const isServerSide = typeof window === 'undefined' type ComponentModule<P> = { default: React.ComponentType<P> }
export type LoaderComponent<P = {}> = Promise< export type LoaderComponent<P = {}> = Promise<ComponentModule<P>>
React.ComponentType<P> | { default: React.ComponentType<P> }
>
export type Loader<P = {}> = (() => LoaderComponent<P>) | LoaderComponent<P> export type Loader<P = {}> = () => LoaderComponent<P>
export type LoaderMap = { [mdule: string]: () => Loader<any> } export type LoaderMap = { [module: string]: () => Loader<any> }
export type LoadableGeneratedOptions = { export type LoadableGeneratedOptions = {
webpack?(): any webpack?(): any
...@@ -24,11 +23,21 @@ export type DynamicOptionsLoadingProps = { ...@@ -24,11 +23,21 @@ export type DynamicOptionsLoadingProps = {
timedOut?: boolean timedOut?: boolean
} }
// Normalize loader to return the module as form { default: Component } for `React.lazy`.
// Also for backward compatible since next/dynamic allows to resolve a component directly with loader
// Client component reference proxy need to be converted to a module.
function convertModule<T>(mod: ComponentModule<T>) {
return { default: mod.default || mod }
}
export type DynamicOptions<P = {}> = LoadableGeneratedOptions & { export type DynamicOptions<P = {}> = LoadableGeneratedOptions & {
loading?: (loadingProps: DynamicOptionsLoadingProps) => JSX.Element | null loading?: (loadingProps: DynamicOptionsLoadingProps) => JSX.Element | null
loader?: Loader<P> | LoaderMap loader?: Loader<P> | LoaderMap
loadableGenerated?: LoadableGeneratedOptions loadableGenerated?: LoadableGeneratedOptions
ssr?: boolean ssr?: boolean
/**
* @deprecated `suspense` prop is not required anymore
*/
suspense?: boolean suspense?: boolean
} }
...@@ -41,23 +50,27 @@ export type LoadableFn<P = {}> = ( ...@@ -41,23 +50,27 @@ export type LoadableFn<P = {}> = (
export type LoadableComponent<P = {}> = React.ComponentType<P> export type LoadableComponent<P = {}> = React.ComponentType<P>
export function noSSR<P = {}>( export function noSSR<P = {}>(
LoadableInitializer: LoadableFn<P>, LoadableInitializer: Loader,
loadableOptions: DynamicOptions<P> loadableOptions: DynamicOptions<P>
): React.ComponentType<P> { ): React.ComponentType<P> {
// Removing webpack and modules means react-loadable won't try preloading // Removing webpack and modules means react-loadable won't try preloading
delete loadableOptions.webpack delete loadableOptions.webpack
delete loadableOptions.modules delete loadableOptions.modules
// This check is necessary to prevent react-loadable from initializing on the server const NoSSRComponent = lazy(LoadableInitializer)
if (!isServerSide) {
return LoadableInitializer(loadableOptions)
}
const Loading = loadableOptions.loading! const Loading = loadableOptions.loading!
// This will only be rendered on the server side const fallback = (
return () => (
<Loading error={null} isLoading pastDelay={false} timedOut={false} /> <Loading error={null} isLoading pastDelay={false} timedOut={false} />
) )
return () => (
<Suspense fallback={fallback}>
<NoSSR>
<NoSSRComponent />
</NoSSR>
</Suspense>
)
} }
export default function dynamic<P = {}>( export default function dynamic<P = {}>(
...@@ -66,31 +79,27 @@ export default function dynamic<P = {}>( ...@@ -66,31 +79,27 @@ export default function dynamic<P = {}>(
): React.ComponentType<P> { ): React.ComponentType<P> {
let loadableFn: LoadableFn<P> = Loadable let loadableFn: LoadableFn<P> = Loadable
let loadableOptions: LoadableOptions<P> = options?.suspense let loadableOptions: LoadableOptions<P> = {
? {} // A loading component is not required, so we default it
: // only provide a default loading component when suspense is disabled loading: ({ error, isLoading, pastDelay }) => {
{ if (!pastDelay) return null
// A loading component is not required, so we default it if (process.env.NODE_ENV !== 'production') {
loading: ({ error, isLoading, pastDelay }) => { if (isLoading) {
if (!pastDelay) return null
if (process.env.NODE_ENV === 'development') {
if (isLoading) {
return null
}
if (error) {
return (
<p>
{error.message}
<br />
{error.stack}
</p>
)
}
}
return null return null
}, }
if (error) {
return (
<p>
{error.message}
<br />
{error.stack}
</p>
)
}
} }
return null
},
}
// Support for direct import(), eg: dynamic(import('../hello-world')) // Support for direct import(), eg: dynamic(import('../hello-world'))
// Note that this is only kept for the edge case where someone is passing in a promise as first argument // Note that this is only kept for the edge case where someone is passing in a promise as first argument
...@@ -109,47 +118,24 @@ export default function dynamic<P = {}>( ...@@ -109,47 +118,24 @@ export default function dynamic<P = {}>(
// Support for passing options, eg: dynamic(import('../hello-world'), {loading: () => <p>Loading something</p>}) // Support for passing options, eg: dynamic(import('../hello-world'), {loading: () => <p>Loading something</p>})
loadableOptions = { ...loadableOptions, ...options } loadableOptions = { ...loadableOptions, ...options }
if (loadableOptions.suspense) { const loaderFn = loadableOptions.loader as Loader<P>
if (process.env.NODE_ENV !== 'production') { const loader = () => loaderFn().then(convertModule)
/**
* TODO: Currently, next/dynamic will opt-in to React.lazy if { suspense: true } is used
* React 18 will always resolve the Suspense boundary on the server-side, effectively ignoring the ssr option
*
* In the future, when React Suspense with third-party libraries is stable, we can implement a custom version of
* React.lazy that can suspense on the server-side while only loading the component on the client-side
*/
if (loadableOptions.ssr === false) {
console.warn(
`"ssr: false" is ignored by next/dynamic because you can not enable "suspense" while disabling "ssr" at the same time. Read more: https://nextjs.org/docs/messages/invalid-dynamic-suspense`
)
}
if (loadableOptions.loading != null) {
console.warn(
`"loading" is ignored by next/dynamic because you have enabled "suspense". Place your loading element in your suspense boundary's "fallback" prop instead. Read more: https://nextjs.org/docs/messages/invalid-dynamic-suspense`
)
}
}
delete loadableOptions.ssr
delete loadableOptions.loading
}
// coming from build/babel/plugins/react-loadable-plugin.js // coming from build/babel/plugins/react-loadable-plugin.js
if (loadableOptions.loadableGenerated) { if (loadableOptions.loadableGenerated) {
loadableOptions = { loadableOptions = {
...loadableOptions, ...loadableOptions,
...loadableOptions.loadableGenerated, ...loadableOptions.loadableGenerated,
loader,
} }
delete loadableOptions.loadableGenerated delete loadableOptions.loadableGenerated
} }
// support for disabling server side rendering, eg: dynamic(import('../hello-world'), {ssr: false}). // support for disabling server side rendering, eg: dynamic(() => import('../hello-world'), {ssr: false}).
// skip `ssr` for suspense mode and opt-in React.lazy directly if (typeof loadableOptions.ssr === 'boolean') {
if (typeof loadableOptions.ssr === 'boolean' && !loadableOptions.suspense) {
if (!loadableOptions.ssr) { if (!loadableOptions.ssr) {
delete loadableOptions.ssr delete loadableOptions.ssr
return noSSR(loadableFn, loadableOptions) return noSSR(loader as Loader, loadableOptions)
} }
delete loadableOptions.ssr delete loadableOptions.ssr
} }
......
'use client'
import React from 'react' import React from 'react'
type CaptureFn = (moduleName: string) => void type CaptureFn = (moduleName: string) => void
......
...@@ -21,7 +21,7 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE ...@@ -21,7 +21,7 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE
// https://github.com/jamiebuilds/react-loadable/blob/v5.5.0/src/index.js // https://github.com/jamiebuilds/react-loadable/blob/v5.5.0/src/index.js
// Modified to be compatible with webpack 4 / Next.js // Modified to be compatible with webpack 4 / Next.js
import React, { useSyncExternalStore } from 'react' import React from 'react'
import { LoadableContext } from './loadable-context' import { LoadableContext } from './loadable-context'
const ALL_INITIALIZERS = [] const ALL_INITIALIZERS = []
...@@ -52,10 +52,6 @@ function load(loader) { ...@@ -52,10 +52,6 @@ function load(loader) {
return state return state
} }
function resolve(obj) {
return obj && obj.__esModule ? obj.default : obj
}
function createLoadableComponent(loadFn, options) { function createLoadableComponent(loadFn, options) {
let opts = Object.assign( let opts = Object.assign(
{ {
...@@ -65,14 +61,11 @@ function createLoadableComponent(loadFn, options) { ...@@ -65,14 +61,11 @@ function createLoadableComponent(loadFn, options) {
timeout: null, timeout: null,
webpack: null, webpack: null,
modules: null, modules: null,
suspense: false,
}, },
options options
) )
if (opts.suspense) { opts.lazy = React.lazy(opts.loader)
opts.lazy = React.lazy(opts.loader)
}
/** @type LoadableSubscription */ /** @type LoadableSubscription */
let subscription = null let subscription = null
...@@ -122,52 +115,28 @@ function createLoadableComponent(loadFn, options) { ...@@ -122,52 +115,28 @@ function createLoadableComponent(loadFn, options) {
}) })
} }
} }
function LoadableComponent(props) {
function LoadableImpl(props, ref) {
useLoadableModule() useLoadableModule()
const state = useSyncExternalStore( const fallbackElement = React.createElement(opts.loading, {
subscription.subscribe, isLoading: true,
subscription.getCurrentValue, pastDelay: true,
subscription.getCurrentValue error: null,
) })
React.useImperativeHandle( return React.createElement(
ref, React.Suspense,
() => ({ {
retry: subscription.retry, fallback: fallbackElement,
}), },
[] React.createElement(opts.lazy, props)
) )
return React.useMemo(() => {
if (state.loading || state.error) {
return React.createElement(opts.loading, {
isLoading: state.loading,
pastDelay: state.pastDelay,
timedOut: state.timedOut,
error: state.error,
retry: subscription.retry,
})
} else if (state.loaded) {
return React.createElement(resolve(state.loaded), props)
} else {
return null
}
}, [props, state])
}
function LazyImpl(props, ref) {
useLoadableModule()
return React.createElement(opts.lazy, { ...props, ref })
} }
const LoadableComponent = opts.suspense ? LazyImpl : LoadableImpl
LoadableComponent.preload = () => init() LoadableComponent.preload = () => init()
LoadableComponent.displayName = 'LoadableComponent' LoadableComponent.displayName = 'LoadableComponent'
return React.forwardRef(LoadableComponent) return LoadableComponent
} }
class LoadableSubscription { class LoadableSubscription {
......
// This has to be a shared module which is shared between client component error boundary and dynamic component
export const NEXT_DYNAMIC_NO_SSR_CODE = 'DYNAMIC_SERVER_USAGE'
...@@ -3,7 +3,15 @@ ...@@ -3,7 +3,15 @@
import dynamic from 'next/dynamic' import dynamic from 'next/dynamic'
const Dynamic = dynamic(() => import('../text-dynamic-client')) const Dynamic = dynamic(() => import('../text-dynamic-client'))
const DynamicNoSSR = dynamic(() => import('../text-dynamic-no-ssr-client'), {
ssr: false,
})
export function NextDynamicClientComponent() { export function NextDynamicClientComponent() {
return <Dynamic /> return (
<>
<Dynamic />
<DynamicNoSSR />
</>
)
} }
import dynamic from 'next/dynamic'
export const NextDynamicServerComponent = dynamic(() =>
import('../text-dynamic-server')
)
export const NextDynamicNoSSRServerComponent = dynamic(
() => import('../text-dynamic-no-ssr-server'),
{
ssr: false,
}
)
export const NextDynamicServerImportClientComponent = dynamic(() =>
import('../text-dynamic-server-import-client')
)
...@@ -2,14 +2,14 @@ ...@@ -2,14 +2,14 @@
import { useState, lazy } from 'react' import { useState, lazy } from 'react'
const Lazy = lazy(() => import('../text-lazy-client.js')) const Lazy = lazy(() => import('../text-lazy-client'))
export function LazyClientComponent() { export function LazyClientComponent() {
let [state] = useState('use client') let [state] = useState('use client')
return ( return (
<> <>
<Lazy /> <Lazy />
<p className="hi">hello from {state}</p> <p className="hi">next-dynamic {state}</p>
</> </>
) )
} }
import { LazyClientComponent } from './dynamic-imports/react-lazy-client'
import { NextDynamicClientComponent } from './dynamic-imports/dynamic-client'
import {
NextDynamicServerComponent,
NextDynamicServerImportClientComponent,
NextDynamicNoSSRServerComponent,
} from './dynamic-imports/dynamic-server'
export default function page() {
return (
<div id="content">
<LazyClientComponent />
<NextDynamicServerComponent />
<NextDynamicClientComponent />
<NextDynamicServerImportClientComponent />
<NextDynamicNoSSRServerComponent />
</div>
)
}
export default function TextClient() {
return <p>text client under sever</p>
}
...@@ -7,7 +7,7 @@ export default function Dynamic() { ...@@ -7,7 +7,7 @@ export default function Dynamic() {
let [state] = useState('dynamic on client') let [state] = useState('dynamic on client')
return ( return (
<p id="css-text-dynamic-client" className={styles.dynamic}> <p id="css-text-dynamic-client" className={styles.dynamic}>
{`hello from ${state}`} {`next-dynamic ${state}`}
</p> </p>
) )
} }
'use client'
import { useState } from 'react'
import styles from './dynamic.module.css'
export default function Dynamic() {
let [state] = useState('dynamic no ssr on client')
return (
<p id="css-text-dynamic-no-ssr-client" className={styles.dynamic}>
{`next-dynamic ${state}`}
</p>
)
}
import TextClient from './text-client'
export default function Dynamic() {
return (
<>
<p id="css-text-dynamic-no-ssr-server">
next-dynamic dynamic no ssr on server
</p>
<TextClient />
</>
)
}
'use client'
export default function ClientImportedByServer() {
return (
<p id="text-dynamic-server-import-client">
next-dynamic server import client
</p>
)
}
...@@ -3,7 +3,7 @@ import styles from './dynamic.module.css' ...@@ -3,7 +3,7 @@ import styles from './dynamic.module.css'
export default function Dynamic() { export default function Dynamic() {
return ( return (
<p id="css-text-dynamic-server" className={styles.dynamic}> <p id="css-text-dynamic-server" className={styles.dynamic}>
hello from dynamic on server next-dynamic dynamic on server
</p> </p>
) )
} }
...@@ -6,7 +6,7 @@ export default function LazyComponent() { ...@@ -6,7 +6,7 @@ export default function LazyComponent() {
return ( return (
<> <>
<p id="css-text-lazy" className={styles.lazy}> <p id="css-text-lazy" className={styles.lazy}>
hello from lazy next-dynamic lazy
</p> </p>
</> </>
) )
......
import dynamic from 'next/dynamic'
const Dynamic = dynamic(() => import('../text-dynamic-server'), {
ssr: false,
})
export function NextDynamicServerComponent() {
return <Dynamic />
}
import { LazyClientComponent } from './dynamic-imports/react-lazy-client'
import { NextDynamicServerComponent } from './dynamic-imports/dynamic-server'
import { NextDynamicClientComponent } from './dynamic-imports/dynamic-client'
export default function DashboardIndexPage() { export default function DashboardIndexPage() {
return ( return <p>hello from app/dashboard/index</p>
<>
<p>hello from app/dashboard/index</p>
<NextDynamicServerComponent />
<NextDynamicClientComponent />
<LazyClientComponent />
</>
)
} }
...@@ -138,11 +138,38 @@ describe('app dir', () => { ...@@ -138,11 +138,38 @@ describe('app dir', () => {
it('should serve /index as separate page', async () => { it('should serve /index as separate page', async () => {
const html = await renderViaHTTP(next.url, '/dashboard/index') const html = await renderViaHTTP(next.url, '/dashboard/index')
expect(html).toContain('hello from app/dashboard/index') expect(html).toContain('hello from app/dashboard/index')
})
it('should handle next/dynamic correctly', async () => {
const html = await renderViaHTTP(next.url, '/dashboard/dynamic')
const $ = cheerio.load(html)
// filter out the script
const selector = 'body div'
const serverContent = $(selector).text()
// should load chunks generated via async import correctly with React.lazy // should load chunks generated via async import correctly with React.lazy
expect(html).toContain('hello from lazy') expect(serverContent).toContain('next-dynamic lazy')
// should support `dynamic` in both server and client components // should support `dynamic` in both server and client components
expect(html).toContain('hello from dynamic on server') expect(serverContent).toContain('next-dynamic dynamic on server')
expect(html).toContain('hello from dynamic on client') expect(serverContent).toContain('next-dynamic dynamic on client')
expect(serverContent).toContain('next-dynamic server import client')
expect(serverContent).not.toContain(
'next-dynamic dynamic no ssr on client'
)
expect(serverContent).not.toContain(
'next-dynamic dynamic no ssr on server'
)
expect(serverContent).not.toContain('text client under sever')
const browser = await webdriver(next.url, '/dashboard/dynamic')
const clientContent = await browser.elementByCss(selector).text()
expect(clientContent).toContain('next-dynamic dynamic no ssr on server')
expect(clientContent).toContain('text client under sever')
await browser.waitForElementByCss('#css-text-dynamic-no-ssr-client')
expect(
await browser.elementByCss('#css-text-dynamic-no-ssr-client').text()
).toBe('next-dynamic dynamic no ssr on client')
}) })
it('should serve polyfills for browsers that do not support modules', async () => { it('should serve polyfills for browsers that do not support modules', async () => {
......
...@@ -20,8 +20,8 @@ describe('vercel analytics', () => { ...@@ -20,8 +20,8 @@ describe('vercel analytics', () => {
files: new FileRef(path.join(__dirname, 'app')), files: new FileRef(path.join(__dirname, 'app')),
dependencies: { dependencies: {
swr: '2.0.0-rc.0', swr: '2.0.0-rc.0',
react: 'experimental', react: 'latest',
'react-dom': 'experimental', 'react-dom': 'latest',
sass: 'latest', sass: 'latest',
}, },
skipStart: true, skipStart: true,
......
...@@ -29,7 +29,9 @@ function runTests() { ...@@ -29,7 +29,9 @@ function runTests() {
const browser = await webdriver(appPort, '/') const browser = await webdriver(appPort, '/')
const text = await browser.elementByCss('#before-hydration').text() const text = await browser.elementByCss('#before-hydration').text()
expect(text).toBe('Index<!-- -->1<!-- -->2<!-- -->3<!-- -->4<!-- -->4') expect(text).toMatch(
/^Index<!--\/?(\$|\s)-->1(<!--\/?(\$|\s)-->)+2(<!--\/?(\$|\s)-->)+3(<!--\/?(\$|\s)-->)+4(<!--\/?(\$|\s)-->)+4$/
)
expect(await browser.eval('window.caughtErrors')).toBe('') expect(await browser.eval('window.caughtErrors')).toBe('')
}) })
...@@ -37,7 +39,9 @@ function runTests() { ...@@ -37,7 +39,9 @@ function runTests() {
const browser = await webdriver(appPort, '/') const browser = await webdriver(appPort, '/')
const text = await browser.elementByCss('#first-render').text() const text = await browser.elementByCss('#first-render').text()
expect(text).toBe('Index<!-- -->1<!-- -->2<!-- -->3<!-- -->4<!-- -->4') expect(text).toMatch(
/^Index<!--\/?(\$|\s)-->1(<!--\/?(\$|\s)-->)+2(<!--\/?(\$|\s)-->)+3(<!--\/?(\$|\s)-->)+4(<!--\/?(\$|\s)-->)+4$/
)
expect(await browser.eval('window.caughtErrors')).toBe('') expect(await browser.eval('window.caughtErrors')).toBe('')
}) })
} }
......
import { Suspense } from 'react'
import dynamic from 'next/dynamic'
const Thing = dynamic(() => import('./thing'), {
ssr: false,
suspense: true,
loading: () => 'Loading...',
})
export default function IndexPage() {
return (
<div>
<p>Next.js Example</p>
<Suspense fallback="Loading...">
<Thing />
</Suspense>
</div>
)
}
export default function Thing() {
return 'Thing'
}
/* eslint-env jest */
import webdriver from 'next-webdriver'
import { join } from 'path'
import {
renderViaHTTP,
findPort,
launchApp,
killApp,
hasRedbox,
} from 'next-test-utils'
let app
let appPort: number
const appDir = join(__dirname, '../')
describe('next/dynamic with suspense', () => {
beforeAll(async () => {
appPort = await findPort()
app = await launchApp(appDir, appPort)
})
afterAll(() => killApp(app))
it('should render server-side', async () => {
const html = await renderViaHTTP(appPort, '/')
expect(html).toContain('Next.js Example')
expect(html).toContain('Thing')
})
it('should render client-side', async () => {
const browser = await webdriver(appPort, '/')
const warnings = (await browser.log()).map((log) => log.message).join('\n')
expect(await hasRedbox(browser)).toBe(false)
expect(warnings).toMatch(
/"ssr: false" is ignored by next\/dynamic because you can not enable "suspense" while disabling "ssr" at the same time/gim
)
await browser.close()
})
})
...@@ -29,7 +29,9 @@ function runTests() { ...@@ -29,7 +29,9 @@ function runTests() {
const text = await browser.elementByCss('#first-render').text() const text = await browser.elementByCss('#first-render').text()
// Failure case is 'Index<!-- -->3<!-- --><!-- -->' // Failure case is 'Index<!-- -->3<!-- --><!-- -->'
expect(text).toBe('Index<!-- -->1<!-- -->2<!-- -->3<!-- -->4<!-- -->4') expect(text).toMatch(
/^Index<!--\/?(\$|\s)-->1(<!--\/?(\$|\s)-->)+2(<!--\/?(\$|\s)-->)+3(<!--\/?(\$|\s)-->)+4(<!--\/?(\$|\s)-->)+4$/
)
expect(await browser.eval('window.caughtErrors')).toBe('') expect(await browser.eval('window.caughtErrors')).toBe('')
// should not print "invalid-dynamic-suspense" warning in browser's console // should not print "invalid-dynamic-suspense" warning in browser's console
......
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