-
-
Notifications
You must be signed in to change notification settings - Fork 10.2k
/
vite-dev-express-test.ts
311 lines (282 loc) · 9.53 KB
/
vite-dev-express-test.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
import fs from "node:fs/promises";
import path from "node:path";
import { test, expect } from "@playwright/test";
import getPort from "get-port";
import { createFixtureProject, js } from "./helpers/create-fixture.js";
import { kill, node } from "./helpers/dev.js";
let projectDir: string;
let dev: { pid: number; port: number };
test.beforeAll(async () => {
let port = await getPort();
let hmrPort = await getPort();
projectDir = await createFixtureProject({
compiler: "vite",
files: {
"vite.config.ts": js`
import { defineConfig } from "vite";
import { unstable_vitePlugin as remix } from "@remix-run/dev";
export default defineConfig({
server: {
hmr: {
port: ${hmrPort}
}
},
optimizeDeps: {
include: ["react", "react-dom/client"],
},
plugins: [remix()],
});
`,
"server.mjs": js`
import {
unstable_createViteServer,
unstable_loadViteServerBuild,
} from "@remix-run/dev";
import { createRequestHandler } from "@remix-run/express";
import { installGlobals } from "@remix-run/node";
import express from "express";
installGlobals();
let vite =
process.env.NODE_ENV === "production"
? undefined
: await unstable_createViteServer();
const app = express();
if (vite) {
app.use(vite.middlewares);
} else {
app.use(
"/build",
express.static("public/build", { immutable: true, maxAge: "1y" })
);
}
app.use(express.static("public", { maxAge: "1h" }));
app.all(
"*",
createRequestHandler({
build: vite
? () => unstable_loadViteServerBuild(vite)
: await import("./build/index.js"),
getLoadContext: () => ({ value: "context" }),
})
);
const port = ${port};
app.listen(port, () => console.log('http://localhost:' + port));
`,
"app/root.tsx": js`
import { Links, Meta, Outlet, Scripts, LiveReload } from "@remix-run/react";
export default function Root() {
return (
<html lang="en">
<head>
<Meta />
<Links />
</head>
<body>
<div id="content">
<h1>Root</h1>
<Outlet />
</div>
<LiveReload />
<Scripts />
</body>
</html>
);
}
`,
"app/routes/_index.tsx": js`
// imports
import { useState, useEffect } from "react";
// loader
export default function IndexRoute() {
// hooks
const [mounted, setMounted] = useState(false);
useEffect(() => {
setMounted(true);
}, []);
return (
<div id="index">
<h2 data-title>Index</h2>
<input />
<p data-mounted>Mounted: {mounted ? "yes" : "no"}</p>
<p data-hmr>HMR updated: 0</p>
{/* elements */}
</div>
);
}
`,
},
});
dev = await node(projectDir, ["./server.mjs"], { port });
});
test.afterAll(async () => {
await kill(dev.pid);
});
test("Vite custom server HMR & HDR", async ({ page }) => {
// setup: initial render
await page.goto(`http://localhost:${dev.port}/`, {
waitUntil: "networkidle",
});
await expect(page.locator("#index [data-title]")).toHaveText("Index");
// setup: hydration
await expect(page.locator("#index [data-mounted]")).toHaveText(
"Mounted: yes"
);
// setup: browser state
let hmrStatus = page.locator("#index [data-hmr]");
await expect(hmrStatus).toHaveText("HMR updated: 0");
let input = page.locator("#index input");
await expect(input).toBeVisible();
await input.type("stateful");
// route: HMR
await edit("app/routes/_index.tsx", (contents) =>
contents.replace("HMR updated: 0", "HMR updated: 1")
);
await page.waitForLoadState("networkidle");
await expect(hmrStatus).toHaveText("HMR updated: 1");
await expect(input).toHaveValue("stateful");
// route: add loader
await edit("app/routes/_index.tsx", (contents) =>
contents
.replace(
"// imports",
`// imports\nimport { json } from "@remix-run/node";\nimport { useLoaderData } from "@remix-run/react"`
)
.replace(
"// loader",
`// loader\nexport const loader = ({ context }) => json({ message: "HDR updated: 0", context });`
)
.replace(
"// hooks",
"// hooks\nconst { message, context } = useLoaderData<typeof loader>();"
)
.replace(
"{/* elements */}",
`{/* elements */}\n<p data-context>{context.value}</p>\n<p data-hdr>{message}</p>`
)
);
await page.waitForLoadState("networkidle");
await expect(page.locator("#index [data-context]")).toHaveText("context");
let hdrStatus = page.locator("#index [data-hdr]");
await expect(hdrStatus).toHaveText("HDR updated: 0");
// React Fast Refresh cannot preserve state for a component when hooks are added or removed
await expect(input).toHaveValue("");
await input.type("stateful");
// route: HDR
await edit("app/routes/_index.tsx", (contents) =>
contents.replace("HDR updated: 0", "HDR updated: 1")
);
await page.waitForLoadState("networkidle");
await expect(hdrStatus).toHaveText("HDR updated: 1");
await expect(input).toHaveValue("stateful");
// route: HMR + HDR
await edit("app/routes/_index.tsx", (contents) =>
contents
.replace("HMR updated: 1", "HMR updated: 2")
.replace("HDR updated: 1", "HDR updated: 2")
);
await page.waitForLoadState("networkidle");
await expect(hmrStatus).toHaveText("HMR updated: 2");
await expect(hdrStatus).toHaveText("HDR updated: 2");
await expect(input).toHaveValue("stateful");
// create new non-route component module
await fs.writeFile(
path.join(projectDir, "app/component.tsx"),
js`
export function MyComponent() {
return <p data-component>Component HMR: 0</p>;
}
`,
"utf8"
);
await edit("app/routes/_index.tsx", (contents) =>
contents
.replace(
"// imports",
`// imports\nimport { MyComponent } from "../component";`
)
.replace("{/* elements */}", "{/* elements */}\n<MyComponent />")
);
await page.waitForLoadState("networkidle");
let component = page.locator("#index [data-component]");
await expect(component).toBeVisible();
await expect(component).toHaveText("Component HMR: 0");
await expect(input).toHaveValue("stateful");
// non-route: HMR
await edit("app/component.tsx", (contents) =>
contents.replace("Component HMR: 0", "Component HMR: 1")
);
await page.waitForLoadState("networkidle");
await expect(component).toHaveText("Component HMR: 1");
await expect(input).toHaveValue("stateful");
// create new non-route server module
await fs.writeFile(
path.join(projectDir, "app/indirect-hdr-dep.ts"),
js`export const indirect = "indirect 0"`,
"utf8"
);
await fs.writeFile(
path.join(projectDir, "app/direct-hdr-dep.ts"),
js`
import { indirect } from "./indirect-hdr-dep"
export const direct = "direct 0 & " + indirect
`,
"utf8"
);
await edit("app/routes/_index.tsx", (contents) =>
contents
.replace(
"// imports",
`// imports\nimport { direct } from "../direct-hdr-dep"`
)
.replace(
`json({ message: "HDR updated: 2", context })`,
`json({ message: "HDR updated: " + direct, context })`
)
);
await page.waitForLoadState("networkidle");
await expect(hdrStatus).toHaveText("HDR updated: direct 0 & indirect 0");
await expect(input).toHaveValue("stateful");
// non-route: HDR for direct dependency
await edit("app/direct-hdr-dep.ts", (contents) =>
contents.replace("direct 0 &", "direct 1 &")
);
await page.waitForLoadState("networkidle");
await expect(hdrStatus).toHaveText("HDR updated: direct 1 & indirect 0");
await expect(input).toHaveValue("stateful");
// non-route: HDR for indirect dependency
await edit("app/indirect-hdr-dep.ts", (contents) =>
contents.replace("indirect 0", "indirect 1")
);
await page.waitForLoadState("networkidle");
await expect(hdrStatus).toHaveText("HDR updated: direct 1 & indirect 1");
await expect(input).toHaveValue("stateful");
// everything everywhere all at once
await Promise.all([
edit("app/routes/_index.tsx", (contents) =>
contents
.replace("HMR updated: 2", "HMR updated: 3")
.replace("HDR updated: ", "HDR updated: route & ")
),
edit("app/component.tsx", (contents) =>
contents.replace("Component HMR: 1", "Component HMR: 2")
),
edit("app/direct-hdr-dep.ts", (contents) =>
contents.replace("direct 1 &", "direct 2 &")
),
edit("app/indirect-hdr-dep.ts", (contents) =>
contents.replace("indirect 1", "indirect 2")
),
]);
await page.waitForLoadState("networkidle");
await expect(hmrStatus).toHaveText("HMR updated: 3");
await expect(component).toHaveText("Component HMR: 2");
await expect(hdrStatus).toHaveText(
"HDR updated: route & direct 2 & indirect 2"
);
await expect(input).toHaveValue("stateful");
});
async function edit(file: string, transform: (contents: string) => string) {
let filepath = path.join(projectDir, file);
let contents = await fs.readFile(filepath, "utf8");
await fs.writeFile(filepath, transform(contents), "utf8");
}