refactor(ts): refactor remaining proxy files, fix imports and type issues

Author: jescalada

package-lock.json

@@ -82,6 +82,8 @@
     "@babel/preset-react": "^7.22.5",
     "@commitlint/cli": "^19.0.0",
     "@commitlint/config-conventional": "^19.0.0",
+    "@types/express": "^5.0.1",
+    "@types/express-http-proxy": "^1.6.6",
     "@types/lodash": "^4.17.15",
     "@types/mocha": "^10.0.10",
     "@types/node": "^22.13.5",

package.json

@@ -18,7 +18,7 @@ let _api: Record<string, unknown> = defaultSettings.api;
 let _cookieSecret: string = defaultSettings.cookieSecret;
 let _sessionMaxAgeHours: number = defaultSettings.sessionMaxAgeHours;
 let _plugins: any[] = defaultSettings.plugins;
-let _commitConfig: Record<string, unknown> = defaultSettings.commitConfig;
+let _commitConfig: Record<string, any> = defaultSettings.commitConfig;
 let _attestationConfig: Record<string, unknown> = defaultSettings.attestationConfig;
 let _privateOrganizations: string[] = defaultSettings.privateOrganizations;
 let _urlShortener: string = defaultSettings.urlShortener;

src/config/index.ts

@@ -157,7 +157,12 @@ export const deleteRepo = async (name: string) => {
 export const isUserPushAllowed = async (name: string, user: string) => {
   name = name.toLowerCase();
   return new Promise<boolean>(async (resolve) => {
-    const repo = await exports.getRepo(name);
+    const repo = await getRepo(name);
+    if (!repo) {
+      resolve(false);
+      return;
+    }
+
     console.log(repo.users.canPush);
     console.log(repo.users.canAuthorise);
 
@@ -173,7 +178,12 @@ export const canUserApproveRejectPushRepo = async (name: string, user: string) =
   name = name.toLowerCase();
   console.log(`checking if user ${user} can approve/reject for ${name}`);
   return new Promise<boolean>(async (resolve) => {
-    const repo = await exports.getRepo(name);
+    const repo = await getRepo(name);
+    if (!repo) {
+      resolve(false);
+      return;
+    }
+
     if (repo.users.canAuthorise.includes(user)) {
       console.log(`user ${user} can approve/reject to repo ${name}`);
       resolve(true);

src/db/file/repo.ts

@@ -1,3 +1,5 @@
+import { PluginLoader } from '../plugin';
+import { Action } from './actions';
 import * as proc from './processors';
 
 const pushActionChain = [
@@ -20,14 +22,14 @@ const pullActionChain = [proc.push.checkRepoInAuthorisedList];
 
 let pluginsInserted = false;
 
-const executeChain = async (req) => {
-  let action;
+export const executeChain = async (req: any, res: any): Promise<Action> => {
+  let action: Action;
   try {
     action = await proc.pre.parseAction(req);
     const actions = await getChain(action);
     for (const i in actions) {
       if (!i) continue;
-      const fn = actions[i];
+      const fn = actions[i as any];
 
       action = await fn(req, action);
       if (!action.continue()) {
@@ -39,7 +41,7 @@ const executeChain = async (req) => {
       }
     }
   } finally {
-    await proc.push.audit(req, action);
+    await proc.push.audit(req, action!!);
   }
 
   return action;
@@ -49,9 +51,9 @@ const executeChain = async (req) => {
  * The plugin loader used for the GitProxy chain.
  * @type {import('../plugin').PluginLoader}
  */
-let chainPluginLoader;
+let chainPluginLoader: PluginLoader;
 
-const getChain = async (action) => {
+const getChain = async (action: Action) => {
   if (chainPluginLoader === undefined) {
     console.error(
       'Plugin loader was not initialized! This is an application error. Please report it to the GitProxy maintainers. Skipping plugins...',
@@ -65,12 +67,12 @@ const getChain = async (action) => {
     for (const pluginObj of chainPluginLoader.pushPlugins) {
       console.log(`Inserting push plugin ${pluginObj.constructor.name} into chain`);
       // insert custom functions after parsePush but before other actions
-      pushActionChain.splice(1, 0, pluginObj.exec);
+      pushActionChain.splice(1, 0, pluginObj.exec as any);
     }
     for (const pluginObj of chainPluginLoader.pullPlugins) {
       console.log(`Inserting pull plugin ${pluginObj.constructor.name} into chain`);
       // insert custom functions before other pull actions
-      pullActionChain.splice(0, 0, pluginObj.exec);
+      pullActionChain.splice(0, 0, pluginObj.exec as any);
     }
     // This is set to true so that we don't re-insert the plugins into the chain
     pluginsInserted = true;
@@ -84,7 +86,7 @@ const getChain = async (action) => {
   if (action.type === 'default') return [];
 };
 
-module.exports = {
+export default {
   set chainPluginLoader(loader) {
     chainPluginLoader = loader;
   },

src/proxy/chain.js renamed to src/proxy/chain.ts

@@ -1,40 +1,52 @@
-const express = require('express');
-const bodyParser = require('body-parser');
-const http = require('http');
-const https = require('https');
-const fs = require('fs');
-const path = require('path');
-const router = require('./routes').router;
-const config = require('../config');
-const db = require('../db');
-const { PluginLoader } = require('../plugin');
-const chain = require('./chain');
+import express from 'express';
+import bodyParser from 'body-parser';
+import http from 'http';
+import https from 'https';
+import fs from 'fs';
+import path from 'path';
+import { router } from './routes';
+import {
+  getAuthorisedList,
+  getPlugins,
+  getSSLCertPath,
+  getSSLKeyPath
+} from '../config';
+import {
+  addUserCanAuthorise,
+  addUserCanPush,
+  createRepo,
+  getRepos
+} from '../db';
+import { PluginLoader } from '../plugin';
+import chain from './chain';
+import { Repo } from '../db/types';
+
 const { GIT_PROXY_SERVER_PORT: proxyHttpPort, GIT_PROXY_HTTPS_SERVER_PORT: proxyHttpsPort } =
   require('../config/env').serverConfig;
 
 const options = {
   inflate: true,
   limit: '100000kb',
   type: '*/*',
-  key: fs.readFileSync(path.join(__dirname, config.getSSLKeyPath())),
-  cert: fs.readFileSync(path.join(__dirname, config.getSSLCertPath())),
+  key: fs.readFileSync(path.join(__dirname, getSSLKeyPath())),
+  cert: fs.readFileSync(path.join(__dirname, getSSLCertPath())),
 };
 
 const proxyPreparations = async () => {
-  const plugins = config.getPlugins();
+  const plugins = getPlugins();
   const pluginLoader = new PluginLoader(plugins);
   await pluginLoader.load();
   chain.chainPluginLoader = pluginLoader;
   // Check to see if the default repos are in the repo list
-  const defaultAuthorisedRepoList = config.getAuthorisedList();
-  const allowedList = await db.getRepos();
+  const defaultAuthorisedRepoList = getAuthorisedList();
+  const allowedList: Repo[] = await getRepos();
 
   defaultAuthorisedRepoList.forEach(async (x) => {
     const found = allowedList.find((y) => y.project === x.project && x.name === y.name);
     if (!found) {
-      await db.createRepo(x);
-      await db.addUserCanPush(x.name, 'admin');
-      await db.addUserCanAuthorise(x.name, 'admin');
+      await createRepo(x);
+      await addUserCanPush(x.name, 'admin');
+      await addUserCanAuthorise(x.name, 'admin');
     }
   });
 };
@@ -51,7 +63,7 @@ const createApp = async () => {
 const start = async () => {
   const app = await createApp();
   await proxyPreparations();
-  http.createServer(options, app).listen(proxyHttpPort, () => {
+  http.createServer(options as any, app).listen(proxyHttpPort, () => {
     console.log(`HTTP Proxy Listening on ${proxyHttpPort}`);
   });
   https.createServer(options, app).listen(proxyHttpsPort, () => {
@@ -61,6 +73,8 @@ const start = async () => {
   return app;
 };
 
-module.exports.proxyPreparations = proxyPreparations;
-module.exports.createApp = createApp;
-module.exports.start = start;
+export {
+  proxyPreparations,
+  createApp,
+  start
+};

src/proxy/index.js renamed to src/proxy/index.ts

@@ -1,17 +1,17 @@
-import { exec as parsePush } from './parsePush.js';
-import { exec as preReceive } from './preReceive.js';
-import { exec as checkRepoInAuthorisedList } from './checkRepoInAuthorisedList.js';
-import { exec as audit } from './audit.js';
-import { exec as pullRemote } from './pullRemote.js';
-import { exec as writePack } from './writePack.js';
-import { exec as getDiff } from './getDiff.js';
-import { exec as scanDiff } from './scanDiff.js';
-import { exec as blockForAuth } from './blockForAuth.js';
-import { exec as checkIfWaitingAuth } from './checkIfWaitingAuth.js';
-import { exec as checkCommitMessages } from './checkCommitMessages.js';
-import { exec as checkAuthorEmails } from './checkAuthorEmails.js';
-import { exec as checkUserPushPermission } from './checkUserPushPermission.js';
-import { exec as clearBareClone } from './clearBareClone.js';
+import { exec as parsePush } from './parsePush';
+import { exec as preReceive } from './preReceive';
+import { exec as checkRepoInAuthorisedList } from './checkRepoInAuthorisedList';
+import { exec as audit } from './audit';
+import { exec as pullRemote } from './pullRemote';
+import { exec as writePack } from './writePack';
+import { exec as getDiff } from './getDiff';
+import { exec as scanDiff } from './scanDiff';
+import { exec as blockForAuth } from './blockForAuth';
+import { exec as checkIfWaitingAuth } from './checkIfWaitingAuth';
+import { exec as checkCommitMessages } from './checkCommitMessages';
+import { exec as checkAuthorEmails } from './checkAuthorEmails';
+import { exec as checkUserPushPermission } from './checkUserPushPermission';
+import { exec as clearBareClone } from './clearBareClone';
 
 export {
   parsePush,