feat(cli): add userfriendly output for create-stack or update-stack

Author: Fuss Florian (uid10804)

packages/cli/src/actions/helpers.ts

@@ -3,6 +3,8 @@ import * as path from 'path';
 const util = require('util');
 const exec = util.promisify(require('child_process').exec);
 import figlet from 'figlet';
+import chalk from 'chalk';
+import cli from 'cli-ux';
 export class Helpers {
   static validateFile(filePath: string): string {
     if (!path.isAbsolute(filePath)) {
@@ -92,6 +94,22 @@ export class Helpers {
     }
   }
 
+  static async executeChildProcess2(
+    command: string,
+    options: {},
+    stdout = true
+  ): Promise<string> {
+    try {
+      const childProcess = await exec(command, options);
+      if (stdout) {
+        return Promise.resolve(childProcess.stdout);
+      }
+      return Promise.reject(childProcess.stderr);
+    } catch (err) {
+      throw new Error(err);
+    }
+  }
+
   static async copyFiles(source: string, destination: string) {
     try {
       if (!fs.existsSync(source)) {
@@ -193,4 +211,127 @@ export class Helpers {
     }
     return true;
   }
+
+  static createCLIOutput(
+    slsinfo: string,
+    apiAuth: boolean,
+    enableSwagger: boolean
+  ) {
+    const rows = JSON.stringify(slsinfo).split('\\n') as any[];
+    const createKeyValues = rows.map((x, i, rows) => {
+      if (x.startsWith('  ANY -')) {
+        x = {
+          name: x.split(' - ')[0],
+          value: x.split(' - ')[1],
+        };
+      } else {
+        x = {
+          name: x.split(':')[0],
+          value: x.split(':')[1],
+        };
+      }
+      return x;
+    });
+
+    const outputJson = createKeyValues
+      .map((x, i, rows) => {
+        if (rows[i + 1] && rows[i + 1].name.startsWith('  ')) {
+          x.value = rows[i + 1].value;
+        }
+        if (x && x.name.startsWith('  ')) {
+          return null;
+        }
+        if (x && x.name) {
+          x.name = x.name.replace(/\s/g, '');
+        }
+        if (x && x.value) {
+          x.value = x.value.replace(/\s/g, '');
+        }
+
+        return x;
+      })
+      .filter(
+        (item) =>
+          item != null &&
+          item.hasOwnProperty('value') &&
+          item.value != undefined
+      )
+      .reduce(
+        (obj, item) => Object.assign(obj, { [item.name]: item.value }),
+        {}
+      );
+    console.log();
+    console.log(
+      'The Api ' + outputJson.service + ' has been successfully deployed'
+    );
+    console.log();
+    console.log('Further details:');
+    cli.table(
+      [
+        {
+          text: `${chalk.blueBright('Stage')}`,
+          link: outputJson.stage,
+        },
+        {
+          text: `${chalk.blueBright('Region')}`,
+          link: outputJson.region,
+        },
+        {
+          text: `${chalk.blueBright('Cloudformation Stack')}`,
+          link: outputJson.stack,
+        },
+      ],
+      { text: { minWidth: 30 }, link: { minWidth: 20 } },
+      { 'no-header': true }
+    );
+
+    console.log();
+    console.log();
+    if (apiAuth) {
+      console.log(
+        `${chalk.green(
+          'Please use the following apiKey (x-api-key) to authenticate:'
+        )} ` + outputJson.apikeys
+      );
+    }
+    console.log();
+    console.log();
+    if (enableSwagger) {
+      cli.table(
+        [
+          {
+            text: `${chalk.blueBright('Swagger UI')}`,
+            link: outputJson.endpoints + '/ui',
+          },
+          {
+            text: `${chalk.blueBright('GraphiQL')}`,
+            link: outputJson.endpoints + '/graphql',
+          },
+          {
+            text: `${chalk.blueBright('Swagger Specification')}`,
+            link: outputJson.endpoints + '/api-spec',
+          },
+          {
+            text: `${chalk.blueBright('API Routes')}`,
+            link: outputJson.endpoints + '/api/{routes}',
+          },
+        ],
+        { text: { minWidth: 30 }, link: { minWidth: 20 } },
+        { 'no-header': true }
+      );
+    } else {
+      cli.table(
+        [
+          {
+            text: `${chalk.blueBright('API Routes')}`,
+            link: outputJson.endpoints + '/api/{routes}',
+          },
+        ],
+        { text: { minWidth: 30 }, link: { minWidth: 20 } },
+        { 'no-header': true }
+      );
+    }
+    console.log();
+    console.log();
+  }
 }

packages/cli/src/commands/create-stack.ts

@@ -207,15 +207,29 @@ export class CreateStackCommand extends Command {
         },
       },
     ]);
+    let slsinfo = '';
     try {
       await tasks.run();
-      await Helpers.executeChildProcess(
+      slsinfo = await Helpers.executeChildProcess2(
         'node_modules/serverless/bin/serverless info',
         { cwd: stackFolder }
       );
     } catch (error) {
       this.error(`${chalk.red(error.message)}`);
     }
+    try {
+      const appConfig = JSON.parse(
+        fs.readFileSync(stackFolder + '/config/appconfig.json', 'UTF-8')
+      ) as AppConfig;
+      Helpers.createCLIOutput(
+        slsinfo,
+        appConfig.enableApiKeyAuth,
+        appConfig.enableSwagger
+      );
+    } catch (error) {
+      this.log(`${chalk.red(error.message)}`);
+      this.log(slsinfo);
+    }
   }
 
   private async getRegion() {

packages/cli/src/commands/update-stack.ts

@@ -6,6 +6,7 @@ import { Helpers } from '../actions/helpers';
 import { AWSActions } from '../actions/aws-actions';
 import chalk from 'chalk';
 import cli from 'cli-ux';
+import { AppConfig } from 'json-serverless-lib';
 
 export class UpdateStackCommand extends Command {
   static description = 'describe the command here';
@@ -46,6 +47,7 @@ export class UpdateStackCommand extends Command {
 
   async run() {
     const logo = await Helpers.generateLogo('json-serverless');
+    this.log();
     this.log(`${chalk.blueBright(logo)}`);
     this.log();
     const { flags } = this.parse(UpdateStackCommand);
@@ -168,14 +170,28 @@ export class UpdateStackCommand extends Command {
         },
       },
     ]);
+    let slsinfo = '';
     try {
       await tasks.run();
-      await Helpers.executeChildProcess(
+      slsinfo = await Helpers.executeChildProcess2(
         'node_modules/serverless/bin/serverless info',
         { cwd: stackFolder }
       );
     } catch (error) {
       this.error(`${chalk.red(error.message)}`);
     }
+    try {
+      const appConfig = JSON.parse(
+        fs.readFileSync(stackFolder + '/config/appconfig.json', 'UTF-8')
+      ) as AppConfig;
+      Helpers.createCLIOutput(
+        slsinfo,
+        appConfig.enableApiKeyAuth,
+        appConfig.enableSwagger
+      );
+    } catch (error) {
+      this.log(`${chalk.red(error.message)}`);
+      this.log(slsinfo);
+    }
   }
 }