wrangler 0.0.0-e351afcf → 0.0.0-e3990bbf

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