wrangler 0.0.0-e2f9bb2 → 0.0.0-e305903a

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