wrangler 0.0.0-e3ce82b → 0.0.0-e41c7e41

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