wrangler 0.0.0-e41c7e41 → 0.0.0-e44afaf79

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