@microsoft/teamsfx-core 1.1.2 → 1.1.3-alpha.12edbb86.0

package/build/common/deps-checker/internal/funcToolChecker.d.ts

@@ -0,0 +1,40 @@
+import { Result } from "@microsoft/teamsfx-api";
+import { DepsCheckerError } from "../depsError";
+import { DepsLogger } from "../depsLogger";
+import { DepsTelemetry } from "../depsTelemetry";
+import { DepsInfo, DepsChecker } from "../depsChecker";
+export declare enum FuncVersion {
+    v1 = "1",
+    v2 = "2",
+    v3 = "3"
+}
+export declare class FuncToolChecker implements DepsChecker {
+    private readonly _logger;
+    private readonly _telemetry;
+    constructor(logger: DepsLogger, telemetry: DepsTelemetry);
+    getDepsInfo(): Promise<DepsInfo>;
+    resolve(): Promise<Result<boolean, DepsCheckerError>>;
+    isInstalled(): Promise<boolean>;
+    isPortableFuncInstalled(): Promise<boolean>;
+    isGlobalFuncInstalled(): Promise<boolean>;
+    install(): Promise<void>;
+    private handleInstallFuncFailed;
+    private validate;
+    private handleNpmNotFound;
+    private static getDefaultInstallPath;
+    private static getSentinelPath;
+    private static getPortableFuncExecPath;
+    command(): Promise<string>;
+    getPortableFuncBinFolders(): string[];
+    private queryFuncVersion;
+    private queryGlobalFuncVersion;
+    private hasNPM;
+    private cleanup;
+    private cleanupPortablePs1;
+    private installFunc;
+    private doInstallPortableFunc;
+    private getExecCommand;
+    private getFuncPSScriptPath;
+}
+export declare function mapToFuncToolsVersion(output: string): FuncVersion | null;
+//# sourceMappingURL=funcToolChecker.d.ts.map

package/build/common/deps-checker/internal/funcToolChecker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"funcToolChecker.d.ts","sourceRoot":"","sources":["../../../../src/common/deps-checker/internal/funcToolChecker.ts"],"names":[],"mappings":"AAMA,OAAO,EAAoB,MAAM,EAAW,MAAM,wBAAwB,CAAC;AAI3E,OAAO,EAAE,gBAAgB,EAA0B,MAAM,cAAc,CAAC;AAIxE,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAGvD,oBAAY,WAAW;IACrB,EAAE,MAAM;IACR,EAAE,MAAM;IACR,EAAE,MAAM;CACT;AAWD,qBAAa,eAAgB,YAAW,WAAW;IACjD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAa;IACrC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgB;gBAE/B,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,aAAa;IAK3C,WAAW,IAAI,OAAO,CAAC,QAAQ,CAAC;IAWhC,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;IAmBrD,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAiB/B,uBAAuB,IAAI,OAAO,CAAC,OAAO,CAAC;IAsB3C,qBAAqB,IAAI,OAAO,CAAC,OAAO,CAAC;IAKzC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;YAqBvB,uBAAuB;YAcvB,QAAQ;IAyBtB,OAAO,CAAC,iBAAiB;IAQzB,OAAO,CAAC,MAAM,CAAC,qBAAqB;IAIpC,OAAO,CAAC,MAAM,CAAC,eAAe;IAI9B,OAAO,CAAC,MAAM,CAAC,uBAAuB;IAUzB,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC;IAUhC,yBAAyB,IAAI,MAAM,EAAE;YAO9B,gBAAgB;YAYhB,sBAAsB;YAgBtB,MAAM;YAoBN,OAAO;YAWP,kBAAkB;YAWlB,WAAW;YAYX,qBAAqB;IAyCnC,OAAO,CAAC,cAAc;YAIR,mBAAmB;CAqBlC;AAED,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,WAAW,GAAG,IAAI,CAiBxE"}

package/build/common/deps-checker/internal/funcToolChecker.js

@@ -0,0 +1,280 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapToFuncToolsVersion = exports.FuncToolChecker = exports.FuncVersion = void 0;
+const tslib_1 = require("tslib");
+const fs = tslib_1.__importStar(require("fs-extra"));
+const path = tslib_1.__importStar(require("path"));
+const os = tslib_1.__importStar(require("os"));
+const teamsfx_api_1 = require("@microsoft/teamsfx-api");
+const helpLink_1 = require("../constant/helpLink");
+const progressIndicator_1 = require("../util/progressIndicator");
+const depsError_1 = require("../depsError");
+const cpUtils_1 = require("../util/cpUtils");
+const system_1 = require("../util/system");
+const telemetry_1 = require("../constant/telemetry");
+const message_1 = require("../constant/message");
+var FuncVersion;
+(function (FuncVersion) {
+    FuncVersion["v1"] = "1";
+    FuncVersion["v2"] = "2";
+    FuncVersion["v3"] = "3";
+})(FuncVersion = exports.FuncVersion || (exports.FuncVersion = {}));
+const funcPackageName = "azure-functions-core-tools";
+const funcToolName = "Azure Function Core Tool";
+const installVersion = FuncVersion.v3;
+const supportedVersions = [FuncVersion.v3];
+const displayFuncName = `${funcToolName} (v${FuncVersion.v3})`;
+const timeout = 5 * 60 * 1000;
+class FuncToolChecker {
+    constructor(logger, telemetry) {
+        this._logger = logger;
+        this._telemetry = telemetry;
+    }
+    async getDepsInfo() {
+        return Promise.resolve({
+            name: funcToolName,
+            isLinuxSupported: false,
+            installVersion: installVersion,
+            supportedVersions: supportedVersions,
+            binFolders: this.getPortableFuncBinFolders(),
+            details: new Map(),
+        });
+    }
+    async resolve() {
+        try {
+            if (!(await this.isInstalled())) {
+                await this.install();
+            }
+        }
+        catch (error) {
+            await this._logger.printDetailLog();
+            await this._logger.error(`${error.message}, error = '${error}'`);
+            if (error instanceof depsError_1.DepsCheckerError) {
+                return teamsfx_api_1.err(error);
+            }
+            return teamsfx_api_1.err(new depsError_1.DepsCheckerError(error.message, helpLink_1.defaultHelpLink));
+        }
+        finally {
+            this._logger.cleanup();
+        }
+        return teamsfx_api_1.ok(true);
+    }
+    async isInstalled() {
+        const isGlobalFuncInstalled = await this.isGlobalFuncInstalled();
+        const isPortableFuncInstalled = await this.isPortableFuncInstalled();
+        if (isGlobalFuncInstalled) {
+            this._telemetry.sendEvent(telemetry_1.DepsCheckerEvent.funcAlreadyInstalled, {
+                "global-func-version": `${await this.queryGlobalFuncVersion()}`,
+            });
+        }
+        if (isPortableFuncInstalled) {
+            // avoid missing this event after first installation 60 days
+            this._telemetry.sendEvent(telemetry_1.DepsCheckerEvent.funcInstallCompleted);
+        }
+        return isPortableFuncInstalled || isGlobalFuncInstalled;
+    }
+    async isPortableFuncInstalled() {
+        let isVersionSupported = false, hasSentinel = false;
+        try {
+            const portableFuncVersion = await this.queryFuncVersion(FuncToolChecker.getPortableFuncExecPath());
+            isVersionSupported =
+                portableFuncVersion !== null && supportedVersions.includes(portableFuncVersion);
+            // to avoid "func -v" and "func new" work well, but "func start" fail.
+            hasSentinel = await fs.pathExists(FuncToolChecker.getSentinelPath());
+            if (system_1.isWindows() && isVersionSupported && hasSentinel) {
+                await this.cleanupPortablePs1();
+            }
+        }
+        catch (error) {
+            // do nothing
+            return false;
+        }
+        return isVersionSupported && hasSentinel;
+    }
+    async isGlobalFuncInstalled() {
+        const globalFuncVersion = await this.queryGlobalFuncVersion();
+        return globalFuncVersion !== null && supportedVersions.includes(globalFuncVersion);
+    }
+    async install() {
+        if (system_1.isLinux()) {
+            throw new depsError_1.LinuxNotSupportedError(helpLink_1.defaultHelpLink);
+        }
+        if (!(await this.hasNPM())) {
+            this.handleNpmNotFound();
+        }
+        await this.cleanup();
+        await this.installFunc();
+        if (!(await this.validate())) {
+            await this.handleInstallFuncFailed();
+        }
+        this._telemetry.sendEvent(telemetry_1.DepsCheckerEvent.funcInstallCompleted);
+        await this._logger.info(message_1.Messages.finishInstallFunctionCoreTool.replace("@NameVersion", displayFuncName));
+    }
+    async handleInstallFuncFailed() {
+        await this.cleanup();
+        this._telemetry.sendSystemErrorEvent(telemetry_1.DepsCheckerEvent.funcInstallError, telemetry_1.TelemtryMessages.failedToInstallFunc, message_1.Messages.failToValidateFuncCoreTool.replace("@NameVersion", displayFuncName));
+        throw new depsError_1.DepsCheckerError(message_1.Messages.failToInstallFuncCoreTool.split("@NameVersion").join(displayFuncName), helpLink_1.defaultHelpLink);
+    }
+    async validate() {
+        let isVersionSupported = false;
+        let hasSentinel = false;
+        try {
+            const portableFunc = await this.queryFuncVersion(FuncToolChecker.getPortableFuncExecPath());
+            isVersionSupported = portableFunc !== null && supportedVersions.includes(portableFunc);
+            // to avoid "func -v" and "func new" work well, but "func start" fail.
+            hasSentinel = await fs.pathExists(FuncToolChecker.getSentinelPath());
+        }
+        catch (err) {
+            this._telemetry.sendSystemErrorEvent(telemetry_1.DepsCheckerEvent.funcValidationError, telemetry_1.TelemtryMessages.failedToValidateFunc, err);
+        }
+        if (!isVersionSupported || !hasSentinel) {
+            this._telemetry.sendEvent(telemetry_1.DepsCheckerEvent.funcValidationError, {
+                "func-v": String(isVersionSupported),
+                sentinel: String(hasSentinel),
+            });
+        }
+        return isVersionSupported && hasSentinel;
+    }
+    handleNpmNotFound() {
+        this._telemetry.sendEvent(telemetry_1.DepsCheckerEvent.npmNotFound);
+        throw new depsError_1.DepsCheckerError(message_1.Messages.needInstallFuncCoreTool.replace("@NameVersion", displayFuncName), helpLink_1.defaultHelpLink);
+    }
+    static getDefaultInstallPath() {
+        return path.join(os.homedir(), `.${teamsfx_api_1.ConfigFolderName}`, "bin", "func");
+    }
+    static getSentinelPath() {
+        return path.join(os.homedir(), `.${teamsfx_api_1.ConfigFolderName}`, "func-sentinel");
+    }
+    static getPortableFuncExecPath() {
+        return path.join(FuncToolChecker.getDefaultInstallPath(), "node_modules", "azure-functions-core-tools", "lib", "main.js");
+    }
+    async command() {
+        if (await this.isPortableFuncInstalled()) {
+            return `node "${FuncToolChecker.getPortableFuncExecPath()}"`;
+        }
+        if (await this.isGlobalFuncInstalled()) {
+            return "func";
+        }
+        return "npx azure-functions-core-tools@3";
+    }
+    getPortableFuncBinFolders() {
+        return [
+            FuncToolChecker.getDefaultInstallPath(),
+            path.join(FuncToolChecker.getDefaultInstallPath(), "node_modules", ".bin"),
+        ];
+    }
+    async queryFuncVersion(path) {
+        const output = await cpUtils_1.cpUtils.executeCommand(undefined, this._logger, { shell: true }, "node", `"${path}"`, "--version");
+        return mapToFuncToolsVersion(output);
+    }
+    async queryGlobalFuncVersion() {
+        try {
+            const output = await cpUtils_1.cpUtils.executeCommand(undefined, this._logger, 
+            // same as backend start, avoid powershell execution policy issue.
+            { shell: system_1.isWindows() ? "cmd.exe" : true }, "func", "--version");
+            return mapToFuncToolsVersion(output);
+        }
+        catch (error) {
+            return null;
+        }
+    }
+    async hasNPM() {
+        try {
+            const npmVersion = await cpUtils_1.cpUtils.executeCommand(undefined, this._logger, { shell: true }, "npm", "--version");
+            this._telemetry.sendEvent(telemetry_1.DepsCheckerEvent.npmAlreadyInstalled, {
+                "npm-version": npmVersion,
+            });
+            return true;
+        }
+        catch (error) {
+            this._telemetry.sendEvent(telemetry_1.DepsCheckerEvent.npmNotFound);
+            return false;
+        }
+    }
+    async cleanup() {
+        try {
+            await fs.emptyDir(FuncToolChecker.getDefaultInstallPath());
+            await fs.remove(FuncToolChecker.getSentinelPath());
+        }
+        catch (err) {
+            await this._logger.debug(`Failed to clean up path: ${FuncToolChecker.getDefaultInstallPath()}, error: ${err}`);
+        }
+    }
+    async cleanupPortablePs1() {
+        // delete func.ps1 from portable function
+        for (const funcFolder of this.getPortableFuncBinFolders()) {
+            const funcPath = path.join(funcFolder, "func.ps1");
+            if (await fs.pathExists(funcPath)) {
+                await this._logger.debug(`deleting func.ps1 from ${funcPath}`);
+                await fs.remove(funcPath);
+            }
+        }
+    }
+    async installFunc() {
+        await this._telemetry.sendEventWithDuration(telemetry_1.DepsCheckerEvent.funcInstallScriptCompleted, async () => {
+            await progressIndicator_1.runWithProgressIndicator(async () => await this.doInstallPortableFunc(FuncVersion.v3), this._logger);
+        });
+    }
+    async doInstallPortableFunc(version) {
+        await this._logger.info(message_1.Messages.startInstallFunctionCoreTool.replace("@NameVersion", displayFuncName));
+        try {
+            await cpUtils_1.cpUtils.executeCommand(undefined, this._logger, { timeout: timeout, shell: false }, this.getExecCommand("npm"), "install", 
+            // not use -f, to avoid npm@6 bug: exit code = 0, even if install fail
+            `${funcPackageName}@${version}`, "--prefix", `${FuncToolChecker.getDefaultInstallPath()}`, "--no-audit");
+            await fs.ensureFile(FuncToolChecker.getSentinelPath());
+            if (system_1.isWindows()) {
+                // delete func.ps1 if exists to workaround the powershell execution policy issue:
+                // https://github.com/npm/cli/issues/470
+                const funcPSScript = await this.getFuncPSScriptPath();
+                if (await fs.pathExists(funcPSScript)) {
+                    await this._logger.debug(`deleting func.ps1 from ${funcPSScript}`);
+                    await fs.remove(funcPSScript);
+                }
+                await this.cleanupPortablePs1();
+            }
+        }
+        catch (error) {
+            this._telemetry.sendSystemErrorEvent(telemetry_1.DepsCheckerEvent.funcInstallScriptError, telemetry_1.TelemtryMessages.failedToInstallFunc, error);
+        }
+    }
+    getExecCommand(command) {
+        return system_1.isWindows() ? `${command}.cmd` : command;
+    }
+    async getFuncPSScriptPath() {
+        try {
+            const output = await cpUtils_1.cpUtils.executeCommand(undefined, this._logger, {
+                shell: "cmd.exe",
+            }, "where", "func");
+            const funcPath = output.split(/\r?\n/)[0];
+            const funcFolder = path.dirname(funcPath);
+            return path.join(funcFolder, "func.ps1");
+        }
+        catch (_a) {
+            // ignore error and regard func.ps1 as not found.
+            return "";
+        }
+    }
+}
+exports.FuncToolChecker = FuncToolChecker;
+function mapToFuncToolsVersion(output) {
+    var _a;
+    const regex = /(?<major_version>\d+)\.(?<minor_version>\d+)\.(?<patch_version>\d+)/gm;
+    const match = regex.exec(output);
+    if (!match) {
+        return null;
+    }
+    switch ((_a = match.groups) === null || _a === void 0 ? void 0 : _a.major_version) {
+        case FuncVersion.v1:
+            return FuncVersion.v1;
+        case FuncVersion.v2:
+            return FuncVersion.v2;
+        case FuncVersion.v3:
+            return FuncVersion.v3;
+        default:
+            return null;
+    }
+}
+exports.mapToFuncToolsVersion = mapToFuncToolsVersion;
+//# sourceMappingURL=funcToolChecker.js.map

package/build/common/deps-checker/internal/funcToolChecker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"funcToolChecker.js","sourceRoot":"","sources":["../../../../src/common/deps-checker/internal/funcToolChecker.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;AAElC,qDAA+B;AAC/B,mDAA6B;AAC7B,+CAAyB;AACzB,wDAA2E;AAE3E,mDAAuD;AACvD,iEAAqE;AACrE,4CAAwE;AACxE,6CAA0C;AAC1C,2CAAoD;AACpD,qDAA2E;AAI3E,iDAA+C;AAE/C,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,uBAAQ,CAAA;IACR,uBAAQ,CAAA;IACR,uBAAQ,CAAA;AACV,CAAC,EAJW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAItB;AAED,MAAM,eAAe,GAAG,4BAA4B,CAAC;AACrD,MAAM,YAAY,GAAG,0BAA0B,CAAC;AAEhD,MAAM,cAAc,GAAG,WAAW,CAAC,EAAE,CAAC;AACtC,MAAM,iBAAiB,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;AAC3C,MAAM,eAAe,GAAG,GAAG,YAAY,MAAM,WAAW,CAAC,EAAE,GAAG,CAAC;AAE/D,MAAM,OAAO,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;AAE9B,MAAa,eAAe;IAI1B,YAAY,MAAkB,EAAE,SAAwB;QACtD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;IAEM,KAAK,CAAC,WAAW;QACtB,OAAO,OAAO,CAAC,OAAO,CAAC;YACrB,IAAI,EAAE,YAAY;YAClB,gBAAgB,EAAE,KAAK;YACvB,cAAc,EAAE,cAAc;YAC9B,iBAAiB,EAAE,iBAAiB;YACpC,UAAU,EAAE,IAAI,CAAC,yBAAyB,EAAE;YAC5C,OAAO,EAAE,IAAI,GAAG,EAAkB;SACnC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,OAAO;QAClB,IAAI;YACF,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE;gBAC/B,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;aACtB;SACF;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;YACpC,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,OAAO,cAAc,KAAK,GAAG,CAAC,CAAC;YACjE,IAAI,KAAK,YAAY,4BAAgB,EAAE;gBACrC,OAAO,iBAAG,CAAC,KAAK,CAAC,CAAC;aACnB;YACD,OAAO,iBAAG,CAAC,IAAI,4BAAgB,CAAC,KAAK,CAAC,OAAO,EAAE,0BAAe,CAAC,CAAC,CAAC;SAClE;gBAAS;YACR,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;SACxB;QAED,OAAO,gBAAE,CAAC,IAAI,CAAC,CAAC;IAClB,CAAC;IAEM,KAAK,CAAC,WAAW;QACtB,MAAM,qBAAqB,GAAY,MAAM,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAC1E,MAAM,uBAAuB,GAAY,MAAM,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAE9E,IAAI,qBAAqB,EAAE;YACzB,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,4BAAgB,CAAC,oBAAoB,EAAE;gBAC/D,qBAAqB,EAAE,GAAG,MAAM,IAAI,CAAC,sBAAsB,EAAE,EAAE;aAChE,CAAC,CAAC;SACJ;QACD,IAAI,uBAAuB,EAAE;YAC3B,4DAA4D;YAC5D,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,4BAAgB,CAAC,oBAAoB,CAAC,CAAC;SAClE;QAED,OAAO,uBAAuB,IAAI,qBAAqB,CAAC;IAC1D,CAAC;IAEM,KAAK,CAAC,uBAAuB;QAClC,IAAI,kBAAkB,GAAG,KAAK,EAC5B,WAAW,GAAG,KAAK,CAAC;QACtB,IAAI;YACF,MAAM,mBAAmB,GAAG,MAAM,IAAI,CAAC,gBAAgB,CACrD,eAAe,CAAC,uBAAuB,EAAE,CAC1C,CAAC;YACF,kBAAkB;gBAChB,mBAAmB,KAAK,IAAI,IAAI,iBAAiB,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;YAClF,sEAAsE;YACtE,WAAW,GAAG,MAAM,EAAE,CAAC,UAAU,CAAC,eAAe,CAAC,eAAe,EAAE,CAAC,CAAC;YAErE,IAAI,kBAAS,EAAE,IAAI,kBAAkB,IAAI,WAAW,EAAE;gBACpD,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;aACjC;SACF;QAAC,OAAO,KAAK,EAAE;YACd,aAAa;YACb,OAAO,KAAK,CAAC;SACd;QACD,OAAO,kBAAkB,IAAI,WAAW,CAAC;IAC3C,CAAC;IAEM,KAAK,CAAC,qBAAqB;QAChC,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC9D,OAAO,iBAAiB,KAAK,IAAI,IAAI,iBAAiB,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC;IACrF,CAAC;IAEM,KAAK,CAAC,OAAO;QAClB,IAAI,gBAAO,EAAE,EAAE;YACb,MAAM,IAAI,kCAAsB,CAAC,0BAAe,CAAC,CAAC;SACnD;QACD,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE;YAC1B,IAAI,CAAC,iBAAiB,EAAE,CAAC;SAC1B;QAED,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QACrB,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QAEzB,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC,EAAE;YAC5B,MAAM,IAAI,CAAC,uBAAuB,EAAE,CAAC;SACtC;QAED,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,4BAAgB,CAAC,oBAAoB,CAAC,CAAC;QACjE,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CACrB,kBAAQ,CAAC,6BAA6B,CAAC,OAAO,CAAC,cAAc,EAAE,eAAe,CAAC,CAChF,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,uBAAuB;QACnC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QAErB,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAClC,4BAAgB,CAAC,gBAAgB,EACjC,4BAAgB,CAAC,mBAAmB,EACpC,kBAAQ,CAAC,0BAA0B,CAAC,OAAO,CAAC,cAAc,EAAE,eAAe,CAAC,CAC7E,CAAC;QACF,MAAM,IAAI,4BAAgB,CACxB,kBAAQ,CAAC,yBAAyB,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,EAC9E,0BAAe,CAChB,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,QAAQ;QACpB,IAAI,kBAAkB,GAAG,KAAK,CAAC;QAC/B,IAAI,WAAW,GAAG,KAAK,CAAC;QACxB,IAAI;YACF,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC,uBAAuB,EAAE,CAAC,CAAC;YAC5F,kBAAkB,GAAG,YAAY,KAAK,IAAI,IAAI,iBAAiB,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;YACvF,sEAAsE;YACtE,WAAW,GAAG,MAAM,EAAE,CAAC,UAAU,CAAC,eAAe,CAAC,eAAe,EAAE,CAAC,CAAC;SACtE;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAClC,4BAAgB,CAAC,mBAAmB,EACpC,4BAAgB,CAAC,oBAAoB,EACrC,GAAG,CACJ,CAAC;SACH;QAED,IAAI,CAAC,kBAAkB,IAAI,CAAC,WAAW,EAAE;YACvC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,4BAAgB,CAAC,mBAAmB,EAAE;gBAC9D,QAAQ,EAAE,MAAM,CAAC,kBAAkB,CAAC;gBACpC,QAAQ,EAAE,MAAM,CAAC,WAAW,CAAC;aAC9B,CAAC,CAAC;SACJ;QACD,OAAO,kBAAkB,IAAI,WAAW,CAAC;IAC3C,CAAC;IAEO,iBAAiB;QACvB,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,4BAAgB,CAAC,WAAW,CAAC,CAAC;QACxD,MAAM,IAAI,4BAAgB,CACxB,kBAAQ,CAAC,uBAAuB,CAAC,OAAO,CAAC,cAAc,EAAE,eAAe,CAAC,EACzE,0BAAe,CAChB,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,qBAAqB;QAClC,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,IAAI,8BAAgB,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IACxE,CAAC;IAEO,MAAM,CAAC,eAAe;QAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,IAAI,8BAAgB,EAAE,EAAE,eAAe,CAAC,CAAC;IAC1E,CAAC;IAEO,MAAM,CAAC,uBAAuB;QACpC,OAAO,IAAI,CAAC,IAAI,CACd,eAAe,CAAC,qBAAqB,EAAE,EACvC,cAAc,EACd,4BAA4B,EAC5B,KAAK,EACL,SAAS,CACV,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,OAAO;QAClB,IAAI,MAAM,IAAI,CAAC,uBAAuB,EAAE,EAAE;YACxC,OAAO,SAAS,eAAe,CAAC,uBAAuB,EAAE,GAAG,CAAC;SAC9D;QACD,IAAI,MAAM,IAAI,CAAC,qBAAqB,EAAE,EAAE;YACtC,OAAO,MAAM,CAAC;SACf;QACD,OAAO,kCAAkC,CAAC;IAC5C,CAAC;IAEM,yBAAyB;QAC9B,OAAO;YACL,eAAe,CAAC,qBAAqB,EAAE;YACvC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,qBAAqB,EAAE,EAAE,cAAc,EAAE,MAAM,CAAC;SAC3E,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,IAAY;QACzC,MAAM,MAAM,GAAG,MAAM,iBAAO,CAAC,cAAc,CACzC,SAAS,EACT,IAAI,CAAC,OAAO,EACZ,EAAE,KAAK,EAAE,IAAI,EAAE,EACf,MAAM,EACN,IAAI,IAAI,GAAG,EACX,WAAW,CACZ,CAAC;QACF,OAAO,qBAAqB,CAAC,MAAM,CAAC,CAAC;IACvC,CAAC;IAEO,KAAK,CAAC,sBAAsB;QAClC,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,iBAAO,CAAC,cAAc,CACzC,SAAS,EACT,IAAI,CAAC,OAAO;YACZ,kEAAkE;YAClE,EAAE,KAAK,EAAE,kBAAS,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,EAAE,EACzC,MAAM,EACN,WAAW,CACZ,CAAC;YACF,OAAO,qBAAqB,CAAC,MAAM,CAAC,CAAC;SACtC;QAAC,OAAO,KAAK,EAAE;YACd,OAAO,IAAI,CAAC;SACb;IACH,CAAC;IAEO,KAAK,CAAC,MAAM;QAClB,IAAI;YACF,MAAM,UAAU,GAAG,MAAM,iBAAO,CAAC,cAAc,CAC7C,SAAS,EACT,IAAI,CAAC,OAAO,EACZ,EAAE,KAAK,EAAE,IAAI,EAAE,EACf,KAAK,EACL,WAAW,CACZ,CAAC;YACF,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,4BAAgB,CAAC,mBAAmB,EAAE;gBAC9D,aAAa,EAAE,UAAU;aAC1B,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC;SACb;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,4BAAgB,CAAC,WAAW,CAAC,CAAC;YACxD,OAAO,KAAK,CAAC;SACd;IACH,CAAC;IAEO,KAAK,CAAC,OAAO;QACnB,IAAI;YACF,MAAM,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,qBAAqB,EAAE,CAAC,CAAC;YAC3D,MAAM,EAAE,CAAC,MAAM,CAAC,eAAe,CAAC,eAAe,EAAE,CAAC,CAAC;SACpD;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CACtB,4BAA4B,eAAe,CAAC,qBAAqB,EAAE,YAAY,GAAG,EAAE,CACrF,CAAC;SACH;IACH,CAAC;IAEO,KAAK,CAAC,kBAAkB;QAC9B,yCAAyC;QACzC,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,yBAAyB,EAAE,EAAE;YACzD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;YACnD,IAAI,MAAM,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;gBACjC,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,0BAA0B,QAAQ,EAAE,CAAC,CAAC;gBAC/D,MAAM,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;aAC3B;SACF;IACH,CAAC;IAEO,KAAK,CAAC,WAAW;QACvB,MAAM,IAAI,CAAC,UAAU,CAAC,qBAAqB,CACzC,4BAAgB,CAAC,0BAA0B,EAC3C,KAAK,IAAI,EAAE;YACT,MAAM,4CAAwB,CAC5B,KAAK,IAAI,EAAE,CAAC,MAAM,IAAI,CAAC,qBAAqB,CAAC,WAAW,CAAC,EAAE,CAAC,EAC5D,IAAI,CAAC,OAAO,CACb,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,qBAAqB,CAAC,OAAoB;QACtD,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CACrB,kBAAQ,CAAC,4BAA4B,CAAC,OAAO,CAAC,cAAc,EAAE,eAAe,CAAC,CAC/E,CAAC;QAEF,IAAI;YACF,MAAM,iBAAO,CAAC,cAAc,CAC1B,SAAS,EACT,IAAI,CAAC,OAAO,EACZ,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,EAClC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,EAC1B,SAAS;YACT,sEAAsE;YACtE,GAAG,eAAe,IAAI,OAAO,EAAE,EAC/B,UAAU,EACV,GAAG,eAAe,CAAC,qBAAqB,EAAE,EAAE,EAC5C,YAAY,CACb,CAAC;YAEF,MAAM,EAAE,CAAC,UAAU,CAAC,eAAe,CAAC,eAAe,EAAE,CAAC,CAAC;YAEvD,IAAI,kBAAS,EAAE,EAAE;gBACf,iFAAiF;gBACjF,wCAAwC;gBACxC,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBACtD,IAAI,MAAM,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE;oBACrC,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,0BAA0B,YAAY,EAAE,CAAC,CAAC;oBACnE,MAAM,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;iBAC/B;gBAED,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;aACjC;SACF;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAClC,4BAAgB,CAAC,sBAAsB,EACvC,4BAAgB,CAAC,mBAAmB,EACpC,KAAK,CACN,CAAC;SACH;IACH,CAAC;IAEO,cAAc,CAAC,OAAe;QACpC,OAAO,kBAAS,EAAE,CAAC,CAAC,CAAC,GAAG,OAAO,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;IAClD,CAAC;IAEO,KAAK,CAAC,mBAAmB;QAC/B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,iBAAO,CAAC,cAAc,CACzC,SAAS,EACT,IAAI,CAAC,OAAO,EACZ;gBACE,KAAK,EAAE,SAAS;aACjB,EACD,OAAO,EACP,MAAM,CACP,CAAC;YAEF,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1C,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAE1C,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;SAC1C;QAAC,WAAM;YACN,iDAAiD;YACjD,OAAO,EAAE,CAAC;SACX;IACH,CAAC;CACF;AA9UD,0CA8UC;AAED,SAAgB,qBAAqB,CAAC,MAAc;;IAClD,MAAM,KAAK,GAAG,uEAAuE,CAAC;IACtF,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACjC,IAAI,CAAC,KAAK,EAAE;QACV,OAAO,IAAI,CAAC;KACb;IAED,QAAQ,MAAA,KAAK,CAAC,MAAM,0CAAE,aAAa,EAAE;QACnC,KAAK,WAAW,CAAC,EAAE;YACjB,OAAO,WAAW,CAAC,EAAE,CAAC;QACxB,KAAK,WAAW,CAAC,EAAE;YACjB,OAAO,WAAW,CAAC,EAAE,CAAC;QACxB,KAAK,WAAW,CAAC,EAAE;YACjB,OAAO,WAAW,CAAC,EAAE,CAAC;QACxB;YACE,OAAO,IAAI,CAAC;KACf;AACH,CAAC;AAjBD,sDAiBC"}

package/build/common/deps-checker/internal/ngrokChecker.d.ts

@@ -0,0 +1,28 @@
+import { Result } from "@microsoft/teamsfx-api";
+import { DepsCheckerError } from "../depsError";
+import { DepsLogger } from "../depsLogger";
+import { DepsTelemetry } from "../depsTelemetry";
+import { DepsChecker, DepsInfo } from "../depsChecker";
+export declare class NgrokChecker implements DepsChecker {
+    private readonly _logger;
+    private readonly _telemetry;
+    constructor(logger: DepsLogger, telemetry: DepsTelemetry);
+    command(): Promise<string>;
+    getDepsInfo(): Promise<DepsInfo>;
+    isInstalled(): Promise<boolean>;
+    install(): Promise<void>;
+    getNgrokBinFolder(): string;
+    resolve(): Promise<Result<boolean, DepsCheckerError>>;
+    private handleInstallNgrokFailed;
+    private validate;
+    private handleNpmNotFound;
+    private getDefaultInstallPath;
+    private getSentinelPath;
+    private queryNgrokBinVersion;
+    private hasNPM;
+    private cleanup;
+    private installNgrok;
+    private doInstallNgrok;
+    private getExecCommand;
+}
+//# sourceMappingURL=ngrokChecker.d.ts.map

package/build/common/deps-checker/internal/ngrokChecker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ngrokChecker.d.ts","sourceRoot":"","sources":["../../../../src/common/deps-checker/internal/ngrokChecker.ts"],"names":[],"mappings":"AAMA,OAAO,EAA6B,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAG3E,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAKhD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAYvD,qBAAa,YAAa,YAAW,WAAW;IAC9C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAa;IACrC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgB;gBAE/B,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,aAAa;IAK3C,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC;IAIhC,WAAW,IAAI,OAAO,CAAC,QAAQ,CAAC;IAW1B,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAe/B,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAgB9B,iBAAiB,IAAI,MAAM;IAIrB,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;YAqBpD,wBAAwB;YAcxB,QAAQ;IAwBtB,OAAO,CAAC,iBAAiB;IAQzB,OAAO,CAAC,qBAAqB;IAI7B,OAAO,CAAC,eAAe;YAIT,oBAAoB;YAuBpB,MAAM;YAoBN,OAAO;YAWP,YAAY;YASZ,cAAc;IA2B5B,OAAO,CAAC,cAAc;CAGvB"}

package/build/common/deps-checker/internal/ngrokChecker.js

@@ -0,0 +1,181 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NgrokChecker = void 0;
+const tslib_1 = require("tslib");
+const fs = tslib_1.__importStar(require("fs-extra"));
+const path = tslib_1.__importStar(require("path"));
+const os = tslib_1.__importStar(require("os"));
+const teamsfx_api_1 = require("@microsoft/teamsfx-api");
+const helpLink_1 = require("../constant/helpLink");
+const depsError_1 = require("../depsError");
+const progressIndicator_1 = require("../util/progressIndicator");
+const cpUtils_1 = require("../util/cpUtils");
+const system_1 = require("../util/system");
+const telemetry_1 = require("../constant/telemetry");
+const message_1 = require("../constant/message");
+const ngrokName = "ngrok";
+const installPackageVersion = "4.2.2";
+const supportedPackageVersions = [">=3.4.0"];
+const supportedBinVersions = ["2.3"];
+const displayNgrokName = `${ngrokName}@${installPackageVersion}`;
+const timeout = 5 * 60 * 1000;
+class NgrokChecker {
+    constructor(logger, telemetry) {
+        this._logger = logger;
+        this._telemetry = telemetry;
+    }
+    async command() {
+        return "ngrok";
+    }
+    getDepsInfo() {
+        return Promise.resolve({
+            name: ngrokName,
+            isLinuxSupported: true,
+            installVersion: installPackageVersion,
+            binFolders: [this.getNgrokBinFolder()],
+            supportedVersions: supportedPackageVersions,
+            details: new Map(),
+        });
+    }
+    async isInstalled() {
+        let isVersionSupported = false, hasSentinel = false;
+        try {
+            const ngrokVersion = await this.queryNgrokBinVersion();
+            isVersionSupported =
+                ngrokVersion !== undefined && supportedBinVersions.includes(ngrokVersion);
+            hasSentinel = await fs.pathExists(this.getSentinelPath());
+        }
+        catch (error) {
+            // do nothing
+            return false;
+        }
+        return isVersionSupported && hasSentinel;
+    }
+    async install() {
+        if (!(await this.hasNPM())) {
+            this.handleNpmNotFound();
+        }
+        await this.cleanup();
+        await this.installNgrok();
+        if (!(await this.validate())) {
+            await this.handleInstallNgrokFailed();
+        }
+        this._telemetry.sendEvent(telemetry_1.DepsCheckerEvent.ngrokInstallCompleted);
+        await this._logger.info(message_1.Messages.finishInstallNgrok.replace("@NameVersion", displayNgrokName));
+    }
+    getNgrokBinFolder() {
+        return path.join(this.getDefaultInstallPath(), "node_modules", "ngrok", "bin");
+    }
+    async resolve() {
+        try {
+            if (!(await this.isInstalled())) {
+                // TODO: show output in extension
+                // this._adapter.showOutputChannel();
+                await this.install();
+                this._logger.cleanup();
+            }
+        }
+        catch (error) {
+            await this._logger.printDetailLog();
+            this._logger.cleanup();
+            await this._logger.error(`Failed to install 'ngrok', error = '${error}'`);
+            if (error instanceof depsError_1.DepsCheckerError) {
+                return teamsfx_api_1.err(error);
+            }
+            return teamsfx_api_1.err(new depsError_1.DepsCheckerError(error.message, helpLink_1.ngrokInstallHelpLink));
+        }
+        return teamsfx_api_1.ok(true);
+    }
+    async handleInstallNgrokFailed() {
+        await this.cleanup();
+        this._telemetry.sendSystemErrorEvent(telemetry_1.DepsCheckerEvent.ngrokInstallError, telemetry_1.TelemtryMessages.failedToInstallNgrok, message_1.Messages.failToValidateNgrok.replace("@NameVersion", displayNgrokName));
+        throw new depsError_1.DepsCheckerError(message_1.Messages.failToInstallNgrok.split("@NameVersion").join(displayNgrokName), helpLink_1.ngrokInstallHelpLink);
+    }
+    async validate() {
+        let isVersionSupported = false;
+        let hasSentinel = false;
+        try {
+            const binVersion = await this.queryNgrokBinVersion();
+            isVersionSupported = binVersion !== undefined && supportedBinVersions.includes(binVersion);
+            hasSentinel = await fs.pathExists(this.getSentinelPath());
+        }
+        catch (err) {
+            this._telemetry.sendSystemErrorEvent(telemetry_1.DepsCheckerEvent.ngrokValidationError, telemetry_1.TelemtryMessages.failedToValidateNgrok, err);
+        }
+        if (!isVersionSupported || !hasSentinel) {
+            this._telemetry.sendEvent(telemetry_1.DepsCheckerEvent.ngrokValidationError, {
+                "ngrok-v": String(isVersionSupported),
+                sentinel: String(hasSentinel),
+            });
+        }
+        return isVersionSupported && hasSentinel;
+    }
+    handleNpmNotFound() {
+        this._telemetry.sendEvent(telemetry_1.DepsCheckerEvent.npmNotFound);
+        throw new depsError_1.DepsCheckerError(message_1.Messages.needInstallNgrok.replace("@NameVersion", displayNgrokName), helpLink_1.ngrokInstallHelpLink);
+    }
+    getDefaultInstallPath() {
+        return path.join(os.homedir(), `.${teamsfx_api_1.ConfigFolderName}`, "bin", "ngrok");
+    }
+    getSentinelPath() {
+        return path.join(os.homedir(), `.${teamsfx_api_1.ConfigFolderName}`, "ngrok-sentinel");
+    }
+    async queryNgrokBinVersion() {
+        const output = await cpUtils_1.cpUtils.executeCommand(undefined, this._logger, {
+            shell: true,
+            env: { PATH: this.getNgrokBinFolder() },
+        }, ngrokName, "version");
+        const regex = /ngrok version (?<major_version>\d+)\.(?<minor_version>\d+)\.(?<patch_version>\d+)/gim;
+        const match = regex.exec(output);
+        if (!match || !match.groups) {
+            return undefined;
+        }
+        return `${match.groups.major_version}.${match.groups.minor_version}`;
+    }
+    async hasNPM() {
+        try {
+            const npmVersion = await cpUtils_1.cpUtils.executeCommand(undefined, this._logger, { shell: true }, "npm", "--version");
+            this._telemetry.sendEvent(telemetry_1.DepsCheckerEvent.npmAlreadyInstalled, {
+                "npm-version": npmVersion,
+            });
+            return true;
+        }
+        catch (error) {
+            this._telemetry.sendEvent(telemetry_1.DepsCheckerEvent.npmNotFound);
+            return false;
+        }
+    }
+    async cleanup() {
+        try {
+            await fs.emptyDir(this.getDefaultInstallPath());
+            await fs.remove(this.getSentinelPath());
+        }
+        catch (err) {
+            await this._logger.debug(`Failed to clean up path: ${this.getDefaultInstallPath()}, error: ${err}`);
+        }
+    }
+    async installNgrok() {
+        await this._telemetry.sendEventWithDuration(telemetry_1.DepsCheckerEvent.ngrokInstallScriptCompleted, async () => {
+            await progressIndicator_1.runWithProgressIndicator(async () => await this.doInstallNgrok(), this._logger);
+        });
+    }
+    async doInstallNgrok() {
+        await this._logger.info(message_1.Messages.startInstallNgrok.replace("@NameVersion", displayNgrokName));
+        try {
+            await cpUtils_1.cpUtils.executeCommand(undefined, this._logger, { timeout: timeout, shell: false }, this.getExecCommand("npm"), "install", 
+            // not use -f, to avoid npm@6 bug: exit code = 0, even if install fail
+            `${ngrokName}@${installPackageVersion}`, "--prefix", `${this.getDefaultInstallPath()}`, "--no-audit");
+            await fs.ensureFile(this.getSentinelPath());
+        }
+        catch (error) {
+            this._telemetry.sendSystemErrorEvent(telemetry_1.DepsCheckerEvent.ngrokInstallScriptError, telemetry_1.TelemtryMessages.failedToInstallNgrok, error);
+        }
+    }
+    getExecCommand(command) {
+        return system_1.isWindows() ? `${command}.cmd` : command;
+    }
+}
+exports.NgrokChecker = NgrokChecker;
+//# sourceMappingURL=ngrokChecker.js.map

package/build/common/deps-checker/internal/ngrokChecker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ngrokChecker.js","sourceRoot":"","sources":["../../../../src/common/deps-checker/internal/ngrokChecker.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;AAElC,qDAA+B;AAC/B,mDAA6B;AAC7B,+CAAyB;AACzB,wDAA2E;AAE3E,mDAA4D;AAC5D,4CAAgD;AAChD,iEAAqE;AACrE,6CAA0C;AAC1C,2CAA2C;AAC3C,qDAA2E;AAI3E,iDAA+C;AAE/C,MAAM,SAAS,GAAG,OAAO,CAAC;AAE1B,MAAM,qBAAqB,GAAG,OAAO,CAAC;AACtC,MAAM,wBAAwB,GAAG,CAAC,SAAS,CAAC,CAAC;AAC7C,MAAM,oBAAoB,GAAG,CAAC,KAAK,CAAC,CAAC;AACrC,MAAM,gBAAgB,GAAG,GAAG,SAAS,IAAI,qBAAqB,EAAE,CAAC;AAEjE,MAAM,OAAO,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;AAE9B,MAAa,YAAY;IAIvB,YAAY,MAAkB,EAAE,SAAwB;QACtD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;IAEM,KAAK,CAAC,OAAO;QAClB,OAAO,OAAO,CAAC;IACjB,CAAC;IAEM,WAAW;QAChB,OAAO,OAAO,CAAC,OAAO,CAAC;YACrB,IAAI,EAAE,SAAS;YACf,gBAAgB,EAAE,IAAI;YACtB,cAAc,EAAE,qBAAqB;YACrC,UAAU,EAAE,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACtC,iBAAiB,EAAE,wBAAwB;YAC3C,OAAO,EAAE,IAAI,GAAG,EAAkB;SACnC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,WAAW;QACtB,IAAI,kBAAkB,GAAG,KAAK,EAC5B,WAAW,GAAG,KAAK,CAAC;QACtB,IAAI;YACF,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC;YACvD,kBAAkB;gBAChB,YAAY,KAAK,SAAS,IAAI,oBAAoB,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;YAC5E,WAAW,GAAG,MAAM,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC,CAAC;SAC3D;QAAC,OAAO,KAAK,EAAE;YACd,aAAa;YACb,OAAO,KAAK,CAAC;SACd;QACD,OAAO,kBAAkB,IAAI,WAAW,CAAC;IAC3C,CAAC;IAEM,KAAK,CAAC,OAAO;QAClB,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE;YAC1B,IAAI,CAAC,iBAAiB,EAAE,CAAC;SAC1B;QAED,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QACrB,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QAE1B,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC,EAAE;YAC5B,MAAM,IAAI,CAAC,wBAAwB,EAAE,CAAC;SACvC;QAED,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,4BAAgB,CAAC,qBAAqB,CAAC,CAAC;QAClE,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAQ,CAAC,kBAAkB,CAAC,OAAO,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC,CAAC;IACjG,CAAC;IAEM,iBAAiB;QACtB,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,cAAc,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;IACjF,CAAC;IAEM,KAAK,CAAC,OAAO;QAClB,IAAI;YACF,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE;gBAC/B,iCAAiC;gBACjC,qCAAqC;gBACrC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;gBACrB,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;aACxB;SACF;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;YACpC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YACvB,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,uCAAuC,KAAK,GAAG,CAAC,CAAC;YAC1E,IAAI,KAAK,YAAY,4BAAgB,EAAE;gBACrC,OAAO,iBAAG,CAAC,KAAK,CAAC,CAAC;aACnB;YACD,OAAO,iBAAG,CAAC,IAAI,4BAAgB,CAAC,KAAK,CAAC,OAAO,EAAE,+BAAoB,CAAC,CAAC,CAAC;SACvE;QAED,OAAO,gBAAE,CAAC,IAAI,CAAC,CAAC;IAClB,CAAC;IAEO,KAAK,CAAC,wBAAwB;QACpC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QAErB,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAClC,4BAAgB,CAAC,iBAAiB,EAClC,4BAAgB,CAAC,oBAAoB,EACrC,kBAAQ,CAAC,mBAAmB,CAAC,OAAO,CAAC,cAAc,EAAE,gBAAgB,CAAC,CACvE,CAAC;QACF,MAAM,IAAI,4BAAgB,CACxB,kBAAQ,CAAC,kBAAkB,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,EACxE,+BAAoB,CACrB,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,QAAQ;QACpB,IAAI,kBAAkB,GAAG,KAAK,CAAC;QAC/B,IAAI,WAAW,GAAG,KAAK,CAAC;QACxB,IAAI;YACF,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC;YACrD,kBAAkB,GAAG,UAAU,KAAK,SAAS,IAAI,oBAAoB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;YAC3F,WAAW,GAAG,MAAM,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC,CAAC;SAC3D;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAClC,4BAAgB,CAAC,oBAAoB,EACrC,4BAAgB,CAAC,qBAAqB,EACtC,GAAG,CACJ,CAAC;SACH;QAED,IAAI,CAAC,kBAAkB,IAAI,CAAC,WAAW,EAAE;YACvC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,4BAAgB,CAAC,oBAAoB,EAAE;gBAC/D,SAAS,EAAE,MAAM,CAAC,kBAAkB,CAAC;gBACrC,QAAQ,EAAE,MAAM,CAAC,WAAW,CAAC;aAC9B,CAAC,CAAC;SACJ;QACD,OAAO,kBAAkB,IAAI,WAAW,CAAC;IAC3C,CAAC;IAEO,iBAAiB;QACvB,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,4BAAgB,CAAC,WAAW,CAAC,CAAC;QACxD,MAAM,IAAI,4BAAgB,CACxB,kBAAQ,CAAC,gBAAgB,CAAC,OAAO,CAAC,cAAc,EAAE,gBAAgB,CAAC,EACnE,+BAAoB,CACrB,CAAC;IACJ,CAAC;IAEO,qBAAqB;QAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,IAAI,8BAAgB,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAEO,eAAe;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,IAAI,8BAAgB,EAAE,EAAE,gBAAgB,CAAC,CAAC;IAC3E,CAAC;IAEO,KAAK,CAAC,oBAAoB;QAChC,MAAM,MAAM,GAAG,MAAM,iBAAO,CAAC,cAAc,CACzC,SAAS,EACT,IAAI,CAAC,OAAO,EACZ;YACE,KAAK,EAAE,IAAI;YACX,GAAG,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,iBAAiB,EAAE,EAAE;SACxC,EACD,SAAS,EACT,SAAS,CACV,CAAC;QAEF,MAAM,KAAK,GACT,sFAAsF,CAAC;QACzF,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEjC,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;YAC3B,OAAO,SAAS,CAAC;SAClB;QAED,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,aAAa,IAAI,KAAK,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC;IACvE,CAAC;IAEO,KAAK,CAAC,MAAM;QAClB,IAAI;YACF,MAAM,UAAU,GAAG,MAAM,iBAAO,CAAC,cAAc,CAC7C,SAAS,EACT,IAAI,CAAC,OAAO,EACZ,EAAE,KAAK,EAAE,IAAI,EAAE,EACf,KAAK,EACL,WAAW,CACZ,CAAC;YACF,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,4BAAgB,CAAC,mBAAmB,EAAE;gBAC9D,aAAa,EAAE,UAAU;aAC1B,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC;SACb;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,4BAAgB,CAAC,WAAW,CAAC,CAAC;YACxD,OAAO,KAAK,CAAC;SACd;IACH,CAAC;IAEO,KAAK,CAAC,OAAO;QACnB,IAAI;YACF,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAC;YAChD,MAAM,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC,CAAC;SACzC;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CACtB,4BAA4B,IAAI,CAAC,qBAAqB,EAAE,YAAY,GAAG,EAAE,CAC1E,CAAC;SACH;IACH,CAAC;IAEO,KAAK,CAAC,YAAY;QACxB,MAAM,IAAI,CAAC,UAAU,CAAC,qBAAqB,CACzC,4BAAgB,CAAC,2BAA2B,EAC5C,KAAK,IAAI,EAAE;YACT,MAAM,4CAAwB,CAAC,KAAK,IAAI,EAAE,CAAC,MAAM,IAAI,CAAC,cAAc,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACxF,CAAC,CACF,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,cAAc;QAC1B,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAQ,CAAC,iBAAiB,CAAC,OAAO,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC,CAAC;QAE9F,IAAI;YACF,MAAM,iBAAO,CAAC,cAAc,CAC1B,SAAS,EACT,IAAI,CAAC,OAAO,EACZ,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,EAClC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,EAC1B,SAAS;YACT,sEAAsE;YACtE,GAAG,SAAS,IAAI,qBAAqB,EAAE,EACvC,UAAU,EACV,GAAG,IAAI,CAAC,qBAAqB,EAAE,EAAE,EACjC,YAAY,CACb,CAAC;YAEF,MAAM,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC,CAAC;SAC7C;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAClC,4BAAgB,CAAC,uBAAuB,EACxC,4BAAgB,CAAC,oBAAoB,EACrC,KAAK,CACN,CAAC;SACH;IACH,CAAC;IAEO,cAAc,CAAC,OAAe;QACpC,OAAO,kBAAS,EAAE,CAAC,CAAC,CAAC,GAAG,OAAO,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;IAClD,CAAC;CACF;AAnOD,oCAmOC"}

package/build/common/deps-checker/internal/nodeChecker.d.ts

@@ -0,0 +1,40 @@
+import { DepsCheckerError } from "../depsError";
+import { DepsCheckerEvent } from "../constant/telemetry";
+import { DepsLogger } from "../depsLogger";
+import { DepsTelemetry } from "../depsTelemetry";
+import { DepsInfo, DepsChecker } from "../depsChecker";
+import { Result } from "@microsoft/teamsfx-api";
+export declare abstract class NodeChecker implements DepsChecker {
+    protected abstract readonly _nodeNotFoundHelpLink: string;
+    protected abstract readonly _nodeNotSupportedEvent: DepsCheckerEvent;
+    protected abstract getSupportedVersions(): Promise<string[]>;
+    protected abstract getNodeNotSupportedHelpLink(): Promise<string>;
+    private readonly _telemetry;
+    private readonly _logger;
+    constructor(logger: DepsLogger, telemetry: DepsTelemetry);
+    isInstalled(): Promise<boolean>;
+    resolve(): Promise<Result<boolean, DepsCheckerError>>;
+    install(): Promise<void>;
+    getDepsInfo(): Promise<DepsInfo>;
+    private static isVersionSupported;
+    command(): Promise<string>;
+}
+export declare class SPFxNodeChecker extends NodeChecker {
+    protected readonly _nodeNotFoundHelpLink: string;
+    protected readonly _nodeNotSupportedEvent = DepsCheckerEvent.nodeNotSupportedForSPFx;
+    protected getNodeNotSupportedHelpLink(): Promise<string>;
+    protected getSupportedVersions(): Promise<string[]>;
+}
+export declare class AzureNodeChecker extends NodeChecker {
+    protected readonly _nodeNotFoundHelpLink: string;
+    protected readonly _nodeNotSupportedEvent = DepsCheckerEvent.nodeNotSupportedForAzure;
+    protected getNodeNotSupportedHelpLink(): Promise<string>;
+    protected getSupportedVersions(): Promise<string[]>;
+}
+export declare class FunctionNodeChecker extends NodeChecker {
+    protected readonly _nodeNotFoundHelpLink: string;
+    protected readonly _nodeNotSupportedEvent = DepsCheckerEvent.nodeNotSupportedForAzure;
+    protected getNodeNotSupportedHelpLink(): Promise<string>;
+    protected getSupportedVersions(): Promise<string[]>;
+}
+//# sourceMappingURL=nodeChecker.d.ts.map

package/build/common/deps-checker/internal/nodeChecker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nodeChecker.d.ts","sourceRoot":"","sources":["../../../../src/common/deps-checker/internal/nodeChecker.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,EAA4C,MAAM,cAAc,CAAC;AAE1F,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAEvD,OAAO,EAAE,MAAM,EAAW,MAAM,wBAAwB,CAAC;AAoBzD,8BAAsB,WAAY,YAAW,WAAW;IACtD,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IAC1D,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,sBAAsB,EAAE,gBAAgB,CAAC;IACrE,SAAS,CAAC,QAAQ,CAAC,oBAAoB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAC5D,SAAS,CAAC,QAAQ,CAAC,2BAA2B,IAAI,OAAO,CAAC,MAAM,CAAC;IAEjE,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgB;IAC3C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAa;gBAEzB,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,aAAa;IAK3C,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IA+B/B,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;IAmBrD,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAIxB,WAAW,IAAI,OAAO,CAAC,QAAQ,CAAC;IAS7C,OAAO,CAAC,MAAM,CAAC,kBAAkB;IAIpB,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC;CAGxC;AAgCD,qBAAa,eAAgB,SAAQ,WAAW;IAC9C,SAAS,CAAC,QAAQ,CAAC,qBAAqB,SAAwB;IAChE,SAAS,CAAC,QAAQ,CAAC,sBAAsB,4CAA4C;cAErE,2BAA2B,IAAI,OAAO,CAAC,MAAM,CAAC;cAI9C,oBAAoB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;CAG1D;AAED,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C,SAAS,CAAC,QAAQ,CAAC,qBAAqB,SAAwB;IAChE,SAAS,CAAC,QAAQ,CAAC,sBAAsB,6CAA6C;cAEtE,2BAA2B,IAAI,OAAO,CAAC,MAAM,CAAC;cAI9C,oBAAoB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;CAG1D;AAED,qBAAa,mBAAoB,SAAQ,WAAW;IAClD,SAAS,CAAC,QAAQ,CAAC,qBAAqB,SAAwB;IAChE,SAAS,CAAC,QAAQ,CAAC,sBAAsB,6CAA6C;cAEtE,2BAA2B,IAAI,OAAO,CAAC,MAAM,CAAC;cAI9C,oBAAoB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;CAG1D"}