Merge pull request #1086 from RBC/feat/mongo-env

feat: mongo connection string & cookie secret from env vars

Author: JamieSlome

src/config/env.ts

@@ -3,18 +3,24 @@ export type ServerConfig = {
   GIT_PROXY_HTTPS_SERVER_PORT: string | number;
   GIT_PROXY_UI_HOST: string;
   GIT_PROXY_UI_PORT: string | number;
+  GIT_PROXY_COOKIE_SECRET: string | undefined;
+  GIT_PROXY_MONGO_CONNECTION_STRING: string;
 };
 
 const {
   GIT_PROXY_SERVER_PORT = 8000,
   GIT_PROXY_HTTPS_SERVER_PORT = 8443,
   GIT_PROXY_UI_HOST = 'http://localhost',
   GIT_PROXY_UI_PORT = 8080,
+  GIT_PROXY_COOKIE_SECRET,
+  GIT_PROXY_MONGO_CONNECTION_STRING = 'mongodb://localhost:27017/git-proxy',
 } = process.env;
 
 export const serverConfig: ServerConfig = {
   GIT_PROXY_SERVER_PORT,
   GIT_PROXY_HTTPS_SERVER_PORT,
   GIT_PROXY_UI_HOST,
   GIT_PROXY_UI_PORT,
+  GIT_PROXY_COOKIE_SECRET,
+  GIT_PROXY_MONGO_CONNECTION_STRING,
 };

src/config/index.ts

@@ -1,6 +1,7 @@
 import { existsSync, readFileSync } from 'fs';
 
 import defaultSettings from '../../proxy.config.json';
+import { serverConfig } from './env';
 import { configFile, validate } from './file';
 import { ConfigLoader, Configuration } from './ConfigLoader';
 import {
@@ -23,7 +24,7 @@ let _apiAuthentication: Authentication[] = defaultSettings.apiAuthentication;
 let _tempPassword: TempPasswordConfig = defaultSettings.tempPassword;
 let _proxyUrl = defaultSettings.proxyUrl;
 let _api: Record<string, unknown> = defaultSettings.api;
-let _cookieSecret: string = defaultSettings.cookieSecret;
+let _cookieSecret: string = serverConfig.GIT_PROXY_COOKIE_SECRET || defaultSettings.cookieSecret;
 let _sessionMaxAgeHours: number = defaultSettings.sessionMaxAgeHours;
 let _plugins: any[] = defaultSettings.plugins;
 let _commitConfig: Record<string, any> = defaultSettings.commitConfig;
@@ -82,6 +83,10 @@ export const getDatabase = () => {
     if (ix) {
       const db = _database[ix];
       if (db.enabled) {
+        // if mongodb is configured and connection string unspecified, fallback to env var
+        if (db.type === 'mongo' && !db.connectionString) {
+          db.connectionString = serverConfig.GIT_PROXY_MONGO_CONNECTION_STRING;
+        }
         return db;
       }
     }
@@ -92,7 +97,7 @@ export const getDatabase = () => {
 
 /**
  * Get the list of enabled authentication methods
- * 
+ *
  * At least one authentication method must be enabled.
  * @return {Authentication[]} List of enabled authentication methods
  */
@@ -104,15 +109,15 @@ export const getAuthMethods = (): Authentication[] => {
   const enabledAuthMethods = _authentication.filter((auth) => auth.enabled);
 
   if (enabledAuthMethods.length === 0) {
-    throw new Error("No authentication method enabled");
+    throw new Error('No authentication method enabled');
   }
 
   return enabledAuthMethods;
 };
 
 /**
  * Get the list of enabled authentication methods for API endpoints
- * 
+ *
  * If no API authentication methods are enabled, all endpoints are public.
  * @return {Authentication[]} List of enabled authentication methods
  */
@@ -121,10 +126,10 @@ export const getAPIAuthMethods = (): Authentication[] => {
     _apiAuthentication = _userSettings.apiAuthentication;
   }
 
-  const enabledAuthMethods = _apiAuthentication.filter(auth => auth.enabled);
+  const enabledAuthMethods = _apiAuthentication.filter((auth) => auth.enabled);
 
   if (enabledAuthMethods.length === 0) {
-    console.log("Warning: No authentication method enabled for API endpoints.");
+    console.log('Warning: No authentication method enabled for API endpoints.');
   }
 
   return enabledAuthMethods;

test/testConfig.test.js

@@ -37,8 +37,11 @@ describe('default configuration', function () {
 describe('user configuration', function () {
   let tempDir;
   let tempUserFile;
+  let oldEnv;
 
   beforeEach(function () {
+    delete require.cache[require.resolve('../src/config/env')];
+    oldEnv = { ...process.env };
     tempDir = fs.mkdtempSync('gitproxy-test');
     tempUserFile = path.join(tempDir, 'test-settings.json');
     require('../src/config/file').configFile = tempUserFile;
@@ -258,9 +261,34 @@ describe('user configuration', function () {
     expect(config.getAPIs()).to.be.eql(user.api);
   });
 
+  it('should override default settings for cookieSecret if env var is used', function () {
+    fs.writeFileSync(tempUserFile, '{}');
+    process.env.GIT_PROXY_COOKIE_SECRET = 'test-cookie-secret'
+
+    const config = require('../src/config');
+    expect(config.getCookieSecret()).to.equal('test-cookie-secret');
+  });
+
+  it('should override default settings for mongo connection string if env var is used', function () {
+    const user = {
+      sink: [
+        {
+          type: 'mongo',
+          enabled: true,
+        }
+      ]
+    };
+    fs.writeFileSync(tempUserFile, JSON.stringify(user));
+    process.env.GIT_PROXY_MONGO_CONNECTION_STRING = 'mongodb://example.com:27017/test';
+
+    const config = require('../src/config');
+    expect(config.getDatabase().connectionString).to.equal('mongodb://example.com:27017/test');
+  });
+
   afterEach(function () {
     fs.rmSync(tempUserFile);
     fs.rmdirSync(tempDir);
+    process.env = oldEnv;
     delete require.cache[require.resolve('../src/config')];
   });
 });