wrangler 2.20.0 → 3.0.1

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 (297) hide show
  1. package/README.md +4 -4
  2. package/bin/wrangler.js +9 -75
  3. package/package.json +6 -14
  4. package/templates/__tests__/tsconfig.tsbuildinfo +1 -1
  5. package/templates/checked-fetch.js +1 -1
  6. package/templates/first-party-worker-module-facade.ts +2 -2
  7. package/templates/middleware/common.ts +9 -4
  8. package/templates/middleware/loader-sw.ts +2 -7
  9. package/templates/new-worker-scheduled.ts +1 -1
  10. package/templates/new-worker.ts +1 -1
  11. package/templates/pages-dev-util.ts +4 -1
  12. package/templates/pages-shim.ts +0 -3
  13. package/templates/tsconfig.tsbuildinfo +1 -1
  14. package/wrangler-dist/cli.d.ts +149 -75
  15. package/wrangler-dist/cli.js +60065 -64339
  16. package/import_meta_url.js +0 -3
  17. package/miniflare-config-stubs/.env.empty +0 -0
  18. package/miniflare-config-stubs/package.empty.json +0 -1
  19. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  20. package/miniflare-dist/index.mjs +0 -6442
  21. package/src/__tests__/access.test.ts +0 -25
  22. package/src/__tests__/api-dev.test.ts +0 -238
  23. package/src/__tests__/api-devregistry.test.ts +0 -121
  24. package/src/__tests__/api.test.ts +0 -102
  25. package/src/__tests__/config-cache-without-cache-dir.test.ts +0 -38
  26. package/src/__tests__/config-cache.test.ts +0 -42
  27. package/src/__tests__/configuration.test.ts +0 -4517
  28. package/src/__tests__/constellation.test.ts +0 -371
  29. package/src/__tests__/d1/d1.test.ts +0 -82
  30. package/src/__tests__/d1/execute.test.ts +0 -66
  31. package/src/__tests__/d1/migrate.test.ts +0 -257
  32. package/src/__tests__/d1/splitter.test.ts +0 -255
  33. package/src/__tests__/delete.test.ts +0 -272
  34. package/src/__tests__/deployments.test.ts +0 -369
  35. package/src/__tests__/dev.test.tsx +0 -1617
  36. package/src/__tests__/generate.test.ts +0 -237
  37. package/src/__tests__/get-host-from-url.test.ts +0 -16
  38. package/src/__tests__/guess-worker-format.test.ts +0 -120
  39. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  40. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  41. package/src/__tests__/helpers/end-event-loop.ts +0 -6
  42. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  43. package/src/__tests__/helpers/mock-auth-domain.ts +0 -20
  44. package/src/__tests__/helpers/mock-bin.ts +0 -36
  45. package/src/__tests__/helpers/mock-console.ts +0 -112
  46. package/src/__tests__/helpers/mock-dialogs.ts +0 -139
  47. package/src/__tests__/helpers/mock-get-pages-upload-token.ts +0 -25
  48. package/src/__tests__/helpers/mock-get-zone-from-host.ts +0 -11
  49. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  50. package/src/__tests__/helpers/mock-istty.ts +0 -74
  51. package/src/__tests__/helpers/mock-known-routes.ts +0 -12
  52. package/src/__tests__/helpers/mock-kv.ts +0 -46
  53. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -263
  54. package/src/__tests__/helpers/mock-process.ts +0 -34
  55. package/src/__tests__/helpers/mock-set-timeout.ts +0 -16
  56. package/src/__tests__/helpers/mock-stdin.ts +0 -108
  57. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  58. package/src/__tests__/helpers/msw/blob-worker.cjs +0 -19
  59. package/src/__tests__/helpers/msw/handlers/access.ts +0 -13
  60. package/src/__tests__/helpers/msw/handlers/deployments.ts +0 -160
  61. package/src/__tests__/helpers/msw/handlers/namespaces.ts +0 -81
  62. package/src/__tests__/helpers/msw/handlers/oauth.ts +0 -31
  63. package/src/__tests__/helpers/msw/handlers/r2.ts +0 -60
  64. package/src/__tests__/helpers/msw/handlers/script.ts +0 -56
  65. package/src/__tests__/helpers/msw/handlers/user.ts +0 -52
  66. package/src/__tests__/helpers/msw/handlers/zones.ts +0 -20
  67. package/src/__tests__/helpers/msw/index.ts +0 -52
  68. package/src/__tests__/helpers/msw/read-file-sync.js +0 -61
  69. package/src/__tests__/helpers/run-in-tmp.ts +0 -38
  70. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  71. package/src/__tests__/helpers/string-dynamic-values-matcher.ts +0 -28
  72. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +0 -1
  73. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +0 -5
  74. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +0 -1
  75. package/src/__tests__/helpers/worker-scripts/parent-worker.js +0 -11
  76. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +0 -5
  77. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  78. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  79. package/src/__tests__/https-options.test.ts +0 -163
  80. package/src/__tests__/index.test.ts +0 -282
  81. package/src/__tests__/init.test.ts +0 -3196
  82. package/src/__tests__/jest.setup.ts +0 -179
  83. package/src/__tests__/kv.test.ts +0 -1799
  84. package/src/__tests__/logger.test.ts +0 -207
  85. package/src/__tests__/logout.test.ts +0 -47
  86. package/src/__tests__/metrics.test.ts +0 -493
  87. package/src/__tests__/middleware.scheduled.test.ts +0 -145
  88. package/src/__tests__/middleware.test.ts +0 -816
  89. package/src/__tests__/mtls-certificates.test.ts +0 -589
  90. package/src/__tests__/package-manager.test.ts +0 -353
  91. package/src/__tests__/pages/deployment-list.test.ts +0 -80
  92. package/src/__tests__/pages/functions-build.test.ts +0 -528
  93. package/src/__tests__/pages/pages.test.ts +0 -81
  94. package/src/__tests__/pages/project-create.test.ts +0 -63
  95. package/src/__tests__/pages/project-list.test.ts +0 -110
  96. package/src/__tests__/pages/project-upload.test.ts +0 -500
  97. package/src/__tests__/pages/publish.test.ts +0 -2864
  98. package/src/__tests__/pages-deployment-tail.test.ts +0 -957
  99. package/src/__tests__/parse.test.ts +0 -436
  100. package/src/__tests__/paths.test.ts +0 -39
  101. package/src/__tests__/publish.test.ts +0 -8849
  102. package/src/__tests__/pubsub.test.ts +0 -496
  103. package/src/__tests__/queues.test.ts +0 -532
  104. package/src/__tests__/r2.test.ts +0 -374
  105. package/src/__tests__/route.test.ts +0 -45
  106. package/src/__tests__/secret.test.ts +0 -693
  107. package/src/__tests__/tail.test.ts +0 -989
  108. package/src/__tests__/test-old-node-version.js +0 -31
  109. package/src/__tests__/traverse-module-graph.test.ts +0 -220
  110. package/src/__tests__/tsconfig-sanity.ts +0 -12
  111. package/src/__tests__/tsconfig.json +0 -8
  112. package/src/__tests__/tsconfig.tsbuildinfo +0 -1
  113. package/src/__tests__/type-generation.test.ts +0 -234
  114. package/src/__tests__/user.test.ts +0 -118
  115. package/src/__tests__/utils-collectKeyValues.test.ts +0 -47
  116. package/src/__tests__/validate-dev-props.test.ts +0 -56
  117. package/src/__tests__/version.test.ts +0 -35
  118. package/src/__tests__/whoami.test.tsx +0 -172
  119. package/src/__tests__/worker-namespace.test.ts +0 -340
  120. package/src/abort.d.ts +0 -3
  121. package/src/api/dev.ts +0 -321
  122. package/src/api/index.ts +0 -11
  123. package/src/api/mtls-certificate.ts +0 -148
  124. package/src/api/pages/create-worker-bundle-contents.ts +0 -77
  125. package/src/api/pages/index.ts +0 -5
  126. package/src/api/pages/publish.tsx +0 -371
  127. package/src/bundle-reporter.ts +0 -68
  128. package/src/bundle.ts +0 -929
  129. package/src/cfetch/index.ts +0 -158
  130. package/src/cfetch/internal.ts +0 -258
  131. package/src/cli.ts +0 -28
  132. package/src/config/README.md +0 -107
  133. package/src/config/config.ts +0 -282
  134. package/src/config/diagnostics.ts +0 -80
  135. package/src/config/environment.ts +0 -625
  136. package/src/config/index.ts +0 -403
  137. package/src/config/validation-helpers.ts +0 -597
  138. package/src/config/validation.ts +0 -2369
  139. package/src/config-cache.ts +0 -85
  140. package/src/constellation/createProject.tsx +0 -51
  141. package/src/constellation/deleteProject.ts +0 -51
  142. package/src/constellation/deleteProjectModel.ts +0 -68
  143. package/src/constellation/index.ts +0 -75
  144. package/src/constellation/listCatalog.tsx +0 -35
  145. package/src/constellation/listModel.tsx +0 -41
  146. package/src/constellation/listProject.tsx +0 -28
  147. package/src/constellation/listRuntime.tsx +0 -28
  148. package/src/constellation/options.ts +0 -17
  149. package/src/constellation/types.ts +0 -17
  150. package/src/constellation/uploadModel.tsx +0 -64
  151. package/src/constellation/utils.ts +0 -90
  152. package/src/create-worker-preview.ts +0 -293
  153. package/src/create-worker-upload-form.ts +0 -363
  154. package/src/d1/backups.tsx +0 -219
  155. package/src/d1/constants.ts +0 -2
  156. package/src/d1/create.tsx +0 -70
  157. package/src/d1/delete.ts +0 -53
  158. package/src/d1/execute.tsx +0 -357
  159. package/src/d1/formatTimeAgo.ts +0 -14
  160. package/src/d1/index.ts +0 -100
  161. package/src/d1/list.tsx +0 -62
  162. package/src/d1/migrations/apply.tsx +0 -212
  163. package/src/d1/migrations/create.tsx +0 -79
  164. package/src/d1/migrations/helpers.ts +0 -169
  165. package/src/d1/migrations/index.ts +0 -3
  166. package/src/d1/migrations/list.tsx +0 -95
  167. package/src/d1/migrations/options.ts +0 -23
  168. package/src/d1/options.ts +0 -22
  169. package/src/d1/splitter.ts +0 -161
  170. package/src/d1/types.ts +0 -25
  171. package/src/d1/utils.ts +0 -49
  172. package/src/delete.ts +0 -100
  173. package/src/deployments.ts +0 -368
  174. package/src/deprecated/index.ts +0 -144
  175. package/src/dev/dev-vars.ts +0 -39
  176. package/src/dev/dev.tsx +0 -605
  177. package/src/dev/get-local-persistence-path.ts +0 -31
  178. package/src/dev/local.tsx +0 -952
  179. package/src/dev/remote.tsx +0 -635
  180. package/src/dev/start-server.ts +0 -545
  181. package/src/dev/use-esbuild.ts +0 -215
  182. package/src/dev/validate-dev-props.ts +0 -40
  183. package/src/dev-registry.ts +0 -202
  184. package/src/dev.tsx +0 -934
  185. package/src/dialogs.ts +0 -136
  186. package/src/dispatch-namespace.ts +0 -211
  187. package/src/docs/helpers.ts +0 -50
  188. package/src/docs/index.ts +0 -54
  189. package/src/durable.ts +0 -102
  190. package/src/entry.ts +0 -344
  191. package/src/environment-variables/factory.ts +0 -89
  192. package/src/environment-variables/misc-variables.ts +0 -30
  193. package/src/errors.ts +0 -11
  194. package/src/generate/index.ts +0 -298
  195. package/src/git-client.ts +0 -135
  196. package/src/global-wrangler-config-path.ts +0 -26
  197. package/src/https-options.ts +0 -127
  198. package/src/index.ts +0 -768
  199. package/src/init.ts +0 -1037
  200. package/src/inspect.ts +0 -883
  201. package/src/intl-polyfill.d.ts +0 -139
  202. package/src/is-ci.ts +0 -14
  203. package/src/is-interactive.ts +0 -16
  204. package/src/jest.d.ts +0 -4
  205. package/src/kv/helpers.ts +0 -433
  206. package/src/kv/index.ts +0 -594
  207. package/src/logger.ts +0 -123
  208. package/src/metrics/index.ts +0 -5
  209. package/src/metrics/metrics-config.ts +0 -239
  210. package/src/metrics/metrics-dispatcher.ts +0 -96
  211. package/src/metrics/metrics-usage-headers.ts +0 -24
  212. package/src/metrics/send-event.ts +0 -99
  213. package/src/miniflare-cli/README.md +0 -30
  214. package/src/miniflare-cli/assets.ts +0 -251
  215. package/src/miniflare-cli/index.ts +0 -210
  216. package/src/miniflare-cli/request-context.ts +0 -40
  217. package/src/miniflare-cli/tsconfig.json +0 -9
  218. package/src/miniflare-cli/tsconfig.tsbuildinfo +0 -1
  219. package/src/miniflare-cli/types.ts +0 -11
  220. package/src/module-collection.ts +0 -333
  221. package/src/mtls-certificate/cli.ts +0 -155
  222. package/src/open-in-browser.ts +0 -17
  223. package/src/package-manager.ts +0 -219
  224. package/src/pages/build.ts +0 -423
  225. package/src/pages/buildFunctions.ts +0 -140
  226. package/src/pages/constants.ts +0 -18
  227. package/src/pages/deployment-tails.ts +0 -281
  228. package/src/pages/deployments.tsx +0 -84
  229. package/src/pages/dev.ts +0 -734
  230. package/src/pages/errors.ts +0 -67
  231. package/src/pages/functions/buildPlugin.ts +0 -114
  232. package/src/pages/functions/buildWorker.ts +0 -350
  233. package/src/pages/functions/filepath-routing.test.ts +0 -234
  234. package/src/pages/functions/filepath-routing.ts +0 -189
  235. package/src/pages/functions/identifiers.ts +0 -78
  236. package/src/pages/functions/routes-consolidation.test.ts +0 -250
  237. package/src/pages/functions/routes-consolidation.ts +0 -73
  238. package/src/pages/functions/routes-transformation.test.ts +0 -282
  239. package/src/pages/functions/routes-transformation.ts +0 -115
  240. package/src/pages/functions/routes-validation.test.ts +0 -403
  241. package/src/pages/functions/routes-validation.ts +0 -202
  242. package/src/pages/functions/routes.ts +0 -151
  243. package/src/pages/functions/tsconfig.json +0 -8
  244. package/src/pages/functions/tsconfig.tsbuildinfo +0 -1
  245. package/src/pages/functions.ts +0 -86
  246. package/src/pages/hash.ts +0 -13
  247. package/src/pages/index.ts +0 -102
  248. package/src/pages/projects.tsx +0 -159
  249. package/src/pages/prompt-select-project.tsx +0 -31
  250. package/src/pages/publish.tsx +0 -267
  251. package/src/pages/types.ts +0 -46
  252. package/src/pages/upload.tsx +0 -469
  253. package/src/pages/utils.ts +0 -23
  254. package/src/parse.ts +0 -308
  255. package/src/paths.ts +0 -71
  256. package/src/proxy.ts +0 -694
  257. package/src/publish/index.ts +0 -274
  258. package/src/publish/publish.ts +0 -1065
  259. package/src/pubsub/index.ts +0 -286
  260. package/src/pubsub/pubsub-commands.ts +0 -623
  261. package/src/queues/cli/commands/consumer/add.ts +0 -71
  262. package/src/queues/cli/commands/consumer/index.ts +0 -19
  263. package/src/queues/cli/commands/consumer/remove.ts +0 -31
  264. package/src/queues/cli/commands/create.ts +0 -25
  265. package/src/queues/cli/commands/delete.ts +0 -26
  266. package/src/queues/cli/commands/index.ts +0 -35
  267. package/src/queues/cli/commands/list.ts +0 -25
  268. package/src/queues/client.ts +0 -136
  269. package/src/queues/utils.ts +0 -18
  270. package/src/r2/constants.ts +0 -4
  271. package/src/r2/helpers.ts +0 -132
  272. package/src/r2/index.ts +0 -289
  273. package/src/routes.ts +0 -140
  274. package/src/secret/index.ts +0 -377
  275. package/src/selfsigned.d.ts +0 -29
  276. package/src/sites.ts +0 -484
  277. package/src/tail/createTail.ts +0 -415
  278. package/src/tail/filters.ts +0 -277
  279. package/src/tail/index.ts +0 -211
  280. package/src/tail/printing.ts +0 -132
  281. package/src/traverse-module-graph.ts +0 -54
  282. package/src/tsconfig-sanity.ts +0 -16
  283. package/src/type-generation.ts +0 -181
  284. package/src/update-check.ts +0 -19
  285. package/src/user/access.ts +0 -68
  286. package/src/user/auth-variables.ts +0 -113
  287. package/src/user/choose-account.tsx +0 -39
  288. package/src/user/generate-auth-url.ts +0 -33
  289. package/src/user/generate-random-state.ts +0 -16
  290. package/src/user/index.ts +0 -2
  291. package/src/user/user.ts +0 -1234
  292. package/src/utils/collectKeyValues.ts +0 -14
  293. package/src/utils/render.ts +0 -93
  294. package/src/whoami.ts +0 -135
  295. package/src/worker.ts +0 -279
  296. package/src/yargs-types.ts +0 -37
  297. package/src/zones.ts +0 -191
@@ -1,140 +0,0 @@
1
- import { writeFileSync } from "node:fs";
2
- import { tmpdir } from "node:os";
3
- import { join, resolve } from "node:path";
4
- import { FatalError } from "../errors";
5
- import { toUrlPath } from "../paths";
6
- import { FunctionsNoRoutesError } from "./errors";
7
- import { buildPlugin } from "./functions/buildPlugin";
8
- import { buildWorker } from "./functions/buildWorker";
9
- import { generateConfigFromFileTree } from "./functions/filepath-routing";
10
- import { writeRoutesModule } from "./functions/routes";
11
- import { convertRoutesToRoutesJSONSpec } from "./functions/routes-transformation";
12
- import { RUNNING_BUILDERS } from "./utils";
13
- import type { BundleResult } from "../bundle";
14
- import type { PagesBuildArgs } from "./build";
15
- import type { Config } from "./functions/routes";
16
-
17
- /**
18
- * Builds a Functions worker based on the functions directory, with filepath and handler based routing.
19
- * @throws FunctionsNoRoutesError when there are no routes found in the functions directory
20
- */
21
-
22
- export async function buildFunctions({
23
- outfile,
24
- outdir,
25
- outputConfigPath,
26
- functionsDirectory,
27
- minify = false,
28
- sourcemap = false,
29
- fallbackService = "ASSETS",
30
- watch = false,
31
- onEnd,
32
- plugin = false,
33
- buildOutputDirectory,
34
- routesOutputPath,
35
- legacyNodeCompat,
36
- nodejsCompat,
37
- local,
38
- d1Databases,
39
- }: Partial<
40
- Pick<
41
- PagesBuildArgs,
42
- | "outfile"
43
- | "outdir"
44
- | "outputConfigPath"
45
- | "minify"
46
- | "sourcemap"
47
- | "fallbackService"
48
- | "watch"
49
- | "plugin"
50
- | "buildOutputDirectory"
51
- >
52
- > & {
53
- functionsDirectory: string;
54
- onEnd?: () => void;
55
- routesOutputPath?: PagesBuildArgs["outputRoutesPath"];
56
- local: boolean;
57
- d1Databases?: string[];
58
- legacyNodeCompat?: boolean;
59
- nodejsCompat?: boolean;
60
- }) {
61
- RUNNING_BUILDERS.forEach(
62
- (runningBuilder) => runningBuilder.stop && runningBuilder.stop()
63
- );
64
-
65
- const routesModule = join(tmpdir(), `./functionsRoutes-${Math.random()}.mjs`);
66
- const baseURL = toUrlPath("/");
67
-
68
- const config: Config = await generateConfigFromFileTree({
69
- baseDir: functionsDirectory,
70
- baseURL,
71
- });
72
-
73
- if (!config.routes || config.routes.length === 0) {
74
- throw new FunctionsNoRoutesError(
75
- `Failed to find any routes while compiling Functions in: ${functionsDirectory}`
76
- );
77
- }
78
-
79
- if (routesOutputPath) {
80
- const routesJSON = convertRoutesToRoutesJSONSpec(config.routes);
81
- writeFileSync(routesOutputPath, JSON.stringify(routesJSON, null, 2));
82
- }
83
-
84
- if (outputConfigPath) {
85
- writeFileSync(
86
- outputConfigPath,
87
- JSON.stringify({ ...config, baseURL }, null, 2)
88
- );
89
- }
90
-
91
- await writeRoutesModule({
92
- config,
93
- srcDir: functionsDirectory,
94
- outfile: routesModule,
95
- });
96
-
97
- const absoluteFunctionsDirectory = resolve(functionsDirectory);
98
- let bundle: BundleResult;
99
-
100
- if (plugin) {
101
- if (outdir === undefined) {
102
- throw new FatalError(
103
- "Must specify an output directory when building a Plugin.",
104
- 1
105
- );
106
- }
107
-
108
- bundle = await buildPlugin({
109
- routesModule,
110
- outdir,
111
- minify,
112
- sourcemap,
113
- watch,
114
- legacyNodeCompat,
115
- functionsDirectory: absoluteFunctionsDirectory,
116
- local,
117
- betaD1Shims: d1Databases,
118
- });
119
- } else {
120
- bundle = await buildWorker({
121
- routesModule,
122
- outfile,
123
- outdir,
124
- minify,
125
- sourcemap,
126
- fallbackService,
127
- watch,
128
- functionsDirectory: absoluteFunctionsDirectory,
129
- local,
130
- betaD1Shims: d1Databases,
131
- onEnd,
132
- buildOutputDirectory,
133
- legacyNodeCompat,
134
- nodejsCompat,
135
- });
136
- }
137
-
138
- RUNNING_BUILDERS.push(bundle);
139
- return bundle;
140
- }
@@ -1,18 +0,0 @@
1
- import { version as wranglerVersion } from "../../package.json";
2
-
3
- export const MAX_ASSET_COUNT = 20_000;
4
- export const MAX_ASSET_SIZE = 25 * 1024 * 1024;
5
- export const PAGES_CONFIG_CACHE_FILENAME = "pages.json";
6
- export const MAX_BUCKET_SIZE = 50 * 1024 * 1024;
7
- export const MAX_BUCKET_FILE_COUNT = 5000;
8
- export const BULK_UPLOAD_CONCURRENCY = 3;
9
- export const MAX_UPLOAD_ATTEMPTS = 5;
10
- export const MAX_CHECK_MISSING_ATTEMPTS = 5;
11
- export const SECONDS_TO_WAIT_FOR_PROXY = 5;
12
- export const isInPagesCI = !!process.env.CF_PAGES;
13
- /** Max number of rules in _routes.json */
14
- export const MAX_FUNCTIONS_ROUTES_RULES = 100;
15
- /** Max char length of each rule in _routes.json */
16
- export const MAX_FUNCTIONS_ROUTES_RULE_LENGTH = 100;
17
- export const ROUTES_SPEC_VERSION = 1;
18
- export const ROUTES_SPEC_DESCRIPTION = `Generated by wrangler@${wranglerVersion}`;
@@ -1,281 +0,0 @@
1
- import { setTimeout } from "node:timers/promises";
2
- import onExit from "signal-exit";
3
- import { printWranglerBanner } from "..";
4
- import { fetchResult } from "../cfetch";
5
- import { readConfig } from "../config";
6
- import { getConfigCache } from "../config-cache";
7
- import { FatalError } from "../errors";
8
- import isInteractive from "../is-interactive";
9
- import { logger } from "../logger";
10
- import * as metrics from "../metrics";
11
- import {
12
- jsonPrintLogs,
13
- prettyPrintLogs,
14
- createPagesTail,
15
- } from "../tail/createTail";
16
- import { translateCLICommandToFilterMessage } from "../tail/filters";
17
- import { requireAuth } from "../user";
18
- import { PAGES_CONFIG_CACHE_FILENAME } from "./constants";
19
- import { promptSelectProject } from "./prompt-select-project";
20
- import { isUrl } from "./utils";
21
- import type {
22
- CommonYargsArgv,
23
- StrictYargsOptionsToInterface,
24
- } from "../yargs-types";
25
- import type { Deployment, PagesConfigCache } from "./types";
26
-
27
- const statusChoices = ["ok", "error", "canceled"] as const;
28
- type StatusChoice = typeof statusChoices[number];
29
- const isStatusChoiceList = (
30
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
31
- data?: any[]
32
- ): data is StatusChoice[] =>
33
- data?.every((d) => statusChoices.includes(d)) ?? false;
34
-
35
- export function Options(yargs: CommonYargsArgv) {
36
- return (
37
- yargs
38
- .positional("deployment", {
39
- type: "string",
40
- description:
41
- "(Optional) ID or URL of the deployment to tail. " +
42
- "Specify by environment if deployment ID is unknown.",
43
- })
44
- .options({
45
- "project-name": {
46
- type: "string",
47
- description: "The name of the project you would like to tail",
48
- },
49
- environment: {
50
- type: "string",
51
- choices: ["production", "preview"],
52
- default: "production",
53
- description:
54
- "When not providing a specific deployment ID, " +
55
- "specifying environment will grab the latest production or " +
56
- "preview deployment",
57
- },
58
- })
59
- .option("format", {
60
- default: process.stdout.isTTY ? "pretty" : "json",
61
- choices: ["json", "pretty"],
62
- describe: "The format of log entries",
63
- })
64
- .option("debug", {
65
- type: "boolean",
66
- hidden: true,
67
- default: false,
68
- describe:
69
- "If a log would have been filtered out, send it through " +
70
- "anyway alongside the filter which would have blocked it.",
71
- })
72
- // Tail filters;
73
- .option("status", {
74
- choices: statusChoices,
75
- describe: "Filter by invocation status",
76
- array: true,
77
- })
78
- .option("header", {
79
- type: "string",
80
- requiresArg: true,
81
- describe: "Filter by HTTP header",
82
- })
83
- .option("method", {
84
- type: "string",
85
- requiresArg: true,
86
- describe: "Filter by HTTP method",
87
- array: true,
88
- })
89
- .option("search", {
90
- type: "string",
91
- requiresArg: true,
92
- describe: "Filter by a text match in console.log messages",
93
- })
94
- .option("sampling-rate", {
95
- type: "number",
96
- describe: "Adds a percentage of requests to log sampling rate",
97
- })
98
- .option("ip", {
99
- type: "string",
100
- requiresArg: true,
101
- describe:
102
- "Filter by the IP address the request originates from. Use " +
103
- '"self" to filter for your own IP',
104
- array: true,
105
- })
106
- );
107
- }
108
-
109
- export async function Handler({
110
- deployment,
111
- projectName,
112
- environment,
113
- header,
114
- ip: clientIp,
115
- method,
116
- samplingRate,
117
- search,
118
- status,
119
- format = "pretty",
120
- debug,
121
- ...args
122
- }: StrictYargsOptionsToInterface<typeof Options>) {
123
- if (status && !isStatusChoiceList(status)) {
124
- throw new FatalError(
125
- "Invalid value for `--status`. Valid options: " + statusChoices.join(", ")
126
- );
127
- }
128
-
129
- if (format === "pretty") {
130
- await printWranglerBanner();
131
- }
132
-
133
- const config = readConfig(args.config, args);
134
- const pagesConfig = getConfigCache<PagesConfigCache>(
135
- PAGES_CONFIG_CACHE_FILENAME
136
- );
137
- const accountId = await requireAuth(pagesConfig);
138
- let deploymentId = deployment;
139
-
140
- if (!isInteractive()) {
141
- if (!deploymentId) {
142
- throw new FatalError(
143
- "Must specify a deployment in non-interactive mode.",
144
- 1
145
- );
146
- }
147
-
148
- if (!projectName) {
149
- throw new FatalError(
150
- "Must specify a project name in non-interactive mode.",
151
- 1
152
- );
153
- }
154
- }
155
-
156
- if (!projectName && isInteractive()) {
157
- projectName = await promptSelectProject({ accountId });
158
- }
159
-
160
- if (!deployment && !projectName) {
161
- throw new FatalError("Must specify a project name or deployment.", 1);
162
- }
163
-
164
- const deployments: Array<Deployment> = await fetchResult(
165
- `/accounts/${accountId}/pages/projects/${projectName}/deployments`
166
- );
167
-
168
- const envDeployments = deployments.filter(
169
- (d) => d.environment === environment
170
- );
171
-
172
- // Deployment is URL
173
- if (isUrl(deployment)) {
174
- const { hostname: deploymentHostname } = new URL(deployment);
175
- const targetDeployment = envDeployments.find(
176
- (d) => new URL(d.url).hostname === deploymentHostname
177
- );
178
-
179
- if (!targetDeployment) {
180
- throw new FatalError(
181
- "Could not find deployment match url: " + deployment,
182
- 1
183
- );
184
- }
185
-
186
- deploymentId = targetDeployment.id;
187
- } else if (!deployment) {
188
- if (envDeployments.length === 0) {
189
- throw new FatalError("No deployments for environment: " + environment, 1);
190
- }
191
-
192
- if (format === "pretty") {
193
- logger.log(
194
- "No deployment specified. Using latest deployment for",
195
- environment,
196
- "environment."
197
- );
198
- }
199
-
200
- const latestDeployment = envDeployments
201
- .map((d) => ({ id: d.id, created_on: new Date(d.created_on) }))
202
- .sort((a, b) => +b.created_on - +a.created_on)[0];
203
-
204
- deploymentId = latestDeployment.id;
205
- }
206
-
207
- if (!deploymentId || !projectName) {
208
- throw new FatalError("An unknown error occurred.", 1);
209
- }
210
-
211
- const filters = translateCLICommandToFilterMessage({
212
- header,
213
- clientIp,
214
- method,
215
- samplingRate,
216
- search,
217
- status,
218
- });
219
-
220
- await metrics.sendMetricsEvent("begin pages log stream", {
221
- sendMetrics: config.send_metrics,
222
- });
223
-
224
- const { tail, deleteTail } = await createPagesTail({
225
- accountId,
226
- projectName,
227
- deploymentId,
228
- filters,
229
- debug,
230
- });
231
-
232
- const onCloseTail = (() => {
233
- let didTerminate = false;
234
-
235
- return async () => {
236
- if (didTerminate) return;
237
-
238
- tail.terminate();
239
- await deleteTail();
240
- await metrics.sendMetricsEvent("end pages log stream", {
241
- sendMetrics: config.send_metrics,
242
- });
243
-
244
- didTerminate = true;
245
- };
246
- })();
247
-
248
- onExit(onCloseTail);
249
-
250
- tail.on("message", (data) => {
251
- if (format === "pretty") {
252
- prettyPrintLogs(data);
253
- } else {
254
- jsonPrintLogs(data);
255
- }
256
- });
257
-
258
- tail.on("close", onCloseTail);
259
-
260
- while (tail.readyState !== tail.OPEN) {
261
- switch (tail.readyState) {
262
- case tail.CONNECTING:
263
- await setTimeout(100);
264
- break;
265
- case tail.CLOSING:
266
- await setTimeout(100);
267
- break;
268
- case tail.CLOSED:
269
- await metrics.sendMetricsEvent("end log stream", {
270
- sendMetrics: config.send_metrics,
271
- });
272
- throw new Error(
273
- `Connection to deployment ${deploymentId} closed unexpectedly.`
274
- );
275
- }
276
- }
277
-
278
- if (format === "pretty") {
279
- logger.log(`Connected to deployment ${deploymentId}, waiting for logs...`);
280
- }
281
- }
@@ -1,84 +0,0 @@
1
- import Table from "ink-table";
2
- import React from "react";
3
- import { format as timeagoFormat } from "timeago.js";
4
- import { fetchResult } from "../cfetch";
5
- import { getConfigCache, saveToConfigCache } from "../config-cache";
6
- import { FatalError } from "../errors";
7
- import { logger } from "../logger";
8
- import * as metrics from "../metrics";
9
- import { requireAuth } from "../user";
10
- import { renderToString } from "../utils/render";
11
- import { PAGES_CONFIG_CACHE_FILENAME } from "./constants";
12
- import { promptSelectProject } from "./prompt-select-project";
13
- import { pagesBetaWarning } from "./utils";
14
- import type {
15
- CommonYargsArgv,
16
- StrictYargsOptionsToInterface,
17
- } from "../yargs-types";
18
- import type { Deployment, PagesConfigCache } from "./types";
19
-
20
- type ListArgs = StrictYargsOptionsToInterface<typeof ListOptions>;
21
-
22
- export function ListOptions(yargs: CommonYargsArgv) {
23
- return yargs
24
- .options({
25
- "project-name": {
26
- type: "string",
27
- description:
28
- "The name of the project you would like to list deployments for",
29
- },
30
- })
31
- .epilogue(pagesBetaWarning);
32
- }
33
-
34
- export async function ListHandler({ projectName }: ListArgs) {
35
- const config = getConfigCache<PagesConfigCache>(PAGES_CONFIG_CACHE_FILENAME);
36
- const accountId = await requireAuth(config);
37
-
38
- projectName ??= config.project_name;
39
-
40
- const isInteractive = process.stdin.isTTY;
41
- if (!projectName && isInteractive) {
42
- projectName = await promptSelectProject({ accountId });
43
- }
44
-
45
- if (!projectName) {
46
- throw new FatalError("Must specify a project name.", 1);
47
- }
48
-
49
- const deployments: Array<Deployment> = await fetchResult(
50
- `/accounts/${accountId}/pages/projects/${projectName}/deployments`
51
- );
52
-
53
- const titleCase = (word: string) =>
54
- word.charAt(0).toUpperCase() + word.slice(1);
55
-
56
- const shortSha = (sha: string) => sha.slice(0, 7);
57
-
58
- const getStatus = (deployment: Deployment) => {
59
- // Return a pretty time since timestamp if successful otherwise the status
60
- if (deployment.latest_stage.status === `success`) {
61
- return timeagoFormat(deployment.latest_stage.ended_on);
62
- }
63
- return titleCase(deployment.latest_stage.status);
64
- };
65
-
66
- const data = deployments.map((deployment) => {
67
- return {
68
- Environment: titleCase(deployment.environment),
69
- Branch: deployment.deployment_trigger.metadata.branch,
70
- Source: shortSha(deployment.deployment_trigger.metadata.commit_hash),
71
- Deployment: deployment.url,
72
- Status: getStatus(deployment),
73
- // TODO: Use a url shortener
74
- Build: `https://dash.cloudflare.com/${accountId}/pages/view/${deployment.project_name}/${deployment.id}`,
75
- };
76
- });
77
-
78
- saveToConfigCache<PagesConfigCache>(PAGES_CONFIG_CACHE_FILENAME, {
79
- account_id: accountId,
80
- });
81
-
82
- logger.log(renderToString(<Table data={data}></Table>));
83
- await metrics.sendMetricsEvent("list pages deployments");
84
- }