@serverless-devs/engine 0.0.1-beta.3 → 0.0.1-beta.31

package/lib/index.js

@@ -22,6 +22,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -41,63 +44,119 @@ const types_1 = require("./types");
 const utils_1 = require("./utils");
 const parse_spec_1 = __importStar(require("@serverless-devs/parse-spec"));
 const path_1 = __importDefault(require("path"));
-const js_yaml_1 = __importDefault(require("js-yaml"));
 const chalk_1 = __importDefault(require("chalk"));
 const actions_1 = __importDefault(require("./actions"));
 const credential_1 = __importDefault(require("@serverless-devs/credential"));
 const load_component_1 = __importDefault(require("@serverless-devs/load-component"));
 const logger_1 = __importDefault(require("@serverless-devs/logger"));
-const utils = __importStar(require("@serverless-devs/utils"));
+const utils_2 = require("@serverless-devs/utils");
+const constants_1 = require("./constants");
+const assert_1 = __importDefault(require("assert"));
+__exportStar(require("./types"), exports);
 const debug = require('@serverless-cd/debug')('serverless-devs:engine');
+/**
+ * Engine Class
+ *
+ * This class provides an engine to handle Serverless Devs operations and steps.
+ * It operates based on the xstate state machine library, ensuring that execution follows
+ * the predefined flow and states.
+ */
 class Engine {
     constructor(options) {
         this.options = options;
-        this.context = { status: types_1.STEP_STATUS.PENING, completed: false };
-        this.record = { status: types_1.STEP_STATUS.PENING, editStatusAble: true };
+        this.context = {
+            status: types_1.STEP_STATUS.PENDING,
+            completed: false,
+            error: [],
+        };
+        this.record = { status: types_1.STEP_STATUS.PENDING, editStatusAble: true };
         this.spec = {};
         debug('engine start');
         // 初始化参数
         this.options.args = (0, lodash_1.get)(this.options, 'args', process.argv.slice(2));
         this.options.cwd = (0, lodash_1.get)(this.options, 'cwd', process.cwd());
-        this.options.template = utils.getAbsolutePath((0, lodash_1.get)(this.options, 'template'), this.options.cwd);
+        this.options.template = (0, utils_2.getAbsolutePath)((0, lodash_1.get)(this.options, 'template'), this.options.cwd);
         debug(`engine options: ${(0, utils_1.stringify)(options)}`);
     }
+    /**
+     * Initialization steps before starting the engine.
+     */
+    beforeStart() {
+        return __awaiter(this, void 0, void 0, function* () {
+            // 初始化 logger
+            this.glog = this.getLogger();
+            this.logger = this.glog.__generate('engine');
+            // 初始化 spec
+            this.parseSpecInstance = new parse_spec_1.default((0, lodash_1.get)(this.options, 'template'), {
+                argv: this.options.args,
+                logger: this.logger,
+            });
+            this.spec = yield this.parseSpecInstance.start();
+            // 初始化行参环境变量 > .env (parse-spec require .env)
+            (0, lodash_1.each)(this.options.env, (value, key) => {
+                process.env[key] = value;
+            });
+            const { steps: _steps } = this.spec;
+            // 参数校验
+            this.validate();
+            this.context.steps = yield this.download(_steps);
+        });
+    }
+    /**
+     * Start the engine.
+     *
+     * This is the primary execution function for the engine. It is responsible for starting
+     * the entire engine and handling each step.
+     *
+     * @note engine应收敛所有的异常，不应该抛出异常
+     */
     start() {
         return __awaiter(this, void 0, void 0, function* () {
             this.context.status = types_1.STEP_STATUS.RUNNING;
-            // engine应收敛所有的异常，不应该抛出异常
+            // Haoran: should set this.record.status to RUNNING?
+            this.record.status = types_1.STEP_STATUS.RUNNING;
             try {
-                this.parseSpecInstance = new parse_spec_1.default((0, lodash_1.get)(this.options, 'template'), this.options.args);
-                this.spec = this.parseSpecInstance.start();
+                yield this.beforeStart();
             }
             catch (error) {
-                this.context.error = error;
+                this.context.status = types_1.STEP_STATUS.FAILURE;
+                this.context.completed = true;
+                this.context.error.push(error);
                 return this.context;
             }
-            // 初始化行参环境变量 > .env (parse-spec require .env)
-            (0, lodash_1.each)(this.options.env, (value, key) => {
-                process.env[key] = value;
-            });
-            const { steps: _steps, yaml, access = yaml.access } = this.spec;
-            this.validate();
-            this.glog = this.getLogger();
-            this.logger = this.glog.__generate('engine');
-            const steps = yield this.download(_steps);
+            const { steps: _steps, yaml, command, access = yaml.access } = this.spec;
+            this.logger.write(`${(0, utils_2.emoji)('⌛')} Steps for [${command}] of [${(0, lodash_1.get)(this.spec, 'yaml.appName')}]\n${chalk_1.default.gray('====================')}`);
+            // 初始化全局的 action
             this.globalActionInstance = new actions_1.default(yaml.actions, {
                 hookLevel: parse_spec_1.IActionLevel.GLOBAL,
                 logger: this.logger,
                 skipActions: this.spec.skipActions,
             });
             const credential = yield (0, utils_1.getCredential)(access, this.logger);
-            yield this.globalActionInstance.start(parse_spec_1.IHookType.PRE, { access, credential });
-            this.context.steps = (0, lodash_1.map)(steps, (item) => {
-                return Object.assign(Object.assign({}, item), { stepCount: (0, lodash_1.uniqueId)(), status: types_1.STEP_STATUS.PENING, done: false });
+            this.context.credential = credential;
+            // 处理 global-pre
+            try {
+                this.globalActionInstance.setValue('magic', this.getFilterContext());
+                this.globalActionInstance.setValue('command', command);
+                yield this.globalActionInstance.start(parse_spec_1.IHookType.PRE, { access, credential });
+            }
+            catch (error) {
+                this.context.error.push(error);
+                this.context.status = types_1.STEP_STATUS.FAILURE;
+                yield this.doCompleted();
+                return this.context;
+            }
+            // Assign the id, pending status and etc for all steps.
+            this.context.steps = (0, lodash_1.map)(this.context.steps, item => {
+                return Object.assign(Object.assign({}, item), { stepCount: (0, lodash_1.uniqueId)(), status: types_1.STEP_STATUS.PENDING, done: false });
             });
             const res = yield new Promise((resolve) => __awaiter(this, void 0, void 0, function* () {
+                // Every states object has two fixed states, "init" and "final".
                 const states = {
                     init: {
                         on: {
-                            INIT: (0, lodash_1.get)(this.context.steps, '[0].stepCount'),
+                            // Haoran: May this.context.steps be empty?
+                            INIT: this.context.steps.length === 0 ? 'final' : (0, lodash_1.get)(this.context.steps, '[0].stepCount'),
                         },
                     },
                     final: {
@@ -105,12 +164,11 @@ class Engine {
                         invoke: {
                             src: () => __awaiter(this, void 0, void 0, function* () {
                                 // 执行终态是 error-with-continue 的时候，改为 success
-                                const status = this.record.status === types_1.STEP_STATUS.ERROR_WITH_CONTINUE
-                                    ? types_1.STEP_STATUS.SUCCESS
-                                    : this.record.status;
+                                const status = this.record.status === types_1.STEP_STATUS.ERROR_WITH_CONTINUE ? types_1.STEP_STATUS.SUCCESS : this.record.status;
                                 this.context.status = status;
                                 yield this.doCompleted();
-                                this.context.steps = (0, lodash_1.map)(this.context.steps, (item) => (0, lodash_1.omit)(item, ['instance']));
+                                this.context.steps = (0, lodash_1.map)(this.context.steps, item => (0, lodash_1.omit)(item, ['instance']));
+                                this.context.output = this.getOutput();
                                 debug(`context: ${(0, utils_1.stringify)(this.context)}`);
                                 debug('engine end');
                                 resolve(this.context);
@@ -118,40 +176,25 @@ class Engine {
                         },
                     },
                 };
+                // Every states object has dynamic state, that based on the step.StepCount.
                 (0, lodash_1.each)(this.context.steps, (item, index) => {
-                    const target = this.context.steps[index + 1]
-                        ? (0, lodash_1.get)(this.context.steps, `[${index + 1}].stepCount`)
-                        : 'final';
-                    const flowProject = yaml.useFlow
-                        ? (0, lodash_1.filter)(this.context.steps, (o) => o.flowId === item.flowId)
-                        : [item];
+                    const target = this.context.steps[index + 1] ? (0, lodash_1.get)(this.context.steps, `[${index + 1}].stepCount`) : 'final';
+                    const flowProject = yaml.useFlow ? (0, lodash_1.filter)(this.context.steps, o => o.flowId === item.flowId) : [item];
                     states[item.stepCount] = {
                         invoke: {
                             id: item.stepCount,
                             src: () => __awaiter(this, void 0, void 0, function* () {
-                                // 并行时如果已经执行过，则跳过。
+                                // 并行时如果已经执行，则跳过。
                                 if (item.done)
                                     return;
                                 this.record.startTime = Date.now();
                                 // 记录 context
                                 this.recordContext(item, { status: types_1.STEP_STATUS.RUNNING });
-                                // 先判断if条件，成功则执行该步骤。
-                                if (item.if) {
-                                    // 替换 failure()
-                                    item.if = (0, lodash_1.replace)(item.if, types_1.STEP_IF.FAILURE, this.record.status === types_1.STEP_STATUS.FAILURE ? 'true' : 'false');
-                                    // 替换 success()
-                                    item.if = (0, lodash_1.replace)(item.if, types_1.STEP_IF.SUCCESS, this.record.status !== types_1.STEP_STATUS.FAILURE ? 'true' : 'false');
-                                    // 替换 always()
-                                    item.if = (0, lodash_1.replace)(item.if, types_1.STEP_IF.ALWAYS, 'true');
-                                    return item.if === 'true'
-                                        ? yield Promise.all((0, lodash_1.map)(flowProject, (o) => this.handleSrc(o)))
-                                        : yield Promise.all((0, lodash_1.map)(flowProject, (o) => this.doSkip(o)));
-                                }
                                 // 检查全局的执行状态，如果是failure，则不执行该步骤, 并记录状态为 skipped
                                 if (this.record.status === types_1.STEP_STATUS.FAILURE) {
-                                    return yield Promise.all((0, lodash_1.map)(flowProject, (o) => this.doSkip(o)));
+                                    return yield Promise.all((0, lodash_1.map)(flowProject, o => this.doSkip(o)));
                                 }
-                                return yield Promise.all((0, lodash_1.map)(flowProject, (o) => this.handleSrc(o)));
+                                return yield Promise.all((0, lodash_1.map)(flowProject, o => this.handleSrc(o)));
                             }),
                             onDone: {
                                 target,
@@ -167,44 +210,41 @@ class Engine {
                     states,
                 });
                 const stepService = (0, xstate_1.interpret)(fetchMachine)
-                    .onTransition((state) => state.value)
+                    .onTransition(state => state.value)
                     .start();
                 stepService.send('INIT');
             }));
+            this.glog.__clear();
             return res;
         });
     }
-    output() {
-        const { output } = this.spec;
-        debug(`output: ${output}`);
-        if ((0, lodash_1.isEmpty)(output))
-            return;
-        const data = {};
-        (0, lodash_1.each)(this.context.steps, (item) => {
-            if (!(0, lodash_1.isEmpty)(item.output)) {
-                (0, lodash_1.set)(data, item.projectName, item.output);
+    /**
+     * Extracts and returns an object containing the output of each step.
+     * The object's key is the project name and the value is the output of that project.
+     */
+    getOutput() {
+        const output = {};
+        (0, lodash_1.each)(this.context.steps, item => {
+            if (!(0, lodash_1.isNil)(item.output)) {
+                (0, lodash_1.set)(output, item.projectName, item.output);
             }
         });
-        if (output === parse_spec_1.IOutput.JSON) {
-            return console.log(JSON.stringify(data, null, 2));
-        }
-        if (output === parse_spec_1.IOutput.RAW) {
-            return console.log(JSON.stringify(data));
-        }
-        if (output === parse_spec_1.IOutput.YAML) {
-            return console.log(js_yaml_1.default.dump(data));
-        }
-        return this.logger.output(data, 0);
+        return output;
     }
+    /**
+     * Validates the 'steps' and 'command' present in 'this.spec'.
+     * Throws an error if either 'steps' or 'command' are missing.
+     */
     validate() {
-        const { steps, method } = this.spec;
-        if ((0, lodash_1.isEmpty)(steps)) {
-            throw new Error('steps is empty');
-        }
-        if ((0, lodash_1.isEmpty)(method)) {
-            throw new Error('method is empty');
-        }
+        const { steps, command } = this.spec;
+        (0, assert_1.default)(!(0, lodash_1.isEmpty)(steps), 'steps is required');
+        (0, assert_1.default)(command, 'command is required');
     }
+    /**
+     * Asynchronously downloads and initializes the given steps.
+     * For each step, it loads the specified component and associates a logger with it.
+     * Returns an array containing the initialized steps.
+     */
     download(steps) {
         return __awaiter(this, void 0, void 0, function* () {
             const newSteps = [];
@@ -223,24 +263,30 @@ class Engine {
         const customLogger = (0, lodash_1.get)(this.options, 'logConfig.customLogger');
         if (customLogger) {
             debug('use custom logger');
-            if (customLogger instanceof logger_1.default) {
+            if ((customLogger === null || customLogger === void 0 ? void 0 : customLogger.CODE) === logger_1.default.CODE) {
                 return customLogger;
             }
             throw new Error('customLogger must be instance of Logger');
         }
-        return new logger_1.default(Object.assign(Object.assign({ traceId: (0, lodash_1.get)(process.env, 'serverless_devs_trace_id', (0, utils_1.randomId)()), logDir: path_1.default.join(utils.getRootHome(), 'logs') }, this.options.logConfig), { level: (0, lodash_1.get)(this.options, 'logConfig.level', this.spec.debug ? 'DEBUG' : 'INFO') }));
+        return new logger_1.default(Object.assign(Object.assign({ traceId: (0, utils_2.traceid)(), logDir: path_1.default.join((0, utils_2.getRootHome)(), 'logs') }, this.options.logConfig), { level: (0, lodash_1.get)(this.options, 'logConfig.level', this.spec.debug ? 'DEBUG' : undefined) }));
     }
+    /**
+     * Updates the context for the given step based on the provided options.
+     *
+     * @param item - The current step being processed.
+     * @param options - An object containing details like status, error, output, etc. to update the step's context.
+     */
     recordContext(item, options = {}) {
         const { status, error, output, process_time, props, done } = options;
         this.context.stepCount = item.stepCount;
-        this.context.steps = (0, lodash_1.map)(this.context.steps, (obj) => {
+        this.context.steps = (0, lodash_1.map)(this.context.steps, obj => {
             if (obj.stepCount === item.stepCount) {
                 if (status) {
                     obj.status = status;
                 }
                 if (error) {
                     obj.error = error;
-                    this.context.error = error;
+                    this.context.error.push(error);
                 }
                 if (props) {
                     obj.props = props;
@@ -258,65 +304,150 @@ class Engine {
             return obj;
         });
     }
+    /**
+     * Generates a context data for the given step containing details like cwd, vars, and other steps' outputs and props.
+     * @param item - The current step being processed.
+     * @returns - The generated context data.
+     */
     getFilterContext(item) {
         const data = {
             cwd: path_1.default.dirname(this.spec.yaml.path),
             vars: this.spec.yaml.vars,
-            credential: item.credential,
+            resources: {},
         };
         for (const obj of this.context.steps) {
-            data[obj.projectName] = { output: obj.output || {}, props: obj.props || {} };
+            data.resources[obj.projectName] = { output: obj.output || {}, props: obj.props || {} };
+        }
+        if (item) {
+            data.credential = item.credential;
+            data.that = {
+                name: item.projectName,
+                access: item.access,
+                component: item.component,
+                props: data.resources[item.projectName].props,
+                output: data.resources[item.projectName].output,
+            };
         }
-        data.that = {
-            name: item.projectName,
-            access: item.access,
-            component: item.component,
-            props: data[item.projectName].props,
-            output: data[item.projectName].output,
-        };
         return data;
     }
+    /**
+     * Handles the subsequent operations after a step has been completed.
+     * 1. Marks the step as completed.
+     * 2. If the step status is FAILURE, attempts to trigger the global FAIL hook.
+     * 3. If the step status is SUCCESS, attempts to trigger the global SUCCESS hook.
+     * 4. Regardless of the step's status, tries to trigger the global COMPLETE hook to denote completion.
+     */
     doCompleted() {
         return __awaiter(this, void 0, void 0, function* () {
             this.context.completed = true;
+            if (this.context.status === types_1.STEP_STATUS.FAILURE) {
+                try {
+                    yield this.globalActionInstance.start(parse_spec_1.IHookType.FAIL, this.context);
+                }
+                catch (error) {
+                    this.context.status = types_1.STEP_STATUS.FAILURE;
+                    this.context.error.push(error);
+                }
+            }
             if (this.context.status === types_1.STEP_STATUS.SUCCESS) {
-                yield this.globalActionInstance.start(parse_spec_1.IHookType.SUCCESS, this.context);
+                try {
+                    yield this.globalActionInstance.start(parse_spec_1.IHookType.SUCCESS, this.context);
+                }
+                catch (error) {
+                    this.context.status = types_1.STEP_STATUS.FAILURE;
+                    this.context.error.push(error);
+                }
             }
-            if (this.context.status === types_1.STEP_STATUS.FAILURE) {
-                yield this.globalActionInstance.start(parse_spec_1.IHookType.FAIL, this.context);
+            try {
+                yield this.globalActionInstance.start(parse_spec_1.IHookType.COMPLETE, this.context);
+            }
+            catch (error) {
+                this.context.status = types_1.STEP_STATUS.FAILURE;
+                this.context.error.push(error);
             }
-            yield this.globalActionInstance.start(parse_spec_1.IHookType.COMPLETE, this.context);
         });
     }
+    /**
+     * Handles the execution process for a project step.
+     * @param item - The project step to handle.
+     */
     handleSrc(item) {
+        var _a, _b, _c;
         return __awaiter(this, void 0, void 0, function* () {
-            this.logger.info(`Start executing project ${item.projectName}`);
+            const { command } = this.spec;
+            // Attempt to execute pre-hook and component logic for the project step.
             try {
+                // project pre hook and project component
                 yield this.handleAfterSrc(item);
-                // 项目的output, 再次获取魔法变量
-                this.actionInstance.setValue('magic', this.getFilterContext(item));
-                const newInputs = yield this.getProps(item);
-                yield this.actionInstance.start(parse_spec_1.IHookType.SUCCESS, newInputs);
             }
             catch (error) {
-                const newInputs = yield this.getProps(item);
-                yield this.actionInstance.start(parse_spec_1.IHookType.FAIL, newInputs);
-            }
-            finally {
-                this.recordContext(item, { done: true });
-                const newInputs = yield this.getProps(item);
-                yield this.actionInstance.start(parse_spec_1.IHookType.COMPLETE, newInputs);
+                // On error, attempt to trigger the project's fail hook and update the recorded context.
+                try {
+                    const res = yield ((_a = this.actionInstance) === null || _a === void 0 ? void 0 : _a.start(parse_spec_1.IHookType.FAIL, this.record.componentProps));
+                    this.recordContext(item, (0, lodash_1.get)(res, 'pluginOutput', {}));
+                }
+                catch (error) {
+                    this.record.status = types_1.STEP_STATUS.FAILURE;
+                    this.recordContext(item, { error });
+                }
             }
             // 若记录的全局状态为true，则进行输出成功的日志
-            this.record.status === types_1.STEP_STATUS.SUCCESS &&
-                this.logger.info(`Project ${item.projectName} successfully to execute`);
+            // If the global record status is SUCCESS, attempt to trigger the project's success hook.
+            if (this.record.status === types_1.STEP_STATUS.SUCCESS) {
+                // project success hook
+                try {
+                    // 项目的output, 再次获取魔法变量
+                    this.actionInstance.setValue('magic', this.getFilterContext(item));
+                    const res = yield ((_b = this.actionInstance) === null || _b === void 0 ? void 0 : _b.start(parse_spec_1.IHookType.SUCCESS, Object.assign(Object.assign({}, this.record.componentProps), { output: (0, lodash_1.get)(item, 'output', {}) })));
+                    this.recordContext(item, (0, lodash_1.get)(res, 'pluginOutput', {}));
+                }
+                catch (error) {
+                    this.record.status = types_1.STEP_STATUS.FAILURE;
+                    this.recordContext(item, { error });
+                }
+            }
+            // Attempt to trigger the project's complete hook regardless of status.
+            try {
+                const res = yield ((_c = this.actionInstance) === null || _c === void 0 ? void 0 : _c.start(parse_spec_1.IHookType.COMPLETE, Object.assign(Object.assign({}, this.record.componentProps), { output: (0, lodash_1.get)(item, 'output', {}) })));
+                this.recordContext(item, (0, lodash_1.get)(res, 'pluginOutput', {}));
+            }
+            catch (error) {
+                this.record.status = types_1.STEP_STATUS.FAILURE;
+                this.recordContext(item, { error });
+            }
+            // 记录项目已经执行完成
+            const process_time = (0, utils_1.getProcessTime)(this.record.startTime);
+            this.recordContext(item, { done: true, process_time });
+            // Log output based on the record status.
+            if (this.record.status === types_1.STEP_STATUS.SUCCESS) {
+                this.logger.write(`${chalk_1.default.green('✔')} ${chalk_1.default.gray(`[${item.projectName}] completed (${process_time}s)`)}`);
+            }
+            if (this.record.status === types_1.STEP_STATUS.FAILURE) {
+                this.logger.write(`${chalk_1.default.red('✖')} ${chalk_1.default.gray(`[${item.projectName}] failed to [${command}] (${process_time}s)`)}`);
+            }
+            // step执行完成后，释放logger
+            this.glog.__unset(item.projectName);
         });
     }
+    /**
+     * Handles the logic after a project step's execution.
+     * @param item - The project step to handle.
+     */
     handleAfterSrc(item) {
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
             try {
+                // Print detailed information of the project step for debugging purposes.
                 debug(`project item: ${(0, utils_1.stringify)(item)}`);
+                // Extract the command from the specification.
+                const { command } = this.spec;
+                // Retrieve the credentials for the project step.
                 item.credential = yield (0, utils_1.getCredential)(item.access, this.logger);
+                // Set a secret for each credential.
+                (0, lodash_1.each)(item.credential, v => {
+                    this.glog.__setSecret([v]);
+                });
+                // Parse actions for the project step and initialize a new action instance.
                 const newAction = this.parseSpecInstance.parseActions(item.actions, parse_spec_1.IActionLevel.PROJECT);
                 debug(`project actions: ${JSON.stringify(newAction)}`);
                 this.actionInstance = new actions_1.default(newAction, {
@@ -325,26 +456,33 @@ class Engine {
                     logger: item.logger,
                     skipActions: this.spec.skipActions,
                 });
+                // Set values for the action instance.
                 this.actionInstance.setValue('magic', this.getFilterContext(item));
+                this.actionInstance.setValue('step', item);
+                this.actionInstance.setValue('command', command);
+                // Retrieve properties for the project step.
                 const newInputs = yield this.getProps(item);
-                const pluginResult = yield this.actionInstance.start(parse_spec_1.IHookType.PRE, newInputs);
+                this.actionInstance.setValue('componentProps', newInputs);
+                // Start the pre-hook and execute the logic for the project step.
+                const pluginResult = yield ((_a = this.actionInstance) === null || _a === void 0 ? void 0 : _a.start(parse_spec_1.IHookType.PRE, newInputs));
                 const response = yield this.doSrc(item, pluginResult);
                 // 记录全局的执行状态
                 if (this.record.editStatusAble) {
                     this.record.status = types_1.STEP_STATUS.SUCCESS;
                 }
-                // id 添加状态
+                // If the project step has an ID, update the corresponding record status and output.
                 if (item.id) {
                     this.record.steps = Object.assign(Object.assign({}, this.record.steps), { [item.id]: {
                             status: types_1.STEP_STATUS.SUCCESS,
                             output: response,
                         } });
                 }
-                const process_time = (0, utils_1.getProcessTime)(this.record.startTime);
-                this.recordContext(item, { status: types_1.STEP_STATUS.SUCCESS, output: response, process_time });
+                // Update the project step's context to SUCCESS.
+                this.recordContext(item, { status: types_1.STEP_STATUS.SUCCESS, output: response });
             }
             catch (e) {
                 const error = e;
+                // Determine the status based on the project step's "continue-on-error" attribute.
                 const status = item['continue-on-error'] === true ? types_1.STEP_STATUS.ERROR_WITH_CONTINUE : types_1.STEP_STATUS.FAILURE;
                 // 记录全局的执行状态
                 if (this.record.editStatusAble) {
@@ -354,87 +492,151 @@ class Engine {
                     // 全局的执行状态一旦失败，便不可修改
                     this.record.editStatusAble = false;
                 }
+                // If the project step has an ID, update the corresponding record status.
                 if (item.id) {
                     this.record.steps = Object.assign(Object.assign({}, this.record.steps), { [item.id]: {
                             status,
                         } });
                 }
-                const process_time = (0, utils_1.getProcessTime)(this.record.startTime);
+                // Handle the error based on the project step's "continue-on-error" attribute.
                 if (item['continue-on-error']) {
-                    this.recordContext(item, { status, process_time });
+                    this.recordContext(item, { status });
                 }
                 else {
-                    this.recordContext(item, { status, error, process_time });
+                    this.recordContext(item, { status, error });
                     throw error;
                 }
             }
         });
     }
+    /**
+     * Retrieve properties for a specific project step.
+     * @param item - The project step for which properties are to be retrieved.
+     * @returns An object containing properties related to the project step.
+     */
     getProps(item) {
         return __awaiter(this, void 0, void 0, function* () {
             const magic = this.getFilterContext(item);
             debug(`magic context: ${JSON.stringify(magic)}`);
             const newInputs = (0, parse_spec_1.getInputs)(item.props, magic);
-            const { projectName, method } = this.spec;
-            // TODO: inputs数据
+            const { projectName, command } = this.spec;
             const result = {
+                cwd: this.options.cwd,
+                name: (0, lodash_1.get)(this.spec, 'yaml.appName'),
                 props: newInputs,
-                method,
-                yaml: this.spec.yaml,
-                projectName: item.projectName,
-                access: item.access,
-                component: item.component,
-                credential: new credential_1.default({ logger: this.logger }),
-                args: (0, lodash_1.filter)(this.options.args, (o) => !(0, lodash_1.includes)([projectName, method], o)),
+                command,
+                args: (0, lodash_1.filter)(this.options.args, o => !(0, lodash_1.includes)([projectName, command], o)),
+                yaml: {
+                    path: (0, lodash_1.get)(this.spec, 'yaml.path'),
+                },
+                resource: {
+                    name: item.projectName,
+                    component: item.component,
+                    access: item.access,
+                },
+                outputs: this.getOutput(),
+                getCredential: () => __awaiter(this, void 0, void 0, function* () {
+                    const res = yield new credential_1.default({ logger: this.logger }).get(item.access);
+                    return (0, lodash_1.get)(res, 'credential', {});
+                }),
             };
             this.recordContext(item, { props: newInputs });
             debug(`get props: ${JSON.stringify(result)}`);
             return result;
         });
     }
+    /**
+     * Executes the appropriate action based on the provided project step.
+     * @param item - The project step to be executed.
+     * @param data - Additional data which may contain plugin output.
+     * @returns Result of the executed action, if applicable.
+     */
     doSrc(item, data = {}) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { method = '', projectName } = this.spec;
+            // Extract command and projectName from the specification.
+            const { command = '', projectName } = this.spec;
+            // Retrieve properties for the given project step.
             const newInputs = yield this.getProps(item);
-            const componentProps = (0, lodash_1.isEmpty)(data.pluginOutput) ? newInputs : data.pluginOutput;
-            debug(`component props: ${(0, utils_1.stringify)(componentProps)}`);
-            this.actionInstance.setValue('componentProps', componentProps);
+            // Set component properties based on the provided data or the newly retrieved properties.
+            this.record.componentProps = (0, lodash_1.isEmpty)(data.pluginOutput) ? newInputs : data.pluginOutput;
+            debug(`component props: ${(0, utils_1.stringify)(this.record.componentProps)}`);
+            this.actionInstance.setValue('componentProps', this.record.componentProps);
             // 服务级操作
             if (projectName) {
-                if ((0, lodash_1.isFunction)(item.instance[method])) {
+                if ((0, lodash_1.isFunction)(item.instance[command])) {
                     // 方法存在，执行报错，退出码101
                     try {
-                        return yield item.instance[method](componentProps);
+                        return yield item.instance[command](this.record.componentProps);
                     }
-                    catch (error) {
-                        (0, utils_1.throw101Error)(error, `Project ${item.projectName} failed to execute:`);
+                    catch (e) {
+                        const useAllowFailure = (0, utils_1.getAllowFailure)(item.allow_failure, {
+                            exitCode: constants_1.EXIT_CODE.COMPONENT,
+                            command,
+                        });
+                        if (useAllowFailure)
+                            return;
+                        const error = e;
+                        throw new utils_2.DevsError(error.message, {
+                            data: (0, lodash_1.get)(e, 'data'),
+                            stack: error.stack,
+                            exitCode: constants_1.EXIT_CODE.COMPONENT,
+                            prefix: `[${item.projectName}] failed to [${command}]:`,
+                        });
                     }
                 }
+                const useAllowFailure = (0, utils_1.getAllowFailure)(item.allow_failure, {
+                    exitCode: constants_1.EXIT_CODE.DEVS,
+                    command,
+                });
+                if (useAllowFailure)
+                    return;
                 // 方法不存在，此时系统将会认为是未找到组件方法，系统的exit code为100；
-                (0, utils_1.throw100Error)(`The [${method}] command was not found.`, `Please check the component ${item.component} has the ${method} method. Serverless Devs documents：${chalk_1.default.underline('https://github.com/Serverless-Devs/Serverless-Devs/blob/master/docs/zh/command')}`);
+                throw new utils_2.DevsError(`The [${command}] command was not found.`, {
+                    exitCode: constants_1.EXIT_CODE.DEVS,
+                    tips: `Please check the component ${item.component} has the ${command} command. Serverless Devs documents：${chalk_1.default.underline('https://github.com/Serverless-Devs/Serverless-Devs/blob/master/docs/zh/command')}`,
+                    prefix: `[${item.projectName}] failed to [${command}]:`,
+                });
             }
             // 应用级操作
-            if ((0, lodash_1.isFunction)(item.instance[method])) {
+            if ((0, lodash_1.isFunction)(item.instance[command])) {
                 // 方法存在，执行报错，退出码101
                 try {
-                    return yield item.instance[method](componentProps);
+                    return yield item.instance[command](this.record.componentProps);
                 }
-                catch (error) {
-                    (0, utils_1.throw101Error)(error, `Project ${item.projectName} failed to execute:`);
+                catch (e) {
+                    const useAllowFailure = (0, utils_1.getAllowFailure)(item.allow_failure, {
+                        exitCode: constants_1.EXIT_CODE.COMPONENT,
+                        command,
+                    });
+                    if (useAllowFailure)
+                        return;
+                    const error = e;
+                    throw new utils_2.DevsError(error.message, {
+                        data: (0, lodash_1.get)(e, 'data'),
+                        stack: error.stack,
+                        exitCode: constants_1.EXIT_CODE.COMPONENT,
+                        prefix: `[${item.projectName}] failed to [${command}]:`,
+                    });
                 }
             }
             // 方法不存在，进行警告，但是并不会报错，最终的exit code为0；
-            (0, utils_1.throwError)(`The [${method}] command was not found.`, `Please check the component ${item.component} has the ${method} method. Serverless Devs documents：https://github.com/Serverless-Devs/Serverless-Devs/blob/master/docs/zh/command`);
+            this.logger.tips(`The [${command}] command was not found.`, `Please check the component ${item.component} has the ${command} command. Serverless Devs documents：https://github.com/Serverless-Devs/Serverless-Devs/blob/master/docs/zh/command`);
         });
     }
+    /**
+     * Handles the project step that is marked to be skipped.
+     * @param item - The project step to be skipped.
+     * @returns A resolved Promise.
+     */
     doSkip(item) {
         return __awaiter(this, void 0, void 0, function* () {
-            // id 添加状态
+            // If the step has an 'id', set its status to 'SKIP' in the record.
             if (item.id) {
                 this.record.steps = Object.assign(Object.assign({}, this.record.steps), { [item.id]: {
                         status: types_1.STEP_STATUS.SKIP,
                     } });
             }
+            // Mark the step's status as 'SKIP' and set its processing time to 0.
             this.recordContext(item, { status: types_1.STEP_STATUS.SKIP, process_time: 0 });
             return Promise.resolve();
         });