wrangler 0.0.0-e4ca780f → 0.0.0-e4ef867c

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 (299) hide show
  1. package/README.md +10 -12
  2. package/bin/wrangler.js +9 -75
  3. package/package.json +14 -18
  4. package/templates/__tests__/tsconfig.json +1 -1
  5. package/templates/checked-fetch.js +10 -3
  6. package/templates/facade.d.ts +4 -1
  7. package/templates/middleware/common.ts +9 -4
  8. package/templates/middleware/loader-modules.ts +64 -11
  9. package/templates/middleware/loader-sw.ts +2 -7
  10. package/templates/middleware/middleware-d1-beta.d.ts +3 -0
  11. package/templates/{d1-beta-facade.js → middleware/middleware-d1-beta.ts} +85 -85
  12. package/templates/middleware/middleware-multiworker-dev.d.ts +4 -0
  13. package/templates/middleware/middleware-multiworker-dev.ts +59 -0
  14. package/templates/middleware/middleware-serve-static-assets.d.ts +6 -0
  15. package/templates/middleware/middleware-serve-static-assets.ts +56 -0
  16. package/templates/new-worker-scheduled.ts +1 -1
  17. package/templates/new-worker.ts +1 -1
  18. package/templates/pages-dev-util.ts +4 -1
  19. package/templates/pages-shim.ts +0 -3
  20. package/templates/pages-template-plugin.ts +12 -2
  21. package/templates/pages-template-worker.ts +11 -2
  22. package/templates/tsconfig.json +1 -1
  23. package/wrangler-dist/cli.d.ts +160 -75
  24. package/wrangler-dist/cli.js +70601 -73813
  25. package/import_meta_url.js +0 -3
  26. package/miniflare-config-stubs/.env.empty +0 -0
  27. package/miniflare-config-stubs/package.empty.json +0 -1
  28. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  29. package/miniflare-dist/index.mjs +0 -6395
  30. package/src/__tests__/access.test.ts +0 -25
  31. package/src/__tests__/api-dev.test.ts +0 -238
  32. package/src/__tests__/api-devregistry.test.ts +0 -121
  33. package/src/__tests__/api.test.ts +0 -102
  34. package/src/__tests__/config-cache-without-cache-dir.test.ts +0 -38
  35. package/src/__tests__/config-cache.test.ts +0 -42
  36. package/src/__tests__/configuration.test.ts +0 -4509
  37. package/src/__tests__/d1/d1.test.ts +0 -82
  38. package/src/__tests__/d1/execute.test.ts +0 -66
  39. package/src/__tests__/d1/migrate.test.ts +0 -157
  40. package/src/__tests__/d1/splitter.test.ts +0 -255
  41. package/src/__tests__/delete.test.ts +0 -272
  42. package/src/__tests__/deployments.test.ts +0 -369
  43. package/src/__tests__/dev.test.tsx +0 -1617
  44. package/src/__tests__/generate.test.ts +0 -237
  45. package/src/__tests__/get-host-from-url.test.ts +0 -16
  46. package/src/__tests__/guess-worker-format.test.ts +0 -120
  47. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  48. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  49. package/src/__tests__/helpers/end-event-loop.ts +0 -6
  50. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  51. package/src/__tests__/helpers/mock-auth-domain.ts +0 -20
  52. package/src/__tests__/helpers/mock-bin.ts +0 -36
  53. package/src/__tests__/helpers/mock-console.ts +0 -112
  54. package/src/__tests__/helpers/mock-dialogs.ts +0 -139
  55. package/src/__tests__/helpers/mock-get-pages-upload-token.ts +0 -25
  56. package/src/__tests__/helpers/mock-get-zone-from-host.ts +0 -11
  57. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  58. package/src/__tests__/helpers/mock-istty.ts +0 -74
  59. package/src/__tests__/helpers/mock-known-routes.ts +0 -12
  60. package/src/__tests__/helpers/mock-kv.ts +0 -46
  61. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -263
  62. package/src/__tests__/helpers/mock-process.ts +0 -34
  63. package/src/__tests__/helpers/mock-set-timeout.ts +0 -16
  64. package/src/__tests__/helpers/mock-stdin.ts +0 -108
  65. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  66. package/src/__tests__/helpers/msw/blob-worker.cjs +0 -19
  67. package/src/__tests__/helpers/msw/handlers/access.ts +0 -13
  68. package/src/__tests__/helpers/msw/handlers/deployments.ts +0 -160
  69. package/src/__tests__/helpers/msw/handlers/namespaces.ts +0 -81
  70. package/src/__tests__/helpers/msw/handlers/oauth.ts +0 -31
  71. package/src/__tests__/helpers/msw/handlers/r2.ts +0 -60
  72. package/src/__tests__/helpers/msw/handlers/script.ts +0 -56
  73. package/src/__tests__/helpers/msw/handlers/user.ts +0 -52
  74. package/src/__tests__/helpers/msw/handlers/zones.ts +0 -20
  75. package/src/__tests__/helpers/msw/index.ts +0 -52
  76. package/src/__tests__/helpers/msw/read-file-sync.js +0 -61
  77. package/src/__tests__/helpers/run-in-tmp.ts +0 -38
  78. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  79. package/src/__tests__/helpers/string-dynamic-values-matcher.ts +0 -28
  80. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +0 -1
  81. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +0 -5
  82. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +0 -1
  83. package/src/__tests__/helpers/worker-scripts/parent-worker.js +0 -11
  84. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +0 -5
  85. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  86. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  87. package/src/__tests__/https-options.test.ts +0 -163
  88. package/src/__tests__/index.test.ts +0 -280
  89. package/src/__tests__/init.test.ts +0 -3196
  90. package/src/__tests__/jest.setup.ts +0 -179
  91. package/src/__tests__/kv.test.ts +0 -1799
  92. package/src/__tests__/logger.test.ts +0 -207
  93. package/src/__tests__/logout.test.ts +0 -47
  94. package/src/__tests__/metrics.test.ts +0 -493
  95. package/src/__tests__/middleware.scheduled.test.ts +0 -145
  96. package/src/__tests__/middleware.test.ts +0 -816
  97. package/src/__tests__/mtls-certificates.test.ts +0 -588
  98. package/src/__tests__/package-manager.test.ts +0 -353
  99. package/src/__tests__/pages/deployment-list.test.ts +0 -80
  100. package/src/__tests__/pages/functions-build.test.ts +0 -452
  101. package/src/__tests__/pages/pages.test.ts +0 -81
  102. package/src/__tests__/pages/project-create.test.ts +0 -63
  103. package/src/__tests__/pages/project-list.test.ts +0 -110
  104. package/src/__tests__/pages/project-upload.test.ts +0 -500
  105. package/src/__tests__/pages/publish.test.ts +0 -2864
  106. package/src/__tests__/pages-deployment-tail.test.ts +0 -955
  107. package/src/__tests__/parse.test.ts +0 -436
  108. package/src/__tests__/paths.test.ts +0 -39
  109. package/src/__tests__/publish.test.ts +0 -8423
  110. package/src/__tests__/pubsub.test.ts +0 -496
  111. package/src/__tests__/queues.test.ts +0 -532
  112. package/src/__tests__/r2.test.ts +0 -374
  113. package/src/__tests__/route.test.ts +0 -45
  114. package/src/__tests__/secret.test.ts +0 -693
  115. package/src/__tests__/tail.test.ts +0 -958
  116. package/src/__tests__/test-old-node-version.js +0 -31
  117. package/src/__tests__/traverse-module-graph.test.ts +0 -220
  118. package/src/__tests__/tsconfig-sanity.ts +0 -12
  119. package/src/__tests__/tsconfig.json +0 -8
  120. package/src/__tests__/tsconfig.tsbuildinfo +0 -1
  121. package/src/__tests__/type-generation.test.ts +0 -234
  122. package/src/__tests__/user.test.ts +0 -118
  123. package/src/__tests__/utils-collectKeyValues.test.ts +0 -47
  124. package/src/__tests__/validate-dev-props.test.ts +0 -56
  125. package/src/__tests__/version.test.ts +0 -35
  126. package/src/__tests__/whoami.test.tsx +0 -172
  127. package/src/__tests__/worker-namespace.test.ts +0 -340
  128. package/src/abort.d.ts +0 -3
  129. package/src/api/dev.ts +0 -316
  130. package/src/api/index.ts +0 -11
  131. package/src/api/mtls-certificate.ts +0 -148
  132. package/src/api/pages/create-worker-bundle-contents.ts +0 -76
  133. package/src/api/pages/index.ts +0 -5
  134. package/src/api/pages/publish.tsx +0 -355
  135. package/src/bundle-reporter.ts +0 -68
  136. package/src/bundle.ts +0 -908
  137. package/src/cfetch/index.ts +0 -158
  138. package/src/cfetch/internal.ts +0 -258
  139. package/src/cli.ts +0 -28
  140. package/src/config/README.md +0 -107
  141. package/src/config/config.ts +0 -282
  142. package/src/config/diagnostics.ts +0 -80
  143. package/src/config/environment.ts +0 -618
  144. package/src/config/index.ts +0 -403
  145. package/src/config/validation-helpers.ts +0 -597
  146. package/src/config/validation.ts +0 -2342
  147. package/src/config-cache.ts +0 -85
  148. package/src/create-worker-preview.ts +0 -293
  149. package/src/create-worker-upload-form.ts +0 -359
  150. package/src/d1/backups.tsx +0 -219
  151. package/src/d1/constants.ts +0 -2
  152. package/src/d1/create.tsx +0 -68
  153. package/src/d1/delete.ts +0 -53
  154. package/src/d1/execute.tsx +0 -357
  155. package/src/d1/formatTimeAgo.ts +0 -14
  156. package/src/d1/index.ts +0 -100
  157. package/src/d1/list.tsx +0 -60
  158. package/src/d1/migrations/apply.tsx +0 -212
  159. package/src/d1/migrations/create.tsx +0 -79
  160. package/src/d1/migrations/helpers.ts +0 -172
  161. package/src/d1/migrations/index.ts +0 -3
  162. package/src/d1/migrations/list.tsx +0 -95
  163. package/src/d1/migrations/options.ts +0 -23
  164. package/src/d1/options.ts +0 -22
  165. package/src/d1/splitter.ts +0 -161
  166. package/src/d1/types.ts +0 -25
  167. package/src/d1/utils.ts +0 -49
  168. package/src/delete.ts +0 -100
  169. package/src/deployments.ts +0 -368
  170. package/src/deprecated/index.ts +0 -144
  171. package/src/dev/dev-vars.ts +0 -39
  172. package/src/dev/dev.tsx +0 -600
  173. package/src/dev/get-local-persistence-path.ts +0 -31
  174. package/src/dev/local.tsx +0 -920
  175. package/src/dev/remote.tsx +0 -632
  176. package/src/dev/start-server.ts +0 -534
  177. package/src/dev/use-esbuild.ts +0 -203
  178. package/src/dev/validate-dev-props.ts +0 -40
  179. package/src/dev-registry.ts +0 -202
  180. package/src/dev.tsx +0 -929
  181. package/src/dialogs.ts +0 -136
  182. package/src/dispatch-namespace.ts +0 -211
  183. package/src/docs/index.ts +0 -97
  184. package/src/durable.ts +0 -102
  185. package/src/entry.ts +0 -337
  186. package/src/environment-variables/factory.ts +0 -88
  187. package/src/environment-variables/misc-variables.ts +0 -30
  188. package/src/errors.ts +0 -11
  189. package/src/generate/index.ts +0 -298
  190. package/src/git-client.ts +0 -135
  191. package/src/global-wrangler-config-path.ts +0 -26
  192. package/src/https-options.ts +0 -127
  193. package/src/index.ts +0 -758
  194. package/src/init.ts +0 -1032
  195. package/src/inspect.ts +0 -782
  196. package/src/intl-polyfill.d.ts +0 -139
  197. package/src/is-ci.ts +0 -14
  198. package/src/is-interactive.ts +0 -16
  199. package/src/jest.d.ts +0 -4
  200. package/src/kv/helpers.ts +0 -430
  201. package/src/kv/index.ts +0 -594
  202. package/src/logger.ts +0 -119
  203. package/src/metrics/index.ts +0 -5
  204. package/src/metrics/metrics-config.ts +0 -239
  205. package/src/metrics/metrics-dispatcher.ts +0 -96
  206. package/src/metrics/metrics-usage-headers.ts +0 -24
  207. package/src/metrics/send-event.ts +0 -99
  208. package/src/miniflare-cli/README.md +0 -30
  209. package/src/miniflare-cli/assets.ts +0 -251
  210. package/src/miniflare-cli/index.ts +0 -210
  211. package/src/miniflare-cli/request-context.ts +0 -40
  212. package/src/miniflare-cli/tsconfig.json +0 -9
  213. package/src/miniflare-cli/tsconfig.tsbuildinfo +0 -1
  214. package/src/miniflare-cli/types.ts +0 -11
  215. package/src/module-collection.ts +0 -333
  216. package/src/mtls-certificate/cli.ts +0 -155
  217. package/src/open-in-browser.ts +0 -17
  218. package/src/package-manager.ts +0 -219
  219. package/src/pages/build.ts +0 -410
  220. package/src/pages/buildFunctions.ts +0 -140
  221. package/src/pages/constants.ts +0 -18
  222. package/src/pages/deployment-tails.ts +0 -281
  223. package/src/pages/deployments.tsx +0 -84
  224. package/src/pages/dev.ts +0 -716
  225. package/src/pages/errors.ts +0 -67
  226. package/src/pages/functions/buildPlugin.ts +0 -113
  227. package/src/pages/functions/buildWorker.ts +0 -291
  228. package/src/pages/functions/filepath-routing.test.ts +0 -234
  229. package/src/pages/functions/filepath-routing.ts +0 -189
  230. package/src/pages/functions/identifiers.ts +0 -78
  231. package/src/pages/functions/routes-consolidation.test.ts +0 -250
  232. package/src/pages/functions/routes-consolidation.ts +0 -73
  233. package/src/pages/functions/routes-transformation.test.ts +0 -282
  234. package/src/pages/functions/routes-transformation.ts +0 -115
  235. package/src/pages/functions/routes-validation.test.ts +0 -403
  236. package/src/pages/functions/routes-validation.ts +0 -202
  237. package/src/pages/functions/routes.ts +0 -151
  238. package/src/pages/functions/tsconfig.json +0 -8
  239. package/src/pages/functions/tsconfig.tsbuildinfo +0 -1
  240. package/src/pages/functions.ts +0 -86
  241. package/src/pages/hash.ts +0 -13
  242. package/src/pages/index.ts +0 -102
  243. package/src/pages/projects.tsx +0 -159
  244. package/src/pages/prompt-select-project.tsx +0 -31
  245. package/src/pages/publish.tsx +0 -267
  246. package/src/pages/types.ts +0 -46
  247. package/src/pages/upload.tsx +0 -469
  248. package/src/pages/utils.ts +0 -23
  249. package/src/parse.ts +0 -308
  250. package/src/paths.ts +0 -71
  251. package/src/proxy.ts +0 -694
  252. package/src/publish/index.ts +0 -274
  253. package/src/publish/publish.ts +0 -1060
  254. package/src/pubsub/index.ts +0 -286
  255. package/src/pubsub/pubsub-commands.ts +0 -623
  256. package/src/queues/cli/commands/consumer/add.ts +0 -71
  257. package/src/queues/cli/commands/consumer/index.ts +0 -19
  258. package/src/queues/cli/commands/consumer/remove.ts +0 -31
  259. package/src/queues/cli/commands/create.ts +0 -25
  260. package/src/queues/cli/commands/delete.ts +0 -26
  261. package/src/queues/cli/commands/index.ts +0 -35
  262. package/src/queues/cli/commands/list.ts +0 -25
  263. package/src/queues/client.ts +0 -136
  264. package/src/queues/utils.ts +0 -18
  265. package/src/r2/constants.ts +0 -4
  266. package/src/r2/helpers.ts +0 -132
  267. package/src/r2/index.ts +0 -289
  268. package/src/routes.ts +0 -140
  269. package/src/secret/index.ts +0 -376
  270. package/src/selfsigned.d.ts +0 -29
  271. package/src/sites.ts +0 -372
  272. package/src/tail/createTail.ts +0 -406
  273. package/src/tail/filters.ts +0 -277
  274. package/src/tail/index.ts +0 -211
  275. package/src/tail/printing.ts +0 -122
  276. package/src/traverse-module-graph.ts +0 -53
  277. package/src/tsconfig-sanity.ts +0 -16
  278. package/src/type-generation.ts +0 -181
  279. package/src/update-check.ts +0 -19
  280. package/src/user/access.ts +0 -68
  281. package/src/user/auth-variables.ts +0 -113
  282. package/src/user/choose-account.tsx +0 -39
  283. package/src/user/generate-auth-url.ts +0 -33
  284. package/src/user/generate-random-state.ts +0 -16
  285. package/src/user/index.ts +0 -2
  286. package/src/user/user.ts +0 -1233
  287. package/src/utils/collectKeyValues.ts +0 -14
  288. package/src/utils/render.ts +0 -93
  289. package/src/whoami.ts +0 -135
  290. package/src/worker.ts +0 -274
  291. package/src/yargs-types.ts +0 -37
  292. package/src/zones.ts +0 -191
  293. package/templates/__tests__/tsconfig.tsbuildinfo +0 -1
  294. package/templates/first-party-worker-module-facade.ts +0 -19
  295. package/templates/format-dev-errors.ts +0 -34
  296. package/templates/serve-static-assets.ts +0 -66
  297. package/templates/service-bindings-module-facade.js +0 -55
  298. package/templates/service-bindings-sw-facade.js +0 -42
  299. package/templates/tsconfig.tsbuildinfo +0 -1
@@ -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
- }