💡 Expose endpoint for syncing specific team

Author: JoshuaTheMiller

src/handlers/syncSpecificTeamHandler.ts

@@ -0,0 +1,45 @@
+import { Context } from "openapi-backend";
+import type { Request, Response } from "express";
+import { GetClient } from "../services/gitHub";
+import { SyncOrg, SyncTeam } from "../services/githubSync";
+import { AsyncReturnType } from "../utility";
+import axios from 'axios';
+
+async function forwardToProxy(installationId: number) {    
+    console.log(`Forwarding request to '${process.env.GITHUB_PROXY}'`);
+    const requestUrl = `${process.env.GITHUB_PROXY}/api/sync/SynchronizeOrg?installationId=${installationId}`    
+
+    const result = await axios.post(requestUrl);
+
+    if(result.status >= 200 && result.status < 300) {
+        return result.data;
+    }
+
+    return {
+        status: "failed",
+        installationId: installationId
+    }
+}
+
+export async function syncSpecificTeamHandler(
+    c: Context,
+    _req: Request,
+    res: Response
+) {    
+    const orgId = c.request.query.orgId! as unknown as number;
+    const teamName = c.request.query.teamName! as unknown as string;
+
+    const client = GetClient();
+    const orgClient = await client.GetOrgClient(orgId);
+    const appConfig = await client.GetAppConfig();
+
+    // const existingOrgMembers = await orgClient.GetOrgMembers();
+
+    // if(!existingOrgMembers.successful) {
+    //     return res.status(500).json("Unable to fetch org members");    
+    // }
+
+    const response = await SyncTeam(teamName, orgClient, appConfig);
+
+    return res.status(200).json(response);
+}

src/openapi.yaml

@@ -66,6 +66,28 @@ paths:
       responses:
         "200":
           description: A successful response
+  /api/sync/SynchronizeSpecificTeam:
+    post:
+      operationId: syncSpecificTeam
+      description: Triggers a synchronization job for all orgs. **Note**, at this point in time, this endpoint will NOT check org membership first.
+      tags:
+        - sync
+      parameters:
+        - in: query
+          name: orgId
+          description: This value can be retrieved from the `/metadata/getInstalledOrgs` endpoint
+          schema:
+            type: number                          
+          required: true
+        - in: query
+          name: teamName
+          description: The name of the team to synchronize
+          schema:
+            type: string                          
+          required: true
+      responses:
+        "200":
+          description: A successful response
   /api/get-source-team:
     get:
       operationId: getSourceTeam

src/routes.ts

@@ -3,6 +3,7 @@ import { getInstalledOrgsHandler } from "./handlers/getInstalledOrgs";
 import { getSourceTeamHandler } from "./handlers/getSourceTeam";
 import { syncAllHandler } from "./handlers/syncAll";
 import { syncOrgHandler } from "./handlers/syncOrg";
+import { syncSpecificTeamHandler } from "./handlers/syncSpecificTeamHandler";
 
 function notImplementedHandler(c: any, req: any, res: any) {
     return res
@@ -16,5 +17,6 @@ export const routes = {
     syncOrg: syncOrgHandler,
     syncAllOrgs: syncAllHandler,
     notImplemented: notImplementedHandler,
-    getSourceTeam: getSourceTeamHandler
+    getSourceTeam: getSourceTeamHandler,
+    syncSpecificTeam: syncSpecificTeamHandler
 }

src/services/githubSync.ts

@@ -73,7 +73,7 @@ async function SynchronizeOrgMembers(installedGitHubClient: InstalledClient, tea
     return orgMembers;
 }
 
-async function SynchronizeGitHubTeam(installedGitHubClient: InstalledClient, teamName: string, config: AppConfig, existingMembers: GitHubId[]) {
+async function SynchronizeGitHubTeam(installedGitHubClient: InstalledClient, teamName: string, config: AppConfig, existingMembers: GitHubId[], checkOrgMembers:boolean = true) {
     await installedGitHubClient.UpdateTeamDetails(teamName, teamDescription);
 
     const trueMembersList = await GetGitHubIds(teamName, config);
@@ -96,14 +96,19 @@ async function SynchronizeGitHubTeam(installedGitHubClient: InstalledClient, tea
             };
         }
 
-        const isMember = existingMembers.filter(em => em == gitHubId);
+        if(checkOrgMembers) {
+            const isMember = existingMembers.filter(em => em == gitHubId);
 
-        if (!isMember) {
-            return {
-                successful: false,
-                gitHubId: gitHubId,
-                message: `User '${gitHubId} is not an Org Member of ${orgName}`
-            };
+            if (!isMember) {
+                return {
+                    successful: false,
+                    gitHubId: gitHubId,
+                    message: `User '${gitHubId} is not an Org Member of ${orgName}`
+                };
+            }
+        }
+        else {
+            console.log(`Skipping Org Membership check for ${gitHubId}`);
         }
 
         return {
@@ -246,6 +251,12 @@ async function syncOrg(installedGitHubClient: InstalledClient, config: AppConfig
     }
 }
 
+export async function SyncTeam(teamName:string, client: InstalledClient, config: AppConfig) {
+    const response = await SynchronizeGitHubTeam(client, teamName, config, [], false);
+
+    return response;
+}
+
 export async function SyncOrg(installedGitHubClient: InstalledClient, config: AppConfig) : ReturnTypeOfSyncOrg {
     try {
         return await syncOrg(installedGitHubClient, config);