@microsoft/teamsfx-core 3.1.2 → 3.1.3-alpha.f04bf264d7.0

package/build/core/FxCore.js

@@ -16,6 +16,7 @@ require("reflect-metadata");
 const typedi_1 = require("typedi");
 const url_1 = require("url");
 const teamsDevPortalClient_1 = require("../client/teamsDevPortalClient");
+const cancellation_1 = require("../common/cancellation");
 const constants_1 = require("../common/constants");
 const daSpecParser_1 = require("../common/daSpecParser");
 const featureFlags_1 = require("../common/featureFlags");
@@ -77,11 +78,11 @@ const crypto_1 = require("./crypto");
 const environmentName_1 = require("./environmentName");
 const FxCore_openPlugin_1 = require("./FxCore.openPlugin");
 const generateConfigFiles_1 = require("./generateConfigFiles");
-const v4ArtifactSnapshot_1 = require("./v4ArtifactSnapshot");
 const concurrentLocker_1 = require("./middleware/concurrentLocker");
 const contextInjector_1 = require("./middleware/contextInjector");
 const errorHandler_1 = require("./middleware/errorHandler");
 const fileLocker_1 = require("./middleware/fileLocker");
+const v4ArtifactSnapshot_1 = require("./v4ArtifactSnapshot");
 const retry_1 = require("./middleware/retry");
 const v3MigrationUtils = tslib_1.__importStar(require("./middleware/utils/v3MigrationUtils"));
 const shareCore = tslib_1.__importStar(require("./share"));
@@ -105,6 +106,9 @@ class FxCore extends FxCore_openPlugin_1.FxCoreOpenPluginPart {
         super();
         (0, globalVars_1.setTools)(tools);
     }
+    getAbortSignal(inputs) {
+        return inputs.abortSignal;
+    }
     /**
      * @todo this's a really primitive implement. Maybe could use Subscription Model to
      * refactor later.
@@ -153,7 +157,7 @@ class FxCore extends FxCore_openPlugin_1.FxCoreOpenPluginPart {
                 return (0, teamsfx_api_1.err)(new common_2.InputValidationError("manifest.json", "App contains unsupported features"));
             }
             else {
-                context.telemetryReporter.sendTelemetryEvent(telemetry_2.CoreTelemetryEvent.CreateFromTdpStart, {
+                context.telemetryReporter?.sendTelemetryEvent(telemetry_2.CoreTelemetryEvent.CreateFromTdpStart, {
                     [telemetry_2.CoreTelemetryProperty.TdpTeamsAppFeatures]: (0, utils_2.getFeaturesFromAppDefinition)(inputs.teamsAppFromTdp).join(","),
                     [telemetry_2.CoreTelemetryProperty.TdpTeamsAppId]: inputs.teamsAppFromTdp.teamsAppId,
                 });
@@ -245,6 +249,9 @@ class FxCore extends FxCore_openPlugin_1.FxCoreOpenPluginPart {
      * none lifecycle command, uninstall provisioned resources
      */
     async uninstall(inputs) {
+        if (this.getAbortSignal(inputs)?.aborted) {
+            return (0, teamsfx_api_1.err)(new common_2.UserCancelError("FxCore"));
+        }
         switch (inputs[constants_3.QuestionNames.UninstallMode]) {
             case constants_3.QuestionNames.UninstallModeManifestId:
                 return await this.uninstallByManifestId(inputs);
@@ -269,20 +276,20 @@ class FxCore extends FxCore_openPlugin_1.FxCoreOpenPluginPart {
         const tdpOption = uninstallOptions?.includes(constants_3.QuestionNames.UninstallOptionTDP);
         const botOption = uninstallOptions?.includes(constants_3.QuestionNames.UninstallOptionBot);
         if (m356AppOption) {
-            const res = await this.uninstallM365App(undefined, manifestId);
+            const res = await this.uninstallM365App(undefined, manifestId, this.getAbortSignal(inputs));
             if (res.isErr()) {
                 return (0, teamsfx_api_1.err)(res.error);
             }
         }
         if (botOption) {
-            const res = await this.uninstallBotFrameworRegistration(undefined, manifestId);
+            const res = await this.uninstallBotFrameworRegistration(undefined, manifestId, this.getAbortSignal(inputs));
             if (res.isErr()) {
                 return (0, teamsfx_api_1.err)(res.error);
             }
         }
         // App registraion should be the last to remove, because we might need to query some metadata from TDP.
         if (tdpOption) {
-            const res = await this.uninstallAppRegistration(manifestId);
+            const res = await this.uninstallAppRegistration(manifestId, this.getAbortSignal(inputs));
             if (res.isErr()) {
                 return (0, teamsfx_api_1.err)(res.error);
             }
@@ -327,7 +334,7 @@ class FxCore extends FxCore_openPlugin_1.FxCoreOpenPluginPart {
         const tdpOption = uninstallOptions?.includes(constants_3.QuestionNames.UninstallOptionTDP);
         const botOption = uninstallOptions?.includes(constants_3.QuestionNames.UninstallOptionBot);
         if ((teamsAppId || m365TitleId) && m356AppOption) {
-            const res = await this.uninstallM365App(m365TitleId, teamsAppId);
+            const res = await this.uninstallM365App(m365TitleId, teamsAppId, this.getAbortSignal(inputs));
             if (res.isErr()) {
                 return (0, teamsfx_api_1.err)(res.error);
             }
@@ -335,7 +342,7 @@ class FxCore extends FxCore_openPlugin_1.FxCoreOpenPluginPart {
             this.resetEnvVar(m365TitleIdKeyName, ctx);
         }
         if (botId && botOption) {
-            const res = await this.uninstallBotFrameworRegistration(botId);
+            const res = await this.uninstallBotFrameworRegistration(botId, undefined, this.getAbortSignal(inputs));
             if (res.isErr()) {
                 return (0, teamsfx_api_1.err)(res.error);
             }
@@ -343,7 +350,7 @@ class FxCore extends FxCore_openPlugin_1.FxCoreOpenPluginPart {
         }
         // App registraion should be the last to remove, because we might need to query some metadata from TDP.
         if (teamsAppId && tdpOption) {
-            const res = await this.uninstallAppRegistration(teamsAppId);
+            const res = await this.uninstallAppRegistration(teamsAppId, this.getAbortSignal(inputs));
             if (res.isErr()) {
                 return (0, teamsfx_api_1.err)(res.error);
             }
@@ -372,7 +379,7 @@ class FxCore extends FxCore_openPlugin_1.FxCoreOpenPluginPart {
         if (!titleId) {
             return (0, teamsfx_api_1.err)(new common_2.MissingRequiredInputError("title-id", "FxCore"));
         }
-        const res = await this.uninstallM365App(titleId);
+        const res = await this.uninstallM365App(titleId, undefined, this.getAbortSignal(inputs));
         if (res.isErr()) {
             return (0, teamsfx_api_1.err)(res.error);
         }
@@ -381,7 +388,10 @@ class FxCore extends FxCore_openPlugin_1.FxCoreOpenPluginPart {
     /**
      * uninstall sideloaded appps in M365
      */
-    async uninstallM365App(titleId, manifestId) {
+    async uninstallM365App(titleId, manifestId, signal) {
+        if (signal?.aborted) {
+            return (0, teamsfx_api_1.err)(new common_2.UserCancelError("Uninstall M365 App"));
+        }
         if (titleId === undefined && manifestId === undefined) {
             return (0, teamsfx_api_1.err)(new common_2.MissingRequiredInputError("title id or manifest id", "FxCore"));
         }
@@ -395,7 +405,7 @@ class FxCore extends FxCore_openPlugin_1.FxCoreOpenPluginPart {
         const packageService = new packageService_1.PackageService(sideloadingServiceEndpoint, globalVars_1.TOOLS.logProvider);
         if (titleId === undefined) {
             try {
-                titleId = await packageService.retrieveTitleId(sideloadingTokenRes.value, manifestId ?? "");
+                titleId = await packageService.retrieveTitleId(sideloadingTokenRes.value, manifestId ?? "", signal);
             }
             catch (err) {
                 await globalVars_1.TOOLS.ui.showMessage("info", (0, localizeUtils_1.getLocalizedString)("core.uninstall.failed.titleId"), false);
@@ -408,7 +418,10 @@ class FxCore extends FxCore_openPlugin_1.FxCoreOpenPluginPart {
             default: true,
         });
         if (confirmRes?.isOk() && confirmRes.value.result === true) {
-            await packageService.unacquire(sideloadingTokenRes.value, titleId);
+            if (signal?.aborted) {
+                return (0, teamsfx_api_1.err)(new common_2.UserCancelError("Uninstall M365 App"));
+            }
+            await packageService.unacquire(sideloadingTokenRes.value, titleId, signal);
             await globalVars_1.TOOLS.ui.showMessage("info", (0, localizeUtils_1.getLocalizedString)("core.uninstall.success.m365App", titleId), false);
             await globalVars_1.TOOLS.ui.showMessage("info", (0, localizeUtils_1.getLocalizedString)("core.uninstall.success.delayWarning"), false);
         }
@@ -421,7 +434,10 @@ class FxCore extends FxCore_openPlugin_1.FxCoreOpenPluginPart {
     /**
      * uninstall sideloaded apps in Teams Developer Portal
      */
-    async uninstallAppRegistration(manifestId) {
+    async uninstallAppRegistration(manifestId, signal) {
+        if (signal?.aborted) {
+            return (0, teamsfx_api_1.err)(new common_2.UserCancelError("Uninstall App Registration"));
+        }
         const appStudioTokenRes = await globalVars_1.TOOLS.tokenProvider.m365TokenProvider.getAccessToken({
             scopes: (0, constants_1.AppStudioScopes)(),
         });
@@ -434,8 +450,14 @@ class FxCore extends FxCore_openPlugin_1.FxCoreOpenPluginPart {
             default: true,
         });
         if (confirmRes?.isOk() && confirmRes.value.result === true) {
+            if (signal?.aborted) {
+                return (0, teamsfx_api_1.err)(new common_2.UserCancelError("Uninstall App Registration"));
+            }
             const token = appStudioTokenRes.value;
             await teamsDevPortalClient_1.teamsDevPortalClient.deleteApp(token, manifestId);
+            if (signal?.aborted) {
+                return (0, teamsfx_api_1.err)(new common_2.UserCancelError("Uninstall App Registration"));
+            }
             await globalVars_1.TOOLS.ui.showMessage("info", (0, localizeUtils_1.getLocalizedString)("core.uninstall.success.tdp", manifestId), false);
             return (0, teamsfx_api_1.ok)(undefined);
         }
@@ -447,7 +469,10 @@ class FxCore extends FxCore_openPlugin_1.FxCoreOpenPluginPart {
     /**
      * uninstall bots created in dev.botframework.com
      */
-    async uninstallBotFrameworRegistration(botId, manifestId) {
+    async uninstallBotFrameworRegistration(botId, manifestId, signal) {
+        if (signal?.aborted) {
+            return (0, teamsfx_api_1.err)(new common_2.UserCancelError("Uninstall Bot Framework Registration"));
+        }
         if (!botId && !manifestId) {
             return (0, teamsfx_api_1.err)(new common_2.MissingRequiredInputError("bot id or manifest id", "FxCore"));
         }
@@ -472,7 +497,13 @@ class FxCore extends FxCore_openPlugin_1.FxCoreOpenPluginPart {
             default: true,
         });
         if (confirmRes?.isOk() && confirmRes.value.result === true) {
+            if (signal?.aborted) {
+                return (0, teamsfx_api_1.err)(new common_2.UserCancelError("Uninstall Bot Framework Registration"));
+            }
             await teamsDevPortalClient_1.teamsDevPortalClient.deleteBot(token, botId);
+            if (signal?.aborted) {
+                return (0, teamsfx_api_1.err)(new common_2.UserCancelError("Uninstall Bot Framework Registration"));
+            }
             await globalVars_1.TOOLS.ui.showMessage("info", (0, localizeUtils_1.getLocalizedString)("core.uninstall.success.bot", botId), false);
         }
         else {
@@ -1416,7 +1447,7 @@ class FxCore extends FxCore_openPlugin_1.FxCoreOpenPluginPart {
                 .showMessage("info", successMessage, false, viewPluginManifest)
                 .then((userRes) => {
                 if (userRes.isOk() && userRes.value === viewPluginManifest) {
-                    context.telemetryReporter.sendTelemetryEvent(telemetry_1.TelemetryEvent.ViewPluginManifestAfterAdded);
+                    context.telemetryReporter?.sendTelemetryEvent(telemetry_1.TelemetryEvent.ViewPluginManifestAfterAdded);
                     void globalVars_1.TOOLS?.ui?.openFile?.(destinationPluginManifestPath);
                 }
             });
@@ -1525,6 +1556,7 @@ class FxCore extends FxCore_openPlugin_1.FxCoreOpenPluginPart {
         // Confirm before modifying files (matches addPlugin pattern)
         const confirmMessage = (0, localizeUtils_1.getLocalizedString)("core.addSkill.confirm", path.relative(inputs.projectPath, appPackageFolder));
         const confirmRes = await context.userInteraction.showMessage("warn", confirmMessage, true, (0, localizeUtils_1.getLocalizedString)("core.addSkill.continue"));
+        (0, cancellation_1.throwIfAborted)(inputs);
         if (confirmRes.isErr()) {
             return (0, teamsfx_api_1.err)(confirmRes.error);
         }
@@ -1903,6 +1935,7 @@ class FxCore extends FxCore_openPlugin_1.FxCoreOpenPluginPart {
             }
             // Update openapi spec
             const specParser = new m365_spec_parser_1.SpecParser(apiSpecPath, (0, helper_1.getParserOptions)(m365_spec_parser_1.ProjectType.Copilot, true));
+            (0, cancellation_1.throwIfAborted)(inputs);
             await specParser.addAuthScheme(authName, authType, authParameters);
             let authTypeScheme;
             switch (authType) {
@@ -1951,13 +1984,13 @@ class FxCore extends FxCore_openPlugin_1.FxCoreOpenPluginPart {
                 const appIdUriPlaceholder = m365_spec_parser_1.Utils.getSafeRegistrationIdEnvName(`${authName}_APPLICATION_ID_URI`);
                 void context.userInteraction.showMessage("warn", (0, localizeUtils_1.getLocalizedString)("core.addAuthAction.microsoftEntra.message", appIdUriPlaceholder), false);
             }
-            context.telemetryReporter.sendTelemetryEvent(telemetry_1.TelemetryEvent.AddAuthAction, {
+            context.telemetryReporter?.sendTelemetryEvent(telemetry_1.TelemetryEvent.AddAuthAction, {
                 [telemetry_1.TelemetryProperty.AddAuthType]: authType,
             });
         }
         catch (e) {
             const error = (0, common_2.assembleError)(e);
-            context.telemetryReporter.sendTelemetryErrorEvent(telemetry_1.TelemetryEvent.AddAuthAction, {
+            context.telemetryReporter?.sendTelemetryErrorEvent(telemetry_1.TelemetryEvent.AddAuthAction, {
                 [telemetry_1.TelemetryProperty.ErrorCode]: error.name,
                 [telemetry_1.TelemetryProperty.ErrorMessage]: error.message,
             });
@@ -2279,7 +2312,7 @@ class FxCore extends FxCore_openPlugin_1.FxCoreOpenPluginPart {
                 .showMessage("info", successMessage, false, viewAgentManifest)
                 .then((userRes) => {
                 if (userRes.isOk() && userRes.value === viewAgentManifest) {
-                    context.telemetryReporter.sendTelemetryEvent(telemetry_1.TelemetryEvent.ViewAgentManifestAfterAdded);
+                    context.telemetryReporter?.sendTelemetryEvent(telemetry_1.TelemetryEvent.ViewAgentManifestAfterAdded);
                     void globalVars_1.TOOLS?.ui?.openFile?.(agentManifestPath);
                 }
             });
@@ -2403,7 +2436,7 @@ tslib_1.__decorate([
         errorHandler_1.ErrorHandlerMW,
     ]),
     tslib_1.__metadata("design:type", Function),
-    tslib_1.__metadata("design:paramtypes", [String, String]),
+    tslib_1.__metadata("design:paramtypes", [String, String, AbortSignal]),
     tslib_1.__metadata("design:returntype", Promise)
 ], FxCore.prototype, "uninstallM365App", null);
 tslib_1.__decorate([
@@ -2412,7 +2445,7 @@ tslib_1.__decorate([
         errorHandler_1.ErrorHandlerMW,
     ]),
     tslib_1.__metadata("design:type", Function),
-    tslib_1.__metadata("design:paramtypes", [String]),
+    tslib_1.__metadata("design:paramtypes", [String, AbortSignal]),
     tslib_1.__metadata("design:returntype", Promise)
 ], FxCore.prototype, "uninstallAppRegistration", null);
 tslib_1.__decorate([
@@ -2421,7 +2454,7 @@ tslib_1.__decorate([
         errorHandler_1.ErrorHandlerMW,
     ]),
     tslib_1.__metadata("design:type", Function),
-    tslib_1.__metadata("design:paramtypes", [String, String]),
+    tslib_1.__metadata("design:paramtypes", [String, String, AbortSignal]),
     tslib_1.__metadata("design:returntype", Promise)
 ], FxCore.prototype, "uninstallBotFrameworRegistration", null);
 tslib_1.__decorate([