wrangler 0.0.0-e64812e → 0.0.0-e7a0cd5b

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