wrangler 0.0.0-e492c10 → 0.0.0-e4ca780f

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 (360) hide show
  1. package/Cloudflare_CA.pem +18 -0
  2. package/README.md +25 -5
  3. package/bin/wrangler.js +174 -34
  4. package/kv-asset-handler.js +1 -0
  5. package/miniflare-dist/index.mjs +1590 -81
  6. package/package.json +198 -149
  7. package/src/__tests__/access.test.ts +25 -0
  8. package/src/__tests__/api-dev.test.ts +238 -0
  9. package/src/__tests__/api-devregistry.test.ts +121 -0
  10. package/src/__tests__/api.test.ts +102 -0
  11. package/src/__tests__/config-cache-without-cache-dir.test.ts +38 -0
  12. package/src/__tests__/config-cache.test.ts +30 -24
  13. package/src/__tests__/configuration.test.ts +4498 -3114
  14. package/src/__tests__/d1/d1.test.ts +82 -0
  15. package/src/__tests__/d1/execute.test.ts +66 -0
  16. package/src/__tests__/d1/migrate.test.ts +157 -0
  17. package/src/__tests__/d1/splitter.test.ts +255 -0
  18. package/src/__tests__/delete.test.ts +272 -0
  19. package/src/__tests__/deployments.test.ts +369 -0
  20. package/src/__tests__/dev.test.tsx +1592 -802
  21. package/src/__tests__/generate.test.ts +237 -0
  22. package/src/__tests__/get-host-from-url.test.ts +16 -0
  23. package/src/__tests__/guess-worker-format.test.ts +103 -68
  24. package/src/__tests__/helpers/cmd-shim.d.ts +6 -6
  25. package/src/__tests__/helpers/end-event-loop.ts +6 -0
  26. package/src/__tests__/helpers/mock-account-id.ts +24 -24
  27. package/src/__tests__/helpers/mock-auth-domain.ts +20 -0
  28. package/src/__tests__/helpers/mock-bin.ts +20 -20
  29. package/src/__tests__/helpers/mock-console.ts +64 -39
  30. package/src/__tests__/helpers/mock-dialogs.ts +104 -55
  31. package/src/__tests__/helpers/mock-get-pages-upload-token.ts +25 -0
  32. package/src/__tests__/helpers/mock-get-zone-from-host.ts +11 -0
  33. package/src/__tests__/helpers/mock-http-server.ts +30 -30
  34. package/src/__tests__/helpers/mock-istty.ts +65 -18
  35. package/src/__tests__/helpers/mock-known-routes.ts +12 -0
  36. package/src/__tests__/helpers/mock-kv.ts +41 -28
  37. package/src/__tests__/helpers/mock-oauth-flow.ts +241 -233
  38. package/src/__tests__/helpers/mock-process.ts +34 -0
  39. package/src/__tests__/helpers/mock-set-timeout.ts +16 -0
  40. package/src/__tests__/helpers/mock-stdin.ts +82 -77
  41. package/src/__tests__/helpers/mock-web-socket.ts +21 -21
  42. package/src/__tests__/helpers/msw/blob-worker.cjs +19 -0
  43. package/src/__tests__/helpers/msw/handlers/access.ts +13 -0
  44. package/src/__tests__/helpers/msw/handlers/deployments.ts +160 -0
  45. package/src/__tests__/helpers/msw/handlers/namespaces.ts +81 -0
  46. package/src/__tests__/helpers/msw/handlers/oauth.ts +31 -0
  47. package/src/__tests__/helpers/msw/handlers/r2.ts +60 -0
  48. package/src/__tests__/helpers/msw/handlers/script.ts +56 -0
  49. package/src/__tests__/helpers/msw/handlers/user.ts +52 -0
  50. package/src/__tests__/helpers/msw/handlers/zones.ts +20 -0
  51. package/src/__tests__/helpers/msw/index.ts +52 -0
  52. package/src/__tests__/helpers/msw/read-file-sync.js +61 -0
  53. package/src/__tests__/helpers/run-in-tmp.ts +27 -28
  54. package/src/__tests__/helpers/run-wrangler.ts +8 -8
  55. package/src/__tests__/helpers/string-dynamic-values-matcher.ts +28 -0
  56. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +1 -0
  57. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +5 -0
  58. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +1 -0
  59. package/src/__tests__/helpers/worker-scripts/parent-worker.js +11 -0
  60. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +5 -0
  61. package/src/__tests__/helpers/write-worker-source.ts +16 -16
  62. package/src/__tests__/helpers/write-wrangler-toml.ts +9 -9
  63. package/src/__tests__/https-options.test.ts +142 -109
  64. package/src/__tests__/index.test.ts +262 -224
  65. package/src/__tests__/init.test.ts +3168 -1488
  66. package/src/__tests__/jest.setup.ts +152 -50
  67. package/src/__tests__/kv.test.ts +1789 -1432
  68. package/src/__tests__/logger.test.ts +167 -75
  69. package/src/__tests__/logout.test.ts +47 -0
  70. package/src/__tests__/metrics.test.ts +493 -0
  71. package/src/__tests__/middleware.scheduled.test.ts +145 -0
  72. package/src/__tests__/middleware.test.ts +816 -0
  73. package/src/__tests__/mtls-certificates.test.ts +588 -0
  74. package/src/__tests__/package-manager.test.ts +312 -165
  75. package/src/__tests__/pages/deployment-list.test.ts +80 -0
  76. package/src/__tests__/pages/functions-build.test.ts +452 -0
  77. package/src/__tests__/pages/pages.test.ts +81 -0
  78. package/src/__tests__/pages/project-create.test.ts +63 -0
  79. package/src/__tests__/pages/project-list.test.ts +110 -0
  80. package/src/__tests__/pages/project-upload.test.ts +500 -0
  81. package/src/__tests__/pages/publish.test.ts +2864 -0
  82. package/src/__tests__/pages-deployment-tail.test.ts +955 -0
  83. package/src/__tests__/parse.test.ts +358 -248
  84. package/src/__tests__/paths.test.ts +39 -0
  85. package/src/__tests__/publish.test.ts +8322 -4847
  86. package/src/__tests__/pubsub.test.ts +496 -0
  87. package/src/__tests__/queues.test.ts +532 -0
  88. package/src/__tests__/r2.test.ts +369 -205
  89. package/src/__tests__/route.test.ts +18 -18
  90. package/src/__tests__/secret.test.ts +683 -436
  91. package/src/__tests__/tail.test.ts +835 -567
  92. package/src/__tests__/test-old-node-version.js +31 -0
  93. package/src/__tests__/traverse-module-graph.test.ts +220 -0
  94. package/src/__tests__/tsconfig-sanity.ts +12 -0
  95. package/src/__tests__/tsconfig.json +8 -0
  96. package/src/__tests__/tsconfig.tsbuildinfo +1 -0
  97. package/src/__tests__/type-generation.test.ts +234 -0
  98. package/src/__tests__/user.test.ts +107 -120
  99. package/src/__tests__/utils-collectKeyValues.test.ts +47 -0
  100. package/src/__tests__/validate-dev-props.test.ts +56 -0
  101. package/src/__tests__/version.test.ts +35 -0
  102. package/src/__tests__/whoami.test.tsx +165 -98
  103. package/src/__tests__/worker-namespace.test.ts +340 -0
  104. package/src/abort.d.ts +3 -0
  105. package/src/api/dev.ts +316 -0
  106. package/src/api/index.ts +11 -0
  107. package/src/api/mtls-certificate.ts +148 -0
  108. package/src/api/pages/create-worker-bundle-contents.ts +76 -0
  109. package/src/api/pages/index.ts +5 -0
  110. package/src/api/pages/publish.tsx +355 -0
  111. package/src/bundle-reporter.ts +68 -0
  112. package/src/bundle.ts +874 -135
  113. package/src/cfetch/index.ts +123 -69
  114. package/src/cfetch/internal.ts +217 -96
  115. package/src/cli.ts +23 -8
  116. package/src/config/config.ts +244 -196
  117. package/src/config/diagnostics.ts +61 -61
  118. package/src/config/environment.ts +563 -339
  119. package/src/config/index.ts +381 -41
  120. package/src/config/validation-helpers.ts +379 -357
  121. package/src/config/validation.ts +2181 -1263
  122. package/src/config-cache.ts +81 -41
  123. package/src/create-worker-preview.ts +250 -132
  124. package/src/create-worker-upload-form.ts +343 -224
  125. package/src/d1/backups.tsx +219 -0
  126. package/src/d1/constants.ts +2 -0
  127. package/src/d1/create.tsx +68 -0
  128. package/src/d1/delete.ts +53 -0
  129. package/src/d1/execute.tsx +357 -0
  130. package/src/d1/formatTimeAgo.ts +14 -0
  131. package/src/d1/index.ts +100 -0
  132. package/src/d1/list.tsx +60 -0
  133. package/src/d1/migrations/apply.tsx +212 -0
  134. package/src/d1/migrations/create.tsx +79 -0
  135. package/src/d1/migrations/helpers.ts +172 -0
  136. package/src/d1/migrations/index.ts +3 -0
  137. package/src/d1/migrations/list.tsx +95 -0
  138. package/src/d1/migrations/options.ts +23 -0
  139. package/src/d1/options.ts +22 -0
  140. package/src/d1/splitter.ts +161 -0
  141. package/src/d1/types.ts +25 -0
  142. package/src/d1/utils.ts +49 -0
  143. package/src/delete.ts +100 -0
  144. package/src/deployments.ts +368 -0
  145. package/src/deprecated/index.ts +144 -0
  146. package/src/dev/dev-vars.ts +20 -17
  147. package/src/dev/dev.tsx +535 -353
  148. package/src/dev/get-local-persistence-path.ts +31 -0
  149. package/src/dev/local.tsx +900 -292
  150. package/src/dev/remote.tsx +620 -201
  151. package/src/dev/start-server.ts +534 -0
  152. package/src/dev/use-esbuild.ts +182 -97
  153. package/src/dev/validate-dev-props.ts +40 -0
  154. package/src/dev-registry.ts +202 -0
  155. package/src/dev.tsx +929 -0
  156. package/src/dialogs.ts +136 -0
  157. package/src/dispatch-namespace.ts +211 -0
  158. package/src/docs/index.ts +97 -0
  159. package/src/durable.ts +102 -0
  160. package/src/entry.ts +259 -189
  161. package/src/environment-variables/factory.ts +88 -0
  162. package/src/environment-variables/misc-variables.ts +30 -0
  163. package/src/errors.ts +6 -6
  164. package/src/generate/index.ts +298 -0
  165. package/src/git-client.ts +135 -0
  166. package/src/global-wrangler-config-path.ts +26 -0
  167. package/src/https-options.ts +84 -80
  168. package/src/index.ts +758 -0
  169. package/src/init.ts +1032 -0
  170. package/src/inspect.ts +721 -562
  171. package/src/intl-polyfill.d.ts +123 -123
  172. package/src/is-ci.ts +14 -0
  173. package/src/is-interactive.ts +16 -0
  174. package/src/jest.d.ts +4 -0
  175. package/src/kv/helpers.ts +430 -0
  176. package/src/kv/index.ts +594 -0
  177. package/src/logger.ts +96 -43
  178. package/src/metrics/index.ts +5 -0
  179. package/src/metrics/metrics-config.ts +239 -0
  180. package/src/metrics/metrics-dispatcher.ts +96 -0
  181. package/src/metrics/metrics-usage-headers.ts +24 -0
  182. package/src/metrics/send-event.ts +99 -0
  183. package/src/miniflare-cli/assets.ts +251 -0
  184. package/src/miniflare-cli/index.ts +202 -33
  185. package/src/miniflare-cli/request-context.ts +18 -18
  186. package/src/miniflare-cli/tsconfig.json +9 -0
  187. package/src/miniflare-cli/tsconfig.tsbuildinfo +1 -0
  188. package/src/miniflare-cli/types.ts +11 -0
  189. package/src/module-collection.ts +290 -215
  190. package/src/mtls-certificate/cli.ts +155 -0
  191. package/src/open-in-browser.ts +5 -14
  192. package/src/package-manager.ts +182 -90
  193. package/src/pages/build.ts +410 -0
  194. package/src/pages/buildFunctions.ts +140 -0
  195. package/src/pages/constants.ts +18 -0
  196. package/src/pages/deployment-tails.ts +281 -0
  197. package/src/pages/deployments.tsx +84 -0
  198. package/src/pages/dev.ts +716 -0
  199. package/src/pages/errors.ts +67 -0
  200. package/src/pages/functions/buildPlugin.ts +113 -0
  201. package/src/pages/functions/buildWorker.ts +291 -0
  202. package/{pages → src/pages}/functions/filepath-routing.test.ts +113 -113
  203. package/src/pages/functions/filepath-routing.ts +189 -0
  204. package/src/pages/functions/identifiers.ts +78 -0
  205. package/src/pages/functions/routes-consolidation.test.ts +250 -0
  206. package/src/pages/functions/routes-consolidation.ts +73 -0
  207. package/src/pages/functions/routes-transformation.test.ts +282 -0
  208. package/src/pages/functions/routes-transformation.ts +115 -0
  209. package/src/pages/functions/routes-validation.test.ts +403 -0
  210. package/src/pages/functions/routes-validation.ts +202 -0
  211. package/src/pages/functions/routes.ts +151 -0
  212. package/src/pages/functions/tsconfig.json +8 -0
  213. package/src/pages/functions/tsconfig.tsbuildinfo +1 -0
  214. package/src/pages/functions.ts +86 -0
  215. package/src/pages/hash.ts +13 -0
  216. package/src/pages/index.ts +102 -0
  217. package/src/pages/projects.tsx +159 -0
  218. package/src/pages/prompt-select-project.tsx +31 -0
  219. package/src/pages/publish.tsx +267 -0
  220. package/src/pages/types.ts +46 -0
  221. package/src/pages/upload.tsx +469 -0
  222. package/src/pages/utils.ts +23 -0
  223. package/src/parse.ts +246 -123
  224. package/src/paths.ts +53 -8
  225. package/src/proxy.ts +628 -383
  226. package/src/publish/index.ts +274 -0
  227. package/src/publish/publish.ts +1060 -0
  228. package/src/pubsub/index.ts +286 -0
  229. package/src/pubsub/pubsub-commands.ts +623 -0
  230. package/src/queues/cli/commands/consumer/add.ts +71 -0
  231. package/src/queues/cli/commands/consumer/index.ts +19 -0
  232. package/src/queues/cli/commands/consumer/remove.ts +31 -0
  233. package/src/queues/cli/commands/create.ts +25 -0
  234. package/src/queues/cli/commands/delete.ts +26 -0
  235. package/src/queues/cli/commands/index.ts +35 -0
  236. package/src/queues/cli/commands/list.ts +25 -0
  237. package/src/queues/client.ts +136 -0
  238. package/src/queues/utils.ts +18 -0
  239. package/src/r2/constants.ts +4 -0
  240. package/src/r2/helpers.ts +132 -0
  241. package/src/r2/index.ts +289 -0
  242. package/src/routes.ts +140 -0
  243. package/src/secret/index.ts +376 -0
  244. package/src/selfsigned.d.ts +23 -23
  245. package/src/sites.ts +372 -0
  246. package/src/tail/createTail.ts +406 -0
  247. package/src/tail/filters.ts +109 -111
  248. package/src/tail/index.ts +208 -296
  249. package/src/tail/printing.ts +101 -46
  250. package/src/traverse-module-graph.ts +53 -0
  251. package/src/tsconfig-sanity.ts +16 -0
  252. package/src/type-generation.ts +181 -0
  253. package/src/update-check.ts +11 -11
  254. package/src/user/access.ts +68 -0
  255. package/src/user/auth-variables.ts +113 -0
  256. package/src/user/choose-account.tsx +39 -0
  257. package/src/user/generate-auth-url.ts +33 -0
  258. package/src/user/generate-random-state.ts +16 -0
  259. package/src/user/index.ts +2 -0
  260. package/src/user/user.ts +1233 -0
  261. package/src/utils/collectKeyValues.ts +14 -0
  262. package/src/utils/render.ts +93 -0
  263. package/src/whoami.ts +135 -0
  264. package/src/worker.ts +203 -101
  265. package/src/yargs-types.ts +37 -0
  266. package/src/zones.ts +191 -0
  267. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  268. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  269. package/templates/__tests__/tsconfig.json +8 -0
  270. package/templates/__tests__/tsconfig.tsbuildinfo +1 -0
  271. package/templates/checked-fetch.js +23 -0
  272. package/templates/d1-beta-facade.js +244 -0
  273. package/templates/facade.d.ts +14 -0
  274. package/templates/first-party-worker-module-facade.ts +19 -0
  275. package/templates/format-dev-errors.ts +34 -0
  276. package/templates/gitignore +1 -0
  277. package/templates/init-tests/test-jest-new-worker.js +23 -0
  278. package/templates/init-tests/test-vitest-new-worker.js +24 -0
  279. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  280. package/templates/middleware/common.ts +62 -0
  281. package/templates/middleware/loader-modules.ts +84 -0
  282. package/templates/middleware/loader-sw.ts +233 -0
  283. package/templates/middleware/middleware-miniflare3-json-error.ts +32 -0
  284. package/templates/middleware/middleware-pretty-error.ts +40 -0
  285. package/templates/middleware/middleware-scheduled.ts +15 -0
  286. package/templates/new-worker-scheduled.js +17 -0
  287. package/templates/new-worker-scheduled.ts +32 -0
  288. package/templates/new-worker.js +3 -3
  289. package/templates/new-worker.ts +21 -3
  290. package/templates/no-op-worker.js +10 -0
  291. package/templates/pages-dev-pipeline.ts +31 -0
  292. package/templates/pages-dev-util.ts +52 -0
  293. package/templates/pages-shim.ts +12 -0
  294. package/templates/pages-template-plugin.ts +180 -0
  295. package/templates/pages-template-worker.ts +189 -0
  296. package/templates/serve-static-assets.ts +66 -0
  297. package/templates/service-bindings-module-facade.js +55 -0
  298. package/templates/service-bindings-sw-facade.js +42 -0
  299. package/templates/tsconfig-sanity.ts +11 -0
  300. package/templates/tsconfig.init.json +105 -0
  301. package/templates/tsconfig.json +6 -103
  302. package/templates/tsconfig.tsbuildinfo +1 -0
  303. package/wrangler-dist/cli.d.ts +1641 -0
  304. package/wrangler-dist/cli.js +129145 -89350
  305. package/wrangler-dist/wasm-sync.wasm +0 -0
  306. package/pages/functions/buildPlugin.ts +0 -92
  307. package/pages/functions/buildWorker.ts +0 -138
  308. package/pages/functions/filepath-routing.ts +0 -189
  309. package/pages/functions/identifiers.ts +0 -78
  310. package/pages/functions/routes.ts +0 -156
  311. package/pages/functions/template-plugin.ts +0 -146
  312. package/pages/functions/template-worker.ts +0 -143
  313. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  314. package/src/__tests__/helpers/mock-cfetch.ts +0 -211
  315. package/src/__tests__/pages.test.ts +0 -327
  316. package/src/dialogs.tsx +0 -87
  317. package/src/environment-variables.ts +0 -35
  318. package/src/index.tsx +0 -2698
  319. package/src/kv.ts +0 -319
  320. package/src/miniflare-cli/enum-keys.ts +0 -17
  321. package/src/pages.tsx +0 -1875
  322. package/src/publish.ts +0 -469
  323. package/src/r2.ts +0 -50
  324. package/src/sites.tsx +0 -293
  325. package/src/user.tsx +0 -1203
  326. package/src/whoami.tsx +0 -70
  327. package/templates/static-asset-facade.js +0 -47
  328. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  329. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  330. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  331. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  332. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  333. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  334. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  335. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  336. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  337. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  338. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  339. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  340. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  341. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  342. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  343. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  344. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  345. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  346. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  347. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  348. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  349. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  350. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  351. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  352. package/vendor/wrangler-mime/LICENSE +0 -21
  353. package/vendor/wrangler-mime/Mime.js +0 -97
  354. package/vendor/wrangler-mime/README.md +0 -187
  355. package/vendor/wrangler-mime/cli.js +0 -46
  356. package/vendor/wrangler-mime/index.js +0 -4
  357. package/vendor/wrangler-mime/lite.js +0 -4
  358. package/vendor/wrangler-mime/package.json +0 -52
  359. package/vendor/wrangler-mime/types/other.js +0 -1
  360. package/vendor/wrangler-mime/types/standard.js +0 -1
@@ -1,22 +1,22 @@
1
1
  import { URLSearchParams } from "node:url";
2
+ import { logger } from "../logger";
2
3
  import { ParseError } from "../parse";
3
- import { fetchInternal } from "./internal";
4
+ import { fetchInternal, performApiFetch } from "./internal";
4
5
  import type { RequestInit } from "undici";
5
6
 
6
7
  // Check out https://api.cloudflare.com/ for API docs.
7
8
 
8
- export { getCloudflareAPIBaseURL as getCloudflareApiBaseUrl } from "./internal";
9
-
10
9
  export interface FetchError {
11
- code: number;
12
- message: string;
10
+ code: number;
11
+ message: string;
12
+ error_chain?: FetchError[];
13
13
  }
14
14
  export interface FetchResult<ResponseType = unknown> {
15
- success: boolean;
16
- result: ResponseType;
17
- errors: FetchError[];
18
- messages: string[];
19
- result_info?: unknown;
15
+ success: boolean;
16
+ result: ResponseType;
17
+ errors: FetchError[];
18
+ messages: string[];
19
+ result_info?: unknown;
20
20
  }
21
21
 
22
22
  export { fetchKVGetValue } from "./internal";
@@ -25,20 +25,22 @@ export { fetchKVGetValue } from "./internal";
25
25
  * Make a fetch request, and extract the `result` from the JSON response.
26
26
  */
27
27
  export async function fetchResult<ResponseType>(
28
- resource: string,
29
- init: RequestInit = {},
30
- queryParams?: URLSearchParams
28
+ resource: string,
29
+ init: RequestInit = {},
30
+ queryParams?: URLSearchParams,
31
+ abortSignal?: AbortSignal
31
32
  ): Promise<ResponseType> {
32
- const json = await fetchInternal<FetchResult<ResponseType>>(
33
- resource,
34
- init,
35
- queryParams
36
- );
37
- if (json.success) {
38
- return json.result;
39
- } else {
40
- throwFetchError(resource, json);
41
- }
33
+ const json = await fetchInternal<FetchResult<ResponseType>>(
34
+ resource,
35
+ init,
36
+ queryParams,
37
+ abortSignal
38
+ );
39
+ if (json.success) {
40
+ return json.result;
41
+ } else {
42
+ throwFetchError(resource, json);
43
+ }
42
44
  }
43
45
 
44
46
  /**
@@ -47,58 +49,110 @@ export async function fetchResult<ResponseType>(
47
49
  * and repeating the request if the results are paginated.
48
50
  */
49
51
  export async function fetchListResult<ResponseType>(
50
- resource: string,
51
- init: RequestInit = {},
52
- queryParams?: URLSearchParams
52
+ resource: string,
53
+ init: RequestInit = {},
54
+ queryParams?: URLSearchParams
53
55
  ): Promise<ResponseType[]> {
54
- const results: ResponseType[] = [];
55
- let getMoreResults = true;
56
- let cursor: string | undefined;
57
- while (getMoreResults) {
58
- if (cursor) {
59
- queryParams = new URLSearchParams(queryParams);
60
- queryParams.set("cursor", cursor);
61
- }
62
- const json = await fetchInternal<FetchResult<ResponseType[]>>(
63
- resource,
64
- init,
65
- queryParams
66
- );
67
- if (json.success) {
68
- results.push(...json.result);
69
- if (hasCursor(json.result_info)) {
70
- cursor = json.result_info?.cursor;
71
- } else {
72
- getMoreResults = false;
73
- }
74
- } else {
75
- throwFetchError(resource, json);
76
- }
77
- }
78
- return results;
56
+ const results: ResponseType[] = [];
57
+ let getMoreResults = true;
58
+ let cursor: string | undefined;
59
+ while (getMoreResults) {
60
+ if (cursor) {
61
+ queryParams = new URLSearchParams(queryParams);
62
+ queryParams.set("cursor", cursor);
63
+ }
64
+ const json = await fetchInternal<FetchResult<ResponseType[]>>(
65
+ resource,
66
+ init,
67
+ queryParams
68
+ );
69
+ if (json.success) {
70
+ results.push(...json.result);
71
+ if (hasCursor(json.result_info)) {
72
+ cursor = json.result_info?.cursor;
73
+ } else {
74
+ getMoreResults = false;
75
+ }
76
+ } else {
77
+ throwFetchError(resource, json);
78
+ }
79
+ }
80
+ return results;
79
81
  }
80
82
 
81
83
  function throwFetchError(
82
- resource: string,
83
- response: FetchResult<unknown>
84
+ resource: string,
85
+ response: FetchResult<unknown>
84
86
  ): never {
85
- const error = new ParseError({
86
- text: "Received a bad response from the API",
87
- notes: response.errors.map((err) => ({
88
- text: err.code ? `${err.message} [code: ${err.code}]` : err.message,
89
- })),
90
- });
91
- // add the first error code directly to this error
92
- // so consumers can use it for specific behaviour
93
- const code = response.errors[0]?.code;
94
- if (code) {
95
- //@ts-expect-error non-standard property on Error
96
- error.code = code;
97
- }
98
- throw error;
87
+ const error = new ParseError({
88
+ text: `A request to the Cloudflare API (${resource}) failed.`,
89
+ notes: response.errors.map((err) => ({
90
+ text: renderError(err),
91
+ })),
92
+ });
93
+ // add the first error code directly to this error
94
+ // so consumers can use it for specific behaviour
95
+ const code = response.errors[0]?.code;
96
+ if (code) {
97
+ //@ts-expect-error non-standard property on Error
98
+ error.code = code;
99
+ }
100
+ throw error;
99
101
  }
100
102
 
101
103
  function hasCursor(result_info: unknown): result_info is { cursor: string } {
102
- const cursor = (result_info as { cursor: string } | undefined)?.cursor;
103
- return cursor !== undefined && cursor !== null && cursor !== "";
104
+ const cursor = (result_info as { cursor: string } | undefined)?.cursor;
105
+ return cursor !== undefined && cursor !== null && cursor !== "";
106
+ }
107
+
108
+ function renderError(err: FetchError, level = 0): string {
109
+ const chainedMessages =
110
+ err.error_chain
111
+ ?.map(
112
+ (chainedError) =>
113
+ `\n${" ".repeat(level)}- ${renderError(chainedError, level + 1)}`
114
+ )
115
+ .join("\n") ?? "";
116
+ return (
117
+ (err.code ? `${err.message} [code: ${err.code}]` : err.message) +
118
+ chainedMessages
119
+ );
120
+ }
121
+
122
+ /**
123
+ * Fetch the raw script content of a Worker
124
+ * Note, this will concatenate the files of multi-module workers
125
+ */
126
+ export async function fetchScriptContent(
127
+ resource: string,
128
+ init: RequestInit = {},
129
+ queryParams?: URLSearchParams,
130
+ abortSignal?: AbortSignal
131
+ ): Promise<string> {
132
+ const response = await performApiFetch(
133
+ resource,
134
+ init,
135
+ queryParams,
136
+ abortSignal
137
+ );
138
+
139
+ logger.debug(
140
+ "-- START CF API RESPONSE:",
141
+ response.statusText,
142
+ response.status
143
+ );
144
+
145
+ logger.debug("HEADERS:", { ...response.headers });
146
+ // logger.debug("RESPONSE:", text);
147
+ logger.debug("-- END CF API RESPONSE");
148
+ const contentType = response.headers.get("content-type");
149
+
150
+ const usesModules = contentType?.startsWith("multipart");
151
+ if (usesModules && contentType) {
152
+ const form = await response.formData();
153
+ const entries = Array.from(form.entries());
154
+ return entries.map((e) => e[1]).join("\n");
155
+ } else {
156
+ return await response.text();
157
+ }
104
158
  }
@@ -1,18 +1,55 @@
1
- import { fetch, Headers } from "undici";
2
- import { getEnvironmentVariableFactory } from "../environment-variables";
1
+ import assert from "node:assert";
2
+ import { fetch, File, Headers } from "undici";
3
+ import { version as wranglerVersion } from "../../package.json";
4
+ import { getCloudflareApiBaseUrl } from "../environment-variables/misc-variables";
5
+ import { logger } from "../logger";
3
6
  import { ParseError, parseJSON } from "../parse";
4
- import { getAPIToken, loginOrRefreshIfRequired } from "../user";
7
+ import { loginOrRefreshIfRequired, requireApiToken } from "../user";
8
+ import type { ApiCredentials } from "../user";
5
9
  import type { URLSearchParams } from "node:url";
6
- import type { RequestInit, HeadersInit } from "undici";
10
+ import type { RequestInit, HeadersInit, Response } from "undici";
7
11
 
8
- /**
9
- * Get the URL to use to access the Cloudflare API.
10
- */
11
- export const getCloudflareAPIBaseURL = getEnvironmentVariableFactory({
12
- variableName: "CLOUDFLARE_API_BASE_URL",
13
- deprecatedName: "CF_API_BASE_URL",
14
- defaultValue: "https://api.cloudflare.com/client/v4",
15
- });
12
+ /*
13
+ * performApiFetch does everything required to make a CF API request,
14
+ * but doesn't parse the response as JSON. For normal V4 API responses,
15
+ * use `fetchInternal`
16
+ * */
17
+ export async function performApiFetch(
18
+ resource: string,
19
+ init: RequestInit = {},
20
+ queryParams?: URLSearchParams,
21
+ abortSignal?: AbortSignal
22
+ ) {
23
+ const method = init.method ?? "GET";
24
+ assert(
25
+ resource.startsWith("/"),
26
+ `CF API fetch - resource path must start with a "/" but got "${resource}"`
27
+ );
28
+ await requireLoggedIn();
29
+ const apiToken = requireApiToken();
30
+ const headers = cloneHeaders(init.headers);
31
+ addAuthorizationHeaderIfUnspecified(headers, apiToken);
32
+ addUserAgent(headers);
33
+
34
+ const queryString = queryParams ? `?${queryParams.toString()}` : "";
35
+ logger.debug(
36
+ `-- START CF API REQUEST: ${method} ${getCloudflareApiBaseUrl()}${resource}${queryString}`
37
+ );
38
+ const logHeaders = cloneHeaders(headers);
39
+ delete logHeaders["Authorization"];
40
+ logger.debug("HEADERS:", JSON.stringify(logHeaders, null, 2));
41
+ logger.debug(
42
+ "INIT:",
43
+ JSON.stringify({ ...init, headers: logHeaders }, null, 2)
44
+ );
45
+ logger.debug("-- END CF API REQUEST");
46
+ return await fetch(`${getCloudflareApiBaseUrl()}${resource}${queryString}`, {
47
+ method,
48
+ ...init,
49
+ headers,
50
+ signal: abortSignal,
51
+ });
52
+ }
16
53
 
17
54
  /**
18
55
  * Make a fetch request to the Cloudflare API.
@@ -24,86 +61,88 @@ export const getCloudflareAPIBaseURL = getEnvironmentVariableFactory({
24
61
  * This function should not be used directly, instead use the functions in `cfetch/index.ts`.
25
62
  */
26
63
  export async function fetchInternal<ResponseType>(
27
- resource: string,
28
- init: RequestInit = {},
29
- queryParams?: URLSearchParams
64
+ resource: string,
65
+ init: RequestInit = {},
66
+ queryParams?: URLSearchParams,
67
+ abortSignal?: AbortSignal
30
68
  ): Promise<ResponseType> {
31
- await requireLoggedIn();
32
- const apiToken = requireApiToken();
33
- const headers = cloneHeaders(init.headers);
34
- addAuthorizationHeader(headers, apiToken);
35
-
36
- const queryString = queryParams ? `?${queryParams.toString()}` : "";
37
- const method = init.method ?? "GET";
38
- const response = await fetch(
39
- `${getCloudflareAPIBaseURL()}${resource}${queryString}`,
40
- {
41
- method,
42
- ...init,
43
- headers,
44
- }
45
- );
46
- const jsonText = await response.text();
47
- try {
48
- return parseJSON(jsonText) as ResponseType;
49
- } catch (err) {
50
- throw new ParseError({
51
- text: "Received a malformed response from the API",
52
- notes: [
53
- {
54
- text: truncate(jsonText, 100),
55
- },
56
- {
57
- text: `${method} ${resource} -> ${response.status} ${response.statusText}`,
58
- },
59
- ],
60
- });
61
- }
69
+ const method = init.method ?? "GET";
70
+ const response = await performApiFetch(
71
+ resource,
72
+ init,
73
+ queryParams,
74
+ abortSignal
75
+ );
76
+ const jsonText = await response.text();
77
+ logger.debug(
78
+ "-- START CF API RESPONSE:",
79
+ response.statusText,
80
+ response.status
81
+ );
82
+ const logHeaders = cloneHeaders(response.headers);
83
+ delete logHeaders["Authorization"];
84
+ logger.debug("HEADERS:", JSON.stringify(logHeaders, null, 2));
85
+ logger.debug("RESPONSE:", jsonText);
86
+ logger.debug("-- END CF API RESPONSE");
87
+
88
+ try {
89
+ return parseJSON<ResponseType>(jsonText);
90
+ } catch (err) {
91
+ throw new ParseError({
92
+ text: "Received a malformed response from the API",
93
+ notes: [
94
+ {
95
+ text: truncate(jsonText, 100),
96
+ },
97
+ {
98
+ text: `${method} ${resource} -> ${response.status} ${response.statusText}`,
99
+ },
100
+ ],
101
+ });
102
+ }
62
103
  }
63
104
 
64
105
  function truncate(text: string, maxLength: number): string {
65
- const { length } = text;
66
- if (length <= maxLength) {
67
- return text;
68
- }
69
- return `${text.substring(0, maxLength)}... (length = ${length})`;
106
+ const { length } = text;
107
+ if (length <= maxLength) {
108
+ return text;
109
+ }
110
+ return `${text.substring(0, maxLength)}... (length = ${length})`;
70
111
  }
71
112
 
72
113
  function cloneHeaders(
73
- headers: HeadersInit | undefined
114
+ headers: HeadersInit | undefined
74
115
  ): Record<string, string> {
75
- return headers instanceof Headers
76
- ? Object.fromEntries(headers.entries())
77
- : Array.isArray(headers)
78
- ? Object.fromEntries(headers)
79
- : { ...headers };
116
+ return headers instanceof Headers
117
+ ? Object.fromEntries(headers.entries())
118
+ : Array.isArray(headers)
119
+ ? Object.fromEntries(headers)
120
+ : { ...headers };
80
121
  }
81
122
 
82
123
  async function requireLoggedIn(): Promise<void> {
83
- const loggedIn = await loginOrRefreshIfRequired();
84
- if (!loggedIn) {
85
- throw new Error("Not logged in.");
86
- }
124
+ const loggedIn = await loginOrRefreshIfRequired();
125
+ if (!loggedIn) {
126
+ throw new Error("Not logged in.");
127
+ }
87
128
  }
88
129
 
89
- function requireApiToken(): string {
90
- const authToken = getAPIToken();
91
- if (!authToken) {
92
- throw new Error("No API token found.");
93
- }
94
- return authToken;
130
+ function addAuthorizationHeaderIfUnspecified(
131
+ headers: Record<string, string>,
132
+ auth: ApiCredentials
133
+ ): void {
134
+ if (!("Authorization" in headers)) {
135
+ if ("apiToken" in auth) {
136
+ headers["Authorization"] = `Bearer ${auth.apiToken}`;
137
+ } else {
138
+ headers["X-Auth-Key"] = auth.authKey;
139
+ headers["X-Auth-Email"] = auth.authEmail;
140
+ }
141
+ }
95
142
  }
96
143
 
97
- function addAuthorizationHeader(
98
- headers: Record<string, string>,
99
- apiToken: string
100
- ): void {
101
- if ("Authorization" in headers) {
102
- throw new Error(
103
- "The request already specifies an authorisation header - cannot add a new one."
104
- );
105
- }
106
- headers["Authorization"] = `Bearer ${apiToken}`;
144
+ function addUserAgent(headers: Record<string, string>): void {
145
+ headers["User-Agent"] = `wrangler/${wranglerVersion}`;
107
146
  }
108
147
 
109
148
  /**
@@ -112,26 +151,108 @@ function addAuthorizationHeader(
112
151
  * doesn't return json. We inline the implementation and try not to share
113
152
  * any code with the other calls. We should push back on any new APIs that
114
153
  * try to introduce non-"standard" response structures.
154
+ *
155
+ * Note: any calls to fetchKVGetValue must call encodeURIComponent on key
156
+ * before passing it
115
157
  */
116
-
117
158
  export async function fetchKVGetValue(
118
- accountId: string,
119
- namespaceId: string,
120
- key: string
159
+ accountId: string,
160
+ namespaceId: string,
161
+ key: string
162
+ ): Promise<ArrayBuffer> {
163
+ await requireLoggedIn();
164
+ const auth = requireApiToken();
165
+ const headers: Record<string, string> = {};
166
+ addAuthorizationHeaderIfUnspecified(headers, auth);
167
+ const resource = `${getCloudflareApiBaseUrl()}/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/values/${key}`;
168
+ const response = await fetch(resource, {
169
+ method: "GET",
170
+ headers,
171
+ });
172
+ if (response.ok) {
173
+ return await response.arrayBuffer();
174
+ } else {
175
+ throw new Error(
176
+ `Failed to fetch ${resource} - ${response.status}: ${response.statusText});`
177
+ );
178
+ }
179
+ }
180
+
181
+ /**
182
+ * The implementation for fetching a R2 object from Cloudflare API.
183
+ * We have a special implementation to handle the non-standard API response
184
+ * that doesn't return JSON, likely due to the streaming nature.
185
+ *
186
+ * note: The implementation should be called from light wrappers for
187
+ * different methods (GET, PUT)
188
+ */
189
+ type ResponseWithBody = Response & { body: NonNullable<Response["body"]> };
190
+ export async function fetchR2Objects(
191
+ resource: string,
192
+ bodyInit: RequestInit = {}
193
+ ): Promise<ResponseWithBody> {
194
+ await requireLoggedIn();
195
+ const auth = requireApiToken();
196
+ const headers = cloneHeaders(bodyInit.headers);
197
+ addAuthorizationHeaderIfUnspecified(headers, auth);
198
+ addUserAgent(headers);
199
+
200
+ const response = await fetch(`${getCloudflareApiBaseUrl()}${resource}`, {
201
+ ...bodyInit,
202
+ headers,
203
+ });
204
+
205
+ if (response.ok && response.body) {
206
+ return response as ResponseWithBody;
207
+ } else {
208
+ throw new Error(
209
+ `Failed to fetch ${resource} - ${response.status}: ${response.statusText});`
210
+ );
211
+ }
212
+ }
213
+
214
+ /**
215
+ * This is a wrapper STOPGAP for getting the script which returns a raw text response.
216
+ */
217
+ export async function fetchDashboardScript(
218
+ resource: string,
219
+ bodyInit: RequestInit = {}
121
220
  ): Promise<string> {
122
- await requireLoggedIn();
123
- const apiToken = requireApiToken();
124
- const headers = { Authorization: `Bearer ${apiToken}` };
125
- const resource = `${getCloudflareAPIBaseURL()}/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/values/${key}`;
126
- const response = await fetch(resource, {
127
- method: "GET",
128
- headers,
129
- });
130
- if (response.ok) {
131
- return await response.text();
132
- } else {
133
- throw new Error(
134
- `Failed to fetch ${resource} - ${response.status}: ${response.statusText});`
135
- );
136
- }
221
+ await requireLoggedIn();
222
+ const auth = requireApiToken();
223
+ const headers = cloneHeaders(bodyInit.headers);
224
+ addAuthorizationHeaderIfUnspecified(headers, auth);
225
+ addUserAgent(headers);
226
+
227
+ const response = await fetch(`${getCloudflareApiBaseUrl()}${resource}`, {
228
+ ...bodyInit,
229
+ headers,
230
+ });
231
+
232
+ if (!response.ok || !response.body) {
233
+ throw new Error(
234
+ `Failed to fetch ${resource} - ${response.status}: ${response.statusText});`
235
+ );
236
+ }
237
+
238
+ const usesModules = response.headers
239
+ .get("content-type")
240
+ ?.startsWith("multipart");
241
+
242
+ if (usesModules) {
243
+ // Response from edge contains generic "name = worker.js" for dashboard created scripts
244
+ const form = await response.formData();
245
+ const entries = Array.from(form.entries());
246
+ if (entries.length > 1)
247
+ throw new RangeError("Expected only one entry in multipart response");
248
+ const [_, file] = entries[0];
249
+
250
+ if (file instanceof File) {
251
+ return await file.text();
252
+ }
253
+
254
+ return file ?? "";
255
+ } else {
256
+ return response.text();
257
+ }
137
258
  }
package/src/cli.ts CHANGED
@@ -1,13 +1,28 @@
1
- import "dotenv/config"; // Grab locally specified env params from a `.env` file.
2
1
  import process from "process";
3
2
  import { hideBin } from "yargs/helpers";
3
+ import { unstable_dev, unstable_pages } from "./api";
4
4
  import { FatalError } from "./errors";
5
5
  import { main } from ".";
6
6
 
7
- main(hideBin(process.argv)).catch((e) => {
8
- // The logging of any error that was thrown from `main()` is handled in the `yargs.fail()` handler.
9
- // Here we just want to ensure that the process exits with a non-zero code.
10
- // We don't want to do this inside the `main()` function, since that would kill the process when running our tests.
11
- const exitCode = (e instanceof FatalError && e.code) || 1;
12
- process.exit(exitCode);
13
- });
7
+ import type { UnstableDevWorker, UnstableDevOptions } from "./api";
8
+ /**
9
+ * The main entrypoint for the CLI.
10
+ * main only gets called when the script is run directly, not when it's imported as a module.
11
+ */
12
+ if (typeof jest === "undefined" && require.main === module) {
13
+ main(hideBin(process.argv)).catch((e) => {
14
+ // The logging of any error that was thrown from `main()` is handled in the `yargs.fail()` handler.
15
+ // Here we just want to ensure that the process exits with a non-zero code.
16
+ // We don't want to do this inside the `main()` function, since that would kill the process when running our tests.
17
+ const exitCode = (e instanceof FatalError && e.code) || 1;
18
+ process.exit(exitCode);
19
+ });
20
+ }
21
+
22
+ /**
23
+ * This is how we're exporting the API.
24
+ * It makes it possible to import wrangler from 'wrangler',
25
+ * and call wrangler.unstable_dev().
26
+ */
27
+ export { unstable_dev, unstable_pages };
28
+ export type { UnstableDevWorker, UnstableDevOptions };