🐛 individually add copilot teams (#77)

* This prevents overflow issues due to large amounts of copilot teams
while also allowing the overall call to succeed when one team in the
batch is bad.
* This change is being made after new failures were found where 1 team
with no members would cause the entire batch of additions to fail.

Author: JoshuaTheMiller

src/services/gitHub.ts

@@ -1,7 +1,7 @@
 import { Octokit } from "octokit";
 import { createAppAuth } from "@octokit/auth-app";
 import { Config } from "../config";
-import { AddMemberResponse, GitHubClient, GitHubId, GitHubTeamId, InstalledClient, Org, OrgInvite, OrgRoles, RemoveMemberResponse, Response } from "./gitHubTypes";
+import { AddMemberResponse, CopilotAddResponse, GitHubClient, GitHubId, GitHubTeamId, InstalledClient, Org, OrgInvite, OrgRoles, RemoveMemberResponse, Response } from "./gitHubTypes";
 import { AppConfig } from "./appConfig";
 import yaml from "js-yaml";
 import { throttling } from "@octokit/plugin-throttling";
@@ -230,7 +230,7 @@ class InstalledGitHubClient implements InstalledClient {
         this.orgName = orgName;
     }
 
-    async AddTeamsToCopilotSubscription(teamNames: string[]): Response<string[]> {
+    async AddTeamsToCopilotSubscription(teamNames: string[]): Response<CopilotAddResponse[]> {
         // Such logic should not generally go in a facade, though the convenience
         // and lack of actual problems makes this violation of pattern more "okay."
         if (teamNames.length < 1) {
@@ -241,33 +241,45 @@ class InstalledGitHubClient implements InstalledClient {
             }
         }
 
-        try {
-            const response = await this.gitHubClient.request("POST /orgs/{org}/copilot/billing/selected_teams", {
-                org: this.orgName,
-                selected_teams: teamNames,
-                headers: {
-                    'X-GitHub-Api-Version': '2022-11-28'
-                }
-            });
-
-            if (response.status < 200 || response.status > 299) {
-                return {
-                    successful: false
+        const responses: CopilotAddResponse[] = [];
+
+        for (const team of teamNames) {
+            try {
+                const response = await this.gitHubClient.request("POST /orgs/{org}/copilot/billing/selected_teams", {
+                    org: this.orgName,
+                    selected_teams: [team],
+                    headers: {
+                        'X-GitHub-Api-Version': '2022-11-28'
+                    }
+                });
+        
+                if (response.status < 200 || response.status > 299) {
+                    responses.push({
+                        successful: false,
+                        team: team,
+                        message: response.status.toString()
+                    });
                 }
-            }
 
-            return {
-                successful: true,
-                data: teamNames
+                responses.push({
+                    successful: true,
+                    team: team
+                });
             }
-        }
-        catch (e) {
-            console.log(e);
-            // TODO: actually catch exception and investigate...            
-            return {
-                successful: false
+            catch (e) {
+                console.log(e);                                
+                responses.push({
+                    successful: false,
+                    team: team,
+                    message: JSON.stringify(e)
+                });
             }
         }
+        
+        return {
+            successful: true,
+            data: responses
+        };
     }
 
     async ListPendingInvitesForTeam(teamName: string): Response<OrgInvite[]> {

src/services/gitHubCache.ts

@@ -1,6 +1,6 @@
 import { CacheClient } from "../app";
 import { ILogger } from "../logging";
-import { AddMemberResponse, GitHubId, GitHubTeamId, InstalledClient, OrgInvite, OrgRoles, RemoveMemberResponse, Response } from "./gitHubTypes";
+import { AddMemberResponse, CopilotAddResponse, GitHubId, GitHubTeamId, InstalledClient, OrgInvite, OrgRoles, RemoveMemberResponse, Response } from "./gitHubTypes";
 import { OrgConfig } from "./orgConfig";
 
 export class GitHubClientCache implements InstalledClient {
@@ -13,7 +13,7 @@ export class GitHubClientCache implements InstalledClient {
         this.cacheClient = cacheClient;
         this.logger = logger;
     }
-    AddTeamsToCopilotSubscription(teamNames: string[]): Response<string[]> {
+    AddTeamsToCopilotSubscription(teamNames: string[]): Response<CopilotAddResponse[]> {
         return this.client.AddTeamsToCopilotSubscription(teamNames);
     }
 

src/services/gitHubTypes.ts

@@ -38,7 +38,20 @@ export interface InstalledClient {
     GetPendingOrgInvites():Response<OrgInvite[]>
     CancelOrgInvite(invite:OrgInvite): Response    
     ListPendingInvitesForTeam(teamName: GitHubTeamName):Response<OrgInvite[]>
-    AddTeamsToCopilotSubscription(teamNames: GitHubTeamName[]):Response<string[]>
+    AddTeamsToCopilotSubscription(teamNames: GitHubTeamName[]):Response<CopilotAddResponse[]>
+}
+
+export type CopilotAddResponse = CopilotAddSucceeded | CopilotAddFailed
+
+export type CopilotAddSucceeded = {
+    successful: true,
+    team: GitHubTeamName
+}
+
+export type CopilotAddFailed = {
+    successful: false,
+    message: string,
+    team: GitHubTeamName
 }
 
 export type AddMemberResponse = Promise<AddMemberSucceeded | AddMemberFailed>

src/services/githubSync.ts

@@ -2,7 +2,7 @@
 
 import { Log, LogError } from "../logging";
 import { AppConfig } from "./appConfig";
-import { FailedResponse, GitHubId, InstalledClient, OrgInvite } from "./gitHubTypes";
+import { CopilotAddResponse, FailedResponse, GitHubId, InstalledClient, OrgInvite } from "./gitHubTypes";
 import { IGitHubInvitations } from "./githubInvitations";
 import { SearchAllAsync } from "./ldapClient";
 import { OrgConfig } from "./orgConfig";
@@ -164,7 +164,7 @@ type ReturnTypeOfSyncOrg = {
     syncedSecurityManagerTeams: string[];
     orgOwnersGroup: string;
     ignoredTeams: string[];
-    copilotTeams: string[];
+    copilotTeams: CopilotAddResponse[];
 }
 
 type FailedSecSync = {
@@ -230,7 +230,7 @@ async function syncOrg(installedGitHubClient: InstalledClient, appConfig: AppCon
         syncedSecurityManagerTeams: [] as string[],
         orgOwnersGroup: "",
         ignoredTeams: [] as string[],
-        copilotTeams: [] as string[]
+        copilotTeams: [] as CopilotAddResponse[]
     }
 
     // TODO: add this back once these APIs make sense