wrangler 0.0.0-e5a3814 → 0.0.0-e60dc909

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