Check GitHub API credentials validity when server starts

Author: vejol

.gitignore

@@ -1,4 +1,5 @@
 .env
 node_modules
 .DS_Store
-database.sqlite
+database.sqlite
+.vscode/

src/index.js

@@ -4,6 +4,27 @@ import logger from './utils/logger.js';
 import { API_PORT, APOLLO_PORT } from './config.js';
 import createApolloServer from './apolloServer.js';
 import app from './app.js';
+import githubClient from './utils/githubClient.js';
+
+const logGithubCredentialStatus = async () => {
+  const validationResult = await githubClient.validateCredentials();
+
+  if (!validationResult.configured) {
+    logger.info(
+      'GitHub API credentials are not configured; anonymous GitHub API access with strict rate limit will be used',
+    );
+    return;
+  }
+
+  if (validationResult.valid) {
+    logger.info('GitHub API credentials validated successfully');
+    return;
+  }
+
+  logger.warn(
+    'GitHub API credential validation failed; anonymous GitHub API access with strict rate limit will be used',
+  );
+};
 
 const startServer = async () => {
   const httpServer = http.createServer(app);
@@ -18,6 +39,8 @@ const startServer = async () => {
     httpServer.listen({ port: API_PORT }, resolve),
   );
 
+  await logGithubCredentialStatus();
+
   logger.info(`Apollo Server ready at http://localhost:${APOLLO_PORT}`);
 };
 

src/utils/__tests__/githubClient.test.js

@@ -0,0 +1,67 @@
+import { GithubClient, GithubError } from '../githubClient.js';
+
+describe('GithubClient.validateCredentials', () => {
+  it('returns not configured when credentials are missing', async () => {
+    const githubClient = new GithubClient({
+      clientId: '',
+      clientSecret: '',
+    });
+
+    githubClient.httpClient.get = jest.fn();
+
+    const result = await githubClient.validateCredentials();
+
+    expect(result).toEqual({
+      configured: false,
+      valid: false,
+    });
+    expect(githubClient.httpClient.get).not.toHaveBeenCalled();
+  });
+
+  it('returns success when GitHub accepts the credentials', async () => {
+    const githubClient = new GithubClient({
+      clientId: 'client-id',
+      clientSecret: 'client-secret',
+    });
+
+    githubClient.httpClient.get = jest.fn().mockResolvedValue({ status: 200 });
+
+    const result = await githubClient.validateCredentials({ timeout: 1234 });
+
+    expect(result).toEqual({
+      configured: true,
+      valid: true,
+      status: 200,
+    });
+    expect(githubClient.httpClient.get).toHaveBeenCalledWith('/rate_limit', {
+      timeout: 1234,
+      auth: {
+        username: 'client-id',
+        password: 'client-secret',
+      },
+    });
+  });
+
+  it('returns failure details when GitHub rejects the credentials', async () => {
+    const githubClient = new GithubClient({
+      clientId: 'client-id',
+      clientSecret: 'client-secret',
+    });
+
+    githubClient.httpClient.get = jest.fn().mockRejectedValue({
+      response: {
+        status: 401,
+        statusText: 'Unauthorized',
+        headers: {},
+        data: { message: 'Bad credentials' },
+      },
+    });
+
+    const result = await githubClient.validateCredentials();
+
+    expect(result.configured).toBe(true);
+    expect(result.valid).toBe(false);
+    expect(result.status).toBe(401);
+    expect(result.error).toBeInstanceOf(GithubError);
+  });
+});

src/utils/githubClient.js

@@ -65,8 +65,12 @@ export class GithubClient {
     this.cache = new LRUCache({ max: 100, maxAge: cacheMaxAge });
   }
 
+  hasCredentials() {
+    return Boolean(this.clientId && this.clientSecret);
+  }
+
   getAuth() {
-    return this.clientId && this.clientSecret
+    return this.hasCredentials()
       ? {
           username: this.clientId,
           password: this.clientSecret,
@@ -127,6 +131,32 @@ export class GithubClient {
       throw error;
     }
   }
+
+  async validateCredentials({ timeout = 5000 } = {}) {
+    if (!this.hasCredentials()) {
+      return {
+        configured: false,
+        valid: false,
+      };
+    }
+
+    try {
+      const response = await this.getRequest('/rate_limit', { timeout });
+
+      return {
+        configured: true,
+        valid: true,
+        status: response.status,
+      };
+    } catch (error) {
+      return {
+        configured: true,
+        valid: false,
+        status: error.extensions?.response?.status,
+        error,
+      };
+    }
+  }
 }
 
 export const githubClient = new GithubClient();