wrangler 0.0.0-e2f9bb2 → 0.0.0-e30d1013

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