wrangler 0.0.0-e043479 → 0.0.0-e0621809

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 (365) hide show
  1. package/Cloudflare_CA.pem +18 -0
  2. package/README.md +47 -14
  3. package/bin/wrangler.js +181 -29
  4. package/kv-asset-handler.js +1 -0
  5. package/miniflare-dist/index.mjs +6368 -0
  6. package/package.json +198 -136
  7. package/src/__tests__/access.test.ts +25 -0
  8. package/src/__tests__/api-dev.test.ts +238 -0
  9. package/src/__tests__/api-devregistry.test.js +64 -0
  10. package/src/__tests__/api.test.ts +80 -0
  11. package/src/__tests__/config-cache-without-cache-dir.test.ts +38 -0
  12. package/src/__tests__/config-cache.test.ts +42 -0
  13. package/src/__tests__/configuration.test.ts +4456 -2178
  14. package/src/__tests__/d1/d1.test.ts +82 -0
  15. package/src/__tests__/d1/execute.test.ts +66 -0
  16. package/src/__tests__/d1/migrate.test.ts +157 -0
  17. package/src/__tests__/d1/splitter.test.ts +255 -0
  18. package/src/__tests__/delete.test.ts +272 -0
  19. package/src/__tests__/deployments.test.ts +369 -0
  20. package/src/__tests__/dev.test.tsx +1605 -235
  21. package/src/__tests__/generate.test.ts +238 -0
  22. package/src/__tests__/get-host-from-url.test.ts +16 -0
  23. package/src/__tests__/guess-worker-format.test.ts +111 -57
  24. package/src/__tests__/helpers/cmd-shim.d.ts +6 -6
  25. package/src/__tests__/helpers/end-event-loop.ts +6 -0
  26. package/src/__tests__/helpers/mock-account-id.ts +26 -22
  27. package/src/__tests__/helpers/mock-auth-domain.ts +20 -0
  28. package/src/__tests__/helpers/mock-bin.ts +20 -20
  29. package/src/__tests__/helpers/mock-console.ts +74 -32
  30. package/src/__tests__/helpers/mock-dialogs.ts +107 -33
  31. package/src/__tests__/helpers/mock-get-pages-upload-token.ts +25 -0
  32. package/src/__tests__/helpers/mock-get-zone-from-host.ts +11 -0
  33. package/src/__tests__/helpers/mock-http-server.ts +46 -0
  34. package/src/__tests__/helpers/mock-istty.ts +74 -0
  35. package/src/__tests__/helpers/mock-known-routes.ts +12 -0
  36. package/src/__tests__/helpers/mock-kv.ts +42 -36
  37. package/src/__tests__/helpers/mock-oauth-flow.ts +263 -0
  38. package/src/__tests__/helpers/mock-process.ts +34 -0
  39. package/src/__tests__/helpers/mock-set-timeout.ts +16 -0
  40. package/src/__tests__/helpers/mock-stdin.ts +82 -77
  41. package/src/__tests__/helpers/mock-web-socket.ts +21 -21
  42. package/src/__tests__/helpers/msw/blob-worker.cjs +19 -0
  43. package/src/__tests__/helpers/msw/handlers/access.ts +13 -0
  44. package/src/__tests__/helpers/msw/handlers/deployments.ts +160 -0
  45. package/src/__tests__/helpers/msw/handlers/namespaces.ts +81 -0
  46. package/src/__tests__/helpers/msw/handlers/oauth.ts +31 -0
  47. package/src/__tests__/helpers/msw/handlers/r2.ts +60 -0
  48. package/src/__tests__/helpers/msw/handlers/script.ts +56 -0
  49. package/src/__tests__/helpers/msw/handlers/user.ts +52 -0
  50. package/src/__tests__/helpers/msw/handlers/zones.ts +20 -0
  51. package/src/__tests__/helpers/msw/index.ts +52 -0
  52. package/src/__tests__/helpers/msw/read-file-sync.js +61 -0
  53. package/src/__tests__/helpers/run-in-tmp.ts +29 -20
  54. package/src/__tests__/helpers/run-wrangler.ts +8 -8
  55. package/src/__tests__/helpers/string-dynamic-values-matcher.ts +28 -0
  56. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +1 -0
  57. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +5 -0
  58. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +1 -0
  59. package/src/__tests__/helpers/worker-scripts/parent-worker.js +11 -0
  60. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +5 -0
  61. package/src/__tests__/helpers/write-worker-source.ts +31 -0
  62. package/src/__tests__/helpers/write-wrangler-toml.ts +9 -9
  63. package/src/__tests__/https-options.test.ts +163 -0
  64. package/src/__tests__/index.test.ts +264 -850
  65. package/src/__tests__/init.test.ts +3196 -0
  66. package/src/__tests__/jest.setup.ts +158 -48
  67. package/src/__tests__/kv.test.ts +1789 -1398
  68. package/src/__tests__/logger.test.ts +141 -0
  69. package/src/__tests__/logout.test.ts +41 -44
  70. package/src/__tests__/metrics.test.ts +493 -0
  71. package/src/__tests__/middleware.scheduled.test.ts +145 -0
  72. package/src/__tests__/middleware.test.ts +816 -0
  73. package/src/__tests__/mtls-certificates.test.ts +588 -0
  74. package/src/__tests__/package-manager.test.ts +312 -165
  75. package/src/__tests__/pages/deployment-list.test.ts +80 -0
  76. package/src/__tests__/pages/functions-build.test.ts +452 -0
  77. package/src/__tests__/pages/pages.test.ts +81 -0
  78. package/src/__tests__/pages/project-create.test.ts +63 -0
  79. package/src/__tests__/pages/project-list.test.ts +110 -0
  80. package/src/__tests__/pages/project-upload.test.ts +500 -0
  81. package/src/__tests__/pages/publish.test.ts +2820 -0
  82. package/src/__tests__/pages-deployment-tail.test.ts +955 -0
  83. package/src/__tests__/parse.test.ts +359 -245
  84. package/src/__tests__/paths.test.ts +39 -0
  85. package/src/__tests__/publish.test.ts +8373 -2089
  86. package/src/__tests__/pubsub.test.ts +496 -0
  87. package/src/__tests__/queues.test.ts +532 -0
  88. package/src/__tests__/r2.test.ts +369 -193
  89. package/src/__tests__/route.test.ts +45 -0
  90. package/src/__tests__/secret.test.ts +683 -415
  91. package/src/__tests__/tail.test.ts +838 -444
  92. package/src/__tests__/test-old-node-version.js +31 -0
  93. package/src/__tests__/tsconfig-sanity.ts +12 -0
  94. package/src/__tests__/tsconfig.json +8 -0
  95. package/src/__tests__/tsconfig.tsbuildinfo +1 -0
  96. package/src/__tests__/type-generation.test.ts +234 -0
  97. package/src/__tests__/user.test.ts +118 -0
  98. package/src/__tests__/utils-collectKeyValues.test.ts +47 -0
  99. package/src/__tests__/validate-dev-props.test.ts +56 -0
  100. package/src/__tests__/version.test.ts +35 -0
  101. package/src/__tests__/whoami.test.tsx +167 -81
  102. package/src/__tests__/worker-namespace.test.ts +340 -0
  103. package/src/abort.d.ts +3 -0
  104. package/src/api/dev.ts +327 -0
  105. package/src/api/index.ts +11 -0
  106. package/src/api/mtls-certificate.ts +148 -0
  107. package/src/api/pages/create-worker-bundle-contents.ts +75 -0
  108. package/src/api/pages/index.ts +5 -0
  109. package/src/api/pages/publish.tsx +355 -0
  110. package/src/bundle-reporter.ts +68 -0
  111. package/src/bundle.ts +874 -103
  112. package/src/cfetch/index.ts +123 -69
  113. package/src/cfetch/internal.ts +217 -92
  114. package/src/cli.ts +23 -14
  115. package/src/config/README.md +7 -7
  116. package/src/config/config.ts +236 -224
  117. package/src/config/diagnostics.ts +61 -61
  118. package/src/config/environment.ts +545 -256
  119. package/src/config/index.ts +367 -34
  120. package/src/config/validation-helpers.ts +449 -222
  121. package/src/config/validation.ts +2142 -907
  122. package/src/config-cache.ts +85 -0
  123. package/src/create-worker-preview.ts +293 -0
  124. package/src/create-worker-upload-form.ts +342 -0
  125. package/src/d1/backups.tsx +219 -0
  126. package/src/d1/constants.ts +2 -0
  127. package/src/d1/create.tsx +68 -0
  128. package/src/d1/delete.ts +53 -0
  129. package/src/d1/execute.tsx +357 -0
  130. package/src/d1/formatTimeAgo.ts +14 -0
  131. package/src/d1/index.ts +100 -0
  132. package/src/d1/list.tsx +60 -0
  133. package/src/d1/migrations/apply.tsx +212 -0
  134. package/src/d1/migrations/create.tsx +79 -0
  135. package/src/d1/migrations/helpers.ts +172 -0
  136. package/src/d1/migrations/index.ts +3 -0
  137. package/src/d1/migrations/list.tsx +95 -0
  138. package/src/d1/migrations/options.ts +23 -0
  139. package/src/d1/options.ts +22 -0
  140. package/src/d1/splitter.ts +161 -0
  141. package/src/d1/types.ts +25 -0
  142. package/src/d1/utils.ts +49 -0
  143. package/src/delete.ts +100 -0
  144. package/src/deployments.ts +368 -0
  145. package/src/deprecated/index.ts +144 -0
  146. package/src/dev/dev-vars.ts +39 -0
  147. package/src/dev/dev.tsx +600 -0
  148. package/src/dev/get-local-persistence-path.ts +31 -0
  149. package/src/dev/local.tsx +920 -0
  150. package/src/dev/remote.tsx +632 -0
  151. package/src/dev/start-server.ts +540 -0
  152. package/src/dev/use-esbuild.ts +209 -0
  153. package/src/dev/validate-dev-props.ts +40 -0
  154. package/src/dev-registry.ts +201 -0
  155. package/src/dev.tsx +907 -939
  156. package/src/dialogs.ts +136 -0
  157. package/src/dispatch-namespace.ts +211 -0
  158. package/src/docs/index.ts +97 -0
  159. package/src/durable.ts +102 -0
  160. package/src/entry.ts +307 -37
  161. package/src/environment-variables/factory.ts +88 -0
  162. package/src/environment-variables/misc-variables.ts +30 -0
  163. package/src/errors.ts +11 -0
  164. package/src/generate/index.ts +298 -0
  165. package/src/git-client.ts +135 -0
  166. package/src/global-wrangler-config-path.ts +26 -0
  167. package/src/https-options.ts +127 -0
  168. package/src/index.ts +758 -0
  169. package/src/init.ts +1032 -0
  170. package/src/inspect.ts +723 -550
  171. package/src/intl-polyfill.d.ts +139 -0
  172. package/src/is-ci.ts +14 -0
  173. package/src/is-interactive.ts +16 -0
  174. package/src/jest.d.ts +4 -0
  175. package/src/kv/helpers.ts +430 -0
  176. package/src/kv/index.ts +594 -0
  177. package/src/logger.ts +104 -0
  178. package/src/metrics/index.ts +5 -0
  179. package/src/metrics/metrics-config.ts +239 -0
  180. package/src/metrics/metrics-dispatcher.ts +96 -0
  181. package/src/metrics/metrics-usage-headers.ts +24 -0
  182. package/src/metrics/send-event.ts +99 -0
  183. package/src/miniflare-cli/README.md +30 -0
  184. package/src/miniflare-cli/assets.ts +251 -0
  185. package/src/miniflare-cli/index.ts +210 -0
  186. package/src/miniflare-cli/request-context.ts +40 -0
  187. package/src/miniflare-cli/tsconfig.json +9 -0
  188. package/src/miniflare-cli/tsconfig.tsbuildinfo +1 -0
  189. package/src/miniflare-cli/types.ts +11 -0
  190. package/src/module-collection.ts +243 -146
  191. package/src/mtls-certificate/cli.ts +155 -0
  192. package/src/open-in-browser.ts +10 -6
  193. package/src/package-manager.ts +183 -90
  194. package/src/pages/build.ts +410 -0
  195. package/src/pages/buildFunctions.ts +140 -0
  196. package/src/pages/constants.ts +18 -0
  197. package/src/pages/deployment-tails.ts +281 -0
  198. package/src/pages/deployments.tsx +84 -0
  199. package/src/pages/dev.ts +716 -0
  200. package/src/pages/errors.ts +67 -0
  201. package/src/pages/functions/buildPlugin.ts +112 -0
  202. package/src/pages/functions/buildWorker.ts +297 -0
  203. package/src/pages/functions/filepath-routing.test.ts +234 -0
  204. package/src/pages/functions/filepath-routing.ts +189 -0
  205. package/src/pages/functions/identifiers.ts +78 -0
  206. package/src/pages/functions/routes-consolidation.test.ts +250 -0
  207. package/src/pages/functions/routes-consolidation.ts +73 -0
  208. package/src/pages/functions/routes-transformation.test.ts +282 -0
  209. package/src/pages/functions/routes-transformation.ts +115 -0
  210. package/src/pages/functions/routes-validation.test.ts +403 -0
  211. package/src/pages/functions/routes-validation.ts +202 -0
  212. package/src/pages/functions/routes.ts +151 -0
  213. package/src/pages/functions/tsconfig.json +8 -0
  214. package/src/pages/functions/tsconfig.tsbuildinfo +1 -0
  215. package/src/pages/functions.ts +86 -0
  216. package/src/pages/hash.ts +13 -0
  217. package/src/pages/index.ts +102 -0
  218. package/src/pages/projects.tsx +159 -0
  219. package/src/pages/prompt-select-project.tsx +31 -0
  220. package/src/pages/publish.tsx +267 -0
  221. package/src/pages/types.ts +46 -0
  222. package/src/pages/upload.tsx +469 -0
  223. package/src/pages/utils.ts +23 -0
  224. package/src/parse.ts +247 -122
  225. package/src/paths.ts +53 -8
  226. package/src/proxy.ts +636 -318
  227. package/src/publish/index.ts +274 -0
  228. package/src/publish/publish.ts +1065 -0
  229. package/src/pubsub/index.ts +286 -0
  230. package/src/pubsub/pubsub-commands.ts +623 -0
  231. package/src/queues/cli/commands/consumer/add.ts +71 -0
  232. package/src/queues/cli/commands/consumer/index.ts +19 -0
  233. package/src/queues/cli/commands/consumer/remove.ts +31 -0
  234. package/src/queues/cli/commands/create.ts +25 -0
  235. package/src/queues/cli/commands/delete.ts +26 -0
  236. package/src/queues/cli/commands/index.ts +35 -0
  237. package/src/queues/cli/commands/list.ts +25 -0
  238. package/src/queues/client.ts +136 -0
  239. package/src/queues/utils.ts +18 -0
  240. package/src/r2/constants.ts +4 -0
  241. package/src/r2/helpers.ts +132 -0
  242. package/src/r2/index.ts +289 -0
  243. package/src/routes.ts +140 -0
  244. package/src/secret/index.ts +375 -0
  245. package/src/selfsigned.d.ts +29 -0
  246. package/src/sites.ts +372 -0
  247. package/src/tail/createTail.ts +406 -0
  248. package/src/tail/filters.ts +109 -111
  249. package/src/tail/index.ts +208 -296
  250. package/src/tail/printing.ts +107 -47
  251. package/src/tsconfig-sanity.ts +16 -0
  252. package/src/type-generation.ts +181 -0
  253. package/src/update-check.ts +19 -0
  254. package/src/user/access.ts +68 -0
  255. package/src/user/auth-variables.ts +113 -0
  256. package/src/user/choose-account.tsx +39 -0
  257. package/src/user/generate-auth-url.ts +33 -0
  258. package/src/user/generate-random-state.ts +16 -0
  259. package/src/user/index.ts +2 -0
  260. package/src/user/user.ts +1233 -0
  261. package/src/utils/collectKeyValues.ts +14 -0
  262. package/src/utils/render.ts +93 -0
  263. package/src/whoami.ts +135 -0
  264. package/src/worker.ts +264 -0
  265. package/src/yargs-types.ts +37 -0
  266. package/src/zones.ts +191 -0
  267. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  268. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  269. package/templates/__tests__/tsconfig.json +8 -0
  270. package/templates/__tests__/tsconfig.tsbuildinfo +1 -0
  271. package/templates/checked-fetch.js +23 -0
  272. package/templates/d1-beta-facade.js +244 -0
  273. package/templates/facade.d.ts +14 -0
  274. package/templates/first-party-worker-module-facade.ts +19 -0
  275. package/templates/format-dev-errors.ts +34 -0
  276. package/templates/gitignore +172 -0
  277. package/templates/init-tests/test-jest-new-worker.js +23 -0
  278. package/templates/init-tests/test-vitest-new-worker.js +24 -0
  279. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  280. package/templates/middleware/common.ts +62 -0
  281. package/templates/middleware/loader-modules.ts +84 -0
  282. package/templates/middleware/loader-sw.ts +233 -0
  283. package/templates/middleware/middleware-miniflare3-json-error.ts +32 -0
  284. package/templates/middleware/middleware-pretty-error.ts +40 -0
  285. package/templates/middleware/middleware-scheduled.ts +15 -0
  286. package/templates/new-worker-scheduled.js +17 -0
  287. package/templates/new-worker-scheduled.ts +32 -0
  288. package/templates/new-worker.js +3 -3
  289. package/templates/new-worker.ts +21 -3
  290. package/templates/no-op-worker.js +10 -0
  291. package/templates/pages-dev-pipeline.ts +31 -0
  292. package/templates/pages-dev-util.ts +52 -0
  293. package/templates/pages-shim.ts +12 -0
  294. package/templates/pages-template-plugin.ts +180 -0
  295. package/templates/pages-template-worker.ts +189 -0
  296. package/templates/serve-static-assets.ts +66 -0
  297. package/templates/service-bindings-module-facade.js +55 -0
  298. package/templates/service-bindings-sw-facade.js +42 -0
  299. package/templates/tsconfig-sanity.ts +11 -0
  300. package/templates/tsconfig.init.json +105 -0
  301. package/templates/tsconfig.json +6 -103
  302. package/templates/tsconfig.tsbuildinfo +1 -0
  303. package/wrangler-dist/cli.d.ts +1619 -0
  304. package/wrangler-dist/cli.js +141446 -128789
  305. package/wrangler-dist/wasm-sync.wasm +0 -0
  306. package/pages/functions/buildWorker.ts +0 -62
  307. package/pages/functions/filepath-routing.test.ts +0 -123
  308. package/pages/functions/filepath-routing.ts +0 -178
  309. package/pages/functions/identifiers.ts +0 -78
  310. package/pages/functions/routes.ts +0 -151
  311. package/pages/functions/template-worker.ts +0 -130
  312. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  313. package/src/__tests__/helpers/mock-cfetch.ts +0 -207
  314. package/src/__tests__/helpers/mock-user.ts +0 -27
  315. package/src/__tests__/sentry.test.ts +0 -146
  316. package/src/api/form_data.ts +0 -217
  317. package/src/api/preview.ts +0 -147
  318. package/src/api/worker.ts +0 -186
  319. package/src/dialogs.tsx +0 -77
  320. package/src/environment-variables.ts +0 -33
  321. package/src/guess-worker-format.ts +0 -68
  322. package/src/index.tsx +0 -2302
  323. package/src/kv.tsx +0 -339
  324. package/src/pages.tsx +0 -1045
  325. package/src/publish.ts +0 -363
  326. package/src/r2.ts +0 -50
  327. package/src/reporting.ts +0 -115
  328. package/src/sites.tsx +0 -238
  329. package/src/user.tsx +0 -1063
  330. package/src/whoami.tsx +0 -69
  331. package/templates/static-asset-facade.js +0 -47
  332. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  333. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  334. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  335. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  336. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  337. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  338. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  339. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  340. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  341. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  342. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  343. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  344. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  345. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  346. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  347. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  348. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  349. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  350. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  351. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  352. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  353. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  354. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  355. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  356. package/vendor/wrangler-mime/LICENSE +0 -21
  357. package/vendor/wrangler-mime/Mime.js +0 -97
  358. package/vendor/wrangler-mime/README.md +0 -187
  359. package/vendor/wrangler-mime/cli.js +0 -46
  360. package/vendor/wrangler-mime/index.js +0 -4
  361. package/vendor/wrangler-mime/lite.js +0 -4
  362. package/vendor/wrangler-mime/package.json +0 -52
  363. package/vendor/wrangler-mime/types/other.js +0 -1
  364. package/vendor/wrangler-mime/types/standard.js +0 -1
  365. package/wrangler-dist/cli.js.map +0 -7
package/src/proxy.ts CHANGED
@@ -1,23 +1,26 @@
1
- import { createServer } from "node:http";
1
+ import { createServer as createHttpServer } from "node:http";
2
2
  import { connect } from "node:http2";
3
- import WebSocket from "faye-websocket";
3
+ import { createServer as createHttpsServer } from "node:https";
4
+ import https from "node:https";
5
+ import { networkInterfaces } from "node:os";
6
+ import { createHttpTerminator } from "http-terminator";
4
7
  import { useEffect, useRef, useState } from "react";
5
8
  import serveStatic from "serve-static";
6
- import type { CfPreviewToken } from "./api/preview";
9
+ import { getHttpsOptions } from "./https-options";
10
+ import { logger } from "./logger";
11
+ import { getAccessToken } from "./user/access";
12
+ import type { CfPreviewToken } from "./create-worker-preview";
13
+ import type { HttpTerminator } from "http-terminator";
7
14
  import type {
8
- IncomingHttpHeaders,
9
- RequestListener,
10
- IncomingMessage,
11
- ServerResponse,
12
- Server,
15
+ IncomingHttpHeaders,
16
+ RequestListener,
17
+ IncomingMessage,
18
+ ServerResponse,
19
+ Server as HttpServer,
13
20
  } from "node:http";
14
21
  import type { ClientHttp2Session, ServerHttp2Stream } from "node:http2";
15
- import type ws from "ws";
16
-
17
- interface IWebsocket extends ws {
18
- // Pipe implements .on("message", ...)
19
- pipe<T>(fn: T): IWebsocket;
20
- }
22
+ import type { Server as HttpsServer } from "node:https";
23
+ import type { Duplex, Writable } from "node:stream";
21
24
 
22
25
  /**
23
26
  * `usePreviewServer` is a React hook that creates a local development
@@ -34,343 +37,658 @@ interface IWebsocket extends ws {
34
37
 
35
38
  /** Rewrite request headers to add the preview token. */
36
39
  function addCfPreviewTokenHeader(
37
- headers: IncomingHttpHeaders,
38
- previewTokenValue: string
40
+ headers: IncomingHttpHeaders,
41
+ previewTokenValue: string
39
42
  ) {
40
- headers["cf-workers-preview-token"] = previewTokenValue;
43
+ headers["cf-workers-preview-token"] = previewTokenValue;
41
44
  }
42
45
 
46
+ export async function addCfAccessToken(
47
+ headers: IncomingHttpHeaders,
48
+ domain: string,
49
+ accessTokenRef: { current: string | undefined | null }
50
+ ) {
51
+ if (accessTokenRef.current === null) {
52
+ return;
53
+ }
54
+ if (typeof accessTokenRef.current === "string") {
55
+ headers[
56
+ "cookie"
57
+ ] = `${headers["cookie"]};CF_Authorization=${accessTokenRef.current}`;
58
+ return;
59
+ }
60
+ const token = await getAccessToken(domain);
61
+ accessTokenRef.current = token;
62
+ if (token)
63
+ headers[
64
+ "cookie"
65
+ ] = `${headers["cookie"]};CF_Authorization=${accessTokenRef.current}`;
66
+ }
43
67
  /**
44
68
  * Rewrite references in request headers
45
69
  * from the preview host to the local host.
46
70
  */
47
71
  function rewriteRemoteHostToLocalHostInHeaders(
48
- headers: IncomingHttpHeaders,
49
- remoteHost: string,
50
- localPort: number
72
+ headers: IncomingHttpHeaders,
73
+ remoteHost: string,
74
+ localPort: number,
75
+ localProtocol: "https" | "http"
51
76
  ) {
52
- for (const [name, value] of Object.entries(headers)) {
53
- // Rewrite the remote host to the local host.
54
- if (typeof value === "string" && value.includes(remoteHost)) {
55
- headers[name] = value
56
- .replaceAll(`https://${remoteHost}`, `http://localhost:${localPort}`)
57
- .replaceAll(remoteHost, `localhost:${localPort}`);
58
- }
59
- }
77
+ for (const [name, value] of Object.entries(headers)) {
78
+ // Rewrite the remote host to the local host.
79
+ if (typeof value === "string" && value.includes(remoteHost)) {
80
+ headers[name] = value
81
+ .replaceAll(
82
+ `https://${remoteHost}`,
83
+ `${localProtocol}://localhost:${localPort}`
84
+ )
85
+ .replaceAll(remoteHost, `localhost:${localPort}`);
86
+ }
87
+ }
88
+ }
89
+
90
+ function writeHead(
91
+ socket: Writable,
92
+ res: Pick<
93
+ IncomingMessage,
94
+ "httpVersion" | "statusCode" | "statusMessage" | "headers"
95
+ >
96
+ ) {
97
+ socket.write(
98
+ `HTTP/${res.httpVersion} ${res.statusCode} ${res.statusMessage}\r\n`
99
+ );
100
+ for (const [key, values] of Object.entries(res.headers)) {
101
+ if (Array.isArray(values)) {
102
+ for (const value of values) socket.write(`${key}: ${value}\r\n`);
103
+ } else {
104
+ socket.write(`${key}: ${values}\r\n`);
105
+ }
106
+ }
107
+ socket.write("\r\n");
108
+ }
109
+
110
+ type PreviewProxy = {
111
+ server: HttpServer | HttpsServer;
112
+ terminator: HttpTerminator;
113
+ };
114
+
115
+ export async function startPreviewServer({
116
+ previewToken,
117
+ assetDirectory,
118
+ localProtocol,
119
+ localPort: port,
120
+ ip,
121
+ onReady,
122
+ }: {
123
+ previewToken: CfPreviewToken;
124
+ assetDirectory: string | undefined;
125
+ localProtocol: "https" | "http";
126
+ localPort: number;
127
+ ip: string;
128
+ onReady: ((readyIp: string, readyPort: number) => void) | undefined;
129
+ }) {
130
+ try {
131
+ const abortController = new AbortController();
132
+
133
+ const server = await createProxyServer(localProtocol);
134
+ const proxy = {
135
+ server,
136
+ terminator: createHttpTerminator({
137
+ server,
138
+ gracefulTerminationTimeout: 0,
139
+ }),
140
+ };
141
+
142
+ // We have a token. Let's proxy requests to the preview end point.
143
+ const streamBufferRef = { current: [] };
144
+ const requestResponseBufferRef = { current: [] };
145
+ const accessTokenRef = { current: undefined };
146
+ const cleanupListeners = configureProxyServer({
147
+ proxy,
148
+ previewToken,
149
+ streamBufferRef,
150
+ requestResponseBufferRef,
151
+ retryServerSetup: () => {}, // no-op outside of React
152
+ assetDirectory,
153
+ localProtocol,
154
+ port,
155
+ accessTokenRef,
156
+ });
157
+
158
+ await waitForPortToBeAvailable(port, {
159
+ retryPeriod: 200,
160
+ timeout: 2000,
161
+ abortSignal: abortController.signal,
162
+ });
163
+
164
+ proxy.server.on("listening", () => {
165
+ const address = proxy.server.address();
166
+ const usedPort =
167
+ address && typeof address === "object" ? address.port : port;
168
+ logger.log(`⬣ Listening at ${localProtocol}://${ip}:${usedPort}`);
169
+ const accessibleHosts = ip !== "0.0.0.0" ? [ip] : getAccessibleHosts();
170
+ for (const accessibleHost of accessibleHosts) {
171
+ logger.log(`- ${localProtocol}://${accessibleHost}:${usedPort}`);
172
+ }
173
+ onReady?.(ip, usedPort);
174
+ });
175
+
176
+ proxy.server.listen(port, ip);
177
+ return {
178
+ stop: () => {
179
+ abortController.abort();
180
+ cleanupListeners?.forEach((cleanup) => cleanup());
181
+ },
182
+ };
183
+ } catch (err) {
184
+ if ((err as { code: string }).code !== "ABORT_ERR") {
185
+ logger.error(`Failed to start server: ${err}`);
186
+ }
187
+ logger.error("Failed to create proxy server:", err);
188
+ }
60
189
  }
61
190
 
62
191
  export function usePreviewServer({
63
- previewToken,
64
- publicRoot,
65
- port,
192
+ previewToken,
193
+ assetDirectory,
194
+ localProtocol,
195
+ localPort: port,
196
+ ip,
66
197
  }: {
67
- previewToken: CfPreviewToken | undefined;
68
- publicRoot: undefined | string;
69
- port: number;
198
+ previewToken: CfPreviewToken | undefined;
199
+ assetDirectory: string | undefined;
200
+ localProtocol: "https" | "http";
201
+ localPort: number;
202
+ ip: string;
70
203
  }) {
71
- /** Creates an HTTP/1 proxy that sends requests over HTTP/2. */
72
- const proxyServer = useRef<Server>();
73
- const proxy = (proxyServer.current ??= createProxyServer());
74
-
75
- /**
76
- * When we're not connected / getting a fresh token on changes,
77
- * we'd like to buffer streams/requests until we're connected.
78
- * Once connected, we can flush the buffered streams/requests.
79
- * streamBufferRef is used to buffer http/2 streams, while
80
- * requestResponseBufferRef is used to buffer http/1 requests.
81
- */
82
- const streamBufferRef = useRef<
83
- { stream: ServerHttp2Stream; headers: IncomingHttpHeaders }[]
84
- >([]);
85
- const requestResponseBufferRef = useRef<
86
- { request: IncomingMessage; response: ServerResponse }[]
87
- >([]);
88
-
89
- /**
90
- * The session doesn't last forever, and will eventually drop
91
- * (usually within 5-15 minutes). When that happens, we simply
92
- * restart the effect, effectively restarting the server. We use
93
- * a state sigil as an effect dependency to do so.
94
- */
95
- const [retryServerSetupSigil, setRetryServerSetupSigil] = useState<number>(0);
96
- function retryServerSetup() {
97
- setRetryServerSetupSigil((x) => x + 1);
98
- }
99
-
100
- useEffect(() => {
101
- // If we don't have a token, that means either we're just starting up,
102
- // or we're refreshing the token.
103
- if (!previewToken) {
104
- const cleanupListeners: (() => void)[] = [];
105
- const bufferStream = (
106
- stream: ServerHttp2Stream,
107
- headers: IncomingHttpHeaders
108
- ) => {
109
- // store the stream in a buffer so we can replay it later
110
- streamBufferRef.current.push({ stream, headers });
111
- };
112
- proxy.on("stream", bufferStream);
113
- cleanupListeners.push(() => proxy.off("stream", bufferStream));
114
-
115
- const bufferRequestResponse = (
116
- request: IncomingMessage,
117
- response: ServerResponse
118
- ) => {
119
- // store the request and response in a buffer so we can replay it later
120
- requestResponseBufferRef.current.push({ request, response });
121
- };
122
-
123
- proxy.on("request", bufferRequestResponse);
124
- cleanupListeners.push(() => proxy.off("request", bufferRequestResponse));
125
- return () => {
126
- cleanupListeners.forEach((cleanup) => cleanup());
127
- };
128
- }
129
-
130
- // We have a token. Let's proxy requests to the preview end point.
131
- const cleanupListeners: (() => void)[] = [];
132
-
133
- const assetPath = typeof publicRoot === "string" ? publicRoot : null;
134
-
135
- // create a ClientHttp2Session
136
- const remote = connect(`https://${previewToken.host}`);
137
- cleanupListeners.push(() => remote.destroy());
138
-
139
- // As mentioned above, the session may die at any point,
140
- // so we need to restart the effect.
141
- remote.on("close", retryServerSetup);
142
- cleanupListeners.push(() => remote.off("close", retryServerSetup));
143
-
144
- /** HTTP/2 -> HTTP/2 */
145
- const handleStream = createStreamHandler(previewToken, remote, port);
146
- proxy.on("stream", handleStream);
147
- cleanupListeners.push(() => proxy.off("stream", handleStream));
148
-
149
- // flush and replay buffered streams
150
- streamBufferRef.current.forEach((buffer) =>
151
- handleStream(buffer.stream, buffer.headers)
152
- );
153
- streamBufferRef.current = [];
154
-
155
- /** HTTP/1 -> HTTP/2 */
156
- const handleRequest: RequestListener = (
157
- message: IncomingMessage,
158
- response: ServerResponse
159
- ) => {
160
- const { httpVersionMajor, headers, method, url } = message;
161
- if (httpVersionMajor >= 2) {
162
- return; // Already handled by the "stream" event.
163
- }
164
- addCfPreviewTokenHeader(headers, previewToken.value);
165
- headers[":method"] = method;
166
- headers[":path"] = url;
167
- headers[":authority"] = previewToken.host;
168
- headers[":scheme"] = "https";
169
- for (const name of Object.keys(headers)) {
170
- if (HTTP1_HEADERS.has(name.toLowerCase())) {
171
- delete headers[name];
172
- }
173
- }
174
- const request = message.pipe(remote.request(headers));
175
- request.on("response", (responseHeaders) => {
176
- const status = responseHeaders[":status"] ?? 500;
177
- rewriteRemoteHostToLocalHostInHeaders(
178
- responseHeaders,
179
- previewToken.host,
180
- port
181
- );
182
- for (const name of Object.keys(responseHeaders)) {
183
- if (name.startsWith(":")) {
184
- delete responseHeaders[name];
185
- }
186
- }
187
- response.writeHead(status, responseHeaders);
188
- request.pipe(response, { end: true });
189
- });
190
- };
191
-
192
- // If an asset path is defined, check the file system
193
- // for a file first and serve if it exists.
194
- const actualHandleRequest = assetPath
195
- ? createHandleAssetsRequest(assetPath, handleRequest)
196
- : handleRequest;
197
-
198
- proxy.on("request", actualHandleRequest);
199
- cleanupListeners.push(() => proxy.off("request", actualHandleRequest));
200
-
201
- // flush and replay buffered requests
202
- requestResponseBufferRef.current.forEach(({ request, response }) =>
203
- actualHandleRequest(request, response)
204
- );
205
- requestResponseBufferRef.current = [];
206
-
207
- /** HTTP/1 -> WebSocket (over HTTP/1) */
208
- const handleUpgrade = (
209
- message: IncomingMessage,
210
- socket: WebSocket,
211
- body: Buffer
212
- ) => {
213
- const { headers, url } = message;
214
- addCfPreviewTokenHeader(headers, previewToken.value);
215
- headers["host"] = previewToken.host;
216
- const localWebsocket = new WebSocket(message, socket, body) as IWebsocket;
217
- // TODO(soon): Custom WebSocket protocol is not working?
218
- const remoteWebsocketClient = new WebSocket.Client(
219
- `wss://${previewToken.host}${url}`,
220
- [],
221
- { headers }
222
- ) as IWebsocket;
223
- localWebsocket.pipe(remoteWebsocketClient).pipe(localWebsocket);
224
- // We close down websockets whenever we refresh the token.
225
- cleanupListeners.push(() => {
226
- localWebsocket.close();
227
- remoteWebsocketClient.close();
228
- });
229
- };
230
- proxy.on("upgrade", handleUpgrade);
231
- cleanupListeners.push(() => proxy.off("upgrade", handleUpgrade));
232
-
233
- return () => {
234
- cleanupListeners.forEach((cleanup) => cleanup());
235
- };
236
- }, [
237
- previewToken,
238
- publicRoot,
239
- port,
240
- proxy,
241
- // We use a state value as a sigil to trigger reconnecting the server.
242
- // It's not used inside the effect, so react-hooks/exhaustive-deps
243
- // doesn't complain if it's not included in the dependency array.
244
- // But its presence is critical, so Do NOT remove it from the dependency list.
245
- retryServerSetupSigil,
246
- ]);
247
-
248
- // Start/stop the server whenever the
249
- // containing component is mounted/unmounted.
250
- useEffect(() => {
251
- waitForPortToBeAvailable(port, { retryPeriod: 200, timeout: 2000 })
252
- .then(() => {
253
- proxy.listen(port);
254
- console.log(`⬣ Listening at http://localhost:${port}`);
255
- })
256
- .catch((err) => {
257
- console.error(`⬣ Failed to start server: ${err}`);
258
- });
259
-
260
- return () => {
261
- proxy.close();
262
- };
263
- }, [port, proxy]);
204
+ /** Creates an HTTP/1 proxy that sends requests over HTTP/2. */
205
+ const [proxy, setProxy] = useState<PreviewProxy>();
206
+
207
+ /**
208
+ * Create the instance of the local proxy server that will pass on
209
+ * requests to the preview worker.
210
+ */
211
+ useEffect(() => {
212
+ if (proxy === undefined) {
213
+ createProxyServer(localProtocol)
214
+ .then((server) => {
215
+ setProxy({
216
+ server,
217
+ terminator: createHttpTerminator({
218
+ server,
219
+ gracefulTerminationTimeout: 0,
220
+ }),
221
+ });
222
+ })
223
+ .catch(async (err) => {
224
+ logger.error("Failed to create proxy server:", err);
225
+ });
226
+ }
227
+ }, [proxy, localProtocol]);
228
+
229
+ /**
230
+ * When we're not connected / getting a fresh token on changes,
231
+ * we'd like to buffer streams/requests until we're connected.
232
+ * Once connected, we can flush the buffered streams/requests.
233
+ * streamBufferRef is used to buffer http/2 streams, while
234
+ * requestResponseBufferRef is used to buffer http/1 requests.
235
+ */
236
+ const streamBufferRef = useRef<
237
+ { stream: ServerHttp2Stream; headers: IncomingHttpHeaders }[]
238
+ >([]);
239
+ const requestResponseBufferRef = useRef<
240
+ { request: IncomingMessage; response: ServerResponse }[]
241
+ >([]);
242
+ const accessTokenRef = useRef<string | undefined | null>(undefined);
243
+
244
+ /**
245
+ * The session doesn't last forever, and will eventually drop
246
+ * (usually within 5-15 minutes). When that happens, we simply
247
+ * restart the effect, effectively restarting the server. We use
248
+ * a state sigil as an effect dependency to do so.
249
+ */
250
+ const [retryServerSetupSigil, setRetryServerSetupSigil] = useState<number>(0);
251
+ function retryServerSetup() {
252
+ setRetryServerSetupSigil((x) => x + 1);
253
+ }
254
+
255
+ useEffect(() => {
256
+ const cleanupListeners = configureProxyServer({
257
+ proxy,
258
+ previewToken,
259
+ streamBufferRef,
260
+ requestResponseBufferRef,
261
+ retryServerSetup,
262
+ assetDirectory,
263
+ localProtocol,
264
+ port,
265
+ accessTokenRef,
266
+ });
267
+ return () => {
268
+ cleanupListeners?.forEach((cleanup) => cleanup());
269
+ };
270
+ }, [
271
+ previewToken,
272
+ assetDirectory,
273
+ port,
274
+ localProtocol,
275
+ proxy,
276
+ // We use a state value as a sigil to trigger reconnecting the server.
277
+ // It's not used inside the effect, so react-hooks/exhaustive-deps
278
+ // doesn't complain if it's not included in the dependency array.
279
+ // But its presence is critical, so Do NOT remove it from the dependency list.
280
+ retryServerSetupSigil,
281
+ ]);
282
+
283
+ // Start/stop the server whenever the
284
+ // containing component is mounted/unmounted.
285
+ useEffect(() => {
286
+ const abortController = new AbortController();
287
+ if (proxy === undefined) {
288
+ return;
289
+ }
290
+
291
+ waitForPortToBeAvailable(port, {
292
+ retryPeriod: 200,
293
+ timeout: 2000,
294
+ abortSignal: abortController.signal,
295
+ })
296
+ .then(() => {
297
+ proxy.server.on("listening", () => {
298
+ const address = proxy.server.address();
299
+ const usedPort =
300
+ address && typeof address === "object" ? address.port : port;
301
+ logger.log(`⬣ Listening at ${localProtocol}://${ip}:${usedPort}`);
302
+ const accessibleHosts =
303
+ ip !== "0.0.0.0" ? [ip] : getAccessibleHosts();
304
+ for (const accessibleHost of accessibleHosts) {
305
+ logger.log(`- ${localProtocol}://${accessibleHost}:${usedPort}`);
306
+ }
307
+ });
308
+ proxy.server.listen(port, ip);
309
+ })
310
+ .catch((err) => {
311
+ if ((err as { code: string }).code !== "ABORT_ERR") {
312
+ logger.error(`Failed to start server: ${err}`);
313
+ }
314
+ });
315
+
316
+ return () => {
317
+ abortController.abort();
318
+ // Running `proxy.server.close()` does not close open connections, preventing the process from exiting.
319
+ // So we use this `terminator` to close all the connections and force the server to shutdown.
320
+ proxy.terminator
321
+ .terminate()
322
+ .catch(() => logger.error("Failed to terminate the proxy server."));
323
+ };
324
+ }, [port, ip, proxy, localProtocol]);
325
+ }
326
+
327
+ function configureProxyServer({
328
+ proxy,
329
+ previewToken,
330
+ streamBufferRef,
331
+ requestResponseBufferRef,
332
+ retryServerSetup,
333
+ port,
334
+ localProtocol,
335
+ assetDirectory,
336
+ accessTokenRef,
337
+ }: {
338
+ proxy: PreviewProxy | undefined;
339
+ previewToken: CfPreviewToken | undefined;
340
+ // normally the type of streamBufferRef should be
341
+ // React.MutableRefObject<T>, but we don't want to require react
342
+ streamBufferRef: {
343
+ current: { stream: ServerHttp2Stream; headers: IncomingHttpHeaders }[];
344
+ };
345
+ // normally the type of requestResponseBufferRef should be
346
+ // React.MutableRefObject<T>, but we don't want to require react
347
+ requestResponseBufferRef: {
348
+ current: { request: IncomingMessage; response: ServerResponse }[];
349
+ };
350
+ retryServerSetup: () => void;
351
+ port: number;
352
+ localProtocol: "https" | "http";
353
+ assetDirectory: string | undefined;
354
+ accessTokenRef: { current: string | null | undefined };
355
+ }) {
356
+ if (proxy === undefined) {
357
+ return;
358
+ }
359
+
360
+ // If we don't have a token, that means either we're just starting up,
361
+ // or we're refreshing the token.
362
+ if (!previewToken) {
363
+ const cleanupListeners: (() => void)[] = [];
364
+ const bufferStream = (
365
+ stream: ServerHttp2Stream,
366
+ headers: IncomingHttpHeaders
367
+ ) => {
368
+ // store the stream in a buffer so we can replay it later
369
+ streamBufferRef.current.push({ stream, headers });
370
+ };
371
+ proxy.server.on("stream", bufferStream);
372
+ cleanupListeners.push(() => proxy.server.off("stream", bufferStream));
373
+
374
+ const bufferRequestResponse = (
375
+ request: IncomingMessage,
376
+ response: ServerResponse
377
+ ) => {
378
+ // store the request and response in a buffer so we can replay it later
379
+ requestResponseBufferRef.current.push({ request, response });
380
+ };
381
+
382
+ proxy.server.on("request", bufferRequestResponse);
383
+ cleanupListeners.push(() =>
384
+ proxy.server.off("request", bufferRequestResponse)
385
+ );
386
+ return cleanupListeners;
387
+ }
388
+
389
+ // We have a token. Let's proxy requests to the preview end point.
390
+ const cleanupListeners: (() => void)[] = [];
391
+
392
+ // create a ClientHttp2Session
393
+ logger.debug("PREVIEW URL:", `https://${previewToken.host}`);
394
+ const remote = connect(`https://${previewToken.host}`);
395
+ cleanupListeners.push(() => remote.destroy());
396
+
397
+ // As mentioned above, the session may die at any point,
398
+ // so we need to restart the effect.
399
+ remote.on("close", retryServerSetup);
400
+ cleanupListeners.push(() => remote.off("close", retryServerSetup));
401
+
402
+ /** HTTP/2 -> HTTP/2 */
403
+ const handleStream = createStreamHandler(
404
+ previewToken,
405
+ remote,
406
+ port,
407
+ localProtocol,
408
+ accessTokenRef
409
+ );
410
+ proxy.server.on("stream", handleStream);
411
+ cleanupListeners.push(() => proxy.server.off("stream", handleStream));
412
+
413
+ // flush and replay buffered streams
414
+ streamBufferRef.current.forEach(
415
+ (buffer: { stream: ServerHttp2Stream; headers: IncomingHttpHeaders }) =>
416
+ handleStream(buffer.stream, buffer.headers)
417
+ );
418
+ streamBufferRef.current = [];
419
+
420
+ /** HTTP/1 -> HTTP/2 */
421
+ const handleRequest: RequestListener = async (
422
+ message: IncomingMessage,
423
+ response: ServerResponse
424
+ ) => {
425
+ const { httpVersionMajor, headers, method, url } = message;
426
+ if (httpVersionMajor >= 2) {
427
+ return; // Already handled by the "stream" event.
428
+ }
429
+ await addCfAccessToken(headers, previewToken.host, accessTokenRef);
430
+ addCfPreviewTokenHeader(headers, previewToken.value);
431
+ headers[":method"] = method;
432
+ headers[":path"] = url;
433
+ headers[":authority"] = previewToken.host;
434
+ headers[":scheme"] = "https";
435
+ for (const name of Object.keys(headers)) {
436
+ if (HTTP1_HEADERS.has(name.toLowerCase())) {
437
+ delete headers[name];
438
+ }
439
+ }
440
+ const request = message.pipe(remote.request(headers));
441
+ logger.debug(
442
+ "WORKER REQUEST",
443
+ new Date().toLocaleTimeString(),
444
+ method,
445
+ url
446
+ );
447
+ logger.debug("HEADERS", JSON.stringify(headers, null, 2));
448
+ logger.debug("PREVIEW TOKEN", previewToken);
449
+
450
+ request.on("response", (responseHeaders) => {
451
+ const status = responseHeaders[":status"] ?? 500;
452
+ // log all requests to terminal
453
+ logger.log(new Date().toLocaleTimeString(), method, url, status);
454
+
455
+ rewriteRemoteHostToLocalHostInHeaders(
456
+ responseHeaders,
457
+ previewToken.host,
458
+ port,
459
+ localProtocol
460
+ );
461
+ for (const name of Object.keys(responseHeaders)) {
462
+ if (name.startsWith(":")) {
463
+ delete responseHeaders[name];
464
+ }
465
+ }
466
+ response.writeHead(status, responseHeaders);
467
+ request.pipe(response, { end: true });
468
+ });
469
+ };
470
+
471
+ // If an asset path is defined, check the file system
472
+ // for a file first and serve if it exists.
473
+ const actualHandleRequest = assetDirectory
474
+ ? createHandleAssetsRequest(assetDirectory, handleRequest)
475
+ : handleRequest;
476
+
477
+ proxy.server.on("request", actualHandleRequest);
478
+ cleanupListeners.push(() => proxy.server.off("request", actualHandleRequest));
479
+
480
+ // flush and replay buffered requests
481
+ requestResponseBufferRef.current.forEach(
482
+ ({
483
+ request,
484
+ response,
485
+ }: {
486
+ request: IncomingMessage;
487
+ response: ServerResponse;
488
+ }) => actualHandleRequest(request, response)
489
+ );
490
+ requestResponseBufferRef.current = [];
491
+
492
+ /** HTTP/1 -> WebSocket (over HTTP/1) */
493
+ const handleUpgrade = async (
494
+ originalMessage: IncomingMessage,
495
+ originalSocket: Duplex,
496
+ originalHead: Buffer
497
+ ) => {
498
+ const { headers, method, url } = originalMessage;
499
+ await addCfAccessToken(headers, previewToken.host, accessTokenRef);
500
+ addCfPreviewTokenHeader(headers, previewToken.value);
501
+ headers["host"] = previewToken.host;
502
+
503
+ if (originalHead?.byteLength) originalSocket.unshift(originalHead);
504
+
505
+ const runtimeRequest = https.request(
506
+ {
507
+ hostname: previewToken.host,
508
+ path: url,
509
+ method,
510
+ headers,
511
+ },
512
+ (runtimeResponse) => {
513
+ if (!(runtimeResponse as { upgrade?: boolean }).upgrade) {
514
+ writeHead(originalSocket, runtimeResponse);
515
+ runtimeResponse.pipe(originalSocket);
516
+ }
517
+ }
518
+ );
519
+
520
+ runtimeRequest.on(
521
+ "upgrade",
522
+ (runtimeResponse, runtimeSocket, runtimeHead) => {
523
+ if (runtimeHead?.byteLength) runtimeSocket.unshift(runtimeHead);
524
+ writeHead(originalSocket, {
525
+ httpVersion: "1.1",
526
+ statusCode: 101,
527
+ statusMessage: "Switching Protocols",
528
+ headers: runtimeResponse.headers,
529
+ });
530
+ runtimeSocket.pipe(originalSocket).pipe(runtimeSocket);
531
+ }
532
+ );
533
+ originalMessage.pipe(runtimeRequest);
534
+ };
535
+
536
+ proxy.server.on("upgrade", handleUpgrade);
537
+ cleanupListeners.push(() => proxy.server.off("upgrade", handleUpgrade));
538
+ return cleanupListeners;
264
539
  }
265
540
 
266
541
  function createHandleAssetsRequest(
267
- assetPath: string,
268
- handleRequest: RequestListener
542
+ assetDirectory: string,
543
+ handleRequest: RequestListener
269
544
  ) {
270
- const handleAsset = serveStatic(assetPath, {
271
- cacheControl: false,
272
- });
273
- return (request: IncomingMessage, response: ServerResponse) => {
274
- handleAsset(request, response, () => {
275
- handleRequest(request, response);
276
- });
277
- };
545
+ const handleAsset = serveStatic(assetDirectory, {
546
+ cacheControl: false,
547
+ });
548
+ return (request: IncomingMessage, response: ServerResponse) => {
549
+ handleAsset(request, response, () => {
550
+ handleRequest(request, response);
551
+ });
552
+ };
278
553
  }
279
554
 
280
555
  /** A Set of headers we want to remove from HTTP/1 requests. */
281
556
  const HTTP1_HEADERS = new Set([
282
- "host",
283
- "connection",
284
- "upgrade",
285
- "keep-alive",
286
- "proxy-connection",
287
- "transfer-encoding",
288
- "http2-settings",
557
+ "host",
558
+ "connection",
559
+ "upgrade",
560
+ "keep-alive",
561
+ "proxy-connection",
562
+ "transfer-encoding",
563
+ "http2-settings",
289
564
  ]);
290
565
 
291
- function createProxyServer() {
292
- return createServer()
293
- .on("request", function (req, res) {
294
- // log all requests
295
- console.log(
296
- new Date().toLocaleTimeString(),
297
- req.method,
298
- req.url,
299
- res.statusCode
300
- );
301
- })
302
- .on("upgrade", (req) => {
303
- // log all websocket connections
304
- console.log(
305
- new Date().toLocaleTimeString(),
306
- req.method,
307
- req.url,
308
- 101,
309
- "(WebSocket)"
310
- );
311
- })
312
- .on("error", (err) => {
313
- // log all connection errors
314
- console.error(new Date().toLocaleTimeString(), err);
315
- });
566
+ async function createProxyServer(
567
+ localProtocol: "https" | "http"
568
+ ): Promise<HttpServer | HttpsServer> {
569
+ const server: HttpServer | HttpsServer =
570
+ localProtocol === "https"
571
+ ? createHttpsServer(await getHttpsOptions())
572
+ : createHttpServer();
573
+
574
+ return server
575
+ .on("upgrade", (req) => {
576
+ // log all websocket connections
577
+ logger.log(
578
+ new Date().toLocaleTimeString(),
579
+ req.method,
580
+ req.url,
581
+ 101,
582
+ "(WebSocket)"
583
+ );
584
+ })
585
+ .on("error", (err) => {
586
+ // log all connection errors
587
+ logger.error(new Date().toLocaleTimeString(), err);
588
+ });
316
589
  }
317
590
 
318
591
  function createStreamHandler(
319
- previewToken: CfPreviewToken,
320
- remote: ClientHttp2Session,
321
- port: number
592
+ previewToken: CfPreviewToken,
593
+ remote: ClientHttp2Session,
594
+ localPort: number,
595
+ localProtocol: "https" | "http",
596
+ accessTokenRef: { current: string | undefined | null }
322
597
  ) {
323
- return function handleStream(
324
- stream: ServerHttp2Stream,
325
- headers: IncomingHttpHeaders
326
- ) {
327
- addCfPreviewTokenHeader(headers, previewToken.value);
328
- headers[":authority"] = previewToken.host;
329
- const request = stream.pipe(remote.request(headers));
330
- request.on("response", (responseHeaders: IncomingHttpHeaders) => {
331
- rewriteRemoteHostToLocalHostInHeaders(
332
- responseHeaders,
333
- previewToken.host,
334
- port
335
- );
336
- stream.respond(responseHeaders);
337
- request.pipe(stream, { end: true });
338
- });
339
- };
598
+ return async function handleStream(
599
+ stream: ServerHttp2Stream,
600
+ headers: IncomingHttpHeaders
601
+ ) {
602
+ await addCfAccessToken(headers, previewToken.host, accessTokenRef);
603
+ addCfPreviewTokenHeader(headers, previewToken.value);
604
+ headers[":authority"] = previewToken.host;
605
+ const request = stream.pipe(remote.request(headers));
606
+ request.on("response", (responseHeaders: IncomingHttpHeaders) => {
607
+ rewriteRemoteHostToLocalHostInHeaders(
608
+ responseHeaders,
609
+ previewToken.host,
610
+ localPort,
611
+ localProtocol
612
+ );
613
+ stream.respond(responseHeaders);
614
+ request.pipe(stream, { end: true });
615
+ });
616
+ };
340
617
  }
341
618
 
342
619
  /**
343
620
  * A helper function that waits for a port to be available.
344
621
  */
345
622
  export async function waitForPortToBeAvailable(
346
- port: number,
347
- options: { retryPeriod: number; timeout: number }
623
+ port: number,
624
+ options: { retryPeriod: number; timeout: number; abortSignal: AbortSignal }
348
625
  ): Promise<void> {
349
- return new Promise((resolve, reject) => {
350
- const timeout = setTimeout(() => {
351
- reject(new Error(`Timed out waiting for port ${port}`));
352
- }, options.timeout);
353
-
354
- function checkPort() {
355
- // Testing whether a port is 'available' involves simply
356
- // trying to make a server listen on that port, and retrying
357
- // until it succeeds.
358
- const server = createServer();
359
- server.on("error", (err) => {
360
- // @ts-expect-error non standard property on Error
361
- if (err.code === "EADDRINUSE") {
362
- setTimeout(checkPort, options.retryPeriod);
363
- } else {
364
- reject(err);
365
- }
366
- });
367
- server.listen(port, () => {
368
- server.close();
369
- clearTimeout(timeout);
370
- resolve();
371
- });
372
- }
373
-
374
- checkPort();
375
- });
626
+ return new Promise((resolve, reject) => {
627
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
628
+ options.abortSignal.addEventListener("abort", () => {
629
+ const abortError = new Error("waitForPortToBeAvailable() aborted");
630
+ (abortError as Error & { code: string }).code = "ABORT_ERR";
631
+ doReject(abortError);
632
+ });
633
+
634
+ const timeout = setTimeout(() => {
635
+ doReject(new Error(`Timed out waiting for port ${port}`));
636
+ }, options.timeout);
637
+
638
+ const interval = setInterval(checkPort, options.retryPeriod);
639
+ checkPort();
640
+
641
+ function doResolve() {
642
+ clearTimeout(timeout);
643
+ clearInterval(interval);
644
+ resolve();
645
+ }
646
+
647
+ function doReject(err: unknown) {
648
+ clearInterval(interval);
649
+ clearTimeout(timeout);
650
+ reject(err);
651
+ }
652
+
653
+ function checkPort() {
654
+ if (port === 0) {
655
+ doResolve();
656
+ return;
657
+ }
658
+
659
+ // Testing whether a port is 'available' involves simply
660
+ // trying to make a server listen on that port, and retrying
661
+ // until it succeeds.
662
+ const server = createHttpServer();
663
+ const terminator = createHttpTerminator({
664
+ server,
665
+ gracefulTerminationTimeout: 0, // default 1000
666
+ });
667
+
668
+ server.on("error", (err) => {
669
+ // @ts-expect-error non standard property on Error
670
+ if (err.code !== "EADDRINUSE") {
671
+ doReject(err);
672
+ }
673
+ });
674
+ server.listen(port, () =>
675
+ terminator
676
+ .terminate()
677
+ .then(doResolve, () =>
678
+ logger.error("Failed to terminate the port checker.")
679
+ )
680
+ );
681
+ }
682
+ });
683
+ }
684
+
685
+ function getAccessibleHosts(): string[] {
686
+ const hosts: string[] = [];
687
+ Object.values(networkInterfaces()).forEach((net) => {
688
+ net?.forEach(({ family, address }) => {
689
+ // @ts-expect-error the `family` property is numeric as of Node.js 18.0.0
690
+ if (family === "IPv4" || family === 4) hosts.push(address);
691
+ });
692
+ });
693
+ return hosts;
376
694
  }