fix: avoid key collision in React refresh registration

ArnaudBarre · ArnaudBarre · commit e8dd1e23c52e · 2023-03-11T17:14:05.000+01:00
diff --git a/playground/shadow-export/__tests__/shadow-export.spec.ts b/playground/shadow-export/__tests__/shadow-export.spec.ts
@@ -0,0 +1,12 @@
+import { expect, test } from "@playwright/test";
+import { setupDevServer } from "../../utils";
+
+test("Shadow export HMR", async ({ page }) => {
+  const { testUrl, server, editFile } = await setupDevServer("shadow-export");
+  await page.goto(testUrl);
+
+  editFile("src/App.tsx", ["Shadow export", "Shadow export updates!"]);
+  await expect(page.locator("body")).toHaveText("Shadow export updates!");
+
+  await server.close();
+});
diff --git a/playground/shadow-export/index.html b/playground/shadow-export/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 + shadow export</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/index.tsx"></script>
+  </body>
+</html>
diff --git a/playground/shadow-export/package.json b/playground/shadow-export/package.json
@@ -0,0 +1,17 @@
+{
+  "name": "playground-worker",
+  "private": true,
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build"
+  },
+  "dependencies": {
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  },
+  "devDependencies": {
+    "@types/react": "^18.0.27",
+    "@types/react-dom": "^18.0.10",
+    "@vitejs/plugin-react-swc": "../../dist"
+  }
+}
diff --git a/playground/shadow-export/public/vite.svg b/playground/shadow-export/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/shadow-export/src/App.tsx b/playground/shadow-export/src/App.tsx
@@ -0,0 +1,11 @@
+import { memo } from "react";
+
+function App() {
+  return <div>Shadow export</div>;
+}
+
+// For anyone reading this, don't do that
+// Use PascalCase for all components and export them directly without rename,
+// you're just making grep more complex.
+const withMemo = memo(App);
+export { withMemo as App };
diff --git a/playground/shadow-export/src/index.tsx b/playground/shadow-export/src/index.tsx
@@ -0,0 +1,9 @@
+import { StrictMode } from "react";
+import { createRoot } from "react-dom/client";
+import { App } from "./App";
+
+createRoot(document.getElementById("root")!).render(
+  <StrictMode>
+    <App />
+  </StrictMode>,
+);
diff --git a/playground/shadow-export/tsconfig.json b/playground/shadow-export/tsconfig.json
@@ -0,0 +1,25 @@
+{
+  "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,
+
+    /* Imports */
+    "moduleResolution": "node", // Allow `index` imports
+    "resolveJsonModule": true, // Allow json import
+    "forceConsistentCasingInFileNames": true, // Avoid difference in case between file name and import
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true,
+    "useUnknownInCatchVariables": true
+  }
+}
diff --git a/playground/shadow-export/vite.config.ts b/playground/shadow-export/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/utils.ts b/playground/utils.ts
@@ -52,7 +52,7 @@ export const setupDevServer = async (name: string) => {
       let content = readFileSync(path, "utf-8");
       for (let [search, replace] of replacements) {
         if (!content.includes(search)) {
-          throw new Error(`${search} not found in ${name}`);
+          throw new Error(`'${search}' not found in ${name}`);
         }
         content = content.replace(search, replace);
       }
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/refresh-runtime.js b/src/refresh-runtime.js
@@ -558,7 +558,10 @@ export function registerExportsForReactRefresh(filename, moduleExports) {
     if (key === "__esModule") continue;
     const exportValue = moduleExports[key];
     if (isLikelyComponentType(exportValue)) {
-      register(exportValue, filename + " " + key);
+      // `export` is required to avoid key collision when renamed exports that
+      // shadow a local component name: https://github.com/vitejs/vite-plugin-react/issues/116
+      // Register has an identity check to not register twice the same component, so this is safe.
+      register(exportValue, filename + " export " + key);
     }
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ export const setupDevServer = async (name: string) => {`
`52`	`52`	`let content = readFileSync(path, "utf-8");`
`53`	`53`	`for (let [search, replace] of replacements) {`
`54`	`54`	`if (!content.includes(search)) {`
`55`		- throw new Error(`${search} not found in ${name}`);
	`55`	+ throw new Error(`'${search}' not found in ${name}`);
`56`	`56`	`}`
`57`	`57`	`content = content.replace(search, replace);`
`58`	`58`	`}`