wrangler 0.0.0-eebdb6c → 0.0.0-eec88346

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 (304) hide show
  1. package/Cloudflare_CA.pem +18 -0
  2. package/README.md +47 -14
  3. package/bin/wrangler.js +160 -28
  4. package/kv-asset-handler.js +1 -0
  5. package/miniflare-dist/index.mjs +6314 -0
  6. package/package.json +190 -122
  7. package/src/__tests__/access.test.ts +25 -0
  8. package/src/__tests__/api-dev.test.ts +209 -0
  9. package/src/__tests__/api-devregistry.test.js +56 -0
  10. package/src/__tests__/api.test.ts +80 -0
  11. package/src/__tests__/config-cache-without-cache-dir.test.ts +38 -0
  12. package/src/__tests__/config-cache.test.ts +42 -0
  13. package/src/__tests__/configuration.test.ts +3972 -0
  14. package/src/__tests__/d1.test.ts +72 -0
  15. package/src/__tests__/delete.test.ts +230 -0
  16. package/src/__tests__/deployments.test.ts +91 -0
  17. package/src/__tests__/dev.test.tsx +1455 -0
  18. package/src/__tests__/dialogs.test.tsx +40 -0
  19. package/src/__tests__/generate.test.ts +235 -0
  20. package/src/__tests__/get-host-from-url.test.ts +16 -0
  21. package/src/__tests__/guess-worker-format.test.ts +85 -0
  22. package/src/__tests__/{clipboardy-mock.js → helpers/clipboardy-mock.js} +0 -0
  23. package/src/__tests__/helpers/cmd-shim.d.ts +11 -0
  24. package/src/__tests__/helpers/mock-account-id.ts +48 -0
  25. package/src/__tests__/helpers/mock-bin.ts +36 -0
  26. package/src/__tests__/helpers/mock-cfetch.ts +333 -0
  27. package/src/__tests__/helpers/mock-console.ts +106 -0
  28. package/src/__tests__/helpers/mock-dialogs.ts +153 -0
  29. package/src/__tests__/helpers/mock-get-zone-from-host.ts +8 -0
  30. package/src/__tests__/helpers/mock-http-server.ts +46 -0
  31. package/src/__tests__/helpers/mock-istty.ts +74 -0
  32. package/src/__tests__/helpers/mock-known-routes.ts +7 -0
  33. package/src/__tests__/helpers/mock-kv.ts +33 -0
  34. package/src/__tests__/helpers/mock-oauth-flow.ts +252 -0
  35. package/src/__tests__/helpers/mock-process.ts +39 -0
  36. package/src/__tests__/helpers/mock-stdin.ts +108 -0
  37. package/src/__tests__/helpers/mock-web-socket.ts +29 -0
  38. package/src/__tests__/helpers/msw/handlers/access.ts +13 -0
  39. package/src/__tests__/helpers/msw/handlers/deployments.ts +86 -0
  40. package/src/__tests__/helpers/msw/handlers/namespaces.ts +104 -0
  41. package/src/__tests__/helpers/msw/handlers/oauth.ts +36 -0
  42. package/src/__tests__/helpers/msw/handlers/r2.ts +80 -0
  43. package/src/__tests__/helpers/msw/handlers/script.ts +75 -0
  44. package/src/__tests__/helpers/msw/handlers/user.ts +63 -0
  45. package/src/__tests__/helpers/msw/handlers/zones.ts +22 -0
  46. package/src/__tests__/helpers/msw/index.ts +21 -0
  47. package/src/__tests__/helpers/run-in-tmp.ts +38 -0
  48. package/src/__tests__/helpers/run-wrangler.ts +16 -0
  49. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +1 -0
  50. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +5 -0
  51. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +1 -0
  52. package/src/__tests__/helpers/worker-scripts/parent-worker.js +8 -0
  53. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +5 -0
  54. package/src/__tests__/helpers/write-worker-source.ts +31 -0
  55. package/src/__tests__/helpers/write-wrangler-toml.ts +17 -0
  56. package/src/__tests__/https-options.test.ts +163 -0
  57. package/src/__tests__/index.test.ts +252 -284
  58. package/src/__tests__/init.test.ts +2900 -0
  59. package/src/__tests__/jest.setup.ts +190 -10
  60. package/src/__tests__/kv.test.ts +1463 -886
  61. package/src/__tests__/logger.test.ts +141 -0
  62. package/src/__tests__/metrics.test.ts +450 -0
  63. package/src/__tests__/middleware.scheduled.test.ts +135 -0
  64. package/src/__tests__/middleware.test.ts +726 -0
  65. package/src/__tests__/package-manager.test.ts +353 -0
  66. package/src/__tests__/pages.test.ts +2221 -0
  67. package/src/__tests__/parse.test.ts +330 -0
  68. package/src/__tests__/paths.test.ts +39 -0
  69. package/src/__tests__/publish.test.ts +7282 -0
  70. package/src/__tests__/pubsub.test.ts +367 -0
  71. package/src/__tests__/queues.test.ts +368 -0
  72. package/src/__tests__/r2.test.ts +371 -0
  73. package/src/__tests__/route.test.ts +45 -0
  74. package/src/__tests__/secret.test.ts +644 -0
  75. package/src/__tests__/tail.test.ts +800 -0
  76. package/src/__tests__/test-old-node-version.js +31 -0
  77. package/src/__tests__/type-generation.test.ts +217 -0
  78. package/src/__tests__/user.test.ts +155 -0
  79. package/src/__tests__/utils-collectKeyValues.test.ts +47 -0
  80. package/src/__tests__/validate-dev-props.test.ts +56 -0
  81. package/src/__tests__/version.test.ts +35 -0
  82. package/src/__tests__/whoami.test.tsx +278 -0
  83. package/src/__tests__/worker-namespace.test.ts +321 -0
  84. package/src/abort.d.ts +3 -0
  85. package/src/api/dev.ts +208 -0
  86. package/src/api/index.ts +2 -0
  87. package/src/bundle-reporter.tsx +29 -0
  88. package/src/bundle.ts +782 -0
  89. package/src/cfetch/index.ts +128 -71
  90. package/src/cfetch/internal.ts +240 -46
  91. package/src/cli.ts +26 -6
  92. package/src/config/README.md +107 -0
  93. package/src/config/config.ts +275 -0
  94. package/src/config/diagnostics.ts +80 -0
  95. package/src/config/environment.ts +549 -0
  96. package/src/config/index.ts +306 -0
  97. package/src/config/validation-helpers.ts +597 -0
  98. package/src/config/validation.ts +2095 -0
  99. package/src/config-cache.ts +85 -0
  100. package/src/create-worker-preview.ts +282 -0
  101. package/src/create-worker-upload-form.ts +314 -0
  102. package/src/d1/backups.tsx +218 -0
  103. package/src/d1/constants.ts +2 -0
  104. package/src/d1/create.tsx +54 -0
  105. package/src/d1/delete.tsx +56 -0
  106. package/src/d1/execute.tsx +334 -0
  107. package/src/d1/formatTimeAgo.ts +14 -0
  108. package/src/d1/index.ts +98 -0
  109. package/src/d1/list.tsx +48 -0
  110. package/src/d1/migrations.tsx +446 -0
  111. package/src/d1/options.ts +22 -0
  112. package/src/d1/types.tsx +24 -0
  113. package/src/d1/utils.ts +48 -0
  114. package/src/delete.ts +111 -0
  115. package/src/deprecated/index.ts +453 -0
  116. package/src/dev/dev-vars.ts +36 -0
  117. package/src/dev/dev.tsx +587 -0
  118. package/src/dev/get-local-persistence-path.tsx +31 -0
  119. package/src/dev/local.tsx +717 -0
  120. package/src/dev/remote.tsx +602 -0
  121. package/src/dev/start-server.ts +516 -0
  122. package/src/dev/use-esbuild.ts +200 -0
  123. package/src/dev/validate-dev-props.ts +31 -0
  124. package/src/dev-registry.tsx +201 -0
  125. package/src/dev.tsx +850 -857
  126. package/src/dialogs.tsx +153 -61
  127. package/src/dispatch-namespace.ts +206 -0
  128. package/src/durable.ts +102 -0
  129. package/src/entry.ts +329 -0
  130. package/src/environment-variables.ts +50 -0
  131. package/src/errors.ts +11 -0
  132. package/src/git-client.ts +124 -0
  133. package/src/global-wrangler-config-path.ts +26 -0
  134. package/src/https-options.ts +127 -0
  135. package/src/index.tsx +663 -1889
  136. package/src/init.ts +969 -0
  137. package/src/inspect.ts +767 -0
  138. package/src/intl-polyfill.d.ts +139 -0
  139. package/src/is-ci.ts +14 -0
  140. package/src/is-interactive.ts +16 -0
  141. package/src/kv/helpers.ts +430 -0
  142. package/src/kv/index.ts +645 -0
  143. package/src/logger.ts +92 -0
  144. package/src/metrics/index.ts +5 -0
  145. package/src/metrics/metrics-config.ts +239 -0
  146. package/src/metrics/metrics-dispatcher.ts +96 -0
  147. package/src/metrics/metrics-usage-headers.ts +24 -0
  148. package/src/metrics/send-event.ts +94 -0
  149. package/src/miniflare-cli/README.md +30 -0
  150. package/src/miniflare-cli/assets.ts +215 -0
  151. package/src/miniflare-cli/index.ts +213 -0
  152. package/src/miniflare-cli/request-context.ts +40 -0
  153. package/src/module-collection.ts +256 -53
  154. package/src/open-in-browser.ts +17 -0
  155. package/src/package-manager.ts +219 -0
  156. package/src/pages/build.tsx +238 -0
  157. package/src/pages/constants.ts +18 -0
  158. package/src/pages/deployments.tsx +106 -0
  159. package/src/pages/dev.tsx +693 -0
  160. package/src/pages/errors.ts +66 -0
  161. package/src/pages/functions/buildPlugin.ts +110 -0
  162. package/src/pages/functions/buildWorker.ts +156 -0
  163. package/src/pages/functions/filepath-routing.test.ts +234 -0
  164. package/src/pages/functions/filepath-routing.ts +189 -0
  165. package/src/pages/functions/identifiers.ts +78 -0
  166. package/src/pages/functions/routes-consolidation.test.ts +250 -0
  167. package/src/pages/functions/routes-consolidation.ts +73 -0
  168. package/src/pages/functions/routes-transformation.test.ts +282 -0
  169. package/src/pages/functions/routes-transformation.ts +115 -0
  170. package/src/pages/functions/routes-validation.test.ts +403 -0
  171. package/src/pages/functions/routes-validation.ts +202 -0
  172. package/src/pages/functions/routes.ts +151 -0
  173. package/src/pages/functions.tsx +82 -0
  174. package/src/pages/hash.tsx +13 -0
  175. package/src/pages/index.tsx +94 -0
  176. package/src/pages/projects.tsx +169 -0
  177. package/src/pages/publish.tsx +436 -0
  178. package/src/pages/types.ts +49 -0
  179. package/src/pages/upload.tsx +425 -0
  180. package/src/pages/utils.ts +12 -0
  181. package/src/parse.ts +286 -0
  182. package/src/paths.ts +71 -0
  183. package/src/proxy.ts +678 -92
  184. package/src/publish/index.ts +267 -0
  185. package/src/publish/publish.ts +976 -0
  186. package/src/pubsub/index.ts +286 -0
  187. package/src/pubsub/pubsub-commands.tsx +623 -0
  188. package/src/queues/cli/commands/consumer/add.ts +75 -0
  189. package/src/queues/cli/commands/consumer/index.ts +19 -0
  190. package/src/queues/cli/commands/consumer/remove.ts +44 -0
  191. package/src/queues/cli/commands/create.ts +25 -0
  192. package/src/queues/cli/commands/delete.ts +26 -0
  193. package/src/queues/cli/commands/index.ts +32 -0
  194. package/src/queues/cli/commands/list.ts +25 -0
  195. package/src/queues/client.ts +135 -0
  196. package/src/r2/helpers.ts +131 -0
  197. package/src/r2/index.ts +277 -0
  198. package/src/routes.ts +140 -0
  199. package/src/secret/index.ts +404 -0
  200. package/src/selfsigned.d.ts +29 -0
  201. package/src/sites.tsx +357 -99
  202. package/src/tail/createTail.ts +315 -0
  203. package/src/tail/filters.ts +277 -0
  204. package/src/tail/index.ts +217 -0
  205. package/src/tail/printing.ts +107 -0
  206. package/src/type-generation.ts +159 -0
  207. package/src/update-check.ts +19 -0
  208. package/src/user/access.ts +69 -0
  209. package/src/user/choose-account.tsx +69 -0
  210. package/src/user/env-vars.ts +46 -0
  211. package/src/user/generate-auth-url.ts +33 -0
  212. package/src/user/generate-random-state.ts +16 -0
  213. package/src/user/index.ts +3 -0
  214. package/src/user/user.tsx +1192 -0
  215. package/src/utils/collectKeyValues.ts +14 -0
  216. package/src/whoami.tsx +169 -0
  217. package/src/worker.ts +243 -0
  218. package/src/yargs-types.ts +7 -0
  219. package/src/zones.ts +191 -0
  220. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  221. package/templates/checked-fetch.js +17 -0
  222. package/templates/d1-beta-facade.js +185 -0
  223. package/templates/experimental-local-cache-stubs.js +27 -0
  224. package/templates/first-party-worker-module-facade.ts +18 -0
  225. package/templates/format-dev-errors.ts +32 -0
  226. package/templates/gitignore +171 -0
  227. package/templates/init-tests/test-jest-new-worker.js +25 -0
  228. package/templates/init-tests/test-vitest-new-worker.js +26 -0
  229. package/templates/middleware/common.ts +62 -0
  230. package/templates/middleware/loader-modules.ts +84 -0
  231. package/templates/middleware/loader-sw.ts +213 -0
  232. package/templates/middleware/middleware-pretty-error.ts +40 -0
  233. package/templates/middleware/middleware-scheduled.ts +15 -0
  234. package/templates/new-worker-scheduled.js +17 -0
  235. package/templates/new-worker-scheduled.ts +32 -0
  236. package/templates/new-worker.js +15 -0
  237. package/templates/new-worker.ts +30 -0
  238. package/templates/no-op-worker.js +10 -0
  239. package/templates/pages-dev-pipeline.ts +28 -0
  240. package/templates/pages-dev-util.ts +52 -0
  241. package/templates/pages-shim.ts +9 -0
  242. package/templates/pages-template-plugin.ts +171 -0
  243. package/templates/pages-template-worker.ts +189 -0
  244. package/templates/serve-static-assets.ts +63 -0
  245. package/templates/service-bindings-module-facade.js +54 -0
  246. package/templates/service-bindings-sw-facade.js +42 -0
  247. package/templates/tsconfig.json +106 -0
  248. package/wrangler-dist/cli.d.ts +880 -0
  249. package/wrangler-dist/cli.js +144775 -105026
  250. package/pages/functions/buildWorker.ts +0 -57
  251. package/pages/functions/filepath-routing.test.ts +0 -32
  252. package/pages/functions/filepath-routing.ts +0 -225
  253. package/pages/functions/identifiers.ts +0 -78
  254. package/pages/functions/routes.ts +0 -158
  255. package/pages/functions/template-worker.ts +0 -135
  256. package/src/__tests__/mock-cfetch.ts +0 -171
  257. package/src/__tests__/mock-dialogs.ts +0 -65
  258. package/src/__tests__/run-in-tmp.ts +0 -19
  259. package/src/__tests__/run-wrangler.ts +0 -32
  260. package/src/api/form_data.ts +0 -131
  261. package/src/api/inspect.ts +0 -430
  262. package/src/api/preview.ts +0 -128
  263. package/src/api/worker.ts +0 -155
  264. package/src/config.ts +0 -131
  265. package/src/kv.tsx +0 -267
  266. package/src/pages.tsx +0 -921
  267. package/src/publish.ts +0 -350
  268. package/src/tail.tsx +0 -73
  269. package/src/user.tsx +0 -1022
  270. package/static-asset-facade.js +0 -47
  271. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  272. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  273. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  274. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  275. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  276. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  277. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  278. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  279. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  280. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  281. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  282. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  283. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  284. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  285. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  286. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  287. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  288. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  289. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  290. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  291. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  292. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  293. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  294. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  295. package/vendor/wrangler-mime/LICENSE +0 -21
  296. package/vendor/wrangler-mime/Mime.js +0 -97
  297. package/vendor/wrangler-mime/README.md +0 -187
  298. package/vendor/wrangler-mime/cli.js +0 -46
  299. package/vendor/wrangler-mime/index.js +0 -4
  300. package/vendor/wrangler-mime/lite.js +0 -4
  301. package/vendor/wrangler-mime/package.json +0 -52
  302. package/vendor/wrangler-mime/types/other.js +0 -1
  303. package/vendor/wrangler-mime/types/standard.js +0 -1
  304. package/wrangler-dist/cli.js.map +0 -7
@@ -0,0 +1,623 @@
1
+ import { type ConfigPath } from "..";
2
+ import { readConfig } from "../config";
3
+ import { confirm } from "../dialogs";
4
+ import { CommandLineArgsError } from "../index";
5
+ import { logger } from "../logger";
6
+ import * as metrics from "../metrics";
7
+ import { parseHumanDuration } from "../parse";
8
+ import { requireAuth } from "../user";
9
+ import * as pubsub from ".";
10
+ import type { Argv, CommandModule } from "yargs";
11
+
12
+ export function pubSubCommands(
13
+ pubsubYargs: Argv,
14
+ subHelp: CommandModule
15
+ ): Argv {
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 as ConfigPath, 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/SubNamespace ${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 as ConfigPath, 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 as ConfigPath, 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 as ConfigPath, 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 as ConfigPath, 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 as ConfigPath, 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 as ConfigPath, 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 as ConfigPath, 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 as ConfigPath, 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 as ConfigPath, 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 as ConfigPath, 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 as ConfigPath, 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 as ConfigPath, 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 as ConfigPath, 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
+ }
@@ -0,0 +1,75 @@
1
+ import { type Argv } from "yargs";
2
+ import { readConfig } from "../../../../config";
3
+ import { logger } from "../../../../logger";
4
+ import { postConsumer } from "../../../client";
5
+ import type { PostConsumerBody } from "../../../client";
6
+
7
+ interface Args {
8
+ config?: string;
9
+ ["queue-name"]: string;
10
+ ["script-name"]: string;
11
+ ["environment"]?: string;
12
+ ["batch-size"]?: number;
13
+ ["batch-timeout"]?: number;
14
+ ["message-retries"]?: number;
15
+ ["dead-letter-queue"]?: string;
16
+ }
17
+
18
+ export function options(yargs: Argv): Argv<Args> {
19
+ return yargs
20
+ .positional("queue-name", {
21
+ type: "string",
22
+ demandOption: true,
23
+ description: "Name of the queue to configure",
24
+ })
25
+ .positional("script-name", {
26
+ type: "string",
27
+ demandOption: true,
28
+ description: "Name of the consumer script",
29
+ })
30
+ .options({
31
+ environment: {
32
+ type: "string",
33
+ describe: "Environment of the consumer script",
34
+ },
35
+ "batch-size": {
36
+ type: "number",
37
+ describe: "Maximum number of messages per batch",
38
+ },
39
+ "batch-timeout": {
40
+ type: "number",
41
+ describe:
42
+ "Maximum number of seconds to wait to fill a batch with messages",
43
+ },
44
+ "message-retries": {
45
+ type: "number",
46
+ describe: "Maximum number of retries for each message",
47
+ },
48
+ "dead-letter-queue": {
49
+ type: "string",
50
+ describe: "Queue to send messages that failed to be consumed",
51
+ },
52
+ });
53
+ }
54
+
55
+ export async function handler(args: Args) {
56
+ const config = readConfig(args.config, args);
57
+
58
+ const body: PostConsumerBody = {
59
+ script_name: args["script-name"],
60
+ // TODO(soon) is this still the correct usage of the environment?
61
+ environment_name: args.environment || "", // API expects empty string as default
62
+ settings: {
63
+ batch_size: args["batch-size"],
64
+ max_retries: args["message-retries"],
65
+ max_wait_time_ms: args["batch-timeout"] // API expects milliseconds
66
+ ? 1000 * args["batch-timeout"]
67
+ : undefined,
68
+ },
69
+ dead_letter_queue: args["dead-letter-queue"],
70
+ };
71
+
72
+ logger.log(`Adding consumer to queue ${args["queue-name"]}.`);
73
+ await postConsumer(config, args["queue-name"], body);
74
+ logger.log(`Added consumer to queue ${args["queue-name"]}.`);
75
+ }
@@ -0,0 +1,19 @@
1
+ import { type BuilderCallback } from "yargs";
2
+ import { options as addOptions, handler as addHandler } from "./add";
3
+ import { options as removeOptions, handler as removeHandler } from "./remove";
4
+
5
+ export const consumers: BuilderCallback<unknown, unknown> = (yargs) => {
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
+ };