Refactor logging

Author: nfour

src/DocumentGenerator.ts

@@ -3,7 +3,7 @@ import * as c from 'chalk';
 import * as openApiValidator from 'swagger2openapi/validate';
 
 import * as uuid from 'uuid';
-import { IParameterConfig, IServerlessFunctionConfig, IServiceDescription } from './types';
+import { ILog, IParameterConfig, IServerlessFunctionConfig, IServiceDescription } from './types';
 import { clone, merge } from './utils';
 
 export class DocumentGenerator {
@@ -23,13 +23,18 @@ export class DocumentGenerator {
   };
 
   private serviceDescriptor: IServiceDescription;
+  private log: ILog;
 
   /**
    * Constructor
    * @param serviceDescriptor IServiceDescription
    */
-  constructor (serviceDescriptor: IServiceDescription) {
+  constructor ({ log, serviceDescriptor }: {
+    log: ILog,
+    serviceDescriptor: IServiceDescription,
+  }) {
     this.serviceDescriptor = clone(serviceDescriptor);
+    this.log = log;
 
     merge(this.config, {
       openapi: this.openapiVersion,
@@ -53,17 +58,21 @@ export class DocumentGenerator {
 
   public generate () {
     const result: any = {};
-    process.stdout.write(`${ c.bold.yellow('[VALIDATION]') } Validating OpenAPI generated output\n`);
+    this.log(`${ c.bold.yellow('[VALIDATION]') } Validating OpenAPI generated output\n`);
+
     try {
       openApiValidator.validateSync(this.config, result);
-      process.stdout.write(`${ c.bold.green('[VALIDATION]') } OpenAPI valid: ${c.bold.green('true')}\n\n`);
+
+      this.log(`${ c.bold.green('[VALIDATION]') } OpenAPI valid: ${c.bold.green('true')}\n\n`);
+
       return this.config;
     } catch (e) {
-      process.stdout.write(
+      this.log(
         `${c.bold.red('[VALIDATION]')} Failed to validate OpenAPI document: \n\n${c.yellow(e.message)}\n\n` +
-        `${c.bold.green('Path:')} ${result.valid} ${result.context}\n`,
-        );
-      // throw new Error('Failed to validate OpenAPI document');
+        `${c.bold.green('Path:')} ${JSON.stringify(result, null, 2)}\n`,
+      );
+
+      throw new Error('Failed to validate OpenAPI document');
     }
   }
 

src/ServerlessOpenApiDocumentation.ts

@@ -2,7 +2,7 @@ import * as c from 'chalk';
 import * as fs from 'fs';
 import * as YAML from 'js-yaml';
 import { DocumentGenerator } from './DocumentGenerator';
-import { IConfigType } from './types';
+import { IConfigType, ILog } from './types';
 import { merge } from './utils';
 
 export class ServerlessOpenApiDocumentation {
@@ -62,6 +62,10 @@ export class ServerlessOpenApiDocumentation {
     };
   }
 
+  log: ILog = (...str: string[]) => {
+    process.stdout.write(str.join(' '));
+  }
+
   /**
    * Processes CLI input by reading the input from serverless
    * @returns config IConfigType
@@ -83,22 +87,26 @@ export class ServerlessOpenApiDocumentation {
     config.file = this.serverless.processedInput.options.output ||
       ((config.format === 'yaml') ? 'openapi.yml' : 'openapi.json');
 
-    process.stdout.write(
-      `${c.bold.green('[OPTIONS]')} ` +
-      `format: "${c.bold.red(config.format)}", ` +
-      `output file: "${c.bold.red(config.file)}", ` +
+    this.log(
+      `${c.bold.green('[OPTIONS]')}`,
+      `format: "${c.bold.red(config.format)}",`,
+      `output file: "${c.bold.red(config.file)}",`,
       `indentation: "${c.bold.red(String(config.indent))}"\n\n`,
-      );
+    );
+
     return config;
   }
 
   /**
    * Generates OpenAPI Documentation based on serverless configuration and functions
    */
   private generate () {
-    process.stdout.write(c.bold.underline('OpenAPI v3 Documentation Generator\n\n'));
+    this.log(c.bold.underline('OpenAPI v3 Documentation Generator\n\n'));
     // Instantiate DocumentGenerator
-    const dg = new DocumentGenerator(this.customVars.documentation);
+    const generator = new DocumentGenerator({
+      serviceDescriptor: this.customVars.documentation,
+      log: this.log,
+    });
 
     // Map function configurations
     const funcConfigs = this.serverless.service.getAllFunctions().map((functionName) => {
@@ -107,13 +115,13 @@ export class ServerlessOpenApiDocumentation {
     });
 
     // Add Paths to OpenAPI Output from Function Configuration
-    dg.addPathsFromFunctionConfig(funcConfigs);
+    generator.addPathsFromFunctionConfig(funcConfigs);
 
     // Process CLI Input options
     const config = this.processCliInput();
 
     // Generate the resulting OpenAPI Object
-    const outputObject = dg.generate();
+    const outputObject = generator.generate();
 
     // Output the OpenAPI document to the correct format
     let outputContent = '';
@@ -129,6 +137,6 @@ export class ServerlessOpenApiDocumentation {
 
     // Write to disk
     fs.writeFileSync(config.file, outputContent);
-    process.stdout.write(`${ c.bold.green('[SUCCESS]') } Output file to "${c.bold.red(config.file)}"\n`);
+    this.log(`${ c.bold.green('[SUCCESS]') } Output file to "${c.bold.red(config.file)}"\n`);
   }
 }

src/types.ts

@@ -43,3 +43,5 @@ export interface IParameterConfig {
   example?: any;
   examples?: [any];
 }
+
+export type ILog = (...str: string[]) => void;