feat: enable copilot access check (#10265)

OfficeDev · Nov 3, 2023 · a86c4a4 · a86c4a4
1 parent ec81da7
commit a86c4a4
Show file tree

Hide file tree

Showing 6 changed files with 60 additions and 11 deletions.
diff --git a/packages/fx-core/src/common/m365/packageService.ts b/packages/fx-core/src/common/m365/packageService.ts
@@ -342,7 +342,8 @@ export class PackageService {
     try {
       const serviceUrl = await this.getTitleServiceUrl(token);
       this.logger?.debug(`Get active experiences from service URL ${serviceUrl} ...`);
-      const response = await this.axiosInstance.get("/catalog/v1/users/experiences", {
+      // users/experiences is deprecating, using users/uitypes instead
+      const response = await this.axiosInstance.get("/catalog/v1/users/uitypes", {
         baseURL: serviceUrl,
         headers: {
           Authorization: `Bearer ${token}`,

diff --git a/packages/fx-core/tests/common/m365/packageService.test.ts b/packages/fx-core/tests/common/m365/packageService.test.ts
@@ -793,7 +793,7 @@ describe("Package Service", () => {
         titlesServiceUrl: "https://test-url",
       },
     };
-    axiosGetResponses["/catalog/v1/users/experiences"] = {
+    axiosGetResponses["/catalog/v1/users/uitypes"] = {
       data: {
         activeExperiences: ["foo", "bar"],
       },
@@ -829,7 +829,7 @@ describe("Package Service", () => {
         titlesServiceUrl: "https://test-url",
       },
     };
-    axiosGetResponses["/catalog/v1/users/experiences"] = new Error("test-get");
+    axiosGetResponses["/catalog/v1/users/uitypes"] = new Error("test-get");
 
     const packageService = new PackageService("https://test-endpoint");
     let actualError: Error | undefined;
@@ -853,7 +853,7 @@ describe("Package Service", () => {
     expectedError.response = {
       data: {},
     };
-    axiosGetResponses["/catalog/v1/users/experiences"] = expectedError;
+    axiosGetResponses["/catalog/v1/users/uitypes"] = expectedError;
 
     let packageService = new PackageService("https://test-endpoint");
     let actualError: Error | undefined;
@@ -884,7 +884,7 @@ describe("Package Service", () => {
         titlesServiceUrl: "https://test-url",
       },
     };
-    axiosGetResponses["/catalog/v1/users/experiences"] = {
+    axiosGetResponses["/catalog/v1/users/uitypes"] = {
       data: {
         activeExperiences: ["foo", "bar"],
       },
@@ -909,7 +909,7 @@ describe("Package Service", () => {
         titlesServiceUrl: "https://test-url",
       },
     };
-    axiosGetResponses["/catalog/v1/users/experiences"] = {
+    axiosGetResponses["/catalog/v1/users/uitypes"] = {
       foo: "bar",
     };
 
@@ -932,7 +932,7 @@ describe("Package Service", () => {
         titlesServiceUrl: "https://test-url",
       },
     };
-    axiosGetResponses["/catalog/v1/users/experiences"] = new Error("test-get");
+    axiosGetResponses["/catalog/v1/users/uitypes"] = new Error("test-get");
 
     let packageService = new PackageService("https://test-endpoint");
     let actualError: Error | undefined;

diff --git a/templates/js/message-extension-copilot/.vscode/launch.json b/templates/js/message-extension-copilot/.vscode/launch.json
@@ -223,7 +223,7 @@
                 "Launch App in Copilot (Edge)",
                 "Attach to Local Service"
             ],
-            "preLaunchTask": "Start Teams App Locally",
+            "preLaunchTask": "Start Teams App Locally (Copilot)",
             "presentation": {
                 "group": "group 2: Copilot",
                 "order": 1
@@ -236,7 +236,7 @@
                 "Launch App in Copilot (Chrome)",
                 "Attach to Local Service"
             ],
-            "preLaunchTask": "Start Teams App Locally",
+            "preLaunchTask": "Start Teams App Locally (Copilot)",
             "presentation": {
                 "group": "group 2: Copilot",
                 "order": 2

diff --git a/templates/js/message-extension-copilot/.vscode/tasks.json b/templates/js/message-extension-copilot/.vscode/tasks.json
@@ -15,6 +15,18 @@
             ],
             "dependsOrder": "sequence"
         },
+        {
+            "label": "Start Teams App Locally (Copilot)",
+            "dependsOn": [
+                "Validate prerequisites",
+                "Validate Copilot access",
+                "Start local tunnel",
+                "Provision",
+                "Deploy",
+                "Start application"
+            ],
+            "dependsOrder": "sequence"
+        },
         {
             // Check all required prerequisites.
             // See https://aka.ms/teamsfx-tasks/check-prerequisites to know the details and how to customize the args.
@@ -33,6 +45,18 @@
                 ]
             }
         },
+        {
+            // Check Copilot access.
+            // See https://aka.ms/teamsfx-tasks/check-prerequisites to know the details and how to customize the args.
+            "label": "Validate Copilot access",
+            "type": "teamsfx",
+            "command": "debug-check-prerequisites",
+            "args": {
+                "prerequisites": [
+                    "copilotAccess" // Validate if the account has Copilot access.
+                ]
+            }
+        },
         {
             // Start the local tunnel service to forward public URL to local port and inspect traffic.
             // See https://aka.ms/teamsfx-tasks/local-tunnel for the detailed args definitions.

diff --git a/templates/ts/message-extension-copilot/.vscode/launch.json b/templates/ts/message-extension-copilot/.vscode/launch.json
@@ -223,7 +223,7 @@
                 "Launch App in Copilot (Edge)",
                 "Attach to Local Service"
             ],
-            "preLaunchTask": "Start Teams App Locally",
+            "preLaunchTask": "Start Teams App Locally (Copilot)",
             "presentation": {
                 "group": "group 2: Copilot",
                 "order": 1
@@ -236,7 +236,7 @@
                 "Launch App in Copilot (Chrome)",
                 "Attach to Local Service"
             ],
-            "preLaunchTask": "Start Teams App Locally",
+            "preLaunchTask": "Start Teams App Locally (Copilot)",
             "presentation": {
                 "group": "group 2: Copilot",
                 "order": 2

diff --git a/templates/ts/message-extension-copilot/.vscode/tasks.json b/templates/ts/message-extension-copilot/.vscode/tasks.json
@@ -15,6 +15,18 @@
             ],
             "dependsOrder": "sequence"
         },
+        {
+            "label": "Start Teams App Locally (Copilot)",
+            "dependsOn": [
+                "Validate prerequisites",
+                "Validate Copilot access",
+                "Start local tunnel",
+                "Provision",
+                "Deploy",
+                "Start application"
+            ],
+            "dependsOrder": "sequence"
+        },
         {
             // Check all required prerequisites.
             // See https://aka.ms/teamsfx-tasks/check-prerequisites to know the details and how to customize the args.
@@ -33,6 +45,18 @@
                 ]
             }
         },
+        {
+            // Check Copilot access.
+            // See https://aka.ms/teamsfx-tasks/check-prerequisites to know the details and how to customize the args.
+            "label": "Validate Copilot access",
+            "type": "teamsfx",
+            "command": "debug-check-prerequisites",
+            "args": {
+                "prerequisites": [
+                    "copilotAccess" // Validate if the account has Copilot access.
+                ]
+            }
+        },
         {
             // Start the local tunnel service to forward public URL to local port and inspect traffic.
             // See https://aka.ms/teamsfx-tasks/local-tunnel for the detailed args definitions.