wrangler 0.0.0-e3ce82b → 0.0.0-e4047cab

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