feat: support --baseline-template, submit diffs to component

Signed-off-by: zxypro1 <[email protected]>
Serverless-Devs · Aug 8, 2024 · d7ccf3d · d7ccf3d
1 parent 1720c2d
commit d7ccf3d
Show file tree

Hide file tree

Showing 10 changed files with 58 additions and 7 deletions.
diff --git a/packages/component-interface/package.json b/packages/component-interface/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@serverless-devs/component-interface",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "request for serverless-devs",
   "main": "lib/index.js",
   "scripts": {

diff --git a/packages/component-interface/src/index.ts b/packages/component-interface/src/index.ts
@@ -22,4 +22,5 @@ export interface IInputs {
   cwd: string;
   outputs?: Record<string, any>;
   output?: Record<string, any>; // 当前步骤输出
+  diffs?: Record<string, any>[]; // 当 --baseline-template 参数存在时，和基线yaml做diff
 }
diff --git a/packages/engine/package.json b/packages/engine/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@serverless-devs/engine",
-  "version": "0.1.4-beta.15",
+  "version": "0.1.4-beta.16",
   "description": "a engine lib for serverless-devs",
   "main": "lib/index.js",
   "scripts": {
@@ -23,21 +23,23 @@
   "dependencies": {
     "@serverless-cd/debug": "^4.3.4",
     "@serverless-devs/credential": "workspace:^",
+    "@serverless-devs/load-application": "workspace:^",
     "@serverless-devs/load-component": "workspace:^",
     "@serverless-devs/logger": "workspace:^",
     "@serverless-devs/parse-spec": "workspace:^",
-    "@serverless-devs/utils": "workspace:^",
-    "@serverless-devs/load-application": "workspace:^",
     "@serverless-devs/secret": "workspace:^",
+    "@serverless-devs/utils": "workspace:^",
     "ajv": "^8.12.0",
     "chalk": "4.x",
+    "deep-diff": "^1.0.2",
     "flatted": "^3.2.7",
     "fs-extra": "^11.1.0",
     "lodash": "^4.17.21",
     "string-argv": "^0.3.2",
     "xstate": "^4.37.2"
   },
   "devDependencies": {
+    "@types/deep-diff": "^1.0.5",
     "@types/fs-extra": "^11.0.1",
     "@types/lodash": "^4.14.195"
   }

diff --git a/packages/engine/src/index.ts b/packages/engine/src/index.ts
@@ -1,7 +1,7 @@
 import { createMachine, interpret } from 'xstate';
 import { isEmpty, get, each, map, isFunction, has, uniqueId, filter, omit, includes, set, isNil, isUndefined, keys, size, cloneDeep, find } from 'lodash';
-import { IStepOptions, IRecord, IStatus, IEngineOptions, IContext, IEngineError, STEP_STATUS } from './types';
-import { getProcessTime, getCredential, stringify, getAllowFailure } from './utils';
+import { IStepOptions, IRecord, IStatus, IEngineOptions, IContext, IEngineError, STEP_STATUS, IDiff } from './types';
+import { getProcessTime, getCredential, stringify, getAllowFailure, getDiffs } from './utils';
 import ParseSpec, { getInputs, ISpec, IHookType, IStep as IParseStep, IActionLevel } from '@serverless-devs/parse-spec';
 import path from 'path';
 import chalk from 'chalk';
@@ -34,13 +34,16 @@ class Engine {
   } as IContext;
   private record = { status: STEP_STATUS.PENDING, editStatusAble: true } as IRecord;
   private spec = {} as ISpec;
+  private baselineSpec = {} as ISpec;
   private glog!: Logger;
   private logger!: ILoggerInstance;
   private parseSpecInstance!: ParseSpec;
+  private parseSpecInstanceBaseline!: ParseSpec;
   private globalActionInstance!: Actions; // 全局的 action
   private actionInstance!: Actions; // 项目的 action
   private info: Record<string, any> = {}; // 存储全局变量
   private secretManager!: SecretManager; // 敏感参数管理
+  private diffs: IDiff[] = []; // baseline diff
 
   constructor(private options: IEngineOptions) {
     debug('engine start');
@@ -72,6 +75,16 @@ class Engine {
       logger: this.logger,
     });
     this.spec = await this.parseSpecInstance.start();
+    // 20240808: Add baselineTemplate, do diff when --baseline-template is set
+    if (this.spec.baselineTemplate) {
+      this.logger.debug(`baselineTemplate: ${this.spec.baselineTemplate}`);
+      this.parseSpecInstanceBaseline = new ParseSpec(get(this.spec, 'baselineTemplate'), {
+        argv: this.options.args,
+        logger: this.logger,
+      });
+      this.baselineSpec = await this.parseSpecInstanceBaseline.start();
+      this.diffs = getDiffs(get(this.spec, 'yaml.content'), get(this.baselineSpec, 'yaml.content')) || [];
+    }
     // 初始化行参环境变量 > .env (parse-spec require .env)
     each(this.options.env, (value, key) => {
       process.env[key] = value;
@@ -655,6 +668,7 @@ class Engine {
         const res = await new Credential({ logger: this.logger }).get(item.access);
         return get(res, 'credential', {});
       },
+      diffs: filter(this.diffs, (diff) => { return diff.path?.startsWith(`resources.${item.projectName}`) }),
     };
     this.recordContext(item, { props: newInputs });
     debug(`get props: ${JSON.stringify(result)}`);

diff --git a/packages/engine/src/types.ts b/packages/engine/src/types.ts
@@ -3,6 +3,7 @@ import { IOptions as ILogConfig } from '@serverless-devs/logger/lib/type';
 import Logger, { ILoggerInstance } from '@serverless-devs/logger';
 import { AssertionError } from 'assert';
 import { DevsError } from '@serverless-devs/utils';
+import { Diff } from 'deep-diff';
 export interface IEngineOptions {
   args?: string[]; //默认 process.argv.slice(2)
   template?: string;
@@ -15,6 +16,10 @@ export interface IEngineOptions {
   serverlessDevsVersion?: string;
 }
 
+export type IDiff = Omit<Diff<Object, Object>, "path"> & {
+  path?: string | undefined;
+}
+
 export type IStepOptions = IStep & {
   logger: ILoggerInstance; // logger实例
   instance?: any; //组件实例

diff --git a/packages/engine/src/utils/index.ts b/packages/engine/src/utils/index.ts
@@ -8,13 +8,25 @@ import Ajv from 'ajv';
 import loadComponent from '@serverless-devs/load-component';
 import loadApplication from '@serverless-devs/load-application';
 import path from 'path';
+import deepDiff from 'deep-diff';
 
 export function getLogPath(filePath: string) {
   return `step_${filePath}.log`;
 }
 
 export const randomId = () => Math.random().toString(16).slice(2);
 
+export const getDiffs = (leftObject: Object, rightObject: Object) => {
+  const diffs = deepDiff.diff(leftObject, rightObject);
+  const formattedDiffs = diffs?.map((diff) => {
+    return {
+      ...diff,
+      path: diff.path?.join('.'),
+    }
+  });
+  return formattedDiffs || [];
+};
+
 export function getProcessTime(time: number) {
   return (Math.round((Date.now() - time) / 10) * 10) / 1000;
 }

diff --git a/packages/parse-spec/package.json b/packages/parse-spec/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@serverless-devs/parse-spec",
-  "version": "0.0.28-beta.11",
+  "version": "0.0.28-beta.12",
   "description": "a parse yaml spec lib for serverless-devs",
   "main": "lib/index.js",
   "scripts": {

diff --git a/packages/parse-spec/src/index.ts b/packages/parse-spec/src/index.ts
@@ -30,6 +30,7 @@ class ParseSpec {
   constructor(filePath: string = '', private options: IOptions = {}) {
     this.options.argv = this.options.argv || process.argv.slice(2);
     this.options.logger = this.options.logger || console;
+    // ${config()} ${secret()} won't show real value in preview mode
     this.options.isPreview = this.options.isPreview || false;
     this.init(filePath);
     debug(`yaml path: ${this.yaml.path}`);
@@ -259,6 +260,7 @@ class ParseSpec {
     this.record.skipActions = get(argv, 'skip-actions');
     this.record.debug = get(argv, 'debug');
     this.record.env = get(argv, 'env');
+    this.record.baselineTemplate = get(argv, 'baseline-template');
     if (includes(this.yaml.projectNames, _[0])) {
       this.record.projectName = _[0];
       this.record.command = _[1];

diff --git a/packages/parse-spec/src/types.ts b/packages/parse-spec/src/types.ts
@@ -94,6 +94,7 @@ export interface IRecord {
   help?: boolean;
   debug?: boolean;
   env?: string;
+  baselineTemplate?: string;
 }
 
 export enum IOutput {

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml