wrangler 0.0.0-e87ad068 → 0.0.0-e8a2a1d9

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 (322) hide show
  1. package/README.md +10 -12
  2. package/bin/wrangler.js +13 -74
  3. package/package.json +213 -199
  4. package/templates/__tests__/tsconfig.json +1 -1
  5. package/templates/checked-fetch.js +10 -3
  6. package/templates/facade.d.ts +4 -1
  7. package/templates/middleware/common.ts +9 -4
  8. package/templates/middleware/loader-modules.ts +64 -11
  9. package/templates/middleware/loader-sw.ts +2 -7
  10. package/templates/middleware/middleware-d1-beta.d.ts +3 -0
  11. package/templates/middleware/middleware-miniflare3-json-error.ts +1 -0
  12. package/templates/middleware/middleware-multiworker-dev.d.ts +4 -0
  13. package/templates/middleware/middleware-multiworker-dev.ts +68 -0
  14. package/templates/middleware/middleware-serve-static-assets.d.ts +6 -0
  15. package/templates/middleware/middleware-serve-static-assets.ts +56 -0
  16. package/templates/modules-watch-stub.js +4 -0
  17. package/templates/new-worker-scheduled.ts +1 -1
  18. package/templates/new-worker.ts +1 -1
  19. package/templates/pages-shim.ts +0 -3
  20. package/templates/pages-template-plugin.ts +12 -2
  21. package/templates/pages-template-worker.ts +11 -2
  22. package/templates/startDevWorker/InspectorProxyWorker.ts +652 -0
  23. package/templates/startDevWorker/ProxyWorker.ts +252 -0
  24. package/templates/tsconfig.json +1 -1
  25. package/wrangler-dist/InspectorProxyWorker.js +460 -0
  26. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  27. package/wrangler-dist/ProxyWorker.js +186 -0
  28. package/wrangler-dist/ProxyWorker.js.map +6 -0
  29. package/wrangler-dist/cli.d.ts +21989 -199
  30. package/wrangler-dist/cli.js +110619 -103132
  31. package/wrangler-dist/wasm-sync.wasm +0 -0
  32. package/import_meta_url.js +0 -3
  33. package/miniflare-config-stubs/.env.empty +0 -0
  34. package/miniflare-config-stubs/package.empty.json +0 -1
  35. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  36. package/miniflare-dist/index.mjs +0 -6442
  37. package/src/__tests__/access.test.ts +0 -25
  38. package/src/__tests__/api-dev.test.ts +0 -238
  39. package/src/__tests__/api-devregistry.test.ts +0 -121
  40. package/src/__tests__/api.test.ts +0 -102
  41. package/src/__tests__/config-cache-without-cache-dir.test.ts +0 -38
  42. package/src/__tests__/config-cache.test.ts +0 -42
  43. package/src/__tests__/configuration.test.ts +0 -4727
  44. package/src/__tests__/constellation.test.ts +0 -371
  45. package/src/__tests__/d1/d1.test.ts +0 -82
  46. package/src/__tests__/d1/execute.test.ts +0 -66
  47. package/src/__tests__/d1/migrate.test.ts +0 -257
  48. package/src/__tests__/d1/splitter.test.ts +0 -255
  49. package/src/__tests__/delete.test.ts +0 -272
  50. package/src/__tests__/deployments.test.ts +0 -369
  51. package/src/__tests__/dev.test.tsx +0 -1617
  52. package/src/__tests__/generate.test.ts +0 -237
  53. package/src/__tests__/get-host-from-url.test.ts +0 -16
  54. package/src/__tests__/guess-worker-format.test.ts +0 -120
  55. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  56. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  57. package/src/__tests__/helpers/end-event-loop.ts +0 -6
  58. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  59. package/src/__tests__/helpers/mock-auth-domain.ts +0 -20
  60. package/src/__tests__/helpers/mock-bin.ts +0 -36
  61. package/src/__tests__/helpers/mock-console.ts +0 -112
  62. package/src/__tests__/helpers/mock-dialogs.ts +0 -139
  63. package/src/__tests__/helpers/mock-get-pages-upload-token.ts +0 -25
  64. package/src/__tests__/helpers/mock-get-zone-from-host.ts +0 -11
  65. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  66. package/src/__tests__/helpers/mock-istty.ts +0 -74
  67. package/src/__tests__/helpers/mock-known-routes.ts +0 -12
  68. package/src/__tests__/helpers/mock-kv.ts +0 -46
  69. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -263
  70. package/src/__tests__/helpers/mock-process.ts +0 -34
  71. package/src/__tests__/helpers/mock-set-timeout.ts +0 -16
  72. package/src/__tests__/helpers/mock-stdin.ts +0 -108
  73. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  74. package/src/__tests__/helpers/msw/blob-worker.cjs +0 -19
  75. package/src/__tests__/helpers/msw/handlers/access.ts +0 -13
  76. package/src/__tests__/helpers/msw/handlers/deployments.ts +0 -160
  77. package/src/__tests__/helpers/msw/handlers/namespaces.ts +0 -81
  78. package/src/__tests__/helpers/msw/handlers/oauth.ts +0 -31
  79. package/src/__tests__/helpers/msw/handlers/r2.ts +0 -60
  80. package/src/__tests__/helpers/msw/handlers/script.ts +0 -56
  81. package/src/__tests__/helpers/msw/handlers/user.ts +0 -52
  82. package/src/__tests__/helpers/msw/handlers/zones.ts +0 -20
  83. package/src/__tests__/helpers/msw/index.ts +0 -52
  84. package/src/__tests__/helpers/msw/read-file-sync.js +0 -61
  85. package/src/__tests__/helpers/run-in-tmp.ts +0 -38
  86. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  87. package/src/__tests__/helpers/string-dynamic-values-matcher.ts +0 -28
  88. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +0 -1
  89. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +0 -5
  90. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +0 -1
  91. package/src/__tests__/helpers/worker-scripts/parent-worker.js +0 -11
  92. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +0 -5
  93. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  94. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  95. package/src/__tests__/https-options.test.ts +0 -163
  96. package/src/__tests__/index.test.ts +0 -282
  97. package/src/__tests__/init.test.ts +0 -3302
  98. package/src/__tests__/jest.setup.ts +0 -179
  99. package/src/__tests__/kv.test.ts +0 -1799
  100. package/src/__tests__/logger.test.ts +0 -207
  101. package/src/__tests__/logout.test.ts +0 -47
  102. package/src/__tests__/metrics.test.ts +0 -493
  103. package/src/__tests__/middleware.scheduled.test.ts +0 -145
  104. package/src/__tests__/middleware.test.ts +0 -816
  105. package/src/__tests__/mtls-certificates.test.ts +0 -589
  106. package/src/__tests__/package-manager.test.ts +0 -353
  107. package/src/__tests__/pages/deployment-list.test.ts +0 -80
  108. package/src/__tests__/pages/functions-build.test.ts +0 -529
  109. package/src/__tests__/pages/pages.test.ts +0 -81
  110. package/src/__tests__/pages/project-create.test.ts +0 -63
  111. package/src/__tests__/pages/project-list.test.ts +0 -110
  112. package/src/__tests__/pages/project-upload.test.ts +0 -500
  113. package/src/__tests__/pages/publish.test.ts +0 -2864
  114. package/src/__tests__/pages-deployment-tail.test.ts +0 -957
  115. package/src/__tests__/parse.test.ts +0 -436
  116. package/src/__tests__/paths.test.ts +0 -39
  117. package/src/__tests__/publish.test.ts +0 -8882
  118. package/src/__tests__/pubsub.test.ts +0 -496
  119. package/src/__tests__/queues.test.ts +0 -532
  120. package/src/__tests__/r2.test.ts +0 -374
  121. package/src/__tests__/route.test.ts +0 -45
  122. package/src/__tests__/secret.test.ts +0 -693
  123. package/src/__tests__/tail.test.ts +0 -1000
  124. package/src/__tests__/test-old-node-version.js +0 -31
  125. package/src/__tests__/traverse-module-graph.test.ts +0 -220
  126. package/src/__tests__/tsconfig-sanity.ts +0 -12
  127. package/src/__tests__/tsconfig.json +0 -8
  128. package/src/__tests__/tsconfig.tsbuildinfo +0 -1
  129. package/src/__tests__/type-generation.test.ts +0 -234
  130. package/src/__tests__/unstableDev.test.ts +0 -61
  131. package/src/__tests__/user.test.ts +0 -118
  132. package/src/__tests__/utils-collectKeyValues.test.ts +0 -47
  133. package/src/__tests__/validate-dev-props.test.ts +0 -56
  134. package/src/__tests__/version.test.ts +0 -35
  135. package/src/__tests__/whoami.test.tsx +0 -172
  136. package/src/__tests__/worker-namespace.test.ts +0 -340
  137. package/src/abort.d.ts +0 -3
  138. package/src/api/dev.ts +0 -328
  139. package/src/api/index.ts +0 -11
  140. package/src/api/mtls-certificate.ts +0 -148
  141. package/src/api/pages/create-worker-bundle-contents.ts +0 -80
  142. package/src/api/pages/index.ts +0 -5
  143. package/src/api/pages/publish.tsx +0 -371
  144. package/src/bundle-reporter.ts +0 -68
  145. package/src/bundle.ts +0 -952
  146. package/src/cfetch/index.ts +0 -158
  147. package/src/cfetch/internal.ts +0 -263
  148. package/src/cli.ts +0 -28
  149. package/src/config/README.md +0 -107
  150. package/src/config/config.ts +0 -282
  151. package/src/config/diagnostics.ts +0 -80
  152. package/src/config/environment.ts +0 -659
  153. package/src/config/index.ts +0 -424
  154. package/src/config/validation-helpers.ts +0 -597
  155. package/src/config/validation.ts +0 -2524
  156. package/src/config-cache.ts +0 -85
  157. package/src/constellation/createProject.tsx +0 -51
  158. package/src/constellation/deleteProject.ts +0 -51
  159. package/src/constellation/deleteProjectModel.ts +0 -76
  160. package/src/constellation/index.ts +0 -75
  161. package/src/constellation/listCatalog.tsx +0 -35
  162. package/src/constellation/listModel.tsx +0 -49
  163. package/src/constellation/listProject.tsx +0 -28
  164. package/src/constellation/listRuntime.tsx +0 -28
  165. package/src/constellation/options.ts +0 -17
  166. package/src/constellation/types.ts +0 -17
  167. package/src/constellation/uploadModel.tsx +0 -84
  168. package/src/constellation/utils.ts +0 -90
  169. package/src/create-worker-preview.ts +0 -293
  170. package/src/create-worker-upload-form.ts +0 -384
  171. package/src/d1/backups.tsx +0 -219
  172. package/src/d1/constants.ts +0 -5
  173. package/src/d1/create.tsx +0 -102
  174. package/src/d1/delete.ts +0 -53
  175. package/src/d1/execute.tsx +0 -371
  176. package/src/d1/formatTimeAgo.ts +0 -14
  177. package/src/d1/index.ts +0 -100
  178. package/src/d1/list.tsx +0 -62
  179. package/src/d1/migrations/apply.tsx +0 -235
  180. package/src/d1/migrations/create.tsx +0 -79
  181. package/src/d1/migrations/helpers.ts +0 -171
  182. package/src/d1/migrations/index.ts +0 -3
  183. package/src/d1/migrations/list.tsx +0 -95
  184. package/src/d1/migrations/options.ts +0 -23
  185. package/src/d1/options.ts +0 -22
  186. package/src/d1/splitter.ts +0 -161
  187. package/src/d1/types.ts +0 -32
  188. package/src/d1/utils.ts +0 -49
  189. package/src/delete.ts +0 -100
  190. package/src/deployments.ts +0 -368
  191. package/src/deprecated/index.ts +0 -144
  192. package/src/dev/dev-vars.ts +0 -39
  193. package/src/dev/dev.tsx +0 -607
  194. package/src/dev/get-local-persistence-path.ts +0 -31
  195. package/src/dev/local.tsx +0 -952
  196. package/src/dev/remote.tsx +0 -636
  197. package/src/dev/start-server.ts +0 -558
  198. package/src/dev/use-esbuild.ts +0 -230
  199. package/src/dev/validate-dev-props.ts +0 -40
  200. package/src/dev-registry.ts +0 -213
  201. package/src/dev.tsx +0 -946
  202. package/src/dialogs.ts +0 -136
  203. package/src/dispatch-namespace.ts +0 -211
  204. package/src/docs/helpers.ts +0 -50
  205. package/src/docs/index.ts +0 -54
  206. package/src/durable.ts +0 -102
  207. package/src/entry.ts +0 -344
  208. package/src/environment-variables/factory.ts +0 -89
  209. package/src/environment-variables/misc-variables.ts +0 -30
  210. package/src/errors.ts +0 -11
  211. package/src/generate/index.ts +0 -303
  212. package/src/git-client.ts +0 -135
  213. package/src/global-wrangler-config-path.ts +0 -26
  214. package/src/https-options.ts +0 -127
  215. package/src/index.ts +0 -769
  216. package/src/init.ts +0 -1074
  217. package/src/inspect.ts +0 -883
  218. package/src/intl-polyfill.d.ts +0 -139
  219. package/src/is-ci.ts +0 -14
  220. package/src/is-interactive.ts +0 -16
  221. package/src/jest.d.ts +0 -4
  222. package/src/kv/helpers.ts +0 -433
  223. package/src/kv/index.ts +0 -594
  224. package/src/logger.ts +0 -123
  225. package/src/metrics/index.ts +0 -5
  226. package/src/metrics/metrics-config.ts +0 -239
  227. package/src/metrics/metrics-dispatcher.ts +0 -96
  228. package/src/metrics/metrics-usage-headers.ts +0 -24
  229. package/src/metrics/send-event.ts +0 -99
  230. package/src/miniflare-cli/README.md +0 -30
  231. package/src/miniflare-cli/assets.ts +0 -251
  232. package/src/miniflare-cli/index.ts +0 -210
  233. package/src/miniflare-cli/request-context.ts +0 -40
  234. package/src/miniflare-cli/tsconfig.json +0 -9
  235. package/src/miniflare-cli/tsconfig.tsbuildinfo +0 -1
  236. package/src/miniflare-cli/types.ts +0 -11
  237. package/src/module-collection.ts +0 -333
  238. package/src/mtls-certificate/cli.ts +0 -155
  239. package/src/open-in-browser.ts +0 -17
  240. package/src/package-manager.ts +0 -219
  241. package/src/pages/build.ts +0 -423
  242. package/src/pages/buildFunctions.ts +0 -140
  243. package/src/pages/constants.ts +0 -18
  244. package/src/pages/deployment-tails.ts +0 -281
  245. package/src/pages/deployments.tsx +0 -84
  246. package/src/pages/dev.ts +0 -759
  247. package/src/pages/errors.ts +0 -67
  248. package/src/pages/functions/buildPlugin.ts +0 -114
  249. package/src/pages/functions/buildWorker.ts +0 -381
  250. package/src/pages/functions/filepath-routing.test.ts +0 -234
  251. package/src/pages/functions/filepath-routing.ts +0 -189
  252. package/src/pages/functions/identifiers.ts +0 -78
  253. package/src/pages/functions/routes-consolidation.test.ts +0 -250
  254. package/src/pages/functions/routes-consolidation.ts +0 -73
  255. package/src/pages/functions/routes-transformation.test.ts +0 -282
  256. package/src/pages/functions/routes-transformation.ts +0 -115
  257. package/src/pages/functions/routes-validation.test.ts +0 -403
  258. package/src/pages/functions/routes-validation.ts +0 -202
  259. package/src/pages/functions/routes.ts +0 -151
  260. package/src/pages/functions/tsconfig.json +0 -8
  261. package/src/pages/functions/tsconfig.tsbuildinfo +0 -1
  262. package/src/pages/functions.ts +0 -86
  263. package/src/pages/hash.ts +0 -13
  264. package/src/pages/index.ts +0 -102
  265. package/src/pages/projects.tsx +0 -159
  266. package/src/pages/prompt-select-project.tsx +0 -31
  267. package/src/pages/publish.tsx +0 -267
  268. package/src/pages/types.ts +0 -46
  269. package/src/pages/upload.tsx +0 -469
  270. package/src/pages/utils.ts +0 -23
  271. package/src/parse.ts +0 -308
  272. package/src/paths.ts +0 -71
  273. package/src/proxy.ts +0 -694
  274. package/src/publish/index.ts +0 -274
  275. package/src/publish/publish.ts +0 -1068
  276. package/src/pubsub/index.ts +0 -286
  277. package/src/pubsub/pubsub-commands.ts +0 -623
  278. package/src/queues/cli/commands/consumer/add.ts +0 -71
  279. package/src/queues/cli/commands/consumer/index.ts +0 -19
  280. package/src/queues/cli/commands/consumer/remove.ts +0 -31
  281. package/src/queues/cli/commands/create.ts +0 -25
  282. package/src/queues/cli/commands/delete.ts +0 -26
  283. package/src/queues/cli/commands/index.ts +0 -35
  284. package/src/queues/cli/commands/list.ts +0 -25
  285. package/src/queues/client.ts +0 -136
  286. package/src/queues/utils.ts +0 -18
  287. package/src/r2/constants.ts +0 -4
  288. package/src/r2/helpers.ts +0 -132
  289. package/src/r2/index.ts +0 -289
  290. package/src/routes.ts +0 -140
  291. package/src/secret/index.ts +0 -380
  292. package/src/selfsigned.d.ts +0 -29
  293. package/src/sites.ts +0 -484
  294. package/src/tail/createTail.ts +0 -415
  295. package/src/tail/filters.ts +0 -277
  296. package/src/tail/index.ts +0 -211
  297. package/src/tail/printing.ts +0 -134
  298. package/src/traverse-module-graph.ts +0 -54
  299. package/src/tsconfig-sanity.ts +0 -16
  300. package/src/type-generation.ts +0 -187
  301. package/src/update-check.ts +0 -19
  302. package/src/user/access.ts +0 -68
  303. package/src/user/auth-variables.ts +0 -113
  304. package/src/user/choose-account.tsx +0 -39
  305. package/src/user/generate-auth-url.ts +0 -33
  306. package/src/user/generate-random-state.ts +0 -16
  307. package/src/user/index.ts +0 -2
  308. package/src/user/user.ts +0 -1234
  309. package/src/utils/collectKeyValues.ts +0 -14
  310. package/src/utils/render.ts +0 -93
  311. package/src/whoami.ts +0 -135
  312. package/src/worker.ts +0 -300
  313. package/src/yargs-types.ts +0 -37
  314. package/src/zones.ts +0 -191
  315. package/templates/__tests__/tsconfig.tsbuildinfo +0 -1
  316. package/templates/d1-beta-facade.js +0 -244
  317. package/templates/first-party-worker-module-facade.ts +0 -19
  318. package/templates/format-dev-errors.ts +0 -34
  319. package/templates/serve-static-assets.ts +0 -66
  320. package/templates/service-bindings-module-facade.js +0 -55
  321. package/templates/service-bindings-sw-facade.js +0 -42
  322. package/templates/tsconfig.tsbuildinfo +0 -1
package/src/dev/local.tsx DELETED
@@ -1,952 +0,0 @@
1
- import assert from "node:assert";
2
- import { fork } from "node:child_process";
3
- import { realpathSync } from "node:fs";
4
- import { readFile } from "node:fs/promises";
5
- import path from "node:path";
6
- import chalk from "chalk";
7
- import getPort from "get-port";
8
- import { npxImport } from "npx-import";
9
- import { useState, useEffect, useRef } from "react";
10
- import onExit from "signal-exit";
11
- import { fetch } from "undici";
12
- import { performApiFetch } from "../cfetch/internal";
13
- import { registerWorker } from "../dev-registry";
14
- import useInspector from "../inspect";
15
- import { logger } from "../logger";
16
- import {
17
- DEFAULT_MODULE_RULES,
18
- ModuleTypeToRuleType,
19
- } from "../module-collection";
20
- import { getBasePath } from "../paths";
21
- import { waitForPortToBeAvailable } from "../proxy";
22
- import { requireAuth } from "../user";
23
- import type { Config } from "../config";
24
- import type { WorkerRegistry } from "../dev-registry";
25
- import type { LoggerLevel } from "../logger";
26
- import type { EnablePagesAssetsServiceBindingOptions } from "../miniflare-cli/types";
27
- import type { AssetPaths } from "../sites";
28
- import type {
29
- CfWorkerInit,
30
- CfScriptFormat,
31
- CfWasmModuleBindings,
32
- CfTextBlobBindings,
33
- CfDataBlobBindings,
34
- CfDurableObject,
35
- CfKvNamespace,
36
- CfR2Bucket,
37
- CfVars,
38
- CfQueue,
39
- CfD1Database,
40
- } from "../worker";
41
- import type { EsbuildBundle } from "./use-esbuild";
42
- import type {
43
- Miniflare as Miniflare3Type,
44
- MiniflareOptions as Miniflare3Options,
45
- Log as Miniflare3LogType,
46
- CloudflareFetch,
47
- } from "@miniflare/tre";
48
- import type { MiniflareOptions } from "miniflare";
49
- import type { ChildProcess } from "node:child_process";
50
-
51
- export interface LocalProps {
52
- name: string | undefined;
53
- bundle: EsbuildBundle | undefined;
54
- format: CfScriptFormat | undefined;
55
- compatibilityDate: string;
56
- compatibilityFlags: string[] | undefined;
57
- usageModel: "bundled" | "unbound" | undefined;
58
- bindings: CfWorkerInit["bindings"];
59
- workerDefinitions: WorkerRegistry | undefined;
60
- assetPaths: AssetPaths | undefined;
61
- initialPort: number;
62
- initialIp: string;
63
- rules: Config["rules"];
64
- inspectorPort: number;
65
- localPersistencePath: string | null;
66
- liveReload: boolean;
67
- crons: Config["triggers"]["crons"];
68
- queueConsumers: Config["queues"]["consumers"];
69
- localProtocol: "http" | "https";
70
- localUpstream: string | undefined;
71
- inspect: boolean;
72
- onReady: ((ip: string, port: number) => void) | undefined;
73
- enablePagesAssetsServiceBinding?: EnablePagesAssetsServiceBindingOptions;
74
- testScheduled?: boolean;
75
- experimentalLocal: boolean | undefined;
76
- accountId: string | undefined; // Account ID? In local mode??? :exploding_head:
77
- experimentalLocalRemoteKv: boolean | undefined;
78
- sourceMapPath: string | undefined;
79
- }
80
-
81
- type InspectorJSON = {
82
- id: string;
83
- title: string;
84
- type: "node";
85
- description: string;
86
- webSocketDebuggerUrl: string;
87
- devtoolsFrontendUrl: string;
88
- devtoolsFrontendUrlCompat: string;
89
- faviconUrl: string;
90
- url: string;
91
- }[];
92
-
93
- export function Local(props: LocalProps) {
94
- const { inspectorUrl } = useLocalWorker(props);
95
- useInspector({
96
- inspectorUrl,
97
- port: props.inspectorPort,
98
- logToTerminal: props.experimentalLocal ?? false,
99
- sourceMapPath: props.sourceMapPath,
100
- name: props.name,
101
- sourceMapMetadata: props.bundle?.sourceMapMetadata,
102
- });
103
- return null;
104
- }
105
-
106
- function useLocalWorker({
107
- name: workerName,
108
- bundle,
109
- format,
110
- compatibilityDate,
111
- compatibilityFlags,
112
- usageModel,
113
- bindings,
114
- workerDefinitions,
115
- assetPaths,
116
- initialPort,
117
- rules,
118
- localPersistencePath,
119
- liveReload,
120
- initialIp,
121
- crons,
122
- queueConsumers,
123
- localProtocol,
124
- localUpstream,
125
- inspect,
126
- onReady,
127
- enablePagesAssetsServiceBinding,
128
- experimentalLocal,
129
- accountId,
130
- experimentalLocalRemoteKv,
131
- }: LocalProps) {
132
- // TODO: pass vars via command line
133
- const local = useRef<ChildProcess>();
134
- const experimentalLocalRef = useRef<Miniflare3Type>();
135
- const removeSignalExitListener = useRef<() => void>();
136
- const removeExperimentalLocalSignalExitListener = useRef<() => void>();
137
- const [inspectorUrl, setInspectorUrl] = useState<string | undefined>();
138
-
139
- // Our inspector proxy server will be binding to `LocalProps`'s `inspectorPort`.
140
- // If we attempted to bind Node.js/workerd to the same inspector port, we'd get a port already in use error.
141
- // Therefore, generate a new random port for our runtime's to bind their inspector service to.
142
- const runtimeInspectorPortRef = useRef<number>();
143
-
144
- useEffect(() => {
145
- if (bindings.services && bindings.services.length > 0) {
146
- logger.warn(
147
- "⎔ Support for service bindings in local mode is experimental and may change."
148
- );
149
- }
150
- }, [bindings.services]);
151
-
152
- useEffect(() => {
153
- const externalDurableObjects = (
154
- bindings.durable_objects?.bindings || []
155
- ).filter((binding) => binding.script_name);
156
-
157
- if (externalDurableObjects.length > 0) {
158
- logger.warn(
159
- "⎔ Support for external Durable Objects in local mode is experimental and may change."
160
- );
161
- }
162
- }, [bindings.durable_objects?.bindings]);
163
-
164
- useEffect(() => {
165
- const abortController = new AbortController();
166
- async function startLocalWorker() {
167
- if (!bundle || !format) return;
168
-
169
- const scriptPath = realpathSync(bundle.path);
170
-
171
- const upstream =
172
- typeof localUpstream === "string"
173
- ? `${localProtocol}://${localUpstream}`
174
- : undefined;
175
-
176
- const {
177
- externalDurableObjects,
178
- internalDurableObjects,
179
- wasmBindings,
180
- textBlobBindings,
181
- dataBlobBindings,
182
- } = setupBindings({
183
- wasm_modules: bindings.wasm_modules,
184
- text_blobs: bindings.text_blobs,
185
- data_blobs: bindings.data_blobs,
186
- durable_objects: bindings.durable_objects,
187
- format,
188
- bundle,
189
- });
190
-
191
- runtimeInspectorPortRef.current ??= await getPort();
192
- const runtimeInspectorPort = runtimeInspectorPortRef.current;
193
-
194
- const { forkOptions, miniflareCLIPath, options } = setupMiniflareOptions({
195
- workerName,
196
- port: initialPort,
197
- scriptPath,
198
- localProtocol,
199
- ip: initialIp,
200
- format,
201
- rules,
202
- compatibilityDate,
203
- compatibilityFlags,
204
- usageModel,
205
- kv_namespaces: bindings?.kv_namespaces,
206
- r2_buckets: bindings?.r2_buckets,
207
- queueBindings: bindings?.queues,
208
- queueConsumers: queueConsumers,
209
- d1_databases: bindings?.d1_databases,
210
- internalDurableObjects,
211
- externalDurableObjects,
212
- localPersistencePath,
213
- liveReload,
214
- assetPaths,
215
- vars: bindings?.vars,
216
- wasmBindings,
217
- textBlobBindings,
218
- dataBlobBindings,
219
- crons,
220
- upstream,
221
- workerDefinitions,
222
- enablePagesAssetsServiceBinding,
223
- });
224
-
225
- if (experimentalLocal) {
226
- const log = await buildMiniflare3Logger();
227
- const mf3Options = await transformMf2OptionsToMf3Options({
228
- miniflare2Options: options,
229
- format,
230
- bundle,
231
- log,
232
- enablePagesAssetsServiceBinding,
233
- kvNamespaces: bindings?.kv_namespaces,
234
- r2Buckets: bindings?.r2_buckets,
235
- d1Databases: bindings?.d1_databases,
236
- authenticatedAccountId: accountId,
237
- kvRemote: experimentalLocalRemoteKv,
238
- inspectorPort: runtimeInspectorPort,
239
- });
240
-
241
- const current = experimentalLocalRef.current;
242
-
243
- if (current === undefined) {
244
- // If we don't have an active Miniflare instance, create a new one
245
- const { Miniflare } = await getMiniflare3();
246
- if (abortController.signal.aborted) return;
247
- const mf = new Miniflare(mf3Options);
248
- experimentalLocalRef.current = mf;
249
- removeExperimentalLocalSignalExitListener.current = onExit(() => {
250
- logger.log("⎔ Shutting down experimental local server.");
251
- void mf.dispose();
252
- experimentalLocalRef.current = undefined;
253
- });
254
- await mf.ready;
255
- } else {
256
- // Otherwise, reuse the existing instance with its loopback server
257
- // and just update the options
258
- if (abortController.signal.aborted) return;
259
- logger.log("⎔ Reloading experimental local server.");
260
- await current.setOptions(mf3Options);
261
- }
262
-
263
- try {
264
- // fetch the inspector JSON response from the DevTools Inspector protocol
265
- const inspectorJSONArr = (await (
266
- await fetch(`http://127.0.0.1:${runtimeInspectorPort}/json`)
267
- ).json()) as InspectorJSON;
268
-
269
- const foundInspectorURL = inspectorJSONArr?.find((inspectorJSON) =>
270
- inspectorJSON.id.startsWith("core:user")
271
- )?.webSocketDebuggerUrl;
272
- if (foundInspectorURL === undefined) {
273
- setInspectorUrl(undefined);
274
- } else {
275
- const url = new URL(foundInspectorURL);
276
- // Force inspector URL to be different on each reload so `useEffect`
277
- // in `useInspector` is re-run to connect to newly restarted
278
- // `workerd` server when updating options. Can't use a query param
279
- // here as that seems to cause an infinite connection loop, can't
280
- // use a hash as those are forbidden by `ws`, so username it is.
281
- url.username = `${Date.now()}-${Math.floor(
282
- Math.random() * Number.MAX_SAFE_INTEGER
283
- )}`;
284
- setInspectorUrl(url.toString());
285
- }
286
- } catch (error: unknown) {
287
- logger.error("Error attempting to retrieve Debugger URL:", error);
288
- }
289
-
290
- return;
291
- }
292
-
293
- // Wait for the Worker port to be available. We don't want to do this in experimental local
294
- // mode, as we only `dispose()` the Miniflare 3 instance, and shutdown the server when
295
- // unmounting the component, not when props change. If we did, we'd just timeout every time.
296
- await waitForPortToBeAvailable(initialPort, {
297
- retryPeriod: 200,
298
- timeout: 2000,
299
- abortSignal: abortController.signal,
300
- });
301
-
302
- const nodeOptions = setupNodeOptions({
303
- inspect,
304
- inspectorPort: runtimeInspectorPort,
305
- });
306
- logger.log("⎔ Starting a local server...");
307
-
308
- const hasColourSupport =
309
- chalk.supportsColor.hasBasic && process.env.FORCE_COLOR !== "0";
310
- const child = (local.current = fork(miniflareCLIPath, forkOptions, {
311
- cwd: path.dirname(scriptPath),
312
- execArgv: nodeOptions,
313
- stdio: "pipe",
314
- env: {
315
- ...process.env,
316
- FORCE_COLOR: hasColourSupport ? "1" : undefined,
317
- },
318
- }));
319
-
320
- child.on("message", async (messageString) => {
321
- const message = JSON.parse(messageString as string);
322
- if (message.ready) {
323
- // Let's register our presence in the dev registry
324
- if (workerName) {
325
- await registerWorker(workerName, {
326
- protocol: localProtocol,
327
- mode: "local",
328
- port: message.port,
329
- host: initialIp,
330
- durableObjects: internalDurableObjects.map((binding) => ({
331
- name: binding.name,
332
- className: binding.class_name,
333
- })),
334
- ...(message.durableObjectsPort
335
- ? {
336
- durableObjectsHost: initialIp,
337
- durableObjectsPort: message.durableObjectsPort,
338
- }
339
- : {}),
340
- });
341
- }
342
- onReady?.(initialIp, message.port);
343
- }
344
- });
345
-
346
- child.on("close", (code) => {
347
- if (code) {
348
- logger.log(`Miniflare process exited with code ${code}`);
349
- }
350
- });
351
-
352
- child.stdout?.on("data", (data: Buffer) => {
353
- process.stdout.write(data);
354
- });
355
-
356
- // parse the node inspector url (which may be received in chunks) from stderr
357
- let stderrData = "";
358
- let inspectorUrlFound = false;
359
- child.stderr?.on("data", (data: Buffer) => {
360
- if (!inspectorUrlFound) {
361
- stderrData += data.toString();
362
- const matches =
363
- /Debugger listening on (ws:\/\/127\.0\.0\.1:\d+\/[A-Za-z0-9-]+)[\r|\n]/.exec(
364
- stderrData
365
- );
366
- if (matches) {
367
- inspectorUrlFound = true;
368
- setInspectorUrl(matches[1]);
369
- }
370
- }
371
-
372
- process.stderr.write(data);
373
- });
374
-
375
- child.on("exit", (code) => {
376
- if (code) {
377
- logger.error(`Miniflare process exited with code ${code}`);
378
- }
379
- });
380
-
381
- child.on("error", (error: Error) => {
382
- logger.error(`Miniflare process failed to spawn`);
383
- logger.error(error);
384
- });
385
-
386
- removeSignalExitListener.current = onExit((_code, _signal) => {
387
- logger.log("⎔ Shutting down local server.");
388
- child.kill();
389
- local.current = undefined;
390
- });
391
- }
392
-
393
- startLocalWorker().catch((err) => {
394
- if (err.code === "ERR_RUNTIME_FAILURE") {
395
- // Don't log a full verbose stack-trace when Miniflare 3's workerd instance fails to start.
396
- // workerd will log its own errors, and our stack trace won't have any useful information.
397
- logger.error(err.message);
398
- } else {
399
- logger.error("local worker:", err);
400
- }
401
- });
402
-
403
- return () => {
404
- abortController.abort();
405
- if (local.current) {
406
- logger.log("⎔ Shutting down local server.");
407
- local.current?.kill();
408
- local.current = undefined;
409
- }
410
- removeSignalExitListener.current?.();
411
- removeSignalExitListener.current = undefined;
412
- };
413
- }, [
414
- bundle,
415
- workerName,
416
- format,
417
- initialPort,
418
- initialIp,
419
- queueConsumers,
420
- bindings.queues,
421
- bindings.durable_objects,
422
- bindings.kv_namespaces,
423
- bindings.r2_buckets,
424
- bindings.d1_databases,
425
- bindings.vars,
426
- bindings.services,
427
- workerDefinitions,
428
- compatibilityDate,
429
- compatibilityFlags,
430
- usageModel,
431
- localPersistencePath,
432
- liveReload,
433
- assetPaths,
434
- rules,
435
- bindings.wasm_modules,
436
- bindings.text_blobs,
437
- bindings.data_blobs,
438
- crons,
439
- localProtocol,
440
- localUpstream,
441
- inspect,
442
- onReady,
443
- enablePagesAssetsServiceBinding,
444
- experimentalLocal,
445
- accountId,
446
- experimentalLocalRemoteKv,
447
- ]);
448
-
449
- // Rather than disposing the Miniflare instance on every reload, only dispose
450
- // it if local mode is disabled and the `Local` component is unmounted. This
451
- // allows us to use the more efficient `Miniflare#setOptions` on reload which
452
- // retains internal state (e.g. the Miniflare loopback server).
453
- useEffect(
454
- () => () => {
455
- if (experimentalLocalRef.current) {
456
- logger.log("⎔ Shutting down experimental local server.");
457
- // Initialisation errors are also thrown asynchronously by dispose().
458
- // The catch() above should've caught them though.
459
- experimentalLocalRef.current?.dispose().catch(() => {});
460
- experimentalLocalRef.current = undefined;
461
- }
462
- removeExperimentalLocalSignalExitListener.current?.();
463
- removeExperimentalLocalSignalExitListener.current = undefined;
464
- },
465
- []
466
- );
467
-
468
- return { inspectorUrl };
469
- }
470
-
471
- interface SetupBindingsProps {
472
- wasm_modules: CfWasmModuleBindings | undefined;
473
- text_blobs: CfTextBlobBindings | undefined;
474
- data_blobs: CfDataBlobBindings | undefined;
475
- durable_objects: { bindings: CfDurableObject[] } | undefined;
476
- bundle: EsbuildBundle;
477
- format: CfScriptFormat;
478
- }
479
-
480
- export function setupBindings({
481
- wasm_modules,
482
- text_blobs,
483
- data_blobs,
484
- durable_objects,
485
- format,
486
- bundle,
487
- }: SetupBindingsProps) {
488
- // the wasm_modules/text_blobs/data_blobs bindings are
489
- // relative to process.cwd(), but the actual worker bundle
490
- // is in the temp output directory; so we rewrite the paths to be absolute,
491
- // letting miniflare resolve them correctly
492
-
493
- // wasm
494
- const wasmBindings: Record<string, string> = {};
495
- for (const [name, filePath] of Object.entries(wasm_modules || {})) {
496
- wasmBindings[name] = path.join(process.cwd(), filePath);
497
- }
498
-
499
- // text
500
- const textBlobBindings: Record<string, string> = {};
501
- for (const [name, filePath] of Object.entries(text_blobs || {})) {
502
- textBlobBindings[name] = path.join(process.cwd(), filePath);
503
- }
504
-
505
- // data
506
- const dataBlobBindings: Record<string, string> = {};
507
- for (const [name, filePath] of Object.entries(data_blobs || {})) {
508
- dataBlobBindings[name] = path.join(process.cwd(), filePath);
509
- }
510
-
511
- if (format === "service-worker") {
512
- for (const { type, name } of bundle.modules) {
513
- if (type === "compiled-wasm") {
514
- // In service-worker format, .wasm modules are referenced by global identifiers,
515
- // so we convert it here.
516
- // This identifier has to be a valid JS identifier, so we replace all non alphanumeric
517
- // characters with an underscore.
518
- const identifier = name.replace(/[^a-zA-Z0-9_$]/g, "_");
519
- wasmBindings[identifier] = name;
520
- } else if (type === "text") {
521
- // In service-worker format, text modules are referenced by global identifiers,
522
- // so we convert it here.
523
- // This identifier has to be a valid JS identifier, so we replace all non alphanumeric
524
- // characters with an underscore.
525
- const identifier = name.replace(/[^a-zA-Z0-9_$]/g, "_");
526
- textBlobBindings[identifier] = name;
527
- } else if (type === "buffer") {
528
- // In service-worker format, data blobs are referenced by global identifiers,
529
- // so we convert it here.
530
- // This identifier has to be a valid JS identifier, so we replace all non alphanumeric
531
- // characters with an underscore.
532
- const identifier = name.replace(/[^a-zA-Z0-9_$]/g, "_");
533
- dataBlobBindings[identifier] = name;
534
- }
535
- }
536
- }
537
-
538
- const internalDurableObjects = (durable_objects?.bindings || []).filter(
539
- (binding) => !binding.script_name
540
- );
541
- const externalDurableObjects = (durable_objects?.bindings || []).filter(
542
- (binding) => binding.script_name
543
- );
544
- return {
545
- internalDurableObjects,
546
- externalDurableObjects,
547
- wasmBindings,
548
- textBlobBindings,
549
- dataBlobBindings,
550
- };
551
- }
552
-
553
- interface SetupMiniflareOptionsProps {
554
- workerName: string | undefined;
555
- port: number;
556
- scriptPath: string;
557
- localProtocol: "http" | "https";
558
- ip: string;
559
- format: CfScriptFormat;
560
- rules: Config["rules"];
561
- compatibilityDate: string;
562
- compatibilityFlags: string[] | undefined;
563
- usageModel: "bundled" | "unbound" | undefined;
564
- kv_namespaces: CfKvNamespace[] | undefined;
565
- queueBindings: CfQueue[] | undefined;
566
- queueConsumers: Config["queues"]["consumers"];
567
- r2_buckets: CfR2Bucket[] | undefined;
568
- d1_databases: CfD1Database[] | undefined;
569
- internalDurableObjects: CfDurableObject[];
570
- externalDurableObjects: CfDurableObject[];
571
- localPersistencePath: string | null;
572
- liveReload: boolean;
573
- assetPaths: AssetPaths | undefined;
574
- vars: CfVars | undefined;
575
- wasmBindings: Record<string, string>;
576
- textBlobBindings: Record<string, string>;
577
- dataBlobBindings: Record<string, string>;
578
- crons: Config["triggers"]["crons"];
579
- upstream: string | undefined;
580
- workerDefinitions: WorkerRegistry | undefined;
581
- enablePagesAssetsServiceBinding?: EnablePagesAssetsServiceBindingOptions;
582
- }
583
-
584
- export function setupMiniflareOptions({
585
- workerName,
586
- port,
587
- scriptPath,
588
- localProtocol,
589
- ip,
590
- format,
591
- rules,
592
- compatibilityDate,
593
- compatibilityFlags,
594
- usageModel,
595
- kv_namespaces,
596
- queueBindings,
597
- queueConsumers,
598
- r2_buckets,
599
- d1_databases,
600
- internalDurableObjects,
601
- externalDurableObjects,
602
- localPersistencePath,
603
- liveReload,
604
- assetPaths,
605
- vars,
606
- wasmBindings,
607
- textBlobBindings,
608
- dataBlobBindings,
609
- crons,
610
- upstream,
611
- workerDefinitions,
612
- enablePagesAssetsServiceBinding,
613
- }: SetupMiniflareOptionsProps): {
614
- miniflareCLIPath: string;
615
- forkOptions: string[];
616
- options: MiniflareOptions;
617
- } {
618
- // It's now getting _really_ messy now with Pages ASSETS binding outside and the external Durable Objects inside.
619
- const options: MiniflareOptions = {
620
- name: workerName,
621
- port,
622
- scriptPath,
623
- https: localProtocol === "https",
624
- host: ip,
625
- modules: format === "modules",
626
- modulesRules: (rules || [])
627
- .concat(DEFAULT_MODULE_RULES)
628
- .map(({ type, globs: include, fallthrough }) => ({
629
- type,
630
- include,
631
- fallthrough,
632
- })),
633
- compatibilityDate,
634
- compatibilityFlags,
635
- usageModel,
636
- kvNamespaces: kv_namespaces?.map((kv) => kv.binding),
637
- queueBindings: queueBindings?.map((queue) => {
638
- return { name: queue.binding, queueName: queue.queue_name };
639
- }),
640
- queueConsumers: queueConsumers?.map((consumer) => {
641
- const waitMs = consumer.max_batch_timeout
642
- ? 1000 * consumer.max_batch_timeout
643
- : undefined;
644
- return {
645
- queueName: consumer.queue,
646
- maxBatchSize: consumer.max_batch_size,
647
- maxWaitMs: waitMs,
648
- maxRetries: consumer.max_retries,
649
- deadLetterQueue: consumer.dead_letter_queue,
650
- };
651
- }),
652
- r2Buckets: r2_buckets?.map((r2) => r2.binding),
653
- durableObjects: Object.fromEntries(
654
- internalDurableObjects.map((binding) => [
655
- binding.name,
656
- binding.class_name,
657
- ])
658
- ),
659
- externalDurableObjects: Object.fromEntries(
660
- externalDurableObjects
661
- .map((binding) => {
662
- const service =
663
- workerDefinitions &&
664
- workerDefinitions[binding.script_name as string];
665
- if (!service) return [binding.name, undefined];
666
-
667
- const name = service.durableObjects.find(
668
- (durableObject) => durableObject.className === binding.class_name
669
- )?.name;
670
- if (!name) return [binding.name, undefined];
671
-
672
- return [
673
- binding.name,
674
- {
675
- name,
676
- host: service.durableObjectsHost,
677
- port: service.durableObjectsPort,
678
- },
679
- ];
680
- })
681
- .filter(([_, details]) => !!details)
682
- ),
683
- d1Databases: d1_databases?.map((db) => db.binding),
684
- ...(localPersistencePath
685
- ? {
686
- cachePersist: path.join(localPersistencePath, "cache"),
687
- durableObjectsPersist: path.join(localPersistencePath, "do"),
688
- kvPersist: path.join(localPersistencePath, "kv"),
689
- r2Persist: path.join(localPersistencePath, "r2"),
690
- d1Persist: path.join(localPersistencePath, "d1"),
691
- }
692
- : {
693
- // We mark these as true, so that they'll
694
- // persist in the temp directory.
695
- // This means they'll persist across a dev session,
696
- // even if we change source and reload,
697
- // and be deleted when the dev session ends
698
- cachePersist: true,
699
- durableObjectsPersist: true,
700
- kvPersist: true,
701
- r2Persist: true,
702
- d1Persist: true,
703
- }),
704
-
705
- liveReload,
706
- sitePath: assetPaths?.assetDirectory
707
- ? path.join(assetPaths.baseDirectory, assetPaths.assetDirectory)
708
- : undefined,
709
- siteInclude: assetPaths?.includePatterns.length
710
- ? assetPaths?.includePatterns
711
- : undefined,
712
- siteExclude: assetPaths?.excludePatterns.length
713
- ? assetPaths.excludePatterns
714
- : undefined,
715
- bindings: vars,
716
- wasmBindings,
717
- textBlobBindings,
718
- dataBlobBindings,
719
- sourceMap: true,
720
- logUnhandledRejections: true,
721
- crons,
722
- upstream,
723
- logLevel: logger.loggerLevel,
724
- enablePagesAssetsServiceBinding,
725
- };
726
- // The path to the Miniflare CLI assumes that this file is being run from
727
- // `wrangler-dist` and that the CLI is found in `miniflare-dist`.
728
- // If either of those paths change this line needs updating.
729
- const miniflareCLIPath = path.resolve(
730
- getBasePath(),
731
- "miniflare-dist/index.mjs"
732
- );
733
- const miniflareOptions = JSON.stringify(options, null);
734
- const forkOptions = [miniflareOptions];
735
- if (enablePagesAssetsServiceBinding) {
736
- forkOptions.push(JSON.stringify(enablePagesAssetsServiceBinding));
737
- }
738
- return { miniflareCLIPath, forkOptions, options };
739
- }
740
-
741
- export function setupNodeOptions({
742
- inspect,
743
- inspectorPort,
744
- }: {
745
- inspect: boolean;
746
- inspectorPort: number;
747
- }) {
748
- const nodeOptions = [
749
- "--experimental-vm-modules", // ensures that Miniflare can run ESM Workers
750
- "--no-warnings", // hide annoying Node warnings
751
- // "--log=VERBOSE", // uncomment this to Miniflare to log "everything"!
752
- ];
753
- if (inspect) {
754
- nodeOptions.push("--inspect=" + `127.0.0.1:${inspectorPort}`); // start Miniflare listening for a debugger to attach
755
- }
756
- return nodeOptions;
757
- }
758
-
759
- export interface SetupMiniflare3Options {
760
- // Regular Miniflare 2 options to transform
761
- miniflare2Options: MiniflareOptions;
762
- // Miniflare 3 requires all modules to be manually specified
763
- format: CfScriptFormat;
764
- bundle: EsbuildBundle;
765
-
766
- // Miniflare's logger
767
- log: Miniflare3LogType;
768
-
769
- enablePagesAssetsServiceBinding?: EnablePagesAssetsServiceBindingOptions;
770
-
771
- // Miniflare 3 accepts namespace/bucket names in addition to binding names.
772
- // This means multiple workers persisting to the same location can have
773
- // different binding names for the same namespace/bucket. Therefore, we need
774
- // the full KV/R2 arrays. This is also required for remote KV storage, as
775
- // we need actual namespace IDs to connect to.
776
- kvNamespaces: CfKvNamespace[] | undefined;
777
- r2Buckets: CfR2Bucket[] | undefined;
778
- d1Databases: CfD1Database[] | undefined;
779
-
780
- // Account ID to use for authenticated Cloudflare fetch. If true, prompt
781
- // user for ID if multiple available.
782
- authenticatedAccountId: string | true | undefined;
783
- // Whether to read/write from/to real KV namespaces
784
- kvRemote: boolean | undefined;
785
-
786
- // Port to start DevTools inspector server on
787
- inspectorPort: number;
788
- }
789
-
790
- export async function buildMiniflare3Logger(): Promise<Miniflare3LogType> {
791
- const { Log, NoOpLog, LogLevel } = await getMiniflare3();
792
-
793
- let level = logger.loggerLevel.toUpperCase() as Uppercase<LoggerLevel>;
794
- if (level === "LOG") level = "INFO";
795
- const logLevel = LogLevel[level];
796
-
797
- return logLevel === LogLevel.NONE ? new NoOpLog() : new Log(logLevel);
798
- }
799
-
800
- function transformMf2PersistToMf3(persist?: boolean | string) {
801
- // Wrangler reuses Miniflare 3 instances between reloads but not Miniflare 2
802
- // ones. We previously set `*Persist` options to `true` by default to
803
- // persist data between reloads in the temporary script directory (Miniflare
804
- // 2's working directory). However, with Miniflare 3, the working directory
805
- // is the current working directory, so we want to set these to `false`
806
- // and use Miniflare 3's native in-memory persistence.
807
- //
808
- // See https://github.com/cloudflare/workers-sdk/issues/2995.
809
- return persist === true ? false : persist;
810
- }
811
-
812
- export async function transformMf2OptionsToMf3Options({
813
- miniflare2Options,
814
- format,
815
- bundle,
816
- log,
817
- enablePagesAssetsServiceBinding,
818
- kvNamespaces,
819
- r2Buckets,
820
- d1Databases,
821
- authenticatedAccountId,
822
- kvRemote,
823
- inspectorPort,
824
- }: SetupMiniflare3Options): Promise<Miniflare3Options> {
825
- // Build authenticated Cloudflare API fetch function if required
826
- let cloudflareFetch: CloudflareFetch | undefined;
827
- if (kvRemote && authenticatedAccountId !== undefined) {
828
- const { Response: Miniflare3Response } = await getMiniflare3();
829
- const preferredAccountId =
830
- authenticatedAccountId === true ? undefined : authenticatedAccountId;
831
- const accountId = await requireAuth({ account_id: preferredAccountId });
832
- cloudflareFetch = async (resource, searchParams, init) => {
833
- resource = `/accounts/${accountId}/${resource}`;
834
- const response = await performApiFetch(resource, init, searchParams);
835
- return new Miniflare3Response(response.body, response);
836
- };
837
- }
838
-
839
- let options: Partial<Miniflare3Options> = {
840
- ...miniflare2Options,
841
-
842
- // Miniflare 3 distinguishes between binding name and namespace/bucket IDs.
843
- kvNamespaces: Object.fromEntries(
844
- kvNamespaces?.map(({ binding, id }) => [binding, id]) ?? []
845
- ),
846
- r2Buckets: Object.fromEntries(
847
- r2Buckets?.map(({ binding, bucket_name }) => [binding, bucket_name]) ?? []
848
- ),
849
- d1Databases: Object.fromEntries(
850
- d1Databases?.map(({ binding, database_id, preview_database_id }) => [
851
- binding,
852
- preview_database_id ?? database_id,
853
- ]) ?? []
854
- ),
855
-
856
- cachePersist: transformMf2PersistToMf3(miniflare2Options.cachePersist),
857
- durableObjectsPersist: transformMf2PersistToMf3(
858
- miniflare2Options.durableObjectsPersist
859
- ),
860
- kvPersist: transformMf2PersistToMf3(miniflare2Options.kvPersist),
861
- r2Persist: transformMf2PersistToMf3(miniflare2Options.r2Persist),
862
- d1Persist: transformMf2PersistToMf3(miniflare2Options.d1Persist),
863
-
864
- inspectorPort,
865
- verbose: logger.loggerLevel === "debug",
866
- cloudflareFetch,
867
- log,
868
- };
869
-
870
- if (enablePagesAssetsServiceBinding !== undefined) {
871
- // `../miniflare-cli/assets` dynamically imports`@cloudflare/pages-shared/environment-polyfills`.
872
- // `@cloudflare/pages-shared/environment-polyfills/types.ts` defines `global`
873
- // augmentations that pollute the `import`-site's typing environment.
874
- //
875
- // We `require` instead of `import`ing here to avoid polluting the main
876
- // `wrangler` TypeScript project with the `global` augmentations. This
877
- // relies on the fact that `require` is untyped.
878
- //
879
- // eslint-disable-next-line @typescript-eslint/no-var-requires
880
- const generateASSETSBinding = require("../miniflare-cli/assets").default;
881
- options.serviceBindings = {
882
- ...options.serviceBindings,
883
- ASSETS: (await generateASSETSBinding({
884
- log,
885
- ...enablePagesAssetsServiceBinding,
886
- tre: true,
887
- // We can get rid of this `any` easily once we do experimental-local/tre by default
888
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
889
- })) as any,
890
- };
891
- }
892
-
893
- if (format === "modules") {
894
- // Manually specify all modules from the bundle. If we didn't do this,
895
- // Miniflare 3 would try collect them automatically again itself.
896
-
897
- // Resolve entrypoint relative to the temporary directory, ensuring
898
- // path doesn't start with `..`, which causes issues in `workerd`.
899
- // Also ensures other modules with relative names can be resolved.
900
- const root = path.dirname(bundle.path);
901
-
902
- assert.strictEqual(bundle.type, "esm");
903
- options = {
904
- // Creating a new options object ensures types check (Miniflare's
905
- // options type requires source code to be specified)
906
- ...options,
907
- // Required for source mapped paths to resolve correctly
908
- modulesRoot: root,
909
- modules: [
910
- // Entrypoint
911
- {
912
- type: "ESModule",
913
- path: bundle.path,
914
- contents: await readFile(bundle.path, "utf-8"),
915
- },
916
- // Misc (WebAssembly, etc, ...)
917
- ...bundle.modules.map((module) => ({
918
- type: ModuleTypeToRuleType[module.type ?? "esm"],
919
- path: path.resolve(root, module.name),
920
- contents: module.content,
921
- })),
922
- ],
923
- };
924
- }
925
-
926
- if (kvRemote) {
927
- // `kvPersist` is always assigned a truthy value in `setupMiniflareOptions`
928
- assert(options.kvPersist);
929
- const kvRemoteCache =
930
- options.kvPersist === true
931
- ? // If storing in temporary directory, find this path from the bundle
932
- // output path
933
- path.join(path.dirname(bundle.path), ".mf", "kv-remote")
934
- : // Otherwise, `kvPersist` looks like `.../kv`, so rewrite it to
935
- // `kv-remote` since the expected metadata format for remote storage
936
- // is different to local
937
- path.join(path.dirname(options.kvPersist), "kv-remote");
938
- options.kvPersist = `remote:?cache=${encodeURIComponent(kvRemoteCache)}`;
939
- }
940
-
941
- return options as Miniflare3Options;
942
- }
943
-
944
- // Caching of the `npx-import`ed `@miniflare/tre` package
945
- // eslint-disable-next-line @typescript-eslint/consistent-type-imports
946
- let miniflare3Module: typeof import("@miniflare/tre");
947
- export async function getMiniflare3(): Promise<
948
- // eslint-disable-next-line @typescript-eslint/consistent-type-imports
949
- typeof import("@miniflare/tre")
950
- > {
951
- return (miniflare3Module ??= await npxImport("@miniflare/tre@3.0.0-next.13"));
952
- }