refactor: refactor git-proxy-cli to TS + ESM

.eslintrc.json

@@ -45,7 +45,8 @@
     "@typescript-eslint/no-explicit-any": "off", // temporary until TS refactor is complete
     "@typescript-eslint/no-unused-vars": "off", // temporary until TS refactor is complete
     "@typescript-eslint/no-require-imports": "off", // prevents error on old "require" imports
-    "@typescript-eslint/no-unused-expressions": "off" // prevents error on test "expect" expressions
+    "@typescript-eslint/no-unused-expressions": "off", // prevents error on test "expect" expressions
+    "new-cap": "off" // prevents error on express.Router()
   },
   "settings": {
     "react": {

index.ts

@@ -5,7 +5,7 @@ import { hideBin } from 'yargs/helpers';
 import * as fs from 'fs';
 import { configFile, setConfigFile, validate } from './src/config/file';
 import proxy from './src/proxy';
-import service from './src/service';
+import * as service from './src/service';
 
 const argv = yargs(hideBin(process.argv))
   .usage('Usage: $0 [options]')

package.json

@@ -3,7 +3,7 @@
   "version": "1.18.2",
   "description": "Deploy custom push protections and policies on top of Git.",
   "scripts": {
-    "cli": "node ./packages/git-proxy-cli/index.js",
+    "cli": "tsx ./packages/git-proxy-cli/index.ts",
     "client": "vite --config vite.config.js",
     "clientinstall": "npm install --prefix client",
     "server": "tsx index.ts",
@@ -89,11 +89,17 @@
     "@babel/preset-react": "^7.22.5",
     "@commitlint/cli": "^19.0.0",
     "@commitlint/config-conventional": "^19.0.0",
+    "@types/cors": "^2.8.19",
     "@types/express": "^5.0.1",
     "@types/express-http-proxy": "^1.6.6",
+    "@types/express-session": "^1.18.2",
+    "@types/jsonwebtoken": "^9.0.10",
+    "@types/jwk-to-pem": "^2.0.3",
     "@types/lodash": "^4.17.15",
+    "@types/lusca": "^1.7.5",
     "@types/mocha": "^10.0.10",
     "@types/node": "^22.13.5",
+    "@types/passport-local": "^1.0.38",
     "@types/yargs": "^17.0.33",
     "@typescript-eslint/eslint-plugin": "^8.26.1",
     "@typescript-eslint/parser": "^8.26.1",

packages/git-proxy-cli/index.js → packages/git-proxy-cli/index.ts

@@ -1,9 +1,11 @@
 #!/usr/bin/env node
-const axios = require('axios');
-const yargs = require('yargs/yargs');
-const { hideBin } = require('yargs/helpers');
-const fs = require('fs');
-const util = require('util');
+import axios from 'axios';
+import yargs from 'yargs/yargs';
+import { hideBin } from 'yargs/helpers';
+import fs from 'fs';
+import util from 'util';
+
+import { CommitData, PushData, PushFilters } from './types';
 
 const GIT_PROXY_COOKIE_FILE = 'git-proxy-cookie';
 // GitProxy UI HOST and PORT (configurable via environment variable)
@@ -19,7 +21,7 @@ axios.defaults.timeout = 30000;
  * @param {string} username The user name to login with
  * @param {string} password The password to use for the login
  */
-async function login(username, password) {
+async function login(username: string, password: string) {
   try {
     let response = await axios.post(
       `${baseUrl}/api/auth/login`,
@@ -44,7 +46,7 @@ async function login(username, password) {
     const user = `"${response.data.username}" <${response.data.email}>`;
     const isAdmin = response.data.admin ? ' (admin)' : '';
     console.log(`Login ${user}${isAdmin}: OK`);
-  } catch (error) {
+  } catch (error: any) {
     if (error.response) {
       console.error(`Error: Login '${username}': '${error.response.status}'`);
       process.exitCode = 1;
@@ -76,7 +78,7 @@ async function login(username, password) {
  * @param {boolean} filters.rejected - If not null, filters for pushes with
  *          given attribute and status.
  */
-async function getGitPushes(filters) {
+async function getGitPushes(filters: PushFilters) {
   if (!fs.existsSync(GIT_PROXY_COOKIE_FILE)) {
     console.error('Error: List: Authentication required');
     process.exitCode = 1;
@@ -91,40 +93,46 @@ async function getGitPushes(filters) {
       params: filters,
     });
 
-    const records = [];
-    response.data?.forEach((push) => {
-      const record = {};
-      record.id = push.id;
-      record.timestamp = push.timestamp;
-      record.url = push.url;
-      record.allowPush = push.allowPush;
-      record.authorised = push.authorised;
-      record.blocked = push.blocked;
-      record.canceled = push.canceled;
-      record.error = push.error;
-      record.rejected = push.rejected;
-
-      record.lastStep = {
-        stepName: push.lastStep?.stepName,
-        error: push.lastStep?.error,
-        errorMessage: push.lastStep?.errorMessage,
-        blocked: push.lastStep?.blocked,
-        blockedMessage: push.lastStep?.blockedMessage,
+    const records: PushData[] = [];
+    response.data.forEach((push: PushData) => {
+      const record: PushData = {
+        id: push.id,
+        timestamp: push.timestamp,
+        url: push.url,
+        allowPush: push.allowPush,
+        authorised: push.authorised,
+        blocked: push.blocked,
+        canceled: push.canceled,
+        error: push.error,
+        rejected: push.rejected,
       };
 
-      record.commitData = [];
-      push.commitData?.forEach((pushCommitDataRecord) => {
-        record.commitData.push({
-          message: pushCommitDataRecord.message,
-          committer: pushCommitDataRecord.committer,
+      if (push.lastStep) {
+        record.lastStep = {
+          stepName: push.lastStep?.stepName,
+          error: push.lastStep?.error,
+          errorMessage: push.lastStep?.errorMessage,
+          blocked: push.lastStep?.blocked,
+          blockedMessage: push.lastStep?.blockedMessage,
+        };
+      }
+
+      if (push.commitData) {
+        const commitData: CommitData[] = [];
+        push.commitData.forEach((pushCommitDataRecord: CommitData) => {
+          commitData.push({
+            message: pushCommitDataRecord.message,
+            committer: pushCommitDataRecord.committer,
+          });
         });
-      });
+        record.commitData = commitData;
+      }
 
       records.push(record);
     });
 
     console.log(`${util.inspect(records, false, null, false)}`);
-  } catch (error) {
+  } catch (error: any) {
     // default error
     const errorMessage = `Error: List: '${error.message}'`;
     process.exitCode = 2;
@@ -136,7 +144,7 @@ async function getGitPushes(filters) {
  * Authorise git push by ID
  * @param {string} id The ID of the git push to authorise
  */
-async function authoriseGitPush(id) {
+async function authoriseGitPush(id: string) {
   if (!fs.existsSync(GIT_PROXY_COOKIE_FILE)) {
     console.error('Error: Authorise: Authentication required');
     process.exitCode = 1;
@@ -168,7 +176,7 @@ async function authoriseGitPush(id) {
     );
 
     console.log(`Authorise: ID: '${id}': OK`);
-  } catch (error) {
+  } catch (error: any) {
     // default error
     let errorMessage = `Error: Authorise: '${error.message}'`;
     process.exitCode = 2;
@@ -192,7 +200,7 @@ async function authoriseGitPush(id) {
  * Reject git push by ID
  * @param {string} id The ID of the git push to reject
  */
-async function rejectGitPush(id) {
+async function rejectGitPush(id: string) {
   if (!fs.existsSync(GIT_PROXY_COOKIE_FILE)) {
     console.error('Error: Reject: Authentication required');
     process.exitCode = 1;
@@ -215,7 +223,7 @@ async function rejectGitPush(id) {
     );
 
     console.log(`Reject: ID: '${id}': OK`);
-  } catch (error) {
+  } catch (error: any) {
     // default error
     let errorMessage = `Error: Reject: '${error.message}'`;
     process.exitCode = 2;
@@ -239,7 +247,7 @@ async function rejectGitPush(id) {
  * Cancel git push by ID
  * @param {string} id The ID of the git push to cancel
  */
-async function cancelGitPush(id) {
+async function cancelGitPush(id: string) {
   if (!fs.existsSync(GIT_PROXY_COOKIE_FILE)) {
     console.error('Error: Cancel: Authentication required');
     process.exitCode = 1;
@@ -262,7 +270,7 @@ async function cancelGitPush(id) {
     );
 
     console.log(`Cancel: ID: '${id}': OK`);
-  } catch (error) {
+  } catch (error: any) {
     // default error
     let errorMessage = `Error: Cancel: '${error.message}'`;
     process.exitCode = 2;
@@ -299,7 +307,7 @@ async function logout() {
           headers: { Cookie: cookies },
         },
       );
-    } catch (error) {
+    } catch (error: any) {
       console.log(`Warning: Logout: '${error.message}'`);
     }
   }
@@ -323,7 +331,7 @@ async function reloadConfig() {
     await axios.post(`${baseUrl}/api/v1/admin/reload-config`, {}, { headers: { Cookie: cookies } });
 
     console.log('Configuration reloaded successfully');
-  } catch (error) {
+  } catch (error: any) {
     const errorMessage = `Error: Reload config: '${error.message}'`;
     process.exitCode = 2;
     console.error(errorMessage);
@@ -462,8 +470,10 @@ yargs(hideBin(process.argv)) // eslint-disable-line @typescript-eslint/no-unused
   })
   .command({
     command: 'reload-config',
-    description: 'Reload GitProxy configuration without restarting',
-    action: reloadConfig,
+    describe: 'Reload GitProxy configuration without restarting',
+    handler() {
+      reloadConfig();
+    },
   })
   .demandCommand(1, 'You need at least one command before moving on')
   .strict()