wrangler 0.0.0-e3278fa → 0.0.0-e33294b0

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 (322) hide show
  1. package/README.md +24 -4
  2. package/bin/wrangler.js +170 -62
  3. package/kv-asset-handler.js +1 -0
  4. package/miniflare-dist/index.mjs +1499 -34
  5. package/package.json +193 -153
  6. package/src/__tests__/access.test.ts +25 -0
  7. package/src/__tests__/api-dev.test.ts +238 -0
  8. package/src/__tests__/api-devregistry.test.js +64 -0
  9. package/src/__tests__/api.test.ts +80 -0
  10. package/src/__tests__/config-cache-without-cache-dir.test.ts +38 -0
  11. package/src/__tests__/config-cache.test.ts +30 -24
  12. package/src/__tests__/configuration.test.ts +4222 -3397
  13. package/src/__tests__/d1/d1.test.ts +82 -0
  14. package/src/__tests__/d1/execute.test.ts +64 -0
  15. package/src/__tests__/d1/migrate.test.ts +155 -0
  16. package/src/__tests__/d1/splitter.test.ts +255 -0
  17. package/src/__tests__/delete.test.ts +266 -0
  18. package/src/__tests__/deployments.test.ts +129 -0
  19. package/src/__tests__/dev.test.tsx +1560 -956
  20. package/src/__tests__/generate.test.ts +238 -0
  21. package/src/__tests__/get-host-from-url.test.ts +16 -0
  22. package/src/__tests__/guess-worker-format.test.ts +68 -68
  23. package/src/__tests__/helpers/cmd-shim.d.ts +6 -6
  24. package/src/__tests__/helpers/end-event-loop.ts +6 -0
  25. package/src/__tests__/helpers/mock-account-id.ts +24 -24
  26. package/src/__tests__/helpers/mock-auth-domain.ts +20 -0
  27. package/src/__tests__/helpers/mock-bin.ts +20 -20
  28. package/src/__tests__/helpers/mock-console.ts +58 -39
  29. package/src/__tests__/helpers/mock-dialogs.ts +88 -79
  30. package/src/__tests__/helpers/mock-get-pages-upload-token.ts +25 -0
  31. package/src/__tests__/helpers/mock-get-zone-from-host.ts +11 -0
  32. package/src/__tests__/helpers/mock-http-server.ts +30 -30
  33. package/src/__tests__/helpers/mock-istty.ts +65 -18
  34. package/src/__tests__/helpers/mock-known-routes.ts +12 -0
  35. package/src/__tests__/helpers/mock-kv.ts +41 -28
  36. package/src/__tests__/helpers/mock-oauth-flow.ts +241 -233
  37. package/src/__tests__/helpers/mock-process.ts +34 -0
  38. package/src/__tests__/helpers/mock-set-timeout.ts +16 -0
  39. package/src/__tests__/helpers/mock-stdin.ts +82 -77
  40. package/src/__tests__/helpers/mock-web-socket.ts +21 -21
  41. package/src/__tests__/helpers/msw/blob-worker.cjs +19 -0
  42. package/src/__tests__/helpers/msw/handlers/access.ts +13 -0
  43. package/src/__tests__/helpers/msw/handlers/deployments.ts +93 -0
  44. package/src/__tests__/helpers/msw/handlers/namespaces.ts +81 -0
  45. package/src/__tests__/helpers/msw/handlers/oauth.ts +31 -0
  46. package/src/__tests__/helpers/msw/handlers/r2.ts +60 -0
  47. package/src/__tests__/helpers/msw/handlers/script.ts +56 -0
  48. package/src/__tests__/helpers/msw/handlers/user.ts +52 -0
  49. package/src/__tests__/helpers/msw/handlers/zones.ts +20 -0
  50. package/src/__tests__/helpers/msw/index.ts +50 -0
  51. package/src/__tests__/helpers/msw/read-file-sync.js +61 -0
  52. package/src/__tests__/helpers/run-in-tmp.ts +27 -28
  53. package/src/__tests__/helpers/run-wrangler.ts +8 -8
  54. package/src/__tests__/helpers/string-dynamic-values-matcher.ts +28 -0
  55. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +1 -0
  56. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +5 -0
  57. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +1 -0
  58. package/src/__tests__/helpers/worker-scripts/parent-worker.js +8 -0
  59. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +5 -0
  60. package/src/__tests__/helpers/write-worker-source.ts +16 -16
  61. package/src/__tests__/helpers/write-wrangler-toml.ts +9 -9
  62. package/src/__tests__/https-options.test.ts +142 -109
  63. package/src/__tests__/index.test.ts +254 -236
  64. package/src/__tests__/init.test.ts +3135 -1608
  65. package/src/__tests__/jest.setup.ts +148 -50
  66. package/src/__tests__/kv.test.ts +1789 -1471
  67. package/src/__tests__/logger.test.ts +100 -74
  68. package/src/__tests__/logout.test.ts +47 -0
  69. package/src/__tests__/metrics.test.ts +493 -0
  70. package/src/__tests__/middleware.scheduled.test.ts +145 -0
  71. package/src/__tests__/middleware.test.ts +815 -0
  72. package/src/__tests__/mtls-certificates.test.ts +585 -0
  73. package/src/__tests__/package-manager.test.ts +303 -303
  74. package/src/__tests__/pages/deployment-list.test.ts +78 -0
  75. package/src/__tests__/pages/functions-build.test.ts +402 -0
  76. package/src/__tests__/pages/pages.test.ts +81 -0
  77. package/src/__tests__/pages/project-create.test.ts +63 -0
  78. package/src/__tests__/pages/project-list.test.ts +108 -0
  79. package/src/__tests__/pages/project-upload.test.ts +481 -0
  80. package/src/__tests__/pages/publish.test.ts +2745 -0
  81. package/src/__tests__/pages-deployment-tail.test.ts +955 -0
  82. package/src/__tests__/parse.test.ts +358 -252
  83. package/src/__tests__/paths.test.ts +39 -0
  84. package/src/__tests__/publish.test.ts +8023 -5629
  85. package/src/__tests__/pubsub.test.ts +493 -0
  86. package/src/__tests__/queues.test.ts +529 -0
  87. package/src/__tests__/r2.test.ts +369 -228
  88. package/src/__tests__/route.test.ts +18 -18
  89. package/src/__tests__/secret.test.ts +681 -469
  90. package/src/__tests__/tail.test.ts +835 -567
  91. package/src/__tests__/test-old-node-version.js +31 -0
  92. package/src/__tests__/tsconfig-sanity.ts +12 -0
  93. package/src/__tests__/tsconfig.json +8 -0
  94. package/src/__tests__/tsconfig.tsbuildinfo +1 -0
  95. package/src/__tests__/type-generation.test.ts +233 -0
  96. package/src/__tests__/user.test.ts +107 -120
  97. package/src/__tests__/utils-collectKeyValues.test.ts +47 -0
  98. package/src/__tests__/validate-dev-props.test.ts +56 -0
  99. package/src/__tests__/version.test.ts +35 -0
  100. package/src/__tests__/whoami.test.tsx +165 -132
  101. package/src/__tests__/worker-namespace.test.ts +339 -0
  102. package/src/abort.d.ts +1 -1
  103. package/src/api/dev.ts +328 -0
  104. package/src/api/index.ts +11 -0
  105. package/src/api/mtls-certificate.ts +148 -0
  106. package/src/api/pages/create-worker-bundle-contents.ts +75 -0
  107. package/src/api/pages/index.ts +5 -0
  108. package/src/api/pages/publish.tsx +368 -0
  109. package/src/bundle-reporter.ts +68 -0
  110. package/src/bundle.ts +839 -160
  111. package/src/cfetch/index.ts +120 -83
  112. package/src/cfetch/internal.ts +208 -92
  113. package/src/cli.ts +23 -8
  114. package/src/config/config.ts +244 -196
  115. package/src/config/diagnostics.ts +61 -61
  116. package/src/config/environment.ts +523 -357
  117. package/src/config/index.ts +346 -196
  118. package/src/config/validation-helpers.ts +379 -366
  119. package/src/config/validation.ts +2026 -1367
  120. package/src/config-cache.ts +81 -41
  121. package/src/create-worker-preview.ts +239 -142
  122. package/src/create-worker-upload-form.ts +318 -238
  123. package/src/d1/backups.tsx +215 -0
  124. package/src/d1/constants.ts +2 -0
  125. package/src/d1/create.tsx +64 -0
  126. package/src/d1/delete.ts +53 -0
  127. package/src/d1/execute.tsx +354 -0
  128. package/src/d1/formatTimeAgo.ts +14 -0
  129. package/src/d1/index.ts +100 -0
  130. package/src/d1/list.tsx +60 -0
  131. package/src/d1/migrations/apply.tsx +206 -0
  132. package/src/d1/migrations/create.tsx +76 -0
  133. package/src/d1/migrations/helpers.ts +172 -0
  134. package/src/d1/migrations/index.ts +3 -0
  135. package/src/d1/migrations/list.tsx +92 -0
  136. package/src/d1/migrations/options.ts +23 -0
  137. package/src/d1/options.ts +22 -0
  138. package/src/d1/splitter.ts +161 -0
  139. package/src/d1/types.ts +25 -0
  140. package/src/d1/utils.ts +49 -0
  141. package/src/delete.ts +100 -0
  142. package/src/deployments.ts +116 -0
  143. package/src/deprecated/index.ts +144 -0
  144. package/src/dev/dev-vars.ts +20 -17
  145. package/src/dev/dev.tsx +533 -345
  146. package/src/dev/get-local-persistence-path.ts +31 -0
  147. package/src/dev/local.tsx +903 -302
  148. package/src/dev/remote.tsx +620 -225
  149. package/src/dev/start-server.ts +538 -0
  150. package/src/dev/use-esbuild.ts +184 -97
  151. package/src/dev/validate-dev-props.ts +31 -0
  152. package/src/dev-registry.ts +201 -0
  153. package/src/dev.tsx +914 -0
  154. package/src/dialogs.ts +136 -0
  155. package/src/dispatch-namespace.ts +211 -0
  156. package/src/docs/index.ts +97 -0
  157. package/src/durable.ts +87 -87
  158. package/src/entry.ts +236 -230
  159. package/src/environment-variables/factory.ts +88 -0
  160. package/src/environment-variables/misc-variables.ts +30 -0
  161. package/src/errors.ts +6 -6
  162. package/src/generate/index.ts +298 -0
  163. package/src/git-client.ts +135 -0
  164. package/src/global-wrangler-config-path.ts +26 -0
  165. package/src/https-options.ts +84 -80
  166. package/src/index.ts +705 -0
  167. package/src/init.ts +1022 -0
  168. package/src/inspect.ts +698 -593
  169. package/src/intl-polyfill.d.ts +123 -123
  170. package/src/is-ci.ts +14 -0
  171. package/src/is-interactive.ts +16 -0
  172. package/src/jest.d.ts +4 -0
  173. package/src/kv/helpers.ts +430 -0
  174. package/src/kv/index.ts +594 -0
  175. package/src/logger.ts +80 -42
  176. package/src/metrics/index.ts +5 -0
  177. package/src/metrics/metrics-config.ts +239 -0
  178. package/src/metrics/metrics-dispatcher.ts +96 -0
  179. package/src/metrics/metrics-usage-headers.ts +24 -0
  180. package/src/metrics/send-event.ts +98 -0
  181. package/src/miniflare-cli/assets.ts +250 -0
  182. package/src/miniflare-cli/index.ts +202 -33
  183. package/src/miniflare-cli/request-context.ts +18 -18
  184. package/src/miniflare-cli/tsconfig.json +9 -0
  185. package/src/miniflare-cli/tsconfig.tsbuildinfo +1 -0
  186. package/src/miniflare-cli/types.ts +11 -0
  187. package/src/module-collection.ts +221 -212
  188. package/src/mtls-certificate/cli.ts +155 -0
  189. package/src/open-in-browser.ts +4 -6
  190. package/src/package-manager.ts +173 -128
  191. package/src/pages/build.ts +232 -0
  192. package/src/pages/buildFunctions.ts +130 -0
  193. package/src/pages/constants.ts +18 -0
  194. package/src/pages/deployment-tails.ts +281 -0
  195. package/src/pages/deployments.tsx +86 -0
  196. package/src/pages/dev.ts +716 -0
  197. package/src/pages/errors.ts +66 -0
  198. package/src/pages/functions/buildPlugin.ts +90 -0
  199. package/src/pages/functions/buildWorker.ts +288 -0
  200. package/{pages → src/pages}/functions/filepath-routing.test.ts +113 -113
  201. package/src/pages/functions/filepath-routing.ts +189 -0
  202. package/src/pages/functions/identifiers.ts +78 -0
  203. package/src/pages/functions/routes-consolidation.test.ts +250 -0
  204. package/src/pages/functions/routes-consolidation.ts +73 -0
  205. package/src/pages/functions/routes-transformation.test.ts +282 -0
  206. package/src/pages/functions/routes-transformation.ts +115 -0
  207. package/src/pages/functions/routes-validation.test.ts +403 -0
  208. package/src/pages/functions/routes-validation.ts +202 -0
  209. package/src/pages/functions/routes.ts +151 -0
  210. package/src/pages/functions/tsconfig.json +8 -0
  211. package/src/pages/functions/tsconfig.tsbuildinfo +1 -0
  212. package/src/pages/functions.ts +86 -0
  213. package/src/pages/hash.ts +13 -0
  214. package/src/pages/index.ts +102 -0
  215. package/src/pages/projects.tsx +162 -0
  216. package/src/pages/prompt-select-project.tsx +31 -0
  217. package/src/pages/publish.tsx +276 -0
  218. package/src/pages/types.ts +46 -0
  219. package/src/pages/upload.tsx +449 -0
  220. package/src/pages/utils.ts +23 -0
  221. package/src/parse.ts +232 -126
  222. package/src/paths.ts +53 -8
  223. package/src/proxy.ts +623 -407
  224. package/src/publish/index.ts +274 -0
  225. package/src/publish/publish.ts +1065 -0
  226. package/src/pubsub/index.ts +286 -0
  227. package/src/pubsub/pubsub-commands.ts +623 -0
  228. package/src/queues/cli/commands/consumer/add.ts +65 -0
  229. package/src/queues/cli/commands/consumer/index.ts +19 -0
  230. package/src/queues/cli/commands/consumer/remove.ts +31 -0
  231. package/src/queues/cli/commands/create.ts +25 -0
  232. package/src/queues/cli/commands/delete.ts +26 -0
  233. package/src/queues/cli/commands/index.ts +35 -0
  234. package/src/queues/cli/commands/list.ts +25 -0
  235. package/src/queues/client.ts +135 -0
  236. package/src/queues/utils.ts +18 -0
  237. package/src/r2/constants.ts +4 -0
  238. package/src/r2/helpers.ts +131 -0
  239. package/src/r2/index.ts +289 -0
  240. package/src/routes.ts +140 -0
  241. package/src/secret/index.ts +375 -0
  242. package/src/selfsigned.d.ts +23 -23
  243. package/src/sites.ts +372 -0
  244. package/src/tail/createTail.ts +406 -0
  245. package/src/tail/filters.ts +109 -111
  246. package/src/tail/index.ts +208 -296
  247. package/src/tail/printing.ts +101 -46
  248. package/src/tsconfig-sanity.ts +16 -0
  249. package/src/type-generation.ts +181 -0
  250. package/src/update-check.ts +11 -11
  251. package/src/user/access.ts +68 -0
  252. package/src/user/auth-variables.ts +113 -0
  253. package/src/user/choose-account.tsx +39 -0
  254. package/src/user/generate-auth-url.ts +33 -0
  255. package/src/user/generate-random-state.ts +16 -0
  256. package/src/user/index.ts +2 -0
  257. package/src/user/user.ts +1233 -0
  258. package/src/utils/collectKeyValues.ts +14 -0
  259. package/src/whoami.ts +135 -0
  260. package/src/worker.ts +183 -107
  261. package/src/yargs-types.ts +37 -0
  262. package/src/zones.ts +158 -40
  263. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  264. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  265. package/templates/__tests__/tsconfig.json +8 -0
  266. package/templates/__tests__/tsconfig.tsbuildinfo +1 -0
  267. package/templates/checked-fetch.js +23 -0
  268. package/templates/d1-beta-facade.js +241 -0
  269. package/templates/facade.d.ts +14 -0
  270. package/templates/first-party-worker-module-facade.ts +19 -0
  271. package/templates/format-dev-errors.ts +34 -0
  272. package/templates/init-tests/test-jest-new-worker.js +23 -0
  273. package/templates/init-tests/test-vitest-new-worker.js +24 -0
  274. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  275. package/templates/middleware/common.ts +62 -0
  276. package/templates/middleware/loader-modules.ts +84 -0
  277. package/templates/middleware/loader-sw.ts +233 -0
  278. package/templates/middleware/middleware-miniflare3-json-error.ts +20 -0
  279. package/templates/middleware/middleware-pretty-error.ts +40 -0
  280. package/templates/middleware/middleware-scheduled.ts +15 -0
  281. package/templates/new-worker-scheduled.js +3 -3
  282. package/templates/new-worker-scheduled.ts +15 -15
  283. package/templates/new-worker.js +3 -3
  284. package/templates/new-worker.ts +18 -15
  285. package/templates/no-op-worker.js +10 -0
  286. package/templates/pages-dev-pipeline.ts +31 -0
  287. package/templates/pages-dev-util.ts +52 -0
  288. package/templates/pages-shim.ts +12 -0
  289. package/templates/pages-template-plugin.ts +176 -0
  290. package/templates/pages-template-worker.ts +189 -0
  291. package/templates/serve-static-assets.ts +66 -0
  292. package/templates/service-bindings-module-facade.js +55 -0
  293. package/templates/service-bindings-sw-facade.js +42 -0
  294. package/templates/tsconfig-sanity.ts +11 -0
  295. package/templates/tsconfig.init.json +106 -0
  296. package/templates/tsconfig.json +6 -103
  297. package/templates/tsconfig.tsbuildinfo +1 -0
  298. package/wrangler-dist/cli.d.ts +1108 -0
  299. package/wrangler-dist/cli.js +109524 -90537
  300. package/wrangler-dist/wasm-sync.wasm +0 -0
  301. package/pages/functions/buildPlugin.ts +0 -105
  302. package/pages/functions/buildWorker.ts +0 -151
  303. package/pages/functions/filepath-routing.ts +0 -189
  304. package/pages/functions/identifiers.ts +0 -78
  305. package/pages/functions/routes.ts +0 -156
  306. package/pages/functions/template-plugin.ts +0 -147
  307. package/pages/functions/template-worker.ts +0 -143
  308. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  309. package/src/__tests__/helpers/mock-cfetch.ts +0 -211
  310. package/src/__tests__/pages.test.ts +0 -754
  311. package/src/dialogs.tsx +0 -135
  312. package/src/environment-variables.ts +0 -35
  313. package/src/index.tsx +0 -2846
  314. package/src/kv.ts +0 -408
  315. package/src/miniflare-cli/enum-keys.ts +0 -17
  316. package/src/pages.tsx +0 -2093
  317. package/src/publish.ts +0 -716
  318. package/src/r2.ts +0 -50
  319. package/src/sites.tsx +0 -326
  320. package/src/user.tsx +0 -1214
  321. package/src/whoami.tsx +0 -71
  322. package/templates/static-asset-facade.js +0 -43
package/src/dev/dev.tsx CHANGED
@@ -1,14 +1,21 @@
1
1
  import { spawn } from "node:child_process";
2
2
  import * as path from "node:path";
3
+ import * as util from "node:util";
3
4
  import { watch } from "chokidar";
4
5
  import clipboardy from "clipboardy";
5
6
  import commandExists from "command-exists";
6
7
  import { Box, Text, useApp, useInput, useStdin } from "ink";
7
- import React, { useState, useEffect, useRef } from "react";
8
+ import React, { useState, useEffect, useRef, useMemo } from "react";
8
9
  import { withErrorBoundary, useErrorHandler } from "react-error-boundary";
9
10
  import onExit from "signal-exit";
10
11
  import tmp from "tmp-promise";
11
12
  import { fetch } from "undici";
13
+ import {
14
+ getBoundRegisteredWorkers,
15
+ startWorkerRegistry,
16
+ stopWorkerRegistry,
17
+ unregisterWorker,
18
+ } from "../dev-registry";
12
19
  import { runCustomBuild } from "../entry";
13
20
  import { openInspector } from "../inspect";
14
21
  import { logger } from "../logger";
@@ -16,262 +23,434 @@ import openInBrowser from "../open-in-browser";
16
23
  import { Local } from "./local";
17
24
  import { Remote } from "./remote";
18
25
  import { useEsbuild } from "./use-esbuild";
26
+ import { validateDevProps } from "./validate-dev-props";
19
27
  import type { Config } from "../config";
28
+ import type { Route } from "../config/environment";
29
+ import type { WorkerRegistry } from "../dev-registry";
20
30
  import type { Entry } from "../entry";
31
+ import type { EnablePagesAssetsServiceBindingOptions } from "../miniflare-cli/types";
21
32
  import type { AssetPaths } from "../sites";
22
33
  import type { CfWorkerInit } from "../worker";
23
- 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
+ }
24
111
 
25
112
  export type DevProps = {
26
- name?: string;
27
- entry: Entry;
28
- port: number;
29
- ip: string;
30
- inspectorPort: number;
31
- rules: Config["rules"];
32
- accountId: string | undefined;
33
- initialMode: "local" | "remote";
34
- jsxFactory: string | undefined;
35
- jsxFragment: string | undefined;
36
- tsconfig: string | undefined;
37
- upstreamProtocol: "https" | "http";
38
- localProtocol: "https" | "http";
39
- enableLocalPersistence: boolean;
40
- bindings: CfWorkerInit["bindings"];
41
- crons: Config["triggers"]["crons"];
42
- public: string | undefined;
43
- assetPaths: AssetPaths | undefined;
44
- compatibilityDate: string;
45
- compatibilityFlags: string[] | undefined;
46
- usageModel: "bundled" | "unbound" | undefined;
47
- minify: boolean | undefined;
48
- nodeCompat: boolean | undefined;
49
- build: {
50
- command?: string | undefined;
51
- cwd?: string | undefined;
52
- watch_dir?: string | undefined;
53
- };
54
- env: string | undefined;
55
- legacyEnv: boolean;
56
- zone: string | undefined;
57
- host: string | 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
+ nodeCompat: boolean | undefined;
142
+ build: Config["build"];
143
+ env: string | undefined;
144
+ legacyEnv: boolean;
145
+ zone: string | undefined;
146
+ host: string | undefined;
147
+ routes: Route[] | undefined;
148
+ inspect: boolean;
149
+ logPrefix?: string;
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;
58
159
  };
59
160
 
60
161
  export function DevImplementation(props: DevProps): JSX.Element {
61
- const directory = useTmpDir();
62
-
63
- useCustomBuild(props.entry, props.build);
64
-
65
- if (props.public && props.entry.format === "service-worker") {
66
- throw new Error(
67
- "You cannot use the service-worker format with a `public` directory."
68
- );
69
- }
70
-
71
- if (props.bindings.wasm_modules && props.entry.format === "modules") {
72
- throw new Error(
73
- "You cannot configure [wasm_modules] with an ES module worker. Instead, import the .wasm module directly in your code"
74
- );
75
- }
76
-
77
- if (props.bindings.text_blobs && props.entry.format === "modules") {
78
- throw new Error(
79
- "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"
80
- );
81
- }
82
-
83
- if (props.bindings.data_blobs && props.entry.format === "modules") {
84
- throw new Error(
85
- "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"
86
- );
87
- }
88
-
89
- const bundle = useEsbuild({
90
- entry: props.entry,
91
- destination: directory,
92
- staticRoot: props.public,
93
- jsxFactory: props.jsxFactory,
94
- rules: props.rules,
95
- jsxFragment: props.jsxFragment,
96
- serveAssetsFromWorker: !!props.public,
97
- tsconfig: props.tsconfig,
98
- minify: props.minify,
99
- nodeCompat: props.nodeCompat,
100
- });
101
-
102
- // only load the UI if we're running in a supported environment
103
- const { isRawModeSupported } = useStdin();
104
- return isRawModeSupported ? (
105
- <InteractiveDevSession {...props} bundle={bundle} />
106
- ) : (
107
- <DevSession
108
- {...props}
109
- bundle={bundle}
110
- local={props.initialMode === "local"}
111
- />
112
- );
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
+ );
113
172
  }
114
173
 
115
- type InteractiveDevSessionProps = DevProps & {
116
- bundle: EsbuildBundle | undefined;
117
- };
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
+ });
118
191
 
119
- function InteractiveDevSession(props: InteractiveDevSessionProps) {
120
- const toggles = useHotkeys(
121
- {
122
- local: props.initialMode === "local",
123
- tunnel: false,
124
- },
125
- props.port,
126
- props.ip,
127
- props.inspectorPort,
128
- props.localProtocol
129
- );
130
-
131
- useTunnel(toggles.tunnel);
132
-
133
- return (
134
- <>
135
- <DevSession {...props} local={toggles.local} />
136
- <Box borderStyle="round" paddingLeft={1} paddingRight={1}>
137
- <Text bold={true}>[b]</Text>
138
- <Text> open a browser, </Text>
139
- <Text bold={true}>[d]</Text>
140
- <Text> open Devtools, </Text>
141
- <Text bold={true}>[l]</Text>
142
- <Text> {toggles.local ? "turn off" : "turn on"} local mode, </Text>
143
- <Text bold={true}>[c]</Text>
144
- <Text> clear console, </Text>
145
- <Text bold={true}>[x]</Text>
146
- <Text> to exit</Text>
147
- </Box>
148
- </>
149
- );
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
+ );
150
232
  }
151
233
 
152
- type DevSessionProps = InteractiveDevSessionProps & { local: boolean };
234
+ type DevSessionProps = DevProps & {
235
+ local: boolean;
236
+ experimentalLocal?: boolean;
237
+ };
153
238
 
154
239
  function DevSession(props: DevSessionProps) {
155
- return props.local ? (
156
- <Local
157
- name={props.name}
158
- bundle={props.bundle}
159
- format={props.entry.format}
160
- compatibilityDate={props.compatibilityDate}
161
- localProtocol={props.localProtocol}
162
- compatibilityFlags={props.compatibilityFlags}
163
- bindings={props.bindings}
164
- assetPaths={props.assetPaths}
165
- public={props.public}
166
- port={props.port}
167
- ip={props.ip}
168
- rules={props.rules}
169
- inspectorPort={props.inspectorPort}
170
- enableLocalPersistence={props.enableLocalPersistence}
171
- crons={props.crons}
172
- />
173
- ) : (
174
- <Remote
175
- name={props.name}
176
- bundle={props.bundle}
177
- format={props.entry.format}
178
- accountId={props.accountId}
179
- bindings={props.bindings}
180
- assetPaths={props.assetPaths}
181
- public={props.public}
182
- port={props.port}
183
- ip={props.ip}
184
- localProtocol={props.localProtocol}
185
- inspectorPort={props.inspectorPort}
186
- compatibilityDate={props.compatibilityDate}
187
- compatibilityFlags={props.compatibilityFlags}
188
- usageModel={props.usageModel}
189
- env={props.env}
190
- legacyEnv={props.legacyEnv}
191
- zone={props.zone}
192
- host={props.host}
193
- />
194
- );
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
+ nodeCompat: props.nodeCompat,
282
+ betaD1Shims,
283
+ define: props.define,
284
+ noBundle: props.noBundle,
285
+ assets: props.assetsConfig,
286
+ workerDefinitions,
287
+ services: props.bindings.services,
288
+ durableObjects: props.bindings.durable_objects || { bindings: [] },
289
+ firstPartyWorkerDevFacade: props.firstPartyWorker,
290
+ local: props.local,
291
+ // Enable the bundling to know whether we are using dev or publish
292
+ targetConsumer: "dev",
293
+ testScheduled: props.testScheduled ?? false,
294
+ experimentalLocal: props.experimentalLocal,
295
+ });
296
+
297
+ // TODO(queues) support remote wrangler dev
298
+ if (
299
+ !props.local &&
300
+ (props.bindings.queues?.length || props.queueConsumers?.length)
301
+ ) {
302
+ logger.warn(
303
+ "Queues are currently in Beta and are not supported in wrangler dev remote mode."
304
+ );
305
+ }
306
+
307
+ const announceAndOnReady: typeof props.onReady = (finalIp, finalPort) => {
308
+ if (process.send) {
309
+ process.send(
310
+ JSON.stringify({
311
+ event: "DEV_SERVER_READY",
312
+ ip: finalIp,
313
+ port: finalPort,
314
+ })
315
+ );
316
+ }
317
+
318
+ if (props.onReady) {
319
+ props.onReady(finalIp, finalPort);
320
+ }
321
+ };
322
+
323
+ return props.local ? (
324
+ <Local
325
+ name={props.name}
326
+ bundle={bundle}
327
+ format={props.entry.format}
328
+ compatibilityDate={props.compatibilityDate}
329
+ compatibilityFlags={props.compatibilityFlags}
330
+ usageModel={props.usageModel}
331
+ bindings={props.bindings}
332
+ workerDefinitions={workerDefinitions}
333
+ assetPaths={props.assetPaths}
334
+ initialPort={props.initialPort}
335
+ initialIp={props.initialIp}
336
+ rules={props.rules}
337
+ inspectorPort={props.inspectorPort}
338
+ localPersistencePath={props.localPersistencePath}
339
+ liveReload={props.liveReload}
340
+ crons={props.crons}
341
+ queueConsumers={props.queueConsumers}
342
+ localProtocol={props.localProtocol}
343
+ localUpstream={props.localUpstream}
344
+ logPrefix={props.logPrefix}
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
+ );
195
381
  }
196
382
 
197
383
  export interface DirectorySyncResult {
198
- name: string;
199
- removeCallback: () => void;
384
+ name: string;
385
+ removeCallback: () => void;
200
386
  }
201
387
 
202
388
  function useTmpDir(): string | undefined {
203
- const [directory, setDirectory] = useState<DirectorySyncResult>();
204
- const handleError = useErrorHandler();
205
- useEffect(() => {
206
- let dir: DirectorySyncResult | undefined;
207
- try {
208
- dir = tmp.dirSync({ unsafeCleanup: true });
209
- setDirectory(dir);
210
- return;
211
- } catch (err) {
212
- logger.error(
213
- "Failed to create temporary directory to store built files."
214
- );
215
- handleError(err);
216
- }
217
- return () => {
218
- dir?.removeCallback();
219
- };
220
- }, [handleError]);
221
- 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;
222
408
  }
223
409
 
224
- function useCustomBuild(
225
- expectedEntry: Entry,
226
- build: {
227
- command?: string | undefined;
228
- cwd?: string | undefined;
229
- watch_dir?: string | undefined;
230
- }
231
- ): void {
232
- useEffect(() => {
233
- if (!build.command) return;
234
- let watcher: ReturnType<typeof watch> | undefined;
235
- if (build.watch_dir) {
236
- watcher = watch(build.watch_dir, {
237
- persistent: true,
238
- ignoreInitial: true,
239
- }).on("all", (_event, filePath) => {
240
- const relativeFile =
241
- path.relative(expectedEntry.directory, expectedEntry.file) || ".";
242
- //TODO: we should buffer requests to the proxy until this completes
243
- logger.log(`The file ${filePath} changed, restarting build...`);
244
- runCustomBuild(expectedEntry.file, relativeFile, build).catch((err) => {
245
- logger.error("Custom build failed:", err);
246
- });
247
- });
248
- }
249
-
250
- return () => {
251
- watcher?.close();
252
- };
253
- }, [build, expectedEntry]);
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]);
254
433
  }
255
434
 
256
435
  function sleep(period: number) {
257
- return new Promise((resolve) => setTimeout(resolve, period));
436
+ return new Promise((resolve) => setTimeout(resolve, period));
258
437
  }
259
438
  const SLEEP_DURATION = 2000;
260
439
  // really need a first class api for this
261
440
  const hostNameRegex = /userHostname="(.*)"/g;
262
441
  async function findTunnelHostname() {
263
- let hostName: string | undefined;
264
- while (!hostName) {
265
- try {
266
- const resp = await fetch("http://localhost:8789/metrics");
267
- const data = await resp.text();
268
- const matches = Array.from(data.matchAll(hostNameRegex));
269
- hostName = matches[0][1];
270
- } catch (err) {
271
- await sleep(SLEEP_DURATION);
272
- }
273
- }
274
- 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;
275
454
  }
276
455
 
277
456
  /**
@@ -279,134 +458,143 @@ async function findTunnelHostname() {
279
458
  * We've disabled this for now until we figure out a better user experience.
280
459
  */
281
460
  function useTunnel(toggle: boolean) {
282
- const tunnel = useRef<ReturnType<typeof spawn>>();
283
- const removeSignalExitListener = useRef<() => void>();
284
- // TODO: test if cloudflared is available, if not
285
- // point them to a url where they can get docs to install it
286
- useEffect(() => {
287
- async function startTunnel() {
288
- if (toggle) {
289
- try {
290
- await commandExists("cloudflared");
291
- } catch (e) {
292
- logger.warn(
293
- "To share your worker on the Internet, please install `cloudflared` from https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup/installation"
294
- );
295
- return;
296
- }
297
- logger.log("⎔ Starting a tunnel...");
298
- tunnel.current = spawn("cloudflared", [
299
- "tunnel",
300
- "--url",
301
- "http://localhost:8787",
302
- "--metrics",
303
- "localhost:8789",
304
- ]);
305
-
306
- tunnel.current.on("close", (code) => {
307
- if (code) {
308
- logger.log(`Tunnel process exited with code ${code}`);
309
- }
310
- });
311
-
312
- removeSignalExitListener.current = onExit((_code, _signal) => {
313
- logger.log("⎔ Shutting down local tunnel.");
314
- tunnel.current?.kill();
315
- tunnel.current = undefined;
316
- });
317
-
318
- const hostName = await findTunnelHostname();
319
- await clipboardy.write(hostName);
320
- logger.log(`⬣ Sharing at ${hostName}, copied to clipboard.`);
321
- }
322
- }
323
-
324
- startTunnel().catch(async (err) => {
325
- logger.error("tunnel:", err);
326
- });
327
-
328
- return () => {
329
- if (tunnel.current) {
330
- logger.log("⎔ Shutting down tunnel.");
331
- tunnel.current?.kill();
332
- tunnel.current = undefined;
333
- removeSignalExitListener.current && removeSignalExitListener.current();
334
- removeSignalExitListener.current = undefined;
335
- }
336
- };
337
- }, [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]);
338
517
  }
339
518
 
340
519
  type useHotkeysInitialState = {
341
- local: boolean;
342
- tunnel: boolean;
520
+ local: boolean;
521
+ tunnel: boolean;
343
522
  };
344
- function useHotkeys(
345
- initial: useHotkeysInitialState,
346
- port: number,
347
- ip: string,
348
- inspectorPort: number,
349
- localProtocol: "http" | "https"
350
- ) {
351
- // UGH, we should put port in context instead
352
- const [toggles, setToggles] = useState(initial);
353
- const { exit } = useApp();
354
- useInput(
355
- async (
356
- input,
357
- // eslint-disable-next-line unused-imports/no-unused-vars
358
- key
359
- ) => {
360
- switch (input.toLowerCase()) {
361
- // clear console
362
- case "c":
363
- console.clear();
364
- // This console.log causes Ink to re-render the `DevSession` component.
365
- // Couldn't find a better way to tell it to do so...
366
- console.log();
367
- break;
368
- // open browser
369
- case "b": {
370
- await openInBrowser(`${localProtocol}://${ip}:${port}`);
371
- break;
372
- }
373
- // toggle inspector
374
- case "d": {
375
- await openInspector(inspectorPort);
376
- break;
377
- }
378
- // toggle local
379
- case "l":
380
- setToggles((previousToggles) => ({
381
- ...previousToggles,
382
- local: !previousToggles.local,
383
- }));
384
- break;
385
- // shut down
386
- case "q":
387
- case "x":
388
- exit();
389
- break;
390
- default:
391
- // nothing?
392
- break;
393
- }
394
- }
395
- );
396
- 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;
397
585
  }
398
586
 
399
587
  function ErrorFallback(props: { error: Error }) {
400
- const { exit } = useApp();
401
- useEffect(() => exit(props.error));
402
- return (
403
- <>
404
- <Text>Something went wrong:</Text>
405
- <Text>{props.error.stack}</Text>
406
- </>
407
- );
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
+ );
408
596
  }
409
597
 
410
598
  export default withErrorBoundary(DevImplementation, {
411
- FallbackComponent: ErrorFallback,
599
+ FallbackComponent: ErrorFallback,
412
600
  });