💡 Manage Copilot Licenses (#62)

This PR closes
#53

At the moment, merging is blocked due to the necessary API not
functioning... Or, at least my inability to use it properly (though I
did follow the docs).

Author: JoshuaTheMiller

docs/OrganizationConfiguration.md

@@ -36,4 +36,7 @@ Teams:
 - Name: Some_Team
 - Name: Some_Team_2
   DisplayName: Some Team 2
+  # An optional property that adds the given team to the list of those Copilot licenses are 
+  # granted to.
+  CopilotEnabled: true
 ```

src/services/gitHub.ts

@@ -4,7 +4,7 @@ import { Config } from "../config";
 import { GitHubClient, GitHubId, GitHubTeamId, InstalledClient, Org, OrgInvite, OrgRoles, Response } from "./gitHubTypes";
 import { AppConfig } from "./appConfig";
 import yaml from "js-yaml";
-import { throttling  } from "@octokit/plugin-throttling";
+import { throttling } from "@octokit/plugin-throttling";
 import { AsyncReturnType } from "../utility";
 import { Log, LoggerToUse } from "../logging";
 import { GitHubClientCache } from "./gitHubCache";
@@ -36,7 +36,7 @@ async function GetOrgClient(installationId: number): Promise<InstalledClient> {
     // TODO: look further into this... it seems like it would be best if 
     // installation client was generated from the original client, and not
     // created fresh.    
-    const MyOctokit = Octokit.plugin(throttling);           
+    const MyOctokit = Octokit.plugin(throttling);
 
     const installedOctokit = new MyOctokit({
         authStrategy: createAppAuth,
@@ -45,7 +45,7 @@ async function GetOrgClient(installationId: number): Promise<InstalledClient> {
             privateKey: Config().GitHub.PrivateKey,
             installationId
         },
-        throttle: {            
+        throttle: {
             onRateLimit: (retryAfter, options, octokit, retryCount) => {
                 octokit.log.warn(
                     `Request quota exhausted for request ${options.method} ${options.url}`
@@ -56,7 +56,7 @@ async function GetOrgClient(installationId: number): Promise<InstalledClient> {
                     octokit.log.info(`Retrying after ${retryAfter} seconds!`);
                     return true;
                 }
-            },            
+            },
             onSecondaryRateLimit: (retryAfter, options, octokit) => {
                 // does not retry, only logs a warning
                 octokit.log.warn(
@@ -74,7 +74,7 @@ async function GetOrgClient(installationId: number): Promise<InstalledClient> {
         // TODO: keep an eye on this as there is a good 
         // chance login will be removed considering it
         // is already not present on the type...
-        login:string
+        login: string
     }
 
     // HACK: gross typing nonsense
@@ -192,18 +192,18 @@ async function GetAppConfig(client: Octokit): Promise<AppConfig> {
     }
 
     type RawAppConfig = {
-        GitHubIdAppend?:string
-        SecurityManagerTeams?:string[]
+        GitHubIdAppend?: string
+        SecurityManagerTeams?: string[]
         Description?: {
             ShortLink: string
         }
-        TeamsToIgnore?:string[]
+        TeamsToIgnore?: string[]
     }
 
     const configuration = yaml.load(Buffer.from(contentData.content, 'base64').toString()) as RawAppConfig;
 
     return {
-        Description: configuration.Description ?? {ShortLink:"https://github.com/cloudpups/github-teams-user-sync"},
+        Description: configuration.Description ?? { ShortLink: "https://github.com/cloudpups/github-teams-user-sync" },
         SecurityManagerTeams: configuration.SecurityManagerTeams ?? [],
         TeamsToIgnore: configuration.TeamsToIgnore ?? [],
         GitHubIdAppend: configuration.GitHubIdAppend ?? ""
@@ -230,6 +230,46 @@ class InstalledGitHubClient implements InstalledClient {
         this.orgName = orgName;
     }
 
+    async AddTeamsToCopilotSubscription(teamNames: string[]): Response<string[]> {   
+        // 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) {
+            return {
+                // Should be "no op"
+                successful: true,
+                data: []
+            } 
+        }
+
+        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
+                }
+            }
+    
+            return {
+                successful: true,
+                data: teamNames
+            }
+        }
+        catch(e) {
+            console.log(e);
+            // TODO: actually catch exception and investigate...            
+            return {
+                successful: false
+            }
+        }
+    }
+
     async ListPendingInvitesForTeam(teamName: string): Response<OrgInvite[]> {
         const safeName = MakeTeamNameSafeAndApiFriendly(teamName);
 

src/services/gitHubCache.ts

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

src/services/gitHubTypes.ts

@@ -1,5 +1,5 @@
 import { AppConfig } from "./appConfig"
-import { GitHubTeamName, OrgConfig, OrgConfigurationOptions } from "./orgConfig"
+import { GitHubTeamName, OrgConfig } from "./orgConfig"
 
 export interface Org {
     id: number,
@@ -38,6 +38,7 @@ export interface InstalledClient {
     GetPendingOrgInvites():Response<OrgInvite[]>
     CancelOrgInvite(invite:OrgInvite): Response    
     ListPendingInvitesForTeam(teamName: GitHubTeamName):Response<OrgInvite[]>
+    AddTeamsToCopilotSubscription(teamNames: GitHubTeamName[]):Response<string[]>
 }
 
 

src/services/githubSync.ts

@@ -216,6 +216,7 @@ type ReturnTypeOfSyncOrg = {
     syncedSecurityManagerTeams: string[];
     orgOwnersGroup: string;
     ignoredTeams: string[];
+    copilotTeams: string[];
 }
 
 type FailedSecSync = {
@@ -280,7 +281,8 @@ async function syncOrg(installedGitHubClient: InstalledClient, appConfig: AppCon
         status: "failed",
         syncedSecurityManagerTeams: [] as string[],
         orgOwnersGroup: "",
-        ignoredTeams: [] as string[]
+        ignoredTeams: [] as string[],
+        copilotTeams: [] as string[]
     }
 
     // TODO: add this back once these APIs make sense
@@ -434,9 +436,12 @@ async function syncOrg(installedGitHubClient: InstalledClient, appConfig: AppCon
         }
     }
 
+    const copilotResult = await installedGitHubClient.AddTeamsToCopilotSubscription(orgConfig.CopilotTeams);
+
     return {
         ...response,
-        status: "completed"
+        status: "completed",
+        copilotTeams: copilotResult.successful ? copilotResult.data : []
     }
 }
 
@@ -480,7 +485,8 @@ export async function SyncOrg(installedGitHubClient: InstalledClient, config: Ap
             status: "failed",
             syncedSecurityManagerTeams: [],
             orgOwnersGroup: "",
-            ignoredTeams: []
+            ignoredTeams: [],
+            copilotTeams: []
         }
 
         Log(JSON.stringify(

src/services/orgConfig.ts

@@ -3,6 +3,7 @@ export type GitHubTeamName = string;
 export type ManagedGitHubTeam = {
     Name: GitHubTeamName,
     DisplayName?: string
+    CopilotEnabled?: boolean
 }
 
 export type OrgConfigurationOptions = {
@@ -21,6 +22,7 @@ export class OrgConfig {
     public OrgMembersGroupName: string | undefined;
     public TeamsToManage: string[];
     public DisplayNameToSourceMap: Map<string,string>;
+    public CopilotTeams: string[];
 
     constructor(options: OrgConfigurationOptions) {
         this.options = options;
@@ -29,6 +31,11 @@ export class OrgConfig {
         this.TeamsToManage = this.GetTeams();
         this.DisplayNameToSourceMap = this.GetSourceTeamMap();
         this.AdditionalSecurityManagerGroups = this.GetAdditionalSecurityManagerGroupNames();
+        this.CopilotTeams = this.GetCopilotTeams();
+    }
+    
+    private GetCopilotTeams(): string[] {
+        return this.options.Teams?.filter(t => t.CopilotEnabled == true).map(t => t.DisplayName ?? t.Name) ?? [];
     }
 
     private GetAdditionalSecurityManagerGroupNames(): string[] {