fix(backend): warn on missing GitHub App org installation

Author: brendan-kellam

packages/backend/src/ee/githubAppManager.ts

@@ -16,6 +16,13 @@ type Installation = {
     };
 };
 
+export class GithubAppInstallationNotFoundError extends Error {
+    constructor(owner: string, deploymentHostname: string) {
+        super(`GitHub App installation not found for ${deploymentHostname}/${owner}`);
+        this.name = 'GithubAppInstallationNotFoundError';
+    }
+}
+
 export class GithubAppManager {
     private static instance: GithubAppManager | null = null;
     private octokitApps: Map<number, App>;
@@ -112,7 +119,7 @@ export class GithubAppManager {
         const key = this.generateMapKey(owner, deploymentHostname);
         const installation = this.installationMap.get(key) as Installation | undefined;
         if (!installation) {
-            throw new Error(`GitHub App Installation not found for ${key}`);
+            throw new GithubAppInstallationNotFoundError(owner, deploymentHostname);
         }
 
         const octokitApp = this.octokitApps.get(installation.appId) as App;

packages/backend/src/github.ts

@@ -9,7 +9,7 @@ import { hasEntitlement } from "./entitlements.js";
 import micromatch from "micromatch";
 import pLimit from "p-limit";
 import { processPromiseResults, throwIfAnyFailed } from "./connectionUtils.js";
-import { GithubAppManager } from "./ee/githubAppManager.js";
+import { GithubAppInstallationNotFoundError, GithubAppManager } from "./ee/githubAppManager.js";
 import { fetchWithRetry, measure } from "./utils.js";
 
 export const GITHUB_CLOUD_HOSTNAME = "github.com";
@@ -145,6 +145,10 @@ export const getOctokitWithGithubApp = async (
         });
         return octokitFromToken;
     } catch (error) {
+        if (error instanceof GithubAppInstallationNotFoundError) {
+            throw error;
+        }
+
         logger.error(`Error getting GitHub App token for ${context}.`, error);
         throw error;
     }
@@ -403,6 +407,15 @@ const getReposForOrgs = async (orgs: string[], octokit: Octokit, signal: AbortSi
                 data
             };
         } catch (error) {
+            if (error instanceof GithubAppInstallationNotFoundError) {
+                const warning = error.message;
+                logger.warn(warning);
+                return {
+                    type: 'warning' as const,
+                    warning
+                };
+            }
+
             Sentry.captureException(error);
             logger.error(`Failed to fetch repositories for org ${org}.`, error);
 

packages/backend/src/githubAppAuth.test.ts

@@ -1,24 +1,61 @@
-import type { Octokit } from '@octokit/rest';
 import { beforeEach, describe, expect, test, vi } from 'vitest';
 
 const mocks = vi.hoisted(() => ({
     appsConfigured: vi.fn(),
     ensureInitialized: vi.fn(),
     getInstallationToken: vi.fn(),
     hasEntitlement: vi.fn(),
+    logger: {
+        debug: vi.fn(),
+        error: vi.fn(),
+        info: vi.fn(),
+        warn: vi.fn(),
+    },
+    GithubAppInstallationNotFoundError: class GithubAppInstallationNotFoundError extends Error {
+        constructor(owner: string, deploymentHostname: string) {
+            super(`GitHub App installation not found for ${deploymentHostname}/${owner}`);
+            this.name = 'GithubAppInstallationNotFoundError';
+        }
+    },
+}));
+
+vi.mock('@octokit/rest', () => ({
+    Octokit: class {
+        public paginate = {
+            iterator: async function* (_request: unknown, options: { org: string }) {
+                yield {
+                    data: [{
+                        clone_url: `https://github.com/${options.org}/repo.git`,
+                        full_name: `${options.org}/repo`,
+                        id: 1,
+                        name: 'repo',
+                        owner: {
+                            avatar_url: '',
+                            login: options.org,
+                        },
+                    }],
+                };
+            },
+        };
+
+        public repos = {
+            listForOrg: vi.fn(),
+        };
+
+        public rest = {
+            users: {
+                getAuthenticated: vi.fn(),
+            },
+        };
+    },
 }));
 
 vi.mock('@sentry/node', () => ({
     captureException: vi.fn(),
 }));
 
 vi.mock('@sourcebot/shared', () => ({
-    createLogger: vi.fn(() => ({
-        debug: vi.fn(),
-        error: vi.fn(),
-        info: vi.fn(),
-        warn: vi.fn(),
-    })),
+    createLogger: vi.fn(() => mocks.logger),
     env: {
         FALLBACK_GITHUB_CLOUD_TOKEN: undefined,
     },
@@ -30,6 +67,7 @@ vi.mock('./entitlements.js', () => ({
 }));
 
 vi.mock('./ee/githubAppManager.js', () => ({
+    GithubAppInstallationNotFoundError: mocks.GithubAppInstallationNotFoundError,
     GithubAppManager: {
         getInstance: () => ({
             appsConfigured: mocks.appsConfigured,
@@ -39,14 +77,19 @@ vi.mock('./ee/githubAppManager.js', () => ({
     },
 }));
 
-import { getOctokitWithGithubApp } from './github.js';
+import type { Octokit } from '@octokit/rest';
+import { getGitHubReposFromConfig, getOctokitWithGithubApp } from './github.js';
 
 describe('getOctokitWithGithubApp', () => {
     beforeEach(() => {
         mocks.appsConfigured.mockReset().mockReturnValue(true);
         mocks.ensureInitialized.mockReset().mockResolvedValue(undefined);
         mocks.getInstallationToken.mockReset().mockResolvedValue('installation-token');
         mocks.hasEntitlement.mockReset();
+        mocks.logger.debug.mockReset();
+        mocks.logger.error.mockReset();
+        mocks.logger.info.mockReset();
+        mocks.logger.warn.mockReset();
     });
 
     test('fails safely, then uses the GitHub App when the entitlement appears after startup', async () => {
@@ -101,4 +144,28 @@ describe('getOctokitWithGithubApp', () => {
             'org example',
         )).rejects.toBe(error);
     });
+
+    test('warns and continues when the GitHub App is not installed for one organization', async () => {
+        mocks.hasEntitlement.mockResolvedValue(true);
+        mocks.getInstallationToken.mockImplementation(async (owner: string) => {
+            if (owner === 'invalid-org') {
+                throw new mocks.GithubAppInstallationNotFoundError(owner, 'github.com');
+            }
+            return 'installation-token';
+        });
+
+        const result = await getGitHubReposFromConfig({
+            type: 'github',
+            orgs: ['valid-org', 'invalid-org'],
+        }, new AbortController().signal);
+
+        expect(result.repos.map(repo => repo.full_name)).toEqual(['valid-org/repo']);
+        expect(result.warnings).toEqual([
+            'GitHub App installation not found for github.com/invalid-org',
+        ]);
+        expect(mocks.logger.warn).toHaveBeenCalledWith(
+            'GitHub App installation not found for github.com/invalid-org',
+        );
+        expect(mocks.logger.error).not.toHaveBeenCalled();
+    });
 });