wrangler 0.0.0-e464fcdb → 0.0.0-e4abed3e

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 (326) hide show
  1. package/README.md +11 -13
  2. package/bin/wrangler.js +13 -102
  3. package/config-schema.json +3059 -0
  4. package/package.json +196 -199
  5. package/templates/__tests__/tsconfig.json +1 -1
  6. package/templates/checked-fetch.js +11 -4
  7. package/templates/facade.d.ts +7 -2
  8. package/templates/gitignore +2 -4
  9. package/templates/init-tests/test-vitest-new-worker.js +1 -1
  10. package/templates/init-tests/test-vitest-new-worker.ts +1 -1
  11. package/templates/middleware/common.ts +9 -4
  12. package/templates/middleware/loader-modules.ts +94 -44
  13. package/templates/middleware/loader-sw.ts +6 -10
  14. package/templates/middleware/middleware-ensure-req-body-drained.ts +18 -0
  15. package/templates/middleware/middleware-serve-static-assets.d.ts +6 -0
  16. package/templates/middleware/middleware-serve-static-assets.ts +56 -0
  17. package/templates/modules-watch-stub.js +4 -0
  18. package/templates/new-worker-scheduled.ts +1 -1
  19. package/templates/new-worker.ts +1 -1
  20. package/templates/pages-dev-pipeline.ts +2 -1
  21. package/templates/pages-dev-util.ts +4 -1
  22. package/templates/pages-shim.ts +0 -3
  23. package/templates/pages-template-plugin.ts +14 -4
  24. package/templates/pages-template-worker.ts +12 -3
  25. package/templates/startDevWorker/InspectorProxyWorker.ts +664 -0
  26. package/templates/startDevWorker/ProxyWorker.ts +334 -0
  27. package/templates/tsconfig.init.json +4 -87
  28. package/templates/tsconfig.json +1 -1
  29. package/wrangler-dist/InspectorProxyWorker.js +464 -0
  30. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  31. package/wrangler-dist/ProxyWorker.js +240 -0
  32. package/wrangler-dist/ProxyWorker.js.map +6 -0
  33. package/wrangler-dist/cli.d.ts +24996 -247
  34. package/wrangler-dist/cli.js +155069 -97472
  35. package/wrangler-dist/wasm-sync.wasm +0 -0
  36. package/Cloudflare_CA.pem +0 -18
  37. package/import_meta_url.js +0 -3
  38. package/miniflare-config-stubs/.env.empty +0 -0
  39. package/miniflare-config-stubs/package.empty.json +0 -1
  40. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  41. package/miniflare-dist/index.mjs +0 -6442
  42. package/src/__tests__/access.test.ts +0 -25
  43. package/src/__tests__/api-dev.test.ts +0 -238
  44. package/src/__tests__/api-devregistry.test.ts +0 -121
  45. package/src/__tests__/api.test.ts +0 -102
  46. package/src/__tests__/config-cache-without-cache-dir.test.ts +0 -38
  47. package/src/__tests__/config-cache.test.ts +0 -42
  48. package/src/__tests__/configuration.test.ts +0 -4509
  49. package/src/__tests__/constellation.test.ts +0 -371
  50. package/src/__tests__/d1/d1.test.ts +0 -82
  51. package/src/__tests__/d1/execute.test.ts +0 -66
  52. package/src/__tests__/d1/migrate.test.ts +0 -257
  53. package/src/__tests__/d1/splitter.test.ts +0 -255
  54. package/src/__tests__/delete.test.ts +0 -272
  55. package/src/__tests__/deployments.test.ts +0 -369
  56. package/src/__tests__/dev.test.tsx +0 -1617
  57. package/src/__tests__/generate.test.ts +0 -237
  58. package/src/__tests__/get-host-from-url.test.ts +0 -16
  59. package/src/__tests__/guess-worker-format.test.ts +0 -120
  60. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  61. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  62. package/src/__tests__/helpers/end-event-loop.ts +0 -6
  63. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  64. package/src/__tests__/helpers/mock-auth-domain.ts +0 -20
  65. package/src/__tests__/helpers/mock-bin.ts +0 -36
  66. package/src/__tests__/helpers/mock-console.ts +0 -112
  67. package/src/__tests__/helpers/mock-dialogs.ts +0 -139
  68. package/src/__tests__/helpers/mock-get-pages-upload-token.ts +0 -25
  69. package/src/__tests__/helpers/mock-get-zone-from-host.ts +0 -11
  70. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  71. package/src/__tests__/helpers/mock-istty.ts +0 -74
  72. package/src/__tests__/helpers/mock-known-routes.ts +0 -12
  73. package/src/__tests__/helpers/mock-kv.ts +0 -46
  74. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -263
  75. package/src/__tests__/helpers/mock-process.ts +0 -34
  76. package/src/__tests__/helpers/mock-set-timeout.ts +0 -16
  77. package/src/__tests__/helpers/mock-stdin.ts +0 -108
  78. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  79. package/src/__tests__/helpers/msw/blob-worker.cjs +0 -19
  80. package/src/__tests__/helpers/msw/handlers/access.ts +0 -13
  81. package/src/__tests__/helpers/msw/handlers/deployments.ts +0 -160
  82. package/src/__tests__/helpers/msw/handlers/namespaces.ts +0 -81
  83. package/src/__tests__/helpers/msw/handlers/oauth.ts +0 -31
  84. package/src/__tests__/helpers/msw/handlers/r2.ts +0 -60
  85. package/src/__tests__/helpers/msw/handlers/script.ts +0 -56
  86. package/src/__tests__/helpers/msw/handlers/user.ts +0 -52
  87. package/src/__tests__/helpers/msw/handlers/zones.ts +0 -20
  88. package/src/__tests__/helpers/msw/index.ts +0 -52
  89. package/src/__tests__/helpers/msw/read-file-sync.js +0 -61
  90. package/src/__tests__/helpers/run-in-tmp.ts +0 -38
  91. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  92. package/src/__tests__/helpers/string-dynamic-values-matcher.ts +0 -28
  93. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +0 -1
  94. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +0 -5
  95. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +0 -1
  96. package/src/__tests__/helpers/worker-scripts/parent-worker.js +0 -11
  97. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +0 -5
  98. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  99. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  100. package/src/__tests__/https-options.test.ts +0 -163
  101. package/src/__tests__/index.test.ts +0 -282
  102. package/src/__tests__/init.test.ts +0 -3196
  103. package/src/__tests__/jest.setup.ts +0 -179
  104. package/src/__tests__/kv.test.ts +0 -1799
  105. package/src/__tests__/logger.test.ts +0 -207
  106. package/src/__tests__/logout.test.ts +0 -47
  107. package/src/__tests__/metrics.test.ts +0 -493
  108. package/src/__tests__/middleware.scheduled.test.ts +0 -145
  109. package/src/__tests__/middleware.test.ts +0 -816
  110. package/src/__tests__/mtls-certificates.test.ts +0 -589
  111. package/src/__tests__/package-manager.test.ts +0 -353
  112. package/src/__tests__/pages/deployment-list.test.ts +0 -80
  113. package/src/__tests__/pages/functions-build.test.ts +0 -452
  114. package/src/__tests__/pages/pages.test.ts +0 -81
  115. package/src/__tests__/pages/project-create.test.ts +0 -63
  116. package/src/__tests__/pages/project-list.test.ts +0 -110
  117. package/src/__tests__/pages/project-upload.test.ts +0 -500
  118. package/src/__tests__/pages/publish.test.ts +0 -2864
  119. package/src/__tests__/pages-deployment-tail.test.ts +0 -955
  120. package/src/__tests__/parse.test.ts +0 -436
  121. package/src/__tests__/paths.test.ts +0 -39
  122. package/src/__tests__/publish.test.ts +0 -8849
  123. package/src/__tests__/pubsub.test.ts +0 -496
  124. package/src/__tests__/queues.test.ts +0 -532
  125. package/src/__tests__/r2.test.ts +0 -374
  126. package/src/__tests__/route.test.ts +0 -45
  127. package/src/__tests__/secret.test.ts +0 -693
  128. package/src/__tests__/tail.test.ts +0 -958
  129. package/src/__tests__/test-old-node-version.js +0 -31
  130. package/src/__tests__/traverse-module-graph.test.ts +0 -220
  131. package/src/__tests__/tsconfig-sanity.ts +0 -12
  132. package/src/__tests__/tsconfig.json +0 -8
  133. package/src/__tests__/tsconfig.tsbuildinfo +0 -1
  134. package/src/__tests__/type-generation.test.ts +0 -234
  135. package/src/__tests__/user.test.ts +0 -118
  136. package/src/__tests__/utils-collectKeyValues.test.ts +0 -47
  137. package/src/__tests__/validate-dev-props.test.ts +0 -56
  138. package/src/__tests__/version.test.ts +0 -35
  139. package/src/__tests__/whoami.test.tsx +0 -172
  140. package/src/__tests__/worker-namespace.test.ts +0 -340
  141. package/src/abort.d.ts +0 -3
  142. package/src/api/dev.ts +0 -316
  143. package/src/api/index.ts +0 -11
  144. package/src/api/mtls-certificate.ts +0 -148
  145. package/src/api/pages/create-worker-bundle-contents.ts +0 -76
  146. package/src/api/pages/index.ts +0 -5
  147. package/src/api/pages/publish.tsx +0 -355
  148. package/src/bundle-reporter.ts +0 -68
  149. package/src/bundle.ts +0 -908
  150. package/src/cfetch/index.ts +0 -158
  151. package/src/cfetch/internal.ts +0 -258
  152. package/src/cli.ts +0 -28
  153. package/src/config/README.md +0 -107
  154. package/src/config/config.ts +0 -282
  155. package/src/config/diagnostics.ts +0 -80
  156. package/src/config/environment.ts +0 -618
  157. package/src/config/index.ts +0 -403
  158. package/src/config/validation-helpers.ts +0 -597
  159. package/src/config/validation.ts +0 -2342
  160. package/src/config-cache.ts +0 -85
  161. package/src/constellation/createProject.tsx +0 -51
  162. package/src/constellation/deleteProject.ts +0 -51
  163. package/src/constellation/deleteProjectModel.ts +0 -68
  164. package/src/constellation/index.ts +0 -75
  165. package/src/constellation/listCatalog.tsx +0 -35
  166. package/src/constellation/listModel.tsx +0 -41
  167. package/src/constellation/listProject.tsx +0 -28
  168. package/src/constellation/listRuntime.tsx +0 -28
  169. package/src/constellation/options.ts +0 -17
  170. package/src/constellation/types.ts +0 -17
  171. package/src/constellation/uploadModel.tsx +0 -64
  172. package/src/constellation/utils.ts +0 -90
  173. package/src/create-worker-preview.ts +0 -293
  174. package/src/create-worker-upload-form.ts +0 -359
  175. package/src/d1/backups.tsx +0 -219
  176. package/src/d1/constants.ts +0 -6
  177. package/src/d1/create.tsx +0 -103
  178. package/src/d1/delete.ts +0 -53
  179. package/src/d1/execute.tsx +0 -371
  180. package/src/d1/formatTimeAgo.ts +0 -14
  181. package/src/d1/index.ts +0 -100
  182. package/src/d1/list.tsx +0 -62
  183. package/src/d1/migrations/apply.tsx +0 -235
  184. package/src/d1/migrations/create.tsx +0 -79
  185. package/src/d1/migrations/helpers.ts +0 -171
  186. package/src/d1/migrations/index.ts +0 -3
  187. package/src/d1/migrations/list.tsx +0 -95
  188. package/src/d1/migrations/options.ts +0 -23
  189. package/src/d1/options.ts +0 -22
  190. package/src/d1/splitter.ts +0 -161
  191. package/src/d1/types.ts +0 -32
  192. package/src/d1/utils.ts +0 -49
  193. package/src/delete.ts +0 -100
  194. package/src/deployments.ts +0 -368
  195. package/src/deprecated/index.ts +0 -144
  196. package/src/dev/dev-vars.ts +0 -39
  197. package/src/dev/dev.tsx +0 -600
  198. package/src/dev/get-local-persistence-path.ts +0 -31
  199. package/src/dev/local.tsx +0 -948
  200. package/src/dev/remote.tsx +0 -632
  201. package/src/dev/start-server.ts +0 -534
  202. package/src/dev/use-esbuild.ts +0 -203
  203. package/src/dev/validate-dev-props.ts +0 -40
  204. package/src/dev-registry.ts +0 -202
  205. package/src/dev.tsx +0 -929
  206. package/src/dialogs.ts +0 -136
  207. package/src/dispatch-namespace.ts +0 -211
  208. package/src/docs/helpers.ts +0 -50
  209. package/src/docs/index.ts +0 -54
  210. package/src/durable.ts +0 -102
  211. package/src/entry.ts +0 -337
  212. package/src/environment-variables/factory.ts +0 -89
  213. package/src/environment-variables/misc-variables.ts +0 -30
  214. package/src/errors.ts +0 -11
  215. package/src/generate/index.ts +0 -298
  216. package/src/git-client.ts +0 -135
  217. package/src/global-wrangler-config-path.ts +0 -26
  218. package/src/https-options.ts +0 -127
  219. package/src/index.ts +0 -768
  220. package/src/init.ts +0 -1032
  221. package/src/inspect.ts +0 -782
  222. package/src/intl-polyfill.d.ts +0 -139
  223. package/src/is-ci.ts +0 -14
  224. package/src/is-interactive.ts +0 -16
  225. package/src/jest.d.ts +0 -4
  226. package/src/kv/helpers.ts +0 -433
  227. package/src/kv/index.ts +0 -594
  228. package/src/logger.ts +0 -123
  229. package/src/metrics/index.ts +0 -5
  230. package/src/metrics/metrics-config.ts +0 -239
  231. package/src/metrics/metrics-dispatcher.ts +0 -96
  232. package/src/metrics/metrics-usage-headers.ts +0 -24
  233. package/src/metrics/send-event.ts +0 -99
  234. package/src/miniflare-cli/README.md +0 -30
  235. package/src/miniflare-cli/assets.ts +0 -251
  236. package/src/miniflare-cli/index.ts +0 -210
  237. package/src/miniflare-cli/request-context.ts +0 -40
  238. package/src/miniflare-cli/tsconfig.json +0 -9
  239. package/src/miniflare-cli/tsconfig.tsbuildinfo +0 -1
  240. package/src/miniflare-cli/types.ts +0 -11
  241. package/src/module-collection.ts +0 -333
  242. package/src/mtls-certificate/cli.ts +0 -155
  243. package/src/open-in-browser.ts +0 -17
  244. package/src/package-manager.ts +0 -219
  245. package/src/pages/build.ts +0 -410
  246. package/src/pages/buildFunctions.ts +0 -140
  247. package/src/pages/constants.ts +0 -18
  248. package/src/pages/deployment-tails.ts +0 -281
  249. package/src/pages/deployments.tsx +0 -84
  250. package/src/pages/dev.ts +0 -716
  251. package/src/pages/errors.ts +0 -67
  252. package/src/pages/functions/buildPlugin.ts +0 -113
  253. package/src/pages/functions/buildWorker.ts +0 -291
  254. package/src/pages/functions/filepath-routing.test.ts +0 -234
  255. package/src/pages/functions/filepath-routing.ts +0 -189
  256. package/src/pages/functions/identifiers.ts +0 -78
  257. package/src/pages/functions/routes-consolidation.test.ts +0 -250
  258. package/src/pages/functions/routes-consolidation.ts +0 -73
  259. package/src/pages/functions/routes-transformation.test.ts +0 -282
  260. package/src/pages/functions/routes-transformation.ts +0 -115
  261. package/src/pages/functions/routes-validation.test.ts +0 -403
  262. package/src/pages/functions/routes-validation.ts +0 -202
  263. package/src/pages/functions/routes.ts +0 -151
  264. package/src/pages/functions/tsconfig.json +0 -8
  265. package/src/pages/functions/tsconfig.tsbuildinfo +0 -1
  266. package/src/pages/functions.ts +0 -86
  267. package/src/pages/hash.ts +0 -13
  268. package/src/pages/index.ts +0 -102
  269. package/src/pages/projects.tsx +0 -159
  270. package/src/pages/prompt-select-project.tsx +0 -31
  271. package/src/pages/publish.tsx +0 -267
  272. package/src/pages/types.ts +0 -46
  273. package/src/pages/upload.tsx +0 -469
  274. package/src/pages/utils.ts +0 -23
  275. package/src/parse.ts +0 -308
  276. package/src/paths.ts +0 -71
  277. package/src/proxy.ts +0 -694
  278. package/src/publish/index.ts +0 -274
  279. package/src/publish/publish.ts +0 -1060
  280. package/src/pubsub/index.ts +0 -286
  281. package/src/pubsub/pubsub-commands.ts +0 -623
  282. package/src/queues/cli/commands/consumer/add.ts +0 -71
  283. package/src/queues/cli/commands/consumer/index.ts +0 -19
  284. package/src/queues/cli/commands/consumer/remove.ts +0 -31
  285. package/src/queues/cli/commands/create.ts +0 -25
  286. package/src/queues/cli/commands/delete.ts +0 -26
  287. package/src/queues/cli/commands/index.ts +0 -35
  288. package/src/queues/cli/commands/list.ts +0 -25
  289. package/src/queues/client.ts +0 -136
  290. package/src/queues/utils.ts +0 -18
  291. package/src/r2/constants.ts +0 -4
  292. package/src/r2/helpers.ts +0 -132
  293. package/src/r2/index.ts +0 -289
  294. package/src/routes.ts +0 -140
  295. package/src/secret/index.ts +0 -376
  296. package/src/selfsigned.d.ts +0 -29
  297. package/src/sites.ts +0 -484
  298. package/src/tail/createTail.ts +0 -406
  299. package/src/tail/filters.ts +0 -277
  300. package/src/tail/index.ts +0 -211
  301. package/src/tail/printing.ts +0 -122
  302. package/src/traverse-module-graph.ts +0 -53
  303. package/src/tsconfig-sanity.ts +0 -16
  304. package/src/type-generation.ts +0 -181
  305. package/src/update-check.ts +0 -19
  306. package/src/user/access.ts +0 -68
  307. package/src/user/auth-variables.ts +0 -113
  308. package/src/user/choose-account.tsx +0 -39
  309. package/src/user/generate-auth-url.ts +0 -33
  310. package/src/user/generate-random-state.ts +0 -16
  311. package/src/user/index.ts +0 -2
  312. package/src/user/user.ts +0 -1234
  313. package/src/utils/collectKeyValues.ts +0 -14
  314. package/src/utils/render.ts +0 -93
  315. package/src/whoami.ts +0 -135
  316. package/src/worker.ts +0 -274
  317. package/src/yargs-types.ts +0 -37
  318. package/src/zones.ts +0 -191
  319. package/templates/__tests__/tsconfig.tsbuildinfo +0 -1
  320. package/templates/d1-beta-facade.js +0 -244
  321. package/templates/first-party-worker-module-facade.ts +0 -19
  322. package/templates/format-dev-errors.ts +0 -34
  323. package/templates/serve-static-assets.ts +0 -66
  324. package/templates/service-bindings-module-facade.js +0 -55
  325. package/templates/service-bindings-sw-facade.js +0 -42
  326. package/templates/tsconfig.tsbuildinfo +0 -1
@@ -1,623 +0,0 @@
1
- import { readConfig } from "../config";
2
- import { confirm } from "../dialogs";
3
- import { CommandLineArgsError } from "../index";
4
- import { logger } from "../logger";
5
- import * as metrics from "../metrics";
6
- import { parseHumanDuration } from "../parse";
7
- import { requireAuth } from "../user";
8
- import * as pubsub from ".";
9
- import type { CommonYargsArgv, CommonYargsOptions } from "../yargs-types";
10
- import type { CommandModule } from "yargs";
11
-
12
- export function pubSubCommands(
13
- pubsubYargs: CommonYargsArgv,
14
- subHelp: CommandModule<CommonYargsOptions, CommonYargsOptions>
15
- ) {
16
- return pubsubYargs
17
- .command(subHelp)
18
- .command(
19
- "namespace",
20
- "Manage your Pub/Sub Namespaces",
21
- (pubsubNamespaceYargs) => {
22
- return pubsubNamespaceYargs
23
- .command(
24
- "create <name>",
25
- "Create a new Pub/Sub Namespace",
26
- (yargs) => {
27
- return yargs
28
- .positional("name", {
29
- describe:
30
- "The name of the new Namespace. This name will form part of the public endpoint, in the form <broker>.<namespace>.cloudflarepubsub.com",
31
- type: "string",
32
- demandOption: true,
33
- })
34
- .option("description", {
35
- describe: "Textual description of Namespace",
36
- type: "string",
37
- })
38
- .epilogue(pubsub.pubSubBetaWarning);
39
- },
40
- async (args) => {
41
- const config = readConfig(args.config, args);
42
- const accountId = await requireAuth(config);
43
-
44
- const namespace: pubsub.PubSubNamespace = {
45
- name: args.name,
46
- };
47
- if (args.description) {
48
- namespace.description = args.description;
49
- }
50
-
51
- logger.log(`Creating Pub/Sub Namespace ${args.name}...`);
52
- await pubsub.createPubSubNamespace(accountId, namespace);
53
- logger.log(`Success! Created Pub/Sub Namespace ${args.name}`);
54
- await metrics.sendMetricsEvent("create pubsub namespace", {
55
- sendMetrics: config.send_metrics,
56
- });
57
- }
58
- )
59
- .command(
60
- "list",
61
- "List your existing Pub/Sub Namespaces",
62
- (yargs) => {
63
- return yargs.epilogue(pubsub.pubSubBetaWarning);
64
- },
65
- async (args) => {
66
- const config = readConfig(args.config, args);
67
- const accountId = await requireAuth(config);
68
-
69
- logger.log(await pubsub.listPubSubNamespaces(accountId));
70
- await metrics.sendMetricsEvent("list pubsub namespaces", {
71
- sendMetrics: config.send_metrics,
72
- });
73
- }
74
- )
75
- .command(
76
- "delete <name>",
77
- "Delete a Pub/Sub Namespace",
78
- (yargs) => {
79
- return yargs
80
- .positional("name", {
81
- describe: "The name of the namespace to delete",
82
- type: "string",
83
- demandOption: true,
84
- })
85
- .epilogue(pubsub.pubSubBetaWarning);
86
- },
87
- async (args) => {
88
- const config = readConfig(args.config, args);
89
- const accountId = await requireAuth(config);
90
-
91
- if (
92
- await confirm(
93
- `️❗️ Are you sure you want to delete the Pub/Sub Namespace ${args.name}? This cannot be undone.\nThis name will be available for others to register.`
94
- )
95
- ) {
96
- logger.log(`Deleting namespace ${args.name}...`);
97
- await pubsub.deletePubSubNamespace(accountId, args.name);
98
- logger.log(`Deleted namespace ${args.name}.`);
99
- await metrics.sendMetricsEvent("delete pubsub namespace", {
100
- sendMetrics: config.send_metrics,
101
- });
102
- }
103
- }
104
- )
105
- .command(
106
- "describe <name>",
107
- "Describe a Pub/Sub Namespace",
108
- (yargs) => {
109
- return yargs
110
- .positional("name", {
111
- describe: "The name of the namespace to describe.",
112
- type: "string",
113
- demandOption: true,
114
- })
115
- .epilogue(pubsub.pubSubBetaWarning);
116
- },
117
- async (args) => {
118
- const config = readConfig(args.config, args);
119
- const accountId = await requireAuth(config);
120
-
121
- logger.log(
122
- await pubsub.describePubSubNamespace(accountId, args.name)
123
- );
124
- await metrics.sendMetricsEvent("view pubsub namespace", {
125
- sendMetrics: config.send_metrics,
126
- });
127
- }
128
- )
129
- .epilogue(pubsub.pubSubBetaWarning);
130
- }
131
- )
132
- .command("broker", "Interact with your Pub/Sub Brokers", (brokersYargs) => {
133
- brokersYargs.command(
134
- "create <name>",
135
- "Create a new Pub/Sub Broker",
136
- (yargs) =>
137
- yargs
138
- .positional("name", {
139
- describe:
140
- "The name of the Pub/Sub Broker. This name will form part of the public endpoint, in the form <broker>.<namespace>.cloudflarepubsub.com",
141
- type: "string",
142
- demandOption: true,
143
- })
144
- .option("namespace", {
145
- describe:
146
- "An existing Namespace to associate the Broker with. This name will form part of the public endpoint, in the form <broker>.<namespace>.cloudflarepubsub.com",
147
- type: "string",
148
- alias: "ns",
149
- demandOption: true,
150
- })
151
- .option("description", {
152
- describe: "Longer description for the broker",
153
- type: "string",
154
- })
155
- .option("expiration", {
156
- describe:
157
- "Time to allow token validity (can use seconds, hours, months, weeks, years)",
158
- type: "string",
159
- })
160
- .option("on-publish-url", {
161
- describe:
162
- "A (HTTPS) Cloudflare Worker (or webhook) URL that messages will be sent to on-publish.",
163
- type: "string",
164
- })
165
- .epilogue(pubsub.pubSubBetaWarning),
166
- async (args) => {
167
- const config = readConfig(args.config, args);
168
- const accountId = await requireAuth(config);
169
-
170
- const broker: pubsub.PubSubBroker = {
171
- name: args.name,
172
- };
173
- if (args.description) {
174
- broker.description = args.description;
175
- }
176
- if (args.expiration) {
177
- const expiration = parseHumanDuration(args.expiration);
178
- if (isNaN(expiration)) {
179
- throw new CommandLineArgsError(
180
- `${args.expiration} is not a time duration. (Example of valid values are: 1y, 6 days)`
181
- );
182
- }
183
- broker.expiration = expiration;
184
- }
185
- if (args["on-publish-url"]) {
186
- broker.on_publish = {
187
- url: args["on-publish-url"],
188
- };
189
- }
190
-
191
- logger.log(
192
- await pubsub.createPubSubBroker(accountId, args.namespace, broker)
193
- );
194
- await metrics.sendMetricsEvent("create pubsub broker", {
195
- sendMetrics: config.send_metrics,
196
- });
197
- }
198
- );
199
-
200
- brokersYargs.command(
201
- "update <name>",
202
- "Update an existing Pub/Sub Broker's configuration.",
203
- (yargs) =>
204
- yargs
205
- .positional("name", {
206
- describe: "The name of an existing Pub/Sub Broker",
207
- type: "string",
208
- demandOption: true,
209
- })
210
- .option("namespace", {
211
- describe: "The Namespace the Broker is associated with",
212
- type: "string",
213
- alias: "ns",
214
- demandOption: true,
215
- })
216
- .option("description", {
217
- describe: "A optional description of the Broker.",
218
- type: "string",
219
- })
220
- .option("expiration", {
221
- describe:
222
- "The expiration date for all client credentials issued by the Broker (can use seconds, hours, months, weeks, years)",
223
- type: "string",
224
- })
225
- .option("on-publish-url", {
226
- describe:
227
- "A (HTTPS) Cloudflare Worker (or webhook) URL that messages will be sent to on-publish.",
228
- type: "string",
229
- })
230
- .epilogue(pubsub.pubSubBetaWarning),
231
- async (args) => {
232
- const config = readConfig(args.config, args);
233
- const accountId = await requireAuth(config);
234
-
235
- const broker: pubsub.PubSubBrokerUpdate = {};
236
-
237
- if (args.description) {
238
- broker.description = args.description;
239
- }
240
-
241
- if (args.expiration) {
242
- const expiration = parseHumanDuration(args.expiration);
243
- if (isNaN(expiration)) {
244
- throw new CommandLineArgsError(
245
- `${args.expiration} is not a time duration. Examples of valid values include: '1y', '24h', or '6 days'.`
246
- );
247
- }
248
- broker.expiration = expiration;
249
- }
250
-
251
- if (args["on-publish-url"]) {
252
- broker.on_publish = {
253
- url: args["on-publish-url"],
254
- };
255
- }
256
-
257
- logger.log(
258
- await pubsub.updatePubSubBroker(
259
- accountId,
260
- args.namespace,
261
- args.name,
262
- broker
263
- )
264
- );
265
- logger.log(`Successfully updated Pub/Sub Broker ${args.name}`);
266
- await metrics.sendMetricsEvent("update pubsub broker", {
267
- sendMetrics: config.send_metrics,
268
- });
269
- }
270
- );
271
-
272
- brokersYargs.command(
273
- "list",
274
- "List the Pub/Sub Brokers within a Namespace",
275
- (yargs) => {
276
- return yargs
277
- .option("namespace", {
278
- describe: "The Namespace the Brokers are associated with.",
279
- type: "string",
280
- alias: "ns",
281
- demandOption: true,
282
- })
283
- .epilogue(pubsub.pubSubBetaWarning);
284
- },
285
- async (args) => {
286
- const config = readConfig(args.config, args);
287
- const accountId = await requireAuth(config);
288
-
289
- logger.log(await pubsub.listPubSubBrokers(accountId, args.namespace));
290
- await metrics.sendMetricsEvent("list pubsub brokers", {
291
- sendMetrics: config.send_metrics,
292
- });
293
- }
294
- );
295
-
296
- brokersYargs
297
- .command(
298
- "delete <name>",
299
- "Delete an existing Pub/Sub Broker",
300
- (yargs) => {
301
- return yargs
302
- .positional("name", {
303
- describe: "The name of the Broker to delete",
304
- type: "string",
305
- demandOption: true,
306
- })
307
- .option("namespace", {
308
- describe: "The Namespace the Broker is associated with.",
309
- type: "string",
310
- alias: "ns",
311
- demandOption: true,
312
- })
313
- .epilogue(pubsub.pubSubBetaWarning);
314
- },
315
- async (args) => {
316
- const config = readConfig(args.config, args);
317
- const accountId = await requireAuth(config);
318
-
319
- if (
320
- await confirm(
321
- `️❗️ Are you sure you want to delete the Pub/Sub Broker ${args.name}? This cannot be undone.\nAll existing clients will be disconnected.`
322
- )
323
- ) {
324
- logger.log(`Deleting Pub/Sub Broker ${args.name}.`);
325
- await pubsub.deletePubSubBroker(
326
- accountId,
327
- args.namespace,
328
- args.name
329
- );
330
- logger.log(`Deleted Pub/Sub Broker ${args.name}.`);
331
- await metrics.sendMetricsEvent("delete pubsub broker", {
332
- sendMetrics: config.send_metrics,
333
- });
334
- }
335
- }
336
- )
337
- .command(
338
- "describe <name>",
339
- "Describe an existing Pub/Sub Broker.",
340
- (yargs) => {
341
- return yargs
342
- .positional("name", {
343
- describe: "The name of the Broker to describe.",
344
- type: "string",
345
- demandOption: true,
346
- })
347
- .option("namespace", {
348
- describe: "The Namespace the Broker is associated with.",
349
- type: "string",
350
- alias: "ns",
351
- demandOption: true,
352
- })
353
- .epilogue(pubsub.pubSubBetaWarning);
354
- },
355
- async (args) => {
356
- const config = readConfig(args.config, args);
357
- const accountId = await requireAuth(config);
358
-
359
- logger.log(
360
- await pubsub.describePubSubBroker(
361
- accountId,
362
- args.namespace,
363
- args.name
364
- )
365
- );
366
- await metrics.sendMetricsEvent("view pubsub broker", {
367
- sendMetrics: config.send_metrics,
368
- });
369
- }
370
- );
371
-
372
- brokersYargs.command(
373
- "issue <name>",
374
- "Issue new client credentials for a specific Pub/Sub Broker.",
375
- (yargs) => {
376
- return yargs
377
- .positional("name", {
378
- describe: "The name of the Broker to issue credentials for.",
379
- type: "string",
380
- demandOption: true,
381
- })
382
- .option("namespace", {
383
- describe: "The Namespace the Broker is associated with.",
384
- type: "string",
385
- alias: "ns",
386
- demandOption: true,
387
- })
388
- .option("number", {
389
- describe: "The number of credentials to generate.",
390
- type: "number",
391
- alias: "n",
392
- default: 1,
393
- })
394
- .option("type", {
395
- describe: "The type of credential to generate.",
396
- type: "string",
397
- default: "TOKEN",
398
- })
399
- .option("expiration", {
400
- describe:
401
- "The expiration to set on the issued credentials. This overrides any Broker-level expiration that is set.",
402
- type: "string",
403
- alias: "exp",
404
- })
405
- .option("client-id", {
406
- describe:
407
- "A list of existing clientIds to generate tokens for. By default, clientIds are randomly generated.",
408
- type: "string",
409
- alias: "jti",
410
- array: true,
411
- })
412
- .epilogue(pubsub.pubSubBetaWarning);
413
- },
414
- async (args) => {
415
- const config = readConfig(args.config, args);
416
- const accountId = await requireAuth(config);
417
-
418
- let parsedExpiration: number | undefined;
419
- if (args.expiration) {
420
- const expiration = parseHumanDuration(args.expiration);
421
- if (isNaN(expiration)) {
422
- throw new CommandLineArgsError(
423
- `${args.expiration} is not a time duration. Example of valid values are: 1y, 6 days.`
424
- );
425
- }
426
- parsedExpiration = expiration;
427
- }
428
-
429
- logger.log(
430
- `🔑 Issuing credential(s) for ${args.name}.${args.namespace}...`
431
- );
432
-
433
- logger.log(
434
- await pubsub.issuePubSubBrokerTokens(
435
- accountId,
436
- args.namespace,
437
- args.name,
438
- args.number,
439
- args.type,
440
- args["client-id"],
441
- parsedExpiration
442
- )
443
- );
444
- await metrics.sendMetricsEvent("issue pubsub broker credentials", {
445
- sendMetrics: config.send_metrics,
446
- });
447
- }
448
- );
449
-
450
- brokersYargs.command(
451
- "revoke <name>",
452
- "Revoke a set of active client credentials associated with the given Broker",
453
- (yargs) => {
454
- return yargs
455
- .positional("name", {
456
- describe: "The name of the Broker to revoke credentials against.",
457
- type: "string",
458
- demandOption: true,
459
- })
460
- .option("namespace", {
461
- describe: "The Namespace the Broker is associated with.",
462
- type: "string",
463
- alias: "ns",
464
- demandOption: true,
465
- })
466
- .option("jti", {
467
- describe: "Tokens to revoke",
468
- type: "string",
469
- demandOption: true,
470
- array: true,
471
- })
472
- .epilogue(pubsub.pubSubBetaWarning);
473
- },
474
- async (args) => {
475
- const config = readConfig(args.config, args);
476
- const accountId = await requireAuth(config);
477
-
478
- const numTokens = args.jti.length;
479
-
480
- logger.log(
481
- `🔴 Revoking access to ${args.name} for ${numTokens} credential(s)...`
482
- );
483
-
484
- await pubsub.revokePubSubBrokerTokens(
485
- accountId,
486
- args.namespace,
487
- args.name,
488
- args.jti
489
- );
490
-
491
- logger.log(`Revoked ${args.jti.length} credential(s).`);
492
- await metrics.sendMetricsEvent("revoke pubsub broker credentials", {
493
- sendMetrics: config.send_metrics,
494
- });
495
- }
496
- );
497
-
498
- brokersYargs.command(
499
- "unrevoke <name>",
500
- "Restore access to a set of previously revoked client credentials.",
501
- (yargs) => {
502
- return yargs
503
- .positional("name", {
504
- describe: "The name of the Broker to revoke credentials against.",
505
- type: "string",
506
- demandOption: true,
507
- })
508
- .option("namespace", {
509
- describe: "The Namespace the Broker is associated with.",
510
- type: "string",
511
- alias: "ns",
512
- demandOption: true,
513
- })
514
- .option("jti", {
515
- describe: "Tokens to revoke",
516
- type: "string",
517
- demandOption: true,
518
- array: true,
519
- })
520
- .epilogue(pubsub.pubSubBetaWarning);
521
- },
522
- async (args) => {
523
- const config = readConfig(args.config, args);
524
- const accountId = await requireAuth(config);
525
-
526
- const numTokens = args.jti.length;
527
- logger.log(
528
- `🟢 Restoring access to ${args.broker} for ${numTokens} credential(s)...`
529
- );
530
-
531
- await pubsub.unrevokePubSubBrokerTokens(
532
- accountId,
533
- args.namespace,
534
- args.name,
535
- args.jti
536
- );
537
-
538
- logger.log(`Unrevoked ${numTokens} credential(s)`);
539
- await metrics.sendMetricsEvent("unrevoke pubsub broker credentials", {
540
- sendMetrics: config.send_metrics,
541
- });
542
- }
543
- );
544
-
545
- brokersYargs.command(
546
- "show-revocations <name>",
547
- "Show all previously revoked client credentials.",
548
- (yargs) => {
549
- return yargs
550
- .positional("name", {
551
- describe: "The name of the Broker to revoke credentials against.",
552
- type: "string",
553
- demandOption: true,
554
- })
555
- .option("namespace", {
556
- describe: "The Namespace the Broker is associated with.",
557
- type: "string",
558
- alias: "ns",
559
- demandOption: true,
560
- })
561
- .epilogue(pubsub.pubSubBetaWarning);
562
- },
563
- async (args) => {
564
- const config = readConfig(args.config, args);
565
- const accountId = await requireAuth(config);
566
-
567
- logger.log(`Listing previously revoked tokens for ${args.name}...`);
568
- logger.log(
569
- await pubsub.listRevokedPubSubBrokerTokens(
570
- accountId,
571
- args.namespace,
572
- args.name
573
- )
574
- );
575
- await metrics.sendMetricsEvent(
576
- "list pubsub broker revoked credentials",
577
- {
578
- sendMetrics: config.send_metrics,
579
- }
580
- );
581
- }
582
- );
583
-
584
- brokersYargs.command(
585
- "public-keys <name>",
586
- "Show the public keys used for verifying on-publish hooks and credentials for a Broker.",
587
- (yargs) => {
588
- return yargs
589
- .positional("name", {
590
- describe: "The name of the Broker to revoke credentials against.",
591
- type: "string",
592
- demandOption: true,
593
- })
594
- .option("namespace", {
595
- describe: "The Namespace the Broker is associated with.",
596
- type: "string",
597
- alias: "ns",
598
- demandOption: true,
599
- })
600
- .epilogue(pubsub.pubSubBetaWarning);
601
- },
602
- async (args) => {
603
- const config = readConfig(args.config, args);
604
- const accountId = await requireAuth(config);
605
-
606
- logger.log(
607
- await pubsub.getPubSubBrokerPublicKeys(
608
- accountId,
609
- args.namespace,
610
- args.name
611
- )
612
- );
613
- await metrics.sendMetricsEvent("list pubsub broker public-keys", {
614
- sendMetrics: config.send_metrics,
615
- });
616
- }
617
- );
618
-
619
- brokersYargs.epilogue(pubsub.pubSubBetaWarning);
620
- return brokersYargs;
621
- })
622
- .epilogue(pubsub.pubSubBetaWarning);
623
- }
@@ -1,71 +0,0 @@
1
- import { readConfig } from "../../../../config";
2
- import { logger } from "../../../../logger";
3
- import { postConsumer } from "../../../client";
4
- import type {
5
- CommonYargsArgv,
6
- StrictYargsOptionsToInterface,
7
- } from "../../../../yargs-types";
8
- import type { PostConsumerBody } from "../../../client";
9
-
10
- export function options(yargs: CommonYargsArgv) {
11
- return yargs
12
- .positional("queue-name", {
13
- type: "string",
14
- demandOption: true,
15
- description: "Name of the queue to configure",
16
- })
17
- .positional("script-name", {
18
- type: "string",
19
- demandOption: true,
20
- description: "Name of the consumer script",
21
- })
22
- .options({
23
- "batch-size": {
24
- type: "number",
25
- describe: "Maximum number of messages per batch",
26
- },
27
- "batch-timeout": {
28
- type: "number",
29
- describe:
30
- "Maximum number of seconds to wait to fill a batch with messages",
31
- },
32
- "message-retries": {
33
- type: "number",
34
- describe: "Maximum number of retries for each message",
35
- },
36
- "dead-letter-queue": {
37
- type: "string",
38
- describe: "Queue to send messages that failed to be consumed",
39
- },
40
- "max-concurrency": {
41
- type: "number",
42
- describe:
43
- "The maximum number of concurrent consumer Worker invocations. Must be a positive integer",
44
- },
45
- });
46
- }
47
-
48
- export async function handler(
49
- args: StrictYargsOptionsToInterface<typeof options>
50
- ) {
51
- const config = readConfig(args.config, args);
52
-
53
- const body: PostConsumerBody = {
54
- script_name: args.scriptName,
55
- // TODO(soon) is this still the correct usage of the environment?
56
- environment_name: args.env ?? "", // API expects empty string as default
57
- settings: {
58
- batch_size: args.batchSize,
59
- max_retries: args.messageRetries,
60
- max_wait_time_ms: args.batchTimeout // API expects milliseconds
61
- ? 1000 * args.batchTimeout
62
- : undefined,
63
- max_concurrency: args.maxConcurrency,
64
- },
65
- dead_letter_queue: args.deadLetterQueue,
66
- };
67
-
68
- logger.log(`Adding consumer to queue ${args.queueName}.`);
69
- await postConsumer(config, args.queueName, body);
70
- logger.log(`Added consumer to queue ${args.queueName}.`);
71
- }
@@ -1,19 +0,0 @@
1
- import { options as addOptions, handler as addHandler } from "./add";
2
- import { options as removeOptions, handler as removeHandler } from "./remove";
3
- import type { CommonYargsArgv } from "../../../../yargs-types";
4
-
5
- export function consumers(yargs: CommonYargsArgv) {
6
- yargs.command(
7
- "add <queue-name> <script-name>",
8
- "Add a Queue Consumer",
9
- addOptions,
10
- addHandler
11
- );
12
-
13
- yargs.command(
14
- "remove <queue-name> <script-name>",
15
- "Remove a Queue Consumer",
16
- removeOptions,
17
- removeHandler
18
- );
19
- }