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
@@ -0,0 +1,493 @@
1
+ import { mkdirSync } from "node:fs";
2
+ import { rest } from "msw";
3
+ import { version as wranglerVersion } from "../../package.json";
4
+ import { purgeConfigCaches, saveToConfigCache } from "../config-cache";
5
+ import { CI } from "../is-ci";
6
+ import { logger } from "../logger";
7
+ import { getMetricsDispatcher, getMetricsConfig } from "../metrics";
8
+ import {
9
+ CURRENT_METRICS_DATE,
10
+ readMetricsConfig,
11
+ USER_ID_CACHE_PATH,
12
+ writeMetricsConfig,
13
+ } from "../metrics/metrics-config";
14
+ import { writeAuthConfigFile } from "../user";
15
+ import { mockConsoleMethods } from "./helpers/mock-console";
16
+ import { mockConfirm, clearDialogs } from "./helpers/mock-dialogs";
17
+ import { useMockIsTTY } from "./helpers/mock-istty";
18
+ import { msw, mswSuccessOauthHandlers } from "./helpers/msw";
19
+ import { runInTempDir } from "./helpers/run-in-tmp";
20
+
21
+ declare const global: { SPARROW_SOURCE_KEY: string | undefined };
22
+
23
+ describe("metrics", () => {
24
+ const ORIGINAL_SPARROW_SOURCE_KEY = global.SPARROW_SOURCE_KEY;
25
+ const std = mockConsoleMethods();
26
+ runInTempDir();
27
+
28
+ beforeEach(() => {
29
+ // Tell jest to use the original version of the `getMetricsConfig()` function in these tests.
30
+ const mockMetricsConfig = jest.requireMock("../metrics/metrics-config");
31
+ mockMetricsConfig.useOriginal = true;
32
+ global.SPARROW_SOURCE_KEY = "MOCK_KEY";
33
+ logger.loggerLevel = "debug";
34
+ // Create a node_modules directory to store config-cache files
35
+ mkdirSync("node_modules");
36
+ });
37
+ afterEach(() => {
38
+ global.SPARROW_SOURCE_KEY = ORIGINAL_SPARROW_SOURCE_KEY;
39
+ purgeConfigCaches();
40
+ clearDialogs();
41
+ });
42
+
43
+ describe("getMetricsDispatcher()", () => {
44
+ const MOCK_DISPATCHER_OPTIONS = {
45
+ // By setting this to true we avoid the `getMetricsConfig()` logic in these tests.
46
+ sendMetrics: true,
47
+ offline: false,
48
+ };
49
+
50
+ // These tests should never hit the `/user` API endpoint.
51
+ const userRequests = mockUserRequest();
52
+ afterEach(() => {
53
+ expect(userRequests.count).toBe(0);
54
+ });
55
+
56
+ describe("identify()", () => {
57
+ it("should send a request to the default URL", async () => {
58
+ const request = mockMetricRequest(
59
+ {
60
+ event: "identify",
61
+ properties: {
62
+ category: "Workers",
63
+ wranglerVersion,
64
+ os: process.platform + ":" + process.arch,
65
+ a: 1,
66
+ b: 2,
67
+ },
68
+ },
69
+ { "Sparrow-Source-Key": "MOCK_KEY" },
70
+ "identify"
71
+ );
72
+ const dispatcher = await getMetricsDispatcher(MOCK_DISPATCHER_OPTIONS);
73
+ await dispatcher.identify({ a: 1, b: 2 });
74
+
75
+ expect(request.count).toBe(1);
76
+ expect(std.debug).toMatchInlineSnapshot(
77
+ `"Metrics dispatcher: Posting data {\\"type\\":\\"identify\\",\\"name\\":\\"identify\\",\\"properties\\":{\\"a\\":1,\\"b\\":2}}"`
78
+ );
79
+ expect(std.out).toMatchInlineSnapshot(`""`);
80
+ expect(std.warn).toMatchInlineSnapshot(`""`);
81
+ expect(std.err).toMatchInlineSnapshot(`""`);
82
+ });
83
+
84
+ it("should write a debug log if the dispatcher is disabled", async () => {
85
+ const requests = mockMetricRequest({}, {}, "identify");
86
+ const dispatcher = await getMetricsDispatcher({
87
+ ...MOCK_DISPATCHER_OPTIONS,
88
+ sendMetrics: false,
89
+ });
90
+ await dispatcher.identify({ a: 1, b: 2 });
91
+ await flushPromises();
92
+
93
+ expect(requests.count).toBe(0);
94
+ expect(std.debug).toMatchInlineSnapshot(
95
+ `"Metrics dispatcher: Dispatching disabled - would have sent {\\"type\\":\\"identify\\",\\"name\\":\\"identify\\",\\"properties\\":{\\"a\\":1,\\"b\\":2}}."`
96
+ );
97
+ expect(std.out).toMatchInlineSnapshot(`""`);
98
+ expect(std.warn).toMatchInlineSnapshot(`""`);
99
+ expect(std.err).toMatchInlineSnapshot(`""`);
100
+ });
101
+
102
+ it("should write a debug log if the request fails", async () => {
103
+ msw.use(
104
+ rest.post("*/identify", async (req, res) => {
105
+ return res.networkError("BAD REQUEST");
106
+ })
107
+ );
108
+
109
+ const dispatcher = await getMetricsDispatcher(MOCK_DISPATCHER_OPTIONS);
110
+ await dispatcher.identify({ a: 1, b: 2 });
111
+ await flushPromises();
112
+ expect(std.debug).toMatchInlineSnapshot(`
113
+ "Metrics dispatcher: Posting data {\\"type\\":\\"identify\\",\\"name\\":\\"identify\\",\\"properties\\":{\\"a\\":1,\\"b\\":2}}
114
+ Metrics dispatcher: Failed to send request: request to https://sparrow.cloudflare.com/api/v1/identify failed, reason: BAD REQUEST"
115
+ `);
116
+ expect(std.out).toMatchInlineSnapshot(`""`);
117
+ expect(std.warn).toMatchInlineSnapshot(`""`);
118
+ expect(std.err).toMatchInlineSnapshot(`""`);
119
+ });
120
+
121
+ it("should write a warning log if no source key has been provided", async () => {
122
+ global.SPARROW_SOURCE_KEY = undefined;
123
+ const dispatcher = await getMetricsDispatcher(MOCK_DISPATCHER_OPTIONS);
124
+ await dispatcher.identify({ a: 1, b: 2 });
125
+ expect(std.debug).toMatchInlineSnapshot(
126
+ `"Metrics dispatcher: Source Key not provided. Be sure to initialize before sending events. { type: 'identify', name: 'identify', properties: { a: 1, b: 2 } }"`
127
+ );
128
+ expect(std.out).toMatchInlineSnapshot(`""`);
129
+ expect(std.warn).toMatchInlineSnapshot(`""`);
130
+ expect(std.err).toMatchInlineSnapshot(`""`);
131
+ });
132
+ });
133
+
134
+ describe("sendEvent()", () => {
135
+ it("should send a request to the default URL", async () => {
136
+ const requests = mockMetricRequest(
137
+ {
138
+ event: "some-event",
139
+ properties: {
140
+ category: "Workers",
141
+ wranglerVersion,
142
+ os: process.platform + ":" + process.arch,
143
+ a: 1,
144
+ b: 2,
145
+ },
146
+ },
147
+ {
148
+ "Sparrow-Source-Key": "MOCK_KEY",
149
+ },
150
+ "event"
151
+ );
152
+ const dispatcher = await getMetricsDispatcher(MOCK_DISPATCHER_OPTIONS);
153
+ await dispatcher.sendEvent("some-event", { a: 1, b: 2 });
154
+
155
+ expect(requests.count).toBe(1);
156
+ expect(std.debug).toMatchInlineSnapshot(
157
+ `"Metrics dispatcher: Posting data {\\"type\\":\\"event\\",\\"name\\":\\"some-event\\",\\"properties\\":{\\"a\\":1,\\"b\\":2}}"`
158
+ );
159
+ expect(std.out).toMatchInlineSnapshot(`""`);
160
+ expect(std.warn).toMatchInlineSnapshot(`""`);
161
+ expect(std.err).toMatchInlineSnapshot(`""`);
162
+ });
163
+
164
+ it("should write a debug log if the dispatcher is disabled", async () => {
165
+ const requests = mockMetricRequest({}, {}, "event");
166
+
167
+ const dispatcher = await getMetricsDispatcher({
168
+ ...MOCK_DISPATCHER_OPTIONS,
169
+ sendMetrics: false,
170
+ });
171
+ await dispatcher.sendEvent("some-event", { a: 1, b: 2 });
172
+ await flushPromises();
173
+
174
+ expect(requests.count).toBe(0);
175
+ expect(std.debug).toMatchInlineSnapshot(
176
+ `"Metrics dispatcher: Dispatching disabled - would have sent {\\"type\\":\\"event\\",\\"name\\":\\"some-event\\",\\"properties\\":{\\"a\\":1,\\"b\\":2}}."`
177
+ );
178
+ expect(std.out).toMatchInlineSnapshot(`""`);
179
+ expect(std.warn).toMatchInlineSnapshot(`""`);
180
+ expect(std.err).toMatchInlineSnapshot(`""`);
181
+ });
182
+
183
+ it("should write a debug log if the request fails", async () => {
184
+ msw.use(
185
+ rest.post("*/event", async (_, res) => {
186
+ return res.networkError("BAD REQUEST");
187
+ })
188
+ );
189
+ const dispatcher = await getMetricsDispatcher(MOCK_DISPATCHER_OPTIONS);
190
+ await dispatcher.sendEvent("some-event", { a: 1, b: 2 });
191
+ await flushPromises();
192
+ expect(std.debug).toMatchInlineSnapshot(`
193
+ "Metrics dispatcher: Posting data {\\"type\\":\\"event\\",\\"name\\":\\"some-event\\",\\"properties\\":{\\"a\\":1,\\"b\\":2}}
194
+ Metrics dispatcher: Failed to send request: request to https://sparrow.cloudflare.com/api/v1/event failed, reason: BAD REQUEST"
195
+ `);
196
+ expect(std.out).toMatchInlineSnapshot(`""`);
197
+ expect(std.warn).toMatchInlineSnapshot(`""`);
198
+ expect(std.err).toMatchInlineSnapshot(`""`);
199
+ });
200
+
201
+ it("should write a warning log if no source key has been provided", async () => {
202
+ global.SPARROW_SOURCE_KEY = undefined;
203
+ const requests = mockMetricRequest({}, {}, "event");
204
+ const dispatcher = await getMetricsDispatcher(MOCK_DISPATCHER_OPTIONS);
205
+ await dispatcher.sendEvent("some-event", { a: 1, b: 2 });
206
+
207
+ expect(requests.count).toBe(0);
208
+ expect(std.debug).toMatchInlineSnapshot(
209
+ `"Metrics dispatcher: Source Key not provided. Be sure to initialize before sending events. { type: 'event', name: 'some-event', properties: { a: 1, b: 2 } }"`
210
+ );
211
+ expect(std.out).toMatchInlineSnapshot(`""`);
212
+ expect(std.warn).toMatchInlineSnapshot(`""`);
213
+ expect(std.err).toMatchInlineSnapshot(`""`);
214
+ });
215
+ });
216
+ });
217
+
218
+ describe("getMetricsConfig()", () => {
219
+ let isCISpy: jest.SpyInstance;
220
+
221
+ const { setIsTTY } = useMockIsTTY();
222
+ beforeEach(() => {
223
+ // Default the mock TTY to interactive for all these tests.
224
+ setIsTTY(true);
225
+ isCISpy = jest.spyOn(CI, "isCI").mockReturnValue(false);
226
+ });
227
+
228
+ describe("enabled", () => {
229
+ const ORIGINAL_ENV = process.env;
230
+ beforeEach(() => {
231
+ process.env = { ...ORIGINAL_ENV };
232
+ });
233
+ afterEach(() => {
234
+ process.env = ORIGINAL_ENV;
235
+ });
236
+
237
+ it("should return the WRANGLER_SEND_METRICS environment variable for enabled if it is defined", async () => {
238
+ process.env.WRANGLER_SEND_METRICS = "false";
239
+ expect(await getMetricsConfig({})).toMatchObject({
240
+ enabled: false,
241
+ });
242
+ process.env.WRANGLER_SEND_METRICS = "true";
243
+ expect(await getMetricsConfig({})).toMatchObject({
244
+ enabled: true,
245
+ });
246
+ });
247
+
248
+ it("should return false if running in a CI environment", async () => {
249
+ isCISpy.mockReturnValue(true);
250
+ expect(await getMetricsConfig({})).toMatchObject({
251
+ enabled: false,
252
+ });
253
+ });
254
+
255
+ it("should return the sendMetrics argument for enabled if it is defined", async () => {
256
+ expect(
257
+ await getMetricsConfig({ sendMetrics: false, offline: false })
258
+ ).toMatchObject({
259
+ enabled: false,
260
+ });
261
+ expect(
262
+ await getMetricsConfig({ sendMetrics: true, offline: false })
263
+ ).toMatchObject({
264
+ enabled: true,
265
+ });
266
+ });
267
+
268
+ it("should return enabled false if the process is not interactive", async () => {
269
+ setIsTTY(false);
270
+ expect(
271
+ await getMetricsConfig({
272
+ sendMetrics: undefined,
273
+ offline: false,
274
+ })
275
+ ).toMatchObject({
276
+ enabled: false,
277
+ });
278
+ });
279
+
280
+ it("should return enabled true if the user on this device previously agreed to send metrics", async () => {
281
+ await writeMetricsConfig({
282
+ permission: {
283
+ enabled: true,
284
+ date: new Date(2022, 6, 4),
285
+ },
286
+ });
287
+ expect(
288
+ await getMetricsConfig({
289
+ sendMetrics: undefined,
290
+ offline: false,
291
+ })
292
+ ).toMatchObject({
293
+ enabled: true,
294
+ });
295
+ });
296
+
297
+ it("should return enabled false if the user on this device previously refused to send metrics", async () => {
298
+ await writeMetricsConfig({
299
+ permission: {
300
+ enabled: false,
301
+ date: new Date(2022, 6, 4),
302
+ },
303
+ });
304
+ expect(
305
+ await getMetricsConfig({
306
+ sendMetrics: undefined,
307
+ offline: false,
308
+ })
309
+ ).toMatchObject({
310
+ enabled: false,
311
+ });
312
+ });
313
+
314
+ it("should accept and store permission granting to send metrics if the user agrees", async () => {
315
+ mockConfirm({
316
+ text: "Would you like to help improve Wrangler by sending usage metrics to Cloudflare?",
317
+ result: true,
318
+ });
319
+ expect(
320
+ await getMetricsConfig({
321
+ sendMetrics: undefined,
322
+ offline: false,
323
+ })
324
+ ).toMatchObject({
325
+ enabled: true,
326
+ });
327
+ expect((await readMetricsConfig()).permission).toMatchObject({
328
+ enabled: true,
329
+ });
330
+ });
331
+
332
+ it("should accept and store permission declining to send metrics if the user declines", async () => {
333
+ mockConfirm({
334
+ text: "Would you like to help improve Wrangler by sending usage metrics to Cloudflare?",
335
+ result: false,
336
+ });
337
+ expect(
338
+ await getMetricsConfig({
339
+ sendMetrics: undefined,
340
+ offline: false,
341
+ })
342
+ ).toMatchObject({
343
+ enabled: false,
344
+ });
345
+ expect((await readMetricsConfig()).permission).toMatchObject({
346
+ enabled: false,
347
+ });
348
+ });
349
+
350
+ it("should ignore the config if the permission date is older than the current metrics date", async () => {
351
+ mockConfirm({
352
+ text: "Would you like to help improve Wrangler by sending usage metrics to Cloudflare?",
353
+ result: false,
354
+ });
355
+ const OLD_DATE = new Date(2000);
356
+ await writeMetricsConfig({
357
+ permission: { enabled: true, date: OLD_DATE },
358
+ });
359
+ expect(
360
+ await getMetricsConfig({
361
+ sendMetrics: undefined,
362
+ offline: false,
363
+ })
364
+ ).toMatchObject({
365
+ enabled: false,
366
+ });
367
+ const { permission } = await readMetricsConfig();
368
+ expect(permission?.enabled).toBe(false);
369
+ // The date should be updated to today's date
370
+ expect(permission?.date).toEqual(CURRENT_METRICS_DATE);
371
+
372
+ expect(std.out).toMatchInlineSnapshot(`
373
+ "Usage metrics tracking has changed since you last granted permission.
374
+ Your choice has been saved in the following file: test-xdg-config/metrics.json.
375
+
376
+ You can override the user level setting for a project in \`wrangler.toml\`:
377
+
378
+ - to disable sending metrics for a project: \`send_metrics = false\`
379
+ - to enable sending metrics for a project: \`send_metrics = true\`"
380
+ `);
381
+ });
382
+ });
383
+
384
+ describe("deviceId", () => {
385
+ it("should return a deviceId found in the config file", async () => {
386
+ await writeMetricsConfig({ deviceId: "XXXX-YYYY-ZZZZ" });
387
+ const { deviceId } = await getMetricsConfig({
388
+ sendMetrics: true,
389
+ offline: false,
390
+ });
391
+ expect(deviceId).toEqual("XXXX-YYYY-ZZZZ");
392
+ expect((await readMetricsConfig()).deviceId).toEqual(deviceId);
393
+ });
394
+
395
+ it("should create and store a new deviceId if none is found in the config file", async () => {
396
+ await writeMetricsConfig({});
397
+ const { deviceId } = await getMetricsConfig({
398
+ sendMetrics: true,
399
+ offline: false,
400
+ });
401
+ expect(deviceId).toMatch(
402
+ /[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}/
403
+ );
404
+ expect((await readMetricsConfig()).deviceId).toEqual(deviceId);
405
+ });
406
+ });
407
+
408
+ describe("userId", () => {
409
+ const userRequests = mockUserRequest();
410
+ it("should return a userId found in a cache file", async () => {
411
+ await saveToConfigCache(USER_ID_CACHE_PATH, {
412
+ userId: "CACHED_USER_ID",
413
+ });
414
+ const { userId } = await getMetricsConfig({
415
+ sendMetrics: true,
416
+ offline: false,
417
+ });
418
+ expect(userId).toEqual("CACHED_USER_ID");
419
+ expect(userRequests.count).toBe(0);
420
+ });
421
+
422
+ it("should fetch the userId from Cloudflare and store it in a cache file", async () => {
423
+ writeAuthConfigFile({ oauth_token: "DUMMY_TOKEN" });
424
+ const { userId } = await getMetricsConfig({
425
+ sendMetrics: true,
426
+ offline: false,
427
+ });
428
+ await flushPromises();
429
+
430
+ expect(userId).toEqual("MOCK_USER_ID");
431
+ expect(userRequests.count).toBe(1);
432
+ });
433
+
434
+ it("should not fetch the userId from Cloudflare if running in `offline` mode", async () => {
435
+ writeAuthConfigFile({ oauth_token: "DUMMY_TOKEN" });
436
+ const { userId } = await getMetricsConfig({
437
+ sendMetrics: true,
438
+ offline: true,
439
+ });
440
+ expect(userId).toBe(undefined);
441
+ expect(userRequests.count).toBe(0);
442
+ });
443
+ });
444
+ });
445
+ });
446
+
447
+ function mockUserRequest() {
448
+ const requests = { count: 0 };
449
+ beforeEach(() => {
450
+ msw.use(
451
+ ...mswSuccessOauthHandlers,
452
+ rest.get("*/user", (_, res, cxt) => {
453
+ requests.count++;
454
+ return res(
455
+ cxt.status(200),
456
+ cxt.json({
457
+ success: true,
458
+ errors: [],
459
+ messages: [],
460
+ result: { id: "MOCK_USER_ID" },
461
+ })
462
+ );
463
+ })
464
+ );
465
+ });
466
+ afterEach(() => {
467
+ requests.count = 0;
468
+ });
469
+ return requests;
470
+ }
471
+
472
+ function mockMetricRequest(
473
+ body: unknown,
474
+ header: unknown,
475
+ endpoint: "identify" | "event"
476
+ ) {
477
+ const requests = { count: 0 };
478
+ msw.use(
479
+ rest.post(`*/${endpoint}`, async (req, res, cxt) => {
480
+ requests.count++;
481
+ expect(await req.json()).toEqual(body);
482
+ expect(req.headers).toContain(header);
483
+ return res.once(cxt.status(200), cxt.json({}));
484
+ })
485
+ );
486
+
487
+ return requests;
488
+ }
489
+
490
+ // Forces a tick to allow the non-awaited fetch promise to resolve.
491
+ function flushPromises(): Promise<void> {
492
+ return new Promise((resolve) => setTimeout(resolve, 0));
493
+ }
@@ -0,0 +1,145 @@
1
+ import * as fs from "node:fs";
2
+ import { unstable_dev } from "../api";
3
+ import { runInTempDir } from "./helpers/run-in-tmp";
4
+
5
+ jest.unmock("undici");
6
+
7
+ describe("run scheduled events with middleware", () => {
8
+ describe("module workers", () => {
9
+ runInTempDir();
10
+
11
+ beforeEach(() => {
12
+ const scriptContent = `
13
+ export default {
14
+ fetch(request, env, ctx) {
15
+ const url = new URL(request.url);
16
+ if (url.pathname === "/__scheduled") {
17
+ return new Response("Fetch triggered at /__scheduled");
18
+ }
19
+ return new Response("Hello world!");
20
+ },
21
+ scheduled(controller, env, ctx) {
22
+ // Doing something scheduled in modules...
23
+ },
24
+ };
25
+ `;
26
+ fs.writeFileSync("index.js", scriptContent);
27
+ });
28
+
29
+ it("should not intercept when middleware is not enabled", async () => {
30
+ const worker = await unstable_dev("index.js", {
31
+ experimental: {
32
+ disableExperimentalWarning: true,
33
+ disableDevRegistry: true,
34
+ },
35
+ });
36
+
37
+ const resp = await worker.fetch("/__scheduled");
38
+ let text;
39
+ if (resp) text = await resp.text();
40
+ expect(text).toMatchInlineSnapshot(`"Fetch triggered at /__scheduled"`);
41
+ await worker.stop();
42
+ });
43
+
44
+ it("should intercept when middleware is enabled", async () => {
45
+ const worker = await unstable_dev("index.js", {
46
+ experimental: {
47
+ disableExperimentalWarning: true,
48
+ disableDevRegistry: true,
49
+ testScheduled: true,
50
+ },
51
+ });
52
+
53
+ const resp = await worker.fetch("/__scheduled");
54
+ let text;
55
+ if (resp) text = await resp.text();
56
+ expect(text).toMatchInlineSnapshot(`"Ran scheduled event"`);
57
+ await worker.stop();
58
+ });
59
+
60
+ it("should not trigger scheduled event on wrong route", async () => {
61
+ const worker = await unstable_dev("index.js", {
62
+ experimental: {
63
+ disableExperimentalWarning: true,
64
+ disableDevRegistry: true,
65
+ testScheduled: true,
66
+ },
67
+ });
68
+
69
+ const resp = await worker.fetch("/test");
70
+ let text;
71
+ if (resp) text = await resp.text();
72
+ expect(text).toMatchInlineSnapshot(`"Hello world!"`);
73
+ await worker.stop();
74
+ });
75
+ });
76
+
77
+ describe("service workers", () => {
78
+ runInTempDir();
79
+
80
+ beforeEach(() => {
81
+ const scriptContent = `
82
+ addEventListener("scheduled", (event) => {
83
+ // Doing something scheduled in service worker...
84
+ });
85
+
86
+ addEventListener("fetch", (event) => {
87
+ const url = new URL(event.request.url);
88
+ if (url.pathname === "/__scheduled") {
89
+ event.respondWith(new Response("Fetch triggered at /__scheduled"));
90
+ } else {
91
+ event.respondWith(new Response("Hello world!"));
92
+ }
93
+ });
94
+ `;
95
+ fs.writeFileSync("index.js", scriptContent);
96
+ });
97
+
98
+ it("should not intercept when middleware is not enabled", async () => {
99
+ const worker = await unstable_dev("index.js", {
100
+ experimental: {
101
+ disableExperimentalWarning: true,
102
+ disableDevRegistry: true,
103
+ },
104
+ });
105
+
106
+ const resp = await worker.fetch("/__scheduled");
107
+ let text;
108
+ if (resp) text = await resp.text();
109
+ expect(text).toMatchInlineSnapshot(`"Fetch triggered at /__scheduled"`);
110
+ await worker.stop();
111
+ });
112
+
113
+ it("should intercept when middleware is enabled", async () => {
114
+ const worker = await unstable_dev("index.js", {
115
+ experimental: {
116
+ disableExperimentalWarning: true,
117
+ disableDevRegistry: true,
118
+ testScheduled: true,
119
+ },
120
+ });
121
+
122
+ const resp = await worker.fetch("/__scheduled");
123
+ let text;
124
+ if (resp) text = await resp.text();
125
+ expect(text).toMatchInlineSnapshot(`"Ran scheduled event"`);
126
+ await worker.stop();
127
+ });
128
+
129
+ it("should not trigger scheduled event on wrong route", async () => {
130
+ const worker = await unstable_dev("index.js", {
131
+ experimental: {
132
+ disableExperimentalWarning: true,
133
+ disableDevRegistry: true,
134
+ testScheduled: true,
135
+ },
136
+ });
137
+
138
+ const resp = await worker.fetch("/test");
139
+ let text;
140
+ if (resp) text = await resp.text();
141
+ expect(text).toMatchInlineSnapshot(`"Hello world!"`);
142
+ await worker.stop();
143
+ });
144
+ });
145
+ });