JavaScript (v3): Add --verbose|-v flag to scenario parser. (#5556)

awsdocs · Oct 23, 2023 · 25dcb14 · 25dcb14
1 parent 170b53c
commit 25dcb14
Show file tree

Hide file tree

Showing 2 changed files with 56 additions and 14 deletions.
diff --git a/javascriptv3/example_code/libs/scenario/scenario-parser.js b/javascriptv3/example_code/libs/scenario/scenario-parser.js
@@ -14,11 +14,12 @@ node . -s <${Object.keys(scenarios).join("|")}>
 node . -h
 
 Options:
-[-s|--scenario, <scenario>] [-h|--help] [-y|--yes]
+[-s|--scenario, <scenario>] [-h|--help] [-y|--yes] [-v|--verbose]
 
 -h, --help        Show this help message.
 -s, --scenario    The name of a scenario to run.
 -y, --yes         Assume "yes" to all prompts.
+-v, --verbose     Show debug information.
 `;
 
   const { values } = parseArgs({
@@ -35,6 +36,10 @@ Options:
         short: "y",
         type: "boolean",
       },
+      verbose: {
+        short: "v",
+        type: "boolean",
+      },
     },
   });
 
@@ -52,5 +57,21 @@ Options:
     throw new Error(`Invalid scenario: ${values.scenario}\n${help}`);
   }
 
-  scenarios[values.scenario].run({ confirmAll: values.yes });
+  if (values.verbose) {
+    console.log(
+      `[DEBUG ${new Date().toISOString()}] Running scenario: ${
+        scenarios[values.scenario].name
+      }`,
+    );
+    console.log(
+      `[DEBUG ${new Date().toISOString()}] Context: ${JSON.stringify(
+        scenarios[values.scenario].context,
+      )}`,
+    );
+  }
+
+  scenarios[values.scenario].run({
+    confirmAll: values.yes,
+    verbose: values.verbose,
+  });
 }
diff --git a/javascriptv3/example_code/libs/scenario/scenario.js b/javascriptv3/example_code/libs/scenario/scenario.js
@@ -16,11 +16,22 @@ export class Step {
   }
 
   /**
-   * @param {Record<string, any>} context
+   * @param {Record<string, any>} context,
+   * @param {{ verbose: boolean }} options
    */
-  handle(context) {
-    console.log(JSON.stringify(context));
-    return Promise.resolve();
+  handle(context, { verbose }) {
+    if (verbose) {
+      console.log(
+        `[DEBUG ${new Date().toISOString()}] Handling step: ${
+          this.constructor.name
+        }<${this.name}>`,
+      );
+      console.log(
+        `[DEBUG ${new Date().toISOString()}] Context: ${JSON.stringify(
+          context,
+        )}`,
+      );
+    }
   }
 }
 
@@ -40,8 +51,11 @@ export class ScenarioOutput extends Step {
 
   /**
    * @param {Record<string, any>} context
+   * @param {{ verbose: boolean }} options
    */
-  async handle(context) {
+  async handle(context, options) {
+    super.handle(context, options);
+
     const output =
       typeof this.value === "function" ? this.value(context) : this.value;
     const paddingTop = "\n";
@@ -72,9 +86,11 @@ export class ScenarioInput extends Step {
 
   /**
    * @param {Record<string, any>} context
-   * @param {boolean} confirmAll
+   * @param {{ confirmAll: boolean, verbose: boolean }} options
    */
-  async handle(context, confirmAll = false) {
+  async handle(context, options) {
+    super.handle(context, options);
+
     const choices =
       this.options.choices && typeof this.options.choices[0] === "string"
         ? this.options.choices.map((s) => ({ name: s, value: s }))
@@ -93,7 +109,7 @@ export class ScenarioInput extends Step {
     } else if (this.options.type === "input") {
       context[this.name] = await this.prompter.input({ message: this.prompt });
     } else if (this.options.type === "confirm") {
-      if (confirmAll) {
+      if (options.confirmAll) {
         return;
       }
 
@@ -118,7 +134,12 @@ export class ScenarioAction extends Step {
     this.action = action;
   }
 
-  async handle(context) {
+  /**
+   * @param {Record<string, any>} context
+   * @param {{ verbose: boolean }} options
+   */
+  async handle(context, options) {
+    super.handle(context, options);
     await this.action(context);
   }
 }
@@ -141,11 +162,11 @@ export class Scenario {
   }
 
   /**
-   * @param {{ confirmAll: boolean }} runConfig
+   * @param {{ confirmAll: boolean, verbose: boolean }} runConfig
    */
-  async run({ confirmAll }) {
+  async run(runConfig) {
     for (const step of this.steps) {
-      await step.handle(this.context, confirmAll);
+      await step.handle(this.context, runConfig);
     }
   }
 }