feat: support HMR for class components (#203)

ArnaudBarre · web-flow · commit 53878df5c546 · 2024-05-20T11:05:48.000+02:00
diff --git a/playground/class-components/__tests__/class-components.spec.ts b/playground/class-components/__tests__/class-components.spec.ts
@@ -0,0 +1,20 @@
+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");
+
+  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
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 256 257"><defs><linearGradient id="a" x1="-.828%" x2="57.636%" y1="7.652%" y2="78.411%"><stop offset="0%" stop-color="#41D1FF"/><stop offset="100%" stop-color="#BD34FE"/></linearGradient><linearGradient id="b" x1="43.376%" x2="50.316%" y1="2.242%" y2="89.03%"><stop offset="0%" stop-color="#FFEA83"/><stop offset="8.333%" stop-color="#FFDD35"/><stop offset="100%" stop-color="#FFA800"/></linearGradient></defs><path fill="url(#a)" d="M255.153 37.938 134.897 252.976c-2.483 4.44-8.862 4.466-11.382.048L.875 37.958c-2.746-4.814 1.371-10.646 6.827-9.67l120.385 21.517a6.537 6.537 0 0 0 2.322-.004l117.867-21.483c5.438-.991 9.574 4.796 6.877 9.62Z"/><path fill="url(#b)" d="M185.432.063 96.44 17.501a3.268 3.268 0 0 0-2.634 3.014l-5.474 92.456a3.268 3.268 0 0 0 3.997 3.378l24.777-5.718c2.318-.535 4.413 1.507 3.936 3.838l-7.361 36.047c-.495 2.426 1.782 4.5 4.151 3.78l15.304-4.649c2.372-.72 4.652 1.36 4.15 3.788l-11.698 56.621c-.732 3.542 3.979 5.473 5.943 2.437l1.313-2.028 72.516-144.72c1.215-2.423-.88-5.186-3.54-4.672l-25.505 4.922c-2.396.462-4.435-1.77-3.759-4.114l16.646-57.705c.677-2.35-1.37-4.583-3.769-4.113Z"/></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/playground/styled-components/.swc/plugins/v4/007754343d0bfdb6fe27959c3405e5aee674e896788e641f88b94ed88e0d5e47 b/playground/styled-components/.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 };
       },
     },

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+export const getGetting = () => <span>Hello</span>;`