wrangler 0.0.0-ecc8b172 → 0.0.0-ecdfabed0

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 (248) hide show
  1. package/README.md +17 -19
  2. package/bin/wrangler.js +24 -93
  3. package/config-schema.json +3088 -0
  4. package/package.json +197 -190
  5. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  6. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  7. package/templates/__tests__/tsconfig.json +8 -0
  8. package/templates/checked-fetch.js +19 -6
  9. package/templates/facade.d.ts +19 -0
  10. package/templates/gitignore +2 -3
  11. package/templates/init-tests/test-jest-new-worker.js +3 -5
  12. package/templates/init-tests/test-vitest-new-worker.js +4 -6
  13. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  14. package/templates/middleware/common.ts +9 -4
  15. package/templates/middleware/loader-modules.ts +94 -44
  16. package/templates/middleware/loader-sw.ts +48 -32
  17. package/templates/middleware/middleware-ensure-req-body-drained.ts +18 -0
  18. package/templates/middleware/middleware-miniflare3-json-error.ts +32 -0
  19. package/templates/middleware/middleware-scheduled.ts +15 -1
  20. package/templates/middleware/middleware-serve-static-assets.d.ts +6 -0
  21. package/templates/middleware/middleware-serve-static-assets.ts +56 -0
  22. package/templates/modules-watch-stub.js +4 -0
  23. package/templates/new-worker-scheduled.ts +1 -1
  24. package/templates/new-worker.ts +4 -1
  25. package/templates/pages-dev-pipeline.ts +10 -13
  26. package/templates/pages-dev-util.ts +55 -0
  27. package/templates/pages-shim.ts +1 -1
  28. package/templates/pages-template-plugin.ts +37 -14
  29. package/templates/pages-template-worker.ts +33 -7
  30. package/templates/startDevWorker/InspectorProxyWorker.ts +664 -0
  31. package/templates/startDevWorker/ProxyWorker.ts +336 -0
  32. package/templates/tsconfig-sanity.ts +11 -0
  33. package/templates/tsconfig.init.json +22 -0
  34. package/templates/tsconfig.json +5 -102
  35. package/wrangler-dist/InspectorProxyWorker.js +464 -0
  36. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  37. package/wrangler-dist/ProxyWorker.js +241 -0
  38. package/wrangler-dist/ProxyWorker.js.map +6 -0
  39. package/wrangler-dist/cli.d.ts +26031 -472
  40. package/wrangler-dist/cli.js +172877 -121674
  41. package/wrangler-dist/wasm-sync.wasm +0 -0
  42. package/Cloudflare_CA.pem +0 -18
  43. package/import_meta_url.js +0 -3
  44. package/miniflare-config-stubs/.env.empty +0 -0
  45. package/miniflare-config-stubs/package.empty.json +0 -1
  46. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  47. package/miniflare-dist/index.mjs +0 -6310
  48. package/src/__tests__/api-dev.test.ts +0 -209
  49. package/src/__tests__/api-devregistry.test.js +0 -56
  50. package/src/__tests__/api.test.ts +0 -80
  51. package/src/__tests__/config-cache-without-cache-dir.test.ts +0 -38
  52. package/src/__tests__/config-cache.test.ts +0 -42
  53. package/src/__tests__/configuration.test.ts +0 -3864
  54. package/src/__tests__/d1.test.ts +0 -70
  55. package/src/__tests__/delete.test.ts +0 -116
  56. package/src/__tests__/dev.test.tsx +0 -1357
  57. package/src/__tests__/dialogs.test.tsx +0 -40
  58. package/src/__tests__/generate.test.ts +0 -235
  59. package/src/__tests__/get-host-from-url.test.ts +0 -16
  60. package/src/__tests__/guess-worker-format.test.ts +0 -85
  61. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  62. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  63. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  64. package/src/__tests__/helpers/mock-bin.ts +0 -36
  65. package/src/__tests__/helpers/mock-cfetch.ts +0 -333
  66. package/src/__tests__/helpers/mock-console.ts +0 -106
  67. package/src/__tests__/helpers/mock-dialogs.ts +0 -153
  68. package/src/__tests__/helpers/mock-get-zone-from-host.ts +0 -8
  69. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  70. package/src/__tests__/helpers/mock-istty.ts +0 -74
  71. package/src/__tests__/helpers/mock-known-routes.ts +0 -7
  72. package/src/__tests__/helpers/mock-kv.ts +0 -33
  73. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -252
  74. package/src/__tests__/helpers/mock-process.ts +0 -39
  75. package/src/__tests__/helpers/mock-stdin.ts +0 -108
  76. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  77. package/src/__tests__/helpers/msw/handlers/namespaces.ts +0 -104
  78. package/src/__tests__/helpers/msw/handlers/oauth.ts +0 -36
  79. package/src/__tests__/helpers/msw/handlers/r2.ts +0 -80
  80. package/src/__tests__/helpers/msw/handlers/script.ts +0 -75
  81. package/src/__tests__/helpers/msw/handlers/user.ts +0 -63
  82. package/src/__tests__/helpers/msw/index.ts +0 -15
  83. package/src/__tests__/helpers/run-in-tmp.ts +0 -38
  84. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  85. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +0 -1
  86. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +0 -5
  87. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +0 -1
  88. package/src/__tests__/helpers/worker-scripts/parent-worker.js +0 -8
  89. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +0 -5
  90. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  91. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  92. package/src/__tests__/https-options.test.ts +0 -163
  93. package/src/__tests__/index.test.ts +0 -251
  94. package/src/__tests__/init.test.ts +0 -2816
  95. package/src/__tests__/jest.setup.ts +0 -191
  96. package/src/__tests__/kv.test.ts +0 -1675
  97. package/src/__tests__/logger.test.ts +0 -141
  98. package/src/__tests__/metrics.test.ts +0 -450
  99. package/src/__tests__/middleware.scheduled.test.ts +0 -135
  100. package/src/__tests__/middleware.test.ts +0 -726
  101. package/src/__tests__/package-manager.test.ts +0 -353
  102. package/src/__tests__/pages.test.ts +0 -2111
  103. package/src/__tests__/parse.test.ts +0 -330
  104. package/src/__tests__/paths.test.ts +0 -39
  105. package/src/__tests__/publish.test.ts +0 -7119
  106. package/src/__tests__/pubsub.test.ts +0 -367
  107. package/src/__tests__/r2.test.ts +0 -371
  108. package/src/__tests__/route.test.ts +0 -45
  109. package/src/__tests__/secret.test.ts +0 -644
  110. package/src/__tests__/tail.test.ts +0 -800
  111. package/src/__tests__/test-old-node-version.js +0 -31
  112. package/src/__tests__/user.test.ts +0 -155
  113. package/src/__tests__/utils-collectKeyValues.test.ts +0 -47
  114. package/src/__tests__/validate-dev-props.test.ts +0 -56
  115. package/src/__tests__/version.test.ts +0 -35
  116. package/src/__tests__/whoami.test.tsx +0 -278
  117. package/src/__tests__/worker-namespace.test.ts +0 -321
  118. package/src/abort.d.ts +0 -3
  119. package/src/api/dev.ts +0 -208
  120. package/src/api/index.ts +0 -2
  121. package/src/bundle-reporter.tsx +0 -29
  122. package/src/bundle.ts +0 -756
  123. package/src/cfetch/index.ts +0 -160
  124. package/src/cfetch/internal.ts +0 -263
  125. package/src/cli.ts +0 -29
  126. package/src/config/README.md +0 -107
  127. package/src/config/config.ts +0 -275
  128. package/src/config/diagnostics.ts +0 -80
  129. package/src/config/environment.ts +0 -505
  130. package/src/config/index.ts +0 -293
  131. package/src/config/validation-helpers.ts +0 -597
  132. package/src/config/validation.ts +0 -1930
  133. package/src/config-cache.ts +0 -85
  134. package/src/create-worker-preview.ts +0 -275
  135. package/src/create-worker-upload-form.ts +0 -301
  136. package/src/d1/backups.tsx +0 -212
  137. package/src/d1/create.tsx +0 -54
  138. package/src/d1/delete.tsx +0 -56
  139. package/src/d1/execute.tsx +0 -294
  140. package/src/d1/formatTimeAgo.ts +0 -14
  141. package/src/d1/index.ts +0 -75
  142. package/src/d1/list.tsx +0 -48
  143. package/src/d1/options.ts +0 -12
  144. package/src/d1/types.tsx +0 -14
  145. package/src/d1/utils.ts +0 -39
  146. package/src/delete.ts +0 -86
  147. package/src/deprecated/index.ts +0 -453
  148. package/src/dev/dev-vars.ts +0 -36
  149. package/src/dev/dev.tsx +0 -575
  150. package/src/dev/get-local-persistence-path.tsx +0 -31
  151. package/src/dev/local.tsx +0 -686
  152. package/src/dev/remote.tsx +0 -601
  153. package/src/dev/start-server.ts +0 -506
  154. package/src/dev/use-esbuild.ts +0 -197
  155. package/src/dev/validate-dev-props.ts +0 -31
  156. package/src/dev-registry.tsx +0 -201
  157. package/src/dev.tsx +0 -865
  158. package/src/dialogs.tsx +0 -163
  159. package/src/dispatch-namespace.ts +0 -206
  160. package/src/durable.ts +0 -102
  161. package/src/entry.ts +0 -329
  162. package/src/environment-variables.ts +0 -50
  163. package/src/errors.ts +0 -11
  164. package/src/git-client.ts +0 -124
  165. package/src/global-wrangler-config-path.ts +0 -26
  166. package/src/https-options.ts +0 -127
  167. package/src/index.tsx +0 -582
  168. package/src/init.ts +0 -970
  169. package/src/inspect.ts +0 -747
  170. package/src/intl-polyfill.d.ts +0 -139
  171. package/src/is-ci.ts +0 -14
  172. package/src/is-interactive.ts +0 -12
  173. package/src/kv/helpers.ts +0 -430
  174. package/src/kv/index.ts +0 -645
  175. package/src/logger.ts +0 -80
  176. package/src/metrics/index.ts +0 -5
  177. package/src/metrics/metrics-config.ts +0 -239
  178. package/src/metrics/metrics-dispatcher.ts +0 -96
  179. package/src/metrics/metrics-usage-headers.ts +0 -24
  180. package/src/metrics/send-event.ts +0 -94
  181. package/src/miniflare-cli/README.md +0 -30
  182. package/src/miniflare-cli/assets.ts +0 -215
  183. package/src/miniflare-cli/index.ts +0 -208
  184. package/src/miniflare-cli/request-context.ts +0 -40
  185. package/src/module-collection.ts +0 -267
  186. package/src/open-in-browser.ts +0 -17
  187. package/src/package-manager.ts +0 -219
  188. package/src/pages/build.tsx +0 -238
  189. package/src/pages/constants.ts +0 -16
  190. package/src/pages/deployments.tsx +0 -106
  191. package/src/pages/dev.tsx +0 -689
  192. package/src/pages/errors.ts +0 -66
  193. package/src/pages/functions/buildPlugin.ts +0 -110
  194. package/src/pages/functions/buildWorker.ts +0 -156
  195. package/src/pages/functions/filepath-routing.test.ts +0 -234
  196. package/src/pages/functions/filepath-routing.ts +0 -189
  197. package/src/pages/functions/identifiers.ts +0 -78
  198. package/src/pages/functions/routes-consolidation.test.ts +0 -250
  199. package/src/pages/functions/routes-consolidation.ts +0 -73
  200. package/src/pages/functions/routes-transformation.test.ts +0 -282
  201. package/src/pages/functions/routes-transformation.ts +0 -115
  202. package/src/pages/functions/routes-validation.test.ts +0 -403
  203. package/src/pages/functions/routes-validation.ts +0 -202
  204. package/src/pages/functions/routes.ts +0 -151
  205. package/src/pages/functions.tsx +0 -82
  206. package/src/pages/hash.tsx +0 -13
  207. package/src/pages/index.tsx +0 -94
  208. package/src/pages/projects.tsx +0 -169
  209. package/src/pages/publish.tsx +0 -436
  210. package/src/pages/types.ts +0 -49
  211. package/src/pages/upload.tsx +0 -398
  212. package/src/pages/utils.ts +0 -12
  213. package/src/parse.ts +0 -286
  214. package/src/paths.ts +0 -71
  215. package/src/proxy.ts +0 -657
  216. package/src/publish/index.ts +0 -267
  217. package/src/publish/publish.ts +0 -913
  218. package/src/pubsub/index.ts +0 -286
  219. package/src/pubsub/pubsub-commands.tsx +0 -623
  220. package/src/r2/helpers.ts +0 -131
  221. package/src/r2/index.ts +0 -277
  222. package/src/routes.ts +0 -140
  223. package/src/secret/index.ts +0 -403
  224. package/src/selfsigned.d.ts +0 -29
  225. package/src/sites.tsx +0 -372
  226. package/src/tail/createTail.ts +0 -315
  227. package/src/tail/filters.ts +0 -277
  228. package/src/tail/index.ts +0 -217
  229. package/src/tail/printing.ts +0 -107
  230. package/src/update-check.ts +0 -19
  231. package/src/user/choose-account.tsx +0 -69
  232. package/src/user/env-vars.ts +0 -46
  233. package/src/user/generate-auth-url.ts +0 -33
  234. package/src/user/generate-random-state.ts +0 -16
  235. package/src/user/index.ts +0 -3
  236. package/src/user/user.tsx +0 -1192
  237. package/src/utils/collectKeyValues.ts +0 -14
  238. package/src/whoami.tsx +0 -169
  239. package/src/worker.ts +0 -234
  240. package/src/yargs-types.ts +0 -7
  241. package/src/zones.ts +0 -165
  242. package/templates/d1-beta-facade.js +0 -174
  243. package/templates/experimental-local-cache-stubs.js +0 -27
  244. package/templates/first-party-worker-module-facade.ts +0 -18
  245. package/templates/format-dev-errors.ts +0 -32
  246. package/templates/serve-static-assets.ts +0 -63
  247. package/templates/service-bindings-module-facade.js +0 -54
  248. package/templates/service-bindings-sw-facade.js +0 -42
@@ -1,277 +0,0 @@
1
- /**
2
- * When tailing logs from a worker, oftentimes you don't want to see _every
3
- * single event_. That's where filters come in. We can send a set of filters
4
- * to the tail worker, and it will pre-filter any logs for us so that we
5
- * only recieve the ones we care about.
6
- */
7
-
8
- /**
9
- * These are the filters we accept in the CLI. They
10
- * were copied directly from wrangler 1 in order to
11
- * maintain compatability, so they aren't actually the exact
12
- * filters we need to send up to the tail worker. They generally map 1:1,
13
- * but often require some transformation or
14
- * renaming to match what it expects.
15
- *
16
- * For a full description of each filter, either check the
17
- * CLI description or see the documentation for `ApiFilter`.
18
- */
19
- export type TailCLIFilters = {
20
- status?: ("ok" | "error" | "canceled")[];
21
- header?: string;
22
- method?: string[];
23
- search?: string;
24
- samplingRate?: number;
25
- clientIp?: string[];
26
- };
27
-
28
- /**
29
- * These are the filters we send to the tail worker. We
30
- * actually send a list of filters (an array of objects),
31
- * so rather than having a single TailAPIFilters type,
32
- * each kind of filter gets its own type and we define
33
- * TailAPIFilter to be the union of those types.
34
- */
35
- export type TailAPIFilter =
36
- | SamplingRateFilter
37
- | OutcomeFilter
38
- | MethodFilter
39
- | HeaderFilter
40
- | ClientIPFilter
41
- | QueryFilter;
42
-
43
- /**
44
- * Filters logs based on a given sampling rate.
45
- * For example, a `sampling_rate` of 0.25 will let one-quarter of the
46
- * logs through.
47
- */
48
- type SamplingRateFilter = {
49
- sampling_rate: number;
50
- };
51
-
52
- /**
53
- * Filters logs based on the outcome of the worker's event handler.
54
- */
55
- type OutcomeFilter = {
56
- outcome: Outcome[];
57
- };
58
-
59
- /**
60
- * There are five possible outcomes we can get, three of which
61
- * (exception, exceededCpu, exceededMemory, and unknown) are considered errors
62
- */
63
- export type Outcome =
64
- | "ok"
65
- | "canceled"
66
- | "exception"
67
- | "exceededCpu"
68
- | "exceededMemory"
69
- | "unknown";
70
-
71
- /**
72
- * Filters logs based on the HTTP method used for the request
73
- * that triggered the worker.
74
- */
75
- type MethodFilter = {
76
- method: string[];
77
- };
78
-
79
- /**
80
- * Filters logs based on an HTTP header on the request that
81
- * triggered the worker.
82
- */
83
- type HeaderFilter = {
84
- header: {
85
- /**
86
- * Filters on the header "key", e.g. "X-CLOUDFLARE-HEADER"
87
- * or "X-CUSTOM-HEADER"
88
- */
89
- key: string;
90
-
91
- /**
92
- * Filters on the header "value", e.g. if this is set to
93
- * "filter-for-me" and the "key" is "X-SHOULD-LOG", only
94
- * events triggered by requests with the header
95
- * "X-SHOULD-LOG:filter-for-me" will be logged.
96
- */
97
- query?: string;
98
- };
99
- };
100
-
101
- /**
102
- * Filters on the IP address the request came from that triggered
103
- * the worker. A value of "self" will be replaced with the IP
104
- * address that is running `wrangler tail`
105
- */
106
- type ClientIPFilter = {
107
- client_ip: string[];
108
- };
109
-
110
- /**
111
- * Filters logs by a query string. This means only logs that
112
- * contain the given string will be sent to wrangler, and any
113
- * that don't will be discarded by the tail worker.
114
- */
115
- type QueryFilter = {
116
- query: string;
117
- };
118
-
119
- /**
120
- * The full message we send to the tail worker includes our
121
- * filters and a debug flag.
122
- */
123
- export type TailFilterMessage = {
124
- filters: TailAPIFilter[];
125
- };
126
-
127
- /**
128
- * Translate the flags passed in via a CLI invokation of wrangler
129
- * into a message that we can send to the tail worker.
130
- *
131
- * @param cliFilters An object containing all the filters passed in from the CLI
132
- * @returns A filter message ready to be sent to the tail worker
133
- */
134
- export function translateCLICommandToFilterMessage(
135
- cliFilters: TailCLIFilters
136
- ): TailFilterMessage {
137
- const apiFilters: TailAPIFilter[] = [];
138
-
139
- if (cliFilters.samplingRate) {
140
- apiFilters.push(parseSamplingRate(cliFilters.samplingRate));
141
- }
142
-
143
- if (cliFilters.status) {
144
- apiFilters.push(parseOutcome(cliFilters.status));
145
- }
146
-
147
- if (cliFilters.method) {
148
- apiFilters.push(parseMethod(cliFilters.method));
149
- }
150
-
151
- if (cliFilters.header) {
152
- apiFilters.push(parseHeader(cliFilters.header));
153
- }
154
-
155
- if (cliFilters.clientIp) {
156
- apiFilters.push(parseIP(cliFilters.clientIp));
157
- }
158
-
159
- if (cliFilters.search) {
160
- apiFilters.push(parseQuery(cliFilters.search));
161
- }
162
-
163
- return {
164
- filters: apiFilters,
165
- };
166
- }
167
-
168
- /**
169
- * Parse the sampling rate passed in via command line
170
- *
171
- * @param sampling_rate the sampling rate passed in via CLI
172
- * @throws an Error if the rate doesn't make sense
173
- * @returns a SamplingRateFilter for use with the API
174
- */
175
- function parseSamplingRate(sampling_rate: number): SamplingRateFilter {
176
- if (sampling_rate <= 0 || sampling_rate >= 1) {
177
- throw new Error(
178
- "A sampling rate must be between 0 and 1 in order to have any effect.\nFor example, a sampling rate of 0.25 means 25% of events will be logged."
179
- );
180
- }
181
-
182
- return { sampling_rate };
183
- }
184
-
185
- /**
186
- * Translate from CLI "status"es to API "outcome"s, including
187
- * broadening "error" into "exception", "exceededCpu", and "unknown".
188
- *
189
- * @param statuses statuses passed in via CLI
190
- * @returns an OutcomeFilter for use with the API
191
- */
192
- function parseOutcome(
193
- statuses: ("ok" | "error" | "canceled")[]
194
- ): OutcomeFilter {
195
- const outcomes = new Set<Outcome>();
196
-
197
- for (const status of statuses) {
198
- switch (status) {
199
- case "ok":
200
- outcomes.add("ok");
201
- break;
202
-
203
- case "canceled":
204
- outcomes.add("canceled");
205
- break;
206
-
207
- case "error":
208
- outcomes.add("exception");
209
- outcomes.add("exceededCpu");
210
- outcomes.add("exceededMemory");
211
- outcomes.add("unknown");
212
- break;
213
-
214
- default:
215
- break;
216
- }
217
- }
218
-
219
- return {
220
- outcome: Array.from(outcomes),
221
- };
222
- }
223
-
224
- /**
225
- * We just send silly methods through to the API anyway, since they don't
226
- * cause any harm.
227
- *
228
- * @param method an array of HTTP request methods passed in via CLI
229
- * @returns a MethodFilter for use with the API
230
- */
231
- function parseMethod(method: string[]): MethodFilter {
232
- return { method };
233
- }
234
-
235
- /**
236
- * Header filters can contain either just a key ("X-HEADER-KEY") or both
237
- * a key and a value ("X-HEADER-KEY:some-value"). This function parses
238
- * a given string according to that pattern.
239
- *
240
- * @param header a header string, "X-HEADER-KEY" or "X-HEADER-KEY:some-value"
241
- * @returns a HeaderFilter for use with the API
242
- */
243
- function parseHeader(header: string): HeaderFilter {
244
- const [headerKey, headerQuery] = header.split(":", 2);
245
-
246
- return {
247
- header: {
248
- key: headerKey.trim(),
249
- query: headerQuery?.trim(),
250
- },
251
- };
252
- }
253
-
254
- /**
255
- * A list of IPs can be passed in to filter for messages that come from
256
- * a worker triggered by a request originating from one of those IPs.
257
- * You can also pass in the string "self" to filter for the IP of the
258
- * machine running `wrangler tail`.
259
- *
260
- * @param client_ip an array of IP addresses to filter
261
- * @returns a ClientIPFilter for use with the API
262
- */
263
- function parseIP(client_ip: string[]): ClientIPFilter {
264
- return { client_ip };
265
- }
266
-
267
- /**
268
- * Users can filter for logs that contain a "search" or a "query string".
269
- * For example, if `--search findme` is passed to then we will only
270
- * receive logs that contain the string "findme".
271
- *
272
- * @param query a query string to search for
273
- * @returns a QueryFilter for use with the API
274
- */
275
- function parseQuery(query: string): QueryFilter {
276
- return { query };
277
- }
package/src/tail/index.ts DELETED
@@ -1,217 +0,0 @@
1
- import { setTimeout } from "node:timers/promises";
2
- import onExit from "signal-exit";
3
-
4
- import { fetchResult, fetchScriptContent } from "../cfetch";
5
- import { readConfig } from "../config";
6
- import { tailDOLogPrompt } from "../dialogs";
7
- import {
8
- isLegacyEnv,
9
- printWranglerBanner,
10
- getLegacyScriptName,
11
- } from "../index";
12
- import { logger } from "../logger";
13
- import * as metrics from "../metrics";
14
- import { requireAuth } from "../user";
15
- import { getWorkerForZone } from "../zones";
16
- import {
17
- createTail,
18
- jsonPrintLogs,
19
- prettyPrintLogs,
20
- translateCLICommandToFilterMessage,
21
- } from "./createTail";
22
- import type { WorkerMetadata } from "../create-worker-upload-form";
23
- import type { ConfigPath } from "../index";
24
- import type { YargsOptionsToInterface } from "../yargs-types";
25
- import type { TailCLIFilters } from "./createTail";
26
- import type { RawData } from "ws";
27
- import type { Argv } from "yargs";
28
-
29
- export function tailOptions(yargs: Argv) {
30
- return yargs
31
- .positional("worker", {
32
- describe: "Name or route of the worker to tail",
33
- type: "string",
34
- })
35
- .option("format", {
36
- default: process.stdout.isTTY ? "pretty" : "json",
37
- choices: ["json", "pretty"],
38
- describe: "The format of log entries",
39
- })
40
- .option("status", {
41
- choices: ["ok", "error", "canceled"],
42
- describe: "Filter by invocation status",
43
- array: true,
44
- })
45
- .option("header", {
46
- type: "string",
47
- requiresArg: true,
48
- describe: "Filter by HTTP header",
49
- })
50
- .option("method", {
51
- type: "string",
52
- requiresArg: true,
53
- describe: "Filter by HTTP method",
54
- array: true,
55
- })
56
- .option("sampling-rate", {
57
- type: "number",
58
- describe: "Adds a percentage of requests to log sampling rate",
59
- })
60
- .option("search", {
61
- type: "string",
62
- requiresArg: true,
63
- describe: "Filter by a text match in console.log messages",
64
- })
65
- .option("ip", {
66
- type: "string",
67
- requiresArg: true,
68
- describe:
69
- 'Filter by the IP address the request originates from. Use "self" to filter for your own IP',
70
- array: true,
71
- })
72
- .option("env", {
73
- type: "string",
74
- requiresArg: true,
75
- describe: "Perform on a specific environment",
76
- alias: "e",
77
- })
78
- .option("debug", {
79
- type: "boolean",
80
- hidden: true,
81
- default: false,
82
- describe:
83
- "If a log would have been filtered out, send it through anyway alongside the filter which would have blocked it.",
84
- })
85
- .option("legacy-env", {
86
- type: "boolean",
87
- describe: "Use legacy environments",
88
- hidden: true,
89
- });
90
- }
91
-
92
- type TailArgs = YargsOptionsToInterface<typeof tailOptions>;
93
-
94
- export async function tailHandler(args: TailArgs) {
95
- if (args.format === "pretty") {
96
- await printWranglerBanner();
97
- }
98
- const config = readConfig(args.config as ConfigPath, args);
99
- await metrics.sendMetricsEvent("begin log stream", {
100
- sendMetrics: config.send_metrics,
101
- });
102
-
103
- let scriptName;
104
-
105
- // Worker names can't contain "." (and most routes should), so use that as a discriminator
106
- if (args.worker?.includes(".")) {
107
- scriptName = await getWorkerForZone(args.worker);
108
- if (args.format === "pretty") {
109
- logger.log(`Connecting to worker ${scriptName} at route ${args.worker}`);
110
- }
111
- } else {
112
- scriptName = getLegacyScriptName({ name: args.worker, ...args }, config);
113
- }
114
-
115
- if (!scriptName) {
116
- throw new Error(
117
- "Required Worker name missing. Please specify the Worker name in wrangler.toml, or pass it as an argument with `wrangler tail <worker-name>`"
118
- );
119
- }
120
-
121
- const accountId = await requireAuth(config);
122
-
123
- const cliFilters: TailCLIFilters = {
124
- status: args.status as ("ok" | "error" | "canceled")[] | undefined,
125
- header: args.header,
126
- method: args.method,
127
- samplingRate: args["sampling-rate"],
128
- search: args.search,
129
- clientIp: args.ip,
130
- };
131
- const scriptContent: string = await fetchScriptContent(
132
- (!isLegacyEnv(config) ? args.env : undefined)
133
- ? `/accounts/${accountId}/workers/services/${scriptName}/environments/${args.env}/content`
134
- : `/accounts/${accountId}/workers/scripts/${scriptName}`
135
- );
136
-
137
- const bindings = await fetchResult<WorkerMetadata["bindings"]>(
138
- (!isLegacyEnv(config) ? args.env : undefined)
139
- ? `/accounts/${accountId}/workers/services/${scriptName}/environments/${args.env}/bindings`
140
- : `/accounts/${accountId}/workers/scripts/${scriptName}/bindings`
141
- );
142
- if (
143
- scriptContent.toLowerCase().includes("websocket") &&
144
- bindings.find((b) => b.type === "durable_object_namespace")
145
- ) {
146
- logger.warn(
147
- `Beginning log collection requires restarting the Durable Objects associated with ${scriptName}. Any WebSocket connections or other non-persisted state will be lost as part of this restart.`
148
- );
149
-
150
- const shouldContinue = await tailDOLogPrompt();
151
- if (!shouldContinue) {
152
- return;
153
- }
154
- }
155
- const filters = translateCLICommandToFilterMessage(cliFilters);
156
-
157
- const { tail, expiration, deleteTail } = await createTail(
158
- accountId,
159
- scriptName,
160
- filters,
161
- args.debug,
162
- !isLegacyEnv(config) ? args.env : undefined
163
- );
164
-
165
- const scriptDisplayName = `${scriptName}${
166
- args.env && !isLegacyEnv(config) ? ` (${args.env})` : ""
167
- }`;
168
-
169
- if (args.format === "pretty") {
170
- logger.log(
171
- `Successfully created tail, expires at ${expiration.toLocaleString()}`
172
- );
173
- }
174
-
175
- onExit(async () => {
176
- tail.terminate();
177
- await deleteTail();
178
- await metrics.sendMetricsEvent("end log stream", {
179
- sendMetrics: config.send_metrics,
180
- });
181
- });
182
-
183
- const printLog: (data: RawData) => void =
184
- args.format === "pretty" ? prettyPrintLogs : jsonPrintLogs;
185
-
186
- tail.on("message", printLog);
187
-
188
- while (tail.readyState !== tail.OPEN) {
189
- switch (tail.readyState) {
190
- case tail.CONNECTING:
191
- await setTimeout(100);
192
- break;
193
- case tail.CLOSING:
194
- await setTimeout(100);
195
- break;
196
- case tail.CLOSED:
197
- await metrics.sendMetricsEvent("end log stream", {
198
- sendMetrics: config.send_metrics,
199
- });
200
- throw new Error(
201
- `Connection to ${scriptDisplayName} closed unexpectedly.`
202
- );
203
- }
204
- }
205
-
206
- if (args.format === "pretty") {
207
- logger.log(`Connected to ${scriptDisplayName}, waiting for logs...`);
208
- }
209
-
210
- tail.on("close", async () => {
211
- tail.terminate();
212
- await deleteTail();
213
- await metrics.sendMetricsEvent("end log stream", {
214
- sendMetrics: config.send_metrics,
215
- });
216
- });
217
- }
@@ -1,107 +0,0 @@
1
- import { logger } from "../logger";
2
- import type {
3
- AlarmEvent,
4
- RequestEvent,
5
- ScheduledEvent,
6
- TailEventMessage,
7
- } from "./createTail";
8
- import type { Outcome } from "./filters";
9
- import type WebSocket from "ws";
10
-
11
- export function prettyPrintLogs(data: WebSocket.RawData): void {
12
- const eventMessage: TailEventMessage = JSON.parse(data.toString());
13
-
14
- if (isScheduledEvent(eventMessage.event)) {
15
- const cronPattern = eventMessage.event.cron;
16
- const datetime = new Date(
17
- eventMessage.event.scheduledTime
18
- ).toLocaleString();
19
- const outcome = prettifyOutcome(eventMessage.outcome);
20
-
21
- logger.log(`"${cronPattern}" @ ${datetime} - ${outcome}`);
22
- } else if (isRequestEvent(eventMessage.event)) {
23
- const requestMethod = eventMessage.event?.request.method.toUpperCase();
24
- const url = eventMessage.event?.request.url;
25
- const outcome = prettifyOutcome(eventMessage.outcome);
26
- const datetime = new Date(eventMessage.eventTimestamp).toLocaleString();
27
-
28
- logger.log(
29
- url
30
- ? `${requestMethod} ${url} - ${outcome} @ ${datetime}`
31
- : `[missing request] - ${outcome} @ ${datetime}`
32
- );
33
- } else if (isAlarmEvent(eventMessage.event)) {
34
- const outcome = prettifyOutcome(eventMessage.outcome);
35
- const datetime = new Date(
36
- eventMessage.event.scheduledTime
37
- ).toLocaleString();
38
-
39
- logger.log(`Alarm @ ${datetime} - ${outcome}`);
40
- } else {
41
- // Unknown event type
42
- const outcome = prettifyOutcome(eventMessage.outcome);
43
- const datetime = new Date(eventMessage.eventTimestamp).toLocaleString();
44
-
45
- logger.log(`Unknown Event - ${outcome} @ ${datetime}`);
46
- }
47
-
48
- if (eventMessage.logs.length > 0) {
49
- eventMessage.logs.forEach(({ level, message }) => {
50
- logger.log(` (${level})`, ...message);
51
- });
52
- }
53
-
54
- if (eventMessage.exceptions.length > 0) {
55
- eventMessage.exceptions.forEach(({ name, message }) => {
56
- logger.error(` ${name}:`, message);
57
- });
58
- }
59
- }
60
-
61
- export function jsonPrintLogs(data: WebSocket.RawData): void {
62
- console.log(JSON.stringify(JSON.parse(data.toString()), null, 2));
63
- }
64
-
65
- function isRequestEvent(
66
- event: TailEventMessage["event"]
67
- ): event is RequestEvent {
68
- return Boolean(event && "request" in event);
69
- }
70
-
71
- function isScheduledEvent(
72
- event: TailEventMessage["event"]
73
- ): event is ScheduledEvent {
74
- return Boolean(event && "cron" in event);
75
- }
76
-
77
- /**
78
- * Check to see if an event sent from a worker is an AlarmEvent.
79
- *
80
- * Because the only property on `AlarmEvent` is "scheduledTime", which it
81
- * shares with `ScheduledEvent`, `isAlarmEvent` checks if there's _not_
82
- * a "cron" property in `event` to confirm it's an alarm event.
83
- *
84
- * @param event An event
85
- * @returns true if the event is an AlarmEvent
86
- */
87
- function isAlarmEvent(event: TailEventMessage["event"]): event is AlarmEvent {
88
- return Boolean(event && "scheduledTime" in event && !("cron" in event));
89
- }
90
-
91
- function prettifyOutcome(outcome: Outcome): string {
92
- switch (outcome) {
93
- case "ok":
94
- return "Ok";
95
- case "canceled":
96
- return "Canceled";
97
- case "exceededCpu":
98
- return "Exceeded CPU Limit";
99
- case "exceededMemory":
100
- return "Exceeded Memory Limit";
101
- case "exception":
102
- return "Exception Thrown";
103
- case "unknown":
104
- default:
105
- return "Unknown";
106
- }
107
- }
@@ -1,19 +0,0 @@
1
- import chalk from "chalk";
2
- import checkForUpdate from "update-check";
3
- import pkg from "../package.json";
4
-
5
- export async function updateCheck(): Promise<string> {
6
- let update = null;
7
- try {
8
- // default cache for update check is 1 day
9
- update = await checkForUpdate(pkg, {
10
- distTag: pkg.version.startsWith("0.0.0") ? "beta" : "latest",
11
- });
12
- } catch (err) {
13
- // ignore error
14
- }
15
-
16
- if (update) return `(update available ${chalk.green(update.latest)})`;
17
-
18
- return "";
19
- }
@@ -1,69 +0,0 @@
1
- import { Text } from "ink";
2
- import SelectInput from "ink-select-input";
3
- import React from "react";
4
- import { fetchListResult } from "../cfetch";
5
- import { logger } from "../logger";
6
- import { getCloudflareAccountIdFromEnv } from "./env-vars";
7
-
8
- export type ChooseAccountItem = {
9
- id: string;
10
- name: string;
11
- };
12
-
13
- /**
14
- * A component that allows the user to select from a list of available accounts.
15
- */
16
- export function ChooseAccount(props: {
17
- accounts: ChooseAccountItem[];
18
- onSelect: (account: { name: string; id: string }) => void;
19
- onError: (error: Error) => void;
20
- }) {
21
- return (
22
- <>
23
- <Text bold>Select an account from below:</Text>
24
- <SelectInput
25
- items={props.accounts.map((item) => ({
26
- key: item.id,
27
- label: item.name,
28
- value: item,
29
- }))}
30
- onSelect={(item) => {
31
- logger.log(`Using account: "${item.value.name} - ${item.value.id}"`);
32
- props.onSelect({ id: item.value.id, name: item.value.name });
33
- }}
34
- />
35
- </>
36
- );
37
- }
38
-
39
- /**
40
- * Infer a list of available accounts for the current user.
41
- */
42
- export async function getAccountChoices(): Promise<ChooseAccountItem[]> {
43
- const accountIdFromEnv = getCloudflareAccountIdFromEnv();
44
- if (accountIdFromEnv) {
45
- return [{ id: accountIdFromEnv, name: "" }];
46
- } else {
47
- try {
48
- const response = await fetchListResult<{
49
- account: ChooseAccountItem;
50
- }>(`/memberships`);
51
- const accounts = response.map((r) => r.account);
52
- if (accounts.length === 0) {
53
- throw new Error(
54
- "Failed to automatically retrieve account IDs for the logged in user.\n" +
55
- "In a non-interactive environment, it is mandatory to specify an account ID, either by assigning its value to CLOUDFLARE_ACCOUNT_ID, or as `account_id` in your `wrangler.toml` file."
56
- );
57
- } else {
58
- return accounts;
59
- }
60
- } catch (err) {
61
- if ((err as { code: number }).code === 9109) {
62
- throw new Error(
63
- `Failed to automatically retrieve account IDs for the logged in user.
64
- You may have incorrect permissions on your API token. You can skip this account check by adding an \`account_id\` in your \`wrangler.toml\`, or by setting the value of CLOUDFLARE_ACCOUNT_ID"`
65
- );
66
- } else throw err;
67
- }
68
- }
69
- }