Support suspense in next dynamic #27611

huozhi · 2021-07-29T20:57:36Z

Changes

Feature

Adopt React.lazy into next/dynamic, enable it when options.suspense is true
Support next/dynamic with suspense=true in SSR and SSG

Tests

Scenario	Case	Behavior
basics	react 17 or 18 by default	dev/build error or pass
blocking rendering	`reactRoot: true` + `concurrentFeatures: false`	dev/build pass
concurrent rendering	`reactRoot: true` + `concurrentFeatures: true`	dev/build pass

Feature

Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
Related issues linked using fixes #number
Integration tests added
Documentation added
Telemetry added. In case of a feature if it's used or not.
Errors have helpful link attached, see contributing.md

packages/next/shared/lib/loadable.js

jord1e · 2021-08-10T16:56:26Z

When will this be available for testing in combination with the React 18 alpha builds? Will there be a canary release containing Suspense support in the coming weeks?

packages/next/server/render.tsx

docs/advanced-features/dynamic-import.md

packages/next/build/webpack-config.ts

packages/next/shared/lib/loadable.js

test/integration/react-18/app/components/bar.js

test/integration/react-18/test/basics.js

packages/next/shared/lib/loadable.js

test/integration/react-18/app/pages/suspense/no-preload.js

shuding · 2021-08-13T20:22:52Z

packages/next/shared/lib/dynamic.tsx

+        `Disallowed suspense option usage with next/dynamic in blocking mode`
+      )
+    }
+    suspenseOptions.suspense = false


Do we want to also show errors if users enable suspense w/o concurrent features?

I think we do, yes. Since it's also experimental.

Suspense will be resolved as fallback on server side in blocking rendering, do we want to skip this scenario? I think this can expand use cases, throwing error will limit usage of client suspenses.

ijjk · 2021-08-13T20:40:25Z

Stats from current PR

Default Build (Increase detected ⚠️)

General Overall increase ⚠️

	vercel/next.js canary	huozhi/next.js dynamic-lazy	Change
buildDuration	13.6s	13.7s	⚠️ +171ms
buildDurationCached	3.2s	3.1s	-82ms
nodeModulesSize	49.1 MB	49.1 MB	⚠️ +3.35 kB

Page Load Tests Overall increase ✓

	vercel/next.js canary	huozhi/next.js dynamic-lazy	Change
/ failed reqs	0	0	✓
/ total time (seconds)	2.467	2.501	⚠️ +0.03
/ avg req/sec	1013.35	999.73	⚠️ -13.62
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.398	1.362	-0.04
/error-in-render avg req/sec	1788.17	1835.65	+47.48

Client Bundles (main, webpack, commons)

	vercel/next.js canary	huozhi/next.js dynamic-lazy	Change
745.HASH.js gzip	179 B	179 B	✓
framework-HASH.js gzip	42.2 kB	42.2 kB	✓
main-HASH.js gzip	23.1 kB	23.1 kB	✓
webpack-HASH.js gzip	1.5 kB	1.5 kB	✓
Overall change	67 kB	67 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	huozhi/next.js dynamic-lazy	Change
polyfills-HASH.js gzip	31.1 kB	31.1 kB	✓
Overall change	31.1 kB	31.1 kB	✓

Client Pages Overall increase ⚠️

	vercel/next.js canary	huozhi/next.js dynamic-lazy	Change
_app-HASH.js gzip	980 B	980 B	✓
_error-HASH.js gzip	194 B	194 B	✓
amp-HASH.js gzip	312 B	312 B	✓
css-HASH.js gzip	329 B	329 B	✓
dynamic-HASH.js gzip	2.52 kB	2.64 kB	⚠️ +123 B
head-HASH.js gzip	350 B	350 B	✓
hooks-HASH.js gzip	904 B	904 B	✓
image-HASH.js gzip	4.13 kB	4.13 kB	✓
index-HASH.js gzip	261 B	261 B	✓
link-HASH.js gzip	1.66 kB	1.66 kB	✓
routerDirect..HASH.js gzip	319 B	319 B	✓
script-HASH.js gzip	387 B	387 B	✓
withRouter-HASH.js gzip	320 B	320 B	✓
bb14e60e810b..30f.css gzip	125 B	125 B	✓
Overall change	12.8 kB	12.9 kB	⚠️ +123 B

Client Build Manifests Overall increase ⚠️

	vercel/next.js canary	huozhi/next.js dynamic-lazy	Change
_buildManifest.js gzip	491 B	492 B	⚠️ +1 B
Overall change	491 B	492 B	⚠️ +1 B

Rendered Page Sizes

	vercel/next.js canary	huozhi/next.js dynamic-lazy	Change
index.html gzip	533 B	533 B	✓
link.html gzip	546 B	546 B	✓
withRouter.html gzip	525 B	525 B	✓
Overall change	1.6 kB	1.6 kB	✓

Diffs

Diff for _buildManifest.js

@@ -10,7 +10,7 @@ self.__BUILD_MANIFEST = {
     "static\u002Fchunks\u002Fpages\u002Fcss-979928a4957344dd4cfa.js"
   ],
   "/dynamic": [
-    "static\u002Fchunks\u002Fpages\u002Fdynamic-3ae32efdc092678bfdaf.js"
+    "static\u002Fchunks\u002Fpages\u002Fdynamic-cfe35dffa9e5283a3e13.js"
   ],
   "/head": ["static\u002Fchunks\u002Fpages\u002Fhead-b93e7fccd3af1c72154e.js"],
   "/hooks": [

Diff for dynamic-HASH.js

@@ -126,7 +126,24 @@
         loadableOptions = _objectSpread(
           _objectSpread({}, loadableOptions),
           options
-        ); // coming from build/babel/plugins/react-loadable-plugin.js
+        );
+        var suspenseOptions = loadableOptions;
+
+        if (true) {
+          // Error if react root is not enabled and `suspense` option is set to true
+          if (true && suspenseOptions.suspense) {
+            // TODO: add error doc when this feature is stable
+            throw new Error(
+              "Disallowed suspense option usage with next/dynamic in blocking mode"
+            );
+          }
+
+          suspenseOptions.suspense = false;
+        }
+
+        if (suspenseOptions.suspense) {
+          return loadableFn(suspenseOptions);
+        } // coming from build/babel/plugins/react-loadable-plugin.js
 
         if (loadableOptions.loadableGenerated) {
           loadableOptions = _objectSpread(
@@ -190,12 +207,12 @@
     ) {
       "use strict";
 
-      var _defineProperty = __webpack_require__(9713);
-
       var _classCallCheck = __webpack_require__(4575);
 
       var _createClass = __webpack_require__(3913);
 
+      var _defineProperty = __webpack_require__(9713);
+
       function ownKeys(object, enumerableOnly) {
         var keys = Object.keys(object);
         if (Object.getOwnPropertySymbols) {
@@ -364,10 +381,16 @@
             delay: 200,
             timeout: null,
             webpack: null,
-            modules: null
+            modules: null,
+            suspense: false
           },
           options
         );
+
+        if (opts.suspense) {
+          opts.lazy = _react["default"].lazy(opts.loader);
+        }
+
         var subscription = null;
 
         function init() {
@@ -391,7 +414,8 @@
           !initialized &&
           true &&
           typeof opts.webpack === "function" &&
-          "function" === "function"
+          "function" === "function" &&
+          !opts.suspense
         ) {
           var moduleIds = opts.webpack();
           READY_INITIALIZERS.push(function(ids) {
@@ -414,7 +438,7 @@
           });
         }
 
-        var LoadableComponent = function LoadableComponent(props, ref) {
+        function LoadableImpl(props, ref) {
           init();
 
           var context = _react["default"].useContext(
@@ -460,10 +484,25 @@
             },
             [props, state]
           );
-        };
+        }
+
+        function LazyImpl(props, ref) {
+          return _react["default"].createElement(
+            opts.lazy,
+            _objectSpread(
+              _objectSpread({}, props),
+              {},
+              {
+                ref: ref
+              }
+            )
+          );
+        }
+
+        var LoadableComponent = opts.suspense ? LazyImpl : LoadableImpl;
 
         LoadableComponent.preload = function() {
-          return init();
+          return !opts.suspense && init();
         };
 
         LoadableComponent.displayName = "LoadableComponent";

Webpack 4 Mode (Increase detected ⚠️)

General Overall increase ⚠️

	vercel/next.js canary	huozhi/next.js dynamic-lazy	Change
buildDuration	11.2s	11.2s	⚠️ +14ms
buildDurationCached	4.5s	4.4s	-94ms
nodeModulesSize	49.1 MB	49.1 MB	⚠️ +3.35 kB

Page Load Tests Overall increase ✓

	vercel/next.js canary	huozhi/next.js dynamic-lazy	Change
/ failed reqs	0	0	✓
/ total time (seconds)	2.515	2.489	-0.03
/ avg req/sec	994.14	1004.45	+10.31
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.384	1.355	-0.03
/error-in-render avg req/sec	1806.01	1844.56	+38.55

Client Bundles (main, webpack, commons)

	vercel/next.js canary	huozhi/next.js dynamic-lazy	Change
17.HASH.js gzip	185 B	185 B	✓
677f882d2ed8..HASH.js gzip	14 kB	14 kB	✓
framework.HASH.js gzip	41.9 kB	41.9 kB	✓
main-HASH.js gzip	10.6 kB	10.6 kB	✓
webpack-HASH.js gzip	1.19 kB	1.19 kB	✓
Overall change	67.9 kB	67.9 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	huozhi/next.js dynamic-lazy	Change
polyfills-HASH.js gzip	31.3 kB	31.3 kB	✓
Overall change	31.3 kB	31.3 kB	✓

Client Pages Overall increase ⚠️

	vercel/next.js canary	huozhi/next.js dynamic-lazy	Change
_app-HASH.js gzip	965 B	965 B	✓
_error-HASH.js gzip	3.71 kB	3.71 kB	✓
amp-HASH.js gzip	552 B	552 B	✓
css-HASH.js gzip	333 B	333 B	✓
dynamic-HASH.js gzip	2.71 kB	2.83 kB	⚠️ +124 B
head-HASH.js gzip	2.97 kB	2.97 kB	✓
hooks-HASH.js gzip	911 B	911 B	✓
index-HASH.js gzip	231 B	231 B	✓
link-HASH.js gzip	1.64 kB	1.64 kB	✓
routerDirect..HASH.js gzip	298 B	298 B	✓
script-HASH.js gzip	2.95 kB	2.95 kB	✓
withRouter-HASH.js gzip	294 B	294 B	✓
e025d2764813..52f.css gzip	125 B	125 B	✓
Overall change	17.7 kB	17.8 kB	⚠️ +124 B

Client Build Manifests

	vercel/next.js canary	huozhi/next.js dynamic-lazy	Change
_buildManifest.js gzip	498 B	498 B	✓
Overall change	498 B	498 B	✓

Rendered Page Sizes

	vercel/next.js canary	huozhi/next.js dynamic-lazy	Change
index.html gzip	578 B	578 B	✓
link.html gzip	591 B	591 B	✓
withRouter.html gzip	570 B	570 B	✓
Overall change	1.74 kB	1.74 kB	✓

Diffs

Diff for _buildManifest.js

@@ -10,7 +10,7 @@ self.__BUILD_MANIFEST = {
     "static\u002Fchunks\u002Fpages\u002Fcss-0fc40b547d044664b6a0.js"
   ],
   "/dynamic": [
-    "static\u002Fchunks\u002Fpages\u002Fdynamic-cbc12d944fc8bf945134.js"
+    "static\u002Fchunks\u002Fpages\u002Fdynamic-97a9156f97752a73abfb.js"
   ],
   "/head": ["static\u002Fchunks\u002Fpages\u002Fhead-abecfbe6a75f8cfa32c0.js"],
   "/hooks": [

Diff for dynamic-HASH.js

@@ -4,12 +4,12 @@ _N_E = (window["webpackJsonp_N_E"] = window["webpackJsonp_N_E"] || []).push([
     /***/ O4nQ: /***/ function(module, exports, __webpack_require__) {
       "use strict";
 
-      var _defineProperty = __webpack_require__("lSNA");
-
       var _classCallCheck = __webpack_require__("lwsE");
 
       var _createClass = __webpack_require__("W8MJ");
 
+      var _defineProperty = __webpack_require__("lSNA");
+
       function ownKeys(object, enumerableOnly) {
         var keys = Object.keys(object);
         if (Object.getOwnPropertySymbols) {
@@ -178,10 +178,16 @@ _N_E = (window["webpackJsonp_N_E"] = window["webpackJsonp_N_E"] || []).push([
             delay: 200,
             timeout: null,
             webpack: null,
-            modules: null
+            modules: null,
+            suspense: false
           },
           options
         );
+
+        if (opts.suspense) {
+          opts.lazy = _react["default"].lazy(opts.loader);
+        }
+
         var subscription = null;
 
         function init() {
@@ -205,7 +211,8 @@ _N_E = (window["webpackJsonp_N_E"] = window["webpackJsonp_N_E"] || []).push([
           !initialized &&
           true &&
           typeof opts.webpack === "function" &&
-          "function" === "function"
+          "function" === "function" &&
+          !opts.suspense
         ) {
           var moduleIds = opts.webpack();
           READY_INITIALIZERS.push(function(ids) {
@@ -228,7 +235,7 @@ _N_E = (window["webpackJsonp_N_E"] = window["webpackJsonp_N_E"] || []).push([
           });
         }
 
-        var LoadableComponent = function LoadableComponent(props, ref) {
+        function LoadableImpl(props, ref) {
           init();
 
           var context = _react["default"].useContext(
@@ -274,10 +281,25 @@ _N_E = (window["webpackJsonp_N_E"] = window["webpackJsonp_N_E"] || []).push([
             },
             [props, state]
           );
-        };
+        }
+
+        function LazyImpl(props, ref) {
+          return _react["default"].createElement(
+            opts.lazy,
+            _objectSpread(
+              _objectSpread({}, props),
+              {},
+              {
+                ref: ref
+              }
+            )
+          );
+        }
+
+        var LoadableComponent = opts.suspense ? LazyImpl : LoadableImpl;
 
         LoadableComponent.preload = function() {
-          return init();
+          return !opts.suspense && init();
         };
 
         LoadableComponent.displayName = "LoadableComponent";
@@ -742,7 +764,24 @@ _N_E = (window["webpackJsonp_N_E"] = window["webpackJsonp_N_E"] || []).push([
         loadableOptions = _objectSpread(
           _objectSpread({}, loadableOptions),
           options
-        ); // coming from build/babel/plugins/react-loadable-plugin.js
+        );
+        var suspenseOptions = loadableOptions;
+
+        if (true) {
+          // Error if react root is not enabled and `suspense` option is set to true
+          if (true && suspenseOptions.suspense) {
+            // TODO: add error doc when this feature is stable
+            throw new Error(
+              "Disallowed suspense option usage with next/dynamic in blocking mode"
+            );
+          }
+
+          suspenseOptions.suspense = false;
+        }
+
+        if (suspenseOptions.suspense) {
+          return loadableFn(suspenseOptions);
+        } // coming from build/babel/plugins/react-loadable-plugin.js
 
         if (loadableOptions.loadableGenerated) {
           loadableOptions = _objectSpread(

Commit: ed703a2

## Documentation / Examples - [x] Make sure the linting passes - [x] Errors have helpful link attached, see `contributing.md` (for #28165, #27611) - [x] Update test case

nghiepdev · 2021-09-02T14:24:45Z

@huozhi Thank you for your this feature.
I tried it and it seems to work fine.

But there is a small problem with Typescript

const MyComponent = dynamic(() => import('components/MyComponent'), {
  susspense: true,
});

Argument of type '{ susspense: boolean; }' is not assignable to parameter of type 'DynamicOptions<{}>'.

huozhi · 2021-09-02T14:41:48Z

@nghiepit Thanks for trying it and reporting the issue, will fix it in #28740

x-ref: #27611 (comment)

ijjk added created-by: Next.js team PRs by the Next.js team type: documentation type: next labels Jul 29, 2021

This comment has been minimized.

Sign in to view

huozhi force-pushed the dynamic-lazy branch from 1ba77c6 to e120f9f Compare July 30, 2021 18:47

This comment has been minimized.

Sign in to view

huozhi marked this pull request as ready for review August 2, 2021 08:30

huozhi requested review from ijjk, leerob, lfades, padmaia, shuding, styfle and timneutkens as code owners August 2, 2021 08:30

styfle changed the title ~~Support suspense in next dyanmic~~ Support suspense in next dynamic Aug 2, 2021

devknoll reviewed Aug 3, 2021

View reviewed changes

packages/next/shared/lib/loadable.js Outdated Show resolved Hide resolved

huozhi marked this pull request as draft August 4, 2021 09:31

This comment has been minimized.

Sign in to view

huozhi force-pushed the dynamic-lazy branch from 18e6a60 to 2212dcb Compare August 10, 2021 13:36

This comment has been minimized.

Sign in to view

huozhi force-pushed the dynamic-lazy branch from 415f628 to a732de6 Compare August 11, 2021 13:00

huozhi requested a review from devknoll August 13, 2021 08:35

This comment has been minimized.

Sign in to view

shuding reviewed Aug 13, 2021

View reviewed changes

packages/next/server/render.tsx Outdated Show resolved Hide resolved

devknoll reviewed Aug 13, 2021

View reviewed changes

This comment has been minimized.

Sign in to view

huozhi requested review from shuding and devknoll August 13, 2021 17:05

devknoll reviewed Aug 13, 2021

View reviewed changes

packages/next/shared/lib/loadable.js Show resolved Hide resolved

test/integration/react-18/app/pages/suspense/no-preload.js Show resolved Hide resolved

This comment has been minimized.

Sign in to view

huozhi requested a review from devknoll August 13, 2021 17:56

Use react.lazy in dynamic when suspense = true

4a994fc

huozhi force-pushed the dynamic-lazy branch from d99398a to 4a994fc Compare August 13, 2021 18:02

This comment has been minimized.

Sign in to view

devknoll approved these changes Aug 13, 2021

View reviewed changes

shuding approved these changes Aug 13, 2021

View reviewed changes

Merge branch 'canary' into dynamic-lazy

ed703a2

shuding self-requested a review August 13, 2021 20:39

kodiakhq bot merged commit d14da39 into vercel:canary Aug 13, 2021

huozhi deleted the dynamic-lazy branch August 14, 2021 02:24

This was referenced Aug 14, 2021

Error on suspense in blocking rendering mode #28117

Closed

Document usage of suspense option of next/dynamic #28210

Merged

sync-by-unito bot mentioned this pull request Sep 1, 2021

chore(deps): bump next from 11.1.0 to 11.1.1 filecoin-project/slate#916

Closed

huozhi mentioned this pull request Sep 2, 2021

Fix typings of dynamic suspense #28740

Merged

kodiakhq bot pushed a commit that referenced this pull request Sep 2, 2021

Fix typings of dynamic suspense (#28740)

7f09df3

x-ref: #27611 (comment)

sync-by-unito bot mentioned this pull request Sep 2, 2021

chore(deps): bump next from 11.1.0 to 11.1.2 filecoin-project/slate#917

Closed

vercel locked as resolved and limited conversation to collaborators Jan 27, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support suspense in next dynamic #27611

Support suspense in next dynamic #27611

huozhi commented Jul 29, 2021 •

edited

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

jord1e commented Aug 10, 2021

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

shuding Aug 13, 2021

devknoll Aug 13, 2021

huozhi Aug 14, 2021

ijjk commented Aug 13, 2021

Diffs

Diffs

nghiepdev commented Sep 2, 2021

huozhi commented Sep 2, 2021

Support suspense in next dynamic #27611

Support suspense in next dynamic #27611

Conversation

huozhi commented Jul 29, 2021 • edited

Changes

Feature

Tests

Feature

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

jord1e commented Aug 10, 2021

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

shuding Aug 13, 2021

Choose a reason for hiding this comment

devknoll Aug 13, 2021

Choose a reason for hiding this comment

huozhi Aug 14, 2021

Choose a reason for hiding this comment

ijjk commented Aug 13, 2021

Stats from current PR

Diffs

Diffs

nghiepdev commented Sep 2, 2021

huozhi commented Sep 2, 2021

huozhi commented Jul 29, 2021 •

edited