Fix a bug where null values in RuntimeConfig cause initialize to fail (…

…#2490) * Handle the case where `null` values in the `RuntimeConfig` from the host SDK will cause an error, ultimately causing `app.initialize` to fail. * Update the `AppEligibilityInformation` interface to match the definition in the host SDK library and add a unit test to validate handling `null` values. * Change file * Update change file --------- Co-authored-by: Erin <[email protected]>
OfficeDev · Aug 30, 2024 · 8377643 · 8377643
1 parent d007a31
commit 8377643
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 1 deletion.
diff --git a/change/@microsoft-teams-js-1257aa2f-91cd-490f-94ba-d9fd85728ddf.json b/change/@microsoft-teams-js-1257aa2f-91cd-490f-94ba-d9fd85728ddf.json
@@ -0,0 +1,7 @@
+{
+  "type": "patch",
+  "comment": "Fixed a bug with `AppEligibilityInformation` that could cause `app.initialize` to fail.",
+  "packageName": "@microsoft/teams-js",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}
diff --git a/packages/teams-js/src/internal/utils.ts b/packages/teams-js/src/internal/utils.ts
@@ -94,6 +94,9 @@ export function generateGUID(): string {
  */
 export function deepFreeze<T extends object>(obj: T): T {
   Object.keys(obj).forEach((prop) => {
+    if (obj[prop] === null || obj[prop] === undefined) {
+      return;
+    }
     if (typeof obj[prop] === 'object') {
       deepFreeze(obj[prop]);
     }

diff --git a/packages/teams-js/src/public/interfaces.ts b/packages/teams-js/src/public/interfaces.ts
@@ -1135,7 +1135,7 @@ export interface AppEligibilityInformation {
   /**
    * Education Eligibility Information for the app user
    */
-  userClassification: UserClassification;
+  userClassification: UserClassification | null;
 }
 
 /**

diff --git a/packages/teams-js/test/private/copilot.spec.ts b/packages/teams-js/test/private/copilot.spec.ts
@@ -18,6 +18,15 @@ const mockedAppEligibilityInformation = {
   },
 };
 
+const mockedAppEligibilityInformationUserClassificationNull = {
+  cohort: Cohort.BCAIS,
+  ageGroup: LegalAgeGroupClassification.Adult,
+  isCopilotEnabledRegion: true,
+  isCopilotEligible: true,
+  isOptedOutByAdmin: false,
+  userClassification: null,
+};
+
 const copilotRuntimeConfig: Runtime = {
   apiVersion: 4,
   hostVersionsInfo: {
@@ -35,6 +44,25 @@ const copilotRuntimeConfig: Runtime = {
     logs: {},
   },
 };
+
+const copilotRuntimeConfigWithUserClassificationNull: Runtime = {
+  apiVersion: 4,
+  hostVersionsInfo: {
+    appEligibilityInformation: mockedAppEligibilityInformationUserClassificationNull,
+  },
+  supports: {
+    pages: {
+      appButton: {},
+      tabs: {},
+      config: {},
+      backStack: {},
+      fullTrust: {},
+    },
+    teamsCore: {},
+    logs: {},
+  },
+};
+
 describe('copilot', () => {
   let utils: Utils;
   beforeEach(() => {
@@ -73,5 +101,11 @@ describe('copilot', () => {
         expect.objectContaining(errorNotSupportedOnPlatform),
       );
     });
+    it('should return null userClassification if the host provided eligibility information with userClassification as null', async () => {
+      await utils.initializeWithContext(FrameContexts.content);
+      utils.setRuntimeConfig(copilotRuntimeConfigWithUserClassificationNull);
+      expect(copilot.eligibility.isSupported()).toBeTruthy();
+      expect(copilot.eligibility.getEligibilityInfo()).toBe(mockedAppEligibilityInformationUserClassificationNull);
+    });
   });
 });