Merge pull request #1043 from kriswest/950-key-on-repo-urls

feat(key on repo url): support git hosts other than GitHub + multiple forks

Author: jescalada

config.schema.json

@@ -5,7 +5,11 @@
   "description": "Configuration for customizing git-proxy",
   "type": "object",
   "properties": {
-    "proxyUrl": { "type": "string" },
+    "proxyUrl": {
+      "type": "string",
+      "description": "Used in early versions of git proxy to configure the remote host that traffic is proxied to. In later versions, the repository URL is used to determine the domain proxied, allowing multiple hosts to be proxied by one instance.",
+      "deprecated": true
+    },
     "cookieSecret": { "type": "string" },
     "sessionMaxAgeHours": { "type": "number" },
     "api": {

cypress/e2e/repo.cy.js

@@ -10,7 +10,7 @@ describe('Repo', () => {
 
   describe('Code button for repo row', () => {
     it('Opens tooltip with correct content and can copy', () => {
-      const cloneURL = 'http://localhost:8000/finos/git-proxy.git';
+      const cloneURLRegex = /http:\/\/localhost:8000\/(?:[^\/]+\/).+\.git/;
       const tooltipQuery = 'div[role="tooltip"]';
 
       cy
@@ -19,10 +19,8 @@ describe('Repo', () => {
         .should('not.exist');
 
       cy
-        // find the entry for finos/git-proxy
-        .get('a[href="/dashboard/repo/git-proxy"]')
-        // take it's parent row
-        .closest('tr')
+        // find a table row for a repo (any will do)
+        .get('table#RepoListTable>tbody>tr')
         // find the nearby span containing Code we can click to open the tooltip
         .find('span')
         .contains('Code')
@@ -35,7 +33,7 @@ describe('Repo', () => {
         .should('exist')
         .find('span')
         // check it contains the url we expect
-        .contains(cloneURL)
+        .contains(cloneURLRegex)
         .should('exist')
         .parent()
         // find the adjacent span that contains the svg

index.ts

@@ -6,7 +6,7 @@ import { hideBin } from 'yargs/helpers';
 import * as fs from 'fs';
 import { configFile, setConfigFile, validate } from './src/config/file';
 import { initUserConfig } from './src/config';
-import proxy from './src/proxy';
+import Proxy from './src/proxy';
 import service from './src/service';
 
 const argv = yargs(hideBin(process.argv))
@@ -30,7 +30,7 @@ const argv = yargs(hideBin(process.argv))
   .strict()
   .parseSync();
 
-setConfigFile(argv.c as string || "");
+setConfigFile((argv.c as string) || '');
 initUserConfig();
 
 if (argv.v) {
@@ -48,7 +48,8 @@ if (argv.v) {
 
 validate();
 
+const proxy = new Proxy();
 proxy.start();
-service.start();
+service.start(proxy);
 
 export { proxy, service };

packages/git-proxy-cli/test/testCli.test.js

@@ -221,13 +221,13 @@ describe('test git-proxy-cli', function () {
     before(async function () {
       await helper.addRepoToDb(TEST_REPO_CONFIG);
       await helper.addUserToDb(TEST_USER, TEST_PASSWORD, TEST_EMAIL, TEST_GIT_ACCOUNT);
-      await helper.addGitPushToDb(pushId, TEST_USER, TEST_EMAIL, TEST_REPO);
+      await helper.addGitPushToDb(pushId, TEST_REPO_CONFIG.url, TEST_USER, TEST_EMAIL);
     });
 
     after(async function () {
       await helper.removeGitPushFromDb(pushId);
       await helper.removeUserFromDb(TEST_USER);
-      await helper.removeRepoFromDb(TEST_REPO_CONFIG.name);
+      await helper.removeRepoFromDb(TEST_REPO_CONFIG.url);
     });
 
     it('attempt to authorise should fail when server is down', async function () {
@@ -304,7 +304,7 @@ describe('test git-proxy-cli', function () {
     after(async function () {
       await helper.removeGitPushFromDb(pushId);
       await helper.removeUserFromDb(TEST_USER);
-      await helper.removeRepoFromDb(TEST_REPO_CONFIG.name);
+      await helper.removeRepoFromDb(TEST_REPO_CONFIG.url);
     });
 
     it('attempt to cancel should fail when server is down', async function () {
@@ -421,13 +421,13 @@ describe('test git-proxy-cli', function () {
     before(async function () {
       await helper.addRepoToDb(TEST_REPO_CONFIG);
       await helper.addUserToDb(TEST_USER, TEST_PASSWORD, TEST_EMAIL, TEST_GIT_ACCOUNT);
-      await helper.addGitPushToDb(pushId, TEST_USER, TEST_EMAIL, TEST_REPO);
+      await helper.addGitPushToDb(pushId, TEST_REPO_CONFIG.url, TEST_USER, TEST_EMAIL);
     });
 
     after(async function () {
       await helper.removeGitPushFromDb(pushId);
       await helper.removeUserFromDb(TEST_USER);
-      await helper.removeRepoFromDb(TEST_REPO_CONFIG.name);
+      await helper.removeRepoFromDb(TEST_REPO_CONFIG.url);
     });
 
     it('attempt to reject should fail when server is down', async function () {
@@ -498,19 +498,13 @@ describe('test git-proxy-cli', function () {
     before(async function () {
       await helper.addRepoToDb(TEST_REPO_CONFIG);
       await helper.addUserToDb(TEST_USER, TEST_PASSWORD, TEST_EMAIL, TEST_GIT_ACCOUNT);
-      await helper.addGitPushToDb(pushId, TEST_REPO, TEST_USER, TEST_EMAIL);
+      await helper.addGitPushToDb(pushId, TEST_REPO_CONFIG.url, TEST_USER, TEST_EMAIL);
     });
 
     after(async function () {
       await helper.removeGitPushFromDb(pushId);
       await helper.removeUserFromDb(TEST_USER);
-      await helper.removeRepoFromDb(TEST_REPO_CONFIG.name);
-    });
-
-    after(async function () {
-      await helper.removeUserFromDb('testuser1');
-      await helper.removeGitPushFromDb(pushId);
-      await helper.removeRepoFromDb(TEST_REPO_CONFIG.name);
+      await helper.removeRepoFromDb(TEST_REPO_CONFIG.url);
     });
 
     it('attempt to ls should list existing push', async function () {

packages/git-proxy-cli/test/testCliUtils.js

@@ -30,7 +30,7 @@ async function runCli(
   expectedExitCode = 0,
   expectedMessages = null,
   expectedErrorMessages = null,
-  debug = false,
+  debug = true,
 ) {
   try {
     console.log(`cli: '${cli}'`);
@@ -152,8 +152,9 @@ async function addRepoToDb(newRepo, debug = false) {
   const found = repos.find((y) => y.project === newRepo.project && newRepo.name === y.name);
   if (!found) {
     await db.createRepo(newRepo);
-    await db.addUserCanPush(newRepo.name, 'admin');
-    await db.addUserCanAuthorise(newRepo.name, 'admin');
+    const repo = await db.getRepoByUrl(newRepo.url);
+    await db.addUserCanPush(repo._id, 'admin');
+    await db.addUserCanAuthorise(repo._id, 'admin');
     if (debug) {
       console.log(`New repo added to database: ${newRepo}`);
     }
@@ -166,27 +167,28 @@ async function addRepoToDb(newRepo, debug = false) {
 
 /**
  * Removes a repo from the DB.
- * @param {string} repoName  The name of the repo to remove.
+ * @param {string} repoUrl  The url of the repo to remove.
  */
-async function removeRepoFromDb(repoName) {
-  await db.deleteRepo(repoName);
+async function removeRepoFromDb(repoUrl) {
+  const repo = await db.getRepoByUrl(repoUrl);
+  await db.deleteRepo(repo._id);
 }
 
 /**
  * Add a new git push record to the database.
  * @param {string} id The ID of the git push.
- * @param {string} repo The repository of the git push.
+ * @param {string} repoUrl The repository URL of the git push.
  * @param {string} user The user who pushed the git push.
  * @param {string} userEmail The email of the user who pushed the git push.
  * @param {boolean} debug Flag to enable logging for debugging.
  */
-async function addGitPushToDb(id, repo, user = null, userEmail = null, debug = false) {
+async function addGitPushToDb(id, repoUrl, user = null, userEmail = null, debug = false) {
   const action = new actions.Action(
     id,
     'push', // type
     'get', // method
     Date.now(), // timestamp
-    repo,
+    repoUrl,
   );
   action.user = user;
   action.userEmail = userEmail;

proxy.config.json

@@ -1,5 +1,4 @@
 {
-  "proxyUrl": "https://github.com",
   "cookieSecret": "cookie secret",
   "sessionMaxAgeHours": 12,
   "rateLimit": {

src/config/index.ts

@@ -28,7 +28,6 @@ let _database: Database[] = defaultSettings.sink;
 let _authentication: Authentication[] = defaultSettings.authentication;
 let _apiAuthentication: Authentication[] = defaultSettings.apiAuthentication;
 let _tempPassword: TempPasswordConfig = defaultSettings.tempPassword;
-let _proxyUrl = defaultSettings.proxyUrl;
 let _api: Record<string, unknown> = defaultSettings.api;
 let _cookieSecret: string = serverConfig.GIT_PROXY_COOKIE_SECRET || defaultSettings.cookieSecret;
 let _sessionMaxAgeHours: number = defaultSettings.sessionMaxAgeHours;
@@ -54,15 +53,6 @@ let _config = { ...defaultSettings, ...(_userSettings || {}) } as Configuration;
 // Create config loader instance
 const configLoader = new ConfigLoader(_config);
 
-// Get configured proxy URL
-export const getProxyUrl = () => {
-  if (_userSettings !== null && _userSettings.proxyUrl) {
-    _proxyUrl = _userSettings.proxyUrl;
-  }
-
-  return _proxyUrl;
-};
-
 // Gets a list of authorised repositories
 export const getAuthorisedList = () => {
   if (_userSettings !== null && _userSettings.authorisedList) {

src/db/file/index.ts

@@ -2,29 +2,27 @@ import * as users from './users';
 import * as repo from './repo';
 import * as pushes from './pushes';
 
-export const {
-  getPushes,
-  writeAudit,
-  getPush,
-  deletePush,
-  authorise,
-  cancel,
-  reject,
-  canUserCancelPush,
-  canUserApproveRejectPush,
-} = pushes;
+export const { getPushes, writeAudit, getPush, deletePush, authorise, cancel, reject } = pushes;
 
 export const {
   getRepos,
   getRepo,
+  getRepoByUrl,
+  getRepoById,
   createRepo,
   addUserCanPush,
   addUserCanAuthorise,
   removeUserCanPush,
   removeUserCanAuthorise,
   deleteRepo,
-  isUserPushAllowed,
-  canUserApproveRejectPushRepo,
 } = repo;
 
-export const { findUser, findUserByOIDC, getUsers, createUser, deleteUser, updateUser } = users;
+export const {
+  findUser,
+  findUserByEmail,
+  findUserByOIDC,
+  getUsers,
+  createUser,
+  deleteUser,
+  updateUser,
+} = users;