feat: e2e support for multi-tenant (#12642)

* feat: add tenantId parameter in debug launch url * feat: append tenantId parameter in preview launch url * fix: read tenant id from env file instead of state json file * fix: fallback collaborator to display name * fix: only load tenanted account cache when tenant cache exists * test: fix ut * fix: add feature flag * test: fix ut * test: add ut to raise coverage
OfficeDev · Nov 19, 2024 · decc8f6 · decc8f6
1 parent 32231c0
commit decc8f6
Show file tree

Hide file tree

Showing 9 changed files with 126 additions and 37 deletions.
diff --git a/packages/fx-core/src/component/m365/launchHelper.ts b/packages/fx-core/src/component/m365/launchHelper.ts
@@ -21,6 +21,7 @@ import { NotExtendedToM365Error } from "./errors";
 import { PackageService } from "./packageService";
 import { MosServiceEndpoint, MosServiceScope } from "./serviceConstant";
 import { officeBaseUrl, outlookBaseUrl, outlookCopilotAppId } from "./constants";
+import { featureFlagManager, FeatureFlags } from "../../common/featureFlags";
 
 export class LaunchHelper {
   private readonly m365TokenProvider: M365TokenProvider;
@@ -66,6 +67,9 @@ export class LaunchHelper {
         url = new URL(baseUrl);
         const tid = await this.getTidFromToken();
         if (tid) {
+          if (featureFlagManager.getBooleanValue(FeatureFlags.MultiTenant)) {
+            url.searchParams.append("tenantId", tid);
+          }
           url.searchParams.append("appTenantId", tid);
         }
         break;

diff --git a/packages/fx-core/src/component/provisionUtils.ts b/packages/fx-core/src/component/provisionUtils.ts
@@ -142,7 +142,8 @@ class ProvisionUtils {
       return err(new M365TokenJSONNotFoundError());
     }
     const tenantIdInToken = (appStudioTokenJson as any).tid;
-    const tenantUserName = (appStudioTokenJson as any).upn;
+    const tenantUserName =
+      (appStudioTokenJson as any).upn ?? (appStudioTokenJson as any).unique_name;
     if (!tenantIdInToken || !(typeof tenantIdInToken === "string")) {
       return err(new M365TenantIdNotFoundInTokenError());
     }

diff --git a/packages/fx-core/src/core/collaborator.ts b/packages/fx-core/src/core/collaborator.ts
@@ -351,7 +351,10 @@ export async function listCollaborator(
             content: getLocalizedString("core.collaboration.TeamsAppOwner"),
             color: Colors.BRIGHT_WHITE,
           },
-          { content: teamsAppOwner.userPrincipalName, color: Colors.BRIGHT_MAGENTA },
+          {
+            content: teamsAppOwner.userPrincipalName ?? teamsAppOwner.displayName,
+            color: Colors.BRIGHT_MAGENTA,
+          },
           { content: `.\n`, color: Colors.BRIGHT_WHITE }
         );
       }

diff --git a/packages/fx-core/tests/component/m365/launchHelper.test.ts b/packages/fx-core/tests/component/m365/launchHelper.test.ts
@@ -11,17 +11,57 @@ import { PackageService } from "../../../src/component/m365/packageService";
 import { HubTypes } from "../../../src/question";
 import { outlookCopilotAppId } from "../../../src/component/m365/constants";
 import { MockedM365Provider } from "../../core/utils";
+import mockedEnv, { RestoreFn } from "mocked-env";
+import { FeatureFlagName } from "../../../src";
 
 describe("LaunchHelper", () => {
   const m365TokenProvider = new MockedM365Provider();
   const launchHelper = new LaunchHelper(m365TokenProvider);
+  let mockedEnvRestore: RestoreFn = () => {};
 
   afterEach(() => {
     sinon.restore();
+    mockedEnvRestore();
+  });
+
+  beforeEach(() => {
+    mockedEnvRestore = mockedEnv({
+      [FeatureFlagName.MultiTenant]: "true",
+    });
   });
 
   describe("getLaunchUrl", () => {
     it("getLaunchUrl: Teams, signed in", async () => {
+      sinon.stub(m365TokenProvider, "getStatus").resolves(
+        ok({
+          status: "",
+          accountInfo: {
+            tid: "test-tid",
+            upn: "test-upn",
+          },
+        })
+      );
+      const properties: ManifestProperties = {
+        capabilities: ["staticTab"],
+        id: "test-id",
+        version: "1.0.0",
+        manifestVersion: "1.16",
+        isApiME: false,
+        isSPFx: false,
+        isApiMeAAD: false,
+      };
+      const result = await launchHelper.getLaunchUrl(HubTypes.teams, "test-id", properties);
+      chai.assert(result.isOk());
+      chai.assert.equal(
+        (result as any).value,
+        "https://teams.microsoft.com/l/app/test-id?installAppPackage=true&webjoin=true&tenantId=test-tid&appTenantId=test-tid&login_hint=test-upn"
+      );
+    });
+
+    it("getLaunchUrl: Teams, signed in - multi tenant off", async () => {
+      mockedEnvRestore = mockedEnv({
+        [FeatureFlagName.MultiTenant]: "false",
+      });
       sinon.stub(m365TokenProvider, "getStatus").resolves(
         ok({
           status: "",
@@ -71,7 +111,7 @@ describe("LaunchHelper", () => {
       chai.assert(result.isOk());
       chai.assert.equal(
         (result as any).value,
-        "https://teams.microsoft.com/?appTenantId=test-tid&login_hint=test-upn"
+        "https://teams.microsoft.com/?tenantId=test-tid&appTenantId=test-tid&login_hint=test-upn"
       );
     });
 
@@ -98,7 +138,7 @@ describe("LaunchHelper", () => {
       chai.assert(result.isOk());
       chai.assert.equal(
         (result as any).value,
-        "https://teams.microsoft.com/l/app/test-id?installAppPackage=true&webjoin=true&appTenantId=test-tid&login_hint=test-upn"
+        "https://teams.microsoft.com/l/app/test-id?installAppPackage=true&webjoin=true&tenantId=test-tid&appTenantId=test-tid&login_hint=test-upn"
       );
     });
 
@@ -125,7 +165,7 @@ describe("LaunchHelper", () => {
       chai.assert(result.isOk());
       chai.assert.equal(
         (result as any).value,
-        "https://teams.microsoft.com/l/app/test-id?installAppPackage=true&webjoin=true&appTenantId=test-tid&login_hint=test-upn"
+        "https://teams.microsoft.com/l/app/test-id?installAppPackage=true&webjoin=true&tenantId=test-tid&appTenantId=test-tid&login_hint=test-upn"
       );
     });
 
@@ -152,7 +192,7 @@ describe("LaunchHelper", () => {
       chai.assert(result.isOk());
       chai.assert.equal(
         (result as any).value,
-        "https://teams.microsoft.com/l/app/test-id?installAppPackage=true&webjoin=true&appTenantId=test-tid&login_hint=test-upn"
+        "https://teams.microsoft.com/l/app/test-id?installAppPackage=true&webjoin=true&tenantId=test-tid&appTenantId=test-tid&login_hint=test-upn"
       );
     });
 

diff --git a/packages/fx-core/tests/component/provisionUtils.test.ts b/packages/fx-core/tests/component/provisionUtils.test.ts
@@ -474,6 +474,36 @@ describe("provisionUtils", () => {
         chai.assert.isTrue(res.error instanceof M365TenantIdNotFoundInTokenError);
       }
     });
+
+    it("happy pass - upn", async () => {
+      mocker.stub(tools.tokenProvider.m365TokenProvider, "getAccessToken").resolves(ok(""));
+      mocker
+        .stub(tools.tokenProvider.m365TokenProvider, "getJsonObject")
+        .resolves(ok({ tid: "faked id", upn: "faked upn" }));
+      const res = await provisionUtils.getM365TenantId(tools.tokenProvider.m365TokenProvider);
+      chai.assert.isTrue(res.isOk());
+      if (res.isOk()) {
+        chai.assert.deepEqual(res.value, {
+          tenantIdInToken: "faked id",
+          tenantUserName: "faked upn",
+        });
+      }
+    });
+
+    it("happy pass - unique_name", async () => {
+      mocker.stub(tools.tokenProvider.m365TokenProvider, "getAccessToken").resolves(ok(""));
+      mocker
+        .stub(tools.tokenProvider.m365TokenProvider, "getJsonObject")
+        .resolves(ok({ tid: "faked id", unique_name: "faked unique name" }));
+      const res = await provisionUtils.getM365TenantId(tools.tokenProvider.m365TokenProvider);
+      chai.assert.isTrue(res.isOk());
+      if (res.isOk()) {
+        chai.assert.deepEqual(res.value, {
+          tenantIdInToken: "faked id",
+          tenantUserName: "faked unique name",
+        });
+      }
+    });
   });
   describe("arm", () => {
     let mockedEnvRestore: RestoreFn | undefined;

diff --git a/packages/vscode-extension/src/commonlib/codeFlowLogin.ts b/packages/vscode-extension/src/commonlib/codeFlowLogin.ts
@@ -92,6 +92,14 @@ export class CodeFlowLogin {
         this.account = dataCache;
         this.status = loggedIn;
       }
+
+      if (featureFlagManager.getBooleanValue(FeatureFlags.MultiTenant)) {
+        const tenantCache = await loadTenantId(this.accountName);
+        if (tenantCache) {
+          const allAccounts = await this.msalTokenCache.getAllAccounts();
+          this.account = allAccounts.find((account) => account.tenantId == tenantCache);
+        }
+      }
     } else if (this.status !== loggingIn) {
       this.account = undefined;
       this.status = loggedOut;
@@ -392,11 +400,12 @@ export class CodeFlowLogin {
       if (tenantId) {
         const allAccounts = await this.msalTokenCache.getAllAccounts();
         tenantedAccount = allAccounts.find((account) => account.tenantId == tenantId);
+        this.account = tenantedAccount ?? this.account;
       }
 
       try {
         const res = await this.pca.acquireTokenSilent({
-          account: tenantedAccount ? tenantedAccount : this.account,
+          account: this.account,
           scopes: scopes,
           forceRefresh: tenantedAccount ? false : true,
           authority: tenantId ? BASE_AUTHORITY + tenantId : this.config.auth.authority,

diff --git a/packages/vscode-extension/src/debug/teamsfxDebugProvider.ts b/packages/vscode-extension/src/debug/teamsfxDebugProvider.ts
@@ -9,6 +9,8 @@ import {
   Correlator,
   environmentNameManager,
   envUtil,
+  featureFlagManager,
+  FeatureFlags,
   Hub,
   isValidProject,
   isValidProjectV3,
@@ -223,7 +225,13 @@ async function generateAccountHint(includeTenantId = true): Promise<string> {
     }
   }
   if (includeTenantId && tenantId) {
-    return loginHint ? `appTenantId=${tenantId}&login_hint=${loginHint}` : "";
+    if (featureFlagManager.getBooleanValue(FeatureFlags.MultiTenant)) {
+      return loginHint
+        ? `tenantId=${tenantId}&appTenantId=${tenantId}&login_hint=${loginHint}`
+        : "";
+    } else {
+      return loginHint ? `appTenantId=${tenantId}&login_hint=${loginHint}` : "";
+    }
   } else {
     return loginHint ? `login_hint=${loginHint}` : "";
   }

diff --git a/packages/vscode-extension/src/utils/envTreeUtils.ts b/packages/vscode-extension/src/utils/envTreeUtils.ts
@@ -5,6 +5,9 @@ import { SubscriptionInfo } from "@microsoft/teamsfx-api";
 import { getProvisionResultJson } from "./fileSystemUtils";
 import { workspaceUri } from "../globalVariables";
 import { getV3TeamsAppId } from "./appDefinitionUtils";
+import path from "path";
+import fs from "fs-extra";
+import { dotenvUtil } from "@microsoft/teamsfx-core/build/component/utils/envUtil";
 
 export async function getSubscriptionInfoFromEnv(
   env: string
@@ -34,20 +37,13 @@ export async function getSubscriptionInfoFromEnv(
 }
 
 export async function getM365TenantFromEnv(env: string): Promise<string | undefined> {
-  let provisionResult: Record<string, any> | undefined;
-
-  try {
-    provisionResult = await getProvisionResultJson(env);
-  } catch (error) {
-    // ignore error on tree view when load provision result failed.
-    return undefined;
-  }
-
-  if (!provisionResult) {
-    return undefined;
+  const projectPath = workspaceUri!.fsPath;
+  const envFile = path.resolve(projectPath, "env", `.env.${env}`);
+  if (await fs.pathExists(envFile)) {
+    const envData = dotenvUtil.deserialize(fs.readFileSync(envFile, "utf-8"));
+    return envData.obj["TEAMS_APP_TENANT_ID"];
   }
-
-  return provisionResult.solution?.teamsAppTenantId;
+  return undefined;
 }
 
 export async function getResourceGroupNameFromEnv(env: string): Promise<string | undefined> {

diff --git a/packages/vscode-extension/test/utils/envTreeUtils.test.ts b/packages/vscode-extension/test/utils/envTreeUtils.test.ts
@@ -1,5 +1,6 @@
 import * as chai from "chai";
 import * as sinon from "sinon";
+import fs from "fs-extra";
 import * as globalVariables from "../../src/globalVariables";
 import { Uri } from "vscode";
 import { envUtil, metadataUtil, pathUtils } from "@microsoft/teamsfx-core";
@@ -54,36 +55,33 @@ describe("EnvTreeUtils", () => {
     const m365TenantId = {
       teamsAppTenantId: "fakeTenantId",
     };
-    const provisionResult: Record<string, any> = {
-      solution: m365TenantId,
-    };
+
+    beforeEach(() => {
+      sandbox.stub(globalVariables, "workspaceUri").value({ fsPath: "/test" });
+    });
 
     afterEach(() => {
       sandbox.restore();
     });
 
     it("returns m365 tenantId successfully", async () => {
-      sandbox.stub(fileSystemUtils, "getProvisionResultJson").resolves(provisionResult);
+      sandbox.stub(fs, "pathExists").resolves(true);
+      sandbox.stub(fs, "readFileSync").returns("TEAMS_APP_TENANT_ID=fakeTenantId\n");
       const result = await envTreeUtils.getM365TenantFromEnv("test");
       chai.expect(result).equal("fakeTenantId");
     });
 
-    it("returns undefined if get provision result throws error", async () => {
-      sandbox.stub(fileSystemUtils, "getProvisionResultJson").rejects(new Error());
+    it("returns undefined if env file doesn't exist", async () => {
+      sandbox.stub(fs, "pathExists").resolves(false);
       const result = await envTreeUtils.getM365TenantFromEnv("test");
-      chai.expect(result).is.undefined;
+      chai.expect(result).equal(undefined);
     });
 
-    it("returns undefined if get provision result returns undefined", async () => {
-      sandbox.stub(fileSystemUtils, "getProvisionResultJson").resolves(undefined);
-      const result = await envTreeUtils.getM365TenantFromEnv("test");
-      chai.expect(result).is.undefined;
-    });
-
-    it("returns undefined if get provision result does not contain solution", async () => {
-      sandbox.stub(fileSystemUtils, "getProvisionResultJson").resolves({});
+    it("returns undefined if tenant id doesn't exist in env file", async () => {
+      sandbox.stub(fs, "pathExists").resolves(true);
+      sandbox.stub(fs, "readFileSync").returns("");
       const result = await envTreeUtils.getM365TenantFromEnv("test");
-      chai.expect(result).is.undefined;
+      chai.expect(result).equal(undefined);
     });
   });