Refactor database connection setup to use a URI; update GitHub app registration URLs; enhance logging for setup processes; improve installation handling in the frontend.

Author: austenstone

backend/src/app.ts

@@ -28,10 +28,10 @@ class App {
     this.e = express();
     this.port = port;
     logger.info(`Starting application on port ${this.port}`);
-    if (!process.env.MONGODB_URI) {
-      throw new Error('MONGODB_URI must be set');
-    }
-    this.database = new Database(process.env.MONGODB_URI);
+    // if (!process.env.MONGODB_URI) {
+    //   throw new Error('MONGODB_URI must be set');
+    // }
+    this.database = new Database();
     const webhookService = new WebhookService({
       url: process.env.WEBHOOK_PROXY_URL,
       path: '/api/github/webhooks',
@@ -70,17 +70,19 @@ class App {
       this.setupExpress();
       logger.info('Express setup complete');
 
-      logger.info('Database connecting...');
-      await this.database.connect();
-      logger.info('Database connected');
-
-      logger.info('Initializing settings...');
-      await this.initializeSettings();
-      logger.info('Settings initialized');
+      if (process.env.MONGODB_URI) {
+        logger.info('Database connecting...');
+        await this.database.connect(process.env.MONGODB_URI);
+        logger.info('Database connected');
 
-      logger.info('GitHub App starting...');
-      await this.github.connect();
-      logger.info('GitHub App connected');
+        logger.info('Initializing settings...');
+        await this.initializeSettings();
+        logger.info('Settings initialized');
+  
+        logger.info('GitHub App starting...');
+        await this.github.connect();
+        logger.info('GitHub App connected');
+      }
 
       return this.e;
     } catch (error) {
@@ -89,7 +91,6 @@ class App {
         logger.error(error.message);
       }
       logger.debug(error);
-      process.exit(1);
     }
   }
 

backend/src/controllers/setup.controller.ts

@@ -1,10 +1,12 @@
 import { Request, Response } from 'express';
 import app from '../index.js';
 import StatusService from '../services/status.service.js';
+import logger from '../services/logger.js';
 
 class SetupController {
   async registrationComplete(req: Request, res: Response) {
     try {
+      logger.info(`GitHub registrationComplete`, req.query);
       const { code } = req.query;
       const { html_url } = await app.github.createAppFromManifest(code as string);
       res.redirect(`${html_url}/installations/new`);
@@ -15,6 +17,7 @@ class SetupController {
 
   async installComplete(req: Request, res: Response) {
     try {
+      logger.info(`GitHub installComplete`, req.query);
       const installationUrl = await app.github.app?.getInstallationUrl();
       if (!installationUrl) throw new Error('No installation URL found');
       res.redirect(installationUrl);
@@ -34,6 +37,7 @@ class SetupController {
 
   async addExistingApp(req: Request, res: Response) {
     try {
+      logger.info(`GitHub addExistingApp`, req.body);
       const { appId, privateKey, webhookSecret } = req.body;
 
       if (!appId || !privateKey || !webhookSecret) {
@@ -101,7 +105,7 @@ class SetupController {
 
   async setupDB(req: Request, res: Response) {
     try {
-      await app.database.connect();
+      await app.database.connect(req.body.uri);
       res.json({ message: 'DB setup started' });
     } catch (error) {
       res.status(500).json(error);

backend/src/database.ts

@@ -1,24 +1,18 @@
 import updateDotenv from 'update-dotenv';
 import logger from './services/logger.js';
-import mongoose, { mongo, Schema } from 'mongoose';
+import mongoose, { Schema } from 'mongoose';
 import util from 'util';
-import { da } from 'date-fns/locale';
 
 class Database {
   mongoose: mongoose.Mongoose | null = null;
-  mongodbUri: string;
+  mongodbUri?: string;
 
-  constructor(mongodbUri: string) {
-    this.mongodbUri = mongodbUri;
-  }
-
-  async connect() {
-    //improve the logger message  @12:12
+  constructor() { }
 
-    logger.info('Connecting to the database', this.mongodbUri);
-    if (this.mongodbUri) await updateDotenv({ MONGODB_URI: this.mongodbUri });
+  async connect(mongodbUri: string) {
+    logger.info('Connecting to the database', mongodbUri);
     try {
-      this.mongoose = await mongoose.connect(this.mongodbUri, {
+      this.mongoose = await mongoose.connect(mongodbUri, {
         socketTimeoutMS: 90000,
         connectTimeoutMS: 60000,
         serverSelectionTimeoutMS: 30000,
@@ -41,14 +35,27 @@ class Database {
         // logger.debug(`\x1B[0;36mMongoose:\x1B[0m: ${collectionName}.${methodName}` + `(${methodArgs.map(msgMapper).join(', ')})`);
         logger.debug(`[Mongoose] ${collectionName}.${methodName}(${methodArgs.map(msgMapper).join(', ')})`);
       });
-
+      
+      if (mongodbUri) await updateDotenv({ MONGODB_URI: mongodbUri });
+      this.mongodbUri = mongodbUri;
+      logger.info('Database connected');
+      
+      this.setupSchemas();
+      logger.info('Database schemas setup complete');
     } catch (error) {
       logger.debug(error);
       if (error instanceof Error) {
         logger.error(`Database connection error: ${error.message}`);
       }
       throw error;
     }
+  }
+
+  async disconnect() {
+    await this.mongoose?.disconnect();
+  }
+
+  async setupSchemas() {
     mongoose.model('Settings', new mongoose.Schema({
       name: String,
       value: {}
@@ -361,10 +368,6 @@ class Database {
     mongoose.model('Counter', CounterSchema);
   }
 
-  async disconnect() {
-    await this.mongoose?.disconnect();
-  }
-
 }
 
 export default Database;

backend/src/github.ts

@@ -116,7 +116,7 @@ class GitHub {
   getAppManifest(baseUrl: string) {
     const manifest = JSON.parse(readFileSync('github-manifest.json', 'utf8'));
     const base = new URL(baseUrl);
-    manifest.url = base.href;
+    manifest.url = base.href || 'localhost';
     manifest.hook_attributes.url = new URL('/api/github/webhooks', base).href;
     manifest.setup_url = new URL('/api/setup/install/complete', base).href;
     manifest.redirect_url = new URL('/api/setup/registration/complete', base).href;

backend/src/services/query.service.ts

@@ -4,7 +4,6 @@ import { insertUsage } from '../models/usage.model.js';
 import SeatService, { SeatEntry } from './seats.service.js';
 import { App, Octokit } from 'octokit';
 import { MetricDailyResponseType } from '../models/metrics.model.js';
-import mongoose from 'mongoose';
 import metricsService from './metrics.service.js';
 import teamsService from './teams.service.js';
 import adoptionService from './adoption.service.js';
@@ -44,7 +43,7 @@ class QueryService {
 
   private async task() {
     const queryAt = new Date();
-    logger.info(`Task started`);
+    logger.info(`Task started. Last ran at `, this.cronJob.lastDate());
     const tasks = [];
     for await (const { octokit, installation } of this.app.eachInstallation.iterator()) {
       if (!installation.account?.login) return;

frontend/src/app/database/database.component.html

@@ -6,20 +6,9 @@
         <form [formGroup]="dbFormGroup" (ngSubmit)="dbConnect()" class="database-form">
           <ng-template matStepLabel>Database</ng-template>
           <mat-form-field>
-            <mat-label>Hostname</mat-label>
-            <input matInput formControlName="hostname" placeholder="127.0.0.1">
-          </mat-form-field>
-          <mat-form-field>
-            <mat-label>Port</mat-label>
-            <input type="number" formControlName="port" matInput placeholder="3306">
-          </mat-form-field>
-          <mat-form-field>
-            <mat-label>Username</mat-label>
-            <input matInput formControlName="username" placeholder="root">
-          </mat-form-field>
-          <mat-form-field>
-            <mat-label>Password</mat-label>
-            <input matInput formControlName="password" type="password">
+            <mat-label>Connection String URI</mat-label>
+            <input matInput formControlName="uri"
+              placeholder="mongodb://myDatabaseUser:P%40ssw0rd@cluster0.example.mongodb.net/?retryWrites=true&w=majority">
           </mat-form-field>
           <div>
           </div>

frontend/src/app/database/database.component.ts

@@ -44,10 +44,7 @@ export class DatabaseComponent implements AfterViewInit {
   status?: statusResponse;
   isDbConnecting = false;
   dbFormGroup = new FormGroup({
-    hostname: new FormControl('', Validators.required),
-    port: new FormControl(3306, [Validators.required, Validators.min(1), Validators.max(65535)]),
-    username: new FormControl('root', Validators.required),
-    password: new FormControl(''),
+    uri: new FormControl('', Validators.required)
   });
 
   constructor(
@@ -74,10 +71,7 @@ export class DatabaseComponent implements AfterViewInit {
     if(this.dbFormGroup.invalid) return;
     this.isDbConnecting = true;
     this.setupService.setupDB({
-      host: this.dbFormGroup.value.hostname!,
-      port: this.dbFormGroup.value.port!,
-      username: this.dbFormGroup.value.username!,
-      password: this.dbFormGroup.value.password!,
+      uri: this.dbFormGroup.value.uri!
     }).subscribe(() => {
       this.isDbConnecting = false;
       this.cdr.detectChanges();

frontend/src/app/install/install.component.ts

@@ -96,7 +96,7 @@ export class DialogAppComponent {
 
   registerNewApp() {
     if (this.organizationFormControl.value) {
-      this.form.nativeElement.action = `https://github.com/enterprises/${this.organizationFormControl.value}/settings/apps/new?state=abc123`
+      this.form.nativeElement.action = `https://github.com/organizations/${this.organizationFormControl.value}/settings/apps/new?state=abc123`
     }
     this.form.nativeElement.submit();
     this.dialogRef.close();

frontend/src/app/main/main.component.html

@@ -53,17 +53,24 @@
       </button>
       }
       <div class="header">
-        <div *ngIf="installationsService.currentInstallation.asObservable() | async as installation" class="mat-card-avatar" mat-card-avatar style="background-size: cover;"
+        <div *ngIf="installationsService.currentInstallation.asObservable() | async as installation"
+          class="mat-card-avatar" mat-card-avatar style="background-size: cover;"
           [style.background-image]="'url(' + installation?.account?.avatar_url + ')'">
         </div>
-        <h1>
-          <mat-select [ngModel]="(installationsService.currentInstallation.asObservable() | async)?.id || 1" (ngModelChange)="installationsService.setInstallation($event)">
-            <mat-option [value]="1">Enterprise</mat-option>
-            @for (installation of installationsService.getInstallations() | async; track installation.id) {
-            <mat-option [value]="installation.id">{{ installation.account?.login }}</mat-option>
-            }
-          </mat-select>
-        </h1>
+        <ng-container *ngIf="installationsService.getInstallations() | async as installations">
+          <h1>
+            <mat-select *ngIf="installations.length > 1; else singleInstall" [ngModel]="(installationsService.currentInstallation.asObservable() | async)?.id || 1"
+              (ngModelChange)="installationsService.setInstallation($event)">
+              <mat-option [value]="1">Enterprise</mat-option>
+              @for (installation of installationsService.getInstallations() | async; track installation.id) {
+              <mat-option [value]="installation.id">{{ installation.account?.login }}</mat-option>
+              }
+            </mat-select>
+            <ng-template #singleInstall>
+              <span>{{ installations[0]?.account?.login }}</span>
+            </ng-template>
+          </h1>
+        </ng-container>
       </div>
       <span class="spacer"></span>
     </mat-toolbar>

frontend/src/app/services/api/setup.service.ts

@@ -55,11 +55,7 @@ export class SetupService {
   }
 
   setupDB(request: { // should be url or fields
-    host?: string;
-    port?: number;
-    username?: string;
-    password?: string;
-    url?: string;
+    uri: string;
   }) {
     return this.http.post(`${this.apiUrl}/db`, request);
   }