@rspack/plugin-react-refresh 1.5.0 → 1.5.1

package/README.md

@@ -217,6 +217,21 @@ new ReactRefreshPlugin({
 });
 ```
 
+### reloadOnRuntimeErrors
+
+- Type: `boolean`
+- Default: `false`
+
+Config the plugin whether trigger a full page reload when an unrecoverable runtime error is encountered.
+
+Currently, only module factory undefined error is considered as unrecoverable runtime error.
+
+```js
+new ReactRefreshPlugin({
+  reloadOnRuntimeErrors: true,
+});
+```
+
 ## Credits
 
 Thanks to the [react-refresh-webpack-plugin](https://github.com/pmmmwh/react-refresh-webpack-plugin) created by [@pmmmwh](https://github.com/pmmmwh), which inspires implement this plugin.

package/client/overlay/index.js

@@ -240,7 +240,12 @@ function render() {
  */
 function cleanup() {
   // Clean up and reset all internal state.
-  document.body.removeChild(iframeRoot);
+  try {
+    document.body.removeChild(iframeRoot);
+  } catch (e) {
+    // In case user render react app directly to body， will trigger `NotFoundError` when recovery from an Error
+    // https://developer.mozilla.org/en-US/docs/Web/API/Node/removeChild#exceptions
+  }
   scheduledRenderFn = null;
   root = null;
   iframeRoot = null;

package/client/reactRefresh.js

@@ -14,7 +14,13 @@ function refresh(moduleId, webpackHot) {
     if (typeof __react_refresh_test__ !== 'undefined') {
       testMode = __react_refresh_test__;
     }
-    RefreshUtils.executeRuntime(exports, moduleId, webpackHot, errorOverlay, testMode);
+    RefreshUtils.executeRuntime(
+      exports,
+      moduleId,
+      webpackHot,
+      errorOverlay,
+      testMode,
+    );
   };
   if (typeof Promise !== 'undefined' && currentExports instanceof Promise) {
     currentExports.then(fn);

package/client/refreshUtils.js

@@ -209,6 +209,7 @@ function shouldInvalidateReactRefreshBoundary(prevExports, nextExports) {
 }
 
 var enqueueUpdate = createDebounceUpdate();
+
 function executeRuntime(
   moduleExports,
   moduleId,
@@ -245,6 +246,15 @@ function executeRuntime(
          * @returns {void}
          */
         function hotErrorHandler(error) {
+          console.error(error);
+          if (
+            __reload_on_runtime_errors__ &&
+            isUnrecoverableRuntimeError(error)
+          ) {
+            location.reload();
+            return;
+          }
+
           if (typeof refreshOverlay !== 'undefined' && refreshOverlay) {
             refreshOverlay.handleRuntimeError(error);
           }
@@ -287,6 +297,10 @@ function executeRuntime(
   }
 }
 
+function isUnrecoverableRuntimeError(error) {
+  return error.message.startsWith('RuntimeError: factory is undefined');
+}
+
 module.exports = Object.freeze({
   enqueueUpdate: enqueueUpdate,
   executeRuntime: executeRuntime,

package/dist/index.js

@@ -79,6 +79,7 @@ class ReactRefreshRspackPlugin {
             __react_refresh_library__: JSON.stringify(compiler.webpack.Template.toIdentifier(this.options.library ||
                 compiler.options.output.uniqueName ||
                 compiler.options.output.library)),
+            __reload_on_runtime_errors__: this.options.reloadOnRuntimeErrors,
         };
         const providedModules = {
             __react_refresh_utils__: paths_1.refreshUtilsPath,

package/dist/options.d.ts

@@ -75,6 +75,11 @@ export type PluginOptions = {
      * @default true
      */
     injectEntry?: boolean;
+    /**
+     * Whether to reload the page on runtime errors. E.g: undefined module factory
+     * @default false
+     */
+    reloadOnRuntimeErrors?: boolean;
 };
 export interface NormalizedPluginOptions extends Required<PluginOptions> {
     overlay: false | OverlayOptions;

package/dist/options.js

@@ -34,6 +34,7 @@ function normalizeOptions(options) {
     d(options, 'forceEnable', false);
     d(options, 'injectLoader', true);
     d(options, 'injectEntry', true);
+    d(options, 'reloadOnRuntimeErrors', false);
     options.overlay = normalizeOverlay(options.overlay);
     return options;
 }

package/exports/index.d.mts

@@ -1,4 +1,4 @@
-import { ReactRefreshRspackPlugin, type PluginOptions } from '../dist/index.js';
+import { type PluginOptions, ReactRefreshRspackPlugin } from '../dist/index.js';
 
 export type { PluginOptions };
 export { ReactRefreshRspackPlugin };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspack/plugin-react-refresh",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "repository": "https://github.com/rspack-contrib/rspack-plugin-react-refresh",
   "license": "MIT",
   "description": "React refresh plugin for Rspack",
@@ -36,6 +36,8 @@
     "@rspack/core": "1.4.11",
     "@types/jest": "29.5.14",
     "@types/node": "^22.17.0",
+    "bumpp": "^10.2.3",
+    "cac": "^6.7.14",
     "cross-env": "^10.0.0",
     "execa": "9.6.0",
     "fs-extra": "11.3.0",
@@ -73,6 +75,7 @@
     "lint": "biome check .",
     "lint:write": "biome check . --write",
     "test": "jest --colors",
-    "release": "node ./scripts/release.mjs"
+    "release": "node ./scripts/release.mjs",
+    "bump": "npx bumpp --no-push --no-tag --no-commit"
   }
 }