wrangler 0.0.0-e88a54e → 0.0.0-e8975a93a

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (171) hide show
  1. package/README.md +47 -16
  2. package/bin/wrangler.js +95 -32
  3. package/config-schema.json +3067 -0
  4. package/kv-asset-handler.js +1 -0
  5. package/package.json +148 -95
  6. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  7. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  8. package/templates/__tests__/tsconfig.json +8 -0
  9. package/templates/checked-fetch.js +30 -0
  10. package/templates/facade.d.ts +19 -0
  11. package/templates/gitignore +170 -0
  12. package/templates/init-tests/test-jest-new-worker.js +23 -0
  13. package/templates/init-tests/test-vitest-new-worker.js +24 -0
  14. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  15. package/templates/middleware/common.ts +67 -0
  16. package/templates/middleware/loader-modules.ts +134 -0
  17. package/templates/middleware/loader-sw.ts +229 -0
  18. package/templates/middleware/middleware-ensure-req-body-drained.ts +18 -0
  19. package/templates/middleware/middleware-miniflare3-json-error.ts +32 -0
  20. package/templates/middleware/middleware-pretty-error.ts +40 -0
  21. package/templates/middleware/middleware-scheduled.ts +29 -0
  22. package/templates/middleware/middleware-serve-static-assets.d.ts +6 -0
  23. package/templates/middleware/middleware-serve-static-assets.ts +56 -0
  24. package/templates/modules-watch-stub.js +4 -0
  25. package/templates/new-worker-scheduled.js +17 -0
  26. package/templates/new-worker-scheduled.ts +32 -0
  27. package/templates/new-worker.js +3 -3
  28. package/templates/new-worker.ts +22 -4
  29. package/templates/no-op-worker.js +10 -0
  30. package/templates/pages-dev-pipeline.ts +32 -0
  31. package/templates/pages-dev-util.ts +55 -0
  32. package/templates/pages-shim.ts +9 -0
  33. package/templates/pages-template-plugin.ts +190 -0
  34. package/templates/pages-template-worker.ts +198 -0
  35. package/templates/startDevWorker/InspectorProxyWorker.ts +664 -0
  36. package/templates/startDevWorker/ProxyWorker.ts +336 -0
  37. package/templates/tsconfig-sanity.ts +11 -0
  38. package/templates/tsconfig.init.json +22 -0
  39. package/templates/tsconfig.json +6 -103
  40. package/wrangler-dist/InspectorProxyWorker.js +464 -0
  41. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  42. package/wrangler-dist/ProxyWorker.js +241 -0
  43. package/wrangler-dist/ProxyWorker.js.map +6 -0
  44. package/wrangler-dist/cli.d.ts +26398 -0
  45. package/wrangler-dist/cli.js +204149 -133554
  46. package/wrangler-dist/wasm-sync.wasm +0 -0
  47. package/import_meta_url.js +0 -3
  48. package/miniflare-config-stubs/.env.empty +0 -0
  49. package/miniflare-config-stubs/package.empty.json +0 -1
  50. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  51. package/miniflare-dist/index.mjs +0 -79
  52. package/miniflare-dist/index.mjs.map +0 -7
  53. package/pages/functions/buildWorker.ts +0 -62
  54. package/pages/functions/filepath-routing.test.ts +0 -223
  55. package/pages/functions/filepath-routing.ts +0 -181
  56. package/pages/functions/identifiers.ts +0 -78
  57. package/pages/functions/routes.ts +0 -151
  58. package/pages/functions/template-worker.ts +0 -130
  59. package/src/__tests__/configuration.test.ts +0 -2796
  60. package/src/__tests__/dev.test.tsx +0 -496
  61. package/src/__tests__/dev2.test.tsx +0 -154
  62. package/src/__tests__/guess-worker-format.test.ts +0 -58
  63. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  64. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  65. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  66. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  67. package/src/__tests__/helpers/mock-bin.ts +0 -36
  68. package/src/__tests__/helpers/mock-cfetch.ts +0 -207
  69. package/src/__tests__/helpers/mock-console.ts +0 -70
  70. package/src/__tests__/helpers/mock-dialogs.ts +0 -65
  71. package/src/__tests__/helpers/mock-kv.ts +0 -33
  72. package/src/__tests__/helpers/mock-stdin.ts +0 -103
  73. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  74. package/src/__tests__/helpers/run-in-tmp.ts +0 -32
  75. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  76. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  77. package/src/__tests__/https-options.test.ts +0 -127
  78. package/src/__tests__/index.test.ts +0 -991
  79. package/src/__tests__/jest.setup.ts +0 -69
  80. package/src/__tests__/kv.test.ts +0 -1382
  81. package/src/__tests__/logout.test.ts +0 -52
  82. package/src/__tests__/package-manager.test.ts +0 -206
  83. package/src/__tests__/pages.test.ts +0 -44
  84. package/src/__tests__/parse.test.ts +0 -322
  85. package/src/__tests__/publish.test.ts +0 -2704
  86. package/src/__tests__/r2.test.ts +0 -198
  87. package/src/__tests__/route.test.ts +0 -45
  88. package/src/__tests__/secret.test.ts +0 -425
  89. package/src/__tests__/sentry.test.ts +0 -146
  90. package/src/__tests__/tail.test.ts +0 -564
  91. package/src/__tests__/whoami.test.tsx +0 -100
  92. package/src/bundle.ts +0 -142
  93. package/src/cfetch/index.ts +0 -104
  94. package/src/cfetch/internal.ts +0 -139
  95. package/src/cli.ts +0 -19
  96. package/src/config/README.md +0 -107
  97. package/src/config/config.ts +0 -218
  98. package/src/config/diagnostics.ts +0 -80
  99. package/src/config/environment.ts +0 -366
  100. package/src/config/index.ts +0 -62
  101. package/src/config/validation-helpers.ts +0 -486
  102. package/src/config/validation.ts +0 -1090
  103. package/src/create-worker-preview.ts +0 -166
  104. package/src/create-worker-upload-form.ts +0 -217
  105. package/src/dev/dev.tsx +0 -364
  106. package/src/dev/local.tsx +0 -232
  107. package/src/dev/remote.tsx +0 -203
  108. package/src/dev/use-esbuild.ts +0 -100
  109. package/src/dialogs.tsx +0 -77
  110. package/src/entry.ts +0 -208
  111. package/src/environment-variables.ts +0 -33
  112. package/src/https-options.ts +0 -122
  113. package/src/index.tsx +0 -2373
  114. package/src/inspect.ts +0 -617
  115. package/src/kv.ts +0 -319
  116. package/src/miniflare-cli/README.md +0 -30
  117. package/src/miniflare-cli/enum-keys.ts +0 -17
  118. package/src/miniflare-cli/index.ts +0 -37
  119. package/src/module-collection.ts +0 -258
  120. package/src/open-in-browser.ts +0 -25
  121. package/src/package-manager.ts +0 -126
  122. package/src/pages.tsx +0 -1047
  123. package/src/parse.ts +0 -183
  124. package/src/paths.ts +0 -26
  125. package/src/proxy.ts +0 -440
  126. package/src/publish.ts +0 -347
  127. package/src/r2.ts +0 -50
  128. package/src/reporting.ts +0 -131
  129. package/src/selfsigned.d.ts +0 -29
  130. package/src/sites.tsx +0 -280
  131. package/src/tail/filters.ts +0 -279
  132. package/src/tail/index.ts +0 -299
  133. package/src/tail/printing.ts +0 -62
  134. package/src/user.tsx +0 -1118
  135. package/src/whoami.tsx +0 -69
  136. package/src/worker.ts +0 -163
  137. package/templates/static-asset-facade.js +0 -47
  138. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  139. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  140. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  141. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  142. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  143. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  144. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  145. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  146. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  147. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  148. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  149. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  150. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  151. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  152. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  153. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  154. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  155. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  156. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  157. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  158. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  159. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  160. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  161. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  162. package/vendor/wrangler-mime/LICENSE +0 -21
  163. package/vendor/wrangler-mime/Mime.js +0 -97
  164. package/vendor/wrangler-mime/README.md +0 -187
  165. package/vendor/wrangler-mime/cli.js +0 -46
  166. package/vendor/wrangler-mime/index.js +0 -4
  167. package/vendor/wrangler-mime/lite.js +0 -4
  168. package/vendor/wrangler-mime/package.json +0 -52
  169. package/vendor/wrangler-mime/types/other.js +0 -1
  170. package/vendor/wrangler-mime/types/standard.js +0 -1
  171. package/wrangler-dist/cli.js.map +0 -7
package/src/pages.tsx DELETED
@@ -1,1047 +0,0 @@
1
- /* eslint-disable no-shadow */
2
-
3
- import { execSync, spawn } from "node:child_process";
4
- import { existsSync, lstatSync, readFileSync, writeFileSync } from "node:fs";
5
- import { tmpdir } from "node:os";
6
- import { join } from "node:path";
7
- import { URL } from "node:url";
8
- import { watch } from "chokidar";
9
- import { getType } from "mime";
10
- import { buildWorker } from "../pages/functions/buildWorker";
11
- import { generateConfigFromFileTree } from "../pages/functions/filepath-routing";
12
- import { writeRoutesModule } from "../pages/functions/routes";
13
- import openInBrowser from "./open-in-browser";
14
- import { toUrlPath } from "./paths";
15
- import type { Config } from "../pages/functions/routes";
16
- import type { Headers, Request, fetch } from "@miniflare/core";
17
- import type { BuildResult } from "esbuild";
18
- import type { MiniflareOptions } from "miniflare";
19
- import type { BuilderCallback } from "yargs";
20
-
21
- // Defer importing miniflare until we really need it. This takes ~0.5s
22
- // and also modifies some `stream/web` and `undici` prototypes, so we
23
- // don't want to do this if pages commands aren't being called.
24
-
25
- const EXIT_CALLBACKS: (() => void)[] = [];
26
- const EXIT = (message?: string, code?: number) => {
27
- if (message) console.log(message);
28
- if (code) process.exitCode = code;
29
- EXIT_CALLBACKS.forEach((callback) => callback());
30
- process.exit(code);
31
- };
32
-
33
- process.on("SIGINT", () => EXIT());
34
- process.on("SIGTERM", () => EXIT());
35
-
36
- function isWindows() {
37
- return process.platform === "win32";
38
- }
39
-
40
- const SECONDS_TO_WAIT_FOR_PROXY = 5;
41
-
42
- async function sleep(ms: number) {
43
- await new Promise((resolve) => setTimeout(resolve, ms));
44
- }
45
-
46
- function getPids(pid: number) {
47
- const pids: number[] = [pid];
48
- let command: string, regExp: RegExp;
49
-
50
- if (isWindows()) {
51
- command = `wmic process where (ParentProcessId=${pid}) get ProcessId`;
52
- regExp = new RegExp(/(\d+)/);
53
- } else {
54
- command = `pgrep -P ${pid}`;
55
- regExp = new RegExp(/(\d+)/);
56
- }
57
-
58
- try {
59
- const newPids = (
60
- execSync(command)
61
- .toString()
62
- .split("\n")
63
- .map((line) => line.match(regExp))
64
- .filter((line) => line !== null) as RegExpExecArray[]
65
- ).map((match) => parseInt(match[1]));
66
-
67
- pids.push(...newPids.map(getPids).flat());
68
- } catch {}
69
-
70
- return pids;
71
- }
72
-
73
- function getPort(pid: number) {
74
- let command: string, regExp: RegExp;
75
-
76
- if (isWindows()) {
77
- command = "\\windows\\system32\\netstat.exe -nao";
78
- regExp = new RegExp(`TCP\\s+.*:(\\d+)\\s+.*:\\d+\\s+LISTENING\\s+${pid}`);
79
- } else {
80
- command = "lsof -nPi";
81
- regExp = new RegExp(`${pid}\\s+.*TCP\\s+.*:(\\d+)\\s+\\(LISTEN\\)`);
82
- }
83
-
84
- try {
85
- const matches = execSync(command)
86
- .toString()
87
- .split("\n")
88
- .map((line) => line.match(regExp))
89
- .filter((line) => line !== null) as RegExpExecArray[];
90
-
91
- const match = matches[0];
92
- if (match) return parseInt(match[1]);
93
- } catch (thrown) {
94
- console.error(
95
- `Error scanning for ports of process with PID ${pid}: ${thrown}`
96
- );
97
- }
98
- }
99
-
100
- async function spawnProxyProcess({
101
- port,
102
- command,
103
- }: {
104
- port?: number;
105
- command: (string | number)[];
106
- }): Promise<void | number> {
107
- if (command.length === 0)
108
- return EXIT(
109
- "Must specify a directory of static assets to serve or a command to run.",
110
- 1
111
- );
112
-
113
- console.log(`Running ${command.join(" ")}...`);
114
- const proxy = spawn(
115
- command[0].toString(),
116
- command.slice(1).map((value) => value.toString()),
117
- {
118
- shell: isWindows(),
119
- env: {
120
- BROWSER: "none",
121
- ...process.env,
122
- },
123
- }
124
- );
125
- EXIT_CALLBACKS.push(() => {
126
- proxy.kill();
127
- });
128
-
129
- proxy.stdout.on("data", (data) => {
130
- console.log(`[proxy]: ${data}`);
131
- });
132
-
133
- proxy.stderr.on("data", (data) => {
134
- console.error(`[proxy]: ${data}`);
135
- });
136
-
137
- proxy.on("close", (code) => {
138
- console.error(`Proxy exited with status ${code}.`);
139
- });
140
-
141
- // Wait for proxy process to start...
142
- while (!proxy.pid) {}
143
-
144
- if (port === undefined) {
145
- console.log(
146
- `Sleeping ${SECONDS_TO_WAIT_FOR_PROXY} seconds to allow proxy process to start before attempting to automatically determine port...`
147
- );
148
- console.log("To skip, specify the proxy port with --proxy.");
149
- await sleep(SECONDS_TO_WAIT_FOR_PROXY * 1000);
150
-
151
- port = getPids(proxy.pid)
152
- .map(getPort)
153
- .filter((port) => port !== undefined)[0];
154
-
155
- if (port === undefined) {
156
- return EXIT(
157
- "Could not automatically determine proxy port. Please specify the proxy port with --proxy.",
158
- 1
159
- );
160
- } else {
161
- console.log(`Automatically determined the proxy port to be ${port}.`);
162
- }
163
- }
164
-
165
- return port;
166
- }
167
-
168
- function escapeRegex(str: string) {
169
- return str.replace(/[-/\\^$*+?.()|[]{}]/g, "\\$&");
170
- }
171
-
172
- type Replacements = Record<string, string>;
173
-
174
- function replacer(str: string, replacements: Replacements) {
175
- for (const [replacement, value] of Object.entries(replacements)) {
176
- str = str.replace(`:${replacement}`, value);
177
- }
178
- return str;
179
- }
180
-
181
- function generateRulesMatcher<T>(
182
- rules?: Record<string, T>,
183
- replacer: (match: T, replacements: Replacements) => T = (match) => match
184
- ) {
185
- // TODO: How can you test cross-host rules?
186
- if (!rules) return () => [];
187
-
188
- const compiledRules = Object.entries(rules)
189
- .map(([rule, match]) => {
190
- const crossHost = rule.startsWith("https://");
191
-
192
- rule = rule.split("*").map(escapeRegex).join("(?<splat>.*)");
193
-
194
- const host_matches = rule.matchAll(
195
- /(?<=^https:\\\/\\\/[^/]*?):([^\\]+)(?=\\)/g
196
- );
197
- for (const match of host_matches) {
198
- rule = rule.split(match[0]).join(`(?<${match[1]}>[^/.]+)`);
199
- }
200
-
201
- const path_matches = rule.matchAll(/:(\w+)/g);
202
- for (const match of path_matches) {
203
- rule = rule.split(match[0]).join(`(?<${match[1]}>[^/]+)`);
204
- }
205
-
206
- rule = "^" + rule + "$";
207
-
208
- try {
209
- const regExp = new RegExp(rule);
210
- return [{ crossHost, regExp }, match];
211
- } catch {}
212
- })
213
- .filter((value) => value !== undefined) as [
214
- { crossHost: boolean; regExp: RegExp },
215
- T
216
- ][];
217
-
218
- return ({ request }: { request: Request }) => {
219
- const { pathname, host } = new URL(request.url);
220
-
221
- return compiledRules
222
- .map(([{ crossHost, regExp }, match]) => {
223
- const test = crossHost ? `https://${host}${pathname}` : pathname;
224
- const result = regExp.exec(test);
225
- if (result) {
226
- return replacer(match, result.groups || {});
227
- }
228
- })
229
- .filter((value) => value !== undefined) as T[];
230
- };
231
- }
232
-
233
- function generateHeadersMatcher(headersFile: string) {
234
- if (existsSync(headersFile)) {
235
- const contents = readFileSync(headersFile).toString();
236
-
237
- // TODO: Log errors
238
- const lines = contents
239
- .split("\n")
240
- .map((line) => line.trim())
241
- .filter((line) => !line.startsWith("#") && line !== "");
242
-
243
- const rules: Record<string, Record<string, string>> = {};
244
- let rule: { path: string; headers: Record<string, string> } | undefined =
245
- undefined;
246
-
247
- for (const line of lines) {
248
- if (/^([^\s]+:\/\/|^\/)/.test(line)) {
249
- if (rule && Object.keys(rule.headers).length > 0) {
250
- rules[rule.path] = rule.headers;
251
- }
252
-
253
- const path = validateURL(line);
254
- if (path) {
255
- rule = {
256
- path,
257
- headers: {},
258
- };
259
- continue;
260
- }
261
- }
262
-
263
- if (!line.includes(":")) continue;
264
-
265
- const [rawName, ...rawValue] = line.split(":");
266
- const name = rawName.trim().toLowerCase();
267
- const value = rawValue.join(":").trim();
268
-
269
- if (name === "") continue;
270
- if (!rule) continue;
271
-
272
- const existingValues = rule.headers[name];
273
- rule.headers[name] = existingValues
274
- ? `${existingValues}, ${value}`
275
- : value;
276
- }
277
-
278
- if (rule && Object.keys(rule.headers).length > 0) {
279
- rules[rule.path] = rule.headers;
280
- }
281
-
282
- const rulesMatcher = generateRulesMatcher(rules, (match, replacements) =>
283
- Object.fromEntries(
284
- Object.entries(match).map(([name, value]) => [
285
- name,
286
- replacer(value, replacements),
287
- ])
288
- )
289
- );
290
-
291
- return (request: Request) => {
292
- const matches = rulesMatcher({
293
- request,
294
- });
295
- if (matches) return matches;
296
- };
297
- } else {
298
- return () => undefined;
299
- }
300
- }
301
-
302
- function generateRedirectsMatcher(redirectsFile: string) {
303
- if (existsSync(redirectsFile)) {
304
- const contents = readFileSync(redirectsFile).toString();
305
-
306
- // TODO: Log errors
307
- const lines = contents
308
- .split("\n")
309
- .map((line) => line.trim())
310
- .filter((line) => !line.startsWith("#") && line !== "");
311
-
312
- const rules = Object.fromEntries(
313
- lines
314
- .map((line) => line.split(" "))
315
- .filter((tokens) => tokens.length === 2 || tokens.length === 3)
316
- .map((tokens) => {
317
- const from = validateURL(tokens[0], true, false, false);
318
- const to = validateURL(tokens[1], false, true, true);
319
- let status: number | undefined = parseInt(tokens[2]) || 302;
320
- status = [301, 302, 303, 307, 308].includes(status)
321
- ? status
322
- : undefined;
323
-
324
- return from && to && status ? [from, { to, status }] : undefined;
325
- })
326
- .filter((rule) => rule !== undefined) as [
327
- string,
328
- { to: string; status?: number }
329
- ][]
330
- );
331
-
332
- const rulesMatcher = generateRulesMatcher(
333
- rules,
334
- ({ status, to }, replacements) => ({
335
- status,
336
- to: replacer(to, replacements),
337
- })
338
- );
339
-
340
- return (request: Request) => {
341
- const match = rulesMatcher({
342
- request,
343
- })[0];
344
- if (match) return match;
345
- };
346
- } else {
347
- return () => undefined;
348
- }
349
- }
350
-
351
- function extractPathname(
352
- path = "/",
353
- includeSearch: boolean,
354
- includeHash: boolean
355
- ) {
356
- if (!path.startsWith("/")) path = `/${path}`;
357
- const url = new URL(`//${path}`, "relative://");
358
- return `${url.pathname}${includeSearch ? url.search : ""}${
359
- includeHash ? url.hash : ""
360
- }`;
361
- }
362
-
363
- function validateURL(
364
- token: string,
365
- onlyRelative = false,
366
- includeSearch = false,
367
- includeHash = false
368
- ) {
369
- const host = /^https:\/\/+(?<host>[^/]+)\/?(?<path>.*)/.exec(token);
370
- if (host && host.groups && host.groups.host) {
371
- if (onlyRelative) return;
372
-
373
- return `https://${host.groups.host}${extractPathname(
374
- host.groups.path,
375
- includeSearch,
376
- includeHash
377
- )}`;
378
- } else {
379
- if (!token.startsWith("/") && onlyRelative) token = `/${token}`;
380
-
381
- const path = /^\//.exec(token);
382
- if (path) {
383
- try {
384
- return extractPathname(token, includeSearch, includeHash);
385
- } catch {}
386
- }
387
- }
388
- return "";
389
- }
390
-
391
- function hasFileExtension(pathname: string) {
392
- return /\/.+\.[a-z0-9]+$/i.test(pathname);
393
- }
394
-
395
- async function generateAssetsFetch(directory: string): Promise<typeof fetch> {
396
- // Defer importing miniflare until we really need it
397
- const { Headers, Request, Response } = await import("@miniflare/core");
398
-
399
- const headersFile = join(directory, "_headers");
400
- const redirectsFile = join(directory, "_redirects");
401
- const workerFile = join(directory, "_worker.js");
402
-
403
- const ignoredFiles = [headersFile, redirectsFile, workerFile];
404
-
405
- const assetExists = (path: string) => {
406
- path = join(directory, path);
407
- return (
408
- existsSync(path) &&
409
- lstatSync(path).isFile() &&
410
- !ignoredFiles.includes(path)
411
- );
412
- };
413
-
414
- const getAsset = (path: string) => {
415
- if (assetExists(path)) {
416
- return join(directory, path);
417
- }
418
- };
419
-
420
- let redirectsMatcher = generateRedirectsMatcher(redirectsFile);
421
- let headersMatcher = generateHeadersMatcher(headersFile);
422
-
423
- watch([headersFile, redirectsFile], {
424
- persistent: true,
425
- }).on("change", (path) => {
426
- switch (path) {
427
- case headersFile: {
428
- console.log("_headers modified. Re-evaluating...");
429
- headersMatcher = generateHeadersMatcher(headersFile);
430
- break;
431
- }
432
- case redirectsFile: {
433
- console.log("_redirects modified. Re-evaluating...");
434
- redirectsMatcher = generateRedirectsMatcher(redirectsFile);
435
- break;
436
- }
437
- }
438
- });
439
-
440
- const serveAsset = (file: string) => {
441
- return readFileSync(file);
442
- };
443
-
444
- const generateResponse = (request: Request) => {
445
- const url = new URL(request.url);
446
-
447
- const deconstructedResponse: {
448
- status: number;
449
- headers: Headers;
450
- body?: Buffer;
451
- } = {
452
- status: 200,
453
- headers: new Headers(),
454
- body: undefined,
455
- };
456
-
457
- const match = redirectsMatcher(request);
458
- if (match) {
459
- const { status, to } = match;
460
-
461
- let location = to;
462
- let search;
463
-
464
- if (to.startsWith("/")) {
465
- search = new URL(location, "http://fakehost").search;
466
- } else {
467
- search = new URL(location).search;
468
- }
469
-
470
- location = `${location}${search ? "" : url.search}`;
471
-
472
- if (status && [301, 302, 303, 307, 308].includes(status)) {
473
- deconstructedResponse.status = status;
474
- } else {
475
- deconstructedResponse.status = 302;
476
- }
477
-
478
- deconstructedResponse.headers.set("Location", location);
479
- return deconstructedResponse;
480
- }
481
-
482
- if (!request.method?.match(/^(get|head)$/i)) {
483
- deconstructedResponse.status = 405;
484
- return deconstructedResponse;
485
- }
486
-
487
- const notFound = () => {
488
- let cwd = url.pathname;
489
- while (cwd) {
490
- cwd = cwd.slice(0, cwd.lastIndexOf("/"));
491
-
492
- if ((asset = getAsset(`${cwd}/404.html`))) {
493
- deconstructedResponse.status = 404;
494
- deconstructedResponse.body = serveAsset(asset);
495
- deconstructedResponse.headers.set(
496
- "Content-Type",
497
- getType(asset) || "application/octet-stream"
498
- );
499
- return deconstructedResponse;
500
- }
501
- }
502
-
503
- if ((asset = getAsset(`/index.html`))) {
504
- deconstructedResponse.body = serveAsset(asset);
505
- deconstructedResponse.headers.set(
506
- "Content-Type",
507
- getType(asset) || "application/octet-stream"
508
- );
509
- return deconstructedResponse;
510
- }
511
-
512
- deconstructedResponse.status = 404;
513
- return deconstructedResponse;
514
- };
515
-
516
- let asset;
517
-
518
- if (url.pathname.endsWith("/")) {
519
- if ((asset = getAsset(`${url.pathname}/index.html`))) {
520
- deconstructedResponse.body = serveAsset(asset);
521
- deconstructedResponse.headers.set(
522
- "Content-Type",
523
- getType(asset) || "application/octet-stream"
524
- );
525
- return deconstructedResponse;
526
- } else if (
527
- (asset = getAsset(`${url.pathname.replace(/\/$/, ".html")}`))
528
- ) {
529
- deconstructedResponse.status = 301;
530
- deconstructedResponse.headers.set(
531
- "Location",
532
- `${url.pathname.slice(0, -1)}${url.search}`
533
- );
534
- return deconstructedResponse;
535
- }
536
- }
537
-
538
- if (url.pathname.endsWith("/index")) {
539
- deconstructedResponse.status = 301;
540
- deconstructedResponse.headers.set(
541
- "Location",
542
- `${url.pathname.slice(0, -"index".length)}${url.search}`
543
- );
544
- return deconstructedResponse;
545
- }
546
-
547
- if ((asset = getAsset(url.pathname))) {
548
- if (url.pathname.endsWith(".html")) {
549
- const extensionlessPath = url.pathname.slice(0, -".html".length);
550
- if (getAsset(extensionlessPath) || extensionlessPath === "/") {
551
- deconstructedResponse.body = serveAsset(asset);
552
- deconstructedResponse.headers.set(
553
- "Content-Type",
554
- getType(asset) || "application/octet-stream"
555
- );
556
- return deconstructedResponse;
557
- } else {
558
- deconstructedResponse.status = 301;
559
- deconstructedResponse.headers.set(
560
- "Location",
561
- `${extensionlessPath}${url.search}`
562
- );
563
- return deconstructedResponse;
564
- }
565
- } else {
566
- deconstructedResponse.body = serveAsset(asset);
567
- deconstructedResponse.headers.set(
568
- "Content-Type",
569
- getType(asset) || "application/octet-stream"
570
- );
571
- return deconstructedResponse;
572
- }
573
- } else if (hasFileExtension(url.pathname)) {
574
- notFound();
575
- return deconstructedResponse;
576
- }
577
-
578
- if ((asset = getAsset(`${url.pathname}.html`))) {
579
- deconstructedResponse.body = serveAsset(asset);
580
- deconstructedResponse.headers.set(
581
- "Content-Type",
582
- getType(asset) || "application/octet-stream"
583
- );
584
- return deconstructedResponse;
585
- }
586
-
587
- if ((asset = getAsset(`${url.pathname}/index.html`))) {
588
- deconstructedResponse.status = 301;
589
- deconstructedResponse.headers.set(
590
- "Location",
591
- `${url.pathname}/${url.search}`
592
- );
593
- return deconstructedResponse;
594
- } else {
595
- notFound();
596
- return deconstructedResponse;
597
- }
598
- };
599
-
600
- const attachHeaders = (
601
- request: Request,
602
- deconstructedResponse: { status: number; headers: Headers; body?: Buffer }
603
- ) => {
604
- const headers = deconstructedResponse.headers;
605
- const newHeaders = new Headers({});
606
- const matches = headersMatcher(request) || [];
607
-
608
- matches.forEach((match) => {
609
- Object.entries(match).forEach(([name, value]) => {
610
- newHeaders.append(name, `${value}`);
611
- });
612
- });
613
-
614
- const combinedHeaders = {
615
- ...Object.fromEntries(headers.entries()),
616
- ...Object.fromEntries(newHeaders.entries()),
617
- };
618
-
619
- deconstructedResponse.headers = new Headers({});
620
- Object.entries(combinedHeaders).forEach(([name, value]) => {
621
- if (value) deconstructedResponse.headers.set(name, value);
622
- });
623
- };
624
-
625
- return async (input, init) => {
626
- const request = new Request(input, init);
627
- const deconstructedResponse = generateResponse(request);
628
- attachHeaders(request, deconstructedResponse);
629
-
630
- const headers = new Headers();
631
-
632
- [...deconstructedResponse.headers.entries()].forEach(([name, value]) => {
633
- if (value) headers.set(name, value);
634
- });
635
-
636
- return new Response(deconstructedResponse.body, {
637
- headers,
638
- status: deconstructedResponse.status,
639
- });
640
- };
641
- }
642
-
643
- const RUNNING_BUILDERS: BuildResult[] = [];
644
-
645
- async function buildFunctions({
646
- scriptPath,
647
- outputConfigPath,
648
- functionsDirectory,
649
- minify = false,
650
- sourcemap = false,
651
- fallbackService = "ASSETS",
652
- watch = false,
653
- onEnd,
654
- }: {
655
- scriptPath: string;
656
- outputConfigPath?: string;
657
- functionsDirectory: string;
658
- minify?: boolean;
659
- sourcemap?: boolean;
660
- fallbackService?: string;
661
- watch?: boolean;
662
- onEnd?: () => void;
663
- }) {
664
- RUNNING_BUILDERS.forEach(
665
- (runningBuilder) => runningBuilder.stop && runningBuilder.stop()
666
- );
667
-
668
- const routesModule = join(tmpdir(), "./functionsRoutes.mjs");
669
- const baseURL = toUrlPath("/");
670
-
671
- const config: Config = await generateConfigFromFileTree({
672
- baseDir: functionsDirectory,
673
- baseURL,
674
- });
675
-
676
- if (outputConfigPath) {
677
- writeFileSync(
678
- outputConfigPath,
679
- JSON.stringify({ ...config, baseURL }, null, 2)
680
- );
681
- }
682
-
683
- await writeRoutesModule({
684
- config,
685
- srcDir: functionsDirectory,
686
- outfile: routesModule,
687
- });
688
-
689
- RUNNING_BUILDERS.push(
690
- await buildWorker({
691
- routesModule,
692
- outfile: scriptPath,
693
- minify,
694
- sourcemap,
695
- fallbackService,
696
- watch,
697
- onEnd,
698
- })
699
- );
700
- }
701
-
702
- export const pages: BuilderCallback<unknown, unknown> = (yargs) => {
703
- return yargs
704
- .command(
705
- "dev [directory] [-- command]",
706
- "🧑‍💻 Develop your full-stack Pages application locally",
707
- (yargs) => {
708
- return yargs
709
- .positional("directory", {
710
- type: "string",
711
- demandOption: undefined,
712
- description: "The directory of static assets to serve",
713
- })
714
- .positional("command", {
715
- type: "string",
716
- demandOption: undefined,
717
- description: "The proxy command to run",
718
- })
719
- .options({
720
- local: {
721
- type: "boolean",
722
- default: true,
723
- description: "Run on my machine",
724
- },
725
- port: {
726
- type: "number",
727
- default: 8788,
728
- description: "The port to listen on (serve from)",
729
- },
730
- proxy: {
731
- type: "number",
732
- description:
733
- "The port to proxy (where the static assets are served)",
734
- },
735
- "script-path": {
736
- type: "string",
737
- default: "_worker.js",
738
- description:
739
- "The location of the single Worker script if not using functions",
740
- },
741
- binding: {
742
- type: "array",
743
- description: "Bind variable/secret (KEY=VALUE)",
744
- alias: "b",
745
- },
746
- kv: {
747
- type: "array",
748
- description: "KV namespace to bind",
749
- alias: "k",
750
- },
751
- do: {
752
- type: "array",
753
- description: "Durable Object to bind (NAME=CLASS)",
754
- alias: "o",
755
- },
756
- "live-reload": {
757
- type: "boolean",
758
- default: false,
759
- description: "Auto reload HTML pages when change is detected",
760
- },
761
- // TODO: Miniflare user options
762
- });
763
- },
764
- async ({
765
- local,
766
- directory,
767
- port,
768
- proxy: requestedProxyPort,
769
- "script-path": singleWorkerScriptPath,
770
- binding: bindings = [],
771
- kv: kvs = [],
772
- do: durableObjects = [],
773
- "live-reload": liveReload,
774
- _: [_pages, _dev, ...remaining],
775
- }) => {
776
- if (!local) {
777
- console.error("Only local mode is supported at the moment.");
778
- return;
779
- }
780
-
781
- const functionsDirectory = "./functions";
782
- const usingFunctions = existsSync(functionsDirectory);
783
-
784
- const command = remaining as (string | number)[];
785
-
786
- let proxyPort: number | void;
787
-
788
- if (directory === undefined) {
789
- proxyPort = await spawnProxyProcess({
790
- port: requestedProxyPort,
791
- command,
792
- });
793
- if (proxyPort === undefined) return undefined;
794
- }
795
-
796
- let miniflareArgs: MiniflareOptions = {};
797
-
798
- let scriptReadyResolve: () => void;
799
- const scriptReadyPromise = new Promise<void>(
800
- (resolve) => (scriptReadyResolve = resolve)
801
- );
802
-
803
- if (usingFunctions) {
804
- const scriptPath = join(tmpdir(), "./functionsWorker.js");
805
-
806
- console.log(`Compiling worker to "${scriptPath}"...`);
807
-
808
- try {
809
- await buildFunctions({
810
- scriptPath,
811
- functionsDirectory,
812
- sourcemap: true,
813
- watch: true,
814
- onEnd: () => scriptReadyResolve(),
815
- });
816
- } catch {}
817
-
818
- watch([functionsDirectory], {
819
- persistent: true,
820
- ignoreInitial: true,
821
- }).on("all", async () => {
822
- await buildFunctions({
823
- scriptPath,
824
- functionsDirectory,
825
- sourcemap: true,
826
- watch: true,
827
- onEnd: () => scriptReadyResolve(),
828
- });
829
- });
830
-
831
- miniflareArgs = {
832
- scriptPath,
833
- };
834
- } else {
835
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
836
- scriptReadyResolve!();
837
-
838
- const scriptPath =
839
- directory !== undefined
840
- ? join(directory, singleWorkerScriptPath)
841
- : singleWorkerScriptPath;
842
-
843
- if (existsSync(scriptPath)) {
844
- miniflareArgs = {
845
- scriptPath,
846
- };
847
- } else {
848
- console.log("No functions. Shimming...");
849
- miniflareArgs = {
850
- // TODO: The fact that these request/response hacks are necessary is ridiculous.
851
- // We need to eliminate them from env.ASSETS.fetch (not sure if just local or prod as well)
852
- script: `
853
- export default {
854
- async fetch(request, env, context) {
855
- const response = await env.ASSETS.fetch(request.url, request)
856
- return new Response(response.body, response)
857
- }
858
- }`,
859
- };
860
- }
861
- }
862
-
863
- // Defer importing miniflare until we really need it
864
- const { Miniflare, Log, LogLevel } = await import("miniflare");
865
- const { Response, fetch } = await import("@miniflare/core");
866
-
867
- // Wait for esbuild to finish building before starting Miniflare.
868
- // This must be before the call to `new Miniflare`, as that will
869
- // asynchronously start loading the script. `await startServer()`
870
- // internally just waits for that promise to resolve.
871
- await scriptReadyPromise;
872
-
873
- // `assetsFetch()` will only be called if there is `proxyPort` defined.
874
- // We only define `proxyPort`, above, when there is no `directory` defined.
875
- const assetsFetch =
876
- directory !== undefined
877
- ? await generateAssetsFetch(directory)
878
- : invalidAssetsFetch;
879
-
880
- const miniflare = new Miniflare({
881
- port,
882
- watch: true,
883
- modules: true,
884
-
885
- log: new Log(LogLevel.ERROR, { prefix: "pages" }),
886
- logUnhandledRejections: true,
887
- sourceMap: true,
888
-
889
- kvNamespaces: kvs.map((kv) => kv.toString()),
890
-
891
- durableObjects: Object.fromEntries(
892
- durableObjects.map((durableObject) =>
893
- durableObject.toString().split("=")
894
- )
895
- ),
896
-
897
- // User bindings
898
- bindings: {
899
- ...Object.fromEntries(
900
- bindings.map((binding) => binding.toString().split("=", 1))
901
- ),
902
- },
903
-
904
- // env.ASSETS.fetch
905
- serviceBindings: {
906
- async ASSETS(request: Request) {
907
- if (proxyPort) {
908
- try {
909
- const url = new URL(request.url);
910
- url.host = `localhost:${proxyPort}`;
911
- return await fetch(url, request);
912
- } catch (thrown) {
913
- console.error(`Could not proxy request: ${thrown}`);
914
-
915
- // TODO: Pretty error page
916
- return new Response(
917
- `[wrangler] Could not proxy request: ${thrown}`,
918
- { status: 502 }
919
- );
920
- }
921
- } else {
922
- try {
923
- return await assetsFetch(request);
924
- } catch (thrown) {
925
- console.error(`Could not serve static asset: ${thrown}`);
926
-
927
- // TODO: Pretty error page
928
- return new Response(
929
- `[wrangler] Could not serve static asset: ${thrown}`,
930
- { status: 502 }
931
- );
932
- }
933
- }
934
- },
935
- },
936
-
937
- kvPersist: true,
938
- durableObjectsPersist: true,
939
- cachePersist: true,
940
- liveReload,
941
-
942
- ...miniflareArgs,
943
- });
944
-
945
- try {
946
- // `startServer` might throw if user code contains errors
947
- const server = await miniflare.startServer();
948
- console.log(`Serving at http://localhost:${port}/`);
949
-
950
- if (process.env.BROWSER !== "none") {
951
- await openInBrowser(`http://localhost:${port}/`);
952
- }
953
-
954
- if (directory !== undefined && liveReload) {
955
- watch([directory], {
956
- persistent: true,
957
- ignoreInitial: true,
958
- }).on("all", async () => {
959
- await miniflare.reload();
960
- });
961
- }
962
-
963
- EXIT_CALLBACKS.push(() => {
964
- server.close();
965
- miniflare.dispose().catch((err) => miniflare.log.error(err));
966
- });
967
- } catch (e) {
968
- miniflare.log.error(e as Error);
969
- EXIT("Could not start Miniflare.", 1);
970
- }
971
- }
972
- )
973
- .command("functions", false, (yargs) =>
974
- // we hide this command from help output because
975
- // it's not meant to be used directly right now
976
- yargs.command(
977
- "build [directory]",
978
- "Compile a folder of Cloudflare Pages Functions into a single Worker",
979
- (yargs) =>
980
- yargs
981
- .positional("directory", {
982
- type: "string",
983
- default: "functions",
984
- description: "The directory of Pages Functions",
985
- })
986
- .options({
987
- "script-path": {
988
- type: "string",
989
- default: "_worker.js",
990
- description: "The location of the output Worker script",
991
- },
992
- "output-config-path": {
993
- type: "string",
994
- description: "The location for the output config file",
995
- },
996
- minify: {
997
- type: "boolean",
998
- default: false,
999
- description: "Minify the output Worker script",
1000
- },
1001
- sourcemap: {
1002
- type: "boolean",
1003
- default: false,
1004
- description:
1005
- "Generate a sourcemap for the output Worker script",
1006
- },
1007
- "fallback-service": {
1008
- type: "string",
1009
- default: "ASSETS",
1010
- description:
1011
- "The service to fallback to at the end of the `next` chain. Setting to '' will fallback to the global `fetch`.",
1012
- },
1013
- watch: {
1014
- type: "boolean",
1015
- default: false,
1016
- description:
1017
- "Watch for changes to the functions and automatically rebuild the Worker script",
1018
- },
1019
- }),
1020
- async ({
1021
- directory,
1022
- "script-path": scriptPath,
1023
- "output-config-path": outputConfigPath,
1024
- minify,
1025
- sourcemap,
1026
- fallbackService,
1027
- watch,
1028
- }) => {
1029
- await buildFunctions({
1030
- scriptPath,
1031
- outputConfigPath,
1032
- functionsDirectory: directory,
1033
- minify,
1034
- sourcemap,
1035
- fallbackService,
1036
- watch,
1037
- });
1038
- }
1039
- )
1040
- );
1041
- };
1042
-
1043
- const invalidAssetsFetch: typeof fetch = () => {
1044
- throw new Error(
1045
- "Trying to fetch assets directly when there is no `directory` option specified, and not in `local` mode."
1046
- );
1047
- };