wrangler 0.0.0-e64812e → 0.0.0-e665ccc3

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 (373) hide show
  1. package/README.md +24 -4
  2. package/bin/wrangler.js +170 -62
  3. package/kv-asset-handler.js +1 -0
  4. package/miniflare-dist/index.mjs +1643 -83
  5. package/package.json +198 -152
  6. package/src/__tests__/access.test.ts +25 -0
  7. package/src/__tests__/api-dev.test.ts +238 -0
  8. package/src/__tests__/api-devregistry.test.ts +121 -0
  9. package/src/__tests__/api.test.ts +102 -0
  10. package/src/__tests__/config-cache-without-cache-dir.test.ts +38 -0
  11. package/src/__tests__/config-cache.test.ts +30 -24
  12. package/src/__tests__/configuration.test.ts +4506 -3363
  13. package/src/__tests__/constellation.test.ts +371 -0
  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 +257 -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 +1589 -952
  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 +88 -79
  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 -236
  65. package/src/__tests__/init.test.ts +3167 -1605
  66. package/src/__tests__/jest.setup.ts +152 -50
  67. package/src/__tests__/kv.test.ts +1789 -1471
  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 +589 -0
  74. package/src/__tests__/package-manager.test.ts +303 -303
  75. package/src/__tests__/pages/deployment-list.test.ts +80 -0
  76. package/src/__tests__/pages/functions-build.test.ts +528 -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 +957 -0
  83. package/src/__tests__/parse.test.ts +358 -252
  84. package/src/__tests__/paths.test.ts +39 -0
  85. package/src/__tests__/publish.test.ts +8736 -5355
  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 -228
  89. package/src/__tests__/route.test.ts +18 -18
  90. package/src/__tests__/secret.test.ts +681 -469
  91. package/src/__tests__/tail.test.ts +866 -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 +1 -1
  105. package/src/api/dev.ts +321 -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 +77 -0
  109. package/src/api/pages/index.ts +5 -0
  110. package/src/api/pages/publish.tsx +371 -0
  111. package/src/bundle-reporter.ts +68 -0
  112. package/src/bundle.ts +890 -161
  113. package/src/cfetch/index.ts +120 -83
  114. package/src/cfetch/internal.ts +210 -97
  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 +562 -357
  119. package/src/config/index.ts +374 -196
  120. package/src/config/validation-helpers.ts +379 -357
  121. package/src/config/validation.ts +2197 -1367
  122. package/src/config-cache.ts +81 -41
  123. package/src/constellation/createProject.tsx +51 -0
  124. package/src/constellation/deleteProject.ts +51 -0
  125. package/src/constellation/deleteProjectModel.ts +68 -0
  126. package/src/constellation/index.ts +75 -0
  127. package/src/constellation/listCatalog.tsx +35 -0
  128. package/src/constellation/listModel.tsx +41 -0
  129. package/src/constellation/listProject.tsx +28 -0
  130. package/src/constellation/listRuntime.tsx +28 -0
  131. package/src/constellation/options.ts +17 -0
  132. package/src/constellation/types.ts +17 -0
  133. package/src/constellation/uploadModel.tsx +64 -0
  134. package/src/constellation/utils.ts +90 -0
  135. package/src/create-worker-preview.ts +250 -142
  136. package/src/create-worker-upload-form.ts +347 -238
  137. package/src/d1/backups.tsx +219 -0
  138. package/src/d1/constants.ts +2 -0
  139. package/src/d1/create.tsx +70 -0
  140. package/src/d1/delete.ts +53 -0
  141. package/src/d1/execute.tsx +357 -0
  142. package/src/d1/formatTimeAgo.ts +14 -0
  143. package/src/d1/index.ts +100 -0
  144. package/src/d1/list.tsx +62 -0
  145. package/src/d1/migrations/apply.tsx +212 -0
  146. package/src/d1/migrations/create.tsx +79 -0
  147. package/src/d1/migrations/helpers.ts +169 -0
  148. package/src/d1/migrations/index.ts +3 -0
  149. package/src/d1/migrations/list.tsx +95 -0
  150. package/src/d1/migrations/options.ts +23 -0
  151. package/src/d1/options.ts +22 -0
  152. package/src/d1/splitter.ts +161 -0
  153. package/src/d1/types.ts +25 -0
  154. package/src/d1/utils.ts +49 -0
  155. package/src/delete.ts +100 -0
  156. package/src/deployments.ts +368 -0
  157. package/src/deprecated/index.ts +144 -0
  158. package/src/dev/dev-vars.ts +20 -17
  159. package/src/dev/dev.tsx +538 -352
  160. package/src/dev/get-local-persistence-path.ts +31 -0
  161. package/src/dev/local.tsx +932 -298
  162. package/src/dev/remote.tsx +623 -215
  163. package/src/dev/start-server.ts +545 -0
  164. package/src/dev/use-esbuild.ts +194 -97
  165. package/src/dev/validate-dev-props.ts +40 -0
  166. package/src/dev-registry.ts +202 -0
  167. package/src/dev.tsx +934 -0
  168. package/src/dialogs.ts +136 -0
  169. package/src/dispatch-namespace.ts +211 -0
  170. package/src/docs/helpers.ts +50 -0
  171. package/src/docs/index.ts +54 -0
  172. package/src/durable.ts +87 -87
  173. package/src/entry.ts +253 -231
  174. package/src/environment-variables/factory.ts +89 -0
  175. package/src/environment-variables/misc-variables.ts +30 -0
  176. package/src/errors.ts +6 -6
  177. package/src/generate/index.ts +298 -0
  178. package/src/git-client.ts +135 -0
  179. package/src/global-wrangler-config-path.ts +26 -0
  180. package/src/https-options.ts +84 -80
  181. package/src/index.ts +768 -0
  182. package/src/init.ts +1037 -0
  183. package/src/inspect.ts +816 -595
  184. package/src/intl-polyfill.d.ts +123 -123
  185. package/src/is-ci.ts +14 -0
  186. package/src/is-interactive.ts +16 -0
  187. package/src/jest.d.ts +4 -0
  188. package/src/kv/helpers.ts +433 -0
  189. package/src/kv/index.ts +594 -0
  190. package/src/logger.ts +100 -43
  191. package/src/metrics/index.ts +5 -0
  192. package/src/metrics/metrics-config.ts +239 -0
  193. package/src/metrics/metrics-dispatcher.ts +96 -0
  194. package/src/metrics/metrics-usage-headers.ts +24 -0
  195. package/src/metrics/send-event.ts +99 -0
  196. package/src/miniflare-cli/assets.ts +255 -0
  197. package/src/miniflare-cli/index.ts +202 -33
  198. package/src/miniflare-cli/request-context.ts +18 -18
  199. package/src/miniflare-cli/tsconfig.json +9 -0
  200. package/src/miniflare-cli/tsconfig.tsbuildinfo +1 -0
  201. package/src/miniflare-cli/types.ts +11 -0
  202. package/src/module-collection.ts +290 -215
  203. package/src/mtls-certificate/cli.ts +155 -0
  204. package/src/open-in-browser.ts +4 -6
  205. package/src/package-manager.ts +173 -128
  206. package/src/pages/build.ts +423 -0
  207. package/src/pages/buildFunctions.ts +140 -0
  208. package/src/pages/constants.ts +18 -0
  209. package/src/pages/deployment-tails.ts +281 -0
  210. package/src/pages/deployments.tsx +84 -0
  211. package/src/pages/dev.ts +734 -0
  212. package/src/pages/errors.ts +67 -0
  213. package/src/pages/functions/buildPlugin.ts +114 -0
  214. package/src/pages/functions/buildWorker.ts +350 -0
  215. package/{pages → src/pages}/functions/filepath-routing.test.ts +113 -113
  216. package/src/pages/functions/filepath-routing.ts +189 -0
  217. package/src/pages/functions/identifiers.ts +78 -0
  218. package/src/pages/functions/routes-consolidation.test.ts +250 -0
  219. package/src/pages/functions/routes-consolidation.ts +73 -0
  220. package/src/pages/functions/routes-transformation.test.ts +282 -0
  221. package/src/pages/functions/routes-transformation.ts +115 -0
  222. package/src/pages/functions/routes-validation.test.ts +403 -0
  223. package/src/pages/functions/routes-validation.ts +202 -0
  224. package/src/pages/functions/routes.ts +151 -0
  225. package/src/pages/functions/tsconfig.json +8 -0
  226. package/src/pages/functions/tsconfig.tsbuildinfo +1 -0
  227. package/src/pages/functions.ts +86 -0
  228. package/src/pages/hash.ts +13 -0
  229. package/src/pages/index.ts +102 -0
  230. package/src/pages/projects.tsx +159 -0
  231. package/src/pages/prompt-select-project.tsx +31 -0
  232. package/src/pages/publish.tsx +267 -0
  233. package/src/pages/types.ts +46 -0
  234. package/src/pages/upload.tsx +469 -0
  235. package/src/pages/utils.ts +23 -0
  236. package/src/parse.ts +232 -126
  237. package/src/paths.ts +53 -8
  238. package/src/proxy.ts +623 -394
  239. package/src/publish/index.ts +274 -0
  240. package/src/publish/publish.ts +1065 -0
  241. package/src/pubsub/index.ts +286 -0
  242. package/src/pubsub/pubsub-commands.ts +623 -0
  243. package/src/queues/cli/commands/consumer/add.ts +71 -0
  244. package/src/queues/cli/commands/consumer/index.ts +19 -0
  245. package/src/queues/cli/commands/consumer/remove.ts +31 -0
  246. package/src/queues/cli/commands/create.ts +25 -0
  247. package/src/queues/cli/commands/delete.ts +26 -0
  248. package/src/queues/cli/commands/index.ts +35 -0
  249. package/src/queues/cli/commands/list.ts +25 -0
  250. package/src/queues/client.ts +136 -0
  251. package/src/queues/utils.ts +18 -0
  252. package/src/r2/constants.ts +4 -0
  253. package/src/r2/helpers.ts +132 -0
  254. package/src/r2/index.ts +289 -0
  255. package/src/routes.ts +140 -0
  256. package/src/secret/index.ts +377 -0
  257. package/src/selfsigned.d.ts +23 -23
  258. package/src/sites.ts +484 -0
  259. package/src/tail/createTail.ts +415 -0
  260. package/src/tail/filters.ts +109 -111
  261. package/src/tail/index.ts +208 -296
  262. package/src/tail/printing.ts +116 -51
  263. package/src/traverse-module-graph.ts +54 -0
  264. package/src/tsconfig-sanity.ts +16 -0
  265. package/src/type-generation.ts +181 -0
  266. package/src/update-check.ts +11 -11
  267. package/src/user/access.ts +68 -0
  268. package/src/user/auth-variables.ts +113 -0
  269. package/src/user/choose-account.tsx +39 -0
  270. package/src/user/generate-auth-url.ts +33 -0
  271. package/src/user/generate-random-state.ts +16 -0
  272. package/src/user/index.ts +2 -0
  273. package/src/user/user.ts +1234 -0
  274. package/src/utils/collectKeyValues.ts +14 -0
  275. package/src/utils/render.ts +93 -0
  276. package/src/whoami.ts +135 -0
  277. package/src/worker.ts +205 -106
  278. package/src/yargs-types.ts +37 -0
  279. package/src/zones.ts +191 -0
  280. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  281. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  282. package/templates/__tests__/tsconfig.json +8 -0
  283. package/templates/__tests__/tsconfig.tsbuildinfo +1 -0
  284. package/templates/checked-fetch.js +23 -0
  285. package/templates/d1-beta-facade.js +244 -0
  286. package/templates/facade.d.ts +14 -0
  287. package/templates/first-party-worker-module-facade.ts +19 -0
  288. package/templates/format-dev-errors.ts +34 -0
  289. package/templates/gitignore +1 -0
  290. package/templates/init-tests/test-jest-new-worker.js +23 -0
  291. package/templates/init-tests/test-vitest-new-worker.js +24 -0
  292. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  293. package/templates/middleware/common.ts +62 -0
  294. package/templates/middleware/loader-modules.ts +84 -0
  295. package/templates/middleware/loader-sw.ts +233 -0
  296. package/templates/middleware/middleware-miniflare3-json-error.ts +32 -0
  297. package/templates/middleware/middleware-pretty-error.ts +40 -0
  298. package/templates/middleware/middleware-scheduled.ts +15 -0
  299. package/templates/new-worker-scheduled.js +3 -3
  300. package/templates/new-worker-scheduled.ts +15 -15
  301. package/templates/new-worker.js +3 -3
  302. package/templates/new-worker.ts +18 -15
  303. package/templates/no-op-worker.js +10 -0
  304. package/templates/pages-dev-pipeline.ts +31 -0
  305. package/templates/pages-dev-util.ts +52 -0
  306. package/templates/pages-shim.ts +12 -0
  307. package/templates/pages-template-plugin.ts +180 -0
  308. package/templates/pages-template-worker.ts +189 -0
  309. package/templates/serve-static-assets.ts +66 -0
  310. package/templates/service-bindings-module-facade.js +55 -0
  311. package/templates/service-bindings-sw-facade.js +42 -0
  312. package/templates/tsconfig-sanity.ts +11 -0
  313. package/templates/tsconfig.init.json +105 -0
  314. package/templates/tsconfig.json +6 -103
  315. package/templates/tsconfig.tsbuildinfo +1 -0
  316. package/wrangler-dist/cli.d.ts +1652 -0
  317. package/wrangler-dist/cli.js +137978 -110578
  318. package/wrangler-dist/wasm-sync.wasm +0 -0
  319. package/pages/functions/buildPlugin.ts +0 -105
  320. package/pages/functions/buildWorker.ts +0 -151
  321. package/pages/functions/filepath-routing.ts +0 -189
  322. package/pages/functions/identifiers.ts +0 -78
  323. package/pages/functions/routes.ts +0 -156
  324. package/pages/functions/template-plugin.ts +0 -147
  325. package/pages/functions/template-worker.ts +0 -143
  326. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  327. package/src/__tests__/helpers/mock-cfetch.ts +0 -211
  328. package/src/__tests__/pages.test.ts +0 -754
  329. package/src/dialogs.tsx +0 -135
  330. package/src/environment-variables.ts +0 -35
  331. package/src/index.tsx +0 -2864
  332. package/src/kv.ts +0 -408
  333. package/src/miniflare-cli/enum-keys.ts +0 -17
  334. package/src/pages.tsx +0 -2038
  335. package/src/publish.ts +0 -583
  336. package/src/r2.ts +0 -50
  337. package/src/sites.tsx +0 -295
  338. package/src/user.tsx +0 -1203
  339. package/src/whoami.tsx +0 -70
  340. package/templates/static-asset-facade.js +0 -47
  341. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  342. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  343. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  344. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  345. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  346. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  347. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  348. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  349. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  350. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  351. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  352. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  353. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  354. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  355. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  356. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  357. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  358. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  359. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  360. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  361. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  362. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  363. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  364. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  365. package/vendor/wrangler-mime/LICENSE +0 -21
  366. package/vendor/wrangler-mime/Mime.js +0 -97
  367. package/vendor/wrangler-mime/README.md +0 -187
  368. package/vendor/wrangler-mime/cli.js +0 -46
  369. package/vendor/wrangler-mime/index.js +0 -4
  370. package/vendor/wrangler-mime/lite.js +0 -4
  371. package/vendor/wrangler-mime/package.json +0 -52
  372. package/vendor/wrangler-mime/types/other.js +0 -1
  373. package/vendor/wrangler-mime/types/standard.js +0 -1
@@ -1,420 +1,647 @@
1
1
  import MockWebSocket from "jest-websocket-mock";
2
+ import { rest } from "msw";
2
3
  import { Headers, Request } from "undici";
3
4
  import { mockAccountId, mockApiToken } from "./helpers/mock-account-id";
4
- import { setMockResponse, unsetAllMocks } from "./helpers/mock-cfetch";
5
5
  import { mockConsoleMethods } from "./helpers/mock-console";
6
+ import { mockConfirm, clearDialogs } from "./helpers/mock-dialogs";
6
7
  import { useMockIsTTY } from "./helpers/mock-istty";
8
+ import { createFetchResult, msw, mswSucessScriptHandlers } from "./helpers/msw";
7
9
  import { runInTempDir } from "./helpers/run-in-tmp";
8
10
  import { runWrangler } from "./helpers/run-wrangler";
9
- import type { TailEventMessage, RequestEvent, ScheduledEvent } from "../tail";
11
+ import type {
12
+ TailEventMessage,
13
+ RequestEvent,
14
+ ScheduledEvent,
15
+ AlarmEvent,
16
+ EmailEvent,
17
+ TailInfo,
18
+ } from "../tail/createTail";
19
+ import type { RequestInit } from "undici";
10
20
  import type WebSocket from "ws";
11
21
 
12
22
  describe("tail", () => {
13
- runInTempDir();
14
- mockAccountId();
15
- mockApiToken();
16
-
17
- const std = mockConsoleMethods();
18
-
19
- afterEach(() => {
20
- mockWebSockets.forEach((ws) => ws.close());
21
- mockWebSockets.splice(0);
22
- unsetAllMocks();
23
- });
24
-
25
- /**
26
- * Interaction with the tailing API, including tail creation,
27
- * deletion, and connection.
28
- */
29
- describe("API interaction", () => {
30
- it("creates and then delete tails", async () => {
31
- const api = mockWebsocketAPIs();
32
- expect(api.requests.creation.count).toStrictEqual(0);
33
-
34
- await runWrangler("tail test-worker");
35
-
36
- await expect(api.ws.connected).resolves.toBeTruthy();
37
- expect(api.requests.creation.count).toStrictEqual(1);
38
- expect(api.requests.deletion.count).toStrictEqual(0);
39
-
40
- api.ws.close();
41
- expect(api.requests.deletion.count).toStrictEqual(1);
42
- });
43
-
44
- it("creates and then delete tails: legacy envs", async () => {
45
- const api = mockWebsocketAPIs("some-env", true);
46
- expect(api.requests.creation.count).toStrictEqual(0);
47
-
48
- await runWrangler("tail test-worker --env some-env --legacy-env true");
49
-
50
- await expect(api.ws.connected).resolves.toBeTruthy();
51
- expect(api.requests.creation.count).toStrictEqual(1);
52
- expect(api.requests.deletion.count).toStrictEqual(0);
53
-
54
- api.ws.close();
55
- expect(api.requests.deletion.count).toStrictEqual(1);
56
- });
57
-
58
- it("creates and then delete tails: service envs", async () => {
59
- const api = mockWebsocketAPIs("some-env");
60
- expect(api.requests.creation.count).toStrictEqual(0);
61
-
62
- await runWrangler("tail test-worker --env some-env --legacy-env false");
63
-
64
- await expect(api.ws.connected).resolves.toBeTruthy();
65
- expect(api.requests.creation.count).toStrictEqual(1);
66
- expect(api.requests.deletion.count).toStrictEqual(0);
67
-
68
- api.ws.close();
69
- expect(api.requests.deletion.count).toStrictEqual(1);
70
- });
71
-
72
- it("errors when the websocket closes unexpectedly", async () => {
73
- const api = mockWebsocketAPIs();
74
- api.ws.close();
75
-
76
- await expect(runWrangler("tail test-worker")).rejects.toThrow();
77
- });
78
-
79
- it("activates debug mode when the cli arg is passed in", async () => {
80
- const api = mockWebsocketAPIs();
81
- await runWrangler("tail test-worker --debug");
82
- await expect(api.nextMessageJson()).resolves.toHaveProperty(
83
- "debug",
84
- true
85
- );
86
- });
87
- });
88
-
89
- describe("filtering", () => {
90
- it("sends sampling rate filters", async () => {
91
- const api = mockWebsocketAPIs();
92
- const tooHigh = runWrangler("tail test-worker --sampling-rate 10");
93
- await expect(tooHigh).rejects.toThrow();
94
-
95
- const tooLow = runWrangler("tail test-worker --sampling-rate -5");
96
- await expect(tooLow).rejects.toThrow();
97
-
98
- await runWrangler("tail test-worker --sampling-rate 0.25");
99
- await expect(api.nextMessageJson()).resolves.toHaveProperty("filters", [
100
- { sampling_rate: 0.25 },
101
- ]);
102
- });
103
-
104
- it("sends single status filters", async () => {
105
- const api = mockWebsocketAPIs();
106
- await runWrangler("tail test-worker --status error");
107
- await expect(api.nextMessageJson()).resolves.toHaveProperty("filters", [
108
- { outcome: ["exception", "exceededCpu", "unknown"] },
109
- ]);
110
- });
111
-
112
- it("sends multiple status filters", async () => {
113
- const api = mockWebsocketAPIs();
114
- await runWrangler("tail test-worker --status error --status canceled");
115
- await expect(api.nextMessageJson()).resolves.toHaveProperty("filters", [
116
- { outcome: ["exception", "exceededCpu", "unknown", "canceled"] },
117
- ]);
118
- });
119
-
120
- it("sends single HTTP method filters", async () => {
121
- const api = mockWebsocketAPIs();
122
- await runWrangler("tail test-worker --method POST");
123
- await expect(api.nextMessageJson()).resolves.toHaveProperty("filters", [
124
- { method: ["POST"] },
125
- ]);
126
- });
127
-
128
- it("sends multiple HTTP method filters", async () => {
129
- const api = mockWebsocketAPIs();
130
- await runWrangler("tail test-worker --method POST --method GET");
131
- await expect(api.nextMessageJson()).resolves.toHaveProperty("filters", [
132
- { method: ["POST", "GET"] },
133
- ]);
134
- });
135
-
136
- it("sends header filters without a query", async () => {
137
- const api = mockWebsocketAPIs();
138
- await runWrangler("tail test-worker --header X-CUSTOM-HEADER");
139
- await expect(api.nextMessageJson()).resolves.toHaveProperty("filters", [
140
- { header: { key: "X-CUSTOM-HEADER" } },
141
- ]);
142
- });
143
-
144
- it("sends header filters with a query", async () => {
145
- const api = mockWebsocketAPIs();
146
- await runWrangler("tail test-worker --header X-CUSTOM-HEADER:some-value");
147
- await expect(api.nextMessageJson()).resolves.toHaveProperty("filters", [
148
- { header: { key: "X-CUSTOM-HEADER", query: "some-value" } },
149
- ]);
150
- });
151
-
152
- it("sends single IP filters", async () => {
153
- const api = mockWebsocketAPIs();
154
- const fakeIp = "192.0.2.1";
155
-
156
- await runWrangler(`tail test-worker --ip ${fakeIp}`);
157
- await expect(api.nextMessageJson()).resolves.toHaveProperty("filters", [
158
- { client_ip: [fakeIp] },
159
- ]);
160
- });
161
-
162
- it("sends multiple IP filters", async () => {
163
- const api = mockWebsocketAPIs();
164
- const fakeIp = "192.0.2.1";
165
-
166
- await runWrangler(`tail test-worker --ip ${fakeIp} --ip self`);
167
- await expect(api.nextMessageJson()).resolves.toHaveProperty("filters", [
168
- { client_ip: [fakeIp, "self"] },
169
- ]);
170
- });
171
-
172
- it("sends search filters", async () => {
173
- const api = mockWebsocketAPIs();
174
- const search = "filterMe";
175
-
176
- await runWrangler(`tail test-worker --search ${search}`);
177
- await expect(api.nextMessageJson()).resolves.toHaveProperty("filters", [
178
- { query: search },
179
- ]);
180
- });
181
-
182
- it("sends everything but the kitchen sink", async () => {
183
- const api = mockWebsocketAPIs();
184
- const sampling_rate = 0.69;
185
- const status = ["ok", "error"];
186
- const method = ["GET", "POST", "PUT"];
187
- const header = "X-HELLO:world";
188
- const client_ip = ["192.0.2.1", "self"];
189
- const query = "onlyTheseMessagesPlease";
190
-
191
- const cliFilters =
192
- `--sampling-rate ${sampling_rate} ` +
193
- status.map((s) => `--status ${s} `).join("") +
194
- method.map((m) => `--method ${m} `).join("") +
195
- `--header ${header} ` +
196
- client_ip.map((c) => `--ip ${c} `).join("") +
197
- `--search ${query} ` +
198
- `--debug`;
199
-
200
- const expectedWebsocketMessage = {
201
- filters: [
202
- { sampling_rate },
203
- { outcome: ["ok", "exception", "exceededCpu", "unknown"] },
204
- { method },
205
- { header: { key: "X-HELLO", query: "world" } },
206
- { client_ip },
207
- { query },
208
- ],
209
- debug: true,
210
- };
211
-
212
- await runWrangler(`tail test-worker ${cliFilters}`);
213
- await expect(api.nextMessageJson()).resolves.toEqual(
214
- expectedWebsocketMessage
215
- );
216
- });
217
- });
218
-
219
- describe("printing", () => {
220
- const { setIsTTY } = useMockIsTTY();
221
-
222
- it("logs request messages in JSON format", async () => {
223
- const api = mockWebsocketAPIs();
224
- await runWrangler("tail test-worker --format json");
225
-
226
- const event = generateMockRequestEvent();
227
- const message = generateMockEventMessage({ event });
228
- const serializedMessage = serialize(message);
229
-
230
- api.ws.send(serializedMessage);
231
- expect(std.out).toMatch(deserializeToJson(serializedMessage));
232
- });
233
-
234
- it("logs scheduled messages in JSON format", async () => {
235
- const api = mockWebsocketAPIs();
236
- await runWrangler("tail test-worker --format json");
237
-
238
- const event = generateMockScheduledEvent();
239
- const message = generateMockEventMessage({ event });
240
- const serializedMessage = serialize(message);
241
-
242
- api.ws.send(serializedMessage);
243
- expect(std.out).toMatch(deserializeToJson(serializedMessage));
244
- });
245
-
246
- it("logs request messages in pretty format", async () => {
247
- const api = mockWebsocketAPIs();
248
- await runWrangler("tail test-worker --format pretty");
249
-
250
- const event = generateMockRequestEvent();
251
- const message = generateMockEventMessage({ event });
252
- const serializedMessage = serialize(message);
253
-
254
- api.ws.send(serializedMessage);
255
- expect(
256
- std.out
257
- .replace(
258
- new Date(mockEventTimestamp).toLocaleString(),
259
- "[mock event timestamp]"
260
- )
261
- .replace(
262
- mockTailExpiration.toLocaleString(),
263
- "[mock expiration date]"
264
- )
265
- ).toMatchInlineSnapshot(`
266
- "Successfully created tail, expires at [mock expiration date]
267
- Connected to test-worker, waiting for logs...
268
- GET https://example.org/ - Ok @ [mock event timestamp]"
269
- `);
270
- });
271
-
272
- it("logs scheduled messages in pretty format", async () => {
273
- const api = mockWebsocketAPIs();
274
- await runWrangler("tail test-worker --format pretty");
275
-
276
- const event = generateMockScheduledEvent();
277
- const message = generateMockEventMessage({ event });
278
- const serializedMessage = serialize(message);
279
-
280
- api.ws.send(serializedMessage);
281
- expect(
282
- std.out
283
- .replace(
284
- new Date(mockEventTimestamp).toLocaleString(),
285
- "[mock timestamp string]"
286
- )
287
- .replace(
288
- mockTailExpiration.toLocaleString(),
289
- "[mock expiration date]"
290
- )
291
- ).toMatchInlineSnapshot(`
292
- "Successfully created tail, expires at [mock expiration date]
293
- Connected to test-worker, waiting for logs...
294
- \\"* * * * *\\" @ [mock timestamp string] - Ok"
295
- `);
296
- });
297
-
298
- it("should not crash when the tail message has a void event", async () => {
299
- const api = mockWebsocketAPIs();
300
- await runWrangler("tail test-worker --format pretty");
301
-
302
- const message = generateMockEventMessage({ event: null });
303
- const serializedMessage = serialize(message);
304
-
305
- api.ws.send(serializedMessage);
306
- expect(
307
- std.out
308
- .replace(
309
- new Date(mockEventTimestamp).toLocaleString(),
310
- "[mock timestamp string]"
311
- )
312
- .replace(
313
- mockTailExpiration.toLocaleString(),
314
- "[mock expiration date]"
315
- )
316
- ).toMatchInlineSnapshot(`
317
- "Successfully created tail, expires at [mock expiration date]
318
- Connected to test-worker, waiting for logs...
319
- [missing request] - Ok @ [mock timestamp string]"
320
- `);
321
- });
322
-
323
- it("defaults to logging in pretty format when the output is a TTY", async () => {
324
- setIsTTY(true);
325
- const api = mockWebsocketAPIs();
326
- await runWrangler("tail test-worker");
327
-
328
- const event = generateMockRequestEvent();
329
- const message = generateMockEventMessage({ event });
330
- const serializedMessage = serialize(message);
331
-
332
- api.ws.send(serializedMessage);
333
- expect(
334
- std.out
335
- .replace(
336
- new Date(mockEventTimestamp).toLocaleString(),
337
- "[mock event timestamp]"
338
- )
339
- .replace(
340
- mockTailExpiration.toLocaleString(),
341
- "[mock expiration date]"
342
- )
343
- ).toMatchInlineSnapshot(`
344
- "Successfully created tail, expires at [mock expiration date]
345
- Connected to test-worker, waiting for logs...
346
- GET https://example.org/ - Ok @ [mock event timestamp]"
347
- `);
348
- });
349
-
350
- it("defaults to logging in json format when the output is not a TTY", async () => {
351
- setIsTTY(false);
352
-
353
- const api = mockWebsocketAPIs();
354
- await runWrangler("tail test-worker");
355
-
356
- const event = generateMockRequestEvent();
357
- const message = generateMockEventMessage({ event });
358
- const serializedMessage = serialize(message);
359
-
360
- api.ws.send(serializedMessage);
361
- expect(std.out).toMatch(deserializeToJson(serializedMessage));
362
- });
363
-
364
- it("logs console messages and exceptions", async () => {
365
- setIsTTY(true);
366
- const api = mockWebsocketAPIs();
367
- await runWrangler("tail test-worker");
368
-
369
- const event = generateMockRequestEvent();
370
- const message = generateMockEventMessage({
371
- event,
372
- logs: [
373
- { message: ["some string"], level: "log", timestamp: 1234561 },
374
- {
375
- message: [{ complex: "object" }],
376
- level: "log",
377
- timestamp: 1234562,
378
- },
379
- { message: [1234], level: "error", timestamp: 1234563 },
380
- ],
381
- exceptions: [
382
- { name: "Error", message: "some error", timestamp: 1234564 },
383
- { name: "Error", message: { complex: "error" }, timestamp: 1234564 },
384
- ],
385
- });
386
- const serializedMessage = serialize(message);
387
-
388
- api.ws.send(serializedMessage);
389
- expect(
390
- std.out
391
- .replace(
392
- new Date(mockEventTimestamp).toLocaleString(),
393
- "[mock event timestamp]"
394
- )
395
- .replace(
396
- mockTailExpiration.toLocaleString(),
397
- "[mock expiration date]"
398
- )
399
- ).toMatchInlineSnapshot(`
400
- "Successfully created tail, expires at [mock expiration date]
401
- Connected to test-worker, waiting for logs...
402
- GET https://example.org/ - Ok @ [mock event timestamp]
403
- (log) some string
404
- (log) { complex: 'object' }
405
- (error) 1234"
406
- `);
407
- expect(std.err).toMatchInlineSnapshot(`
408
- "X [ERROR]  Error: some error
409
-
410
-
411
- X [ERROR]  Error: { complex: 'error' }
412
-
413
- "
414
- `);
415
- expect(std.warn).toMatchInlineSnapshot(`""`);
416
- });
417
- });
23
+ beforeEach(() => msw.use(...mswSucessScriptHandlers));
24
+ runInTempDir();
25
+ mockAccountId();
26
+ mockApiToken();
27
+
28
+ const std = mockConsoleMethods();
29
+
30
+ afterEach(() => {
31
+ mockWebSockets.forEach((ws) => ws.close());
32
+ mockWebSockets.splice(0);
33
+ clearDialogs();
34
+ });
35
+
36
+ /**
37
+ * Interaction with the tailing API, including tail creation,
38
+ * deletion, and connection.
39
+ */
40
+ describe("API interaction", () => {
41
+ const { setIsTTY } = useMockIsTTY();
42
+ it("should throw an error if name isn't provided", async () => {
43
+ await expect(
44
+ runWrangler("tail")
45
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
46
+ `"Required Worker name missing. Please specify the Worker name in wrangler.toml, or pass it as an argument with \`wrangler tail <worker-name>\`"`
47
+ );
48
+ });
49
+ it("warns about durable object restarts for tty", async () => {
50
+ setIsTTY(true);
51
+ mockConfirm({
52
+ text: "Would you like to continue?",
53
+ result: false,
54
+ });
55
+ const api = mockWebsocketAPIs();
56
+ expect(api.requests.creation.length).toStrictEqual(0);
57
+ await runWrangler("tail durable-object--websocket--response");
58
+ expect(std.out).toMatchInlineSnapshot(`""`);
59
+ expect(std.warn).toMatchInlineSnapshot(`
60
+ "▲ [WARNING] Beginning log collection requires restarting the Durable Objects associated with durable-object--websocket--response. Any WebSocket connections or other non-persisted state will be lost as part of this restart.
61
+
62
+ "
63
+ `);
64
+ expect(std.err).toMatchInlineSnapshot(`""`);
65
+ });
66
+ it("creates and then delete tails", async () => {
67
+ const api = mockWebsocketAPIs();
68
+ expect(api.requests.creation.length).toStrictEqual(0);
69
+
70
+ await runWrangler("tail test-worker");
71
+
72
+ await expect(api.ws.connected).resolves.toBeTruthy();
73
+ expect(api.requests.creation.length).toStrictEqual(1);
74
+ expect(api.requests.deletion.count).toStrictEqual(0);
75
+
76
+ await api.closeHelper();
77
+ expect(api.requests.deletion.count).toStrictEqual(1);
78
+ });
79
+ it("should connect to the worker assigned to a given route", async () => {
80
+ const api = mockWebsocketAPIs();
81
+ expect(api.requests.creation.length).toStrictEqual(0);
82
+
83
+ msw.use(
84
+ rest.get(`*/zones`, (req, res, ctx) => {
85
+ expect(req.url.searchParams.get("name")).toBe("example.com");
86
+ return res.once(
87
+ ctx.status(200),
88
+ ctx.json({
89
+ success: true,
90
+ errors: [],
91
+ messages: [],
92
+ result: [{ id: "test-zone" }],
93
+ })
94
+ );
95
+ })
96
+ );
97
+ msw.use(
98
+ rest.get(`*/zones/:zoneId/workers/routes`, (req, res, ctx) => {
99
+ return res.once(
100
+ ctx.status(200),
101
+ ctx.json({
102
+ success: true,
103
+ errors: [],
104
+ messages: [],
105
+ result: [
106
+ {
107
+ pattern: "example.com/*",
108
+ script: "test-worker",
109
+ },
110
+ ],
111
+ })
112
+ );
113
+ })
114
+ );
115
+ await runWrangler("tail example.com/*");
116
+
117
+ await expect(api.ws.connected).resolves.toBeTruthy();
118
+ expect(api.requests.creation.length).toStrictEqual(1);
119
+ expect(api.requests.deletion.count).toStrictEqual(0);
120
+
121
+ await api.closeHelper();
122
+ expect(api.requests.deletion.count).toStrictEqual(1);
123
+ });
124
+
125
+ it("should error if a given route is not assigned to the user's zone", async () => {
126
+ msw.use(
127
+ rest.get(`*/zones`, (req, res, ctx) => {
128
+ expect(req.url.searchParams.get("name")).toBe("example.com");
129
+ return res.once(
130
+ ctx.status(200),
131
+ ctx.json({
132
+ success: true,
133
+ errors: [],
134
+ messages: [],
135
+ result: [{ id: "test-zone" }],
136
+ })
137
+ );
138
+ })
139
+ );
140
+ msw.use(
141
+ rest.get(`*/zones/:zoneId/workers/routes`, (req, res, ctx) => {
142
+ return res.once(
143
+ ctx.status(200),
144
+ ctx.json({
145
+ success: true,
146
+ errors: [],
147
+ messages: [],
148
+ result: [],
149
+ })
150
+ );
151
+ })
152
+ );
153
+
154
+ await expect(runWrangler("tail example.com/*")).rejects.toThrow();
155
+ });
156
+ it("should error if a given route is not within the user's zone", async () => {
157
+ msw.use(
158
+ rest.get(`*/zones`, (req, res, ctx) => {
159
+ expect(req.url.searchParams.get("name")).toBe("example.com");
160
+ return res.once(
161
+ ctx.status(200),
162
+ ctx.json({
163
+ success: true,
164
+ errors: [],
165
+ messages: [],
166
+ result: [],
167
+ })
168
+ );
169
+ })
170
+ );
171
+
172
+ await expect(runWrangler("tail example.com/*")).rejects.toThrow();
173
+ });
174
+
175
+ it("creates and then delete tails: legacy envs", async () => {
176
+ const api = mockWebsocketAPIs("some-env", true);
177
+ expect(api.requests.creation.length).toStrictEqual(0);
178
+
179
+ await runWrangler("tail test-worker --env some-env --legacy-env true");
180
+
181
+ await expect(api.ws.connected).resolves.toBeTruthy();
182
+ expect(api.requests.creation.length).toStrictEqual(1);
183
+ expect(api.requests.deletion.count).toStrictEqual(0);
184
+
185
+ await api.closeHelper();
186
+ expect(api.requests.deletion.count).toStrictEqual(1);
187
+ });
188
+
189
+ it("creates and then delete tails: service envs", async () => {
190
+ const api = mockWebsocketAPIs("some-env");
191
+ expect(api.requests.creation.length).toStrictEqual(0);
192
+
193
+ await runWrangler("tail test-worker --env some-env --legacy-env false");
194
+
195
+ await expect(api.ws.connected).resolves.toBeTruthy();
196
+ expect(api.requests.creation.length).toStrictEqual(1);
197
+ expect(api.requests.deletion.count).toStrictEqual(0);
198
+
199
+ await api.closeHelper();
200
+ expect(api.requests.deletion.count).toStrictEqual(1);
201
+ });
202
+
203
+ it("errors when the websocket closes unexpectedly", async () => {
204
+ const api = mockWebsocketAPIs();
205
+ await api.closeHelper();
206
+
207
+ await expect(runWrangler("tail test-worker")).rejects.toThrow();
208
+ });
209
+
210
+ it("activates debug mode when the cli arg is passed in", async () => {
211
+ const api = mockWebsocketAPIs();
212
+ await runWrangler("tail test-worker --debug");
213
+ await expect(api.nextMessageJson()).resolves.toHaveProperty(
214
+ "debug",
215
+ true
216
+ );
217
+ });
218
+ });
219
+
220
+ describe("filtering", () => {
221
+ it("sends sampling rate filters", async () => {
222
+ const api = mockWebsocketAPIs();
223
+ const tooHigh = runWrangler("tail test-worker --sampling-rate 10");
224
+ await expect(tooHigh).rejects.toThrow();
225
+
226
+ const tooLow = runWrangler("tail test-worker --sampling-rate -5");
227
+ await expect(tooLow).rejects.toThrow();
228
+
229
+ await runWrangler("tail test-worker --sampling-rate 0.25");
230
+
231
+ expect(api.requests.creation[0]).toEqual({
232
+ filters: [{ sampling_rate: 0.25 }],
233
+ });
234
+ });
235
+
236
+ it("sends single status filters", async () => {
237
+ const api = mockWebsocketAPIs();
238
+ await runWrangler("tail test-worker --status error");
239
+ expect(api.requests.creation[0]).toEqual({
240
+ filters: [
241
+ {
242
+ outcome: ["exception", "exceededCpu", "exceededMemory", "unknown"],
243
+ },
244
+ ],
245
+ });
246
+ });
247
+
248
+ it("sends multiple status filters", async () => {
249
+ const api = mockWebsocketAPIs();
250
+ await runWrangler("tail test-worker --status error --status canceled");
251
+ expect(api.requests.creation[0]).toEqual({
252
+ filters: [
253
+ {
254
+ outcome: [
255
+ "exception",
256
+ "exceededCpu",
257
+ "exceededMemory",
258
+ "unknown",
259
+ "canceled",
260
+ ],
261
+ },
262
+ ],
263
+ });
264
+ });
265
+
266
+ it("sends single HTTP method filters", async () => {
267
+ const api = mockWebsocketAPIs();
268
+ await runWrangler("tail test-worker --method POST");
269
+ expect(api.requests.creation[0]).toEqual({
270
+ filters: [{ method: ["POST"] }],
271
+ });
272
+ });
273
+
274
+ it("sends multiple HTTP method filters", async () => {
275
+ const api = mockWebsocketAPIs();
276
+ await runWrangler("tail test-worker --method POST --method GET");
277
+ expect(api.requests.creation[0]).toEqual({
278
+ filters: [{ method: ["POST", "GET"] }],
279
+ });
280
+ });
281
+
282
+ it("sends header filters without a query", async () => {
283
+ const api = mockWebsocketAPIs();
284
+ await runWrangler("tail test-worker --header X-CUSTOM-HEADER");
285
+ expect(api.requests.creation[0]).toEqual({
286
+ filters: [{ header: { key: "X-CUSTOM-HEADER" } }],
287
+ });
288
+ });
289
+
290
+ it("sends header filters with a query", async () => {
291
+ const api = mockWebsocketAPIs();
292
+ await runWrangler("tail test-worker --header X-CUSTOM-HEADER:some-value");
293
+ expect(api.requests.creation[0]).toEqual({
294
+ filters: [{ header: { key: "X-CUSTOM-HEADER", query: "some-value" } }],
295
+ });
296
+ });
297
+
298
+ it("sends single IP filters", async () => {
299
+ const api = mockWebsocketAPIs();
300
+ const fakeIp = "192.0.2.1";
301
+
302
+ await runWrangler(`tail test-worker --ip ${fakeIp}`);
303
+ expect(api.requests.creation[0]).toEqual({
304
+ filters: [{ client_ip: [fakeIp] }],
305
+ });
306
+ });
307
+
308
+ it("sends multiple IP filters", async () => {
309
+ const api = mockWebsocketAPIs();
310
+ const fakeIp = "192.0.2.1";
311
+
312
+ await runWrangler(`tail test-worker --ip ${fakeIp} --ip self`);
313
+ expect(api.requests.creation[0]).toEqual({
314
+ filters: [{ client_ip: [fakeIp, "self"] }],
315
+ });
316
+ });
317
+
318
+ it("sends search filters", async () => {
319
+ const api = mockWebsocketAPIs();
320
+ const search = "filterMe";
321
+
322
+ await runWrangler(`tail test-worker --search ${search}`);
323
+ expect(api.requests.creation[0]).toEqual({
324
+ filters: [{ query: search }],
325
+ });
326
+ });
327
+
328
+ it("sends everything but the kitchen sink", async () => {
329
+ const api = mockWebsocketAPIs();
330
+ const sampling_rate = 0.69;
331
+ const status = ["ok", "error"];
332
+ const method = ["GET", "POST", "PUT"];
333
+ const header = "X-HELLO:world";
334
+ const client_ip = ["192.0.2.1", "self"];
335
+ const query = "onlyTheseMessagesPlease";
336
+
337
+ const cliFilters =
338
+ `--sampling-rate ${sampling_rate} ` +
339
+ status.map((s) => `--status ${s} `).join("") +
340
+ method.map((m) => `--method ${m} `).join("") +
341
+ `--header ${header} ` +
342
+ client_ip.map((c) => `--ip ${c} `).join("") +
343
+ `--search ${query} ` +
344
+ `--debug`;
345
+
346
+ const expectedWebsocketMessage = {
347
+ filters: [
348
+ { sampling_rate: 0.69 },
349
+ {
350
+ outcome: [
351
+ "ok",
352
+ "exception",
353
+ "exceededCpu",
354
+ "exceededMemory",
355
+ "unknown",
356
+ ],
357
+ },
358
+ { method: ["GET", "POST", "PUT"] },
359
+ { header: { key: "X-HELLO", query: "world" } },
360
+ { client_ip: ["192.0.2.1", "self"] },
361
+ { query: "onlyTheseMessagesPlease" },
362
+ ],
363
+ };
364
+
365
+ await runWrangler(`tail test-worker ${cliFilters}`);
366
+ expect(api.requests.creation[0]).toEqual(expectedWebsocketMessage);
367
+ });
368
+ });
369
+
370
+ describe("printing", () => {
371
+ const { setIsTTY } = useMockIsTTY();
372
+
373
+ it("logs request messages in JSON format", async () => {
374
+ const api = mockWebsocketAPIs();
375
+ await runWrangler("tail test-worker --format json");
376
+
377
+ const event = generateMockRequestEvent();
378
+ const message = generateMockEventMessage({ event });
379
+ const serializedMessage = serialize(message);
380
+
381
+ api.ws.send(serializedMessage);
382
+ expect(std.out).toMatch(deserializeToJson(serializedMessage));
383
+ });
384
+
385
+ it("logs scheduled messages in JSON format", async () => {
386
+ const api = mockWebsocketAPIs();
387
+ await runWrangler("tail test-worker --format json");
388
+
389
+ const event = generateMockScheduledEvent();
390
+ const message = generateMockEventMessage({ event });
391
+ const serializedMessage = serialize(message);
392
+
393
+ api.ws.send(serializedMessage);
394
+ expect(std.out).toMatch(deserializeToJson(serializedMessage));
395
+ });
396
+
397
+ it("logs alarm messages in json format", async () => {
398
+ const api = mockWebsocketAPIs();
399
+ await runWrangler("tail test-worker --format json");
400
+
401
+ const event = generateMockAlarmEvent();
402
+ const message = generateMockEventMessage({ event });
403
+ const serializedMessage = serialize(message);
404
+
405
+ api.ws.send(serializedMessage);
406
+ expect(std.out).toMatch(deserializeToJson(serializedMessage));
407
+ });
408
+
409
+ it("logs email messages in json format", async () => {
410
+ const api = mockWebsocketAPIs();
411
+ await runWrangler("tail test-worker --format json");
412
+
413
+ const event = generateMockEmailEvent();
414
+ const message = generateMockEventMessage({ event });
415
+ const serializedMessage = serialize(message);
416
+
417
+ api.ws.send(serializedMessage);
418
+ expect(std.out).toMatch(deserializeToJson(serializedMessage));
419
+ });
420
+
421
+ it("logs request messages in pretty format", async () => {
422
+ const api = mockWebsocketAPIs();
423
+ await runWrangler("tail test-worker --format pretty");
424
+
425
+ const event = generateMockRequestEvent();
426
+ const message = generateMockEventMessage({ event });
427
+ const serializedMessage = serialize(message);
428
+
429
+ api.ws.send(serializedMessage);
430
+ expect(
431
+ std.out
432
+ .replace(
433
+ new Date(mockEventTimestamp).toLocaleString(),
434
+ "[mock event timestamp]"
435
+ )
436
+ .replace(mockTailExpiration.toISOString(), "[mock expiration date]")
437
+ ).toMatchInlineSnapshot(`
438
+ "Successfully created tail, expires at [mock expiration date]
439
+ Connected to test-worker, waiting for logs...
440
+ GET https://example.org/ - Ok @ [mock event timestamp]"
441
+ `);
442
+ });
443
+
444
+ it("logs scheduled messages in pretty format", async () => {
445
+ const api = mockWebsocketAPIs();
446
+ await runWrangler("tail test-worker --format pretty");
447
+
448
+ const event = generateMockScheduledEvent();
449
+ const message = generateMockEventMessage({ event });
450
+ const serializedMessage = serialize(message);
451
+
452
+ api.ws.send(serializedMessage);
453
+ expect(
454
+ std.out
455
+ .replace(
456
+ new Date(mockEventTimestamp).toLocaleString(),
457
+ "[mock timestamp string]"
458
+ )
459
+ .replace(mockTailExpiration.toISOString(), "[mock expiration date]")
460
+ ).toMatchInlineSnapshot(`
461
+ "Successfully created tail, expires at [mock expiration date]
462
+ Connected to test-worker, waiting for logs...
463
+ \\"* * * * *\\" @ [mock timestamp string] - Ok"
464
+ `);
465
+ });
466
+
467
+ it("logs alarm messages in pretty format", async () => {
468
+ const api = mockWebsocketAPIs();
469
+ await runWrangler("tail test-worker --format pretty");
470
+
471
+ const event = generateMockAlarmEvent();
472
+ const message = generateMockEventMessage({ event });
473
+ const serializedMessage = serialize(message);
474
+
475
+ api.ws.send(serializedMessage);
476
+ expect(
477
+ std.out
478
+ .replace(
479
+ new Date(mockEventScheduledTime).toLocaleString(),
480
+ "[mock scheduled time]"
481
+ )
482
+ .replace(mockTailExpiration.toISOString(), "[mock expiration date]")
483
+ ).toMatchInlineSnapshot(`
484
+ "Successfully created tail, expires at [mock expiration date]
485
+ Connected to test-worker, waiting for logs...
486
+ Alarm @ [mock scheduled time] - Ok"
487
+ `);
488
+ });
489
+
490
+ it("logs email messages in pretty format", async () => {
491
+ const api = mockWebsocketAPIs();
492
+ await runWrangler("tail test-worker --format pretty");
493
+
494
+ const event = generateMockEmailEvent();
495
+ const message = generateMockEventMessage({ event });
496
+ const serializedMessage = serialize(message);
497
+
498
+ api.ws.send(serializedMessage);
499
+ expect(
500
+ std.out
501
+ .replace(
502
+ new Date(mockEventTimestamp).toLocaleString(),
503
+ "[mock event timestamp]"
504
+ )
505
+ .replace(mockTailExpiration.toISOString(), "[mock expiration date]")
506
+ ).toMatchInlineSnapshot(`
507
+ "Successfully created tail, expires at [mock expiration date]
508
+ Connected to test-worker, waiting for logs...
509
+ Email from:from@example.com to:to@example.com size:45416 @ [mock event timestamp] - Ok"
510
+ `);
511
+ });
512
+
513
+ it("logs tail overload message", async () => {
514
+ const api = mockWebsocketAPIs();
515
+ await runWrangler("tail test-worker --format pretty");
516
+
517
+ const event = generateTailInfo();
518
+ const message = generateMockEventMessage({ event });
519
+ const serializedMessage = serialize(message);
520
+
521
+ api.ws.send(serializedMessage);
522
+ expect(
523
+ std.out.replace(
524
+ mockTailExpiration.toISOString(),
525
+ "[mock expiration date]"
526
+ )
527
+ ).toMatchInlineSnapshot(`
528
+ "Successfully created tail, expires at [mock expiration date]
529
+ Connected to test-worker, waiting for logs...
530
+ Tail is currently in sampling mode due to the high volume of messages. To prevent messages from being dropped consider adding filters."
531
+ `);
532
+ });
533
+
534
+ it("should not crash when the tail message has a void event", async () => {
535
+ const api = mockWebsocketAPIs();
536
+ await runWrangler("tail test-worker --format pretty");
537
+
538
+ const message = generateMockEventMessage({ event: null });
539
+ const serializedMessage = serialize(message);
540
+
541
+ api.ws.send(serializedMessage);
542
+ expect(
543
+ std.out
544
+ .replace(
545
+ new Date(mockEventTimestamp).toLocaleString(),
546
+ "[mock timestamp string]"
547
+ )
548
+ .replace(mockTailExpiration.toISOString(), "[mock expiration date]")
549
+ ).toMatchInlineSnapshot(`
550
+ "Successfully created tail, expires at [mock expiration date]
551
+ Connected to test-worker, waiting for logs...
552
+ Unknown Event - Ok @ [mock timestamp string]"
553
+ `);
554
+ });
555
+
556
+ it("defaults to logging in pretty format when the output is a TTY", async () => {
557
+ setIsTTY(true);
558
+ const api = mockWebsocketAPIs();
559
+ await runWrangler("tail test-worker");
560
+
561
+ const event = generateMockRequestEvent();
562
+ const message = generateMockEventMessage({ event });
563
+ const serializedMessage = serialize(message);
564
+
565
+ api.ws.send(serializedMessage);
566
+ expect(
567
+ std.out
568
+ .replace(
569
+ new Date(mockEventTimestamp).toLocaleString(),
570
+ "[mock event timestamp]"
571
+ )
572
+ .replace(mockTailExpiration.toISOString(), "[mock expiration date]")
573
+ ).toMatchInlineSnapshot(`
574
+ "Successfully created tail, expires at [mock expiration date]
575
+ Connected to test-worker, waiting for logs...
576
+ GET https://example.org/ - Ok @ [mock event timestamp]"
577
+ `);
578
+ });
579
+
580
+ it("defaults to logging in json format when the output is not a TTY", async () => {
581
+ setIsTTY(false);
582
+
583
+ const api = mockWebsocketAPIs();
584
+ await runWrangler("tail test-worker");
585
+
586
+ const event = generateMockRequestEvent();
587
+ const message = generateMockEventMessage({ event });
588
+ const serializedMessage = serialize(message);
589
+
590
+ api.ws.send(serializedMessage);
591
+ expect(std.out).toMatch(deserializeToJson(serializedMessage));
592
+ });
593
+
594
+ it("logs console messages and exceptions", async () => {
595
+ setIsTTY(true);
596
+ const api = mockWebsocketAPIs();
597
+ await runWrangler("tail test-worker");
598
+
599
+ const event = generateMockRequestEvent();
600
+ const message = generateMockEventMessage({
601
+ event,
602
+ logs: [
603
+ { message: ["some string"], level: "log", timestamp: 1234561 },
604
+ {
605
+ message: [{ complex: "object" }],
606
+ level: "log",
607
+ timestamp: 1234562,
608
+ },
609
+ { message: [1234], level: "error", timestamp: 1234563 },
610
+ ],
611
+ exceptions: [
612
+ { name: "Error", message: "some error", timestamp: 1234564 },
613
+ { name: "Error", message: { complex: "error" }, timestamp: 1234564 },
614
+ ],
615
+ });
616
+ const serializedMessage = serialize(message);
617
+
618
+ api.ws.send(serializedMessage);
619
+ expect(
620
+ std.out
621
+ .replace(
622
+ new Date(mockEventTimestamp).toLocaleString(),
623
+ "[mock event timestamp]"
624
+ )
625
+ .replace(mockTailExpiration.toISOString(), "[mock expiration date]")
626
+ ).toMatchInlineSnapshot(`
627
+ "Successfully created tail, expires at [mock expiration date]
628
+ Connected to test-worker, waiting for logs...
629
+ GET https://example.org/ - Ok @ [mock event timestamp]
630
+ (log) some string
631
+ (log) { complex: 'object' }
632
+ (error) 1234"
633
+ `);
634
+ expect(std.err).toMatchInlineSnapshot(`
635
+ "X [ERROR]  Error: some error
636
+
637
+
638
+ X [ERROR]  Error: { complex: 'error' }
639
+
640
+ "
641
+ `);
642
+ expect(std.warn).toMatchInlineSnapshot(`""`);
643
+ });
644
+ });
418
645
  });
419
646
 
420
647
  /* helpers */
@@ -429,45 +656,52 @@ describe("tail", () => {
429
656
  * @returns the same type we expect when deserializing in wrangler
430
657
  */
431
658
  function serialize(message: TailEventMessage): WebSocket.RawData {
432
- if (isScheduled(message.event)) {
433
- // `ScheduledEvent`s work just fine
434
- const stringified = JSON.stringify(message);
435
- return Buffer.from(stringified, "utf-8");
436
- } else {
437
- // Since the "properties" of an `undici.Request` are actually getters,
438
- // which don't serialize properly, we need to hydrate them manually.
439
- // This isn't a problem outside of testing since deserialization
440
- // works just fine and wrangler never _sends_ any event messages,
441
- // it only receives them.
442
- const request = ((message.event as RequestEvent | undefined | null) || {})
443
- .request;
444
- const stringified = JSON.stringify(message, (key, value) => {
445
- if (key !== "request") {
446
- return value;
447
- }
448
-
449
- return {
450
- ...request,
451
- url: request?.url,
452
- headers: request?.headers,
453
- method: request?.method,
454
- };
455
- });
456
-
457
- return Buffer.from(stringified, "utf-8");
458
- }
659
+ if (!isRequest(message.event)) {
660
+ // `ScheduledEvent`s and `TailEvent`s work just fine
661
+ const stringified = JSON.stringify(message);
662
+ return Buffer.from(stringified, "utf-8");
663
+ } else {
664
+ // Since the "properties" of an `undici.Request` are actually getters,
665
+ // which don't serialize properly, we need to hydrate them manually.
666
+ // This isn't a problem outside of testing since deserialization
667
+ // works just fine and wrangler never _sends_ any event messages,
668
+ // it only receives them.
669
+ const request = ((message.event as RequestEvent | undefined | null) || {})
670
+ .request;
671
+ const stringified = JSON.stringify(message, (key, value) => {
672
+ if (key !== "request") {
673
+ return value;
674
+ }
675
+
676
+ return {
677
+ ...request,
678
+ url: request?.url,
679
+ headers: request?.headers,
680
+ method: request?.method,
681
+ };
682
+ });
683
+
684
+ return Buffer.from(stringified, "utf-8");
685
+ }
459
686
  }
460
687
 
461
688
  /**
462
689
  * Small helper to disambiguate the event types possible in a `TailEventMessage`
463
690
  *
464
691
  * @param event A TailEvent
465
- * @returns whether event is a ScheduledEvent (true) or a RequestEvent
692
+ * @returns true if `event` is a RequestEvent
466
693
  */
467
- function isScheduled(
468
- event: ScheduledEvent | RequestEvent | undefined | null
469
- ): event is ScheduledEvent {
470
- return Boolean(event && "cron" in event);
694
+ function isRequest(
695
+ event:
696
+ | ScheduledEvent
697
+ | RequestEvent
698
+ | AlarmEvent
699
+ | EmailEvent
700
+ | TailInfo
701
+ | undefined
702
+ | null
703
+ ): event is RequestEvent {
704
+ return Boolean(event && "request" in event);
471
705
  }
472
706
 
473
707
  /**
@@ -479,7 +713,7 @@ function isScheduled(
479
713
  * @returns a string ready to be printed to the terminal or compared against
480
714
  */
481
715
  function deserializeToJson(message: WebSocket.RawData): string {
482
- return JSON.stringify(JSON.parse(message.toString()), null, 2);
716
+ return JSON.stringify(JSON.parse(message.toString()), null, 2);
483
717
  }
484
718
 
485
719
  /**
@@ -487,12 +721,13 @@ function deserializeToJson(message: WebSocket.RawData): string {
487
721
  * when running `wrangler tail`
488
722
  */
489
723
  type MockAPI = {
490
- requests: {
491
- creation: RequestCounter;
492
- deletion: RequestCounter;
493
- };
494
- ws: MockWebSocket;
495
- nextMessageJson(): Promise<unknown>;
724
+ requests: {
725
+ creation: RequestInit[];
726
+ deletion: RequestCounter;
727
+ };
728
+ ws: MockWebSocket;
729
+ nextMessageJson(): Promise<unknown>;
730
+ closeHelper: () => Promise<void>;
496
731
  };
497
732
 
498
733
  /**
@@ -501,7 +736,7 @@ type MockAPI = {
501
736
  * the correct API calls without actually sending any web traffic
502
737
  */
503
738
  type RequestCounter = {
504
- count: number;
739
+ count: number;
505
740
  };
506
741
 
507
742
  /**
@@ -511,34 +746,39 @@ type RequestCounter = {
511
746
  * @returns a `RequestCounter` for counting how many times the API is hit
512
747
  */
513
748
  function mockCreateTailRequest(
514
- websocketURL: string,
515
- env?: string,
516
- legacyEnv = false
517
- ): RequestCounter {
518
- const requests = { count: 0 };
519
- const servicesOrScripts = env && !legacyEnv ? "services" : "scripts";
520
- const environment = env && !legacyEnv ? "/environments/:envName" : "";
521
- setMockResponse(
522
- `/accounts/:accountId/workers/${servicesOrScripts}/:scriptName${environment}/tails`,
523
- "POST",
524
- ([_url, accountId, scriptName, envName]) => {
525
- requests.count++;
526
- expect(accountId).toEqual("some-account-id");
527
- expect(scriptName).toEqual(
528
- legacyEnv && env ? `test-worker-${env}` : "test-worker"
529
- );
530
- if (!legacyEnv) {
531
- expect(envName).toEqual(env);
532
- }
533
- return {
534
- id: "tail-id",
535
- url: websocketURL,
536
- expires_at: mockTailExpiration,
537
- };
538
- }
539
- );
540
-
541
- return requests;
749
+ websocketURL: string,
750
+ env?: string,
751
+ legacyEnv = false,
752
+ expectedScriptName = legacyEnv && env ? `test-worker-${env}` : "test-worker"
753
+ ): RequestInit[] {
754
+ const requests: RequestInit[] = [];
755
+ const servicesOrScripts = env && !legacyEnv ? "services" : "scripts";
756
+ const environment = env && !legacyEnv ? "/environments/:envName" : "";
757
+ msw.use(
758
+ rest.post(
759
+ `*/accounts/:accountId/workers/${servicesOrScripts}/:scriptName${environment}/tails`,
760
+ async (req, res, ctx) => {
761
+ const request = await req.json();
762
+ requests.push(request);
763
+ expect(req.params.accountId).toEqual("some-account-id");
764
+ expect(req.params.scriptName).toEqual(expectedScriptName);
765
+ if (!legacyEnv) {
766
+ expect(req.params.envName).toEqual(env);
767
+ }
768
+ return res.once(
769
+ ctx.json(
770
+ createFetchResult({
771
+ url: websocketURL,
772
+ id: "tail-id",
773
+ expires_at: mockTailExpiration,
774
+ })
775
+ )
776
+ );
777
+ }
778
+ )
779
+ );
780
+
781
+ return requests;
542
782
  }
543
783
 
544
784
  /**
@@ -551,43 +791,58 @@ const mockTailExpiration = new Date(3005, 1);
551
791
  */
552
792
  const mockEventTimestamp = 1645454470467;
553
793
 
794
+ /**
795
+ * Default value for event time ISO strings
796
+ */
797
+ const mockEventScheduledTime = new Date(mockEventTimestamp).toISOString();
798
+
799
+ /**
800
+ * Default value for email event from
801
+ */
802
+ const mockEmailEventFrom = "from@example.com";
803
+
804
+ /**
805
+ * Default value for email event to
806
+ */
807
+ const mockEmailEventTo = "to@example.com";
808
+
809
+ /**
810
+ * Default value for email event mail size
811
+ */
812
+ const mockEmailEventSize = 45416;
813
+
554
814
  /**
555
815
  * Mock out the API hit during Tail deletion
556
816
  *
557
817
  * @returns a `RequestCounter` for counting how many times the API is hit
558
818
  */
559
819
  function mockDeleteTailRequest(
560
- env?: string,
561
- legacyEnv = false
820
+ env?: string,
821
+ legacyEnv = false,
822
+ expectedScriptName = legacyEnv && env ? `test-worker-${env}` : "test-worker"
562
823
  ): RequestCounter {
563
- const requests = { count: 0 };
564
- const servicesOrScripts = env && !legacyEnv ? "services" : "scripts";
565
- const environment = env && !legacyEnv ? "/environments/:envName" : "";
566
- setMockResponse(
567
- // "/accounts/:accountId/workers/scripts/:worker/tails",
568
- `/accounts/:accountId/workers/${servicesOrScripts}/:scriptName${environment}/tails/:tailId`,
569
- "DELETE",
570
- ([_url, accountId, scriptName, envNameOrTailId, tailId]) => {
571
- requests.count++;
572
- expect(accountId).toEqual("some-account-id");
573
- expect(scriptName).toEqual(
574
- legacyEnv && env ? `test-worker-${env}` : "test-worker"
575
- );
576
- if (!legacyEnv) {
577
- if (env) {
578
- expect(envNameOrTailId).toEqual(env);
579
- expect(tailId).toEqual("tail-id");
580
- } else {
581
- expect(envNameOrTailId).toEqual("tail-id");
582
- }
583
- } else {
584
- expect(envNameOrTailId).toEqual("tail-id");
585
- }
586
- return null;
587
- }
588
- );
589
-
590
- return requests;
824
+ const requests = { count: 0 };
825
+ const servicesOrScripts = env && !legacyEnv ? "services" : "scripts";
826
+ const environment = env && !legacyEnv ? "/environments/:envName" : "";
827
+ msw.use(
828
+ rest.delete(
829
+ `*/accounts/:accountId/workers/${servicesOrScripts}/:scriptName${environment}/tails/:tailId`,
830
+ async (req, res, ctx) => {
831
+ requests.count++;
832
+ expect(req.params.accountId).toEqual("some-account-id");
833
+ expect(req.params.scriptName).toEqual(expectedScriptName);
834
+ if (!legacyEnv) {
835
+ if (env) {
836
+ expect(req.params.tailId).toEqual("tail-id");
837
+ }
838
+ }
839
+ expect(req.params.tailId).toEqual("tail-id");
840
+ return res(ctx.json(createFetchResult(null)));
841
+ }
842
+ )
843
+ );
844
+
845
+ return requests;
591
846
  }
592
847
 
593
848
  const mockWebSockets: MockWebSocket[] = [];
@@ -599,31 +854,53 @@ const mockWebSockets: MockWebSocket[] = [];
599
854
  * @param websocketURL a fake websocket URL for wrangler to connect to
600
855
  * @returns a mocked-out version of the API
601
856
  */
602
- function mockWebsocketAPIs(env?: string, legacyEnv = false): MockAPI {
603
- const websocketURL = "ws://localhost:1234";
604
- const api: MockAPI = {
605
- requests: {
606
- deletion: { count: 0 },
607
- creation: { count: 0 },
608
- },
609
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
610
- ws: null!, // will be set in the `beforeEach()` below.
611
-
612
- /**
613
- * Parse the next message received by the mock websocket as JSON
614
- * @returns JSON.parse of the next message received by the websocket
615
- */
616
- async nextMessageJson() {
617
- const message = await api.ws.nextMessage;
618
- return JSON.parse(message as string);
619
- },
620
- };
621
- api.requests.creation = mockCreateTailRequest(websocketURL, env, legacyEnv);
622
- api.requests.deletion = mockDeleteTailRequest(env, legacyEnv);
623
- api.ws = new MockWebSocket(websocketURL);
624
- mockWebSockets.push(api.ws);
625
-
626
- return api;
857
+ function mockWebsocketAPIs(
858
+ env?: string,
859
+ legacyEnv = false,
860
+ expectedScriptName?: string
861
+ ): MockAPI {
862
+ const websocketURL = "ws://localhost:1234";
863
+ const api: MockAPI = {
864
+ requests: {
865
+ deletion: { count: 0 },
866
+ creation: [],
867
+ },
868
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
869
+ ws: null!, // will be set in the `beforeEach()` below.
870
+
871
+ /**
872
+ * Parse the next message received by the mock websocket as JSON
873
+ * @returns JSON.parse of the next message received by the websocket
874
+ */
875
+ async nextMessageJson() {
876
+ const message = await api.ws.nextMessage;
877
+ return JSON.parse(message as string);
878
+ },
879
+ /**
880
+ * Close the mock websocket and clean up the API.
881
+ * The setTimeout forces a cycle to allow for closing and cleanup
882
+ * @returns a Promise that resolves when the websocket is closed
883
+ */
884
+ async closeHelper() {
885
+ api.ws.close();
886
+ await new Promise((resolve) => setTimeout(resolve, 0));
887
+ },
888
+ };
889
+ api.requests.creation = mockCreateTailRequest(
890
+ websocketURL,
891
+ env,
892
+ legacyEnv,
893
+ expectedScriptName
894
+ );
895
+ api.requests.deletion = mockDeleteTailRequest(
896
+ env,
897
+ legacyEnv,
898
+ expectedScriptName
899
+ );
900
+ api.ws = new MockWebSocket(websocketURL);
901
+ mockWebSockets.push(api.ws);
902
+
903
+ return api;
627
904
  }
628
905
 
629
906
  /**
@@ -634,19 +911,19 @@ function mockWebsocketAPIs(env?: string, legacyEnv = false): MockAPI {
634
911
  * @returns a `TailEventMessage` that wrangler can process and display
635
912
  */
636
913
  function generateMockEventMessage({
637
- outcome = "ok",
638
- exceptions = [],
639
- logs = [],
640
- eventTimestamp = mockEventTimestamp,
641
- event = generateMockRequestEvent(),
914
+ outcome = "ok",
915
+ exceptions = [],
916
+ logs = [],
917
+ eventTimestamp = mockEventTimestamp,
918
+ event = generateMockRequestEvent(),
642
919
  }: Partial<TailEventMessage>): TailEventMessage {
643
- return {
644
- outcome,
645
- exceptions,
646
- logs,
647
- eventTimestamp,
648
- event,
649
- };
920
+ return {
921
+ outcome,
922
+ exceptions,
923
+ logs,
924
+ eventTimestamp,
925
+ event,
926
+ };
650
927
  }
651
928
 
652
929
  /**
@@ -657,34 +934,56 @@ function generateMockEventMessage({
657
934
  * @returns a `RequestEvent` that can be used within an `EventMessage`
658
935
  */
659
936
  function generateMockRequestEvent(
660
- opts?: Partial<RequestEvent["request"]>
937
+ opts?: Partial<RequestEvent["request"]>
661
938
  ): RequestEvent {
662
- return {
663
- request: Object.assign(
664
- new Request(opts?.url || "https://example.org/", {
665
- method: opts?.method || "GET",
666
- headers:
667
- opts?.headers || new Headers({ "X-EXAMPLE-HEADER": "some_value" }),
668
- }),
669
- {
670
- cf: opts?.cf || {
671
- tlsCipher: "AEAD-ENCRYPT-O-MATIC-SHA",
672
- tlsVersion: "TLSv2.0",
673
- asn: 42069,
674
- colo: "ATL",
675
- httpProtocol: "HTTP/4",
676
- asOrganization: "Cloudflare",
677
- },
678
- }
679
- ),
680
- };
939
+ return {
940
+ request: Object.assign(
941
+ new Request(opts?.url || "https://example.org/", {
942
+ method: opts?.method || "GET",
943
+ headers:
944
+ opts?.headers || new Headers({ "X-EXAMPLE-HEADER": "some_value" }),
945
+ }),
946
+ {
947
+ cf: opts?.cf || {
948
+ tlsCipher: "AEAD-ENCRYPT-O-MATIC-SHA",
949
+ tlsVersion: "TLSv2.0",
950
+ asn: 42069,
951
+ colo: "ATL",
952
+ httpProtocol: "HTTP/4",
953
+ asOrganization: "Cloudflare",
954
+ },
955
+ }
956
+ ),
957
+ };
681
958
  }
682
959
 
683
960
  function generateMockScheduledEvent(
684
- opts?: Partial<ScheduledEvent>
961
+ opts?: Partial<ScheduledEvent>
685
962
  ): ScheduledEvent {
686
- return {
687
- cron: opts?.cron || "* * * * *",
688
- scheduledTime: opts?.scheduledTime || mockEventTimestamp,
689
- };
963
+ return {
964
+ cron: opts?.cron || "* * * * *",
965
+ scheduledTime: opts?.scheduledTime || mockEventTimestamp,
966
+ };
967
+ }
968
+
969
+ function generateMockAlarmEvent(opts?: Partial<AlarmEvent>): AlarmEvent {
970
+ return {
971
+ scheduledTime: opts?.scheduledTime || mockEventScheduledTime,
972
+ };
973
+ }
974
+
975
+ function generateMockEmailEvent(opts?: Partial<EmailEvent>): EmailEvent {
976
+ return {
977
+ mailFrom: opts?.mailFrom || mockEmailEventFrom,
978
+ rcptTo: opts?.rcptTo || mockEmailEventTo,
979
+ rawSize: opts?.rawSize || mockEmailEventSize,
980
+ };
981
+ }
982
+
983
+ function generateTailInfo(): TailInfo {
984
+ return {
985
+ message:
986
+ "Tail is currently in sampling mode due to the high volume of messages. To prevent messages from being dropped consider adding filters.",
987
+ type: "overload",
988
+ };
690
989
  }