feat: new command 🎉 that lets you find usages of fields in your payload in downstream consumers

Author: ljacobsson

README.md

@@ -98,6 +98,32 @@ If no template is passed to the command, then you will get prompted to select a
 
 This is using quicktype. See their docs for [target languages](https://github.com/quicktype/quicktype#target-languages)
 
+## Find usages in event rule patterns
+```
+Usage: evb find-usages|f [options]
+
+Searches all rules on a bus for matching event patterns.
+
+I.e to find all rules that match on an s3:PutObject event from CloudTrail, use:
+evb find-usages -f $.source=aws.s3,$.detail-type=.+CloudTrail,$.detail.eventName=PutObject
+
+Options:
+  -b, --eventbus [eventbus]  Name of the event bus to search. (default: "default")
+  -f, --filters [filters]    Comma separated list of '$.path.to.property=regex-pattern' to filter the event patterns with
+  -p, --profile [profile]    AWS profile to use
+  --region [region]          The AWS region to use. Falls back on AWS_REGION environment variable if not specified
+  -h, --help                 output usage information
+```
+
+This command allows you to find usages of specific fields across all event rules on a bus. This could be useful in order to find individual consumers of a specific field in your event payload.
+
+Some examples:
+
+* Find all rules that match on a specific `source` and `detail-type` combination on a custom bus: `evb find-usages --filters $.source=my-custom-source,$.detail-type=my-custom-detail-type` --eventbus custombus
+* Find all rules that trigger on any of AWS CodePipeline, CodeBuild, CodeDeploy, etc events: `evb find-usages --filters $.source=aws\.code.*`
+* Find all rules that trigger on a Lambda failure destination: `evb find-usages --filters $.detail-type='Lambda Function Invocation Result - Failure'`
+
+
 ## Generate API Destinations resources
 ```
 Usage: evb api-destination|api [options]

index.js

@@ -15,6 +15,7 @@ require("./src/commands/local");
 require("./src/commands/code-binding");
 require("./src/commands/api-destination");
 require("./src/commands/pipes");
+require("./src/commands/find-usages");
 
 program.version(package.version, "-v, --vers", "output the current version");
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@mhlabs/evb-cli",
-  "version": "1.1.49",
+  "version": "1.1.50",
   "description": "A package for building EventBridge/CloudWatch Events patterns",
   "main": "index.js",
   "scripts": {
@@ -21,10 +21,12 @@
     "date-prompt": "^1.0.0",
     "inquirer": "^7.0.4",
     "inquirer-autocomplete-prompt": "^1.3.0",
+    "inquirer-tree-prompt": "^1.1.2",
     "json-schema-faker": "^0.5.0-rcv.32",
     "json-to-pretty-yaml": "^1.2.2",
     "jsonpath": "^1.0.2",
-    "open": "^7.2.0",
+    "link2aws": "^1.0.12",
+    "open": "^7.4.2",
     "prompt-skeleton": "^1.0.2",
     "quicktype-core": "^6.0.62",
     "temp-dir": "^2.0.0",

package.json

@@ -6,12 +6,13 @@ const authHelper = require("../shared/auth-helper");
 program
   .command("browse")
   .alias("b")
+  .option("-f, --filter-patterns [filters]", "Comma separated list of '$.json.path.to.property=regex-pattern' to filter the results with")
   .option("-p, --profile [profile]", "AWS profile to use")
   .option("--region [region]", "The AWS region to use. Falls back on AWS_REGION environment variable if not specified")
   .description("Browses sources and detail types and shows their consumers")
   .action(async (cmd) => {
     authHelper.initAuth(cmd);
     const schemaApi = new AWS.Schemas();
     const evbApi = new AWS.EventBridge();
-    await browser.browseEvents(cmd.format, schemaApi, evbApi);
+    await browser.browseEvents(cmd, schemaApi, evbApi);
   });

src/commands/browse/index.js

@@ -6,6 +6,10 @@ if (!process.stdout.getWindowSize) {
 }
 
 const inquirer = require("inquirer");
+
+const TreePrompt = require('inquirer-tree-prompt');
+inquirer.registerPrompt('tree', TreePrompt);
+
 inquirer.registerPrompt(
   "autocomplete",
   require("inquirer-autocomplete-prompt")
@@ -118,10 +122,9 @@ async function getProperty(currentObject, objectArray) {
   const property = await inquirer.prompt({
     name: "id",
     type: "autocomplete",
-    message: `Add ${
-      objectArray[objectArray.length - 1] ||
+    message: `Add ${objectArray[objectArray.length - 1] ||
       currentObject["x-amazon-events-detail-type"]
-    } item`,
+      } item`,
     choices: choices,
     source: sourceAutocomplete(choices),
   });
@@ -252,6 +255,21 @@ async function getDate(message) {
   return answer;
 }
 
+async function tree(message, items) {
+  let answer;
+  do {
+    answer = await inquirer
+      .prompt(
+        {
+          type: 'tree',
+          name: "state",
+          message: message,
+          tree: items,
+        });
+  } while (!answer.state.action);
+  return answer.state;
+}
+
 module.exports = {
   getEventBusName,
   getRegistry,
@@ -263,6 +281,7 @@ module.exports = {
   getPropertyValue,
   text,
   getDate,
+  tree,
   BACK,
   DONE,
   UNDO,