wrangler 0.0.0-fd3517a → 0.0.0-fd39ae64

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 (180) hide show
  1. package/Cloudflare_CA.pem +18 -0
  2. package/README.md +30 -10
  3. package/bin/wrangler.js +113 -39
  4. package/kv-asset-handler.js +1 -0
  5. package/package.json +130 -72
  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 +17 -0
  11. package/templates/gitignore +172 -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 +137 -0
  17. package/templates/middleware/loader-sw.ts +228 -0
  18. package/templates/middleware/middleware-d1-beta.d.ts +3 -0
  19. package/templates/middleware/middleware-miniflare3-json-error.ts +33 -0
  20. package/templates/middleware/middleware-multiworker-dev.d.ts +4 -0
  21. package/templates/middleware/middleware-multiworker-dev.ts +59 -0
  22. package/templates/middleware/middleware-pretty-error.ts +40 -0
  23. package/templates/middleware/middleware-scheduled.ts +15 -0
  24. package/templates/middleware/middleware-serve-static-assets.d.ts +6 -0
  25. package/templates/middleware/middleware-serve-static-assets.ts +56 -0
  26. package/templates/new-worker-scheduled.js +17 -0
  27. package/templates/new-worker-scheduled.ts +32 -0
  28. package/templates/new-worker.js +3 -3
  29. package/templates/new-worker.ts +22 -4
  30. package/templates/no-op-worker.js +10 -0
  31. package/templates/pages-dev-pipeline.ts +31 -0
  32. package/templates/pages-dev-util.ts +55 -0
  33. package/templates/pages-shim.ts +9 -0
  34. package/templates/pages-template-plugin.ts +190 -0
  35. package/templates/pages-template-worker.ts +198 -0
  36. package/templates/tsconfig-sanity.ts +11 -0
  37. package/templates/tsconfig.init.json +105 -0
  38. package/templates/tsconfig.json +6 -103
  39. package/wrangler-dist/cli.d.ts +1749 -0
  40. package/wrangler-dist/cli.js +141133 -135382
  41. package/wrangler-dist/wasm-sync.wasm +0 -0
  42. package/import_meta_url.js +0 -3
  43. package/miniflare-config-stubs/.env.empty +0 -0
  44. package/miniflare-config-stubs/package.empty.json +0 -1
  45. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  46. package/miniflare-dist/index.mjs +0 -79
  47. package/miniflare-dist/index.mjs.map +0 -7
  48. package/pages/functions/buildPlugin.ts +0 -55
  49. package/pages/functions/buildWorker.ts +0 -62
  50. package/pages/functions/filepath-routing.test.ts +0 -234
  51. package/pages/functions/filepath-routing.ts +0 -189
  52. package/pages/functions/identifiers.ts +0 -78
  53. package/pages/functions/routes.ts +0 -156
  54. package/pages/functions/template-plugin.ts +0 -146
  55. package/pages/functions/template-worker.ts +0 -143
  56. package/src/__tests__/config-cache.test.ts +0 -31
  57. package/src/__tests__/configuration.test.ts +0 -3102
  58. package/src/__tests__/dev.test.tsx +0 -631
  59. package/src/__tests__/guess-worker-format.test.ts +0 -85
  60. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  61. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  62. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  63. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  64. package/src/__tests__/helpers/mock-bin.ts +0 -36
  65. package/src/__tests__/helpers/mock-cfetch.ts +0 -211
  66. package/src/__tests__/helpers/mock-console.ts +0 -85
  67. package/src/__tests__/helpers/mock-dialogs.ts +0 -65
  68. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  69. package/src/__tests__/helpers/mock-istty.ts +0 -23
  70. package/src/__tests__/helpers/mock-kv.ts +0 -33
  71. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -231
  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 -39
  75. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  76. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  77. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  78. package/src/__tests__/https-options.test.ts +0 -129
  79. package/src/__tests__/index.test.ts +0 -239
  80. package/src/__tests__/init.test.ts +0 -833
  81. package/src/__tests__/jest.setup.ts +0 -73
  82. package/src/__tests__/kv.test.ts +0 -1418
  83. package/src/__tests__/logger.test.ts +0 -115
  84. package/src/__tests__/package-manager.test.ts +0 -206
  85. package/src/__tests__/pages.test.ts +0 -354
  86. package/src/__tests__/parse.test.ts +0 -322
  87. package/src/__tests__/publish.test.ts +0 -4677
  88. package/src/__tests__/r2.test.ts +0 -202
  89. package/src/__tests__/route.test.ts +0 -45
  90. package/src/__tests__/secret.test.ts +0 -437
  91. package/src/__tests__/sentry.test.ts +0 -146
  92. package/src/__tests__/tail.test.ts +0 -660
  93. package/src/__tests__/user.test.ts +0 -126
  94. package/src/__tests__/whoami.test.tsx +0 -97
  95. package/src/bundle.ts +0 -169
  96. package/src/cfetch/index.ts +0 -104
  97. package/src/cfetch/internal.ts +0 -139
  98. package/src/cli.ts +0 -21
  99. package/src/config/README.md +0 -107
  100. package/src/config/config.ts +0 -234
  101. package/src/config/diagnostics.ts +0 -80
  102. package/src/config/environment.ts +0 -394
  103. package/src/config/index.ts +0 -63
  104. package/src/config/validation-helpers.ts +0 -573
  105. package/src/config/validation.ts +0 -1423
  106. package/src/config-cache.ts +0 -43
  107. package/src/create-worker-preview.ts +0 -173
  108. package/src/create-worker-upload-form.ts +0 -240
  109. package/src/dev/dev.tsx +0 -420
  110. package/src/dev/local.tsx +0 -312
  111. package/src/dev/remote.tsx +0 -213
  112. package/src/dev/use-esbuild.ts +0 -118
  113. package/src/dialogs.tsx +0 -78
  114. package/src/entry.ts +0 -267
  115. package/src/environment-variables.ts +0 -35
  116. package/src/errors.ts +0 -11
  117. package/src/https-options.ts +0 -123
  118. package/src/index.tsx +0 -2455
  119. package/src/inspect.ts +0 -623
  120. package/src/intl-polyfill.d.ts +0 -139
  121. package/src/kv.ts +0 -319
  122. package/src/logger.ts +0 -56
  123. package/src/miniflare-cli/README.md +0 -30
  124. package/src/miniflare-cli/enum-keys.ts +0 -17
  125. package/src/miniflare-cli/index.ts +0 -41
  126. package/src/miniflare-cli/request-context.ts +0 -40
  127. package/src/module-collection.ts +0 -258
  128. package/src/open-in-browser.ts +0 -26
  129. package/src/package-manager.ts +0 -127
  130. package/src/pages.tsx +0 -1658
  131. package/src/parse.ts +0 -183
  132. package/src/paths.ts +0 -26
  133. package/src/proxy.ts +0 -456
  134. package/src/publish.ts +0 -469
  135. package/src/r2.ts +0 -50
  136. package/src/reporting.ts +0 -147
  137. package/src/selfsigned.d.ts +0 -29
  138. package/src/sites.tsx +0 -293
  139. package/src/tail/filters.ts +0 -279
  140. package/src/tail/index.ts +0 -299
  141. package/src/tail/printing.ts +0 -63
  142. package/src/update-check.ts +0 -19
  143. package/src/user.tsx +0 -1173
  144. package/src/whoami.tsx +0 -70
  145. package/src/worker.ts +0 -172
  146. package/templates/static-asset-facade.js +0 -47
  147. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  148. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  149. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  150. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  151. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  152. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  153. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  154. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  155. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  156. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  157. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  158. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  159. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  160. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  161. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  162. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  163. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  164. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  165. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  166. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  167. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  168. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  169. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  170. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  171. package/vendor/wrangler-mime/LICENSE +0 -21
  172. package/vendor/wrangler-mime/Mime.js +0 -97
  173. package/vendor/wrangler-mime/README.md +0 -187
  174. package/vendor/wrangler-mime/cli.js +0 -46
  175. package/vendor/wrangler-mime/index.js +0 -4
  176. package/vendor/wrangler-mime/lite.js +0 -4
  177. package/vendor/wrangler-mime/package.json +0 -52
  178. package/vendor/wrangler-mime/types/other.js +0 -1
  179. package/vendor/wrangler-mime/types/standard.js +0 -1
  180. package/wrangler-dist/cli.js.map +0 -7
package/src/parse.ts DELETED
@@ -1,183 +0,0 @@
1
- import * as fs from "node:fs";
2
- import { resolve } from "node:path";
3
- import TOML from "@iarna/toml";
4
- import { formatMessagesSync } from "esbuild";
5
-
6
- export type Message = {
7
- text: string;
8
- location?: Location;
9
- notes?: Message[];
10
- kind?: "warning" | "error";
11
- };
12
-
13
- export type Location = File & {
14
- line: number;
15
- column: number;
16
- length?: number;
17
- lineText?: string;
18
- suggestion?: string;
19
- };
20
-
21
- export type File = {
22
- file?: string;
23
- fileText?: string;
24
- };
25
-
26
- /**
27
- * Formats a `Message` using esbuild's pretty-printing algorithm.
28
- */
29
- export function formatMessage(
30
- { text, notes, location, kind = "error" }: Message,
31
- color = true
32
- ): string {
33
- const input = { text, notes, location };
34
- delete input.location?.fileText;
35
- for (const note of notes ?? []) {
36
- delete note.location?.fileText;
37
- }
38
- const lines = formatMessagesSync([input], {
39
- color,
40
- kind: kind,
41
- terminalWidth: process.stderr.columns,
42
- });
43
- return lines.join("\n");
44
- }
45
-
46
- /**
47
- * An error that's thrown when something fails to parse.
48
- */
49
- export class ParseError extends Error implements Message {
50
- readonly text: string;
51
- readonly notes: Message[];
52
- readonly location?: Location;
53
- readonly kind: "warning" | "error";
54
-
55
- constructor({ text, notes, location, kind }: Message) {
56
- super(text);
57
- this.name = this.constructor.name;
58
- this.text = text;
59
- this.notes = notes ?? [];
60
- this.location = location;
61
- this.kind = kind ?? "error";
62
- }
63
- }
64
-
65
- /* eslint-disable @typescript-eslint/no-explicit-any */
66
-
67
- const TOML_ERROR_NAME = "TomlError";
68
- const TOML_ERROR_SUFFIX = " at row ";
69
-
70
- type TomlError = Error & {
71
- line: number;
72
- col: number;
73
- };
74
-
75
- /**
76
- * A wrapper around `TOML.parse` that throws a `ParseError`.
77
- */
78
- export function parseTOML(input: string, file?: string): TOML.JsonMap | never {
79
- try {
80
- return TOML.parse(input);
81
- } catch (err) {
82
- const { name, message, line, col } = err as TomlError;
83
- if (name !== TOML_ERROR_NAME) {
84
- throw err;
85
- }
86
- const text = message.substring(0, message.lastIndexOf(TOML_ERROR_SUFFIX));
87
- const lineText = input.split("\n")[line];
88
- const location = {
89
- lineText,
90
- line: line + 1,
91
- column: col - 1,
92
- file,
93
- fileText: input,
94
- };
95
- throw new ParseError({ text, location });
96
- }
97
- }
98
-
99
- const JSON_ERROR_SUFFIX = " in JSON at position ";
100
-
101
- /**
102
- * A wrapper around `JSON.parse` that throws a `ParseError`.
103
- */
104
- export function parseJSON(input: string, file?: string): any {
105
- try {
106
- return JSON.parse(input);
107
- } catch (err) {
108
- const { message } = err as Error;
109
- const index = message.lastIndexOf(JSON_ERROR_SUFFIX);
110
- if (index < 0) {
111
- throw err;
112
- }
113
- const text = message.substring(0, index);
114
- const position = parseInt(
115
- message.substring(index + JSON_ERROR_SUFFIX.length)
116
- );
117
- const location = indexLocation({ file, fileText: input }, position);
118
- throw new ParseError({ text, location });
119
- }
120
- }
121
-
122
- /**
123
- * Reads a file and parses it based on its type.
124
- */
125
- export function readFileSync(file: string): string {
126
- try {
127
- return fs.readFileSync(file, { encoding: "utf-8" });
128
- } catch (err) {
129
- const { message } = err as Error;
130
- throw new ParseError({
131
- text: `Could not read file: ${file}`,
132
- notes: [
133
- {
134
- text: message.replace(file, resolve(file)),
135
- },
136
- ],
137
- });
138
- }
139
- }
140
-
141
- /**
142
- * Calculates the line and column location from an index.
143
- */
144
- export function indexLocation(file: File, index: number): Location {
145
- let lineText,
146
- line = 0,
147
- column = 0,
148
- cursor = 0;
149
- const { fileText = "" } = file;
150
- for (const row of fileText.split("\n")) {
151
- line++;
152
- cursor += row.length + 1;
153
- if (cursor >= index) {
154
- lineText = row;
155
- column = row.length - (cursor - index);
156
- break;
157
- }
158
- }
159
- return { lineText, line, column, ...file };
160
- }
161
-
162
- /**
163
- * Guesses the line and column location of a search query.
164
- */
165
- export function searchLocation(file: File, query: unknown): Location {
166
- let lineText,
167
- length,
168
- line = 0,
169
- column = 0;
170
- const queryText = String(query);
171
- const { fileText = "" } = file;
172
- for (const content of fileText.split("\n")) {
173
- line++;
174
- const index = content.indexOf(queryText);
175
- if (index >= 0) {
176
- lineText = content;
177
- column = index;
178
- length = queryText.length;
179
- break;
180
- }
181
- }
182
- return { lineText, line, column, length, ...file };
183
- }
package/src/paths.ts DELETED
@@ -1,26 +0,0 @@
1
- import { assert } from "console";
2
-
3
- type DiscriminatedPath<Discriminator extends string> = string & {
4
- _discriminator: Discriminator;
5
- };
6
-
7
- /**
8
- * A branded string that expects to be URL compatible.
9
- *
10
- * Require this type when you want callers to ensure that they have converted file-path strings into URL-safe paths.
11
- */
12
- export type UrlPath = DiscriminatedPath<"UrlPath">;
13
-
14
- /**
15
- * Convert a file-path string to a URL-path string.
16
- *
17
- * Use this helper to convert a `string` to a `UrlPath` when it is not clear whether the string needs normalizing.
18
- * Replaces all back-slashes with forward-slashes, and throws an error if the path contains a drive letter (e.g. `C:`).
19
- */
20
- export function toUrlPath(path: string): UrlPath {
21
- assert(
22
- !/^[a-z]:/i.test(path),
23
- "Tried to convert a Windows file path with a drive to a URL path."
24
- );
25
- return path.replace(/\\/g, "/") as UrlPath;
26
- }
package/src/proxy.ts DELETED
@@ -1,456 +0,0 @@
1
- import { createServer as createHttpServer } from "node:http";
2
- import { connect } from "node:http2";
3
- import { createServer as createHttpsServer } from "node:https";
4
- import WebSocket from "faye-websocket";
5
- import { useEffect, useRef, useState } from "react";
6
- import serveStatic from "serve-static";
7
- import { getHttpsOptions } from "./https-options";
8
- import { logger } from "./logger";
9
- import { reportError } from "./reporting";
10
- import type { CfPreviewToken } from "./create-worker-preview";
11
- import type {
12
- IncomingHttpHeaders,
13
- RequestListener,
14
- IncomingMessage,
15
- ServerResponse,
16
- Server as HttpServer,
17
- } from "node:http";
18
- import type { ClientHttp2Session, ServerHttp2Stream } from "node:http2";
19
- import type { Server as HttpsServer } from "node:https";
20
- import type ws from "ws";
21
-
22
- interface IWebsocket extends ws {
23
- // Pipe implements .on("message", ...)
24
- pipe<T>(fn: T): IWebsocket;
25
- }
26
-
27
- /**
28
- * `usePreviewServer` is a React hook that creates a local development
29
- * server that can be used to develop a Worker.
30
- *
31
- * When we run `wrangler dev`, we start by uploading the compiled worker
32
- * to the preview service, which responds with a preview token.
33
- * (see `useWorker`/`createWorker` for details.)
34
- * We can then use that token to connect to the preview server for a
35
- * great local development experience. Further, as we change the worker,
36
- * we can update the preview token transparently without having to restart
37
- * the development server.
38
- */
39
-
40
- /** Rewrite request headers to add the preview token. */
41
- function addCfPreviewTokenHeader(
42
- headers: IncomingHttpHeaders,
43
- previewTokenValue: string
44
- ) {
45
- headers["cf-workers-preview-token"] = previewTokenValue;
46
- }
47
-
48
- /**
49
- * Rewrite references in request headers
50
- * from the preview host to the local host.
51
- */
52
- function rewriteRemoteHostToLocalHostInHeaders(
53
- headers: IncomingHttpHeaders,
54
- remoteHost: string,
55
- localPort: number,
56
- localProtocol: "https" | "http"
57
- ) {
58
- for (const [name, value] of Object.entries(headers)) {
59
- // Rewrite the remote host to the local host.
60
- if (typeof value === "string" && value.includes(remoteHost)) {
61
- headers[name] = value
62
- .replaceAll(
63
- `https://${remoteHost}`,
64
- `${localProtocol}://localhost:${localPort}`
65
- )
66
- .replaceAll(remoteHost, `localhost:${localPort}`);
67
- }
68
- }
69
- }
70
-
71
- export function usePreviewServer({
72
- previewToken,
73
- publicRoot,
74
- localProtocol,
75
- localPort: port,
76
- ip,
77
- }: {
78
- previewToken: CfPreviewToken | undefined;
79
- publicRoot: string | undefined;
80
- localProtocol: "https" | "http";
81
- localPort: number;
82
- ip: string;
83
- }) {
84
- /** Creates an HTTP/1 proxy that sends requests over HTTP/2. */
85
- const [proxyServer, setProxyServer] = useState<HttpServer | HttpsServer>();
86
-
87
- /**
88
- * Create the instance of the local proxy server that will pass on
89
- * requests to the preview worker.
90
- */
91
- useEffect(() => {
92
- if (proxyServer === undefined) {
93
- createProxyServer(localProtocol)
94
- .then((proxy) => setProxyServer(proxy))
95
- .catch(async (err) => {
96
- logger.error("Failed to create proxy server:", err);
97
- await reportError(err);
98
- });
99
- }
100
- }, [proxyServer, localProtocol]);
101
-
102
- /**
103
- * When we're not connected / getting a fresh token on changes,
104
- * we'd like to buffer streams/requests until we're connected.
105
- * Once connected, we can flush the buffered streams/requests.
106
- * streamBufferRef is used to buffer http/2 streams, while
107
- * requestResponseBufferRef is used to buffer http/1 requests.
108
- */
109
- const streamBufferRef = useRef<
110
- { stream: ServerHttp2Stream; headers: IncomingHttpHeaders }[]
111
- >([]);
112
- const requestResponseBufferRef = useRef<
113
- { request: IncomingMessage; response: ServerResponse }[]
114
- >([]);
115
-
116
- /**
117
- * The session doesn't last forever, and will eventually drop
118
- * (usually within 5-15 minutes). When that happens, we simply
119
- * restart the effect, effectively restarting the server. We use
120
- * a state sigil as an effect dependency to do so.
121
- */
122
- const [retryServerSetupSigil, setRetryServerSetupSigil] = useState<number>(0);
123
- function retryServerSetup() {
124
- setRetryServerSetupSigil((x) => x + 1);
125
- }
126
-
127
- useEffect(() => {
128
- if (proxyServer === undefined) {
129
- return;
130
- }
131
-
132
- // If we don't have a token, that means either we're just starting up,
133
- // or we're refreshing the token.
134
- if (!previewToken) {
135
- const cleanupListeners: (() => void)[] = [];
136
- const bufferStream = (
137
- stream: ServerHttp2Stream,
138
- headers: IncomingHttpHeaders
139
- ) => {
140
- // store the stream in a buffer so we can replay it later
141
- streamBufferRef.current.push({ stream, headers });
142
- };
143
- proxyServer.on("stream", bufferStream);
144
- cleanupListeners.push(() => proxyServer.off("stream", bufferStream));
145
-
146
- const bufferRequestResponse = (
147
- request: IncomingMessage,
148
- response: ServerResponse
149
- ) => {
150
- // store the request and response in a buffer so we can replay it later
151
- requestResponseBufferRef.current.push({ request, response });
152
- };
153
-
154
- proxyServer.on("request", bufferRequestResponse);
155
- cleanupListeners.push(() =>
156
- proxyServer.off("request", bufferRequestResponse)
157
- );
158
- return () => {
159
- cleanupListeners.forEach((cleanup) => cleanup());
160
- };
161
- }
162
-
163
- // We have a token. Let's proxy requests to the preview end point.
164
- const cleanupListeners: (() => void)[] = [];
165
-
166
- const assetPath = typeof publicRoot === "string" ? publicRoot : null;
167
-
168
- // create a ClientHttp2Session
169
- const remote = connect(`https://${previewToken.host}`);
170
- cleanupListeners.push(() => remote.destroy());
171
-
172
- // As mentioned above, the session may die at any point,
173
- // so we need to restart the effect.
174
- remote.on("close", retryServerSetup);
175
- cleanupListeners.push(() => remote.off("close", retryServerSetup));
176
-
177
- /** HTTP/2 -> HTTP/2 */
178
- const handleStream = createStreamHandler(
179
- previewToken,
180
- remote,
181
- port,
182
- localProtocol
183
- );
184
- proxyServer.on("stream", handleStream);
185
- cleanupListeners.push(() => proxyServer.off("stream", handleStream));
186
-
187
- // flush and replay buffered streams
188
- streamBufferRef.current.forEach((buffer) =>
189
- handleStream(buffer.stream, buffer.headers)
190
- );
191
- streamBufferRef.current = [];
192
-
193
- /** HTTP/1 -> HTTP/2 */
194
- const handleRequest: RequestListener = (
195
- message: IncomingMessage,
196
- response: ServerResponse
197
- ) => {
198
- const { httpVersionMajor, headers, method, url } = message;
199
- if (httpVersionMajor >= 2) {
200
- return; // Already handled by the "stream" event.
201
- }
202
- addCfPreviewTokenHeader(headers, previewToken.value);
203
- headers[":method"] = method;
204
- headers[":path"] = url;
205
- headers[":authority"] = previewToken.host;
206
- headers[":scheme"] = "https";
207
- for (const name of Object.keys(headers)) {
208
- if (HTTP1_HEADERS.has(name.toLowerCase())) {
209
- delete headers[name];
210
- }
211
- }
212
- const request = message.pipe(remote.request(headers));
213
- request.on("response", (responseHeaders) => {
214
- const status = responseHeaders[":status"] ?? 500;
215
- rewriteRemoteHostToLocalHostInHeaders(
216
- responseHeaders,
217
- previewToken.host,
218
- port,
219
- localProtocol
220
- );
221
- for (const name of Object.keys(responseHeaders)) {
222
- if (name.startsWith(":")) {
223
- delete responseHeaders[name];
224
- }
225
- }
226
- response.writeHead(status, responseHeaders);
227
- request.pipe(response, { end: true });
228
- });
229
- };
230
-
231
- // If an asset path is defined, check the file system
232
- // for a file first and serve if it exists.
233
- const actualHandleRequest = assetPath
234
- ? createHandleAssetsRequest(assetPath, handleRequest)
235
- : handleRequest;
236
-
237
- proxyServer.on("request", actualHandleRequest);
238
- cleanupListeners.push(() =>
239
- proxyServer.off("request", actualHandleRequest)
240
- );
241
-
242
- // flush and replay buffered requests
243
- requestResponseBufferRef.current.forEach(({ request, response }) =>
244
- actualHandleRequest(request, response)
245
- );
246
- requestResponseBufferRef.current = [];
247
-
248
- /** HTTP/1 -> WebSocket (over HTTP/1) */
249
- const handleUpgrade = (
250
- message: IncomingMessage,
251
- socket: WebSocket,
252
- body: Buffer
253
- ) => {
254
- const { headers, url } = message;
255
- addCfPreviewTokenHeader(headers, previewToken.value);
256
- headers["host"] = previewToken.host;
257
- const localWebsocket = new WebSocket(message, socket, body) as IWebsocket;
258
- // TODO(soon): Custom WebSocket protocol is not working?
259
- const remoteWebsocketClient = new WebSocket.Client(
260
- `wss://${previewToken.host}${url}`,
261
- [],
262
- { headers }
263
- ) as IWebsocket;
264
- localWebsocket.pipe(remoteWebsocketClient).pipe(localWebsocket);
265
- // We close down websockets whenever we refresh the token.
266
- cleanupListeners.push(() => {
267
- localWebsocket.close();
268
- remoteWebsocketClient.close();
269
- });
270
- };
271
- proxyServer.on("upgrade", handleUpgrade);
272
- cleanupListeners.push(() => proxyServer.off("upgrade", handleUpgrade));
273
-
274
- return () => {
275
- cleanupListeners.forEach((cleanup) => cleanup());
276
- };
277
- }, [
278
- previewToken,
279
- publicRoot,
280
- port,
281
- localProtocol,
282
- proxyServer,
283
- // We use a state value as a sigil to trigger reconnecting the server.
284
- // It's not used inside the effect, so react-hooks/exhaustive-deps
285
- // doesn't complain if it's not included in the dependency array.
286
- // But its presence is critical, so Do NOT remove it from the dependency list.
287
- retryServerSetupSigil,
288
- ]);
289
-
290
- // Start/stop the server whenever the
291
- // containing component is mounted/unmounted.
292
- useEffect(() => {
293
- const abortController = new AbortController();
294
- if (proxyServer === undefined) {
295
- return;
296
- }
297
-
298
- waitForPortToBeAvailable(port, {
299
- retryPeriod: 200,
300
- timeout: 2000,
301
- abortSignal: abortController.signal,
302
- })
303
- .then(() => {
304
- proxyServer.listen(port, ip);
305
- logger.log(`⬣ Listening at ${localProtocol}://${ip}:${port}`);
306
- })
307
- .catch((err) => {
308
- if ((err as { code: string }).code !== "ABORT_ERR") {
309
- logger.error(`Failed to start server: ${err}`);
310
- }
311
- });
312
-
313
- return () => {
314
- proxyServer.close();
315
- abortController.abort();
316
- };
317
- }, [port, ip, proxyServer, localProtocol]);
318
- }
319
-
320
- function createHandleAssetsRequest(
321
- assetPath: string,
322
- handleRequest: RequestListener
323
- ) {
324
- const handleAsset = serveStatic(assetPath, {
325
- cacheControl: false,
326
- });
327
- return (request: IncomingMessage, response: ServerResponse) => {
328
- handleAsset(request, response, () => {
329
- handleRequest(request, response);
330
- });
331
- };
332
- }
333
-
334
- /** A Set of headers we want to remove from HTTP/1 requests. */
335
- const HTTP1_HEADERS = new Set([
336
- "host",
337
- "connection",
338
- "upgrade",
339
- "keep-alive",
340
- "proxy-connection",
341
- "transfer-encoding",
342
- "http2-settings",
343
- ]);
344
-
345
- async function createProxyServer(
346
- localProtocol: "https" | "http"
347
- ): Promise<HttpServer | HttpsServer> {
348
- const server: HttpServer | HttpsServer =
349
- localProtocol === "https"
350
- ? createHttpsServer(await getHttpsOptions())
351
- : createHttpServer();
352
-
353
- return server
354
- .on("request", function (req, res) {
355
- // log all requests
356
- logger.log(
357
- new Date().toLocaleTimeString(),
358
- req.method,
359
- req.url,
360
- res.statusCode
361
- );
362
- })
363
- .on("upgrade", (req) => {
364
- // log all websocket connections
365
- logger.log(
366
- new Date().toLocaleTimeString(),
367
- req.method,
368
- req.url,
369
- 101,
370
- "(WebSocket)"
371
- );
372
- })
373
- .on("error", (err) => {
374
- // log all connection errors
375
- logger.error(new Date().toLocaleTimeString(), err);
376
- });
377
- }
378
-
379
- function createStreamHandler(
380
- previewToken: CfPreviewToken,
381
- remote: ClientHttp2Session,
382
- localPort: number,
383
- localProtocol: "https" | "http"
384
- ) {
385
- return function handleStream(
386
- stream: ServerHttp2Stream,
387
- headers: IncomingHttpHeaders
388
- ) {
389
- addCfPreviewTokenHeader(headers, previewToken.value);
390
- headers[":authority"] = previewToken.host;
391
- const request = stream.pipe(remote.request(headers));
392
- request.on("response", (responseHeaders: IncomingHttpHeaders) => {
393
- rewriteRemoteHostToLocalHostInHeaders(
394
- responseHeaders,
395
- previewToken.host,
396
- localPort,
397
- localProtocol
398
- );
399
- stream.respond(responseHeaders);
400
- request.pipe(stream, { end: true });
401
- });
402
- };
403
- }
404
-
405
- /**
406
- * A helper function that waits for a port to be available.
407
- */
408
- export async function waitForPortToBeAvailable(
409
- port: number,
410
- options: { retryPeriod: number; timeout: number; abortSignal: AbortSignal }
411
- ): Promise<void> {
412
- return new Promise((resolve, reject) => {
413
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
414
- (options.abortSignal as any).addEventListener("abort", () => {
415
- const abortError = new Error("waitForPortToBeAvailable() aborted");
416
- (abortError as Error & { code: string }).code = "ABORT_ERR";
417
- doReject(abortError);
418
- });
419
-
420
- const timeout = setTimeout(() => {
421
- doReject(new Error(`Timed out waiting for port ${port}`));
422
- }, options.timeout);
423
-
424
- const interval = setInterval(checkPort, options.retryPeriod);
425
- checkPort();
426
-
427
- function doResolve() {
428
- clearTimeout(timeout);
429
- clearInterval(interval);
430
- resolve();
431
- }
432
-
433
- function doReject(err: unknown) {
434
- clearInterval(interval);
435
- clearTimeout(timeout);
436
- reject(err);
437
- }
438
-
439
- function checkPort() {
440
- // Testing whether a port is 'available' involves simply
441
- // trying to make a server listen on that port, and retrying
442
- // until it succeeds.
443
- const server = createHttpServer();
444
- server.on("error", (err) => {
445
- // @ts-expect-error non standard property on Error
446
- if (err.code !== "EADDRINUSE") {
447
- doReject(err);
448
- }
449
- });
450
- server.listen(port, () => {
451
- server.close();
452
- doResolve();
453
- });
454
- }
455
- });
456
- }