💡 update/add additional logging for config results (#86)

This PR makes a few adjustments so that "client side" issues are easier
to detect and thus triage.

Author: JoshuaTheMiller

src/services/gitHub.ts

@@ -649,14 +649,22 @@ class InstalledGitHubClient implements InstalledClient {
             .filter(i => i.type == "file")
             .filter(i => i.name == "team-sync-options.yml" || i.name == "team-sync-options.yaml");
 
-        if (onlyConfigFiles.length != 1) {
+        if (onlyConfigFiles.length > 1) {
             return {
                 successful: false,
                 state: "BadConfig",
                 message: "Multiple configuration files are not supported at this point in time."
             }
         }
 
+        if(onlyConfigFiles.length < 1) {
+            return {
+                successful: false,
+                state: "NoConfig",
+                message: "No configuration file exists in the configuration repository (typically the .github repository)."
+            }
+        }
+
         const onlyFile = onlyConfigFiles[0];
 
         const contentResponse = await this.gitHubClient.rest.repos.getContent({

src/services/githubSync.ts

@@ -19,6 +19,7 @@ const replaceAll = function (original: string, search: string, replacement: stri
 
 type GitHubIdsFailed = {
     Succeeded: false
+    Reason: "unknown" | "team_not_found"
 }
 
 type GitHubIdsSucceeded = {
@@ -31,8 +32,16 @@ async function GetGitHubIds(teamName: string, config: AppConfig): Promise<GitHub
     const membersFromSourceOfTruth = await SearchAllAsync(teamName);
 
     if (membersFromSourceOfTruth.Succeeded == false) {
+        if(membersFromSourceOfTruth.Reason == "team_not_found") {
+            return {
+                Succeeded: false,
+                Reason: "team_not_found"
+            }
+        }
+        
         return {
-            Succeeded: false
+            Succeeded: false,
+            Reason: "unknown"
         }
     }
 
@@ -46,23 +55,34 @@ async function GetGitHubIds(teamName: string, config: AppConfig): Promise<GitHub
     }
 }
 
-type SyncFailed = {
+type SyncMembersFailed = {
     Succeeded: false
+    Reason: "unknown" | "team_not_found"
 }
 
-type SyncSucceeded = {
+type SyncMembersSucceeded = {
     Succeeded: true
     OrgMembers: string[]
 }
 
-async function SynchronizeOrgMembers(installedGitHubClient: InstalledClient, teamName: string, config: AppConfig, sourceTeamMap: Map<string, string>): Promise<SyncFailed | SyncSucceeded> {
+type SyncMembersResponse = Promise<SyncMembersFailed | SyncMembersSucceeded>
+
+async function SynchronizeOrgMembers(installedGitHubClient: InstalledClient, teamName: string, config: AppConfig, sourceTeamMap: Map<string, string>): SyncMembersResponse {
     const actualTeamName = sourceTeamMap.get(teamName) ?? teamName;
 
     const gitHubIdsResponse = await GetGitHubIds(actualTeamName, config);
 
     if (gitHubIdsResponse.Succeeded == false) {
+        if(gitHubIdsResponse.Reason == "team_not_found") {
+            return {
+                Succeeded: false,
+                Reason: "team_not_found"
+            }
+        }
+
         return {
-            Succeeded: false
+            Succeeded: false,
+            Reason: "unknown"
         };
     }
 
@@ -368,6 +388,14 @@ async function syncOrg(installedGitHubClient: InstalledClient, appConfig: AppCon
         if (currentMembersResponse.Succeeded == false) {
             Log("Failed to sync members");
 
+            if(currentMembersResponse.Reason == "team_not_found") {
+                return {
+                    ...response,
+                    message: "Org Membership Group does not appear to exist in source of truth.",
+                    status: "bad_config"
+                };
+            }            
+
             return {
                 ...response,
                 message: "Failed to sync org members"

src/services/ldapClient.ts

@@ -1,5 +1,5 @@
 import { Config } from "../config";
-import axios from "axios";
+import axios, { AxiosError } from "axios";
 import axiosRetry from "axios-retry";
 import { Log, LoggerToUse } from "../logging";
 import { redisClient } from "../app";
@@ -11,12 +11,13 @@ export interface Entry {
 }
 
 export type SearchAllFailed = {
-    Succeeded: false
+    Succeeded: false,
+    Reason: "unknown" | "team_not_found"
 }
 
 export type SearchAllSucceeded = {
     Succeeded: true,
-    entries: Entry[]    
+    entries: Entry[]
 }
 
 export type SearchAllResponse = Promise<SearchAllFailed | SearchAllSucceeded>
@@ -77,16 +78,17 @@ async function ForwardSearch(groupName: string): SearchAllResponse {
     Log(`Retrieving group (${groupName}) information from '${requestUrl}'`);
     try {
         const httpResponse = await httpClient.get(requestUrl);
-        Log(`Results for ${groupName}: ${JSON.stringify(httpResponse.data)}`);
+        Log(`Results for ${groupName}: ${JSON.stringify(httpResponse.data)}`);      
 
-        if(httpResponse.status < 200 || httpResponse.status > 299) {
+        if (httpResponse.status < 200 || httpResponse.status > 299) {
             return {
-                Succeeded: false
+                Succeeded: false,
+                Reason: "unknown"
             }
-        }        
+        }
 
         const response = httpResponse.data as SuccessResponse;
-        
+
         return {
             Succeeded: true,
             entries: response.users.map(u => {
@@ -99,10 +101,21 @@ async function ForwardSearch(groupName: string): SearchAllResponse {
     }
     catch (e) {
         Log(`Error when retrieving results for ${groupName}: ${e}`);
+
+        if (e instanceof (AxiosError)) {
+            const axiosError = e as AxiosError;
+            if (axiosError.response?.status == 404) {
+                return {
+                    Succeeded: false,
+                    Reason: "team_not_found"
+                }
+            }
+        }
     }
 
     return {
-        Succeeded: false
+        Succeeded: false,
+        Reason: "unknown"
     }
 }
 
@@ -111,12 +124,12 @@ export interface User {
     email: string
 }
 
-export interface SuccessResponse {    
-    users: User[]    
+export interface SuccessResponse {
+    users: User[]
 }
 
-export interface FailedResponse {    
+export interface FailedResponse {
     Message: string
 }
 
-export type SearchResponse = SuccessResponse | FailedResponse
+export type SearchResponse = SuccessResponse | FailedResponse;