feat: support HMR for class components

vitejs · May 8, 2024 · 640ea48 · 640ea48
1 parent 21eef9e
commit 640ea48
Show file tree

Hide file tree

Showing 12 changed files with 139 additions and 6 deletions.
diff --git a/playground/class-components/__tests__/class-components.spec.ts b/playground/class-components/__tests__/class-components.spec.ts
@@ -0,0 +1,24 @@
+import { expect, test } from "@playwright/test";
+import { setupDevServer, setupWaitForLogs } from "../../utils.ts";
+
+test("Class component HMR", async ({ page }) => {
+  const { testUrl, server, editFile } =
+    await setupDevServer("class-components");
+  const waitForLogs = await setupWaitForLogs(page);
+  await page.goto(testUrl);
+
+  await expect(page.locator("body")).toHaveText("Hello World");
+  editFile("src/App.tsx", ["World", "class components"]);
+  await waitForLogs("[vite] hot updated: /src/App.tsx");
+  await expect(page.locator("body")).toHaveText("Hello class components");
+
+  editFile("src/utils.tsx", ["Hello", "Hi"]);
+  await waitForLogs("[vite] hot updated: /src/App.tsx");
+  await expect(page.locator("body")).toHaveText("Hi class components");
+
+  editFile("src/index.tsx", ["App mounted", "App mounted!"]);
+  await waitForLogs("[vite] page reload: src/index.tsx");
+  await expect(page.locator("body")).toHaveText("Hi class components");
+
+  await server.close();
+});
diff --git a/playground/class-components/index.html b/playground/class-components/index.html
@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Vite + React + class components</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/index.tsx"></script>
+  </body>
+</html>
diff --git a/playground/class-components/package.json b/playground/class-components/package.json
@@ -0,0 +1,19 @@
+{
+  "name": "class-components",
+  "type": "module",
+  "private": true,
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  },
+  "devDependencies": {
+    "@types/react": "^18.2.48",
+    "@types/react-dom": "^18.2.18",
+    "@vitejs/plugin-react-swc": "../../dist"
+  }
+}
diff --git a/playground/class-components/public/vite.svg b/playground/class-components/public/vite.svg
diff --git a/playground/class-components/src/App.tsx b/playground/class-components/src/App.tsx
@@ -0,0 +1,8 @@
+import { Component } from "react";
+import { getGetting } from "./utils.tsx";
+
+export class App extends Component {
+  render() {
+    return <span>{getGetting()} World</span>;
+  }
+}
diff --git a/playground/class-components/src/index.tsx b/playground/class-components/src/index.tsx
@@ -0,0 +1,9 @@
+import { StrictMode } from "react";
+import { createRoot } from "react-dom/client";
+import { App } from "./App.tsx";
+
+createRoot(document.getElementById("root")!).render(
+  <StrictMode>
+    <App />
+  </StrictMode>,
+);
diff --git a/playground/class-components/src/utils.tsx b/playground/class-components/src/utils.tsx
@@ -0,0 +1 @@
+export const getGetting = () => <span>Hello</span>
diff --git a/playground/class-components/tsconfig.json b/playground/class-components/tsconfig.json
@@ -0,0 +1,23 @@
+{
+  "include": ["src", "vite.config.ts"],
+  "compilerOptions": {
+    "module": "ESNext",
+    "lib": ["ESNext", "DOM", "DOM.Iterable"],
+    "target": "ESNext",
+    "jsx": "react-jsx",
+    "types": ["vite/client"],
+    "noEmit": true,
+    "isolatedModules": true,
+    "skipLibCheck": true,
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "resolveJsonModule": true,
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true,
+    "useUnknownInCatchVariables": true
+  }
+}
diff --git a/playground/class-components/vite.config.ts b/playground/class-components/vite.config.ts
@@ -0,0 +1,6 @@
+import { defineConfig } from "vite";
+import react from "@vitejs/plugin-react-swc";
+
+export default defineConfig({
+  plugins: [react()],
+});
diff --git a/...mponents/.swc/plugins/v4/007754343d0bfdb6fe27959c3405e5aee674e896788e641f88b94ed88e0d5e47 b/...mponents/.swc/plugins/v4/007754343d0bfdb6fe27959c3405e5aee674e896788e641f88b94ed88e0d5e47
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/index.ts b/src/index.ts
@@ -26,6 +26,7 @@ const _dirname =
 const resolve = createRequire(
   typeof __filename !== "undefined" ? __filename : import.meta.url,
 ).resolve;
+const reactCompRE = /extends\s+(?:React\.)?(?:Pure)?Component/;
 const refreshContentRE = /\$Refresh(?:Reg|Sig)\$\(/;
 
 type Options = {
@@ -141,14 +142,21 @@ const react = (_options?: Options): PluginOption[] => {
           },
         );
         if (!result) return;
+        if (!refresh) return result;
 
-        if (!refresh || !refreshContentRE.test(result.code)) {
-          return result;
-        }
+        const hasRefresh = refreshContentRE.test(result.code);
+        if (!hasRefresh && !reactCompRE.test(result.code)) return result;
+
+        const sourceMap: SourceMapPayload = JSON.parse(result.map!);
+        sourceMap.mappings = ";;" + sourceMap.mappings;
 
         result.code = `import * as RefreshRuntime from "${runtimePublicPath}";
 
-if (!window.$RefreshReg$) throw new Error("React refresh preamble was not loaded. Something is wrong.");
+${result.code}`;
+
+        if (hasRefresh) {
+          sourceMap.mappings = ";;;;;;" + sourceMap.mappings;
+          result.code = `if (!window.$RefreshReg$) throw new Error("React refresh preamble was not loaded. Something is wrong.");
 const prevRefreshReg = window.$RefreshReg$;
 const prevRefreshSig = window.$RefreshSig$;
 window.$RefreshReg$ = RefreshRuntime.getRefreshReg("${id}");
@@ -158,6 +166,10 @@ ${result.code}
 
 window.$RefreshReg$ = prevRefreshReg;
 window.$RefreshSig$ = prevRefreshSig;
+`;
+        }
+
+        result.code += `
 RefreshRuntime.__hmr_import(import.meta.url).then((currentExports) => {
   RefreshRuntime.registerExportsForReactRefresh("${id}", currentExports);
   import.meta.hot.accept((nextExports) => {
@@ -168,8 +180,6 @@ RefreshRuntime.__hmr_import(import.meta.url).then((currentExports) => {
 });
 `;
 
-        const sourceMap: SourceMapPayload = JSON.parse(result.map!);
-        sourceMap.mappings = ";;;;;;;;" + sourceMap.mappings;
         return { code: result.code, map: sourceMap };
       },
     },