Added force refresh parameter to get eligbility info API. (#2784)

* Added force refresh parameter to get eligbility info API.

* Add unit testing with new argument.

* Add input to get eligibility info test app.

---------

Co-authored-by: Jeff Klouda <[email protected]>

Author: juanscr

change/@microsoft-teams-js-3bf442f2-393a-43fd-9d52-d09851ea25d4.json

@@ -0,0 +1,7 @@
+{
+  "type": "minor",
+  "comment": "Added `forceRefresh` optional argument in `getEligibilityInfo` API.",
+  "packageName": "@microsoft/teams-js",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}

packages/teams-js/src/private/copilot/eligibility.ts

@@ -34,22 +34,24 @@ export function isSupported(): boolean {
 }
 
 /**
+ *
+ * @param forceRefresh - boolean to represent whether to force refresh the eligibility information
+ * @returns the copilot eligibility information about the user
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ *
  * @hidden
  * @internal
  * Limited to Microsoft-internal use
  * @beta
- * @returns the copilot eligibility information about the user
- *
- * @throws Error if {@linkcode app.initialize} has not successfully completed
  */
-export async function getEligibilityInfo(): Promise<AppEligibilityInformation> {
+export async function getEligibilityInfo(forceRefresh?: boolean): Promise<AppEligibilityInformation> {
   ensureInitialized(runtime);
   if (!isSupported()) {
     throw new Error(`Error code: ${errorNotSupportedOnPlatform.errorCode}, message: Not supported on platform`);
   }
 
   // Return the eligibility information if it is already available
-  if (runtime.hostVersionsInfo?.appEligibilityInformation) {
+  if (runtime.hostVersionsInfo?.appEligibilityInformation && !forceRefresh) {
     copilotLogger('Eligibility information is already available on runtime.');
     return runtime.hostVersionsInfo!.appEligibilityInformation;
   }
@@ -59,6 +61,7 @@ export async function getEligibilityInfo(): Promise<AppEligibilityInformation> {
   const response = await sendAndUnwrap<AppEligibilityInformation | SdkError>(
     getApiVersionTag(copilotTelemetryVersionNumber, ApiName.Copilot_Eligibility_GetEligibilityInfo),
     ApiName.Copilot_Eligibility_GetEligibilityInfo,
+    forceRefresh,
   );
 
   if (isSdkError(response)) {

packages/teams-js/test/private/copilot.spec.ts

@@ -192,6 +192,33 @@ describe('copilot', () => {
           return expect(promise).resolves.toEqual(mockedAppEligibilityInformation);
         });
 
+        it(`should pass forceRefresh parameter if it exists - with context ${frameContext}`, async () => {
+          expect.assertions(1);
+          await utils.initializeWithContext(frameContext);
+          utils.setRuntimeConfig(copilotRuntimeConfig);
+          copilot.eligibility.getEligibilityInfo(true);
+          const message = utils.findMessageByActionName('copilot.eligibility.getEligibilityInfo');
+          expect(message.args?.[0]).toBe(true);
+        });
+
+        it(`should pass forceRefresh parameter if it exists - with context ${frameContext}`, async () => {
+          expect.assertions(1);
+          await utils.initializeWithContext(frameContext);
+          utils.setRuntimeConfig(copilotRuntimeConfig);
+          copilot.eligibility.getEligibilityInfo(false);
+          const message = utils.findMessageByActionName('copilot.eligibility.getEligibilityInfo');
+          expect(message.args?.[0]).toBe(false);
+        });
+
+        it(`should default forceRefresh parameter to false if not passed - with context ${frameContext}`, async () => {
+          expect.assertions(1);
+          await utils.initializeWithContext(frameContext);
+          utils.setRuntimeConfig(copilotRuntimeConfig);
+          copilot.eligibility.getEligibilityInfo();
+          const message = utils.findMessageByActionName('copilot.eligibility.getEligibilityInfo');
+          expect(message.args?.[0]).toBe(undefined);
+        });
+
         it(`should not throw if featureSet in response is undefined - with context ${frameContext}`, async () => {
           await utils.initializeWithContext(frameContext);
           utils.setRuntimeConfig(copilotRuntimeConfig);