wrangler 0.0.0-e2f9bb2 → 0.0.0-e305903a

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