wrangler 0.0.0-e1b8ac4 → 0.0.0-e1c2f5b9

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 (295) hide show
  1. package/README.md +23 -3
  2. package/bin/wrangler.js +170 -62
  3. package/miniflare-dist/index.mjs +1499 -21
  4. package/package.json +193 -156
  5. package/src/__tests__/access.test.ts +25 -0
  6. package/src/__tests__/api-dev.test.ts +238 -0
  7. package/src/__tests__/api-devregistry.test.js +64 -0
  8. package/src/__tests__/api.test.ts +80 -0
  9. package/src/__tests__/config-cache-without-cache-dir.test.ts +38 -0
  10. package/src/__tests__/config-cache.test.ts +30 -24
  11. package/src/__tests__/configuration.test.ts +4152 -3537
  12. package/src/__tests__/d1.test.ts +123 -0
  13. package/src/__tests__/delete.test.ts +263 -0
  14. package/src/__tests__/deployments.test.ts +105 -0
  15. package/src/__tests__/dev.test.tsx +1559 -1028
  16. package/src/__tests__/dialogs.test.tsx +40 -0
  17. package/src/__tests__/generate.test.ts +235 -0
  18. package/src/__tests__/get-host-from-url.test.ts +16 -0
  19. package/src/__tests__/guess-worker-format.test.ts +68 -68
  20. package/src/__tests__/helpers/cmd-shim.d.ts +6 -6
  21. package/src/__tests__/helpers/mock-account-id.ts +24 -24
  22. package/src/__tests__/helpers/mock-auth-domain.ts +20 -0
  23. package/src/__tests__/helpers/mock-bin.ts +20 -20
  24. package/src/__tests__/helpers/mock-cfetch.ts +165 -99
  25. package/src/__tests__/helpers/mock-console.ts +58 -39
  26. package/src/__tests__/helpers/mock-dialogs.ts +94 -94
  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 +244 -228
  33. package/src/__tests__/helpers/mock-process.ts +23 -13
  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 +245 -234
  56. package/src/__tests__/init.test.ts +3027 -1925
  57. package/src/__tests__/jest.setup.ts +157 -61
  58. package/src/__tests__/kv.test.ts +1773 -1507
  59. package/src/__tests__/logger.test.ts +96 -96
  60. package/src/__tests__/logout.test.ts +47 -0
  61. package/src/__tests__/metrics.test.ts +495 -0
  62. package/src/__tests__/middleware.scheduled.test.ts +145 -0
  63. package/src/__tests__/middleware.test.ts +750 -0
  64. package/src/__tests__/package-manager.test.ts +303 -303
  65. package/src/__tests__/pages-deployment-tail.test.ts +884 -0
  66. package/src/__tests__/pages.test.ts +2424 -735
  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 +7621 -5798
  70. package/src/__tests__/pubsub.test.ts +490 -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 +673 -460
  75. package/src/__tests__/tail.test.ts +776 -567
  76. package/src/__tests__/test-old-node-version.js +31 -0
  77. package/src/__tests__/tsconfig-sanity.ts +12 -0
  78. package/src/__tests__/tsconfig.json +8 -0
  79. package/src/__tests__/tsconfig.tsbuildinfo +1 -0
  80. package/src/__tests__/type-generation.test.ts +233 -0
  81. package/src/__tests__/user.test.ts +117 -120
  82. package/src/__tests__/utils-collectKeyValues.test.ts +47 -0
  83. package/src/__tests__/validate-dev-props.test.ts +56 -0
  84. package/src/__tests__/version.test.ts +35 -0
  85. package/src/__tests__/whoami.test.tsx +264 -125
  86. package/src/__tests__/worker-namespace.test.ts +326 -0
  87. package/src/abort.d.ts +1 -1
  88. package/src/api/dev.ts +218 -0
  89. package/src/api/index.ts +2 -0
  90. package/src/bundle-reporter.tsx +68 -0
  91. package/src/bundle.ts +785 -166
  92. package/src/cfetch/index.ts +120 -83
  93. package/src/cfetch/internal.ts +211 -92
  94. package/src/cli.ts +23 -8
  95. package/src/config/config.ts +236 -204
  96. package/src/config/diagnostics.ts +61 -61
  97. package/src/config/environment.ts +514 -357
  98. package/src/config/index.ts +326 -193
  99. package/src/config/validation-helpers.ts +379 -366
  100. package/src/config/validation.ts +1973 -1402
  101. package/src/config-cache.ts +81 -41
  102. package/src/create-worker-preview.ts +239 -142
  103. package/src/create-worker-upload-form.ts +309 -238
  104. package/src/d1/backups.tsx +223 -0
  105. package/src/d1/constants.ts +2 -0
  106. package/src/d1/create.tsx +63 -0
  107. package/src/d1/delete.tsx +56 -0
  108. package/src/d1/execute.tsx +352 -0
  109. package/src/d1/formatTimeAgo.ts +14 -0
  110. package/src/d1/index.ts +101 -0
  111. package/src/d1/list.tsx +48 -0
  112. package/src/d1/migrations/apply.tsx +196 -0
  113. package/src/d1/migrations/create.tsx +77 -0
  114. package/src/d1/migrations/helpers.ts +147 -0
  115. package/src/d1/migrations/index.tsx +3 -0
  116. package/src/d1/migrations/list.tsx +79 -0
  117. package/src/d1/migrations/options.ts +18 -0
  118. package/src/d1/options.ts +22 -0
  119. package/src/d1/types.tsx +24 -0
  120. package/src/d1/utils.ts +48 -0
  121. package/src/delete.ts +108 -0
  122. package/src/deployments.ts +83 -0
  123. package/src/deprecated/index.ts +145 -0
  124. package/src/dev/dev-vars.ts +20 -17
  125. package/src/dev/dev.tsx +544 -329
  126. package/src/dev/get-local-persistence-path.tsx +31 -0
  127. package/src/dev/local.tsx +912 -301
  128. package/src/dev/remote.tsx +591 -230
  129. package/src/dev/start-server.ts +543 -0
  130. package/src/dev/use-esbuild.ts +183 -91
  131. package/src/dev/validate-dev-props.ts +31 -0
  132. package/src/dev-registry.tsx +201 -0
  133. package/src/dev.tsx +949 -0
  134. package/src/dialogs.tsx +132 -99
  135. package/src/dispatch-namespace.ts +207 -0
  136. package/src/docs/index.ts +97 -0
  137. package/src/durable.ts +87 -87
  138. package/src/entry.ts +235 -228
  139. package/src/environment-variables/factory.ts +88 -0
  140. package/src/environment-variables/misc-variables.ts +30 -0
  141. package/src/errors.ts +6 -6
  142. package/src/generate/index.ts +300 -0
  143. package/src/git-client.ts +135 -0
  144. package/src/global-wrangler-config-path.ts +26 -0
  145. package/src/https-options.ts +84 -80
  146. package/src/index.tsx +637 -2850
  147. package/src/init.ts +1025 -0
  148. package/src/inspect.ts +698 -593
  149. package/src/intl-polyfill.d.ts +123 -123
  150. package/src/is-ci.ts +14 -0
  151. package/src/is-interactive.ts +16 -0
  152. package/src/jest.d.ts +4 -0
  153. package/src/kv/helpers.ts +430 -0
  154. package/src/kv/index.ts +596 -0
  155. package/src/logger.ts +64 -45
  156. package/src/metrics/index.ts +5 -0
  157. package/src/metrics/metrics-config.ts +239 -0
  158. package/src/metrics/metrics-dispatcher.ts +96 -0
  159. package/src/metrics/metrics-usage-headers.ts +24 -0
  160. package/src/metrics/send-event.ts +97 -0
  161. package/src/miniflare-cli/assets.ts +250 -0
  162. package/src/miniflare-cli/index.ts +202 -33
  163. package/src/miniflare-cli/request-context.ts +18 -18
  164. package/src/miniflare-cli/tsconfig.json +9 -0
  165. package/src/miniflare-cli/tsconfig.tsbuildinfo +1 -0
  166. package/src/miniflare-cli/types.ts +11 -0
  167. package/src/module-collection.ts +221 -212
  168. package/src/open-in-browser.ts +4 -4
  169. package/src/package-manager.ts +173 -128
  170. package/src/pages/build.tsx +270 -0
  171. package/src/pages/constants.ts +18 -0
  172. package/src/pages/deployment-tails.tsx +284 -0
  173. package/src/pages/deployments.tsx +84 -0
  174. package/src/pages/dev.tsx +710 -0
  175. package/src/pages/errors.ts +66 -0
  176. package/src/pages/functions/buildPlugin.ts +107 -0
  177. package/src/pages/functions/buildWorker.ts +166 -0
  178. package/{pages → src/pages}/functions/filepath-routing.test.ts +113 -113
  179. package/src/pages/functions/filepath-routing.ts +189 -0
  180. package/src/pages/functions/identifiers.ts +78 -0
  181. package/src/pages/functions/routes-consolidation.test.ts +250 -0
  182. package/src/pages/functions/routes-consolidation.ts +73 -0
  183. package/src/pages/functions/routes-transformation.test.ts +282 -0
  184. package/src/pages/functions/routes-transformation.ts +115 -0
  185. package/src/pages/functions/routes-validation.test.ts +403 -0
  186. package/src/pages/functions/routes-validation.ts +202 -0
  187. package/src/pages/functions/routes.ts +151 -0
  188. package/src/pages/functions/tsconfig.json +8 -0
  189. package/src/pages/functions/tsconfig.tsbuildinfo +1 -0
  190. package/src/pages/functions.tsx +82 -0
  191. package/src/pages/hash.tsx +13 -0
  192. package/src/pages/index.tsx +102 -0
  193. package/src/pages/projects.tsx +169 -0
  194. package/src/pages/prompt-select-project.tsx +31 -0
  195. package/src/pages/publish.tsx +461 -0
  196. package/src/pages/types.ts +41 -0
  197. package/src/pages/upload.tsx +447 -0
  198. package/src/pages/utils.ts +23 -0
  199. package/src/parse.ts +202 -138
  200. package/src/paths.ts +53 -8
  201. package/src/proxy.ts +623 -405
  202. package/src/publish/index.ts +270 -0
  203. package/src/publish/publish.ts +1036 -0
  204. package/src/pubsub/index.ts +286 -0
  205. package/src/pubsub/pubsub-commands.tsx +624 -0
  206. package/src/queues/cli/commands/consumer/add.ts +71 -0
  207. package/src/queues/cli/commands/consumer/index.ts +22 -0
  208. package/src/queues/cli/commands/consumer/remove.ts +38 -0
  209. package/src/queues/cli/commands/create.ts +25 -0
  210. package/src/queues/cli/commands/delete.ts +26 -0
  211. package/src/queues/cli/commands/index.ts +36 -0
  212. package/src/queues/cli/commands/list.ts +25 -0
  213. package/src/queues/client.ts +135 -0
  214. package/src/queues/utils.ts +18 -0
  215. package/src/r2/constants.ts +4 -0
  216. package/src/r2/helpers.ts +131 -0
  217. package/src/r2/index.ts +289 -0
  218. package/src/routes.ts +140 -0
  219. package/src/secret/index.ts +379 -0
  220. package/src/selfsigned.d.ts +23 -23
  221. package/src/sites.tsx +258 -254
  222. package/src/tail/createTail.ts +379 -0
  223. package/src/tail/filters.ts +108 -110
  224. package/src/tail/index.ts +211 -296
  225. package/src/tail/printing.ts +86 -46
  226. package/src/tsconfig-sanity.ts +16 -0
  227. package/src/type-generation.ts +181 -0
  228. package/src/update-check.ts +11 -11
  229. package/src/user/access.ts +68 -0
  230. package/src/user/auth-variables.ts +113 -0
  231. package/src/user/choose-account.tsx +69 -0
  232. package/src/user/generate-auth-url.ts +33 -0
  233. package/src/user/generate-random-state.ts +16 -0
  234. package/src/user/index.ts +2 -0
  235. package/src/user/user.tsx +1238 -0
  236. package/src/utils/collectKeyValues.ts +14 -0
  237. package/src/whoami.tsx +141 -43
  238. package/src/worker.ts +177 -107
  239. package/src/yargs-types.ts +24 -0
  240. package/src/zones.ts +158 -40
  241. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  242. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  243. package/templates/__tests__/tsconfig.json +8 -0
  244. package/templates/__tests__/tsconfig.tsbuildinfo +1 -0
  245. package/templates/checked-fetch.js +17 -0
  246. package/templates/d1-beta-facade.js +205 -0
  247. package/templates/facade.d.ts +14 -0
  248. package/templates/first-party-worker-module-facade.ts +19 -0
  249. package/templates/format-dev-errors.ts +33 -0
  250. package/templates/init-tests/test-jest-new-worker.js +23 -0
  251. package/templates/init-tests/test-vitest-new-worker.js +24 -0
  252. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  253. package/templates/middleware/common.ts +62 -0
  254. package/templates/middleware/loader-modules.ts +82 -0
  255. package/templates/middleware/loader-sw.ts +233 -0
  256. package/templates/middleware/middleware-miniflare3-json-error.ts +20 -0
  257. package/templates/middleware/middleware-pretty-error.ts +40 -0
  258. package/templates/middleware/middleware-scheduled.ts +15 -0
  259. package/templates/new-worker-scheduled.js +3 -3
  260. package/templates/new-worker-scheduled.ts +15 -15
  261. package/templates/new-worker.js +3 -3
  262. package/templates/new-worker.ts +15 -15
  263. package/templates/no-op-worker.js +10 -0
  264. package/templates/pages-dev-pipeline.ts +31 -0
  265. package/templates/pages-dev-util.ts +52 -0
  266. package/templates/pages-shim.ts +12 -0
  267. package/templates/pages-template-plugin.ts +171 -0
  268. package/templates/pages-template-worker.ts +189 -0
  269. package/templates/serve-static-assets.ts +65 -0
  270. package/templates/service-bindings-module-facade.js +54 -0
  271. package/templates/service-bindings-sw-facade.js +42 -0
  272. package/templates/tsconfig-sanity.ts +11 -0
  273. package/templates/tsconfig.init.json +106 -0
  274. package/templates/tsconfig.json +6 -103
  275. package/templates/tsconfig.tsbuildinfo +1 -0
  276. package/wrangler-dist/cli.d.ts +906 -0
  277. package/wrangler-dist/cli.js +147920 -108883
  278. package/pages/functions/buildPlugin.ts +0 -105
  279. package/pages/functions/buildWorker.ts +0 -151
  280. package/pages/functions/filepath-routing.ts +0 -189
  281. package/pages/functions/identifiers.ts +0 -78
  282. package/pages/functions/routes.ts +0 -156
  283. package/pages/functions/template-plugin.ts +0 -147
  284. package/pages/functions/template-worker.ts +0 -143
  285. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  286. package/src/environment-variables.ts +0 -35
  287. package/src/generate-auth-url.ts +0 -33
  288. package/src/generate-random-state.ts +0 -16
  289. package/src/kv.ts +0 -408
  290. package/src/miniflare-cli/enum-keys.ts +0 -17
  291. package/src/pages.tsx +0 -2093
  292. package/src/publish.ts +0 -726
  293. package/src/r2.ts +0 -50
  294. package/src/user.tsx +0 -1202
  295. 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,249 +23,448 @@ 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
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
+ }
111
+
24
112
  export type DevProps = {
25
- name?: string;
26
- entry: Entry;
27
- port: number;
28
- ip: string;
29
- inspectorPort: number;
30
- rules: Config["rules"];
31
- accountId: string | undefined;
32
- initialMode: "local" | "remote";
33
- jsxFactory: string | undefined;
34
- jsxFragment: string | undefined;
35
- tsconfig: string | undefined;
36
- upstreamProtocol: "https" | "http";
37
- localProtocol: "https" | "http";
38
- enableLocalPersistence: boolean;
39
- bindings: CfWorkerInit["bindings"];
40
- crons: Config["triggers"]["crons"];
41
- isWorkersSite: boolean;
42
- assetPaths: AssetPaths | undefined;
43
- compatibilityDate: string;
44
- compatibilityFlags: string[] | undefined;
45
- usageModel: "bundled" | "unbound" | undefined;
46
- minify: boolean | undefined;
47
- nodeCompat: boolean | undefined;
48
- build: Config["build"];
49
- env: string | undefined;
50
- legacyEnv: boolean;
51
- zone: string | undefined;
52
- 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;
53
159
  };
54
160
 
55
161
  export function DevImplementation(props: DevProps): JSX.Element {
56
- if (
57
- !props.isWorkersSite &&
58
- props.assetPaths &&
59
- props.entry.format === "service-worker"
60
- ) {
61
- throw new Error(
62
- "You cannot use the service-worker format with an `assets` directory yet. For information on how to migrate to the module-worker format, see: https://developers.cloudflare.com/workers/learning/migrating-to-module-workers/"
63
- );
64
- }
65
-
66
- if (props.bindings.wasm_modules && props.entry.format === "modules") {
67
- throw new Error(
68
- "You cannot configure [wasm_modules] with an ES module worker. Instead, import the .wasm module directly in your code"
69
- );
70
- }
71
-
72
- if (props.bindings.text_blobs && props.entry.format === "modules") {
73
- throw new Error(
74
- "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"
75
- );
76
- }
77
-
78
- if (props.bindings.data_blobs && props.entry.format === "modules") {
79
- throw new Error(
80
- "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"
81
- );
82
- }
83
-
84
- // only load the UI if we're running in a supported environment
85
- const { isRawModeSupported } = useStdin();
86
- return isRawModeSupported ? (
87
- <InteractiveDevSession {...props} />
88
- ) : (
89
- <DevSession {...props} local={props.initialMode === "local"} />
90
- );
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
+ );
91
172
  }
92
173
 
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
+
93
180
  function InteractiveDevSession(props: DevProps) {
94
- const toggles = useHotkeys(
95
- {
96
- local: props.initialMode === "local",
97
- tunnel: false,
98
- },
99
- props.port,
100
- props.ip,
101
- props.inspectorPort,
102
- props.localProtocol
103
- );
104
-
105
- useTunnel(toggles.tunnel);
106
-
107
- return (
108
- <>
109
- <DevSession {...props} local={toggles.local} />
110
- <Box borderStyle="round" paddingLeft={1} paddingRight={1}>
111
- <Text bold={true}>[b]</Text>
112
- <Text> open a browser, </Text>
113
- <Text bold={true}>[d]</Text>
114
- <Text> open Devtools, </Text>
115
- <Text bold={true}>[l]</Text>
116
- <Text> {toggles.local ? "turn off" : "turn on"} local mode, </Text>
117
- <Text bold={true}>[c]</Text>
118
- <Text> clear console, </Text>
119
- <Text bold={true}>[x]</Text>
120
- <Text> to exit</Text>
121
- </Box>
122
- </>
123
- );
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
+ });
191
+
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
+ );
124
232
  }
125
233
 
126
234
  type DevSessionProps = DevProps & {
127
- local: boolean;
235
+ local: boolean;
236
+ experimentalLocal?: boolean;
128
237
  };
129
238
 
130
239
  function DevSession(props: DevSessionProps) {
131
- useCustomBuild(props.entry, props.build);
132
-
133
- const directory = useTmpDir();
134
-
135
- const bundle = useEsbuild({
136
- entry: props.entry,
137
- destination: directory,
138
- jsxFactory: props.jsxFactory,
139
- rules: props.rules,
140
- jsxFragment: props.jsxFragment,
141
- serveAssetsFromWorker: Boolean(
142
- props.assetPaths && !props.isWorkersSite && !props.local
143
- ),
144
- tsconfig: props.tsconfig,
145
- minify: props.minify,
146
- nodeCompat: props.nodeCompat,
147
- });
148
-
149
- return props.local ? (
150
- <Local
151
- name={props.name}
152
- bundle={bundle}
153
- format={props.entry.format}
154
- compatibilityDate={props.compatibilityDate}
155
- localProtocol={props.localProtocol}
156
- compatibilityFlags={props.compatibilityFlags}
157
- bindings={props.bindings}
158
- assetPaths={props.assetPaths}
159
- isWorkersSite={props.isWorkersSite}
160
- port={props.port}
161
- ip={props.ip}
162
- rules={props.rules}
163
- inspectorPort={props.inspectorPort}
164
- enableLocalPersistence={props.enableLocalPersistence}
165
- crons={props.crons}
166
- />
167
- ) : (
168
- <Remote
169
- name={props.name}
170
- bundle={bundle}
171
- format={props.entry.format}
172
- accountId={props.accountId}
173
- bindings={props.bindings}
174
- assetPaths={props.assetPaths}
175
- isWorkersSite={props.isWorkersSite}
176
- port={props.port}
177
- ip={props.ip}
178
- localProtocol={props.localProtocol}
179
- inspectorPort={props.inspectorPort}
180
- compatibilityDate={props.compatibilityDate}
181
- compatibilityFlags={props.compatibilityFlags}
182
- usageModel={props.usageModel}
183
- env={props.env}
184
- legacyEnv={props.legacyEnv}
185
- zone={props.zone}
186
- host={props.host}
187
- />
188
- );
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
+ );
189
395
  }
190
396
 
191
397
  export interface DirectorySyncResult {
192
- name: string;
193
- removeCallback: () => void;
398
+ name: string;
399
+ removeCallback: () => void;
194
400
  }
195
401
 
196
402
  function useTmpDir(): string | undefined {
197
- const [directory, setDirectory] = useState<DirectorySyncResult>();
198
- const handleError = useErrorHandler();
199
- useEffect(() => {
200
- let dir: DirectorySyncResult | undefined;
201
- try {
202
- dir = tmp.dirSync({ unsafeCleanup: true });
203
- setDirectory(dir);
204
- return;
205
- } catch (err) {
206
- logger.error(
207
- "Failed to create temporary directory to store built files."
208
- );
209
- handleError(err);
210
- }
211
- return () => {
212
- dir?.removeCallback();
213
- };
214
- }, [handleError]);
215
- 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;
216
422
  }
217
423
 
218
424
  function useCustomBuild(expectedEntry: Entry, build: Config["build"]): void {
219
- useEffect(() => {
220
- if (!build.command) return;
221
- let watcher: ReturnType<typeof watch> | undefined;
222
- if (build.watch_dir) {
223
- watcher = watch(build.watch_dir, {
224
- persistent: true,
225
- ignoreInitial: true,
226
- }).on("all", (_event, filePath) => {
227
- const relativeFile =
228
- path.relative(expectedEntry.directory, expectedEntry.file) || ".";
229
- //TODO: we should buffer requests to the proxy until this completes
230
- logger.log(`The file ${filePath} changed, restarting build...`);
231
- runCustomBuild(expectedEntry.file, relativeFile, build).catch((err) => {
232
- logger.error("Custom build failed:", err);
233
- });
234
- });
235
- }
236
-
237
- return () => {
238
- watcher?.close();
239
- };
240
- }, [build, expectedEntry]);
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
+ void watcher?.close();
445
+ };
446
+ }, [build, expectedEntry]);
241
447
  }
242
448
 
243
449
  function sleep(period: number) {
244
- return new Promise((resolve) => setTimeout(resolve, period));
450
+ return new Promise((resolve) => setTimeout(resolve, period));
245
451
  }
246
452
  const SLEEP_DURATION = 2000;
247
453
  // really need a first class api for this
248
454
  const hostNameRegex = /userHostname="(.*)"/g;
249
455
  async function findTunnelHostname() {
250
- let hostName: string | undefined;
251
- while (!hostName) {
252
- try {
253
- const resp = await fetch("http://localhost:8789/metrics");
254
- const data = await resp.text();
255
- const matches = Array.from(data.matchAll(hostNameRegex));
256
- hostName = matches[0][1];
257
- } catch (err) {
258
- await sleep(SLEEP_DURATION);
259
- }
260
- }
261
- 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;
262
468
  }
263
469
 
264
470
  /**
@@ -266,134 +472,143 @@ async function findTunnelHostname() {
266
472
  * We've disabled this for now until we figure out a better user experience.
267
473
  */
268
474
  function useTunnel(toggle: boolean) {
269
- const tunnel = useRef<ReturnType<typeof spawn>>();
270
- const removeSignalExitListener = useRef<() => void>();
271
- // TODO: test if cloudflared is available, if not
272
- // point them to a url where they can get docs to install it
273
- useEffect(() => {
274
- async function startTunnel() {
275
- if (toggle) {
276
- try {
277
- await commandExists("cloudflared");
278
- } catch (e) {
279
- logger.warn(
280
- "To share your worker on the Internet, please install `cloudflared` from https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup/installation"
281
- );
282
- return;
283
- }
284
- logger.log("⎔ Starting a tunnel...");
285
- tunnel.current = spawn("cloudflared", [
286
- "tunnel",
287
- "--url",
288
- "http://localhost:8787",
289
- "--metrics",
290
- "localhost:8789",
291
- ]);
292
-
293
- tunnel.current.on("close", (code) => {
294
- if (code) {
295
- logger.log(`Tunnel process exited with code ${code}`);
296
- }
297
- });
298
-
299
- removeSignalExitListener.current = onExit((_code, _signal) => {
300
- logger.log("⎔ Shutting down local tunnel.");
301
- tunnel.current?.kill();
302
- tunnel.current = undefined;
303
- });
304
-
305
- const hostName = await findTunnelHostname();
306
- await clipboardy.write(hostName);
307
- logger.log(`⬣ Sharing at ${hostName}, copied to clipboard.`);
308
- }
309
- }
310
-
311
- startTunnel().catch(async (err) => {
312
- logger.error("tunnel:", err);
313
- });
314
-
315
- return () => {
316
- if (tunnel.current) {
317
- logger.log("⎔ Shutting down tunnel.");
318
- tunnel.current?.kill();
319
- tunnel.current = undefined;
320
- removeSignalExitListener.current && removeSignalExitListener.current();
321
- removeSignalExitListener.current = undefined;
322
- }
323
- };
324
- }, [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]);
325
531
  }
326
532
 
327
533
  type useHotkeysInitialState = {
328
- local: boolean;
329
- tunnel: boolean;
534
+ local: boolean;
535
+ tunnel: boolean;
330
536
  };
331
- function useHotkeys(
332
- initial: useHotkeysInitialState,
333
- port: number,
334
- ip: string,
335
- inspectorPort: number,
336
- localProtocol: "http" | "https"
337
- ) {
338
- // UGH, we should put port in context instead
339
- const [toggles, setToggles] = useState(initial);
340
- const { exit } = useApp();
341
- useInput(
342
- async (
343
- input,
344
- // eslint-disable-next-line unused-imports/no-unused-vars
345
- key
346
- ) => {
347
- switch (input.toLowerCase()) {
348
- // clear console
349
- case "c":
350
- console.clear();
351
- // This console.log causes Ink to re-render the `DevSession` component.
352
- // Couldn't find a better way to tell it to do so...
353
- console.log();
354
- break;
355
- // open browser
356
- case "b": {
357
- await openInBrowser(`${localProtocol}://${ip}:${port}`);
358
- break;
359
- }
360
- // toggle inspector
361
- case "d": {
362
- await openInspector(inspectorPort);
363
- break;
364
- }
365
- // toggle local
366
- case "l":
367
- setToggles((previousToggles) => ({
368
- ...previousToggles,
369
- local: !previousToggles.local,
370
- }));
371
- break;
372
- // shut down
373
- case "q":
374
- case "x":
375
- exit();
376
- break;
377
- default:
378
- // nothing?
379
- break;
380
- }
381
- }
382
- );
383
- 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;
384
599
  }
385
600
 
386
601
  function ErrorFallback(props: { error: Error }) {
387
- const { exit } = useApp();
388
- useEffect(() => exit(props.error));
389
- return (
390
- <>
391
- <Text>Something went wrong:</Text>
392
- <Text>{props.error.stack}</Text>
393
- </>
394
- );
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
+ );
395
610
  }
396
611
 
397
612
  export default withErrorBoundary(DevImplementation, {
398
- FallbackComponent: ErrorFallback,
613
+ FallbackComponent: ErrorFallback,
399
614
  });