refactor: improve & standlize the logger #5

Signed-off-by: seven <[email protected]>

package.json

@@ -60,6 +60,7 @@
     "commander": "^11.1.0",
     "i18n": "^0.15.1",
     "pino": "^8.17.2",
+    "pino-pretty": "^11.2.2",
     "yaml": "^2.5.1"
   },
   "devDependencies": {

src/commands/deploy.ts

@@ -1,17 +1,17 @@
 import { deployStack, parseYaml } from '../stack';
-import { printer, constructActionContext } from '../common';
+import { constructActionContext, logger } from '../common';
 
 export const deploy = async (
   stackName: string,
   options: { location: string; parameters: { [key: string]: string } },
 ) => {
   const context = constructActionContext(options);
-  printer.info('Validating yaml...');
+  logger.info('Validating yaml...');
   const iac = parseYaml(context.iacLocation);
-  printer.success('Yaml is valid! 🎉');
+  logger.info('Yaml is valid! 🎉');
 
-  printer.info('Deploying stack...');
+  logger.info('Deploying stack...');
   await deployStack(stackName, iac, context);
 
-  printer.success('Stack deployed! 🎉');
+  logger.info('Stack deployed! 🎉');
 };

src/commands/validate.ts

@@ -1,8 +1,9 @@
-import { printer, constructActionContext } from '../common';
+import { constructActionContext, logger } from '../common';
 import { parseYaml } from '../stack';
 
 export const validate = (location?: string) => {
   const context = constructActionContext({ location });
   parseYaml(context.iacLocation);
-  printer.success('Yaml is valid! 🎉');
+  logger.info('Yaml is valid! 🎉');
+  logger.debug('Yaml is valid! debug🎉');
 };

src/common/index.ts

@@ -1,4 +1,3 @@
-export * from './printer';
 export * from './provider';
 export * from './logger';
 export * from './getVersion';

src/common/logger.ts

@@ -2,6 +2,10 @@ import pino from 'pino';
 
 const logger = pino({
   name: 'ServerlessInsight',
+  level: ['ServerlessInsight', '*'].includes(process.env.DEBUG || '') ? 'debug' : 'info',
+  transport: {
+    target: 'pino-pretty',
+  },
 });
 
 export { logger };

src/common/rosClient.ts

@@ -9,7 +9,7 @@ import ROS20190910, {
 } from '@alicloud/ros20190910';
 import { Config } from '@alicloud/openapi-client';
 import { ActionContext } from '../types';
-import { printer } from './printer';
+import { logger } from './logger';
 
 const client = new ROS20190910(
   new Config({
@@ -98,15 +98,15 @@ export const rosStackDeploy = async (
   if (stackInfo) {
     const { Status: stackStatus } = stackInfo;
     if (stackStatus?.indexOf('IN_PROGRESS') >= 0) {
-      printer.error(`fail to update stack, because stack status is ${stackStatus}`);
+      logger.error(`fail to update stack, because stack status is ${stackStatus}`);
       throw new Error(`fail to update stack, because stack status is ${stackStatus}`);
     }
 
-    printer.info(`Update stack: ${stackName} deploying... `);
+    logger.info(`Update stack: ${stackName} deploying... `);
     return await updateStack(stackInfo.stackId as string, templateBody, context);
   } else {
     // create stack
-    printer.info(`Create stack: ${stackName} deploying... `);
+    logger.info(`Create stack: ${stackName} deploying... `);
     return await createStack(stackName, templateBody, context);
   }
 };

src/stack/deploy.ts

@@ -1,6 +1,6 @@
 import * as ros from '@alicloud/ros-cdk-core';
 import { ActionContext, ServerlessIac } from '../types';
-import { printer, rosStackDeploy } from '../common';
+import { logger, rosStackDeploy } from '../common';
 import { IacStack } from './iacStack';
 
 const generateStackTemplate = (stackName: string, iac: ServerlessIac, context: ActionContext) => {
@@ -19,7 +19,7 @@ export const deployStack = async (
   context: ActionContext,
 ) => {
   const { template } = generateStackTemplate(stackName, iac, context);
-  console.log('Generated ROS YAML:', JSON.stringify({ template }));
+
   await rosStackDeploy(stackName, template, context);
-  printer.info(`Stack deployed! 🎉`);
+  logger.info(`Stack deployed! 🎉`);
 };

src/stack/iacSchema.ts

@@ -1,5 +1,6 @@
 import { RawServerlessIac } from '../types';
 import Ajv, { ErrorObject } from 'ajv';
+import { logger } from '../common';
 
 const ajv = new Ajv({ allowUnionTypes: true, strict: false, allErrors: true });
 
@@ -130,7 +131,10 @@ class IacSchemaErrors extends Error {
 export const validateYaml = (iacJson: RawServerlessIac) => {
   const validate = ajv.compile(schema);
   const valid = validate(iacJson);
-  if (!valid) throw new IacSchemaErrors(validate.errors as Array<ErrorObject>);
+  if (!valid) {
+    logger.debug(`Invalid yaml: ${JSON.stringify(validate.errors)}`);
+    throw new IacSchemaErrors(validate.errors as Array<ErrorObject>);
+  }
 
   return true;
 };

tests/fixtures/serverless-insignt.yml

@@ -9,6 +9,8 @@ vars:
 stages:
   dev:
     region: ${vars.region}
+  prod:
+    region: cn-shanghai
 
 service: insight-poc
 

tests/validate.test.ts → tests/stack/validate.test.ts

@@ -1,8 +1,8 @@
 import { readFileSync } from 'node:fs';
 import * as path from 'node:path';
 import { parse } from 'yaml';
-import { RawServerlessIac } from '../src/types';
-import { validateYaml } from '../src/stack';
+import { validateYaml } from '../../src/stack';
+import { RawServerlessIac } from '../../src/types';
 
 const jsonIac = parse(
   readFileSync(path.resolve(__dirname, './fixtures/serverless-insignt.yml'), 'utf8'),