feat: allow for providing an alternative domain for the proxy

06kellyjac · 06kellyjac · commit f02b569abe02 · 2024-10-31T11:48:08.000Z
Have the service report back the proxyURL for each project, rather than
being embedded inside the frontend bundle.
Concequence is duplicating some data but very minor and allows for us to serve
different projects from different proxies in the future.
Removed unused vite env var, added method to pull service's current path and substitute
in the http proxy port. Works for local dev, should maintain current behaviour.
Custom domain can be applied via optional config.
New config value added to the config schema.
Config schema documentation has been regenerated (including some other absent items).
diff --git a/.env.development b/.env.development
@@ -1,2 +1 @@
 VITE_API_URI=http://localhost:8080
-VITE_SERVER_URI=http://localhost:8000
diff --git a/config.schema.json b/config.schema.json
@@ -20,6 +20,10 @@
       "description": "Customisable questions to add to attestation form",
       "type": "object"
     },
+    "domains": {
+      "description": "Provide domains to use alternative to the defaults",
+      "type": "object"
+    },
     "privateOrganizations": {
       "description": "Pattern searches for listed private organizations are disabled",
       "type": "array"
diff --git a/proxy.config.json b/proxy.config.json
@@ -92,6 +92,7 @@
       }
     ]
   },
+  "domains": {},
   "privateOrganizations": [],
   "urlShortener": "",
   "contactEmail": "",
diff --git a/src/config/index.js b/src/config/index.js
@@ -24,6 +24,7 @@ let _privateOrganizations = defaultSettings.privateOrganizations;
 let _urlShortener = defaultSettings.urlShortener;
 let _contactEmail = defaultSettings.contactEmail;
 let _csrfProtection = defaultSettings.csrfProtection;
+let _domains = defaultSettings.domains;
 
 // Get configured proxy URL
 const getProxyUrl = () => {
@@ -189,6 +190,13 @@ const getSSLCertPath = () => {
   return _sslCertPath;
 };
 
+const getDomains = () => {
+  if (_userSettings && _userSettings.domains) {
+    _domains = _userSettings.domains;
+  }
+  return _domains;
+};
+
 exports.getAPIs = getAPIs;
 exports.getProxyUrl = getProxyUrl;
 exports.getAuthorisedList = getAuthorisedList;
@@ -207,3 +215,4 @@ exports.getCSRFProtection = getCSRFProtection;
 exports.getPlugins = getPlugins;
 exports.getSSLKeyPath = getSSLKeyPath;
 exports.getSSLCertPath = getSSLCertPath;
+exports.getDomains = getDomains;
diff --git a/src/service/proxyURL.js b/src/service/proxyURL.js
@@ -0,0 +1,13 @@
+const { GIT_PROXY_SERVER_PORT: PROXY_HTTP_PORT, GIT_PROXY_UI_PORT: UI_PORT } =
+  require('../config/env').Vars;
+const config = require('../config');
+
+module.exports = {
+  getProxyURL: (req) => {
+    const defaultURL = `${req.protocol}://${req.headers.host}`.replace(
+      `:${UI_PORT}`,
+      `:${PROXY_HTTP_PORT}`,
+    );
+    return config.getDomains().proxy ?? defaultURL;
+  },
+};
diff --git a/src/service/routes/repo.js b/src/service/routes/repo.js
@@ -1,8 +1,10 @@
 const express = require('express');
 const router = new express.Router();
 const db = require('../../db');
+const { getProxyURL } = require('../proxyURL');
 
 router.get('/', async (req, res) => {
+  const proxyURL = getProxyURL(req);
   const query = {
     type: 'push',
   };
@@ -18,12 +20,15 @@ router.get('/', async (req, res) => {
     query[k] = v;
   }
 
-  res.send(await db.getRepos(query));
+  const qd = await db.getRepos(query);
+  res.send(qd.map((d) => ({ ...d, proxyURL })));
 });
 
 router.get('/:name', async (req, res) => {
+  const proxyURL = getProxyURL(req);
   const name = req.params.name;
-  res.send(await db.getRepo(name));
+  const qd = await db.getRepo(name);
+  res.send({ ...qd, proxyURL });
 });
 
 router.patch('/:name/user/push', async (req, res) => {
diff --git a/src/ui/views/RepoDetails/RepoDetails.jsx b/src/ui/views/RepoDetails/RepoDetails.jsx
@@ -59,8 +59,8 @@ export default function RepoDetails() {
   if (isLoading) return <div>Loading...</div>;
   if (isError) return <div>Something went wrong ...</div>;
 
-  const { project: org, name } = data || {};
-  const cloneURL = `${import.meta.env.VITE_SERVER_URI}/${org}/${name}.git`;
+  const { project: org, name, proxyURL } = data || {};
+  const cloneURL = `${proxyURL}/${org}/${name}.git`;
 
   return (
     <GridContainer>
diff --git a/src/ui/views/RepoList/Components/RepoOverview.jsx b/src/ui/views/RepoList/Components/RepoOverview.jsx
@@ -584,8 +584,8 @@ export default function Repositories(props) {
       });
   };
 
-  const { project: org, name } = props?.data || {};
-  const cloneURL = `${window.location.origin.toString()}/${org}/${name}.git`;
+  const { project: org, name, proxyURL } = props?.data || {};
+  const cloneURL = `${proxyURL}/${org}/${name}.git`;
 
   return (
     <TableRow>
diff --git a/website/docs/configuration/reference.mdx b/website/docs/configuration/reference.mdx
@@ -116,7 +116,25 @@ description: JSON schema reference documentation for GitProxy
 
 <details>
 <summary>
-<strong> <a name="privateOrganizations"></a>7. [Optional] Property GitProxy configuration file > privateOrganizations</strong>  
+<strong> <a name="domains"></a>7. [Optional] Property GitProxy configuration file > domains</strong>  
+
+</summary>
+<blockquote>
+
+|                           |                                                                           |
+| ------------------------- | ------------------------------------------------------------------------- |
+| **Type**                  | `object`                                                                  |
+| **Required**              | No                                                                        |
+| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
+
+**Description:** Provide domains to use alternative to the defaults
+
+</blockquote>
+</details>
+
+<details>
+<summary>
+<strong> <a name="privateOrganizations"></a>8. [Optional] Property GitProxy configuration file > privateOrganizations</strong>  
 
 </summary>
 <blockquote>
@@ -133,7 +151,7 @@ description: JSON schema reference documentation for GitProxy
 
 <details>
 <summary>
-<strong> <a name="urlShortener"></a>8. [Optional] Property GitProxy configuration file > urlShortener</strong>  
+<strong> <a name="urlShortener"></a>9. [Optional] Property GitProxy configuration file > urlShortener</strong>  
 
 </summary>
 <blockquote>
@@ -150,7 +168,7 @@ description: JSON schema reference documentation for GitProxy
 
 <details>
 <summary>
-<strong> <a name="contactEmail"></a>9. [Optional] Property GitProxy configuration file > contactEmail</strong>  
+<strong> <a name="contactEmail"></a>10. [Optional] Property GitProxy configuration file > contactEmail</strong>  
 
 </summary>
 <blockquote>
@@ -167,7 +185,7 @@ description: JSON schema reference documentation for GitProxy
 
 <details>
 <summary>
-<strong> <a name="csrfProtection"></a>10. [Optional] Property GitProxy configuration file > csrfProtection</strong>  
+<strong> <a name="csrfProtection"></a>11. [Optional] Property GitProxy configuration file > csrfProtection</strong>  
 
 </summary>
 <blockquote>
@@ -184,7 +202,7 @@ description: JSON schema reference documentation for GitProxy
 
 <details>
 <summary>
-<strong> <a name="plugins"></a>11. [Optional] Property GitProxy configuration file > plugins</strong>  
+<strong> <a name="plugins"></a>12. [Optional] Property GitProxy configuration file > plugins</strong>  
 
 </summary>
 <blockquote>
@@ -200,7 +218,7 @@ description: JSON schema reference documentation for GitProxy
 | ------------------------------- | ----------- |
 | [plugins items](#plugins_items) | -           |
 
-### <a name="autogenerated_heading_2"></a>11.1. GitProxy configuration file > plugins > plugins items
+### <a name="autogenerated_heading_2"></a>12.1. GitProxy configuration file > plugins > plugins items
 
 |              |          |
 | ------------ | -------- |
@@ -212,7 +230,7 @@ description: JSON schema reference documentation for GitProxy
 
 <details>
 <summary>
-<strong> <a name="authorisedList"></a>12. [Optional] Property GitProxy configuration file > authorisedList</strong>  
+<strong> <a name="authorisedList"></a>13. [Optional] Property GitProxy configuration file > authorisedList</strong>  
 
 </summary>
 <blockquote>
@@ -228,7 +246,7 @@ description: JSON schema reference documentation for GitProxy
 | --------------------------------------- | ----------- |
 | [authorisedRepo](#authorisedList_items) | -           |
 
-### <a name="autogenerated_heading_3"></a>12.1. GitProxy configuration file > authorisedList > authorisedRepo
+### <a name="autogenerated_heading_3"></a>13.1. GitProxy configuration file > authorisedList > authorisedRepo
 
 |                           |                                                                           |
 | ------------------------- | ------------------------------------------------------------------------- |
@@ -239,7 +257,7 @@ description: JSON schema reference documentation for GitProxy
 
 <details>
 <summary>
-<strong> <a name="authorisedList_items_project"></a>12.1.1. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > project</strong>  
+<strong> <a name="authorisedList_items_project"></a>13.1.1. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > project</strong>  
 
 </summary>
 <blockquote>
@@ -254,7 +272,7 @@ description: JSON schema reference documentation for GitProxy
 
 <details>
 <summary>
-<strong> <a name="authorisedList_items_name"></a>12.1.2. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > name</strong>  
+<strong> <a name="authorisedList_items_name"></a>13.1.2. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > name</strong>  
 
 </summary>
 <blockquote>
@@ -269,7 +287,7 @@ description: JSON schema reference documentation for GitProxy
 
 <details>
 <summary>
-<strong> <a name="authorisedList_items_url"></a>12.1.3. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > url</strong>  
+<strong> <a name="authorisedList_items_url"></a>13.1.3. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > url</strong>  
 
 </summary>
 <blockquote>
@@ -287,7 +305,7 @@ description: JSON schema reference documentation for GitProxy
 
 <details>
 <summary>
-<strong> <a name="sink"></a>13. [Optional] Property GitProxy configuration file > sink</strong>  
+<strong> <a name="sink"></a>14. [Optional] Property GitProxy configuration file > sink</strong>  
 
 </summary>
 <blockquote>
@@ -303,7 +321,7 @@ description: JSON schema reference documentation for GitProxy
 | ------------------------------- | ----------- |
 | [database](#sink_items)         | -           |
 
-### <a name="autogenerated_heading_4"></a>13.1. GitProxy configuration file > sink > database
+### <a name="autogenerated_heading_4"></a>14.1. GitProxy configuration file > sink > database
 
 |                           |                                                                           |
 | ------------------------- | ------------------------------------------------------------------------- |
@@ -314,7 +332,7 @@ description: JSON schema reference documentation for GitProxy
 
 <details>
 <summary>
-<strong> <a name="sink_items_type"></a>13.1.1. [Required] Property GitProxy configuration file > sink > sink items > type</strong>  
+<strong> <a name="sink_items_type"></a>14.1.1. [Required] Property GitProxy configuration file > sink > sink items > type</strong>  
 
 </summary>
 <blockquote>
@@ -329,7 +347,7 @@ description: JSON schema reference documentation for GitProxy
 
 <details>
 <summary>
-<strong> <a name="sink_items_enabled"></a>13.1.2. [Required] Property GitProxy configuration file > sink > sink items > enabled</strong>  
+<strong> <a name="sink_items_enabled"></a>14.1.2. [Required] Property GitProxy configuration file > sink > sink items > enabled</strong>  
 
 </summary>
 <blockquote>
@@ -344,7 +362,7 @@ description: JSON schema reference documentation for GitProxy
 
 <details>
 <summary>
-<strong> <a name="sink_items_connectionString"></a>13.1.3. [Optional] Property GitProxy configuration file > sink > sink items > connectionString</strong>  
+<strong> <a name="sink_items_connectionString"></a>14.1.3. [Optional] Property GitProxy configuration file > sink > sink items > connectionString</strong>  
 
 </summary>
 <blockquote>
@@ -359,7 +377,7 @@ description: JSON schema reference documentation for GitProxy
 
 <details>
 <summary>
-<strong> <a name="sink_items_options"></a>13.1.4. [Optional] Property GitProxy configuration file > sink > sink items > options</strong>  
+<strong> <a name="sink_items_options"></a>14.1.4. [Optional] Property GitProxy configuration file > sink > sink items > options</strong>  
 
 </summary>
 <blockquote>
@@ -375,7 +393,7 @@ description: JSON schema reference documentation for GitProxy
 
 <details>
 <summary>
-<strong> <a name="sink_items_params"></a>13.1.5. [Optional] Property GitProxy configuration file > sink > sink items > params</strong>  
+<strong> <a name="sink_items_params"></a>14.1.5. [Optional] Property GitProxy configuration file > sink > sink items > params</strong>  
 
 </summary>
 <blockquote>
@@ -394,7 +412,7 @@ description: JSON schema reference documentation for GitProxy
 
 <details>
 <summary>
-<strong> <a name="authentication"></a>14. [Optional] Property GitProxy configuration file > authentication</strong>  
+<strong> <a name="authentication"></a>15. [Optional] Property GitProxy configuration file > authentication</strong>  
 
 </summary>
 <blockquote>
@@ -410,7 +428,7 @@ description: JSON schema reference documentation for GitProxy
 | --------------------------------------- | ----------- |
 | [authentication](#authentication_items) | -           |
 
-### <a name="autogenerated_heading_5"></a>14.1. GitProxy configuration file > authentication > authentication
+### <a name="autogenerated_heading_5"></a>15.1. GitProxy configuration file > authentication > authentication
 
 |                           |                                                                           |
 | ------------------------- | ------------------------------------------------------------------------- |
@@ -421,7 +439,7 @@ description: JSON schema reference documentation for GitProxy
 
 <details>
 <summary>
-<strong> <a name="authentication_items_type"></a>14.1.1. [Required] Property GitProxy configuration file > authentication > authentication items > type</strong>  
+<strong> <a name="authentication_items_type"></a>15.1.1. [Required] Property GitProxy configuration file > authentication > authentication items > type</strong>  
 
 </summary>
 <blockquote>
@@ -436,7 +454,7 @@ description: JSON schema reference documentation for GitProxy
 
 <details>
 <summary>
-<strong> <a name="authentication_items_enabled"></a>14.1.2. [Required] Property GitProxy configuration file > authentication > authentication items > enabled</strong>  
+<strong> <a name="authentication_items_enabled"></a>15.1.2. [Required] Property GitProxy configuration file > authentication > authentication items > enabled</strong>  
 
 </summary>
 <blockquote>
@@ -451,7 +469,7 @@ description: JSON schema reference documentation for GitProxy
 
 <details>
 <summary>
-<strong> <a name="authentication_items_options"></a>14.1.3. [Optional] Property GitProxy configuration file > authentication > authentication items > options</strong>  
+<strong> <a name="authentication_items_options"></a>15.1.3. [Optional] Property GitProxy configuration file > authentication > authentication items > options</strong>  
 
 </summary>
 <blockquote>
@@ -470,7 +488,7 @@ description: JSON schema reference documentation for GitProxy
 
 <details>
 <summary>
-<strong> <a name="tempPassword"></a>15. [Optional] Property GitProxy configuration file > tempPassword</strong>  
+<strong> <a name="tempPassword"></a>16. [Optional] Property GitProxy configuration file > tempPassword</strong>  
 
 </summary>
 <blockquote>
@@ -485,7 +503,7 @@ description: JSON schema reference documentation for GitProxy
 
 <details>
 <summary>
-<strong> <a name="tempPassword_sendEmail"></a>15.1. [Optional] Property GitProxy configuration file > tempPassword > sendEmail</strong>  
+<strong> <a name="tempPassword_sendEmail"></a>16.1. [Optional] Property GitProxy configuration file > tempPassword > sendEmail</strong>  
 
 </summary>
 <blockquote>
@@ -500,7 +518,7 @@ description: JSON schema reference documentation for GitProxy
 
 <details>
 <summary>
-<strong> <a name="tempPassword_emailConfig"></a>15.2. [Optional] Property GitProxy configuration file > tempPassword > emailConfig</strong>  
+<strong> <a name="tempPassword_emailConfig"></a>16.2. [Optional] Property GitProxy configuration file > tempPassword > emailConfig</strong>  
 
 </summary>
 <blockquote>
@@ -520,4 +538,4 @@ description: JSON schema reference documentation for GitProxy
 </details>
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2024-10-02 at 13:21:09 -0400
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2024-10-22 at 16:44:20 +0100

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1 @@`
`1`	`1`	`VITE_API_URI=http://localhost:8080`
`2`		`-VITE_SERVER_URI=http://localhost:8000`
Original file line number	Diff line number	Diff line change
`@@ -92,6 +92,7 @@`
`92`	`92`	`}`
`93`	`93`	`]`
`94`	`94`	`},`
	`95`	`+ "domains": {},`
`95`	`96`	`"privateOrganizations": [],`
`96`	`97`	`"urlShortener": "",`
`97`	`98`	`"contactEmail": "",`