wrangler 0.0.0-e492c10 → 0.0.0-e4ca780f

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 (360) hide show
  1. package/Cloudflare_CA.pem +18 -0
  2. package/README.md +25 -5
  3. package/bin/wrangler.js +174 -34
  4. package/kv-asset-handler.js +1 -0
  5. package/miniflare-dist/index.mjs +1590 -81
  6. package/package.json +198 -149
  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.ts +121 -0
  10. package/src/__tests__/api.test.ts +102 -0
  11. package/src/__tests__/config-cache-without-cache-dir.test.ts +38 -0
  12. package/src/__tests__/config-cache.test.ts +30 -24
  13. package/src/__tests__/configuration.test.ts +4498 -3114
  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 +1592 -802
  21. package/src/__tests__/generate.test.ts +237 -0
  22. package/src/__tests__/get-host-from-url.test.ts +16 -0
  23. package/src/__tests__/guess-worker-format.test.ts +103 -68
  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 +24 -24
  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 +64 -39
  30. package/src/__tests__/helpers/mock-dialogs.ts +104 -55
  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 +30 -30
  34. package/src/__tests__/helpers/mock-istty.ts +65 -18
  35. package/src/__tests__/helpers/mock-known-routes.ts +12 -0
  36. package/src/__tests__/helpers/mock-kv.ts +41 -28
  37. package/src/__tests__/helpers/mock-oauth-flow.ts +241 -233
  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 +27 -28
  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 +16 -16
  62. package/src/__tests__/helpers/write-wrangler-toml.ts +9 -9
  63. package/src/__tests__/https-options.test.ts +142 -109
  64. package/src/__tests__/index.test.ts +262 -224
  65. package/src/__tests__/init.test.ts +3168 -1488
  66. package/src/__tests__/jest.setup.ts +152 -50
  67. package/src/__tests__/kv.test.ts +1789 -1432
  68. package/src/__tests__/logger.test.ts +167 -75
  69. package/src/__tests__/logout.test.ts +47 -0
  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 +2864 -0
  82. package/src/__tests__/pages-deployment-tail.test.ts +955 -0
  83. package/src/__tests__/parse.test.ts +358 -248
  84. package/src/__tests__/paths.test.ts +39 -0
  85. package/src/__tests__/publish.test.ts +8322 -4847
  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 -205
  89. package/src/__tests__/route.test.ts +18 -18
  90. package/src/__tests__/secret.test.ts +683 -436
  91. package/src/__tests__/tail.test.ts +835 -567
  92. package/src/__tests__/test-old-node-version.js +31 -0
  93. package/src/__tests__/traverse-module-graph.test.ts +220 -0
  94. package/src/__tests__/tsconfig-sanity.ts +12 -0
  95. package/src/__tests__/tsconfig.json +8 -0
  96. package/src/__tests__/tsconfig.tsbuildinfo +1 -0
  97. package/src/__tests__/type-generation.test.ts +234 -0
  98. package/src/__tests__/user.test.ts +107 -120
  99. package/src/__tests__/utils-collectKeyValues.test.ts +47 -0
  100. package/src/__tests__/validate-dev-props.test.ts +56 -0
  101. package/src/__tests__/version.test.ts +35 -0
  102. package/src/__tests__/whoami.test.tsx +165 -98
  103. package/src/__tests__/worker-namespace.test.ts +340 -0
  104. package/src/abort.d.ts +3 -0
  105. package/src/api/dev.ts +316 -0
  106. package/src/api/index.ts +11 -0
  107. package/src/api/mtls-certificate.ts +148 -0
  108. package/src/api/pages/create-worker-bundle-contents.ts +76 -0
  109. package/src/api/pages/index.ts +5 -0
  110. package/src/api/pages/publish.tsx +355 -0
  111. package/src/bundle-reporter.ts +68 -0
  112. package/src/bundle.ts +874 -135
  113. package/src/cfetch/index.ts +123 -69
  114. package/src/cfetch/internal.ts +217 -96
  115. package/src/cli.ts +23 -8
  116. package/src/config/config.ts +244 -196
  117. package/src/config/diagnostics.ts +61 -61
  118. package/src/config/environment.ts +563 -339
  119. package/src/config/index.ts +381 -41
  120. package/src/config/validation-helpers.ts +379 -357
  121. package/src/config/validation.ts +2181 -1263
  122. package/src/config-cache.ts +81 -41
  123. package/src/create-worker-preview.ts +250 -132
  124. package/src/create-worker-upload-form.ts +343 -224
  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 +20 -17
  147. package/src/dev/dev.tsx +535 -353
  148. package/src/dev/get-local-persistence-path.ts +31 -0
  149. package/src/dev/local.tsx +900 -292
  150. package/src/dev/remote.tsx +620 -201
  151. package/src/dev/start-server.ts +534 -0
  152. package/src/dev/use-esbuild.ts +182 -97
  153. package/src/dev/validate-dev-props.ts +40 -0
  154. package/src/dev-registry.ts +202 -0
  155. package/src/dev.tsx +929 -0
  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 +259 -189
  161. package/src/environment-variables/factory.ts +88 -0
  162. package/src/environment-variables/misc-variables.ts +30 -0
  163. package/src/errors.ts +6 -6
  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 +84 -80
  168. package/src/index.ts +758 -0
  169. package/src/init.ts +1032 -0
  170. package/src/inspect.ts +721 -562
  171. package/src/intl-polyfill.d.ts +123 -123
  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 +96 -43
  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/assets.ts +251 -0
  184. package/src/miniflare-cli/index.ts +202 -33
  185. package/src/miniflare-cli/request-context.ts +18 -18
  186. package/src/miniflare-cli/tsconfig.json +9 -0
  187. package/src/miniflare-cli/tsconfig.tsbuildinfo +1 -0
  188. package/src/miniflare-cli/types.ts +11 -0
  189. package/src/module-collection.ts +290 -215
  190. package/src/mtls-certificate/cli.ts +155 -0
  191. package/src/open-in-browser.ts +5 -14
  192. package/src/package-manager.ts +182 -90
  193. package/src/pages/build.ts +410 -0
  194. package/src/pages/buildFunctions.ts +140 -0
  195. package/src/pages/constants.ts +18 -0
  196. package/src/pages/deployment-tails.ts +281 -0
  197. package/src/pages/deployments.tsx +84 -0
  198. package/src/pages/dev.ts +716 -0
  199. package/src/pages/errors.ts +67 -0
  200. package/src/pages/functions/buildPlugin.ts +113 -0
  201. package/src/pages/functions/buildWorker.ts +291 -0
  202. package/{pages → src/pages}/functions/filepath-routing.test.ts +113 -113
  203. package/src/pages/functions/filepath-routing.ts +189 -0
  204. package/src/pages/functions/identifiers.ts +78 -0
  205. package/src/pages/functions/routes-consolidation.test.ts +250 -0
  206. package/src/pages/functions/routes-consolidation.ts +73 -0
  207. package/src/pages/functions/routes-transformation.test.ts +282 -0
  208. package/src/pages/functions/routes-transformation.ts +115 -0
  209. package/src/pages/functions/routes-validation.test.ts +403 -0
  210. package/src/pages/functions/routes-validation.ts +202 -0
  211. package/src/pages/functions/routes.ts +151 -0
  212. package/src/pages/functions/tsconfig.json +8 -0
  213. package/src/pages/functions/tsconfig.tsbuildinfo +1 -0
  214. package/src/pages/functions.ts +86 -0
  215. package/src/pages/hash.ts +13 -0
  216. package/src/pages/index.ts +102 -0
  217. package/src/pages/projects.tsx +159 -0
  218. package/src/pages/prompt-select-project.tsx +31 -0
  219. package/src/pages/publish.tsx +267 -0
  220. package/src/pages/types.ts +46 -0
  221. package/src/pages/upload.tsx +469 -0
  222. package/src/pages/utils.ts +23 -0
  223. package/src/parse.ts +246 -123
  224. package/src/paths.ts +53 -8
  225. package/src/proxy.ts +628 -383
  226. package/src/publish/index.ts +274 -0
  227. package/src/publish/publish.ts +1060 -0
  228. package/src/pubsub/index.ts +286 -0
  229. package/src/pubsub/pubsub-commands.ts +623 -0
  230. package/src/queues/cli/commands/consumer/add.ts +71 -0
  231. package/src/queues/cli/commands/consumer/index.ts +19 -0
  232. package/src/queues/cli/commands/consumer/remove.ts +31 -0
  233. package/src/queues/cli/commands/create.ts +25 -0
  234. package/src/queues/cli/commands/delete.ts +26 -0
  235. package/src/queues/cli/commands/index.ts +35 -0
  236. package/src/queues/cli/commands/list.ts +25 -0
  237. package/src/queues/client.ts +136 -0
  238. package/src/queues/utils.ts +18 -0
  239. package/src/r2/constants.ts +4 -0
  240. package/src/r2/helpers.ts +132 -0
  241. package/src/r2/index.ts +289 -0
  242. package/src/routes.ts +140 -0
  243. package/src/secret/index.ts +376 -0
  244. package/src/selfsigned.d.ts +23 -23
  245. package/src/sites.ts +372 -0
  246. package/src/tail/createTail.ts +406 -0
  247. package/src/tail/filters.ts +109 -111
  248. package/src/tail/index.ts +208 -296
  249. package/src/tail/printing.ts +101 -46
  250. package/src/traverse-module-graph.ts +53 -0
  251. package/src/tsconfig-sanity.ts +16 -0
  252. package/src/type-generation.ts +181 -0
  253. package/src/update-check.ts +11 -11
  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 +203 -101
  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 +1 -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 +1641 -0
  304. package/wrangler-dist/cli.js +129145 -89350
  305. package/wrangler-dist/wasm-sync.wasm +0 -0
  306. package/pages/functions/buildPlugin.ts +0 -92
  307. package/pages/functions/buildWorker.ts +0 -138
  308. package/pages/functions/filepath-routing.ts +0 -189
  309. package/pages/functions/identifiers.ts +0 -78
  310. package/pages/functions/routes.ts +0 -156
  311. package/pages/functions/template-plugin.ts +0 -146
  312. package/pages/functions/template-worker.ts +0 -143
  313. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  314. package/src/__tests__/helpers/mock-cfetch.ts +0 -211
  315. package/src/__tests__/pages.test.ts +0 -327
  316. package/src/dialogs.tsx +0 -87
  317. package/src/environment-variables.ts +0 -35
  318. package/src/index.tsx +0 -2698
  319. package/src/kv.ts +0 -319
  320. package/src/miniflare-cli/enum-keys.ts +0 -17
  321. package/src/pages.tsx +0 -1875
  322. package/src/publish.ts +0 -469
  323. package/src/r2.ts +0 -50
  324. package/src/sites.tsx +0 -293
  325. package/src/user.tsx +0 -1203
  326. package/src/whoami.tsx +0 -70
  327. package/templates/static-asset-facade.js +0 -47
  328. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  329. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  330. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  331. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  332. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  333. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  334. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  335. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  336. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  337. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  338. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  339. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  340. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  341. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  342. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  343. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  344. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  345. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  346. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  347. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  348. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  349. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  350. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  351. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  352. package/vendor/wrangler-mime/LICENSE +0 -21
  353. package/vendor/wrangler-mime/Mime.js +0 -97
  354. package/vendor/wrangler-mime/README.md +0 -187
  355. package/vendor/wrangler-mime/cli.js +0 -46
  356. package/vendor/wrangler-mime/index.js +0 -4
  357. package/vendor/wrangler-mime/lite.js +0 -4
  358. package/vendor/wrangler-mime/package.json +0 -52
  359. package/vendor/wrangler-mime/types/other.js +0 -1
  360. package/vendor/wrangler-mime/types/standard.js +0 -1
package/src/dev/dev.tsx CHANGED
@@ -1,280 +1,456 @@
1
1
  import { spawn } from "node:child_process";
2
+ import * as path from "node:path";
3
+ import * as util from "node:util";
2
4
  import { watch } from "chokidar";
3
5
  import clipboardy from "clipboardy";
4
6
  import commandExists from "command-exists";
5
7
  import { Box, Text, useApp, useInput, useStdin } from "ink";
6
- import React, { useState, useEffect, useRef } from "react";
8
+ import React, { useState, useEffect, useRef, useMemo } from "react";
7
9
  import { withErrorBoundary, useErrorHandler } from "react-error-boundary";
8
10
  import onExit from "signal-exit";
9
11
  import tmp from "tmp-promise";
10
12
  import { fetch } from "undici";
13
+ import {
14
+ getBoundRegisteredWorkers,
15
+ startWorkerRegistry,
16
+ stopWorkerRegistry,
17
+ unregisterWorker,
18
+ } from "../dev-registry";
11
19
  import { runCustomBuild } from "../entry";
20
+ import { openInspector } from "../inspect";
12
21
  import { logger } from "../logger";
13
22
  import openInBrowser from "../open-in-browser";
14
- import { getAPIToken } from "../user";
15
23
  import { Local } from "./local";
16
24
  import { Remote } from "./remote";
17
25
  import { useEsbuild } from "./use-esbuild";
26
+ import { validateDevProps } from "./validate-dev-props";
18
27
  import type { Config } from "../config";
28
+ import type { Route } from "../config/environment";
29
+ import type { WorkerRegistry } from "../dev-registry";
19
30
  import type { Entry } from "../entry";
31
+ import type { EnablePagesAssetsServiceBindingOptions } from "../miniflare-cli/types";
20
32
  import type { AssetPaths } from "../sites";
21
33
  import type { CfWorkerInit } from "../worker";
22
- import type { EsbuildBundle } from "./use-esbuild";
34
+
35
+ /**
36
+ * This hooks establishes a connection with the dev registry,
37
+ * and periodically updates itself with details of workers currently
38
+ * running a dev session on this system.
39
+ */
40
+ function useDevRegistry(
41
+ name: string | undefined,
42
+ services: Config["services"] | undefined,
43
+ durableObjects: Config["durable_objects"] | undefined,
44
+ mode: "local" | "remote"
45
+ ): WorkerRegistry {
46
+ const [workers, setWorkers] = useState<WorkerRegistry>({});
47
+
48
+ useEffect(() => {
49
+ // Let's try to start registry
50
+ // TODO: we should probably call this in a loop
51
+ // in case the registry dies elsewhere
52
+ startWorkerRegistry().catch((err) => {
53
+ logger.error("failed to start worker registry", err);
54
+ });
55
+
56
+ const interval =
57
+ // TODO: enable this for remote mode as well
58
+ // https://github.com/cloudflare/workers-sdk/issues/1182
59
+ mode === "local"
60
+ ? setInterval(() => {
61
+ getBoundRegisteredWorkers({
62
+ services,
63
+ durableObjects,
64
+ }).then(
65
+ (boundRegisteredWorkers: WorkerRegistry | undefined) => {
66
+ setWorkers((prevWorkers) => {
67
+ if (
68
+ !util.isDeepStrictEqual(boundRegisteredWorkers, prevWorkers)
69
+ ) {
70
+ return boundRegisteredWorkers || {};
71
+ }
72
+ return prevWorkers;
73
+ });
74
+ },
75
+ (err) => {
76
+ logger.warn("Failed to get worker definitions", err);
77
+ }
78
+ );
79
+ }, 300)
80
+ : undefined;
81
+
82
+ return () => {
83
+ interval && clearInterval(interval);
84
+ Promise.allSettled([
85
+ name ? unregisterWorker(name) : Promise.resolve(),
86
+ stopWorkerRegistry(),
87
+ ]).then(
88
+ ([unregisterResult, stopRegistryResult]) => {
89
+ if (unregisterResult.status === "rejected") {
90
+ logger.error(
91
+ "Failed to unregister worker",
92
+ unregisterResult.reason
93
+ );
94
+ }
95
+ if (stopRegistryResult.status === "rejected") {
96
+ logger.error(
97
+ "Failed to stop worker registry",
98
+ stopRegistryResult.reason
99
+ );
100
+ }
101
+ },
102
+ (err) => {
103
+ logger.error("Failed to clear dev registry effect", err);
104
+ }
105
+ );
106
+ };
107
+ }, [name, services, durableObjects, mode]);
108
+
109
+ return workers;
110
+ }
23
111
 
24
112
  export type DevProps = {
25
- name?: string;
26
- entry: Entry;
27
- port: number;
28
- ip: string;
29
- inspectorPort: number;
30
- rules: Config["rules"];
31
- accountId: string | undefined;
32
- initialMode: "local" | "remote";
33
- jsxFactory: string | undefined;
34
- jsxFragment: string | undefined;
35
- tsconfig: string | undefined;
36
- upstreamProtocol: "https" | "http";
37
- localProtocol: "https" | "http";
38
- enableLocalPersistence: boolean;
39
- bindings: CfWorkerInit["bindings"];
40
- crons: Config["triggers"]["crons"];
41
- public: string | undefined;
42
- assetPaths: AssetPaths | undefined;
43
- compatibilityDate: string;
44
- compatibilityFlags: string[] | undefined;
45
- usageModel: "bundled" | "unbound" | undefined;
46
- minify: boolean | undefined;
47
- nodeCompat: boolean | undefined;
48
- build: {
49
- command?: string | undefined;
50
- cwd?: string | undefined;
51
- watch_dir?: string | undefined;
52
- };
53
- env: string | undefined;
54
- legacyEnv: boolean;
55
- zone:
56
- | {
57
- id: string;
58
- host: string;
59
- }
60
- | undefined;
113
+ name: string | undefined;
114
+ noBundle: boolean;
115
+ entry: Entry;
116
+ initialPort: number;
117
+ initialIp: string;
118
+ inspectorPort: number;
119
+ rules: Config["rules"];
120
+ accountId: string | undefined;
121
+ initialMode: "local" | "remote";
122
+ jsxFactory: string | undefined;
123
+ jsxFragment: string | undefined;
124
+ tsconfig: string | undefined;
125
+ upstreamProtocol: "https" | "http";
126
+ localProtocol: "https" | "http";
127
+ localUpstream: string | undefined;
128
+ localPersistencePath: string | null;
129
+ liveReload: boolean;
130
+ bindings: CfWorkerInit["bindings"];
131
+ define: Config["define"];
132
+ crons: Config["triggers"]["crons"];
133
+ queueConsumers: Config["queues"]["consumers"];
134
+ isWorkersSite: boolean;
135
+ assetPaths: AssetPaths | undefined;
136
+ assetsConfig: Config["assets"];
137
+ compatibilityDate: string;
138
+ compatibilityFlags: string[] | undefined;
139
+ usageModel: "bundled" | "unbound" | undefined;
140
+ minify: boolean | undefined;
141
+ legacyNodeCompat: boolean | undefined;
142
+ nodejsCompat: boolean | undefined;
143
+ build: Config["build"];
144
+ env: string | undefined;
145
+ legacyEnv: boolean;
146
+ zone: string | undefined;
147
+ host: string | undefined;
148
+ routes: Route[] | undefined;
149
+ inspect: boolean;
150
+ onReady: ((ip: string, port: number) => void) | undefined;
151
+ showInteractiveDevSession: boolean | undefined;
152
+ forceLocal: boolean | undefined;
153
+ enablePagesAssetsServiceBinding?: EnablePagesAssetsServiceBindingOptions;
154
+ firstPartyWorker: boolean | undefined;
155
+ sendMetrics: boolean | undefined;
156
+ testScheduled: boolean | undefined;
157
+ experimentalLocal: boolean | undefined;
158
+ experimentalLocalRemoteKv: boolean | undefined;
61
159
  };
62
160
 
63
161
  export function DevImplementation(props: DevProps): JSX.Element {
64
- const apiToken = props.initialMode === "remote" ? getAPIToken() : undefined;
65
- const directory = useTmpDir();
66
-
67
- useCustomBuild(props.entry, props.build);
68
-
69
- if (props.public && props.entry.format === "service-worker") {
70
- throw new Error(
71
- "You cannot use the service-worker format with a `public` directory."
72
- );
73
- }
74
-
75
- if (props.bindings.wasm_modules && props.entry.format === "modules") {
76
- throw new Error(
77
- "You cannot configure [wasm_modules] with an ES module worker. Instead, import the .wasm module directly in your code"
78
- );
79
- }
80
-
81
- if (props.bindings.text_blobs && props.entry.format === "modules") {
82
- throw new Error(
83
- "You cannot configure [text_blobs] with an ES module worker. Instead, import the file directly in your code, and optionally configure `[rules]` in your wrangler.toml"
84
- );
85
- }
86
-
87
- if (props.bindings.data_blobs && props.entry.format === "modules") {
88
- throw new Error(
89
- "You cannot configure [data_blobs] with an ES module worker. Instead, import the file directly in your code, and optionally configure `[rules]` in your wrangler.toml"
90
- );
91
- }
92
-
93
- const bundle = useEsbuild({
94
- entry: props.entry,
95
- destination: directory,
96
- staticRoot: props.public,
97
- jsxFactory: props.jsxFactory,
98
- rules: props.rules,
99
- jsxFragment: props.jsxFragment,
100
- serveAssetsFromWorker: !!props.public,
101
- tsconfig: props.tsconfig,
102
- minify: props.minify,
103
- nodeCompat: props.nodeCompat,
104
- });
105
-
106
- // only load the UI if we're running in a supported environment
107
- const { isRawModeSupported } = useStdin();
108
- return isRawModeSupported ? (
109
- <InteractiveDevSession {...props} bundle={bundle} apiToken={apiToken} />
110
- ) : (
111
- <DevSession
112
- {...props}
113
- bundle={bundle}
114
- apiToken={apiToken}
115
- local={props.initialMode === "local"}
116
- />
117
- );
162
+ validateDevProps(props);
163
+
164
+ // only load the UI if we're running in a supported environment
165
+ const { isRawModeSupported } = useStdin();
166
+
167
+ return props.showInteractiveDevSession ?? isRawModeSupported ? (
168
+ <InteractiveDevSession {...props} />
169
+ ) : (
170
+ <DevSession {...props} local={props.initialMode === "local"} />
171
+ );
118
172
  }
119
173
 
120
- type InteractiveDevSessionProps = DevProps & {
121
- apiToken: string | undefined;
122
- bundle: EsbuildBundle | undefined;
123
- };
174
+ // This is a nasty hack to allow `useHotkeys` and its "[b] open a browser" feature to read these values
175
+ // without triggering a re-render loop when `onReady()` updates them.
176
+ // The initially requested port can be different than what's actually used, if, for example, you request port 0.
177
+ let ip: string;
178
+ let port: number;
179
+
180
+ function InteractiveDevSession(props: DevProps) {
181
+ const toggles = useHotkeys({
182
+ initial: {
183
+ local: props.initialMode === "local",
184
+ tunnel: false,
185
+ },
186
+ inspectorPort: props.inspectorPort,
187
+ inspect: props.inspect,
188
+ localProtocol: props.localProtocol,
189
+ forceLocal: props.forceLocal,
190
+ });
124
191
 
125
- function InteractiveDevSession(props: InteractiveDevSessionProps) {
126
- const toggles = useHotkeys(
127
- {
128
- local: props.initialMode === "local",
129
- tunnel: false,
130
- },
131
- props.port,
132
- props.ip,
133
- props.inspectorPort,
134
- props.localProtocol
135
- );
136
-
137
- useTunnel(toggles.tunnel);
138
-
139
- return (
140
- <>
141
- <DevSession {...props} local={toggles.local} />
142
- <Box borderStyle="round" paddingLeft={1} paddingRight={1}>
143
- <Text bold={true}>[b]</Text>
144
- <Text> open a browser, </Text>
145
- <Text bold={true}>[d]</Text>
146
- <Text> open Devtools, </Text>
147
- <Text bold={true}>[l]</Text>
148
- <Text> {toggles.local ? "turn off" : "turn on"} local mode, </Text>
149
- <Text bold={true}>[c]</Text>
150
- <Text> clear console, </Text>
151
- <Text bold={true}>[x]</Text>
152
- <Text> to exit</Text>
153
- </Box>
154
- </>
155
- );
192
+ ip = props.initialIp;
193
+ port = props.initialPort;
194
+
195
+ useTunnel(toggles.tunnel);
196
+
197
+ const onReady = (newIp: string, newPort: number) => {
198
+ if (newIp !== props.initialIp || newPort !== props.initialPort) {
199
+ ip = newIp;
200
+ port = newPort;
201
+ if (props.onReady) {
202
+ props.onReady(newIp, newPort);
203
+ }
204
+ }
205
+ };
206
+
207
+ return (
208
+ <>
209
+ <DevSession {...props} local={toggles.local} onReady={onReady} />
210
+ <Box borderStyle="round" paddingLeft={1} paddingRight={1}>
211
+ <Text bold={true}>[b]</Text>
212
+ <Text> open a browser, </Text>
213
+ {props.inspect ? (
214
+ <>
215
+ <Text bold={true}>[d]</Text>
216
+ <Text> open Devtools, </Text>
217
+ </>
218
+ ) : null}
219
+ {!props.forceLocal ? (
220
+ <>
221
+ <Text bold={true}>[l]</Text>
222
+ <Text> {toggles.local ? "turn off" : "turn on"} local mode, </Text>
223
+ </>
224
+ ) : null}
225
+ <Text bold={true}>[c]</Text>
226
+ <Text> clear console, </Text>
227
+ <Text bold={true}>[x]</Text>
228
+ <Text> to exit</Text>
229
+ </Box>
230
+ </>
231
+ );
156
232
  }
157
233
 
158
- type DevSessionProps = InteractiveDevSessionProps & { local: boolean };
234
+ type DevSessionProps = DevProps & {
235
+ local: boolean;
236
+ experimentalLocal?: boolean;
237
+ };
159
238
 
160
239
  function DevSession(props: DevSessionProps) {
161
- return props.local ? (
162
- <Local
163
- name={props.name}
164
- bundle={props.bundle}
165
- format={props.entry.format}
166
- compatibilityDate={props.compatibilityDate}
167
- compatibilityFlags={props.compatibilityFlags}
168
- bindings={props.bindings}
169
- assetPaths={props.assetPaths}
170
- public={props.public}
171
- port={props.port}
172
- ip={props.ip}
173
- rules={props.rules}
174
- inspectorPort={props.inspectorPort}
175
- enableLocalPersistence={props.enableLocalPersistence}
176
- crons={props.crons}
177
- />
178
- ) : (
179
- <Remote
180
- name={props.name}
181
- bundle={props.bundle}
182
- format={props.entry.format}
183
- accountId={props.accountId}
184
- apiToken={props.apiToken}
185
- bindings={props.bindings}
186
- assetPaths={props.assetPaths}
187
- public={props.public}
188
- port={props.port}
189
- ip={props.ip}
190
- localProtocol={props.localProtocol}
191
- inspectorPort={props.inspectorPort}
192
- compatibilityDate={props.compatibilityDate}
193
- compatibilityFlags={props.compatibilityFlags}
194
- usageModel={props.usageModel}
195
- env={props.env}
196
- legacyEnv={props.legacyEnv}
197
- zone={props.zone}
198
- />
199
- );
240
+ useCustomBuild(props.entry, props.build);
241
+
242
+ const directory = useTmpDir();
243
+ const handleError = useErrorHandler();
244
+
245
+ // Note: when D1 is out of beta, this (and all instances of `betaD1Shims`) can be removed.
246
+ // Additionally, useMemo is used so that new arrays aren't created on every render
247
+ // cause re-rendering further down.
248
+ const betaD1Shims = useMemo(
249
+ () => props.bindings.d1_databases?.map((db) => db.binding),
250
+ [props.bindings.d1_databases]
251
+ );
252
+
253
+ // If we are using d1 bindings, and are not bundling the worker
254
+ // we should error here as the d1 shim won't be added
255
+ if (Array.isArray(betaD1Shims) && betaD1Shims.length > 0 && props.noBundle) {
256
+ handleError(
257
+ new Error(
258
+ "While in beta, you cannot use D1 bindings without bundling your worker. Please remove `no_bundle` from your wrangler.toml file or remove the `--no-bundle` flag to access D1 bindings."
259
+ )
260
+ );
261
+ }
262
+
263
+ const workerDefinitions = useDevRegistry(
264
+ props.name,
265
+ props.bindings.services,
266
+ props.bindings.durable_objects,
267
+ props.local ? "local" : "remote"
268
+ );
269
+
270
+ const bundle = useEsbuild({
271
+ entry: props.entry,
272
+ destination: directory,
273
+ jsxFactory: props.jsxFactory,
274
+ rules: props.rules,
275
+ jsxFragment: props.jsxFragment,
276
+ serveAssetsFromWorker: Boolean(
277
+ props.assetPaths && !props.isWorkersSite && props.local
278
+ ),
279
+ tsconfig: props.tsconfig,
280
+ minify: props.minify,
281
+ legacyNodeCompat: props.legacyNodeCompat,
282
+ nodejsCompat: props.nodejsCompat,
283
+ betaD1Shims,
284
+ define: props.define,
285
+ noBundle: props.noBundle,
286
+ assets: props.assetsConfig,
287
+ workerDefinitions,
288
+ services: props.bindings.services,
289
+ durableObjects: props.bindings.durable_objects || { bindings: [] },
290
+ firstPartyWorkerDevFacade: props.firstPartyWorker,
291
+ local: props.local,
292
+ // Enable the bundling to know whether we are using dev or publish
293
+ targetConsumer: "dev",
294
+ testScheduled: props.testScheduled ?? false,
295
+ experimentalLocal: props.experimentalLocal,
296
+ });
297
+
298
+ // TODO(queues) support remote wrangler dev
299
+ if (
300
+ !props.local &&
301
+ (props.bindings.queues?.length || props.queueConsumers?.length)
302
+ ) {
303
+ logger.warn(
304
+ "Queues are currently in Beta and are not supported in wrangler dev remote mode."
305
+ );
306
+ }
307
+
308
+ const announceAndOnReady: typeof props.onReady = (finalIp, finalPort) => {
309
+ if (process.send) {
310
+ process.send(
311
+ JSON.stringify({
312
+ event: "DEV_SERVER_READY",
313
+ ip: finalIp,
314
+ port: finalPort,
315
+ })
316
+ );
317
+ }
318
+
319
+ if (props.onReady) {
320
+ props.onReady(finalIp, finalPort);
321
+ }
322
+ };
323
+
324
+ return props.local ? (
325
+ <Local
326
+ name={props.name}
327
+ bundle={bundle}
328
+ format={props.entry.format}
329
+ compatibilityDate={props.compatibilityDate}
330
+ compatibilityFlags={props.compatibilityFlags}
331
+ usageModel={props.usageModel}
332
+ bindings={props.bindings}
333
+ workerDefinitions={workerDefinitions}
334
+ assetPaths={props.assetPaths}
335
+ initialPort={props.initialPort}
336
+ initialIp={props.initialIp}
337
+ rules={props.rules}
338
+ inspectorPort={props.inspectorPort}
339
+ localPersistencePath={props.localPersistencePath}
340
+ liveReload={props.liveReload}
341
+ crons={props.crons}
342
+ queueConsumers={props.queueConsumers}
343
+ localProtocol={props.localProtocol}
344
+ localUpstream={props.localUpstream}
345
+ inspect={props.inspect}
346
+ onReady={announceAndOnReady}
347
+ enablePagesAssetsServiceBinding={props.enablePagesAssetsServiceBinding}
348
+ experimentalLocal={props.experimentalLocal}
349
+ accountId={props.accountId}
350
+ experimentalLocalRemoteKv={props.experimentalLocalRemoteKv}
351
+ />
352
+ ) : (
353
+ <Remote
354
+ name={props.name}
355
+ bundle={bundle}
356
+ format={props.entry.format}
357
+ accountId={props.accountId}
358
+ bindings={props.bindings}
359
+ assetPaths={props.assetPaths}
360
+ isWorkersSite={props.isWorkersSite}
361
+ port={props.initialPort}
362
+ ip={props.initialIp}
363
+ localProtocol={props.localProtocol}
364
+ inspectorPort={props.inspectorPort}
365
+ // TODO: @threepointone #1167
366
+ // liveReload={props.liveReload}
367
+ inspect={props.inspect}
368
+ compatibilityDate={props.compatibilityDate}
369
+ compatibilityFlags={props.compatibilityFlags}
370
+ usageModel={props.usageModel}
371
+ env={props.env}
372
+ legacyEnv={props.legacyEnv}
373
+ zone={props.zone}
374
+ host={props.host}
375
+ routes={props.routes}
376
+ onReady={announceAndOnReady}
377
+ sourceMapPath={bundle?.sourceMapPath}
378
+ sendMetrics={props.sendMetrics}
379
+ />
380
+ );
200
381
  }
201
382
 
202
383
  export interface DirectorySyncResult {
203
- name: string;
204
- removeCallback: () => void;
384
+ name: string;
385
+ removeCallback: () => void;
205
386
  }
206
387
 
207
388
  function useTmpDir(): string | undefined {
208
- const [directory, setDirectory] = useState<DirectorySyncResult>();
209
- const handleError = useErrorHandler();
210
- useEffect(() => {
211
- let dir: DirectorySyncResult | undefined;
212
- try {
213
- dir = tmp.dirSync({ unsafeCleanup: true });
214
- setDirectory(dir);
215
- return;
216
- } catch (err) {
217
- logger.error(
218
- "Failed to create temporary directory to store built files."
219
- );
220
- handleError(err);
221
- }
222
- return () => {
223
- dir?.removeCallback();
224
- };
225
- }, [handleError]);
226
- return directory?.name;
389
+ const [directory, setDirectory] = useState<DirectorySyncResult>();
390
+ const handleError = useErrorHandler();
391
+ useEffect(() => {
392
+ let dir: DirectorySyncResult | undefined;
393
+ try {
394
+ dir = tmp.dirSync({ unsafeCleanup: true });
395
+ setDirectory(dir);
396
+ return;
397
+ } catch (err) {
398
+ logger.error(
399
+ "Failed to create temporary directory to store built files."
400
+ );
401
+ handleError(err);
402
+ }
403
+ return () => {
404
+ dir?.removeCallback();
405
+ };
406
+ }, [handleError]);
407
+ return directory?.name;
227
408
  }
228
409
 
229
- function useCustomBuild(
230
- expectedEntry: Entry,
231
- build: {
232
- command?: string | undefined;
233
- cwd?: string | undefined;
234
- watch_dir?: string | undefined;
235
- }
236
- ): void {
237
- useEffect(() => {
238
- if (!build.command) return;
239
- let watcher: ReturnType<typeof watch> | undefined;
240
- if (build.watch_dir) {
241
- watcher = watch(build.watch_dir, {
242
- persistent: true,
243
- ignoreInitial: true,
244
- }).on("all", (_event, filePath) => {
245
- //TODO: we should buffer requests to the proxy until this completes
246
- logger.log(`The file ${filePath} changed, restarting build...`);
247
- runCustomBuild(expectedEntry.file, build).catch((err) => {
248
- logger.error("Custom build failed:", err);
249
- });
250
- });
251
- }
252
-
253
- return () => {
254
- watcher?.close();
255
- };
256
- }, [build, expectedEntry.file]);
410
+ function useCustomBuild(expectedEntry: Entry, build: Config["build"]): void {
411
+ useEffect(() => {
412
+ if (!build.command) return;
413
+ let watcher: ReturnType<typeof watch> | undefined;
414
+ if (build.watch_dir) {
415
+ watcher = watch(build.watch_dir, {
416
+ persistent: true,
417
+ ignoreInitial: true,
418
+ }).on("all", (_event, filePath) => {
419
+ const relativeFile =
420
+ path.relative(expectedEntry.directory, expectedEntry.file) || ".";
421
+ //TODO: we should buffer requests to the proxy until this completes
422
+ logger.log(`The file ${filePath} changed, restarting build...`);
423
+ runCustomBuild(expectedEntry.file, relativeFile, build).catch((err) => {
424
+ logger.error("Custom build failed:", err);
425
+ });
426
+ });
427
+ }
428
+
429
+ return () => {
430
+ void watcher?.close();
431
+ };
432
+ }, [build, expectedEntry]);
257
433
  }
258
434
 
259
435
  function sleep(period: number) {
260
- return new Promise((resolve) => setTimeout(resolve, period));
436
+ return new Promise((resolve) => setTimeout(resolve, period));
261
437
  }
262
438
  const SLEEP_DURATION = 2000;
263
439
  // really need a first class api for this
264
440
  const hostNameRegex = /userHostname="(.*)"/g;
265
441
  async function findTunnelHostname() {
266
- let hostName: string | undefined;
267
- while (!hostName) {
268
- try {
269
- const resp = await fetch("http://localhost:8789/metrics");
270
- const data = await resp.text();
271
- const matches = Array.from(data.matchAll(hostNameRegex));
272
- hostName = matches[0][1];
273
- } catch (err) {
274
- await sleep(SLEEP_DURATION);
275
- }
276
- }
277
- return hostName;
442
+ let hostName: string | undefined;
443
+ while (!hostName) {
444
+ try {
445
+ const resp = await fetch("http://localhost:8789/metrics");
446
+ const data = await resp.text();
447
+ const matches = Array.from(data.matchAll(hostNameRegex));
448
+ hostName = matches[0][1];
449
+ } catch (err) {
450
+ await sleep(SLEEP_DURATION);
451
+ }
452
+ }
453
+ return hostName;
278
454
  }
279
455
 
280
456
  /**
@@ -282,137 +458,143 @@ async function findTunnelHostname() {
282
458
  * We've disabled this for now until we figure out a better user experience.
283
459
  */
284
460
  function useTunnel(toggle: boolean) {
285
- const tunnel = useRef<ReturnType<typeof spawn>>();
286
- const removeSignalExitListener = useRef<() => void>();
287
- // TODO: test if cloudflared is available, if not
288
- // point them to a url where they can get docs to install it
289
- useEffect(() => {
290
- async function startTunnel() {
291
- if (toggle) {
292
- try {
293
- await commandExists("cloudflared");
294
- } catch (e) {
295
- logger.warn(
296
- "To share your worker on the Internet, please install `cloudflared` from https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup/installation"
297
- );
298
- return;
299
- }
300
- logger.log("⎔ Starting a tunnel...");
301
- tunnel.current = spawn("cloudflared", [
302
- "tunnel",
303
- "--url",
304
- "http://localhost:8787",
305
- "--metrics",
306
- "localhost:8789",
307
- ]);
308
-
309
- tunnel.current.on("close", (code) => {
310
- if (code) {
311
- logger.log(`Tunnel process exited with code ${code}`);
312
- }
313
- });
314
-
315
- removeSignalExitListener.current = onExit((_code, _signal) => {
316
- logger.log("⎔ Shutting down local tunnel.");
317
- tunnel.current?.kill();
318
- tunnel.current = undefined;
319
- });
320
-
321
- const hostName = await findTunnelHostname();
322
- await clipboardy.write(hostName);
323
- logger.log(`⬣ Sharing at ${hostName}, copied to clipboard.`);
324
- }
325
- }
326
-
327
- startTunnel().catch(async (err) => {
328
- logger.error("tunnel:", err);
329
- });
330
-
331
- return () => {
332
- if (tunnel.current) {
333
- logger.log("⎔ Shutting down tunnel.");
334
- tunnel.current?.kill();
335
- tunnel.current = undefined;
336
- removeSignalExitListener.current && removeSignalExitListener.current();
337
- removeSignalExitListener.current = undefined;
338
- }
339
- };
340
- }, [toggle]);
461
+ const tunnel = useRef<ReturnType<typeof spawn>>();
462
+ const removeSignalExitListener = useRef<() => void>();
463
+ // TODO: test if cloudflared is available, if not
464
+ // point them to a url where they can get docs to install it
465
+ useEffect(() => {
466
+ async function startTunnel() {
467
+ if (toggle) {
468
+ try {
469
+ await commandExists("cloudflared");
470
+ } catch (e) {
471
+ logger.warn(
472
+ "To share your worker on the Internet, please install `cloudflared` from https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup/installation"
473
+ );
474
+ return;
475
+ }
476
+ logger.log("⎔ Starting a tunnel...");
477
+ tunnel.current = spawn("cloudflared", [
478
+ "tunnel",
479
+ "--url",
480
+ "http://localhost:8787",
481
+ "--metrics",
482
+ "localhost:8789",
483
+ ]);
484
+
485
+ tunnel.current.on("close", (code) => {
486
+ if (code) {
487
+ logger.log(`Tunnel process exited with code ${code}`);
488
+ }
489
+ });
490
+
491
+ removeSignalExitListener.current = onExit((_code, _signal) => {
492
+ logger.log("⎔ Shutting down local tunnel.");
493
+ tunnel.current?.kill();
494
+ tunnel.current = undefined;
495
+ });
496
+
497
+ const hostName = await findTunnelHostname();
498
+ await clipboardy.write(hostName);
499
+ logger.log(`⬣ Sharing at ${hostName}, copied to clipboard.`);
500
+ }
501
+ }
502
+
503
+ startTunnel().catch(async (err) => {
504
+ logger.error("tunnel:", err);
505
+ });
506
+
507
+ return () => {
508
+ if (tunnel.current) {
509
+ logger.log("⎔ Shutting down tunnel.");
510
+ tunnel.current?.kill();
511
+ tunnel.current = undefined;
512
+ removeSignalExitListener.current && removeSignalExitListener.current();
513
+ removeSignalExitListener.current = undefined;
514
+ }
515
+ };
516
+ }, [toggle]);
341
517
  }
342
518
 
343
519
  type useHotkeysInitialState = {
344
- local: boolean;
345
- tunnel: boolean;
520
+ local: boolean;
521
+ tunnel: boolean;
346
522
  };
347
- function useHotkeys(
348
- initial: useHotkeysInitialState,
349
- port: number,
350
- ip: string,
351
- inspectorPort: number,
352
- localProtocol: "http" | "https"
353
- ) {
354
- // UGH, we should put port in context instead
355
- const [toggles, setToggles] = useState(initial);
356
- const { exit } = useApp();
357
- useInput(
358
- async (
359
- input,
360
- // eslint-disable-next-line unused-imports/no-unused-vars
361
- key
362
- ) => {
363
- switch (input.toLowerCase()) {
364
- // clear console
365
- case "c":
366
- console.clear();
367
- // This console.log causes Ink to re-render the `DevSession` component.
368
- // Couldn't find a better way to tell it to do so...
369
- console.log();
370
- break;
371
- // open browser
372
- case "b": {
373
- await openInBrowser(`${localProtocol}://${ip}:${port}`);
374
- break;
375
- }
376
- // toggle inspector
377
- case "d": {
378
- await openInBrowser(
379
- `https://built-devtools.pages.dev/js_app?experiments=true&v8only=true&ws=localhost:${inspectorPort}/ws`,
380
- { forceChromium: true }
381
- );
382
- break;
383
- }
384
- // toggle local
385
- case "l":
386
- setToggles((previousToggles) => ({
387
- ...previousToggles,
388
- local: !previousToggles.local,
389
- }));
390
- break;
391
- // shut down
392
- case "q":
393
- case "x":
394
- exit();
395
- break;
396
- default:
397
- // nothing?
398
- break;
399
- }
400
- }
401
- );
402
- return toggles;
523
+ function useHotkeys(props: {
524
+ initial: useHotkeysInitialState;
525
+ inspectorPort: number;
526
+ inspect: boolean;
527
+ localProtocol: "http" | "https";
528
+ forceLocal: boolean | undefined;
529
+ }) {
530
+ const { initial, inspectorPort, inspect, localProtocol, forceLocal } = props;
531
+ // UGH, we should put port in context instead
532
+ const [toggles, setToggles] = useState(initial);
533
+ const { exit } = useApp();
534
+
535
+ useInput(
536
+ async (
537
+ input,
538
+ // eslint-disable-next-line unused-imports/no-unused-vars
539
+ key
540
+ ) => {
541
+ switch (input.toLowerCase()) {
542
+ // clear console
543
+ case "c":
544
+ console.clear();
545
+ // This console.log causes Ink to re-render the `DevSession` component.
546
+ // Couldn't find a better way to tell it to do so...
547
+ console.log();
548
+ break;
549
+ // open browser
550
+ case "b": {
551
+ if (ip === "0.0.0.0") {
552
+ await openInBrowser(`${localProtocol}://127.0.0.1:${port}`);
553
+ return;
554
+ }
555
+ await openInBrowser(`${localProtocol}://${ip}:${port}`);
556
+ break;
557
+ }
558
+ // toggle inspector
559
+ case "d": {
560
+ if (inspect) {
561
+ await openInspector(inspectorPort);
562
+ }
563
+ break;
564
+ }
565
+ // toggle local
566
+ case "l":
567
+ if (forceLocal) return;
568
+ setToggles((previousToggles) => ({
569
+ ...previousToggles,
570
+ local: !previousToggles.local,
571
+ }));
572
+ break;
573
+ // shut down
574
+ case "q":
575
+ case "x":
576
+ exit();
577
+ break;
578
+ default:
579
+ // nothing?
580
+ break;
581
+ }
582
+ }
583
+ );
584
+ return toggles;
403
585
  }
404
586
 
405
587
  function ErrorFallback(props: { error: Error }) {
406
- const { exit } = useApp();
407
- useEffect(() => exit(props.error));
408
- return (
409
- <>
410
- <Text>Something went wrong:</Text>
411
- <Text>{props.error.stack}</Text>
412
- </>
413
- );
588
+ const { exit } = useApp();
589
+ useEffect(() => exit(props.error));
590
+ return (
591
+ <>
592
+ <Text>Something went wrong:</Text>
593
+ <Text>{props.error.stack}</Text>
594
+ </>
595
+ );
414
596
  }
415
597
 
416
598
  export default withErrorBoundary(DevImplementation, {
417
- FallbackComponent: ErrorFallback,
599
+ FallbackComponent: ErrorFallback,
418
600
  });