wrangler 0.0.0-e2b7352 → 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 (264) hide show
  1. package/Cloudflare_CA.pem +18 -0
  2. package/README.md +51 -14
  3. package/bin/wrangler.js +154 -31
  4. package/kv-asset-handler.js +1 -0
  5. package/miniflare-dist/index.mjs +6244 -21
  6. package/package.json +185 -141
  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 +42 -0
  12. package/src/__tests__/configuration.test.ts +4122 -2810
  13. package/src/__tests__/dev.test.tsx +1341 -527
  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 +74 -57
  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 +202 -93
  21. package/src/__tests__/helpers/mock-console.ts +68 -32
  22. package/src/__tests__/helpers/mock-dialogs.ts +121 -33
  23. package/src/__tests__/helpers/mock-get-zone-from-host.ts +8 -0
  24. package/src/__tests__/helpers/mock-http-server.ts +46 -0
  25. package/src/__tests__/helpers/mock-istty.ts +74 -0
  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 +252 -0
  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 +28 -22
  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 +31 -0
  46. package/src/__tests__/helpers/write-wrangler-toml.ts +9 -9
  47. package/src/__tests__/https-options.test.ts +144 -108
  48. package/src/__tests__/index.test.ts +233 -967
  49. package/src/__tests__/init.test.ts +2717 -0
  50. package/src/__tests__/jest.setup.ts +151 -34
  51. package/src/__tests__/kv.test.ts +1376 -1085
  52. package/src/__tests__/logger.test.ts +141 -0
  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 +1990 -77
  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 +6989 -3411
  61. package/src/__tests__/pubsub.test.ts +367 -0
  62. package/src/__tests__/r2.test.ts +363 -190
  63. package/src/__tests__/route.test.ts +22 -22
  64. package/src/__tests__/secret.test.ts +626 -407
  65. package/src/__tests__/tail.test.ts +653 -516
  66. package/src/__tests__/test-old-node-version.js +31 -0
  67. package/src/__tests__/user.test.ts +155 -0
  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 +261 -88
  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 +723 -122
  77. package/src/cfetch/index.ts +83 -66
  78. package/src/cfetch/internal.ts +267 -92
  79. package/src/cli.ts +24 -14
  80. package/src/config/README.md +1 -1
  81. package/src/config/config.ts +236 -179
  82. package/src/config/diagnostics.ts +61 -61
  83. package/src/config/environment.ts +450 -316
  84. package/src/config/index.ts +259 -38
  85. package/src/config/validation-helpers.ts +385 -342
  86. package/src/config/validation.ts +1797 -1099
  87. package/src/config-cache.ts +85 -0
  88. package/src/create-worker-preview.ts +233 -124
  89. package/src/create-worker-upload-form.ts +285 -201
  90. package/src/d1/backups.tsx +212 -0
  91. package/src/d1/create.tsx +54 -0
  92. package/src/d1/delete.tsx +56 -0
  93. package/src/d1/execute.tsx +294 -0
  94. package/src/d1/formatTimeAgo.ts +14 -0
  95. package/src/d1/index.ts +75 -0
  96. package/src/d1/list.tsx +48 -0
  97. package/src/d1/options.ts +12 -0
  98. package/src/d1/types.tsx +14 -0
  99. package/src/d1/utils.ts +39 -0
  100. package/src/dev/dev-vars.ts +36 -0
  101. package/src/dev/dev.tsx +501 -328
  102. package/src/dev/get-local-persistence-path.tsx +31 -0
  103. package/src/dev/local.tsx +629 -211
  104. package/src/dev/remote.tsx +398 -188
  105. package/src/dev/start-server.ts +443 -0
  106. package/src/dev/use-esbuild.ts +175 -82
  107. package/src/dev/validate-dev-props.ts +31 -0
  108. package/src/dev-registry.tsx +190 -0
  109. package/src/dev.tsx +869 -0
  110. package/src/dialogs.tsx +138 -57
  111. package/src/dispatch-namespace.ts +206 -0
  112. package/src/durable.ts +102 -0
  113. package/src/entry.ts +260 -171
  114. package/src/environment-variables.ts +40 -23
  115. package/src/errors.ts +11 -0
  116. package/src/faye-websocket.d.ts +6 -0
  117. package/src/generate.ts +131 -0
  118. package/src/git-client.ts +42 -0
  119. package/src/global-wrangler-config-path.ts +26 -0
  120. package/src/https-options.ts +85 -80
  121. package/src/index.tsx +2295 -2315
  122. package/src/init.ts +967 -0
  123. package/src/inspect.ts +687 -557
  124. package/src/intl-polyfill.d.ts +123 -123
  125. package/src/is-ci.ts +14 -0
  126. package/src/is-interactive.ts +12 -0
  127. package/src/kv.ts +353 -242
  128. package/src/logger.ts +80 -0
  129. package/src/metrics/index.ts +5 -0
  130. package/src/metrics/metrics-config.ts +239 -0
  131. package/src/metrics/metrics-dispatcher.ts +96 -0
  132. package/src/metrics/metrics-usage-headers.ts +24 -0
  133. package/src/metrics/send-event.ts +93 -0
  134. package/src/miniflare-cli/assets.ts +215 -0
  135. package/src/miniflare-cli/index.ts +201 -30
  136. package/src/miniflare-cli/request-context.ts +40 -0
  137. package/src/module-collection.ts +213 -213
  138. package/src/open-in-browser.ts +8 -16
  139. package/src/package-manager.ts +183 -90
  140. package/src/pages/build.tsx +238 -0
  141. package/src/pages/constants.ts +16 -0
  142. package/src/pages/deployments.tsx +106 -0
  143. package/src/pages/dev.tsx +684 -0
  144. package/src/pages/errors.ts +66 -0
  145. package/src/pages/functions/buildPlugin.ts +110 -0
  146. package/src/pages/functions/buildWorker.ts +156 -0
  147. package/src/pages/functions/filepath-routing.test.ts +234 -0
  148. package/src/pages/functions/filepath-routing.ts +189 -0
  149. package/src/pages/functions/identifiers.ts +78 -0
  150. package/src/pages/functions/routes-consolidation.test.ts +250 -0
  151. package/src/pages/functions/routes-consolidation.ts +73 -0
  152. package/src/pages/functions/routes-transformation.test.ts +282 -0
  153. package/src/pages/functions/routes-transformation.ts +115 -0
  154. package/src/pages/functions/routes-validation.test.ts +403 -0
  155. package/src/pages/functions/routes-validation.ts +202 -0
  156. package/src/pages/functions/routes.ts +151 -0
  157. package/src/pages/functions.tsx +82 -0
  158. package/src/pages/hash.tsx +13 -0
  159. package/src/pages/index.tsx +94 -0
  160. package/src/pages/projects.tsx +169 -0
  161. package/src/pages/publish.tsx +419 -0
  162. package/src/pages/types.ts +49 -0
  163. package/src/pages/upload.tsx +398 -0
  164. package/src/pages/utils.ts +12 -0
  165. package/src/parse.ts +224 -121
  166. package/src/paths.ts +53 -8
  167. package/src/preview.ts +31 -0
  168. package/src/proxy.ts +436 -370
  169. package/src/publish.ts +839 -324
  170. package/src/pubsub/index.ts +286 -0
  171. package/src/pubsub/pubsub-commands.tsx +623 -0
  172. package/src/r2.ts +100 -19
  173. package/src/selfsigned.d.ts +23 -23
  174. package/src/sites.tsx +281 -189
  175. package/src/tail/filters.ts +108 -110
  176. package/src/tail/index.ts +234 -218
  177. package/src/tail/printing.ts +92 -47
  178. package/src/update-check.ts +19 -0
  179. package/src/user/choose-account.tsx +69 -0
  180. package/src/user/env-vars.ts +46 -0
  181. package/src/user/generate-auth-url.ts +33 -0
  182. package/src/user/generate-random-state.ts +16 -0
  183. package/src/user/index.ts +3 -0
  184. package/src/user/user.tsx +1192 -0
  185. package/src/whoami.tsx +142 -42
  186. package/src/worker.ts +171 -100
  187. package/src/zones.ts +167 -0
  188. package/templates/checked-fetch.js +17 -0
  189. package/templates/d1-beta-facade.js +174 -0
  190. package/templates/experimental-local-cache-stubs.js +27 -0
  191. package/templates/first-party-worker-module-facade.ts +18 -0
  192. package/templates/format-dev-errors.ts +32 -0
  193. package/templates/gitignore +171 -0
  194. package/templates/init-tests/test-jest-new-worker.js +25 -0
  195. package/templates/init-tests/test-vitest-new-worker.js +26 -0
  196. package/templates/middleware/common.ts +62 -0
  197. package/templates/middleware/loader-modules.ts +84 -0
  198. package/templates/middleware/loader-sw.ts +213 -0
  199. package/templates/middleware/middleware-pretty-error.ts +40 -0
  200. package/templates/middleware/middleware-scheduled.ts +15 -0
  201. package/templates/new-worker-scheduled.js +17 -0
  202. package/templates/new-worker-scheduled.ts +32 -0
  203. package/templates/new-worker.js +3 -3
  204. package/templates/new-worker.ts +18 -3
  205. package/templates/no-op-worker.js +10 -0
  206. package/templates/pages-dev-pipeline.ts +35 -0
  207. package/templates/pages-shim.ts +9 -0
  208. package/templates/pages-template-plugin.ts +167 -0
  209. package/templates/pages-template-worker.ts +172 -0
  210. package/templates/serve-static-assets.ts +63 -0
  211. package/templates/service-bindings-module-facade.js +54 -0
  212. package/templates/service-bindings-sw-facade.js +42 -0
  213. package/templates/tsconfig.json +95 -95
  214. package/wrangler-dist/cli.d.ts +841 -0
  215. package/wrangler-dist/cli.js +129492 -108210
  216. package/miniflare-dist/index.mjs.map +0 -7
  217. package/pages/functions/buildWorker.ts +0 -62
  218. package/pages/functions/filepath-routing.test.ts +0 -223
  219. package/pages/functions/filepath-routing.ts +0 -181
  220. package/pages/functions/identifiers.ts +0 -78
  221. package/pages/functions/routes.ts +0 -151
  222. package/pages/functions/template-worker.ts +0 -130
  223. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  224. package/src/__tests__/logout.test.ts +0 -52
  225. package/src/__tests__/sentry.test.ts +0 -146
  226. package/src/miniflare-cli/enum-keys.ts +0 -17
  227. package/src/pages.tsx +0 -1061
  228. package/src/reporting.ts +0 -131
  229. package/src/user.tsx +0 -1127
  230. package/templates/static-asset-facade.js +0 -47
  231. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  232. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  233. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  234. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  235. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  236. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  237. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  238. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  239. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  240. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  241. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  242. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  243. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  244. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  245. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  246. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  247. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  248. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  249. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  250. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  251. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  252. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  253. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  254. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  255. package/vendor/wrangler-mime/LICENSE +0 -21
  256. package/vendor/wrangler-mime/Mime.js +0 -97
  257. package/vendor/wrangler-mime/README.md +0 -187
  258. package/vendor/wrangler-mime/cli.js +0 -46
  259. package/vendor/wrangler-mime/index.js +0 -4
  260. package/vendor/wrangler-mime/lite.js +0 -4
  261. package/vendor/wrangler-mime/package.json +0 -52
  262. package/vendor/wrangler-mime/types/other.js +0 -1
  263. package/vendor/wrangler-mime/types/standard.js +0 -1
  264. package/wrangler-dist/cli.js.map +0 -7
package/src/dev/dev.tsx CHANGED
@@ -1,261 +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";
21
+ import { logger } from "../logger";
12
22
  import openInBrowser from "../open-in-browser";
13
- import { reportError } from "../reporting";
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: undefined | string;
32
- initialMode: "local" | "remote";
33
- jsxFactory: undefined | string;
34
- jsxFragment: undefined | string;
35
- tsconfig: string | undefined;
36
- upstreamProtocol: "https" | "http";
37
- localProtocol: "https" | "http";
38
- enableLocalPersistence: boolean;
39
- bindings: CfWorkerInit["bindings"];
40
- public: undefined | string;
41
- assetPaths: undefined | AssetPaths;
42
- compatibilityDate: undefined | string;
43
- compatibilityFlags: undefined | string[];
44
- usageModel: undefined | "bundled" | "unbound";
45
- build: {
46
- command?: undefined | string;
47
- cwd?: undefined | string;
48
- watch_dir?: undefined | string;
49
- };
50
- env: string | undefined;
51
- legacyEnv: boolean;
52
- zone:
53
- | {
54
- id: string;
55
- host: string;
56
- }
57
- | 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;
58
157
  };
59
158
 
60
159
  export function DevImplementation(props: DevProps): JSX.Element {
61
- const apiToken = props.initialMode === "remote" ? getAPIToken() : undefined;
62
- const directory = useTmpDir();
63
-
64
- useCustomBuild(props.entry, props.build);
65
-
66
- if (props.public && props.entry.format === "service-worker") {
67
- throw new Error(
68
- "You cannot use the service worker format with a `public` directory."
69
- );
70
- }
71
-
72
- if (props.bindings.wasm_modules && props.entry.format === "modules") {
73
- throw new Error(
74
- "You cannot configure [wasm_modules] with an ES module worker. Instead, import the .wasm module directly in your code"
75
- );
76
- }
77
-
78
- if (props.bindings.text_blobs && props.entry.format === "modules") {
79
- throw new Error(
80
- "You cannot configure [text_blobs] with an ES module worker. Instead, import the file directly in your code, and optionally configure `[build.upload.rules]` in your wrangler.toml"
81
- );
82
- }
83
-
84
- const bundle = useEsbuild({
85
- entry: props.entry,
86
- destination: directory,
87
- staticRoot: props.public,
88
- jsxFactory: props.jsxFactory,
89
- rules: props.rules,
90
- jsxFragment: props.jsxFragment,
91
- serveAssetsFromWorker: !!props.public,
92
- tsconfig: props.tsconfig,
93
- });
94
-
95
- // only load the UI if we're running in a supported environment
96
- const { isRawModeSupported } = useStdin();
97
- return isRawModeSupported ? (
98
- <InteractiveDevSession {...props} bundle={bundle} apiToken={apiToken} />
99
- ) : (
100
- <DevSession
101
- {...props}
102
- bundle={bundle}
103
- apiToken={apiToken}
104
- local={props.initialMode === "local"}
105
- />
106
- );
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
+ );
107
170
  }
108
171
 
109
- type InteractiveDevSessionProps = DevProps & {
110
- apiToken: string | undefined;
111
- bundle: EsbuildBundle | undefined;
112
- };
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);
113
187
 
114
- function InteractiveDevSession(props: InteractiveDevSessionProps) {
115
- const toggles = useHotkeys(
116
- {
117
- local: props.initialMode === "local",
118
- tunnel: false,
119
- },
120
- props.port,
121
- props.ip,
122
- props.inspectorPort,
123
- props.localProtocol
124
- );
125
-
126
- useTunnel(toggles.tunnel);
127
-
128
- return (
129
- <>
130
- <DevSession {...props} local={toggles.local} />
131
- <Box borderStyle="round" paddingLeft={1} paddingRight={1}>
132
- <Text>
133
- {`B to open a browser, D to open Devtools, L to ${
134
- toggles.local ? "turn off" : "turn on"
135
- } local mode, X to exit`}
136
- </Text>
137
- </Box>
138
- </>
139
- );
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
+ );
140
213
  }
141
214
 
142
- type DevSessionProps = InteractiveDevSessionProps & { local: boolean };
215
+ type DevSessionProps = DevProps & {
216
+ local: boolean;
217
+ experimentalLocal?: boolean;
218
+ };
143
219
 
144
220
  function DevSession(props: DevSessionProps) {
145
- return props.local ? (
146
- <Local
147
- name={props.name}
148
- bundle={props.bundle}
149
- format={props.entry.format}
150
- compatibilityDate={props.compatibilityDate}
151
- compatibilityFlags={props.compatibilityFlags}
152
- bindings={props.bindings}
153
- assetPaths={props.assetPaths}
154
- public={props.public}
155
- port={props.port}
156
- ip={props.ip}
157
- rules={props.rules}
158
- inspectorPort={props.inspectorPort}
159
- enableLocalPersistence={props.enableLocalPersistence}
160
- />
161
- ) : (
162
- <Remote
163
- name={props.name}
164
- bundle={props.bundle}
165
- format={props.entry.format}
166
- accountId={props.accountId}
167
- apiToken={props.apiToken}
168
- bindings={props.bindings}
169
- assetPaths={props.assetPaths}
170
- public={props.public}
171
- port={props.port}
172
- ip={props.ip}
173
- localProtocol={props.localProtocol}
174
- inspectorPort={props.inspectorPort}
175
- compatibilityDate={props.compatibilityDate}
176
- compatibilityFlags={props.compatibilityFlags}
177
- usageModel={props.usageModel}
178
- env={props.env}
179
- legacyEnv={props.legacyEnv}
180
- zone={props.zone}
181
- />
182
- );
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
+ );
183
337
  }
184
338
 
185
339
  export interface DirectorySyncResult {
186
- name: string;
187
- removeCallback: () => void;
340
+ name: string;
341
+ removeCallback: () => void;
188
342
  }
189
343
 
190
344
  function useTmpDir(): string | undefined {
191
- const [directory, setDirectory] = useState<DirectorySyncResult>();
192
- const handleError = useErrorHandler();
193
- useEffect(() => {
194
- let dir: DirectorySyncResult | undefined;
195
- try {
196
- dir = tmp.dirSync({ unsafeCleanup: true });
197
- setDirectory(dir);
198
- return;
199
- } catch (err) {
200
- console.error("failed to create tmp dir");
201
- handleError(err);
202
- }
203
- return () => {
204
- dir?.removeCallback();
205
- };
206
- }, [handleError]);
207
- 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;
208
364
  }
209
365
 
210
- function useCustomBuild(
211
- expectedEntry: Entry,
212
- build: {
213
- command?: undefined | string;
214
- cwd?: undefined | string;
215
- watch_dir?: undefined | string;
216
- }
217
- ): void {
218
- useEffect(() => {
219
- if (!build.command) return;
220
- let watcher: ReturnType<typeof watch> | undefined;
221
- if (build.watch_dir) {
222
- watcher = watch(build.watch_dir, {
223
- persistent: true,
224
- ignoreInitial: true,
225
- }).on("all", (_event, filePath) => {
226
- //TODO: we should buffer requests to the proxy until this completes
227
- console.log(`The file ${filePath} changed, restarting build...`);
228
- runCustomBuild(expectedEntry.file, build).catch((err) => {
229
- console.error("Custom build failed:", err);
230
- });
231
- });
232
- }
233
-
234
- return () => {
235
- watcher?.close();
236
- };
237
- }, [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]);
238
389
  }
239
390
 
240
391
  function sleep(period: number) {
241
- return new Promise((resolve) => setTimeout(resolve, period));
392
+ return new Promise((resolve) => setTimeout(resolve, period));
242
393
  }
243
394
  const SLEEP_DURATION = 2000;
244
395
  // really need a first class api for this
245
396
  const hostNameRegex = /userHostname="(.*)"/g;
246
397
  async function findTunnelHostname() {
247
- let hostName: string | undefined;
248
- while (!hostName) {
249
- try {
250
- const resp = await fetch("http://localhost:8789/metrics");
251
- const data = await resp.text();
252
- const matches = Array.from(data.matchAll(hostNameRegex));
253
- hostName = matches[0][1];
254
- } catch (err) {
255
- await sleep(SLEEP_DURATION);
256
- }
257
- }
258
- 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;
259
410
  }
260
411
 
261
412
  /**
@@ -263,130 +414,152 @@ async function findTunnelHostname() {
263
414
  * We've disabled this for now until we figure out a better user experience.
264
415
  */
265
416
  function useTunnel(toggle: boolean) {
266
- const tunnel = useRef<ReturnType<typeof spawn>>();
267
- const removeSignalExitListener = useRef<() => void>();
268
- // TODO: test if cloudflared is available, if not
269
- // point them to a url where they can get docs to install it
270
- useEffect(() => {
271
- async function startTunnel() {
272
- if (toggle) {
273
- try {
274
- await commandExists("cloudflared");
275
- } catch (e) {
276
- console.error(
277
- "To share your worker on the Internet, please install `cloudflared` from https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup/installation"
278
- );
279
- return;
280
- }
281
- console.log("⎔ Starting a tunnel...");
282
- tunnel.current = spawn("cloudflared", [
283
- "tunnel",
284
- "--url",
285
- "http://localhost:8787",
286
- "--metrics",
287
- "localhost:8789",
288
- ]);
289
-
290
- tunnel.current.on("close", (code) => {
291
- if (code) {
292
- console.log(`Tunnel process exited with code ${code}`);
293
- }
294
- });
295
-
296
- removeSignalExitListener.current = onExit((_code, _signal) => {
297
- console.log("⎔ Shutting down local tunnel.");
298
- tunnel.current?.kill();
299
- tunnel.current = undefined;
300
- });
301
-
302
- const hostName = await findTunnelHostname();
303
- await clipboardy.write(hostName);
304
- console.log(`⬣ Sharing at ${hostName}, copied to clipboard.`);
305
- }
306
- }
307
-
308
- startTunnel().catch(async (err) => {
309
- console.error("tunnel:", err);
310
- await reportError(err);
311
- });
312
-
313
- return () => {
314
- if (tunnel.current) {
315
- console.log("⎔ Shutting down tunnel.");
316
- tunnel.current?.kill();
317
- tunnel.current = undefined;
318
- removeSignalExitListener.current && removeSignalExitListener.current();
319
- removeSignalExitListener.current = undefined;
320
- }
321
- };
322
- }, [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]);
323
473
  }
324
474
 
325
475
  type useHotkeysInitialState = {
326
- local: boolean;
327
- tunnel: boolean;
476
+ local: boolean;
477
+ tunnel: boolean;
328
478
  };
329
- function useHotkeys(
330
- initial: useHotkeysInitialState,
331
- port: number,
332
- ip: string,
333
- inspectorPort: number,
334
- localProtocol: "http" | "https"
335
- ) {
336
- // UGH, we should put port in context instead
337
- const [toggles, setToggles] = useState(initial);
338
- useInput(
339
- async (
340
- input,
341
- // eslint-disable-next-line unused-imports/no-unused-vars
342
- key
343
- ) => {
344
- switch (input.toLowerCase()) {
345
- // open browser
346
- case "b": {
347
- await openInBrowser(`${localProtocol}://${ip}:${port}`);
348
- break;
349
- }
350
- // toggle inspector
351
- case "d": {
352
- await openInBrowser(
353
- `https://built-devtools.pages.dev/js_app?experiments=true&v8only=true&ws=localhost:${inspectorPort}/ws`,
354
- { forceChromium: true }
355
- );
356
- break;
357
- }
358
- // toggle local
359
- case "l":
360
- setToggles((previousToggles) => ({
361
- ...previousToggles,
362
- local: !previousToggles.local,
363
- }));
364
- break;
365
- // shut down
366
- case "q":
367
- case "x":
368
- process.exit(0);
369
- break;
370
- default:
371
- // nothing?
372
- break;
373
- }
374
- }
375
- );
376
- 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;
377
550
  }
378
551
 
379
552
  function ErrorFallback(props: { error: Error }) {
380
- const { exit } = useApp();
381
- useEffect(() => exit(props.error));
382
- return (
383
- <>
384
- <Text>Something went wrong:</Text>
385
- <Text>{props.error.stack}</Text>
386
- </>
387
- );
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
+ );
388
561
  }
389
562
 
390
563
  export default withErrorBoundary(DevImplementation, {
391
- FallbackComponent: ErrorFallback,
564
+ FallbackComponent: ErrorFallback,
392
565
  });