@microsoft/teamsfx-core 2.0.4-alpha.4f379e6ab.0 → 2.0.4-alpha.5925cbfed.0

package/build/ui/visitor.js

@@ -2,9 +2,12 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.traverse = exports.getSingleOption = exports.isAutoSkipSelect = void 0;
+exports.traverse = exports.collect = exports.questionVisitor = exports.getSingleOption = exports.isAutoSkipSelect = void 0;
 const teamsfx_api_1 = require("@microsoft/teamsfx-api");
+const lodash_1 = require("lodash");
 const error_1 = require("../error");
+const validationUtils_1 = require("./validationUtils");
+const featureFlags_1 = require("../common/featureFlags");
 function isAutoSkipSelect(q) {
     if (q.type === "singleSelect" || q.type === "multiSelect") {
         const select = q;
@@ -47,10 +50,16 @@ async function getCallFuncValue(inputs, raw) {
  * @param inputs
  */
 const questionVisitor = async function (question, ui, inputs, step, totalSteps) {
+    // 1. check and validate preset answer
     if (inputs[question.name] !== undefined) {
+        // validate existing answer in inputs object
+        const res = await validationUtils_1.validationUtils.validateManualInputs(question, inputs);
+        if (res)
+            return teamsfx_api_1.err(new error_1.InputValidationError(question.name, res));
         return teamsfx_api_1.ok({ type: "skip", result: inputs[question.name] });
     }
     const title = (await getCallFuncValue(inputs, question.title));
+    // 2. run auto function question
     if (question.type === "func") {
         try {
             let res;
@@ -68,277 +77,391 @@ const questionVisitor = async function (question, ui, inputs, step, totalSteps)
             if (typeof res === "object" && "isOk" in res) {
                 const fxresult = res;
                 if (fxresult.isOk()) {
-                    return teamsfx_api_1.ok({ type: "success", result: fxresult.value });
+                    return teamsfx_api_1.ok({ type: "skip", result: fxresult.value });
                 }
                 else {
                     return teamsfx_api_1.err(fxresult.error);
                 }
             }
-            return teamsfx_api_1.ok({ type: "success", result: res });
+            return teamsfx_api_1.ok({ type: "skip", result: res });
         }
         catch (e) {
             return teamsfx_api_1.err(error_1.assembleError(e));
         }
     }
+    // 3. for non-interactive mode, skip question asking and return error
+    if (inputs.nonInteractive && featureFlags_1.isCliNewUxEnabled()) {
+        return teamsfx_api_1.err(new error_1.MissingRequiredInputError(question.name, "core-ui"));
+    }
+    // 4. need manual input from user
+    let defaultValue = undefined;
+    if (question.forgetLastValue !== true && question.value)
+        defaultValue = question.value;
     else {
-        let defaultValue = undefined;
-        if (question.forgetLastValue !== true && question.value)
-            defaultValue = question.value;
-        else {
-            if (question.default) {
-                if (typeof question.default === "function") {
-                    defaultValue = async () => {
-                        return question.default(inputs);
-                    };
-                }
-                else {
-                    defaultValue = question.default;
-                }
-            }
-        }
-        const placeholder = (await getCallFuncValue(inputs, question.placeholder));
-        const prompt = (await getCallFuncValue(inputs, question.prompt));
-        if (question.type === "text") {
-            const validationFunc = question.validation
-                ? teamsfx_api_1.getValidationFunction(question.validation, inputs)
-                : undefined;
-            const inputQuestion = question;
-            return await ui.inputText({
-                name: question.name,
-                title: title,
-                password: inputQuestion.password,
-                default: defaultValue,
-                placeholder: placeholder,
-                prompt: prompt,
-                validation: validationFunc,
-                step: step,
-                totalSteps: totalSteps,
-            });
-        }
-        else if (question.type === "singleSelect" || question.type === "multiSelect") {
-            const selectQuestion = question;
-            let options = undefined;
-            if (selectQuestion.dynamicOptions) {
-                options = async () => {
-                    return selectQuestion.dynamicOptions(inputs);
+        if (question.default) {
+            if (typeof question.default === "function") {
+                defaultValue = async () => {
+                    return question.default(inputs);
                 };
             }
             else {
-                if (!selectQuestion.staticOptions || selectQuestion.staticOptions.length === 0) {
-                    return teamsfx_api_1.err(new error_1.EmptyOptionError());
-                }
-                if (selectQuestion.skipSingleOption && selectQuestion.staticOptions.length === 1) {
-                    const returnResult = getSingleOption(selectQuestion, selectQuestion.staticOptions);
-                    return teamsfx_api_1.ok({ type: "skip", result: returnResult });
-                }
-                options = selectQuestion.staticOptions;
+                defaultValue = question.default;
             }
-            if (question.type === "singleSelect") {
-                const validationFunc = question.validation
-                    ? teamsfx_api_1.getValidationFunction(question.validation, inputs)
-                    : undefined;
-                return await ui.selectOption({
-                    name: question.name,
-                    title: title,
-                    options: options,
-                    returnObject: selectQuestion.returnObject,
-                    default: defaultValue,
-                    placeholder: placeholder,
-                    prompt: prompt,
-                    step: step,
-                    totalSteps: totalSteps,
-                    buttons: question.buttons,
-                    validation: validationFunc,
-                    skipSingleOption: selectQuestion.skipSingleOption,
-                });
+        }
+    }
+    const placeholder = (await getCallFuncValue(inputs, question.placeholder));
+    const prompt = (await getCallFuncValue(inputs, question.prompt));
+    if (question.type === "text") {
+        const validationFunc = question.validation
+            ? teamsfx_api_1.getValidationFunction(question.validation, inputs)
+            : undefined;
+        const additionalValidationOnAcceptFunc = question.additionalValidationOnAccept
+            ? teamsfx_api_1.getValidationFunction(question.additionalValidationOnAccept, inputs)
+            : undefined;
+        const inputQuestion = question;
+        return await ui.inputText({
+            name: question.name,
+            title: title,
+            password: inputQuestion.password,
+            default: defaultValue,
+            placeholder: placeholder,
+            prompt: prompt,
+            validation: validationFunc,
+            step: step,
+            totalSteps: totalSteps,
+            additionalValidationOnAccept: additionalValidationOnAcceptFunc,
+        });
+    }
+    else if (question.type === "singleSelect" || question.type === "multiSelect") {
+        const selectQuestion = question;
+        let options = undefined;
+        if (selectQuestion.dynamicOptions) {
+            options = async () => {
+                return selectQuestion.dynamicOptions(inputs);
+            };
+        }
+        else {
+            if (!selectQuestion.staticOptions || selectQuestion.staticOptions.length === 0) {
+                return teamsfx_api_1.err(new error_1.EmptyOptionError());
             }
-            else {
-                const mq = selectQuestion;
-                const validationFunc = question.validation
-                    ? teamsfx_api_1.getValidationFunction(question.validation, inputs)
-                    : undefined;
-                return await ui.selectOptions({
-                    name: question.name,
-                    title: title,
-                    options: options,
-                    returnObject: selectQuestion.returnObject,
-                    default: defaultValue,
-                    placeholder: placeholder,
-                    prompt: prompt,
-                    onDidChangeSelection: mq.onDidChangeSelection,
-                    step: step,
-                    totalSteps: totalSteps,
-                    validation: validationFunc,
-                    skipSingleOption: selectQuestion.skipSingleOption,
-                });
+            if (selectQuestion.skipSingleOption && selectQuestion.staticOptions.length === 1) {
+                const returnResult = getSingleOption(selectQuestion, selectQuestion.staticOptions);
+                return teamsfx_api_1.ok({ type: "skip", result: returnResult });
             }
+            options = selectQuestion.staticOptions;
         }
-        else if (question.type === "multiFile") {
+        if (question.type === "singleSelect") {
             const validationFunc = question.validation
                 ? teamsfx_api_1.getValidationFunction(question.validation, inputs)
                 : undefined;
-            return await ui.selectFiles({
+            return await ui.selectOption({
                 name: question.name,
                 title: title,
-                placeholder: placeholder,
-                prompt: prompt,
+                options: options,
+                returnObject: selectQuestion.returnObject,
                 default: defaultValue,
-                step: step,
-                totalSteps: totalSteps,
-                validation: validationFunc,
-            });
-        }
-        else if (question.type === "singleFile") {
-            const validationFunc = question.validation
-                ? teamsfx_api_1.getValidationFunction(question.validation, inputs)
-                : undefined;
-            return await ui.selectFile({
-                name: question.name,
-                title: title,
                 placeholder: placeholder,
                 prompt: prompt,
-                default: defaultValue,
                 step: step,
                 totalSteps: totalSteps,
+                buttons: question.buttons,
                 validation: validationFunc,
-                filters: question.filters,
+                skipSingleOption: selectQuestion.skipSingleOption,
             });
         }
-        else if (question.type === "folder") {
+        else {
+            const mq = selectQuestion;
             const validationFunc = question.validation
                 ? teamsfx_api_1.getValidationFunction(question.validation, inputs)
                 : undefined;
-            return await ui.selectFolder({
+            return await ui.selectOptions({
                 name: question.name,
                 title: title,
-                placeholder: placeholder,
-                prompt: prompt,
+                options: options,
+                returnObject: selectQuestion.returnObject,
                 default: defaultValue,
-                step: step,
-                totalSteps: totalSteps,
-                validation: validationFunc,
-            });
-        }
-        else if (question.type === "singleFileOrText" && !!ui.selectFileOrInput) {
-            const validationFunc = question.validation
-                ? teamsfx_api_1.getValidationFunction(question.validation, inputs)
-                : undefined;
-            const res = await ui.selectFileOrInput({
-                name: question.name,
-                title: title,
                 placeholder: placeholder,
                 prompt: prompt,
-                inputOptionItem: question.inputOptionItem,
-                inputBoxConfig: question.inputBoxConfig,
-                filters: question.filters,
+                onDidChangeSelection: mq.onDidChangeSelection,
                 step: step,
                 totalSteps: totalSteps,
                 validation: validationFunc,
+                skipSingleOption: selectQuestion.skipSingleOption,
             });
-            return res;
         }
     }
+    else if (question.type === "multiFile") {
+        const validationFunc = question.validation
+            ? teamsfx_api_1.getValidationFunction(question.validation, inputs)
+            : undefined;
+        return await ui.selectFiles({
+            name: question.name,
+            title: title,
+            placeholder: placeholder,
+            prompt: prompt,
+            default: defaultValue,
+            step: step,
+            totalSteps: totalSteps,
+            validation: validationFunc,
+        });
+    }
+    else if (question.type === "singleFile") {
+        const validationFunc = question.validation
+            ? teamsfx_api_1.getValidationFunction(question.validation, inputs)
+            : undefined;
+        return await ui.selectFile({
+            name: question.name,
+            title: title,
+            placeholder: placeholder,
+            prompt: prompt,
+            default: defaultValue,
+            step: step,
+            totalSteps: totalSteps,
+            validation: validationFunc,
+            filters: question.filters,
+        });
+    }
+    else if (question.type === "folder") {
+        const validationFunc = question.validation
+            ? teamsfx_api_1.getValidationFunction(question.validation, inputs)
+            : undefined;
+        return await ui.selectFolder({
+            name: question.name,
+            title: title,
+            placeholder: placeholder,
+            prompt: prompt,
+            default: defaultValue,
+            step: step,
+            totalSteps: totalSteps,
+            validation: validationFunc,
+        });
+    }
+    else if (question.type === "singleFileOrText" && !!ui.selectFileOrInput) {
+        const validationFunc = question.validation
+            ? teamsfx_api_1.getValidationFunction(question.validation, inputs)
+            : undefined;
+        const additionalValidationOnAcceptFunc = question.inputBoxConfig.additionalValidationOnAccept
+            ? teamsfx_api_1.getValidationFunction({ validFunc: question.inputBoxConfig.additionalValidationOnAccept }, inputs)
+            : undefined;
+        question.inputBoxConfig.additionalValidationOnAccept = additionalValidationOnAcceptFunc;
+        const res = await ui.selectFileOrInput({
+            name: question.name,
+            title: title,
+            placeholder: placeholder,
+            prompt: prompt,
+            inputOptionItem: question.inputOptionItem,
+            inputBoxConfig: question.inputBoxConfig,
+            filters: question.filters,
+            step: step,
+            totalSteps: totalSteps,
+            validation: validationFunc,
+        });
+        return res;
+    }
     return teamsfx_api_1.err(new teamsfx_api_1.UserError("API", "UnsupportedNodeType", `Unsupported question node type:${JSON.stringify(question)}`, `Unsupported question node type:${JSON.stringify(question)}`));
 };
-async function traverse(root, inputs, ui, telemetryReporter, visitor = questionVisitor) {
-    const stack = [];
-    const history = [];
-    stack.push(root);
-    let step = 1; // manual input step
-    let totalStep = 1;
+exports.questionVisitor = questionVisitor;
+// export async function traverse(
+//   root: IQTreeNode,
+//   inputs: Inputs,
+//   ui: UserInteraction,
+//   telemetryReporter?: TelemetryReporter,
+//   visitor: QuestionTreeVisitor = questionVisitor
+// ): Promise<Result<Void, FxError>> {
+//   const stack: IQTreeNode[] = [];
+//   const history: IQTreeNode[] = [];
+//   stack.push(root);
+//   let step = 1; // manual input step
+//   let totalStep = 1;
+//   const parentMap = new Map<IQTreeNode, IQTreeNode>();
+//   // const valueMap = new Map<QTreeNode, unknown>();
+//   const autoSkipSet = new Set<IQTreeNode>();
+//   while (stack.length > 0) {
+//     const curr = stack.pop();
+//     if (!curr) continue;
+//     //visit
+//     if (curr.data.type !== "group") {
+//       const question = curr.data;
+//       totalStep = step + stack.length;
+//       let qvRes;
+//       try {
+//         qvRes = await visitor(question, ui, inputs, step, totalStep);
+//         sendTelemetryEvent(telemetryReporter, qvRes, question, inputs);
+//       } catch (e) {
+//         return err(assembleError(e));
+//       }
+//       if (qvRes.isErr()) {
+//         // Cancel or Error
+//         return err(qvRes.error);
+//       }
+//       const inputResult = qvRes.value;
+//       if (inputResult.type === "back") {
+//         stack.push(curr);
+//         // find the previous input that is neither group nor func nor single option select
+//         let found = false;
+//         while (history.length > 0) {
+//           const last = history.pop();
+//           if (!last) continue;
+//           if (last.children) {
+//             while (stack.length > 0) {
+//               const tmp = stack[stack.length - 1];
+//               if (last.children.includes(tmp)) {
+//                 stack.pop();
+//               } else {
+//                 break;
+//               }
+//             }
+//           }
+//           stack.push(last);
+//           if (last.data.type !== "group") delete inputs[last.data.name];
+//           const lastIsAutoSkip = autoSkipSet.has(last);
+//           if (last.data.type !== "group" && last.data.type !== "func" && !lastIsAutoSkip) {
+//             found = true;
+//             break;
+//           }
+//         }
+//         if (!found) {
+//           return err(new UserCancelError());
+//         }
+//         --step;
+//         continue; //ignore the following steps
+//       } else {
+//         //success or skip
+//         question.value = inputResult.result;
+//         inputs[question.name] = question.value;
+//         if (inputResult.type === "skip" || question.type === "func") {
+//           if (inputResult.type === "skip") autoSkipSet.add(curr);
+//         } else {
+//           ++step;
+//         }
+//       }
+//     }
+//     history.push(curr);
+//     if (curr.children) {
+//       const matchChildren: IQTreeNode[] = [];
+//       const valueInMap = findValue(curr, parentMap); //curr.data.type !== "group" ? curr.data.value : undefined; //valueMap.get(curr);
+//       for (const child of curr.children) {
+//         if (!child) continue;
+//         if (child.condition) {
+//           const validRes = await validate(
+//             child.condition,
+//             valueInMap as string | string[] | OptionItem | OptionItem[],
+//             inputs
+//           );
+//           if (validRes !== undefined) {
+//             continue;
+//           }
+//         }
+//         matchChildren.push(child);
+//       }
+//       for (let i = matchChildren.length - 1; i >= 0; --i) {
+//         const child = matchChildren[i];
+//         parentMap.set(child, curr);
+//         stack.push(child);
+//       }
+//     }
+//   }
+//   return ok(Void);
+// }
+/**
+ * serialize the tree node into array in DFS order
+ */
+function collect(node, list, parentMap) {
+    list.push(node);
+    if (node.children) {
+        for (const child of node.children) {
+            if (child) {
+                parentMap.set(child, node);
+                collect(child, list, parentMap);
+            }
+        }
+    }
+}
+exports.collect = collect;
+async function traverse(root, inputs, ui, telemetryReporter, visitor = exports.questionVisitor) {
+    // The reason to clone is that we don't want to change the original inputs if user cancel the process
+    const clonedInputs = lodash_1.cloneDeep(inputs);
+    // 1. collect all nodes into array
     const parentMap = new Map();
-    // const valueMap = new Map<QTreeNode, unknown>();
-    const autoSkipSet = new Set();
-    while (stack.length > 0) {
-        const curr = stack.pop();
-        if (!curr)
-            continue;
-        //visit
-        if (curr.data.type !== "group") {
-            const question = curr.data;
-            totalStep = step + stack.length;
-            let qvRes;
+    const nodeList = [];
+    collect(root, nodeList, parentMap);
+    const visitedNodeSet = new Set();
+    const visitedInputNodeArray = [];
+    let i = 0;
+    for (; i < nodeList.length; ++i) {
+        const node = nodeList[i];
+        // if parent node is not visited, current node should not be visited
+        const parent = parentMap.get(node);
+        if (parent) {
+            if (!visitedNodeSet.has(parent)) {
+                continue;
+            }
+        }
+        // 1. check condition
+        if (node.condition) {
+            let parentValue = undefined;
+            // const parent = parentMap.get(node);
+            if (parent) {
+                parentValue = findValue(parent, parentMap);
+            }
+            const validRes = await teamsfx_api_1.validate(node.condition, parentValue, clonedInputs);
+            if (validRes !== undefined) {
+                continue;
+            }
+        }
+        // 2. visit node if not group
+        if (node.data.type !== "group") {
+            const question = node.data;
+            let res;
             try {
-                qvRes = await visitor(question, ui, inputs, step, totalStep);
-                sendTelemetryEvent(telemetryReporter, qvRes, question, inputs);
+                res = await visitor(question, ui, clonedInputs, visitedInputNodeArray.length + 1, undefined);
+                sendTelemetryEvent(telemetryReporter, res, question, clonedInputs);
             }
             catch (e) {
                 return teamsfx_api_1.err(error_1.assembleError(e));
             }
-            if (qvRes.isErr()) {
+            if (res.isErr()) {
                 // Cancel or Error
-                return teamsfx_api_1.err(qvRes.error);
+                return teamsfx_api_1.err(res.error);
             }
-            const inputResult = qvRes.value;
+            const inputResult = res.value;
             if (inputResult.type === "back") {
-                stack.push(curr);
-                // find the previous input that is neither group nor func nor single option select
-                let found = false;
-                while (history.length > 0) {
-                    const last = history.pop();
-                    if (!last)
-                        continue;
-                    if (last.children) {
-                        while (stack.length > 0) {
-                            const tmp = stack[stack.length - 1];
-                            if (last.children.includes(tmp)) {
-                                stack.pop();
-                            }
-                            else {
-                                break;
-                            }
-                        }
+                const prevNode = visitedInputNodeArray.pop();
+                if (!prevNode) {
+                    return teamsfx_api_1.err(new error_1.UserCancelError());
+                }
+                for (--i; i >= 0; --i) {
+                    const tmpNode = nodeList[i];
+                    visitedNodeSet.delete(tmpNode);
+                    // clear prevNode data
+                    if (tmpNode.data.type !== "group") {
+                        delete tmpNode.data.value;
+                        delete tmpNode.data.valueType;
+                        delete clonedInputs[tmpNode.data.name];
                     }
-                    stack.push(last);
-                    if (last.data.type !== "group")
-                        delete inputs[last.data.name];
-                    const lastIsAutoSkip = autoSkipSet.has(last);
-                    if (last.data.type !== "group" && last.data.type !== "func" && !lastIsAutoSkip) {
-                        found = true;
+                    if (tmpNode === prevNode) {
                         break;
                     }
                 }
-                if (!found) {
-                    return teamsfx_api_1.err(new error_1.UserCancelError());
-                }
-                --step;
-                continue; //ignore the following steps
+                --i;
+                continue;
             }
             else {
-                //success or skip
+                //success or skip: set value
                 question.value = inputResult.result;
-                inputs[question.name] = question.value;
-                if (inputResult.type === "skip" || question.type === "func") {
-                    if (inputResult.type === "skip")
-                        autoSkipSet.add(curr);
-                }
-                else {
-                    ++step;
+                question.valueType = inputResult.type;
+                clonedInputs[question.name] = question.value;
+                visitedNodeSet.add(node);
+                if (question.valueType === "success") {
+                    visitedInputNodeArray.push(node);
                 }
             }
         }
-        history.push(curr);
-        if (curr.children) {
-            const matchChildren = [];
-            const valueInMap = findValue(curr, parentMap); //curr.data.type !== "group" ? curr.data.value : undefined; //valueMap.get(curr);
-            for (const child of curr.children) {
-                if (!child)
-                    continue;
-                if (child.condition) {
-                    const validRes = await teamsfx_api_1.validate(child.condition, valueInMap, inputs);
-                    if (validRes !== undefined) {
-                        continue;
-                    }
-                }
-                matchChildren.push(child);
-            }
-            for (let i = matchChildren.length - 1; i >= 0; --i) {
-                const child = matchChildren[i];
-                parentMap.set(child, curr);
-                stack.push(child);
-            }
+        else {
+            visitedNodeSet.add(node);
         }
     }
+    lodash_1.assign(inputs, clonedInputs);
     return teamsfx_api_1.ok(teamsfx_api_1.Void);
 }
 exports.traverse = traverse;