refactor: seperate scaffold from tdp (#11910)

* refactor: seperate scaffold from tdp * test: ut
OfficeDev · Jun 26, 2024 · b462957 · b462957
1 parent 25441d2
commit b462957
Show file tree

Hide file tree

Showing 5 changed files with 296 additions and 265 deletions.
diff --git a/packages/vscode-extension/src/extension.ts b/packages/vscode-extension/src/extension.ts
@@ -87,6 +87,7 @@ import {
   deployHandler,
   provisionHandler,
   publishHandler,
+  scaffoldFromDeveloperPortalHandler,
 } from "./handlers/lifecycleHandlers";
 import * as officeDevHandlers from "./handlers/officeDevHandlers";
 import {
@@ -422,7 +423,7 @@ function registerInternalCommands(context: vscode.ExtensionContext) {
   registerInCommandController(
     context,
     "fx-extension.openFromTdp",
-    handlers.scaffoldFromDeveloperPortalHandler,
+    scaffoldFromDeveloperPortalHandler,
     "openFromTdp"
   );
 

diff --git a/packages/vscode-extension/src/handlers.ts b/packages/vscode-extension/src/handlers.ts
@@ -713,102 +713,3 @@ export async function selectSubscriptionCallback(args?: any[]): Promise<Result<n
   await azureAccountManager.setSubscription(askSubRes.value.subscriptionId);
   return ok(null);
 }
-
-/**
- * scaffold based on app id from Developer Portal
- */
-export async function scaffoldFromDeveloperPortalHandler(
-  ...args: any[]
-): Promise<Result<null, FxError>> {
-  if (!args || args.length < 1) {
-    // should never happen
-    return ok(null);
-  }
-
-  const appId = args[0];
-  const properties: { [p: string]: string } = {
-    teamsAppId: appId,
-  };
-
-  ExtTelemetry.sendTelemetryEvent(TelemetryEvent.HandleUrlFromDeveloperProtalStart, properties);
-  const loginHint = args.length < 2 ? undefined : args[1];
-  const progressBar = VS_CODE_UI.createProgressBar(
-    localize("teamstoolkit.devPortalIntegration.checkM365Account.progressTitle"),
-    1
-  );
-
-  await progressBar.start();
-  let token = undefined;
-  try {
-    const tokenRes = await M365TokenInstance.signInWhenInitiatedFromTdp(
-      { scopes: AppStudioScopes },
-      loginHint
-    );
-    if (tokenRes.isErr()) {
-      if ((tokenRes.error as any).displayMessage) {
-        void vscode.window.showErrorMessage((tokenRes.error as any).displayMessage);
-      } else {
-        void vscode.window.showErrorMessage(
-          localize("teamstoolkit.devPortalIntegration.generalError.message")
-        );
-      }
-      ExtTelemetry.sendTelemetryErrorEvent(
-        TelemetryEvent.HandleUrlFromDeveloperProtal,
-        tokenRes.error,
-        properties
-      );
-      await progressBar.end(false);
-      return err(tokenRes.error);
-    }
-    token = tokenRes.value;
-
-    // set region
-    const AuthSvcTokenRes = await M365TokenInstance.getAccessToken({ scopes: AuthSvcScopes });
-    if (AuthSvcTokenRes.isOk()) {
-      await teamsDevPortalClient.setRegionEndpointByToken(AuthSvcTokenRes.value);
-    }
-
-    await progressBar.end(true);
-  } catch (e) {
-    void vscode.window.showErrorMessage(
-      localize("teamstoolkit.devPortalIntegration.generalError.message")
-    );
-    await progressBar.end(false);
-    const error = assembleError(e);
-    ExtTelemetry.sendTelemetryErrorEvent(
-      TelemetryEvent.HandleUrlFromDeveloperProtal,
-      error,
-      properties
-    );
-    return err(error);
-  }
-
-  let appDefinition;
-  try {
-    appDefinition = await teamsDevPortalClient.getApp(token, appId);
-  } catch (error: any) {
-    ExtTelemetry.sendTelemetryErrorEvent(
-      TelemetryEvent.HandleUrlFromDeveloperProtal,
-      error,
-      properties
-    );
-    void vscode.window.showErrorMessage(
-      localize("teamstoolkit.devPortalIntegration.getTeamsAppError.message")
-    );
-    return err(error);
-  }
-
-  const res = await createNewProjectHandler({ teamsAppFromTdp: appDefinition });
-
-  if (res.isErr()) {
-    ExtTelemetry.sendTelemetryErrorEvent(
-      TelemetryEvent.HandleUrlFromDeveloperProtal,
-      res.error,
-      properties
-    );
-    return err(res.error);
-  }
-
-  ExtTelemetry.sendTelemetryEvent(TelemetryEvent.HandleUrlFromDeveloperProtal, properties);
-  return ok(null);
-}
diff --git a/packages/vscode-extension/src/handlers/lifecycleHandlers.ts b/packages/vscode-extension/src/handlers/lifecycleHandlers.ts
@@ -1,11 +1,30 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
-import { CreateProjectResult, err, FxError, Inputs, Result, Stage } from "@microsoft/teamsfx-api";
-import { isUserCancelError, isValidOfficeAddInProject } from "@microsoft/teamsfx-core";
+import {
+  CreateProjectResult,
+  err,
+  FxError,
+  Inputs,
+  ok,
+  Result,
+  Stage,
+} from "@microsoft/teamsfx-api";
+import {
+  AppStudioScopes,
+  assembleError,
+  AuthSvcScopes,
+  isUserCancelError,
+  isValidOfficeAddInProject,
+  teamsDevPortalClient,
+} from "@microsoft/teamsfx-core";
+import * as vscode from "vscode";
 import { Uri } from "vscode";
+import M365TokenInstance from "../commonlib/m365Login";
+import { VS_CODE_UI } from "../qm/vsc_ui";
 import { ExtTelemetry } from "../telemetry/extTelemetry";
 import { TelemetryEvent, TelemetryTriggerFrom } from "../telemetry/extTelemetryEvents";
 import envTreeProviderInstance from "../treeview/environmentTreeViewProvider";
+import { localize } from "../utils/localizeUtils";
 import { getSystemInputs } from "../utils/systemEnvUtils";
 import { getTriggerFromProperty } from "../utils/telemetryUtils";
 import { openFolder, openOfficeDevFolder } from "../utils/workspaceUtils";
@@ -75,3 +94,102 @@ export async function addWebpartHandler(...args: unknown[]) {
   ExtTelemetry.sendTelemetryEvent(TelemetryEvent.AddWebpartStart, getTriggerFromProperty(args));
   return await runCommand(Stage.addWebpart);
 }
+
+/**
+ * scaffold based on app id from Developer Portal
+ */
+export async function scaffoldFromDeveloperPortalHandler(
+  ...args: any[]
+): Promise<Result<null, FxError>> {
+  if (!args || args.length < 1) {
+    // should never happen
+    return ok(null);
+  }
+
+  const appId = args[0];
+  const properties: { [p: string]: string } = {
+    teamsAppId: appId,
+  };
+
+  ExtTelemetry.sendTelemetryEvent(TelemetryEvent.HandleUrlFromDeveloperProtalStart, properties);
+  const loginHint = args.length < 2 ? undefined : args[1];
+  const progressBar = VS_CODE_UI.createProgressBar(
+    localize("teamstoolkit.devPortalIntegration.checkM365Account.progressTitle"),
+    1
+  );
+
+  await progressBar.start();
+  let token = undefined;
+  try {
+    const tokenRes = await M365TokenInstance.signInWhenInitiatedFromTdp(
+      { scopes: AppStudioScopes },
+      loginHint
+    );
+    if (tokenRes.isErr()) {
+      if ((tokenRes.error as any).displayMessage) {
+        void vscode.window.showErrorMessage((tokenRes.error as any).displayMessage);
+      } else {
+        void vscode.window.showErrorMessage(
+          localize("teamstoolkit.devPortalIntegration.generalError.message")
+        );
+      }
+      ExtTelemetry.sendTelemetryErrorEvent(
+        TelemetryEvent.HandleUrlFromDeveloperProtal,
+        tokenRes.error,
+        properties
+      );
+      await progressBar.end(false);
+      return err(tokenRes.error);
+    }
+    token = tokenRes.value;
+
+    // set region
+    const AuthSvcTokenRes = await M365TokenInstance.getAccessToken({ scopes: AuthSvcScopes });
+    if (AuthSvcTokenRes.isOk()) {
+      await teamsDevPortalClient.setRegionEndpointByToken(AuthSvcTokenRes.value);
+    }
+
+    await progressBar.end(true);
+  } catch (e) {
+    void vscode.window.showErrorMessage(
+      localize("teamstoolkit.devPortalIntegration.generalError.message")
+    );
+    await progressBar.end(false);
+    const error = assembleError(e);
+    ExtTelemetry.sendTelemetryErrorEvent(
+      TelemetryEvent.HandleUrlFromDeveloperProtal,
+      error,
+      properties
+    );
+    return err(error);
+  }
+
+  let appDefinition;
+  try {
+    appDefinition = await teamsDevPortalClient.getApp(token, appId);
+  } catch (error: any) {
+    ExtTelemetry.sendTelemetryErrorEvent(
+      TelemetryEvent.HandleUrlFromDeveloperProtal,
+      error,
+      properties
+    );
+    void vscode.window.showErrorMessage(
+      localize("teamstoolkit.devPortalIntegration.getTeamsAppError.message")
+    );
+    return err(error);
+  }
+
+  const res = await createNewProjectHandler({ teamsAppFromTdp: appDefinition });
+
+  if (res.isErr()) {
+    ExtTelemetry.sendTelemetryErrorEvent(
+      TelemetryEvent.HandleUrlFromDeveloperProtal,
+      res.error,
+      properties
+    );
+    return err(res.error);
+  }
+
+  ExtTelemetry.sendTelemetryEvent(TelemetryEvent.HandleUrlFromDeveloperProtal, properties);
+  return ok(null);
+}