wrangler 0.0.0-e2f9bb2 → 0.0.0-e305903a

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