wrangler 0.0.0-e87ad068 → 0.0.0-e89ee2a5

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