wrangler 0.0.0-e61fba8 → 0.0.0-e665ccc3

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 (339) hide show
  1. package/README.md +24 -4
  2. package/bin/wrangler.js +170 -62
  3. package/miniflare-dist/index.mjs +1643 -83
  4. package/package.json +198 -154
  5. package/src/__tests__/access.test.ts +25 -0
  6. package/src/__tests__/api-dev.test.ts +238 -0
  7. package/src/__tests__/api-devregistry.test.ts +121 -0
  8. package/src/__tests__/api.test.ts +102 -0
  9. package/src/__tests__/config-cache-without-cache-dir.test.ts +38 -0
  10. package/src/__tests__/config-cache.test.ts +30 -24
  11. package/src/__tests__/configuration.test.ts +4506 -3476
  12. package/src/__tests__/constellation.test.ts +371 -0
  13. package/src/__tests__/d1/d1.test.ts +82 -0
  14. package/src/__tests__/d1/execute.test.ts +66 -0
  15. package/src/__tests__/d1/migrate.test.ts +257 -0
  16. package/src/__tests__/d1/splitter.test.ts +255 -0
  17. package/src/__tests__/delete.test.ts +272 -0
  18. package/src/__tests__/deployments.test.ts +369 -0
  19. package/src/__tests__/dev.test.tsx +1590 -983
  20. package/src/__tests__/generate.test.ts +237 -0
  21. package/src/__tests__/get-host-from-url.test.ts +16 -0
  22. package/src/__tests__/guess-worker-format.test.ts +103 -68
  23. package/src/__tests__/helpers/cmd-shim.d.ts +6 -6
  24. package/src/__tests__/helpers/end-event-loop.ts +6 -0
  25. package/src/__tests__/helpers/mock-account-id.ts +24 -24
  26. package/src/__tests__/helpers/mock-auth-domain.ts +20 -0
  27. package/src/__tests__/helpers/mock-bin.ts +20 -20
  28. package/src/__tests__/helpers/mock-console.ts +64 -39
  29. package/src/__tests__/helpers/mock-dialogs.ts +88 -79
  30. package/src/__tests__/helpers/mock-get-pages-upload-token.ts +25 -0
  31. package/src/__tests__/helpers/mock-get-zone-from-host.ts +11 -0
  32. package/src/__tests__/helpers/mock-http-server.ts +30 -30
  33. package/src/__tests__/helpers/mock-istty.ts +65 -18
  34. package/src/__tests__/helpers/mock-known-routes.ts +12 -0
  35. package/src/__tests__/helpers/mock-kv.ts +41 -28
  36. package/src/__tests__/helpers/mock-oauth-flow.ts +241 -233
  37. package/src/__tests__/helpers/mock-process.ts +34 -0
  38. package/src/__tests__/helpers/mock-set-timeout.ts +16 -0
  39. package/src/__tests__/helpers/mock-stdin.ts +82 -77
  40. package/src/__tests__/helpers/mock-web-socket.ts +21 -21
  41. package/src/__tests__/helpers/msw/blob-worker.cjs +19 -0
  42. package/src/__tests__/helpers/msw/handlers/access.ts +13 -0
  43. package/src/__tests__/helpers/msw/handlers/deployments.ts +160 -0
  44. package/src/__tests__/helpers/msw/handlers/namespaces.ts +81 -0
  45. package/src/__tests__/helpers/msw/handlers/oauth.ts +31 -0
  46. package/src/__tests__/helpers/msw/handlers/r2.ts +60 -0
  47. package/src/__tests__/helpers/msw/handlers/script.ts +56 -0
  48. package/src/__tests__/helpers/msw/handlers/user.ts +52 -0
  49. package/src/__tests__/helpers/msw/handlers/zones.ts +20 -0
  50. package/src/__tests__/helpers/msw/index.ts +52 -0
  51. package/src/__tests__/helpers/msw/read-file-sync.js +61 -0
  52. package/src/__tests__/helpers/run-in-tmp.ts +27 -28
  53. package/src/__tests__/helpers/run-wrangler.ts +8 -8
  54. package/src/__tests__/helpers/string-dynamic-values-matcher.ts +28 -0
  55. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +1 -0
  56. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +5 -0
  57. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +1 -0
  58. package/src/__tests__/helpers/worker-scripts/parent-worker.js +11 -0
  59. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +5 -0
  60. package/src/__tests__/helpers/write-worker-source.ts +16 -16
  61. package/src/__tests__/helpers/write-wrangler-toml.ts +9 -9
  62. package/src/__tests__/https-options.test.ts +142 -109
  63. package/src/__tests__/index.test.ts +262 -237
  64. package/src/__tests__/init.test.ts +3167 -1608
  65. package/src/__tests__/jest.setup.ts +152 -50
  66. package/src/__tests__/kv.test.ts +1789 -1492
  67. package/src/__tests__/logger.test.ts +167 -75
  68. package/src/__tests__/logout.test.ts +47 -0
  69. package/src/__tests__/metrics.test.ts +493 -0
  70. package/src/__tests__/middleware.scheduled.test.ts +145 -0
  71. package/src/__tests__/middleware.test.ts +816 -0
  72. package/src/__tests__/mtls-certificates.test.ts +589 -0
  73. package/src/__tests__/package-manager.test.ts +303 -303
  74. package/src/__tests__/pages/deployment-list.test.ts +80 -0
  75. package/src/__tests__/pages/functions-build.test.ts +528 -0
  76. package/src/__tests__/pages/pages.test.ts +81 -0
  77. package/src/__tests__/pages/project-create.test.ts +63 -0
  78. package/src/__tests__/pages/project-list.test.ts +110 -0
  79. package/src/__tests__/pages/project-upload.test.ts +500 -0
  80. package/src/__tests__/pages/publish.test.ts +2864 -0
  81. package/src/__tests__/pages-deployment-tail.test.ts +957 -0
  82. package/src/__tests__/parse.test.ts +358 -252
  83. package/src/__tests__/paths.test.ts +39 -0
  84. package/src/__tests__/publish.test.ts +8716 -5687
  85. package/src/__tests__/pubsub.test.ts +496 -0
  86. package/src/__tests__/queues.test.ts +532 -0
  87. package/src/__tests__/r2.test.ts +369 -228
  88. package/src/__tests__/route.test.ts +18 -18
  89. package/src/__tests__/secret.test.ts +681 -469
  90. package/src/__tests__/tail.test.ts +866 -567
  91. package/src/__tests__/test-old-node-version.js +31 -0
  92. package/src/__tests__/traverse-module-graph.test.ts +220 -0
  93. package/src/__tests__/tsconfig-sanity.ts +12 -0
  94. package/src/__tests__/tsconfig.json +8 -0
  95. package/src/__tests__/tsconfig.tsbuildinfo +1 -0
  96. package/src/__tests__/type-generation.test.ts +234 -0
  97. package/src/__tests__/user.test.ts +107 -120
  98. package/src/__tests__/utils-collectKeyValues.test.ts +47 -0
  99. package/src/__tests__/validate-dev-props.test.ts +56 -0
  100. package/src/__tests__/version.test.ts +35 -0
  101. package/src/__tests__/whoami.test.tsx +165 -132
  102. package/src/__tests__/worker-namespace.test.ts +340 -0
  103. package/src/abort.d.ts +1 -1
  104. package/src/api/dev.ts +321 -0
  105. package/src/api/index.ts +11 -0
  106. package/src/api/mtls-certificate.ts +148 -0
  107. package/src/api/pages/create-worker-bundle-contents.ts +77 -0
  108. package/src/api/pages/index.ts +5 -0
  109. package/src/api/pages/publish.tsx +371 -0
  110. package/src/bundle-reporter.ts +68 -0
  111. package/src/bundle.ts +890 -165
  112. package/src/cfetch/index.ts +120 -83
  113. package/src/cfetch/internal.ts +208 -92
  114. package/src/cli.ts +23 -8
  115. package/src/config/config.ts +244 -196
  116. package/src/config/diagnostics.ts +61 -61
  117. package/src/config/environment.ts +562 -357
  118. package/src/config/index.ts +374 -196
  119. package/src/config/validation-helpers.ts +379 -366
  120. package/src/config/validation.ts +2197 -1376
  121. package/src/config-cache.ts +81 -41
  122. package/src/constellation/createProject.tsx +51 -0
  123. package/src/constellation/deleteProject.ts +51 -0
  124. package/src/constellation/deleteProjectModel.ts +68 -0
  125. package/src/constellation/index.ts +75 -0
  126. package/src/constellation/listCatalog.tsx +35 -0
  127. package/src/constellation/listModel.tsx +41 -0
  128. package/src/constellation/listProject.tsx +28 -0
  129. package/src/constellation/listRuntime.tsx +28 -0
  130. package/src/constellation/options.ts +17 -0
  131. package/src/constellation/types.ts +17 -0
  132. package/src/constellation/uploadModel.tsx +64 -0
  133. package/src/constellation/utils.ts +90 -0
  134. package/src/create-worker-preview.ts +250 -142
  135. package/src/create-worker-upload-form.ts +347 -238
  136. package/src/d1/backups.tsx +219 -0
  137. package/src/d1/constants.ts +2 -0
  138. package/src/d1/create.tsx +70 -0
  139. package/src/d1/delete.ts +53 -0
  140. package/src/d1/execute.tsx +357 -0
  141. package/src/d1/formatTimeAgo.ts +14 -0
  142. package/src/d1/index.ts +100 -0
  143. package/src/d1/list.tsx +62 -0
  144. package/src/d1/migrations/apply.tsx +212 -0
  145. package/src/d1/migrations/create.tsx +79 -0
  146. package/src/d1/migrations/helpers.ts +169 -0
  147. package/src/d1/migrations/index.ts +3 -0
  148. package/src/d1/migrations/list.tsx +95 -0
  149. package/src/d1/migrations/options.ts +23 -0
  150. package/src/d1/options.ts +22 -0
  151. package/src/d1/splitter.ts +161 -0
  152. package/src/d1/types.ts +25 -0
  153. package/src/d1/utils.ts +49 -0
  154. package/src/delete.ts +100 -0
  155. package/src/deployments.ts +368 -0
  156. package/src/deprecated/index.ts +144 -0
  157. package/src/dev/dev-vars.ts +20 -17
  158. package/src/dev/dev.tsx +535 -325
  159. package/src/dev/get-local-persistence-path.ts +31 -0
  160. package/src/dev/local.tsx +932 -301
  161. package/src/dev/remote.tsx +623 -228
  162. package/src/dev/start-server.ts +545 -0
  163. package/src/dev/use-esbuild.ts +194 -94
  164. package/src/dev/validate-dev-props.ts +40 -0
  165. package/src/dev-registry.ts +202 -0
  166. package/src/dev.tsx +934 -0
  167. package/src/dialogs.ts +136 -0
  168. package/src/dispatch-namespace.ts +211 -0
  169. package/src/docs/helpers.ts +50 -0
  170. package/src/docs/index.ts +54 -0
  171. package/src/durable.ts +87 -87
  172. package/src/entry.ts +253 -231
  173. package/src/environment-variables/factory.ts +89 -0
  174. package/src/environment-variables/misc-variables.ts +30 -0
  175. package/src/errors.ts +6 -6
  176. package/src/generate/index.ts +298 -0
  177. package/src/git-client.ts +135 -0
  178. package/src/global-wrangler-config-path.ts +26 -0
  179. package/src/https-options.ts +84 -80
  180. package/src/index.ts +768 -0
  181. package/src/init.ts +1037 -0
  182. package/src/inspect.ts +816 -595
  183. package/src/intl-polyfill.d.ts +123 -123
  184. package/src/is-ci.ts +14 -0
  185. package/src/is-interactive.ts +16 -0
  186. package/src/jest.d.ts +4 -0
  187. package/src/kv/helpers.ts +433 -0
  188. package/src/kv/index.ts +594 -0
  189. package/src/logger.ts +100 -43
  190. package/src/metrics/index.ts +5 -0
  191. package/src/metrics/metrics-config.ts +239 -0
  192. package/src/metrics/metrics-dispatcher.ts +96 -0
  193. package/src/metrics/metrics-usage-headers.ts +24 -0
  194. package/src/metrics/send-event.ts +99 -0
  195. package/src/miniflare-cli/assets.ts +255 -0
  196. package/src/miniflare-cli/index.ts +202 -33
  197. package/src/miniflare-cli/request-context.ts +18 -18
  198. package/src/miniflare-cli/tsconfig.json +9 -0
  199. package/src/miniflare-cli/tsconfig.tsbuildinfo +1 -0
  200. package/src/miniflare-cli/types.ts +11 -0
  201. package/src/module-collection.ts +290 -215
  202. package/src/mtls-certificate/cli.ts +155 -0
  203. package/src/open-in-browser.ts +4 -6
  204. package/src/package-manager.ts +173 -128
  205. package/src/pages/build.ts +423 -0
  206. package/src/pages/buildFunctions.ts +140 -0
  207. package/src/pages/constants.ts +18 -0
  208. package/src/pages/deployment-tails.ts +281 -0
  209. package/src/pages/deployments.tsx +84 -0
  210. package/src/pages/dev.ts +734 -0
  211. package/src/pages/errors.ts +67 -0
  212. package/src/pages/functions/buildPlugin.ts +114 -0
  213. package/src/pages/functions/buildWorker.ts +350 -0
  214. package/{pages → src/pages}/functions/filepath-routing.test.ts +113 -113
  215. package/src/pages/functions/filepath-routing.ts +189 -0
  216. package/src/pages/functions/identifiers.ts +78 -0
  217. package/src/pages/functions/routes-consolidation.test.ts +250 -0
  218. package/src/pages/functions/routes-consolidation.ts +73 -0
  219. package/src/pages/functions/routes-transformation.test.ts +282 -0
  220. package/src/pages/functions/routes-transformation.ts +115 -0
  221. package/src/pages/functions/routes-validation.test.ts +403 -0
  222. package/src/pages/functions/routes-validation.ts +202 -0
  223. package/src/pages/functions/routes.ts +151 -0
  224. package/src/pages/functions/tsconfig.json +8 -0
  225. package/src/pages/functions/tsconfig.tsbuildinfo +1 -0
  226. package/src/pages/functions.ts +86 -0
  227. package/src/pages/hash.ts +13 -0
  228. package/src/pages/index.ts +102 -0
  229. package/src/pages/projects.tsx +159 -0
  230. package/src/pages/prompt-select-project.tsx +31 -0
  231. package/src/pages/publish.tsx +267 -0
  232. package/src/pages/types.ts +46 -0
  233. package/src/pages/upload.tsx +469 -0
  234. package/src/pages/utils.ts +23 -0
  235. package/src/parse.ts +225 -139
  236. package/src/paths.ts +53 -8
  237. package/src/proxy.ts +623 -407
  238. package/src/publish/index.ts +274 -0
  239. package/src/publish/publish.ts +1065 -0
  240. package/src/pubsub/index.ts +286 -0
  241. package/src/pubsub/pubsub-commands.ts +623 -0
  242. package/src/queues/cli/commands/consumer/add.ts +71 -0
  243. package/src/queues/cli/commands/consumer/index.ts +19 -0
  244. package/src/queues/cli/commands/consumer/remove.ts +31 -0
  245. package/src/queues/cli/commands/create.ts +25 -0
  246. package/src/queues/cli/commands/delete.ts +26 -0
  247. package/src/queues/cli/commands/index.ts +35 -0
  248. package/src/queues/cli/commands/list.ts +25 -0
  249. package/src/queues/client.ts +136 -0
  250. package/src/queues/utils.ts +18 -0
  251. package/src/r2/constants.ts +4 -0
  252. package/src/r2/helpers.ts +132 -0
  253. package/src/r2/index.ts +289 -0
  254. package/src/routes.ts +140 -0
  255. package/src/secret/index.ts +377 -0
  256. package/src/selfsigned.d.ts +23 -23
  257. package/src/sites.ts +484 -0
  258. package/src/tail/createTail.ts +415 -0
  259. package/src/tail/filters.ts +109 -111
  260. package/src/tail/index.ts +208 -296
  261. package/src/tail/printing.ts +116 -51
  262. package/src/traverse-module-graph.ts +54 -0
  263. package/src/tsconfig-sanity.ts +16 -0
  264. package/src/type-generation.ts +181 -0
  265. package/src/update-check.ts +11 -11
  266. package/src/user/access.ts +68 -0
  267. package/src/user/auth-variables.ts +113 -0
  268. package/src/user/choose-account.tsx +39 -0
  269. package/src/user/generate-auth-url.ts +33 -0
  270. package/src/user/generate-random-state.ts +16 -0
  271. package/src/user/index.ts +2 -0
  272. package/src/user/user.ts +1234 -0
  273. package/src/utils/collectKeyValues.ts +14 -0
  274. package/src/utils/render.ts +93 -0
  275. package/src/whoami.ts +135 -0
  276. package/src/worker.ts +205 -107
  277. package/src/yargs-types.ts +37 -0
  278. package/src/zones.ts +158 -40
  279. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  280. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  281. package/templates/__tests__/tsconfig.json +8 -0
  282. package/templates/__tests__/tsconfig.tsbuildinfo +1 -0
  283. package/templates/checked-fetch.js +23 -0
  284. package/templates/d1-beta-facade.js +244 -0
  285. package/templates/facade.d.ts +14 -0
  286. package/templates/first-party-worker-module-facade.ts +19 -0
  287. package/templates/format-dev-errors.ts +34 -0
  288. package/templates/gitignore +1 -0
  289. package/templates/init-tests/test-jest-new-worker.js +23 -0
  290. package/templates/init-tests/test-vitest-new-worker.js +24 -0
  291. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  292. package/templates/middleware/common.ts +62 -0
  293. package/templates/middleware/loader-modules.ts +84 -0
  294. package/templates/middleware/loader-sw.ts +233 -0
  295. package/templates/middleware/middleware-miniflare3-json-error.ts +32 -0
  296. package/templates/middleware/middleware-pretty-error.ts +40 -0
  297. package/templates/middleware/middleware-scheduled.ts +15 -0
  298. package/templates/new-worker-scheduled.js +3 -3
  299. package/templates/new-worker-scheduled.ts +15 -15
  300. package/templates/new-worker.js +3 -3
  301. package/templates/new-worker.ts +18 -15
  302. package/templates/no-op-worker.js +10 -0
  303. package/templates/pages-dev-pipeline.ts +31 -0
  304. package/templates/pages-dev-util.ts +52 -0
  305. package/templates/pages-shim.ts +12 -0
  306. package/templates/pages-template-plugin.ts +180 -0
  307. package/templates/pages-template-worker.ts +189 -0
  308. package/templates/serve-static-assets.ts +66 -0
  309. package/templates/service-bindings-module-facade.js +55 -0
  310. package/templates/service-bindings-sw-facade.js +42 -0
  311. package/templates/tsconfig-sanity.ts +11 -0
  312. package/templates/tsconfig.init.json +105 -0
  313. package/templates/tsconfig.json +6 -103
  314. package/templates/tsconfig.tsbuildinfo +1 -0
  315. package/wrangler-dist/cli.d.ts +1652 -0
  316. package/wrangler-dist/cli.js +139094 -111923
  317. package/wrangler-dist/wasm-sync.wasm +0 -0
  318. package/pages/functions/buildPlugin.ts +0 -105
  319. package/pages/functions/buildWorker.ts +0 -151
  320. package/pages/functions/filepath-routing.ts +0 -189
  321. package/pages/functions/identifiers.ts +0 -78
  322. package/pages/functions/routes.ts +0 -156
  323. package/pages/functions/template-plugin.ts +0 -147
  324. package/pages/functions/template-worker.ts +0 -143
  325. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  326. package/src/__tests__/helpers/mock-cfetch.ts +0 -211
  327. package/src/__tests__/pages.test.ts +0 -754
  328. package/src/dialogs.tsx +0 -135
  329. package/src/environment-variables.ts +0 -35
  330. package/src/index.tsx +0 -2859
  331. package/src/kv.ts +0 -408
  332. package/src/miniflare-cli/enum-keys.ts +0 -17
  333. package/src/pages.tsx +0 -2093
  334. package/src/publish.ts +0 -721
  335. package/src/r2.ts +0 -50
  336. package/src/sites.tsx +0 -326
  337. package/src/user.tsx +0 -1214
  338. package/src/whoami.tsx +0 -71
  339. package/templates/static-asset-facade.js +0 -43
@@ -0,0 +1,415 @@
1
+ import WebSocket from "ws";
2
+ import { version as packageVersion } from "../../package.json";
3
+ import { fetchResult } from "../cfetch";
4
+ import type { TailFilterMessage, Outcome } from "./filters";
5
+ export type { TailCLIFilters } from "./filters";
6
+ export { translateCLICommandToFilterMessage } from "./filters";
7
+ export { jsonPrintLogs, prettyPrintLogs } from "./printing";
8
+ import type { Request } from "undici";
9
+
10
+ const TRACE_VERSION = "trace-v1";
11
+
12
+ /**
13
+ * When creating a Tail, the response from the API contains
14
+ * - an ID used for identifying the tail
15
+ * - a URL to a WebSocket connection available for the tail to connect to
16
+ * - an expiration date when the tail is no longer guaranteed to be valid
17
+ */
18
+ type TailCreationApiResponse = {
19
+ id: string;
20
+ url: string;
21
+ expires_at: Date;
22
+ };
23
+
24
+ /**
25
+ * Generate a URL that, when `cfetch`ed, creates a tail.
26
+ *
27
+ * https://api.cloudflare.com/#worker-tail-logs-start-tail
28
+ *
29
+ * @param accountId the account ID associated with the worker to tail
30
+ * @param workerName the name of the worker to tail
31
+ * @returns a `cfetch`-ready URL for creating a new tail
32
+ */
33
+ function makeCreateTailUrl(
34
+ accountId: string,
35
+ workerName: string,
36
+ env: string | undefined
37
+ ): string {
38
+ return env
39
+ ? `/accounts/${accountId}/workers/services/${workerName}/environments/${env}/tails`
40
+ : `/accounts/${accountId}/workers/scripts/${workerName}/tails`;
41
+ }
42
+
43
+ /**
44
+ * Generate a URL that, when `cfetch`ed, deletes a tail
45
+ *
46
+ * https://api.cloudflare.com/#worker-tail-logs-delete-tail
47
+ *
48
+ * @param accountId the account ID associated with the worker we're tailing
49
+ * @param workerName the name of the worker we're tailing
50
+ * @param tailId the ID of the tail we want to delete
51
+ * @returns a `cfetch`-ready URL for deleting a tail
52
+ */
53
+ function makeDeleteTailUrl(
54
+ accountId: string,
55
+ workerName: string,
56
+ tailId: string,
57
+ env: string | undefined
58
+ ): string {
59
+ return env
60
+ ? `/accounts/${accountId}/workers/services/${workerName}/environments/${env}/tails/${tailId}`
61
+ : `/accounts/${accountId}/workers/scripts/${workerName}/tails/${tailId}`;
62
+ }
63
+
64
+ interface CreatePagesTailOptions {
65
+ accountId: string;
66
+ projectName: string;
67
+ deploymentId: string;
68
+ filters: TailFilterMessage;
69
+ debug?: boolean;
70
+ }
71
+
72
+ /**
73
+ * Create and connect to a Pages Function Tail.
74
+ *
75
+ * Under the hood, this function
76
+ * - Registers a new Tail with the API
77
+ * - Connects to the tail worker
78
+ * - Sends any filters over the connection
79
+ *
80
+ * @returns a websocket connection, an expiration, and a function to call to delete the tail
81
+ */
82
+ export async function createPagesTail({
83
+ accountId,
84
+ projectName,
85
+ deploymentId,
86
+ filters,
87
+ debug = false,
88
+ }: CreatePagesTailOptions) {
89
+ const tailRecord = await fetchResult<TailCreationApiResponse>(
90
+ `/accounts/${accountId}/pages/projects/${projectName}/deployments/${deploymentId}/tails`,
91
+ {
92
+ method: "POST",
93
+ body: JSON.stringify(filters),
94
+ }
95
+ );
96
+
97
+ const deleteTail = async () =>
98
+ fetchResult(
99
+ `/accounts/${accountId}/pages/projects/${projectName}/deployments/${deploymentId}/tails/${tailRecord.id}`,
100
+ { method: "DELETE" }
101
+ );
102
+
103
+ const tail = new WebSocket(tailRecord.url, TRACE_VERSION, {
104
+ headers: {
105
+ "Sec-WebSocket-Protocol": TRACE_VERSION, // needs to be `trace-v1` to be accepted
106
+ "User-Agent": `wrangler-js/${packageVersion}`,
107
+ },
108
+ });
109
+
110
+ // send filters when we open up
111
+ tail.on("open", () => {
112
+ tail.send(
113
+ JSON.stringify({ debug: debug }),
114
+ { binary: false, compress: false, mask: false, fin: true },
115
+ (err) => {
116
+ if (err) {
117
+ throw err;
118
+ }
119
+ }
120
+ );
121
+ });
122
+
123
+ return { tail, deleteTail, expiration: tailRecord.expires_at };
124
+ }
125
+
126
+ /**
127
+ * Create and connect to a tail.
128
+ *
129
+ * Under the hood, this function
130
+ * - Registers a new Tail with the API
131
+ * - Connects to the tail worker
132
+ * - Sends any filters over the connection
133
+ *
134
+ * @param accountId the account ID associated with the worker to tail
135
+ * @param workerName the name of the worker to tail
136
+ * @param filters A list of `TailAPIFilters` given to the tail
137
+ * @param debug Flag to run tail in debug mode
138
+ * @returns a websocket connection, an expiration, and a function to call to delete the tail
139
+ */
140
+ export async function createTail(
141
+ accountId: string,
142
+ workerName: string,
143
+ filters: TailFilterMessage,
144
+ debug: boolean,
145
+ env: string | undefined
146
+ ): Promise<{
147
+ tail: WebSocket;
148
+ expiration: Date;
149
+ deleteTail: () => Promise<void>;
150
+ }> {
151
+ // create the tail
152
+ const createTailUrl = makeCreateTailUrl(accountId, workerName, env);
153
+ const {
154
+ id: tailId,
155
+ url: websocketUrl,
156
+ expires_at: expiration,
157
+ } = await fetchResult<TailCreationApiResponse>(createTailUrl, {
158
+ method: "POST",
159
+ body: JSON.stringify(filters),
160
+ });
161
+
162
+ // delete the tail (not yet!)
163
+ const deleteUrl = makeDeleteTailUrl(accountId, workerName, tailId, env);
164
+ async function deleteTail() {
165
+ await fetchResult(deleteUrl, { method: "DELETE" });
166
+ }
167
+
168
+ // connect to the tail
169
+ const tail = new WebSocket(websocketUrl, TRACE_VERSION, {
170
+ headers: {
171
+ "Sec-WebSocket-Protocol": TRACE_VERSION, // needs to be `trace-v1` to be accepted
172
+ "User-Agent": `wrangler-js/${packageVersion}`,
173
+ },
174
+ });
175
+
176
+ // send filters when we open up
177
+ tail.on("open", function () {
178
+ tail.send(
179
+ JSON.stringify({ debug: debug }),
180
+ { binary: false, compress: false, mask: false, fin: true },
181
+ (err) => {
182
+ if (err) {
183
+ throw err;
184
+ }
185
+ }
186
+ );
187
+ });
188
+
189
+ return { tail, expiration, deleteTail };
190
+ }
191
+
192
+ /**
193
+ * Everything captured by the trace worker and sent to us via
194
+ * `wrangler tail` is structured JSON that deserializes to this type.
195
+ */
196
+ export type TailEventMessage = {
197
+ /**
198
+ * Whether the execution of this worker succeeded or failed
199
+ */
200
+ outcome: Outcome;
201
+
202
+ /**
203
+ * The name of the script we're tailing
204
+ */
205
+ scriptName?: string;
206
+
207
+ /**
208
+ * Any exceptions raised by the worker
209
+ */
210
+ exceptions: {
211
+ /**
212
+ * The name of the exception.
213
+ */
214
+ name: string;
215
+
216
+ /**
217
+ * The error message
218
+ */
219
+ message: unknown;
220
+
221
+ /**
222
+ * When the exception was raised/thrown
223
+ */
224
+ timestamp: number;
225
+ }[];
226
+
227
+ /**
228
+ * Any logs sent out by the worker
229
+ */
230
+ logs: {
231
+ message: unknown[];
232
+ level: string; // TODO: make this a union of possible values
233
+ timestamp: number;
234
+ }[];
235
+
236
+ /**
237
+ * When the event was triggered
238
+ */
239
+ eventTimestamp: number;
240
+
241
+ /**
242
+ * The event that triggered the worker. In the case of an HTTP request,
243
+ * this will be a RequestEvent. If it's a cron trigger, it'll be a
244
+ * ScheduledEvent. If it's a durable object alarm, it's an AlarmEvent.
245
+ * If it's a email, it'a an EmailEvent
246
+ *
247
+ * Until workers-types exposes individual types for export, we'll have
248
+ * to just re-define these types ourselves.
249
+ */
250
+ event:
251
+ | RequestEvent
252
+ | ScheduledEvent
253
+ | AlarmEvent
254
+ | EmailEvent
255
+ | TailInfo
256
+ | undefined
257
+ | null;
258
+ };
259
+
260
+ /**
261
+ * A request that triggered worker execution
262
+ */
263
+
264
+ export type RequestEvent = {
265
+ request: Pick<Request, "url" | "method" | "headers"> & {
266
+ /**
267
+ * Cloudflare-specific properties
268
+ * https://developers.cloudflare.com/workers/runtime-apis/request#incomingrequestcfproperties
269
+ */
270
+ cf: {
271
+ /**
272
+ * How long (in ms) it took for the client's TCP connection to make a
273
+ * round trip to the worker and back. For all my gamers out there,
274
+ * this is the request's ping
275
+ */
276
+ clientTcpRtt?: number;
277
+
278
+ /**
279
+ * Longitude and Latitude of where the request originated from
280
+ */
281
+ longitude?: string;
282
+ latitude?: string;
283
+
284
+ /**
285
+ * What cipher was used to establish the TLS connection
286
+ */
287
+ tlsCipher: string;
288
+
289
+ /**
290
+ * Which continent the request came from.
291
+ */
292
+ continent?: "NA";
293
+
294
+ /**
295
+ * ASN of the incoming request
296
+ */
297
+ asn: number;
298
+
299
+ /**
300
+ * The country the incoming request is coming from
301
+ */
302
+ country?: string;
303
+
304
+ /**
305
+ * The TLS version the connection used
306
+ */
307
+ tlsVersion: string;
308
+
309
+ /**
310
+ * The colo that processed the request (i.e. the airport code
311
+ * of the closest city to the server that spun up the worker)
312
+ */
313
+ colo: string;
314
+
315
+ /**
316
+ * The timezone where the request came from
317
+ */
318
+ timezone?: string;
319
+
320
+ /**
321
+ * The city where the request came from
322
+ */
323
+ city?: string;
324
+
325
+ /**
326
+ * The browser-requested prioritization information in the request object
327
+ */
328
+ requestPriority?: string;
329
+
330
+ /**
331
+ * Which version of HTTP the request came over e.g. "HTTP/2"
332
+ */
333
+ httpProtocol: string;
334
+
335
+ /**
336
+ * The region where the request originated from
337
+ */
338
+ region?: string;
339
+ regionCode?: string;
340
+
341
+ /**
342
+ * The organization which owns the ASN of the incoming request, for example, Google Cloud.
343
+ */
344
+ asOrganization: string;
345
+
346
+ /**
347
+ * Metro code (DMA) of the incoming request, for example, "635".
348
+ */
349
+ metroCode?: string;
350
+
351
+ /**
352
+ * Postal code of the incoming request, for example, "78701".
353
+ */
354
+ postalCode?: string;
355
+ };
356
+ };
357
+ };
358
+
359
+ /**
360
+ * An event that was triggered at a certain time
361
+ */
362
+ export type ScheduledEvent = {
363
+ /**
364
+ * The cron pattern that matched when this event fired
365
+ */
366
+ cron: string;
367
+
368
+ /**
369
+ * The time this worker was scheduled to run.
370
+ * For some reason, this doesn't...work correctly when we
371
+ * do it directly as a Date. So parse it later on your own.
372
+ */
373
+ scheduledTime: number;
374
+ };
375
+
376
+ /**
377
+ * A event that was triggered from a durable object alarm
378
+ */
379
+ export type AlarmEvent = {
380
+ /**
381
+ * The datetime the alarm was scheduled for.
382
+ *
383
+ * This is sent as an ISO timestamp string (different than ScheduledEvent.scheduledTime),
384
+ * you should parse it later on on your own.
385
+ */
386
+ scheduledTime: string;
387
+ };
388
+
389
+ /**
390
+ * An event that was triggered from an email
391
+ */
392
+ export type EmailEvent = {
393
+ /**
394
+ * Who sent the email
395
+ */
396
+ mailFrom: string;
397
+
398
+ /**
399
+ * Who was the email sent to
400
+ */
401
+ rcptTo: string;
402
+
403
+ /**
404
+ * Size of the email in bytes
405
+ */
406
+ rawSize: number;
407
+ };
408
+
409
+ /**
410
+ * Message from tail with information about the tail itself
411
+ */
412
+ export type TailInfo = {
413
+ message: string;
414
+ type: string;
415
+ };