wrangler 0.0.0-e8e684c7 → 0.0.0-e9106dfa5

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 (207) hide show
  1. package/README.md +35 -49
  2. package/bin/wrangler.js +25 -100
  3. package/config-schema.json +2277 -0
  4. package/package.json +182 -174
  5. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  6. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  7. package/templates/__tests__/tsconfig.json +8 -0
  8. package/templates/checked-fetch.js +19 -6
  9. package/templates/facade.d.ts +19 -0
  10. package/templates/gitignore +2 -3
  11. package/templates/init-tests/test-jest-new-worker.js +23 -0
  12. package/templates/init-tests/test-vitest-new-worker.js +24 -0
  13. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  14. package/templates/middleware/common.ts +67 -0
  15. package/templates/middleware/loader-modules.ts +134 -0
  16. package/templates/middleware/loader-sw.ts +229 -0
  17. package/templates/middleware/middleware-ensure-req-body-drained.ts +18 -0
  18. package/templates/middleware/middleware-miniflare3-json-error.ts +32 -0
  19. package/templates/middleware/middleware-mock-analytics-engine.d.ts +3 -0
  20. package/templates/middleware/middleware-mock-analytics-engine.ts +30 -0
  21. package/templates/middleware/middleware-patch-console-prefix.d.ts +3 -0
  22. package/templates/middleware/middleware-patch-console-prefix.ts +21 -0
  23. package/templates/middleware/middleware-pretty-error.ts +40 -0
  24. package/templates/middleware/middleware-scheduled.ts +29 -0
  25. package/templates/modules-watch-stub.js +4 -0
  26. package/templates/new-worker-scheduled.ts +1 -1
  27. package/templates/new-worker.js +1 -1
  28. package/templates/new-worker.ts +4 -1
  29. package/templates/pages-dev-pipeline.ts +33 -0
  30. package/templates/pages-dev-util.ts +55 -0
  31. package/templates/pages-shim.ts +1 -1
  32. package/templates/pages-template-plugin.ts +37 -14
  33. package/templates/pages-template-worker.ts +33 -7
  34. package/templates/startDevWorker/InspectorProxyWorker.ts +679 -0
  35. package/templates/startDevWorker/ProxyWorker.ts +336 -0
  36. package/templates/tsconfig-sanity.ts +11 -0
  37. package/templates/tsconfig.init.json +22 -0
  38. package/templates/tsconfig.json +12 -102
  39. package/templates/tsconfig.tsbuildinfo +1 -0
  40. package/wrangler-dist/InspectorProxyWorker.js +471 -0
  41. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  42. package/wrangler-dist/ProxyWorker.js +238 -0
  43. package/wrangler-dist/ProxyWorker.js.map +6 -0
  44. package/wrangler-dist/cli.d.ts +26527 -172
  45. package/wrangler-dist/cli.js +148646 -148093
  46. package/Cloudflare_CA.pem +0 -18
  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 -5542
  52. package/src/__tests__/config-cache-without-cache-dir.test.ts +0 -38
  53. package/src/__tests__/config-cache.test.ts +0 -42
  54. package/src/__tests__/configuration.test.ts +0 -4026
  55. package/src/__tests__/dev.test.tsx +0 -1318
  56. package/src/__tests__/generate.test.ts +0 -91
  57. package/src/__tests__/guess-worker-format.test.ts +0 -85
  58. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  59. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  60. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  61. package/src/__tests__/helpers/mock-bin.ts +0 -36
  62. package/src/__tests__/helpers/mock-cfetch.ts +0 -296
  63. package/src/__tests__/helpers/mock-console.ts +0 -97
  64. package/src/__tests__/helpers/mock-dialogs.ts +0 -153
  65. package/src/__tests__/helpers/mock-get-zone-from-host.ts +0 -8
  66. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  67. package/src/__tests__/helpers/mock-istty.ts +0 -74
  68. package/src/__tests__/helpers/mock-known-routes.ts +0 -7
  69. package/src/__tests__/helpers/mock-kv.ts +0 -33
  70. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -250
  71. package/src/__tests__/helpers/mock-process.ts +0 -39
  72. package/src/__tests__/helpers/mock-stdin.ts +0 -108
  73. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  74. package/src/__tests__/helpers/run-in-tmp.ts +0 -38
  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 -163
  79. package/src/__tests__/index.test.ts +0 -245
  80. package/src/__tests__/init.test.ts +0 -2170
  81. package/src/__tests__/jest.setup.ts +0 -157
  82. package/src/__tests__/kv.test.ts +0 -1671
  83. package/src/__tests__/logger.test.ts +0 -141
  84. package/src/__tests__/metrics.test.ts +0 -450
  85. package/src/__tests__/package-manager.test.ts +0 -353
  86. package/src/__tests__/pages.test.ts +0 -1275
  87. package/src/__tests__/parse.test.ts +0 -330
  88. package/src/__tests__/publish.test.ts +0 -6955
  89. package/src/__tests__/pubsub.test.ts +0 -367
  90. package/src/__tests__/r2.test.ts +0 -336
  91. package/src/__tests__/route.test.ts +0 -45
  92. package/src/__tests__/secret.test.ts +0 -492
  93. package/src/__tests__/tail.test.ts +0 -802
  94. package/src/__tests__/test-old-node-version.js +0 -31
  95. package/src/__tests__/user.test.ts +0 -155
  96. package/src/__tests__/validate-dev-props.test.ts +0 -56
  97. package/src/__tests__/version.test.ts +0 -35
  98. package/src/__tests__/whoami.test.tsx +0 -289
  99. package/src/__tests__/worker-namespace.test.ts +0 -329
  100. package/src/abort.d.ts +0 -3
  101. package/src/api/dev.ts +0 -93
  102. package/src/api/index.ts +0 -1
  103. package/src/bundle-reporter.tsx +0 -29
  104. package/src/bundle.ts +0 -473
  105. package/src/cfetch/index.ts +0 -121
  106. package/src/cfetch/internal.ts +0 -298
  107. package/src/cli.ts +0 -27
  108. package/src/config/README.md +0 -107
  109. package/src/config/config.ts +0 -263
  110. package/src/config/diagnostics.ts +0 -80
  111. package/src/config/environment.ts +0 -485
  112. package/src/config/index.ts +0 -251
  113. package/src/config/validation-helpers.ts +0 -597
  114. package/src/config/validation.ts +0 -1862
  115. package/src/config-cache.ts +0 -85
  116. package/src/create-worker-preview.ts +0 -257
  117. package/src/create-worker-upload-form.ts +0 -291
  118. package/src/dev/dev-vars.ts +0 -36
  119. package/src/dev/dev.tsx +0 -545
  120. package/src/dev/local.tsx +0 -449
  121. package/src/dev/remote.tsx +0 -422
  122. package/src/dev/use-esbuild.ts +0 -178
  123. package/src/dev/validate-dev-props.ts +0 -31
  124. package/src/dev-registry.tsx +0 -160
  125. package/src/dev.tsx +0 -696
  126. package/src/dialogs.tsx +0 -135
  127. package/src/dispatch-namespace.ts +0 -206
  128. package/src/durable.ts +0 -102
  129. package/src/entry.ts +0 -328
  130. package/src/environment-variables.ts +0 -35
  131. package/src/errors.ts +0 -11
  132. package/src/faye-websocket.d.ts +0 -6
  133. package/src/generate.ts +0 -131
  134. package/src/git-client.ts +0 -42
  135. package/src/global-wrangler-config-path.ts +0 -26
  136. package/src/https-options.ts +0 -127
  137. package/src/index.tsx +0 -2260
  138. package/src/init.ts +0 -622
  139. package/src/inspect.ts +0 -747
  140. package/src/intl-polyfill.d.ts +0 -139
  141. package/src/is-ci.ts +0 -14
  142. package/src/is-interactive.ts +0 -12
  143. package/src/kv.ts +0 -430
  144. package/src/logger.ts +0 -73
  145. package/src/metrics/index.ts +0 -5
  146. package/src/metrics/metrics-config.ts +0 -239
  147. package/src/metrics/metrics-dispatcher.ts +0 -96
  148. package/src/metrics/metrics-usage-headers.ts +0 -24
  149. package/src/metrics/send-event.ts +0 -92
  150. package/src/miniflare-cli/README.md +0 -30
  151. package/src/miniflare-cli/assets.ts +0 -554
  152. package/src/miniflare-cli/enum-keys.ts +0 -17
  153. package/src/miniflare-cli/index.ts +0 -207
  154. package/src/miniflare-cli/request-context.ts +0 -40
  155. package/src/module-collection.ts +0 -258
  156. package/src/open-in-browser.ts +0 -17
  157. package/src/package-manager.ts +0 -219
  158. package/src/pages/build.tsx +0 -238
  159. package/src/pages/constants.ts +0 -12
  160. package/src/pages/deployments.tsx +0 -106
  161. package/src/pages/dev.tsx +0 -528
  162. package/src/pages/errors.ts +0 -22
  163. package/src/pages/functions/buildPlugin.ts +0 -109
  164. package/src/pages/functions/buildWorker.ts +0 -155
  165. package/src/pages/functions/filepath-routing.test.ts +0 -234
  166. package/src/pages/functions/filepath-routing.ts +0 -189
  167. package/src/pages/functions/identifiers.ts +0 -78
  168. package/src/pages/functions/routes-consolidation.test.ts +0 -250
  169. package/src/pages/functions/routes-consolidation.ts +0 -73
  170. package/src/pages/functions/routes-transformation.test.ts +0 -271
  171. package/src/pages/functions/routes-transformation.ts +0 -122
  172. package/src/pages/functions/routes.ts +0 -151
  173. package/src/pages/functions.tsx +0 -96
  174. package/src/pages/index.tsx +0 -94
  175. package/src/pages/projects.tsx +0 -169
  176. package/src/pages/publish.tsx +0 -391
  177. package/src/pages/types.ts +0 -49
  178. package/src/pages/upload.tsx +0 -413
  179. package/src/pages/utils.ts +0 -12
  180. package/src/parse.ts +0 -286
  181. package/src/paths.ts +0 -26
  182. package/src/preview.ts +0 -31
  183. package/src/proxy.ts +0 -486
  184. package/src/publish.ts +0 -822
  185. package/src/pubsub/index.ts +0 -286
  186. package/src/pubsub/pubsub-commands.tsx +0 -623
  187. package/src/r2.ts +0 -131
  188. package/src/selfsigned.d.ts +0 -29
  189. package/src/sites.tsx +0 -372
  190. package/src/tail/filters.ts +0 -281
  191. package/src/tail/index.ts +0 -312
  192. package/src/tail/printing.ts +0 -107
  193. package/src/update-check.ts +0 -19
  194. package/src/user/choose-account.tsx +0 -69
  195. package/src/user/env-vars.ts +0 -46
  196. package/src/user/generate-auth-url.ts +0 -33
  197. package/src/user/generate-random-state.ts +0 -16
  198. package/src/user/index.ts +0 -3
  199. package/src/user/user.tsx +0 -1191
  200. package/src/whoami.tsx +0 -169
  201. package/src/worker.ts +0 -204
  202. package/src/zones.ts +0 -167
  203. package/templates/first-party-worker-module-facade.ts +0 -18
  204. package/templates/format-dev-errors.ts +0 -32
  205. package/templates/serve-static-assets.ts +0 -63
  206. package/templates/service-bindings-module-facade.js +0 -54
  207. package/templates/service-bindings-sw-facade.js +0 -42
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/preview.ts DELETED
@@ -1,31 +0,0 @@
1
- import { DeprecationError } from "./errors";
2
- import type { Argv } from "yargs";
3
-
4
- export function previewOptions(yargs: Argv) {
5
- return yargs
6
- .positional("method", {
7
- type: "string",
8
- describe: "Type of request to preview your worker",
9
- })
10
- .positional("body", {
11
- type: "string",
12
- describe: "Body string to post to your preview worker request.",
13
- })
14
- .option("env", {
15
- type: "string",
16
- requiresArg: true,
17
- describe: "Perform on a specific environment",
18
- })
19
- .option("watch", {
20
- default: true,
21
- describe: "Enable live preview",
22
- type: "boolean",
23
- });
24
- }
25
-
26
- export function previewHandler() {
27
- throw new DeprecationError(
28
- "The `wrangler preview` command has been deprecated.\n" +
29
- "Try using `wrangler dev` to to try out a worker during development.\n"
30
- );
31
- }
package/src/proxy.ts DELETED
@@ -1,486 +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 { createHttpTerminator } from "http-terminator";
6
- import { useEffect, useRef, useState } from "react";
7
- import serveStatic from "serve-static";
8
- import { getHttpsOptions } from "./https-options";
9
- import { logger } from "./logger";
10
- import type { CfPreviewToken } from "./create-worker-preview";
11
- import type { HttpTerminator } from "http-terminator";
12
- import type {
13
- IncomingHttpHeaders,
14
- RequestListener,
15
- IncomingMessage,
16
- ServerResponse,
17
- Server as HttpServer,
18
- } from "node:http";
19
- import type { ClientHttp2Session, ServerHttp2Stream } from "node:http2";
20
- import type { Server as HttpsServer } from "node:https";
21
- import type ws from "ws";
22
-
23
- interface IWebsocket extends ws {
24
- // Pipe implements .on("message", ...)
25
- pipe<T>(fn: T): IWebsocket;
26
- }
27
-
28
- /**
29
- * `usePreviewServer` is a React hook that creates a local development
30
- * server that can be used to develop a Worker.
31
- *
32
- * When we run `wrangler dev`, we start by uploading the compiled worker
33
- * to the preview service, which responds with a preview token.
34
- * (see `useWorker`/`createWorker` for details.)
35
- * We can then use that token to connect to the preview server for a
36
- * great local development experience. Further, as we change the worker,
37
- * we can update the preview token transparently without having to restart
38
- * the development server.
39
- */
40
-
41
- /** Rewrite request headers to add the preview token. */
42
- function addCfPreviewTokenHeader(
43
- headers: IncomingHttpHeaders,
44
- previewTokenValue: string
45
- ) {
46
- headers["cf-workers-preview-token"] = previewTokenValue;
47
- }
48
-
49
- /**
50
- * Rewrite references in request headers
51
- * from the preview host to the local host.
52
- */
53
- function rewriteRemoteHostToLocalHostInHeaders(
54
- headers: IncomingHttpHeaders,
55
- remoteHost: string,
56
- localPort: number,
57
- localProtocol: "https" | "http"
58
- ) {
59
- for (const [name, value] of Object.entries(headers)) {
60
- // Rewrite the remote host to the local host.
61
- if (typeof value === "string" && value.includes(remoteHost)) {
62
- headers[name] = value
63
- .replaceAll(
64
- `https://${remoteHost}`,
65
- `${localProtocol}://localhost:${localPort}`
66
- )
67
- .replaceAll(remoteHost, `localhost:${localPort}`);
68
- }
69
- }
70
- }
71
-
72
- type PreviewProxy = {
73
- server: HttpServer | HttpsServer;
74
- terminator: HttpTerminator;
75
- };
76
-
77
- export function usePreviewServer({
78
- previewToken,
79
- assetDirectory,
80
- localProtocol,
81
- localPort: port,
82
- ip,
83
- }: {
84
- previewToken: CfPreviewToken | undefined;
85
- assetDirectory: string | undefined;
86
- localProtocol: "https" | "http";
87
- localPort: number;
88
- ip: string;
89
- }) {
90
- /** Creates an HTTP/1 proxy that sends requests over HTTP/2. */
91
- const [proxy, setProxy] = useState<PreviewProxy>();
92
-
93
- /**
94
- * Create the instance of the local proxy server that will pass on
95
- * requests to the preview worker.
96
- */
97
- useEffect(() => {
98
- if (proxy === undefined) {
99
- createProxyServer(localProtocol)
100
- .then((server) => {
101
- setProxy({
102
- server,
103
- terminator: createHttpTerminator({
104
- server,
105
- gracefulTerminationTimeout: 0,
106
- }),
107
- });
108
- })
109
- .catch(async (err) => {
110
- logger.error("Failed to create proxy server:", err);
111
- });
112
- }
113
- }, [proxy, localProtocol]);
114
-
115
- /**
116
- * When we're not connected / getting a fresh token on changes,
117
- * we'd like to buffer streams/requests until we're connected.
118
- * Once connected, we can flush the buffered streams/requests.
119
- * streamBufferRef is used to buffer http/2 streams, while
120
- * requestResponseBufferRef is used to buffer http/1 requests.
121
- */
122
- const streamBufferRef = useRef<
123
- { stream: ServerHttp2Stream; headers: IncomingHttpHeaders }[]
124
- >([]);
125
- const requestResponseBufferRef = useRef<
126
- { request: IncomingMessage; response: ServerResponse }[]
127
- >([]);
128
-
129
- /**
130
- * The session doesn't last forever, and will eventually drop
131
- * (usually within 5-15 minutes). When that happens, we simply
132
- * restart the effect, effectively restarting the server. We use
133
- * a state sigil as an effect dependency to do so.
134
- */
135
- const [retryServerSetupSigil, setRetryServerSetupSigil] = useState<number>(0);
136
- function retryServerSetup() {
137
- setRetryServerSetupSigil((x) => x + 1);
138
- }
139
-
140
- useEffect(() => {
141
- if (proxy === undefined) {
142
- return;
143
- }
144
-
145
- // If we don't have a token, that means either we're just starting up,
146
- // or we're refreshing the token.
147
- if (!previewToken) {
148
- const cleanupListeners: (() => void)[] = [];
149
- const bufferStream = (
150
- stream: ServerHttp2Stream,
151
- headers: IncomingHttpHeaders
152
- ) => {
153
- // store the stream in a buffer so we can replay it later
154
- streamBufferRef.current.push({ stream, headers });
155
- };
156
- proxy.server.on("stream", bufferStream);
157
- cleanupListeners.push(() => proxy.server.off("stream", bufferStream));
158
-
159
- const bufferRequestResponse = (
160
- request: IncomingMessage,
161
- response: ServerResponse
162
- ) => {
163
- // store the request and response in a buffer so we can replay it later
164
- requestResponseBufferRef.current.push({ request, response });
165
- };
166
-
167
- proxy.server.on("request", bufferRequestResponse);
168
- cleanupListeners.push(() =>
169
- proxy.server.off("request", bufferRequestResponse)
170
- );
171
- return () => {
172
- cleanupListeners.forEach((cleanup) => cleanup());
173
- };
174
- }
175
-
176
- // We have a token. Let's proxy requests to the preview end point.
177
- const cleanupListeners: (() => void)[] = [];
178
-
179
- // create a ClientHttp2Session
180
- logger.debug("PREVIEW URL:", `https://${previewToken.host}`);
181
- const remote = connect(`https://${previewToken.host}`);
182
- cleanupListeners.push(() => remote.destroy());
183
-
184
- // As mentioned above, the session may die at any point,
185
- // so we need to restart the effect.
186
- remote.on("close", retryServerSetup);
187
- cleanupListeners.push(() => remote.off("close", retryServerSetup));
188
-
189
- /** HTTP/2 -> HTTP/2 */
190
- const handleStream = createStreamHandler(
191
- previewToken,
192
- remote,
193
- port,
194
- localProtocol
195
- );
196
- proxy.server.on("stream", handleStream);
197
- cleanupListeners.push(() => proxy.server.off("stream", handleStream));
198
-
199
- // flush and replay buffered streams
200
- streamBufferRef.current.forEach((buffer) =>
201
- handleStream(buffer.stream, buffer.headers)
202
- );
203
- streamBufferRef.current = [];
204
-
205
- /** HTTP/1 -> HTTP/2 */
206
- const handleRequest: RequestListener = (
207
- message: IncomingMessage,
208
- response: ServerResponse
209
- ) => {
210
- const { httpVersionMajor, headers, method, url } = message;
211
- if (httpVersionMajor >= 2) {
212
- return; // Already handled by the "stream" event.
213
- }
214
- addCfPreviewTokenHeader(headers, previewToken.value);
215
- headers[":method"] = method;
216
- headers[":path"] = url;
217
- headers[":authority"] = previewToken.host;
218
- headers[":scheme"] = "https";
219
- for (const name of Object.keys(headers)) {
220
- if (HTTP1_HEADERS.has(name.toLowerCase())) {
221
- delete headers[name];
222
- }
223
- }
224
- const request = message.pipe(remote.request(headers));
225
- logger.debug(
226
- "WORKER REQUEST",
227
- new Date().toLocaleTimeString(),
228
- method,
229
- url
230
- );
231
- logger.debug("HEADERS", JSON.stringify(headers, null, 2));
232
- logger.debug("PREVIEW TOKEN", previewToken);
233
-
234
- request.on("response", (responseHeaders) => {
235
- const status = responseHeaders[":status"] ?? 500;
236
-
237
- // log all requests to terminal
238
- logger.log(new Date().toLocaleTimeString(), method, url, status);
239
-
240
- rewriteRemoteHostToLocalHostInHeaders(
241
- responseHeaders,
242
- previewToken.host,
243
- port,
244
- localProtocol
245
- );
246
- for (const name of Object.keys(responseHeaders)) {
247
- if (name.startsWith(":")) {
248
- delete responseHeaders[name];
249
- }
250
- }
251
- response.writeHead(status, responseHeaders);
252
- request.pipe(response, { end: true });
253
- });
254
- };
255
-
256
- // If an asset path is defined, check the file system
257
- // for a file first and serve if it exists.
258
- const actualHandleRequest = assetDirectory
259
- ? createHandleAssetsRequest(assetDirectory, handleRequest)
260
- : handleRequest;
261
-
262
- proxy.server.on("request", actualHandleRequest);
263
- cleanupListeners.push(() =>
264
- proxy.server.off("request", actualHandleRequest)
265
- );
266
-
267
- // flush and replay buffered requests
268
- requestResponseBufferRef.current.forEach(({ request, response }) =>
269
- actualHandleRequest(request, response)
270
- );
271
- requestResponseBufferRef.current = [];
272
-
273
- /** HTTP/1 -> WebSocket (over HTTP/1) */
274
- const handleUpgrade = (
275
- message: IncomingMessage,
276
- socket: WebSocket,
277
- body: Buffer
278
- ) => {
279
- const { headers, url } = message;
280
- addCfPreviewTokenHeader(headers, previewToken.value);
281
- headers["host"] = previewToken.host;
282
- const localWebsocket = new WebSocket(message, socket, body) as IWebsocket;
283
- // TODO(soon): Custom WebSocket protocol is not working?
284
- const remoteWebsocketClient = new WebSocket.Client(
285
- `wss://${previewToken.host}${url}`,
286
- [],
287
- { headers }
288
- ) as IWebsocket;
289
- localWebsocket.pipe(remoteWebsocketClient).pipe(localWebsocket);
290
- // We close down websockets whenever we refresh the token.
291
- cleanupListeners.push(() => {
292
- localWebsocket.close();
293
- remoteWebsocketClient.close();
294
- });
295
- };
296
- proxy.server.on("upgrade", handleUpgrade);
297
- cleanupListeners.push(() => proxy.server.off("upgrade", handleUpgrade));
298
-
299
- return () => {
300
- cleanupListeners.forEach((cleanup) => cleanup());
301
- };
302
- }, [
303
- previewToken,
304
- assetDirectory,
305
- port,
306
- localProtocol,
307
- proxy,
308
- // We use a state value as a sigil to trigger reconnecting the server.
309
- // It's not used inside the effect, so react-hooks/exhaustive-deps
310
- // doesn't complain if it's not included in the dependency array.
311
- // But its presence is critical, so Do NOT remove it from the dependency list.
312
- retryServerSetupSigil,
313
- ]);
314
-
315
- // Start/stop the server whenever the
316
- // containing component is mounted/unmounted.
317
- useEffect(() => {
318
- const abortController = new AbortController();
319
- if (proxy === undefined) {
320
- return;
321
- }
322
-
323
- waitForPortToBeAvailable(port, {
324
- retryPeriod: 200,
325
- timeout: 2000,
326
- abortSignal: abortController.signal,
327
- })
328
- .then(() => {
329
- proxy.server.on("listening", () => {
330
- logger.log(`⬣ Listening at ${localProtocol}://${ip}:${port}`);
331
- });
332
- proxy.server.listen(port, ip);
333
- })
334
- .catch((err) => {
335
- if ((err as { code: string }).code !== "ABORT_ERR") {
336
- logger.error(`Failed to start server: ${err}`);
337
- }
338
- });
339
-
340
- return () => {
341
- abortController.abort();
342
- // Running `proxy.server.close()` does not close open connections, preventing the process from exiting.
343
- // So we use this `terminator` to close all the connections and force the server to shutdown.
344
- proxy.terminator
345
- .terminate()
346
- .catch(() => logger.error("Failed to terminate the proxy server."));
347
- };
348
- }, [port, ip, proxy, localProtocol]);
349
- }
350
-
351
- function createHandleAssetsRequest(
352
- assetDirectory: string,
353
- handleRequest: RequestListener
354
- ) {
355
- const handleAsset = serveStatic(assetDirectory, {
356
- cacheControl: false,
357
- });
358
- return (request: IncomingMessage, response: ServerResponse) => {
359
- handleAsset(request, response, () => {
360
- handleRequest(request, response);
361
- });
362
- };
363
- }
364
-
365
- /** A Set of headers we want to remove from HTTP/1 requests. */
366
- const HTTP1_HEADERS = new Set([
367
- "host",
368
- "connection",
369
- "upgrade",
370
- "keep-alive",
371
- "proxy-connection",
372
- "transfer-encoding",
373
- "http2-settings",
374
- ]);
375
-
376
- async function createProxyServer(
377
- localProtocol: "https" | "http"
378
- ): Promise<HttpServer | HttpsServer> {
379
- const server: HttpServer | HttpsServer =
380
- localProtocol === "https"
381
- ? createHttpsServer(await getHttpsOptions())
382
- : createHttpServer();
383
-
384
- return server
385
- .on("upgrade", (req) => {
386
- // log all websocket connections
387
- logger.log(
388
- new Date().toLocaleTimeString(),
389
- req.method,
390
- req.url,
391
- 101,
392
- "(WebSocket)"
393
- );
394
- })
395
- .on("error", (err) => {
396
- // log all connection errors
397
- logger.error(new Date().toLocaleTimeString(), err);
398
- });
399
- }
400
-
401
- function createStreamHandler(
402
- previewToken: CfPreviewToken,
403
- remote: ClientHttp2Session,
404
- localPort: number,
405
- localProtocol: "https" | "http"
406
- ) {
407
- return function handleStream(
408
- stream: ServerHttp2Stream,
409
- headers: IncomingHttpHeaders
410
- ) {
411
- addCfPreviewTokenHeader(headers, previewToken.value);
412
- headers[":authority"] = previewToken.host;
413
- const request = stream.pipe(remote.request(headers));
414
- request.on("response", (responseHeaders: IncomingHttpHeaders) => {
415
- rewriteRemoteHostToLocalHostInHeaders(
416
- responseHeaders,
417
- previewToken.host,
418
- localPort,
419
- localProtocol
420
- );
421
- stream.respond(responseHeaders);
422
- request.pipe(stream, { end: true });
423
- });
424
- };
425
- }
426
-
427
- /**
428
- * A helper function that waits for a port to be available.
429
- */
430
- export async function waitForPortToBeAvailable(
431
- port: number,
432
- options: { retryPeriod: number; timeout: number; abortSignal: AbortSignal }
433
- ): Promise<void> {
434
- return new Promise((resolve, reject) => {
435
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
436
- options.abortSignal.addEventListener("abort", () => {
437
- const abortError = new Error("waitForPortToBeAvailable() aborted");
438
- (abortError as Error & { code: string }).code = "ABORT_ERR";
439
- doReject(abortError);
440
- });
441
-
442
- const timeout = setTimeout(() => {
443
- doReject(new Error(`Timed out waiting for port ${port}`));
444
- }, options.timeout);
445
-
446
- const interval = setInterval(checkPort, options.retryPeriod);
447
- checkPort();
448
-
449
- function doResolve() {
450
- clearTimeout(timeout);
451
- clearInterval(interval);
452
- resolve();
453
- }
454
-
455
- function doReject(err: unknown) {
456
- clearInterval(interval);
457
- clearTimeout(timeout);
458
- reject(err);
459
- }
460
-
461
- function checkPort() {
462
- // Testing whether a port is 'available' involves simply
463
- // trying to make a server listen on that port, and retrying
464
- // until it succeeds.
465
- const server = createHttpServer();
466
- const terminator = createHttpTerminator({
467
- server,
468
- gracefulTerminationTimeout: 0, // default 1000
469
- });
470
-
471
- server.on("error", (err) => {
472
- // @ts-expect-error non standard property on Error
473
- if (err.code !== "EADDRINUSE") {
474
- doReject(err);
475
- }
476
- });
477
- server.listen(port, () =>
478
- terminator
479
- .terminate()
480
- .then(doResolve, () =>
481
- logger.error("Failed to terminate the port checker.")
482
- )
483
- );
484
- }
485
- });
486
- }