wrangler 0.0.0-e64812e → 0.0.0-e8e684c7

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