wrangler 0.0.0-e3e3243 → 0.0.0-e4047cab

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