fix(browser): update worker format and add e2e test (#12747)

* fix: remove lazyCompilationMiddleware

* chore: change worker entry to iife

* chore: add e2e test

* chore: fix format

* fix: add await for e2e

* fix: remove unused imports

* chore: fix ci yml

* chore: fix ci WASM env injection

Author: CPunisher

.github/workflows/reusable-build-test.yml

@@ -16,7 +16,7 @@ on:
 jobs:
   e2e:
     name: E2E Testing
-    if: inputs.target == 'x86_64-unknown-linux-gnu'
+    if: inputs.target == 'x86_64-unknown-linux-gnu' || inputs.target == 'wasm32-wasip1-threads'
     runs-on: ${{ fromJSON(inputs.runner) }}
     defaults:
       run:
@@ -51,6 +51,7 @@ jobs:
 
       - name: Run e2e
         uses: ./.github/actions/docker/run
+        if: inputs.target == 'x86_64-unknown-linux-gnu'
         with:
           # Jammy uses ubuntu 22.04
           # If this is to change, make sure to upgrade the ubuntu version in GitHub Actions
@@ -63,6 +64,22 @@ jobs:
             pnpm run build:js
             pnpm run test:e2e
 
+      - name: Run e2e for @rspack/browser
+        uses: ./.github/actions/docker/run
+        if: inputs.target == 'wasm32-wasip1-threads'
+        with:
+          # Jammy uses ubuntu 22.04
+          # If this is to change, make sure to upgrade the ubuntu version in GitHub Actions
+          image: mcr.microsoft.com/playwright:v1.57.0-jammy
+          # .cache is required by download artifact, and mount in ./.github/actions/docker/run
+          # .tool_cache is required by pnpm
+          options: -v ${{ runner.tool_cache }}:${{runner.tool_cache}}
+          script: |
+            export PATH=${{ steps.calculate-node-bin-path.outputs.path }}:$PATH
+            export WASM=1
+            pnpm run build:js
+            pnpm run test:e2e
+
   test:
     runs-on: ${{ fromJSON(inputs.runner) }}
     timeout-minutes: 60

packages/rspack/rslib.browser.config.mts

@@ -23,7 +23,7 @@ export default defineConfig({
       },
     },
     {
-      format: 'esm',
+      format: 'iife',
       syntax: 'es2021',
       dts: false,
       autoExtension: false,
@@ -109,6 +109,10 @@ export default defineConfig({
           /src[/\\]loader-runner[/\\]service\.ts/,
           path.resolve('./src/browser/service.ts'),
         ),
+        new rspack.NormalModuleReplacementPlugin(
+          /src[/\\]builtin-plugin[/\\]lazy-compilation[/\\]middleware\.ts/,
+          path.resolve('./src/browser/middleware.ts'),
+        ),
       );
     },
   },

packages/rspack/src/browser/middleware.ts

@@ -0,0 +1,3 @@
+export const lazyCompilationMiddleware = () => {
+  throw new Error('lazy compilation middleware is not supported in browser');
+};

pnpm-lock.yaml

@@ -0,0 +1,13 @@
+import { test, expect } from '@/fixtures';
+
+test('@rspack/browser should bundle react app successfully', async ({
+  page,
+}) => {
+  // There should be a long bundle result
+  await expect
+    .poll(async () => {
+      const text = await page.locator('#output').innerText();
+      return text.length;
+    })
+    .toBeGreaterThan(500);
+});

tests/e2e/browser-cases/basic-react/index.test.ts

@@ -0,0 +1,25 @@
+const rspack = require('@rspack/core');
+
+/** @type {import("@rspack/core").Configuration} */
+module.exports = {
+  entry: './src/index.js',
+  context: __dirname,
+  mode: 'development',
+  plugins: [new rspack.HtmlRspackPlugin()],
+  module: {
+    rules: [
+      {
+        test: /\.js$/,
+        exclude: [/node_modules/],
+        include: [/src/],
+        loader: 'builtin:swc-loader',
+      },
+    ],
+  },
+  devServer: {
+    headers: {
+      'Cross-Origin-Opener-Policy': 'same-origin',
+      'Cross-Origin-Embedder-Policy': 'require-corp',
+    },
+  },
+};

tests/e2e/browser-cases/basic-react/rspack.config.js

@@ -0,0 +1,213 @@
+import { BrowserHttpImportEsmPlugin } from '@rspack/browser';
+
+export const files = {
+  './src/assets/react.svg': `<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="35.93" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 228"><path fill="#00D8FF" d="M210.483 73.824a171.49 171.49 0 0 0-8.24-2.597c.465-1.9.893-3.777 1.273-5.621c6.238-30.281 2.16-54.676-11.769-62.708c-13.355-7.7-35.196.329-57.254 19.526a171.23 171.23 0 0 0-6.375 5.848a155.866 155.866 0 0 0-4.241-3.917C100.759 3.829 77.587-4.822 63.673 3.233C50.33 10.957 46.379 33.89 51.995 62.588a170.974 170.974 0 0 0 1.892 8.48c-3.28.932-6.445 1.924-9.474 2.98C17.309 83.498 0 98.307 0 113.668c0 15.865 18.582 31.778 46.812 41.427a145.52 145.52 0 0 0 6.921 2.165a167.467 167.467 0 0 0-2.01 9.138c-5.354 28.2-1.173 50.591 12.134 58.266c13.744 7.926 36.812-.22 59.273-19.855a145.567 145.567 0 0 0 5.342-4.923a168.064 168.064 0 0 0 6.92 6.314c21.758 18.722 43.246 26.282 56.54 18.586c13.731-7.949 18.194-32.003 12.4-61.268a145.016 145.016 0 0 0-1.535-6.842c1.62-.48 3.21-.974 4.76-1.488c29.348-9.723 48.443-25.443 48.443-41.52c0-15.417-17.868-30.326-45.517-39.844Zm-6.365 70.984c-1.4.463-2.836.91-4.3 1.345c-3.24-10.257-7.612-21.163-12.963-32.432c5.106-11 9.31-21.767 12.459-31.957c2.619.758 5.16 1.557 7.61 2.4c23.69 8.156 38.14 20.213 38.14 29.504c0 9.896-15.606 22.743-40.946 31.14Zm-10.514 20.834c2.562 12.94 2.927 24.64 1.23 33.787c-1.524 8.219-4.59 13.698-8.382 15.893c-8.067 4.67-25.32-1.4-43.927-17.412a156.726 156.726 0 0 1-6.437-5.87c7.214-7.889 14.423-17.06 21.459-27.246c12.376-1.098 24.068-2.894 34.671-5.345a134.17 134.17 0 0 1 1.386 6.193ZM87.276 214.515c-7.882 2.783-14.16 2.863-17.955.675c-8.075-4.657-11.432-22.636-6.853-46.752a156.923 156.923 0 0 1 1.869-8.499c10.486 2.32 22.093 3.988 34.498 4.994c7.084 9.967 14.501 19.128 21.976 27.15a134.668 134.668 0 0 1-4.877 4.492c-9.933 8.682-19.886 14.842-28.658 17.94ZM50.35 144.747c-12.483-4.267-22.792-9.812-29.858-15.863c-6.35-5.437-9.555-10.836-9.555-15.216c0-9.322 13.897-21.212 37.076-29.293c2.813-.98 5.757-1.905 8.812-2.773c3.204 10.42 7.406 21.315 12.477 32.332c-5.137 11.18-9.399 22.249-12.634 32.792a134.718 134.718 0 0 1-6.318-1.979Zm12.378-84.26c-4.811-24.587-1.616-43.134 6.425-47.789c8.564-4.958 27.502 2.111 47.463 19.835a144.318 144.318 0 0 1 3.841 3.545c-7.438 7.987-14.787 17.08-21.808 26.988c-12.04 1.116-23.565 2.908-34.161 5.309a160.342 160.342 0 0 1-1.76-7.887Zm110.427 27.268a347.8 347.8 0 0 0-7.785-12.803c8.168 1.033 15.994 2.404 23.343 4.08c-2.206 7.072-4.956 14.465-8.193 22.045a381.151 381.151 0 0 0-7.365-13.322Zm-45.032-43.861c5.044 5.465 10.096 11.566 15.065 18.186a322.04 322.04 0 0 0-30.257-.006c4.974-6.559 10.069-12.652 15.192-18.18ZM82.802 87.83a323.167 323.167 0 0 0-7.227 13.238c-3.184-7.553-5.909-14.98-8.134-22.152c7.304-1.634 15.093-2.97 23.209-3.984a321.524 321.524 0 0 0-7.848 12.897Zm8.081 65.352c-8.385-.936-16.291-2.203-23.593-3.793c2.26-7.3 5.045-14.885 8.298-22.6a321.187 321.187 0 0 0 7.257 13.246c2.594 4.48 5.28 8.868 8.038 13.147Zm37.542 31.03c-5.184-5.592-10.354-11.779-15.403-18.433c4.902.192 9.899.29 14.978.29c5.218 0 10.376-.117 15.453-.343c-4.985 6.774-10.018 12.97-15.028 18.486Zm52.198-57.817c3.422 7.8 6.306 15.345 8.596 22.52c-7.422 1.694-15.436 3.058-23.88 4.071a382.417 382.417 0 0 0 7.859-13.026a347.403 347.403 0 0 0 7.425-13.565Zm-16.898 8.101a358.557 358.557 0 0 1-12.281 19.815a329.4 329.4 0 0 1-23.444.823c-7.967 0-15.716-.248-23.178-.732a310.202 310.202 0 0 1-12.513-19.846h.001a307.41 307.41 0 0 1-10.923-20.627a310.278 310.278 0 0 1 10.89-20.637l-.001.001a307.318 307.318 0 0 1 12.413-19.761c7.613-.576 15.42-.876 23.31-.876H128c7.926 0 15.743.303 23.354.883a329.357 329.357 0 0 1 12.335 19.695a358.489 358.489 0 0 1 11.036 20.54a329.472 329.472 0 0 1-11 20.722Zm22.56-122.124c8.572 4.944 11.906 24.881 6.52 51.026c-.344 1.668-.73 3.367-1.15 5.09c-10.622-2.452-22.155-4.275-34.23-5.408c-7.034-10.017-14.323-19.124-21.64-27.008a160.789 160.789 0 0 1 5.888-5.4c18.9-16.447 36.564-22.941 44.612-18.3ZM128 90.808c12.625 0 22.86 10.235 22.86 22.86s-10.235 22.86-22.86 22.86s-22.86-10.235-22.86-22.86s10.235-22.86 22.86-22.86Z"></path></svg>`,
+  './src/main.jsx': `import React from "react";
+import ReactDOM from "react-dom/client";
+import App from "./App";
+import "./index.css";
+
+ReactDOM.createRoot(document.getElementById("root")).render(
+	<React.StrictMode>
+		<App />
+	</React.StrictMode>
+);
+`,
+  './src/index.css': `:root {
+  font-family: Inter, Avenir, Helvetica, Arial, sans-serif;
+  font-size: 16px;
+  line-height: 24px;
+  font-weight: 400;
+
+  color-scheme: light dark;
+  color: rgba(255, 255, 255, 0.87);
+  background-color: #242424;
+
+  font-synthesis: none;
+  text-rendering: optimizeLegibility;
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+  -webkit-text-size-adjust: 100%;
+}
+
+a {
+  font-weight: 500;
+  color: #646cff;
+  text-decoration: inherit;
+}
+a:hover {
+  color: #535bf2;
+}
+
+body {
+  margin: 0;
+  display: flex;
+  place-items: center;
+  min-width: 320px;
+  min-height: 100vh;
+}
+
+h1 {
+  font-size: 3.2em;
+  line-height: 1.1;
+}
+
+button {
+  border-radius: 8px;
+  border: 1px solid transparent;
+  padding: 0.6em 1.2em;
+  font-size: 1em;
+  font-weight: 500;
+  font-family: inherit;
+  background-color: #1a1a1a;
+  cursor: pointer;
+  transition: border-color 0.25s;
+}
+button:hover {
+  border-color: #646cff;
+}
+button:focus,
+button:focus-visible {
+  outline: 4px auto -webkit-focus-ring-color;
+}
+
+@media (prefers-color-scheme: light) {
+  :root {
+    color: #213547;
+    background-color: #ffffff;
+  }
+  a:hover {
+    color: #747bff;
+  }
+  button {
+    background-color: #f9f9f9;
+  }
+}
+`,
+  './src/App.jsx': `import React from "react";
+import { useState } from "react";
+import reactLogo from "./assets/react.svg";
+import "./App.css";
+
+function App() {
+	const [count, setCount] = useState(0);
+
+	return (
+		<div className="App">
+			<div>
+				<a href="https://reactjs.org" target="_blank" rel="noreferrer">
+					<img src={reactLogo} className="logo react" alt="React logo" />
+				</a>
+			</div>
+			<h1>Rspack + React</h1>
+			<div className="card">
+				<button type="button" onClick={() => setCount(count => count + 1)}>
+					count is {count}
+				</button>
+				<p>
+					Edit <code>src/App.jsx</code> and save to test HMR
+				</p>
+			</div>
+			<p className="read-the-docs">
+				Click on the Rspack and React logos to learn more
+			</p>
+		</div>
+	);
+}
+
+export default App;
+`,
+  './src/App.css': `#root {
+  max-width: 1280px;
+  margin: 0 auto;
+  padding: 2rem;
+  text-align: center;
+}
+
+.logo {
+  height: 6em;
+  padding: 1.5em;
+  will-change: filter;
+}
+.logo:hover {
+  filter: drop-shadow(0 0 2em #646cffaa);
+}
+.logo.react:hover {
+  filter: drop-shadow(0 0 2em #61dafbaa);
+}
+
+@keyframes logo-spin {
+  from {
+    transform: rotate(0deg);
+  }
+  to {
+    transform: rotate(360deg);
+  }
+}
+
+@media (prefers-reduced-motion: no-preference) {
+  a > .logo {
+    animation: logo-spin infinite 20s linear;
+  }
+}
+
+.card {
+  padding: 2em;
+}
+
+.read-the-docs {
+  color: #888;
+}
+`,
+};
+
+export const config = {
+  mode: 'development',
+  devtool: false,
+  entry: './src/main.jsx',
+  resolve: {
+    extensions: ['.js', '.jsx', '.json'],
+  },
+  module: {
+    rules: [
+      {
+        test: /\.jsx$/,
+        use: {
+          loader: 'builtin:swc-loader',
+          options: {
+            jsc: {
+              parser: {
+                syntax: 'ecmascript',
+                jsx: true,
+              },
+              transform: {
+                react: {
+                  pragma: 'React.createElement',
+                  pragmaFrag: 'React.Fragment',
+                  throwIfNamespace: true,
+                  development: false,
+                },
+              },
+            },
+          },
+        },
+        type: 'javascript/auto',
+      },
+      {
+        test: /\.(png|svg|jpg)$/,
+        type: 'asset/resource',
+      },
+    ],
+  },
+  plugins: [
+    new BrowserHttpImportEsmPlugin({
+      domain: 'https://esm.sh',
+    }),
+  ],
+  experiments: {
+    css: true,
+    buildHttp: {
+      allowedUris: ['https://'],
+    },
+  },
+};

tests/e2e/browser-cases/basic-react/src/files.js

@@ -0,0 +1,20 @@
+import { rspack, builtinMemFs } from '@rspack/browser';
+import { files, config } from './files';
+
+builtinMemFs.volume.fromJSON({
+  ...files,
+});
+
+const promise = new Promise((resolve) => {
+  rspack(config, () => {
+    const json = builtinMemFs.volume.toJSON();
+
+    const outputDOM = document.createElement('div');
+    outputDOM.id = 'output';
+    outputDOM.innerHTML = json['/dist/main.js'];
+    document.body.appendChild(outputDOM);
+    resolve();
+  });
+});
+
+await promise;

tests/e2e/browser-cases/basic-react/src/index.js

@@ -12,6 +12,7 @@
     "@playwright/test": "1.57.0",
     "core-js": "3.47.0",
     "@rspack/core": "workspace:*",
+    "@rspack/browser": "workspace:*",
     "@rspack/dev-server": "~1.1.5",
     "@rspack/plugin-react-refresh": "^1.6.0",
     "@swc/helpers": "0.5.18",

tests/e2e/package.json

@@ -5,7 +5,7 @@ const TIMEOUT = 60 * 1000;
 
 export default defineConfig<RspackOptions>({
   // Look for test files in the "fixtures" directory, relative to this configuration file.
-  testDir: './cases',
+  testDir: process.env.WASM ? './browser-cases' : './cases',
 
   //	globalSetup: require.resolve("./scripts/globalSetup"),