wrangler 0.0.0-e978986 → 0.0.0-e98613f8

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