wrangler 0.0.0-e5a3814 → 0.0.0-e60dc909

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 (302) hide show
  1. package/README.md +23 -3
  2. package/bin/wrangler.js +170 -62
  3. package/kv-asset-handler.js +1 -0
  4. package/miniflare-dist/index.mjs +1499 -21
  5. package/package.json +193 -153
  6. package/src/__tests__/access.test.ts +25 -0
  7. package/src/__tests__/api-dev.test.ts +238 -0
  8. package/src/__tests__/api-devregistry.test.js +64 -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 +4152 -3476
  13. package/src/__tests__/d1/d1.test.ts +123 -0
  14. package/src/__tests__/d1/splitter.test.ts +255 -0
  15. package/src/__tests__/delete.test.ts +266 -0
  16. package/src/__tests__/deployments.test.ts +105 -0
  17. package/src/__tests__/dev.test.tsx +1559 -956
  18. package/src/__tests__/generate.test.ts +238 -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-auth-domain.ts +20 -0
  24. package/src/__tests__/helpers/mock-bin.ts +20 -20
  25. package/src/__tests__/helpers/mock-cfetch.ts +167 -100
  26. package/src/__tests__/helpers/mock-console.ts +58 -39
  27. package/src/__tests__/helpers/mock-dialogs.ts +88 -81
  28. package/src/__tests__/helpers/mock-get-zone-from-host.ts +8 -0
  29. package/src/__tests__/helpers/mock-http-server.ts +30 -30
  30. package/src/__tests__/helpers/mock-istty.ts +65 -18
  31. package/src/__tests__/helpers/mock-known-routes.ts +7 -0
  32. package/src/__tests__/helpers/mock-kv.ts +27 -27
  33. package/src/__tests__/helpers/mock-oauth-flow.ts +244 -228
  34. package/src/__tests__/helpers/mock-process.ts +34 -0
  35. package/src/__tests__/helpers/mock-stdin.ts +82 -77
  36. package/src/__tests__/helpers/mock-web-socket.ts +21 -21
  37. package/src/__tests__/helpers/msw/blob-worker.cjs +19 -0
  38. package/src/__tests__/helpers/msw/handlers/access.ts +13 -0
  39. package/src/__tests__/helpers/msw/handlers/deployments.ts +59 -0
  40. package/src/__tests__/helpers/msw/handlers/namespaces.ts +104 -0
  41. package/src/__tests__/helpers/msw/handlers/oauth.ts +31 -0
  42. package/src/__tests__/helpers/msw/handlers/r2.ts +80 -0
  43. package/src/__tests__/helpers/msw/handlers/script.ts +75 -0
  44. package/src/__tests__/helpers/msw/handlers/user.ts +63 -0
  45. package/src/__tests__/helpers/msw/handlers/zones.ts +22 -0
  46. package/src/__tests__/helpers/msw/index.ts +21 -0
  47. package/src/__tests__/helpers/msw/read-file-sync.js +61 -0
  48. package/src/__tests__/helpers/run-in-tmp.ts +27 -28
  49. package/src/__tests__/helpers/run-wrangler.ts +8 -8
  50. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +1 -0
  51. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +5 -0
  52. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +1 -0
  53. package/src/__tests__/helpers/worker-scripts/parent-worker.js +8 -0
  54. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +5 -0
  55. package/src/__tests__/helpers/write-worker-source.ts +16 -16
  56. package/src/__tests__/helpers/write-wrangler-toml.ts +9 -9
  57. package/src/__tests__/https-options.test.ts +142 -109
  58. package/src/__tests__/index.test.ts +245 -234
  59. package/src/__tests__/init.test.ts +3146 -1608
  60. package/src/__tests__/jest.setup.ts +167 -46
  61. package/src/__tests__/kv.test.ts +1778 -1471
  62. package/src/__tests__/logger.test.ts +100 -74
  63. package/src/__tests__/logout.test.ts +47 -0
  64. package/src/__tests__/metrics.test.ts +493 -0
  65. package/src/__tests__/middleware.scheduled.test.ts +145 -0
  66. package/src/__tests__/middleware.test.ts +750 -0
  67. package/src/__tests__/package-manager.test.ts +303 -303
  68. package/src/__tests__/pages-deployment-tail.test.ts +884 -0
  69. package/src/__tests__/pages.test.ts +2888 -743
  70. package/src/__tests__/parse.test.ts +252 -252
  71. package/src/__tests__/paths.test.ts +39 -0
  72. package/src/__tests__/publish.test.ts +7641 -5626
  73. package/src/__tests__/pubsub.test.ts +490 -0
  74. package/src/__tests__/queues.test.ts +522 -0
  75. package/src/__tests__/r2.test.ts +388 -228
  76. package/src/__tests__/route.test.ts +18 -18
  77. package/src/__tests__/secret.test.ts +689 -469
  78. package/src/__tests__/tail.test.ts +782 -567
  79. package/src/__tests__/test-old-node-version.js +31 -0
  80. package/src/__tests__/tsconfig-sanity.ts +12 -0
  81. package/src/__tests__/tsconfig.json +8 -0
  82. package/src/__tests__/tsconfig.tsbuildinfo +1 -0
  83. package/src/__tests__/type-generation.test.ts +233 -0
  84. package/src/__tests__/user.test.ts +117 -119
  85. package/src/__tests__/utils-collectKeyValues.test.ts +47 -0
  86. package/src/__tests__/validate-dev-props.test.ts +56 -0
  87. package/src/__tests__/version.test.ts +35 -0
  88. package/src/__tests__/whoami.test.tsx +176 -132
  89. package/src/__tests__/worker-namespace.test.ts +326 -0
  90. package/src/abort.d.ts +1 -1
  91. package/src/api/dev.ts +247 -0
  92. package/src/api/index.ts +2 -0
  93. package/src/bundle-reporter.ts +68 -0
  94. package/src/bundle.ts +785 -159
  95. package/src/cfetch/index.ts +120 -83
  96. package/src/cfetch/internal.ts +211 -92
  97. package/src/cli.ts +23 -8
  98. package/src/config/config.ts +236 -195
  99. package/src/config/diagnostics.ts +61 -61
  100. package/src/config/environment.ts +514 -357
  101. package/src/config/index.ts +326 -193
  102. package/src/config/validation-helpers.ts +379 -366
  103. package/src/config/validation.ts +1979 -1380
  104. package/src/config-cache.ts +81 -41
  105. package/src/create-worker-preview.ts +239 -142
  106. package/src/create-worker-upload-form.ts +309 -238
  107. package/src/d1/backups.tsx +223 -0
  108. package/src/d1/constants.ts +2 -0
  109. package/src/d1/create.tsx +63 -0
  110. package/src/d1/delete.ts +56 -0
  111. package/src/d1/execute.tsx +323 -0
  112. package/src/d1/formatTimeAgo.ts +14 -0
  113. package/src/d1/index.ts +101 -0
  114. package/src/d1/list.tsx +48 -0
  115. package/src/d1/migrations/apply.tsx +197 -0
  116. package/src/d1/migrations/create.tsx +77 -0
  117. package/src/d1/migrations/helpers.ts +147 -0
  118. package/src/d1/migrations/index.ts +3 -0
  119. package/src/d1/migrations/list.tsx +79 -0
  120. package/src/d1/migrations/options.ts +18 -0
  121. package/src/d1/options.ts +22 -0
  122. package/src/d1/splitter.ts +161 -0
  123. package/src/d1/types.ts +24 -0
  124. package/src/d1/utils.ts +48 -0
  125. package/src/delete.ts +103 -0
  126. package/src/deployments.ts +83 -0
  127. package/src/deprecated/index.ts +145 -0
  128. package/src/dev/dev-vars.ts +20 -17
  129. package/src/dev/dev.tsx +546 -333
  130. package/src/dev/get-local-persistence-path.ts +31 -0
  131. package/src/dev/local.tsx +912 -302
  132. package/src/dev/remote.tsx +618 -225
  133. package/src/dev/start-server.ts +543 -0
  134. package/src/dev/use-esbuild.ts +183 -97
  135. package/src/dev/validate-dev-props.ts +31 -0
  136. package/src/dev-registry.ts +201 -0
  137. package/src/dev.tsx +949 -0
  138. package/src/dialogs.ts +136 -0
  139. package/src/dispatch-namespace.ts +207 -0
  140. package/src/docs/index.ts +97 -0
  141. package/src/durable.ts +87 -87
  142. package/src/entry.ts +235 -228
  143. package/src/environment-variables/factory.ts +88 -0
  144. package/src/environment-variables/misc-variables.ts +30 -0
  145. package/src/errors.ts +6 -6
  146. package/src/generate/index.ts +300 -0
  147. package/src/git-client.ts +135 -0
  148. package/src/global-wrangler-config-path.ts +26 -0
  149. package/src/https-options.ts +84 -80
  150. package/src/index.ts +694 -0
  151. package/src/init.ts +1024 -0
  152. package/src/inspect.ts +698 -593
  153. package/src/intl-polyfill.d.ts +123 -123
  154. package/src/is-ci.ts +14 -0
  155. package/src/is-interactive.ts +16 -0
  156. package/src/jest.d.ts +4 -0
  157. package/src/kv/helpers.ts +430 -0
  158. package/src/kv/index.ts +596 -0
  159. package/src/logger.ts +80 -42
  160. package/src/metrics/index.ts +5 -0
  161. package/src/metrics/metrics-config.ts +239 -0
  162. package/src/metrics/metrics-dispatcher.ts +96 -0
  163. package/src/metrics/metrics-usage-headers.ts +24 -0
  164. package/src/metrics/send-event.ts +97 -0
  165. package/src/miniflare-cli/assets.ts +250 -0
  166. package/src/miniflare-cli/index.ts +202 -33
  167. package/src/miniflare-cli/request-context.ts +18 -18
  168. package/src/miniflare-cli/tsconfig.json +9 -0
  169. package/src/miniflare-cli/tsconfig.tsbuildinfo +1 -0
  170. package/src/miniflare-cli/types.ts +11 -0
  171. package/src/module-collection.ts +221 -212
  172. package/src/open-in-browser.ts +4 -6
  173. package/src/package-manager.ts +173 -128
  174. package/src/pages/build.ts +270 -0
  175. package/src/pages/constants.ts +18 -0
  176. package/src/pages/deployment-tails.ts +284 -0
  177. package/src/pages/deployments.tsx +84 -0
  178. package/src/pages/dev.ts +711 -0
  179. package/src/pages/errors.ts +66 -0
  180. package/src/pages/functions/buildPlugin.ts +107 -0
  181. package/src/pages/functions/buildWorker.ts +166 -0
  182. package/{pages → src/pages}/functions/filepath-routing.test.ts +113 -113
  183. package/src/pages/functions/filepath-routing.ts +189 -0
  184. package/src/pages/functions/identifiers.ts +78 -0
  185. package/src/pages/functions/routes-consolidation.test.ts +250 -0
  186. package/src/pages/functions/routes-consolidation.ts +73 -0
  187. package/src/pages/functions/routes-transformation.test.ts +282 -0
  188. package/src/pages/functions/routes-transformation.ts +115 -0
  189. package/src/pages/functions/routes-validation.test.ts +403 -0
  190. package/src/pages/functions/routes-validation.ts +202 -0
  191. package/src/pages/functions/routes.ts +151 -0
  192. package/src/pages/functions/tsconfig.json +8 -0
  193. package/src/pages/functions/tsconfig.tsbuildinfo +1 -0
  194. package/src/pages/functions.ts +82 -0
  195. package/src/pages/hash.ts +13 -0
  196. package/src/pages/index.ts +102 -0
  197. package/src/pages/projects.tsx +167 -0
  198. package/src/pages/prompt-select-project.tsx +31 -0
  199. package/src/pages/publish.tsx +462 -0
  200. package/src/pages/types.ts +41 -0
  201. package/src/pages/upload.tsx +447 -0
  202. package/src/pages/utils.ts +23 -0
  203. package/src/parse.ts +208 -125
  204. package/src/paths.ts +53 -8
  205. package/src/proxy.ts +623 -407
  206. package/src/publish/index.ts +270 -0
  207. package/src/publish/publish.ts +1038 -0
  208. package/src/pubsub/index.ts +286 -0
  209. package/src/pubsub/pubsub-commands.ts +624 -0
  210. package/src/queues/cli/commands/consumer/add.ts +71 -0
  211. package/src/queues/cli/commands/consumer/index.ts +22 -0
  212. package/src/queues/cli/commands/consumer/remove.ts +38 -0
  213. package/src/queues/cli/commands/create.ts +25 -0
  214. package/src/queues/cli/commands/delete.ts +26 -0
  215. package/src/queues/cli/commands/index.ts +36 -0
  216. package/src/queues/cli/commands/list.ts +25 -0
  217. package/src/queues/client.ts +135 -0
  218. package/src/queues/utils.ts +18 -0
  219. package/src/r2/constants.ts +4 -0
  220. package/src/r2/helpers.ts +131 -0
  221. package/src/r2/index.ts +289 -0
  222. package/src/routes.ts +140 -0
  223. package/src/secret/index.ts +379 -0
  224. package/src/selfsigned.d.ts +23 -23
  225. package/src/sites.ts +372 -0
  226. package/src/tail/createTail.ts +379 -0
  227. package/src/tail/filters.ts +108 -110
  228. package/src/tail/index.ts +210 -296
  229. package/src/tail/printing.ts +86 -46
  230. package/src/tsconfig-sanity.ts +16 -0
  231. package/src/type-generation.ts +181 -0
  232. package/src/update-check.ts +11 -11
  233. package/src/user/access.ts +68 -0
  234. package/src/user/auth-variables.ts +113 -0
  235. package/src/user/choose-account.tsx +39 -0
  236. package/src/user/generate-auth-url.ts +33 -0
  237. package/src/user/generate-random-state.ts +16 -0
  238. package/src/user/index.ts +2 -0
  239. package/src/user/user.ts +1232 -0
  240. package/src/utils/collectKeyValues.ts +14 -0
  241. package/src/whoami.ts +135 -0
  242. package/src/worker.ts +177 -107
  243. package/src/yargs-types.ts +24 -0
  244. package/src/zones.ts +158 -40
  245. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  246. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  247. package/templates/__tests__/tsconfig.json +8 -0
  248. package/templates/__tests__/tsconfig.tsbuildinfo +1 -0
  249. package/templates/checked-fetch.js +17 -0
  250. package/templates/d1-beta-facade.js +241 -0
  251. package/templates/facade.d.ts +14 -0
  252. package/templates/first-party-worker-module-facade.ts +19 -0
  253. package/templates/format-dev-errors.ts +33 -0
  254. package/templates/init-tests/test-jest-new-worker.js +23 -0
  255. package/templates/init-tests/test-vitest-new-worker.js +24 -0
  256. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  257. package/templates/middleware/common.ts +62 -0
  258. package/templates/middleware/loader-modules.ts +82 -0
  259. package/templates/middleware/loader-sw.ts +233 -0
  260. package/templates/middleware/middleware-miniflare3-json-error.ts +20 -0
  261. package/templates/middleware/middleware-pretty-error.ts +40 -0
  262. package/templates/middleware/middleware-scheduled.ts +15 -0
  263. package/templates/new-worker-scheduled.js +3 -3
  264. package/templates/new-worker-scheduled.ts +15 -15
  265. package/templates/new-worker.js +3 -3
  266. package/templates/new-worker.ts +15 -15
  267. package/templates/no-op-worker.js +10 -0
  268. package/templates/pages-dev-pipeline.ts +31 -0
  269. package/templates/pages-dev-util.ts +52 -0
  270. package/templates/pages-shim.ts +12 -0
  271. package/templates/pages-template-plugin.ts +176 -0
  272. package/templates/pages-template-worker.ts +189 -0
  273. package/templates/serve-static-assets.ts +65 -0
  274. package/templates/service-bindings-module-facade.js +54 -0
  275. package/templates/service-bindings-sw-facade.js +42 -0
  276. package/templates/tsconfig-sanity.ts +11 -0
  277. package/templates/tsconfig.init.json +106 -0
  278. package/templates/tsconfig.json +6 -103
  279. package/templates/tsconfig.tsbuildinfo +1 -0
  280. package/wrangler-dist/cli.d.ts +906 -0
  281. package/wrangler-dist/cli.js +128866 -110945
  282. package/wrangler-dist/wasm-sync.wasm +0 -0
  283. package/pages/functions/buildPlugin.ts +0 -105
  284. package/pages/functions/buildWorker.ts +0 -151
  285. package/pages/functions/filepath-routing.ts +0 -189
  286. package/pages/functions/identifiers.ts +0 -78
  287. package/pages/functions/routes.ts +0 -156
  288. package/pages/functions/template-plugin.ts +0 -147
  289. package/pages/functions/template-worker.ts +0 -143
  290. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  291. package/src/dialogs.tsx +0 -135
  292. package/src/environment-variables.ts +0 -35
  293. package/src/index.tsx +0 -2846
  294. package/src/kv.ts +0 -408
  295. package/src/miniflare-cli/enum-keys.ts +0 -17
  296. package/src/pages.tsx +0 -2093
  297. package/src/publish.ts +0 -716
  298. package/src/r2.ts +0 -50
  299. package/src/sites.tsx +0 -326
  300. package/src/user.tsx +0 -1214
  301. package/src/whoami.tsx +0 -71
  302. package/templates/static-asset-facade.js +0 -43
@@ -1,237 +1,630 @@
1
1
  import { readFile } from "node:fs/promises";
2
2
  import path from "node:path";
3
- import { useState, useEffect, useRef } from "react";
4
- import { createWorkerPreview } from "../create-worker-preview";
3
+ import { Text } from "ink";
4
+ import SelectInput from "ink-select-input";
5
+ import React, { useState, useEffect, useRef } from "react";
6
+ import { useErrorHandler } from "react-error-boundary";
7
+ import { printBundleSize } from "../bundle-reporter";
8
+ import {
9
+ createPreviewSession,
10
+ createWorkerPreview,
11
+ } from "../create-worker-preview";
5
12
  import useInspector from "../inspect";
6
13
  import { logger } from "../logger";
7
- import { usePreviewServer } from "../proxy";
14
+ import { startPreviewServer, usePreviewServer } from "../proxy";
8
15
  import { syncAssets } from "../sites";
9
- import { requireApiToken, requireAuth } from "../user";
10
- import type { CfPreviewToken } from "../create-worker-preview";
16
+ import {
17
+ getAccountChoices,
18
+ requireApiToken,
19
+ saveAccountToCache,
20
+ } from "../user";
21
+ import type { Route } from "../config/environment";
22
+ import type {
23
+ CfPreviewToken,
24
+ CfPreviewSession,
25
+ } from "../create-worker-preview";
11
26
  import type { AssetPaths } from "../sites";
12
- import type { CfModule, CfWorkerInit, CfScriptFormat } from "../worker";
27
+ import type { ChooseAccountItem } from "../user";
28
+ import type {
29
+ CfModule,
30
+ CfWorkerInit,
31
+ CfScriptFormat,
32
+ CfAccount,
33
+ CfWorkerContext,
34
+ } from "../worker";
13
35
  import type { EsbuildBundle } from "./use-esbuild";
14
36
 
15
- export function Remote(props: {
16
- name: string | undefined;
17
- bundle: EsbuildBundle | undefined;
18
- format: CfScriptFormat | undefined;
19
- public: string | undefined;
20
- assetPaths: AssetPaths | undefined;
21
- port: number;
22
- ip: string;
23
- localProtocol: "https" | "http";
24
- inspectorPort: number;
25
- accountId: string | undefined;
26
- bindings: CfWorkerInit["bindings"];
27
- compatibilityDate: string;
28
- compatibilityFlags: string[] | undefined;
29
- usageModel: "bundled" | "unbound" | undefined;
30
- env: string | undefined;
31
- legacyEnv: boolean | undefined;
32
- zone: string | undefined;
33
- host: string | undefined;
37
+ interface RemoteProps {
38
+ name: string | undefined;
39
+ bundle: EsbuildBundle | undefined;
40
+ format: CfScriptFormat | undefined;
41
+ isWorkersSite: boolean;
42
+ assetPaths: AssetPaths | undefined;
43
+ port: number;
44
+ ip: string;
45
+ localProtocol: "https" | "http";
46
+ inspect: boolean;
47
+ inspectorPort: number;
48
+ accountId: string | undefined;
49
+ bindings: CfWorkerInit["bindings"];
50
+ compatibilityDate: string;
51
+ compatibilityFlags: string[] | undefined;
52
+ usageModel: "bundled" | "unbound" | undefined;
53
+ env: string | undefined;
54
+ legacyEnv: boolean | undefined;
55
+ zone: string | undefined;
56
+ host: string | undefined;
57
+ routes: Route[] | undefined;
58
+ onReady?: ((ip: string, port: number) => void) | undefined;
59
+ sourceMapPath: string | undefined;
60
+ sendMetrics: boolean | undefined;
61
+ }
62
+
63
+ export function Remote(props: RemoteProps) {
64
+ const [accountId, setAccountId] = useState(props.accountId);
65
+ const accountChoicesRef = useRef<Promise<ChooseAccountItem[]>>();
66
+ const [accountChoices, setAccountChoices] = useState<ChooseAccountItem[]>();
67
+
68
+ const previewToken = useWorker({
69
+ name: props.name,
70
+ bundle: props.bundle,
71
+ format: props.format,
72
+ modules: props.bundle ? props.bundle.modules : [],
73
+ accountId,
74
+ bindings: props.bindings,
75
+ assetPaths: props.assetPaths,
76
+ isWorkersSite: props.isWorkersSite,
77
+ compatibilityDate: props.compatibilityDate,
78
+ compatibilityFlags: props.compatibilityFlags,
79
+ usageModel: props.usageModel,
80
+ env: props.env,
81
+ legacyEnv: props.legacyEnv,
82
+ zone: props.zone,
83
+ host: props.host,
84
+ routes: props.routes,
85
+ onReady: props.onReady,
86
+ sendMetrics: props.sendMetrics,
87
+ port: props.port,
88
+ });
89
+
90
+ usePreviewServer({
91
+ previewToken,
92
+ assetDirectory: props.isWorkersSite
93
+ ? undefined
94
+ : props.assetPaths?.assetDirectory,
95
+ localProtocol: props.localProtocol,
96
+ localPort: props.port,
97
+ ip: props.ip,
98
+ });
99
+
100
+ useInspector({
101
+ inspectorUrl:
102
+ props.inspect && previewToken
103
+ ? previewToken.inspectorUrl.href
104
+ : undefined,
105
+ port: props.inspectorPort,
106
+ logToTerminal: true,
107
+ sourceMapPath: props.sourceMapPath,
108
+ host: previewToken?.host,
109
+ });
110
+
111
+ const errorHandler = useErrorHandler();
112
+
113
+ // This effect handles the async step of fetching the available accounts for the current user.
114
+ // If only one account is available then it is just used by calling `setAccountId()`.
115
+ useEffect(() => {
116
+ if (
117
+ accountChoicesRef.current !== undefined ||
118
+ props.accountId !== undefined
119
+ ) {
120
+ return;
121
+ }
122
+ accountChoicesRef.current = getAccountChoices();
123
+ accountChoicesRef.current.then(
124
+ (accounts) => {
125
+ if (accounts.length === 1) {
126
+ saveAccountToCache({
127
+ id: accounts[0].id,
128
+ name: accounts[0].name,
129
+ });
130
+ setAccountId(accounts[0].id);
131
+ } else {
132
+ setAccountChoices(accounts);
133
+ }
134
+ },
135
+ (err) => {
136
+ errorHandler(err);
137
+ }
138
+ );
139
+ });
140
+
141
+ // If we have not already chosen an account and there are multiple accounts available
142
+ // allow the users to select one.
143
+ return accountId === undefined && accountChoices !== undefined ? (
144
+ <ChooseAccount
145
+ accounts={accountChoices}
146
+ onSelect={(selectedAccount) => {
147
+ saveAccountToCache(selectedAccount);
148
+ setAccountId(selectedAccount.id);
149
+ }}
150
+ onError={(err) => errorHandler(err)}
151
+ ></ChooseAccount>
152
+ ) : null;
153
+ }
154
+
155
+ interface RemoteWorkerProps {
156
+ name: string | undefined;
157
+ bundle: EsbuildBundle | undefined;
158
+ format: CfScriptFormat | undefined;
159
+ modules: CfModule[];
160
+ accountId: string | undefined;
161
+ bindings: CfWorkerInit["bindings"];
162
+ assetPaths: AssetPaths | undefined;
163
+ isWorkersSite: boolean;
164
+ compatibilityDate: string | undefined;
165
+ compatibilityFlags: string[] | undefined;
166
+ usageModel: "bundled" | "unbound" | undefined;
167
+ env: string | undefined;
168
+ legacyEnv: boolean | undefined;
169
+ zone: string | undefined;
170
+ host: string | undefined;
171
+ routes: Route[] | undefined;
172
+ onReady: ((ip: string, port: number) => void) | undefined;
173
+ sendMetrics: boolean | undefined;
174
+ port: number;
175
+ }
176
+
177
+ export function useWorker(
178
+ props: RemoteWorkerProps
179
+ ): CfPreviewToken | undefined {
180
+ const [session, setSession] = useState<CfPreviewSession | undefined>();
181
+ const [token, setToken] = useState<CfPreviewToken | undefined>();
182
+ const [restartCounter, setRestartCounter] = useState<number>(0);
183
+ // This is the most reliable way to detect whether
184
+ // something's "happened" in our system; We make a ref and
185
+ // mark it once we log our initial message. Refs are vars!
186
+ const startedRef = useRef(false);
187
+ // functions must be destructured before use inside a useEffect, otherwise the entire props object has to be added to the dependency array
188
+ const { onReady } = props;
189
+ // This effect sets up the preview session
190
+ useEffect(() => {
191
+ const abortController = new AbortController();
192
+ async function start() {
193
+ if (props.accountId === undefined) {
194
+ return;
195
+ }
196
+ const { workerAccount, workerContext } = getWorkerAccountAndContext({
197
+ accountId: props.accountId,
198
+ env: props.env,
199
+ legacyEnv: props.legacyEnv,
200
+ zone: props.zone,
201
+ host: props.host,
202
+ routes: props.routes,
203
+ sendMetrics: props.sendMetrics,
204
+ });
205
+
206
+ setSession(
207
+ await createPreviewSession(
208
+ workerAccount,
209
+ workerContext,
210
+ abortController.signal
211
+ )
212
+ );
213
+ }
214
+ start().catch((err) => {
215
+ // instead of logging the raw API error to the user,
216
+ // give them friendly instructions
217
+ // for error 10063 (workers.dev subdomain required)
218
+ if (err.code === 10063) {
219
+ const errorMessage =
220
+ "Error: You need to register a workers.dev subdomain before running the dev command in remote mode";
221
+ const solutionMessage =
222
+ "You can either enable local mode by pressing l, or register a workers.dev subdomain here:";
223
+ const onboardingLink = `https://dash.cloudflare.com/${props.accountId}/workers/onboarding`;
224
+ logger.error(`${errorMessage}\n${solutionMessage}\n${onboardingLink}`);
225
+ }
226
+ // we want to log the error, but not end the process
227
+ // since it could recover after the developer fixes whatever's wrong
228
+ else if ((err as { code: string }).code !== "ABORT_ERR") {
229
+ logger.error("Error while creating remote dev session:", err);
230
+ }
231
+ });
232
+
233
+ return () => {
234
+ abortController.abort();
235
+ };
236
+ }, [
237
+ props.accountId,
238
+ props.env,
239
+ props.host,
240
+ props.legacyEnv,
241
+ props.routes,
242
+ props.zone,
243
+ props.sendMetrics,
244
+ restartCounter,
245
+ ]);
246
+
247
+ // This effect uses the session to upload the worker and create a preview
248
+ useEffect(() => {
249
+ const abortController = new AbortController();
250
+ async function start() {
251
+ if (props.accountId === undefined) {
252
+ return;
253
+ }
254
+ if (session === undefined) {
255
+ return;
256
+ }
257
+ setToken(undefined); // reset token in case we're re-running
258
+
259
+ if (!props.bundle || !props.format) return;
260
+
261
+ if (!startedRef.current) {
262
+ startedRef.current = true;
263
+ } else {
264
+ logger.log("⎔ Detected changes, restarted server.");
265
+ }
266
+
267
+ const init = await createRemoteWorkerInit({
268
+ bundle: props.bundle,
269
+ modules: props.modules,
270
+ accountId: props.accountId,
271
+ name: props.name,
272
+ legacyEnv: props.legacyEnv,
273
+ env: props.env,
274
+ isWorkersSite: props.isWorkersSite,
275
+ assetPaths: props.assetPaths,
276
+ format: props.format,
277
+ bindings: props.bindings,
278
+ compatibilityDate: props.compatibilityDate,
279
+ compatibilityFlags: props.compatibilityFlags,
280
+ usageModel: props.usageModel,
281
+ });
282
+
283
+ const { workerAccount, workerContext } = getWorkerAccountAndContext({
284
+ accountId: props.accountId,
285
+ env: props.env,
286
+ legacyEnv: props.legacyEnv,
287
+ zone: props.zone,
288
+ host: props.host,
289
+ routes: props.routes,
290
+ sendMetrics: props.sendMetrics,
291
+ });
292
+
293
+ const workerPreviewToken = await createWorkerPreview(
294
+ init,
295
+ workerAccount,
296
+ workerContext,
297
+ session,
298
+ abortController.signal
299
+ );
300
+
301
+ setToken(workerPreviewToken);
302
+
303
+ // TODO: Once we get service bindings working in the
304
+ // edge preview server, we can define remote dev service bindings
305
+ // and you can uncomment this code.
306
+ // https://github.com/cloudflare/wrangler2/issues/1182
307
+
308
+ /*
309
+ if (name) {
310
+ await registerWorker(name, {
311
+ mode: "remote",
312
+ // upstream protocol is always https (https://github.com/cloudflare/wrangler2/issues/583)
313
+ protocol: "https",
314
+ port: undefined,
315
+ host: workerPreviewToken.host,
316
+ headers: {
317
+ "cf-workers-preview-token": workerPreviewToken.value,
318
+ host: workerPreviewToken.host,
319
+ },
320
+ });
321
+ }
322
+ */
323
+ onReady?.(props.host || "localhost", props.port);
324
+ }
325
+ start().catch((err) => {
326
+ // we want to log the error, but not end the process
327
+ // since it could recover after the developer fixes whatever's wrong
328
+ if ((err as { code: string }).code !== "ABORT_ERR") {
329
+ // instead of logging the raw API error to the user,
330
+ // give them friendly instructions
331
+ // for error 10063 (workers.dev subdomain required)
332
+ if (err.code === 10063) {
333
+ const errorMessage =
334
+ "Error: You need to register a workers.dev subdomain before running the dev command in remote mode";
335
+ const solutionMessage =
336
+ "You can either enable local mode by pressing l, or register a workers.dev subdomain here:";
337
+ const onboardingLink = `https://dash.cloudflare.com/${props.accountId}/workers/onboarding`;
338
+ logger.error(
339
+ `${errorMessage}\n${solutionMessage}\n${onboardingLink}`
340
+ );
341
+ } else if (err.code === 10049) {
342
+ logger.log("Preview token expired, fetching a new one");
343
+ // code 10049 happens when the preview token expires
344
+ // since we want a new preview token when this happens,
345
+ // lets increment the counter, and trigger a rerun of
346
+ // the useEffect above
347
+ setRestartCounter((prevCount) => prevCount + 1);
348
+ } else {
349
+ logger.error("Error on remote worker:", err);
350
+ }
351
+ }
352
+ });
353
+
354
+ return () => {
355
+ abortController.abort();
356
+ };
357
+ }, [
358
+ props.name,
359
+ props.bundle,
360
+ props.format,
361
+ props.accountId,
362
+ props.assetPaths,
363
+ props.isWorkersSite,
364
+ props.compatibilityDate,
365
+ props.compatibilityFlags,
366
+ props.usageModel,
367
+ props.bindings,
368
+ props.modules,
369
+ props.env,
370
+ props.legacyEnv,
371
+ props.zone,
372
+ props.host,
373
+ props.routes,
374
+ session,
375
+ onReady,
376
+ props.sendMetrics,
377
+ props.port,
378
+ ]);
379
+
380
+ return token;
381
+ }
382
+
383
+ export async function startRemoteServer(props: RemoteProps) {
384
+ let accountId = props.accountId;
385
+ if (accountId === undefined) {
386
+ const accountChoices = await getAccountChoices();
387
+ if (accountChoices.length === 1) {
388
+ saveAccountToCache({
389
+ id: accountChoices[0].id,
390
+ name: accountChoices[0].name,
391
+ });
392
+ accountId = accountChoices[0].id;
393
+ } else {
394
+ throw logger.error(
395
+ "In a non-interactive environment, it is mandatory to specify an account ID, either by assigning its value to CLOUDFLARE_ACCOUNT_ID, or as `account_id` in your `wrangler.toml` file."
396
+ );
397
+ }
398
+ }
399
+
400
+ const previewToken = await getRemotePreviewToken({
401
+ ...props,
402
+ accountId: accountId,
403
+ });
404
+
405
+ if (previewToken === undefined) {
406
+ throw logger.error("Failed to get a previewToken");
407
+ }
408
+ // start our proxy server
409
+ const previewServer = await startPreviewServer({
410
+ previewToken,
411
+ assetDirectory: props.isWorkersSite
412
+ ? undefined
413
+ : props.assetPaths?.assetDirectory,
414
+ localProtocol: props.localProtocol,
415
+ localPort: props.port,
416
+ ip: props.ip,
417
+ onReady: props.onReady,
418
+ });
419
+ if (!previewServer) {
420
+ throw logger.error("Failed to start remote server");
421
+ }
422
+ return { stop: previewServer.stop };
423
+ }
424
+
425
+ /**
426
+ * getRemotePreviewToken is a react-free version of `useWorker`.
427
+ * It returns a preview token, which we then use in our proxy server
428
+ */
429
+ export async function getRemotePreviewToken(props: RemoteProps) {
430
+ //setup the preview session
431
+ async function start() {
432
+ if (props.accountId === undefined) {
433
+ throw logger.error("no accountId provided");
434
+ }
435
+ const abortController = new AbortController();
436
+ const { workerAccount, workerContext } = getWorkerAccountAndContext({
437
+ accountId: props.accountId,
438
+ env: props.env,
439
+ legacyEnv: props.legacyEnv,
440
+ zone: props.zone,
441
+ host: props.host,
442
+ routes: props.routes,
443
+ sendMetrics: props.sendMetrics,
444
+ });
445
+ const session = await createPreviewSession(
446
+ workerAccount,
447
+ workerContext,
448
+ abortController.signal
449
+ );
450
+ //use the session to upload the worker, and create a preview
451
+
452
+ if (session === undefined) {
453
+ throw logger.error("Failed to start a session");
454
+ }
455
+ if (!props.bundle || !props.format) return;
456
+
457
+ const init = await createRemoteWorkerInit({
458
+ bundle: props.bundle,
459
+ modules: props.bundle ? props.bundle.modules : [],
460
+ accountId: props.accountId,
461
+ name: props.name,
462
+ legacyEnv: props.legacyEnv,
463
+ env: props.env,
464
+ isWorkersSite: props.isWorkersSite,
465
+ assetPaths: props.assetPaths,
466
+ format: props.format,
467
+ bindings: props.bindings,
468
+ compatibilityDate: props.compatibilityDate,
469
+ compatibilityFlags: props.compatibilityFlags,
470
+ usageModel: props.usageModel,
471
+ });
472
+ const workerPreviewToken = await createWorkerPreview(
473
+ init,
474
+ workerAccount,
475
+ workerContext,
476
+ session,
477
+ abortController.signal
478
+ );
479
+ return workerPreviewToken;
480
+ }
481
+ return start().catch((err) => {
482
+ if ((err as { code?: string })?.code !== "ABORT_ERR") {
483
+ // instead of logging the raw API error to the user,
484
+ // give them friendly instructions
485
+ // for error 10063 (workers.dev subdomain required)
486
+ if (err?.code === 10063) {
487
+ const errorMessage =
488
+ "Error: You need to register a workers.dev subdomain before running the dev command in remote mode";
489
+ const solutionMessage =
490
+ "You can either enable local mode by pressing l, or register a workers.dev subdomain here:";
491
+ const onboardingLink = `https://dash.cloudflare.com/${props.accountId}/workers/onboarding`;
492
+ logger.error(`${errorMessage}\n${solutionMessage}\n${onboardingLink}`);
493
+ } else if (err?.code === 10049) {
494
+ // code 10049 happens when the preview token expires
495
+ logger.log("Preview token expired, restart server to fetch a new one");
496
+ } else {
497
+ logger.error("Error on remote worker:", err);
498
+ }
499
+ }
500
+ });
501
+ }
502
+
503
+ async function createRemoteWorkerInit(props: {
504
+ bundle: EsbuildBundle;
505
+ modules: CfModule[];
506
+ accountId: string;
507
+ name: string | undefined;
508
+ legacyEnv: boolean | undefined;
509
+ env: string | undefined;
510
+ isWorkersSite: boolean;
511
+ assetPaths: AssetPaths | undefined;
512
+ format: CfScriptFormat;
513
+ bindings: CfWorkerInit["bindings"];
514
+ compatibilityDate: string | undefined;
515
+ compatibilityFlags: string[] | undefined;
516
+ usageModel: "bundled" | "unbound" | undefined;
34
517
  }) {
35
- const previewToken = useWorker({
36
- name: props.name,
37
- bundle: props.bundle,
38
- format: props.format,
39
- modules: props.bundle ? props.bundle.modules : [],
40
- accountId: props.accountId,
41
- bindings: props.bindings,
42
- assetPaths: props.assetPaths,
43
- port: props.port,
44
- compatibilityDate: props.compatibilityDate,
45
- compatibilityFlags: props.compatibilityFlags,
46
- usageModel: props.usageModel,
47
- env: props.env,
48
- legacyEnv: props.legacyEnv,
49
- zone: props.zone,
50
- host: props.host,
51
- });
52
-
53
- usePreviewServer({
54
- previewToken,
55
- publicRoot: props.public,
56
- localProtocol: props.localProtocol,
57
- localPort: props.port,
58
- ip: props.ip,
59
- });
60
-
61
- useInspector({
62
- inspectorUrl: previewToken ? previewToken.inspectorUrl.href : undefined,
63
- port: props.inspectorPort,
64
- logToTerminal: true,
65
- });
66
- return null;
518
+ const content = await readFile(props.bundle.path, "utf-8");
519
+
520
+ // TODO: For Dev we could show the reporter message in the interactive box.
521
+ void printBundleSize(
522
+ { name: path.basename(props.bundle.path), content: content },
523
+ props.modules
524
+ );
525
+
526
+ const assets = await syncAssets(
527
+ props.accountId,
528
+ // When we're using the newer service environments, we wouldn't
529
+ // have added the env name on to the script name. However, we must
530
+ // include it in the kv namespace name regardless (since there's no
531
+ // concept of service environments for kv namespaces yet).
532
+ props.name + (!props.legacyEnv && props.env ? `-${props.env}` : ""),
533
+ props.isWorkersSite ? props.assetPaths : undefined,
534
+ true,
535
+ false
536
+ ); // TODO: cancellable?
537
+
538
+ const init: CfWorkerInit = {
539
+ name: props.name,
540
+ main: {
541
+ name: path.basename(props.bundle.path),
542
+ type: props.format === "modules" ? "esm" : "commonjs",
543
+ content,
544
+ },
545
+ modules: props.modules.concat(
546
+ assets.manifest
547
+ ? {
548
+ name: "__STATIC_CONTENT_MANIFEST",
549
+ content: JSON.stringify(assets.manifest),
550
+ type: "text",
551
+ }
552
+ : []
553
+ ),
554
+ bindings: {
555
+ ...props.bindings,
556
+ kv_namespaces: (props.bindings.kv_namespaces || []).concat(
557
+ assets.namespace
558
+ ? { binding: "__STATIC_CONTENT", id: assets.namespace }
559
+ : []
560
+ ),
561
+ text_blobs: {
562
+ ...props.bindings.text_blobs,
563
+ ...(assets.manifest &&
564
+ props.format === "service-worker" && {
565
+ __STATIC_CONTENT_MANIFEST: "__STATIC_CONTENT_MANIFEST",
566
+ }),
567
+ },
568
+ },
569
+ migrations: undefined, // no migrations in dev
570
+ compatibility_date: props.compatibilityDate,
571
+ compatibility_flags: props.compatibilityFlags,
572
+ usage_model: props.usageModel,
573
+ keepVars: true,
574
+ logpush: false,
575
+ };
576
+
577
+ return init;
67
578
  }
68
579
 
69
- export function useWorker(props: {
70
- name: string | undefined;
71
- bundle: EsbuildBundle | undefined;
72
- format: CfScriptFormat | undefined;
73
- modules: CfModule[];
74
- accountId: string | undefined;
75
- bindings: CfWorkerInit["bindings"];
76
- assetPaths: AssetPaths | undefined;
77
- port: number;
78
- compatibilityDate: string | undefined;
79
- compatibilityFlags: string[] | undefined;
80
- usageModel: "bundled" | "unbound" | undefined;
81
- env: string | undefined;
82
- legacyEnv: boolean | undefined;
83
- zone: string | undefined;
84
- host: string | undefined;
85
- }): CfPreviewToken | undefined {
86
- const {
87
- name,
88
- bundle,
89
- format,
90
- modules,
91
- accountId,
92
- bindings,
93
- assetPaths,
94
- compatibilityDate,
95
- compatibilityFlags,
96
- usageModel,
97
- port,
98
- } = props;
99
- const [token, setToken] = useState<CfPreviewToken | undefined>();
100
-
101
- // This is the most reliable way to detect whether
102
- // something's "happened" in our system; We make a ref and
103
- // mark it once we log our initial message. Refs are vars!
104
- const startedRef = useRef(false);
105
- // This ref holds the actual accountId being used, the `accountId` prop could be undefined
106
- // as it is only what is retrieved from the wrangler.toml config.
107
- const accountIdRef = useRef(accountId);
108
-
109
- useEffect(() => {
110
- const abortController = new AbortController();
111
- async function start() {
112
- setToken(undefined); // reset token in case we're re-running
113
-
114
- if (!bundle || !format) return;
115
-
116
- if (!startedRef.current) {
117
- startedRef.current = true;
118
- } else {
119
- logger.log("⎔ Detected changes, restarted server.");
120
- }
121
-
122
- // Ensure we have an account id, even if it means logging in here.
123
- accountIdRef.current = await requireAuth({
124
- account_id: accountIdRef.current,
125
- });
126
-
127
- const assets = await syncAssets(
128
- accountIdRef.current,
129
- // When we're using the newer service environments, we wouldn't
130
- // have added the env name on to the script name. However, we must
131
- // include it in the kv namespace name regardless (since there's no
132
- // concept of service environments for kv namespaces yet).
133
- name + (!props.legacyEnv && props.env ? `-${props.env}` : ""),
134
- assetPaths,
135
- true,
136
- false
137
- ); // TODO: cancellable?
138
-
139
- const content = await readFile(bundle.path, "utf-8");
140
-
141
- const init: CfWorkerInit = {
142
- name,
143
- main: {
144
- name: path.basename(bundle.path),
145
- type: format === "modules" ? "esm" : "commonjs",
146
- content,
147
- },
148
- modules: modules.concat(
149
- assets.manifest
150
- ? {
151
- name: "__STATIC_CONTENT_MANIFEST",
152
- content: JSON.stringify(assets.manifest),
153
- type: "text",
154
- }
155
- : []
156
- ),
157
- bindings: {
158
- ...bindings,
159
- kv_namespaces: (bindings.kv_namespaces || []).concat(
160
- assets.namespace
161
- ? { binding: "__STATIC_CONTENT", id: assets.namespace }
162
- : []
163
- ),
164
- text_blobs: {
165
- ...bindings.text_blobs,
166
- ...(assets.manifest &&
167
- format === "service-worker" && {
168
- __STATIC_CONTENT_MANIFEST: "__STATIC_CONTENT_MANIFEST",
169
- }),
170
- },
171
- },
172
- migrations: undefined, // no migrations in dev
173
- compatibility_date: compatibilityDate,
174
- compatibility_flags: compatibilityFlags,
175
- usage_model: usageModel,
176
- };
177
- setToken(
178
- await createWorkerPreview(
179
- init,
180
- {
181
- accountId: accountIdRef.current,
182
- apiToken: requireApiToken(),
183
- },
184
- {
185
- env: props.env,
186
- legacyEnv: props.legacyEnv,
187
- zone: props.zone,
188
- host: props.host,
189
- },
190
- abortController.signal
191
- )
192
- );
193
- }
194
- start().catch((err) => {
195
- // we want to log the error, but not end the process
196
- // since it could recover after the developer fixes whatever's wrong
197
- if ((err as { code: string }).code !== "ABORT_ERR") {
198
- // instead of logging the raw API error to the user,
199
- // give them friendly instructions
200
- // for error 10063 (workers.dev subdomain required)
201
- if (err.code === 10063) {
202
- const errorMessage =
203
- "Error: You need to register a workers.dev subdomain before running the dev command in remote mode";
204
- const solutionMessage =
205
- "You can either enable local mode by pressing l, or register a workers.dev subdomain here:";
206
- const onboardingLink = `https://dash.cloudflare.com/${accountIdRef.current}/workers/onboarding`;
207
- logger.error(
208
- `${errorMessage}\n${solutionMessage}\n${onboardingLink}`
209
- );
210
- } else {
211
- logger.error("Error on remote worker:", err);
212
- }
213
- }
214
- });
215
-
216
- return () => {
217
- abortController.abort();
218
- };
219
- }, [
220
- name,
221
- bundle,
222
- format,
223
- accountId,
224
- port,
225
- assetPaths,
226
- compatibilityDate,
227
- compatibilityFlags,
228
- usageModel,
229
- bindings,
230
- modules,
231
- props.env,
232
- props.legacyEnv,
233
- props.zone,
234
- props.host,
235
- ]);
236
- return token;
580
+ function getWorkerAccountAndContext(props: {
581
+ accountId: string;
582
+ env?: string;
583
+ legacyEnv?: boolean;
584
+ zone?: string;
585
+ host?: string;
586
+ routes: Route[] | undefined;
587
+ sendMetrics?: boolean;
588
+ }): { workerAccount: CfAccount; workerContext: CfWorkerContext } {
589
+ const workerAccount: CfAccount = {
590
+ accountId: props.accountId,
591
+ apiToken: requireApiToken(),
592
+ };
593
+
594
+ const workerContext: CfWorkerContext = {
595
+ env: props.env,
596
+ legacyEnv: props.legacyEnv,
597
+ zone: props.zone,
598
+ host: props.host,
599
+ routes: props.routes,
600
+ sendMetrics: props.sendMetrics,
601
+ };
602
+
603
+ return { workerAccount, workerContext };
604
+ }
605
+
606
+ /**
607
+ * A component that allows the user to select from a list of available accounts.
608
+ */
609
+ function ChooseAccount(props: {
610
+ accounts: ChooseAccountItem[];
611
+ onSelect: (account: { name: string; id: string }) => void;
612
+ onError: (error: Error) => void;
613
+ }) {
614
+ return (
615
+ <>
616
+ <Text bold>Select an account from below:</Text>
617
+ <SelectInput
618
+ items={props.accounts.map((item) => ({
619
+ key: item.id,
620
+ label: item.name,
621
+ value: item,
622
+ }))}
623
+ onSelect={(item) => {
624
+ logger.log(`Using account: "${item.value.name} - ${item.value.id}"`);
625
+ props.onSelect({ id: item.value.id, name: item.value.name });
626
+ }}
627
+ />
628
+ </>
629
+ );
237
630
  }