Repository navigation
Expand file tree
/
Copy pathworkers.test.ts
More file actions
314 lines (263 loc) · 9.34 KB
/
Copy pathworkers.test.ts
File metadata and controls
314 lines (263 loc) · 9.34 KB
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
312
313
314
import { existsSync } from "node:fs";
import { mockSpinner } from "helpers/__tests__/mocks";
import { getLatestTypesEntrypoint } from "helpers/compatDate";
import { readFile, usesTypescript, writeFile } from "helpers/files";
import { installPackages } from "helpers/packages";
import { beforeEach, describe, test, vi } from "vitest";
import { usesCfCli } from "../cf/config";
import { addTypes, updateTsConfig } from "../workers";
import { createTestContext } from "./helpers";
import type { C3Context } from "types";
vi.mock("helpers/files");
vi.mock("helpers/compatDate");
vi.mock("helpers/packages");
vi.mock("fs");
vi.mock("../cf/config");
vi.mock("@cloudflare/cli-shared-helpers/interactive");
beforeEach(() => {
mockSpinner();
});
const mockCompatDate = "2024-01-17";
describe("updateTsConfig", () => {
let ctx: C3Context;
beforeEach(() => {
ctx = createTestContext();
ctx.args.ts = true;
ctx.template.workersTypes = "generated";
vi.mocked(existsSync).mockImplementation(() => true);
vi.mocked(getLatestTypesEntrypoint).mockReturnValue(mockCompatDate);
// Mock the read of tsconfig.json
vi.mocked(readFile).mockImplementation(
() => `{ "compilerOptions": { "types": ["@cloudflare/workers-types"]} }`
);
});
test("installing workers types", async ({ expect }) => {
ctx.template.workersTypes = "installed";
await updateTsConfig(ctx, { usesNodeCompat: false });
expect(writeFile).toHaveBeenCalled();
expect(vi.mocked(writeFile).mock.calls[0][1]).toContain(
`"@cloudflare/workers-types/${mockCompatDate}"`
);
});
test("tsconfig.json not found", async ({ expect }) => {
vi.mocked(existsSync).mockImplementation(() => false);
await updateTsConfig(ctx, { usesNodeCompat: false });
expect(writeFile).not.toHaveBeenCalled();
});
test("falls back to bare workers-types when no date-versioned entrypoint is available", async ({
expect,
}) => {
ctx.template.workersTypes = "installed";
// `@cloudflare/workers-types` v5+ has no date-versioned entrypoints, but the
// package (mocked as existing via existsSync) is still installed.
vi.mocked(getLatestTypesEntrypoint).mockReturnValue(null);
await updateTsConfig(ctx, { usesNodeCompat: false });
const written = vi.mocked(writeFile).mock.calls[0][1];
expect(written).toContain(`"@cloudflare/workers-types"`);
expect(written).not.toContain(`@cloudflare/workers-types/`);
});
test("does not add bare workers-types when the package is not installed", async ({
expect,
}) => {
ctx.template.workersTypes = "installed";
vi.mocked(getLatestTypesEntrypoint).mockReturnValue(null);
vi.mocked(readFile).mockImplementation(
() => `{ "compilerOptions": { "types": [] } }`
);
// tsconfig.json exists, but node_modules/@cloudflare/workers-types does not.
vi.mocked(existsSync).mockImplementation((p) =>
String(p).includes("tsconfig.json")
);
await updateTsConfig(ctx, { usesNodeCompat: false });
const written = vi.mocked(writeFile).mock.calls[0][1];
expect(written).not.toContain("@cloudflare/workers-types");
});
test("don't clobber existing entrypoints", async ({ expect }) => {
ctx.template.workersTypes = "installed";
vi.mocked(readFile).mockImplementation(
() =>
`{ "compilerOptions": { "types" : ["@cloudflare/workers-types/2021-03-20"]} }`
);
await updateTsConfig(ctx, { usesNodeCompat: false });
expect(vi.mocked(writeFile).mock.calls[0][1]).toContain(
`"@cloudflare/workers-types/2021-03-20"`
);
});
test("will remove workers-types when generating types, if generated types include runtime types", async ({
expect,
}) => {
vi.mocked(readFile).mockImplementation((path) => {
if (path.includes("tsconfig.json")) {
return `{ "compilerOptions": { "types" : ["@cloudflare/workers-types/2021-03-20"]} }`;
} else {
return "// Runtime types generated with workerd";
}
});
await updateTsConfig(ctx, { usesNodeCompat: false });
expect(vi.mocked(writeFile).mock.calls[0][1]).not.toContain(
`"@cloudflare/workers-types/2021-03-20"`
);
});
test("will NOT remove workers-types when generating types, if generated types don't include runtime types", async ({
expect,
}) => {
vi.mocked(readFile).mockImplementation((path) => {
if (path.includes("tsconfig.json")) {
return `{ "compilerOptions": { "types" : ["@cloudflare/workers-types/2021-03-20"]} }`;
} else {
return "no runtime types here";
}
});
await updateTsConfig(ctx, { usesNodeCompat: false });
expect(vi.mocked(writeFile).mock.calls[0][1]).toContain(
`"@cloudflare/workers-types/2021-03-20"`
);
});
test("will add generated types file", async ({ expect }) => {
await updateTsConfig(ctx, { usesNodeCompat: false });
expect(vi.mocked(writeFile).mock.calls[0][1]).toContain(
`./worker-configuration.d.ts`
);
});
test("will not add generated types file for cf projects", async ({
expect,
}) => {
vi.mocked(usesCfCli).mockReturnValue(true);
vi.mocked(readFile).mockImplementation((path) =>
path.includes("tsconfig.json")
? `{ "compilerOptions": { "types" : ["@cloudflare/workers-types"]} }`
: "// Runtime types generated with workerd"
);
await updateTsConfig(ctx, { usesNodeCompat: false });
const written = vi.mocked(writeFile).mock.calls[0][1];
expect(written).not.toContain(".cloudflare/types");
expect(written).not.toContain("@cloudflare/workers-types");
// The runtime types are read from where `cf` generates them
expect(readFile).toHaveBeenCalledWith("./.cloudflare/types/index.d.ts");
});
test("will not add an empty types list for cf projects", async ({
expect,
}) => {
vi.mocked(usesCfCli).mockReturnValue(true);
vi.mocked(readFile).mockImplementation((path) =>
path.includes("tsconfig.json")
? `{ "compilerOptions": {} }`
: "// Runtime types generated with workerd"
);
await updateTsConfig(ctx, { usesNodeCompat: false });
expect(writeFile).not.toHaveBeenCalled();
});
test("preserves SvelteKit generated types", async ({ expect }) => {
vi.mocked(readFile).mockImplementation((path) =>
path.includes("tsconfig.json")
? `{ "extends": "$app/tsconfig", "compilerOptions": {} }`
: "no runtime types here"
);
await updateTsConfig(ctx, { usesNodeCompat: false });
const written = vi.mocked(writeFile).mock.calls[0][1];
expect(written).toContain(`"$app/types"`);
expect(written).toContain(`"./worker-configuration.d.ts"`);
});
test("skips modification when tsconfig uses project references", async ({
expect,
}) => {
vi.mocked(readFile).mockImplementation(
() => `{
"files": [],
"references": [
{ "path": "./tsconfig.app.json" },
{ "path": "./tsconfig.node.json" }
]
}`
);
await updateTsConfig(ctx, { usesNodeCompat: false });
expect(writeFile).not.toHaveBeenCalled();
});
test("modifies tsconfig when references array is empty", async ({
expect,
}) => {
ctx.template.workersTypes = "installed";
vi.mocked(readFile).mockImplementation(
() => `{
"compilerOptions": { "types": [] },
"references": []
}`
);
await updateTsConfig(ctx, { usesNodeCompat: false });
expect(writeFile).toHaveBeenCalled();
});
});
describe("addTypes", () => {
let ctx: C3Context;
beforeEach(() => {
ctx = createTestContext();
ctx.args.ts = true;
ctx.template.workersTypes = "installed";
vi.mocked(existsSync).mockImplementation(() => true);
vi.mocked(usesTypescript).mockReturnValue(true);
vi.mocked(getLatestTypesEntrypoint).mockReturnValue(mockCompatDate);
});
function mockProjectConfig(wranglerConfig: Record<string, unknown>) {
vi.mocked(readFile).mockImplementation((path) =>
path.includes("tsconfig.json")
? `{ "compilerOptions": { "types": [] } }`
: JSON.stringify(wranglerConfig)
);
}
function writtenTsConfig() {
const call = vi
.mocked(writeFile)
.mock.calls.find(([path]) => path.includes("tsconfig.json"));
return call?.[1];
}
test("installs node types when nodejs_compat is set", async ({ expect }) => {
mockProjectConfig({
compatibility_date: "2025-01-01",
compatibility_flags: ["nodejs_compat"],
});
await addTypes(ctx);
expect(installPackages).toHaveBeenCalledWith(
["@types/node"],
expect.anything()
);
expect(writtenTsConfig()).toContain(`"node"`);
});
// The flag is redundant, and rejected by workerd, for these dates, so it is
// the compatibility date alone that tells us Node.js compatibility is on.
test("installs node types when the compatibility date enables nodejs_compat by default", async ({
expect,
}) => {
mockProjectConfig({ compatibility_date: "2026-08-04" });
await addTypes(ctx);
expect(installPackages).toHaveBeenCalledWith(
["@types/node"],
expect.anything()
);
expect(writtenTsConfig()).toContain(`"node"`);
});
test("does not install node types without Node.js compatibility", async ({
expect,
}) => {
mockProjectConfig({ compatibility_date: "2025-01-01" });
await addTypes(ctx);
expect(installPackages).not.toHaveBeenCalledWith(
["@types/node"],
expect.anything()
);
expect(writtenTsConfig()).not.toContain(`"node"`);
});
test("does not install node types when Node.js compatibility is opted out of", async ({
expect,
}) => {
mockProjectConfig({
compatibility_date: "2026-08-04",
compatibility_flags: ["no_nodejs_compat", "no_nodejs_compat_v2"],
});
await addTypes(ctx);
expect(installPackages).not.toHaveBeenCalledWith(
["@types/node"],
expect.anything()
);
expect(writtenTsConfig()).not.toContain(`"node"`);
});
});