Merge pull request #1275 from finos/1193-consolidate-ts-types

refactor: consolidate TS types

Author: jescalada

config.schema.json

@@ -196,7 +196,14 @@
                   },
                   "links": {
                     "type": "array",
-                    "items": { "type": "string", "format": "url" }
+                    "items": {
+                      "type": "object",
+                      "additionalProperties": false,
+                      "properties": {
+                        "text": { "type": "string" },
+                        "url": { "type": "string", "format": "url" }
+                      }
+                    }
                   }
                 },
                 "required": ["text"]
@@ -466,7 +473,14 @@
               "description": "Additional JWT configuration.",
               "properties": {
                 "clientID": { "type": "string" },
-                "authorityURL": { "type": "string" }
+                "authorityURL": { "type": "string" },
+                "expectedAudience": { "type": "string" },
+                "roleMapping": {
+                  "type": "object",
+                  "properties": {
+                    "admin": { "type": "object" }
+                  }
+                }
               },
               "required": ["clientID", "authorityURL"]
             }

package.json

@@ -20,20 +20,25 @@
       "require": "./dist/src/db/index.js",
       "types": "./dist/src/db/index.d.ts"
     },
+    "./plugin": {
+      "import": "./dist/src/plugin.js",
+      "require": "./dist/src/plugin.js",
+      "types": "./dist/src/plugin.d.ts"
+    },
     "./proxy": {
       "import": "./dist/src/proxy/index.js",
       "require": "./dist/src/proxy/index.js",
       "types": "./dist/src/proxy/index.d.ts"
     },
-    "./types": {
-      "import": "./dist/src/types/models.js",
-      "require": "./dist/src/types/models.js",
-      "types": "./dist/src/types/models.d.ts"
+    "./proxy/actions": {
+      "import": "./dist/src/proxy/actions/index.js",
+      "require": "./dist/src/proxy/actions/index.js",
+      "types": "./dist/src/proxy/actions/index.d.ts"
     },
-    "./plugin": {
-      "import": "./dist/src/plugin.js",
-      "require": "./dist/src/plugin.js",
-      "types": "./dist/src/plugin.d.ts"
+    "./ui": {
+      "import": "./dist/src/ui/index.js",
+      "require": "./dist/src/ui/index.js",
+      "types": "./dist/src/ui/index.d.ts"
     }
   },
   "scripts": {

packages/git-proxy-cli/index.ts

@@ -5,8 +5,8 @@ import { hideBin } from 'yargs/helpers';
 import fs from 'fs';
 import util from 'util';
 
-import { CommitData, PushData } from '@finos/git-proxy/types';
 import { PushQuery } from '@finos/git-proxy/db';
+import { Action } from '@finos/git-proxy/proxy/actions';
 
 const GIT_PROXY_COOKIE_FILE = 'git-proxy-cookie';
 // GitProxy UI HOST and PORT (configurable via environment variable)
@@ -88,74 +88,86 @@ async function getGitPushes(filters: Partial<PushQuery>) {
 
   try {
     const cookies = JSON.parse(fs.readFileSync(GIT_PROXY_COOKIE_FILE, 'utf8'));
-
-    const response = await axios.get(`${baseUrl}/api/v1/push/`, {
+    const { data } = await axios.get<Action[]>(`${baseUrl}/api/v1/push/`, {
       headers: { Cookie: cookies },
       params: filters,
     });
 
-    const records: PushData[] = [];
-    response.data.forEach((push: PushData) => {
-      const record: PushData = {
-        id: push.id,
-        repo: push.repo,
-        branch: push.branch,
-        commitFrom: push.commitFrom,
-        commitTo: push.commitTo,
-        commitData: push.commitData,
-        diff: push.diff,
-        error: push.error,
-        canceled: push.canceled,
-        rejected: push.rejected,
-        blocked: push.blocked,
-        authorised: push.authorised,
-        attestation: push.attestation,
-        autoApproved: push.autoApproved,
-        timestamp: push.timestamp,
-        url: push.url,
-        allowPush: push.allowPush,
+    const records = data.map((push: Action) => {
+      const {
+        id,
+        repo,
+        branch,
+        commitFrom,
+        commitTo,
+        commitData,
+        error,
+        canceled,
+        rejected,
+        blocked,
+        authorised,
+        attestation,
+        autoApproved,
+        timestamp,
+        url,
+        allowPush,
+        lastStep,
+      } = push;
+
+      return {
+        id,
+        repo,
+        branch,
+        commitFrom,
+        commitTo,
+        commitData: commitData?.map(
+          ({
+            message,
+            committer,
+            committerEmail,
+            author,
+            authorEmail,
+            commitTimestamp,
+            tree,
+            parent,
+          }) => ({
+            message,
+            committer,
+            committerEmail,
+            author,
+            authorEmail,
+            commitTimestamp,
+            tree,
+            parent,
+          }),
+        ),
+        error,
+        canceled,
+        rejected,
+        blocked,
+        authorised,
+        attestation,
+        autoApproved,
+        timestamp,
+        url,
+        allowPush,
+        lastStep: lastStep && {
+          id: lastStep.id,
+          content: lastStep.content,
+          logs: lastStep.logs,
+          stepName: lastStep.stepName,
+          error: lastStep.error,
+          errorMessage: lastStep.errorMessage,
+          blocked: lastStep.blocked,
+          blockedMessage: lastStep.blockedMessage,
+        },
       };
-
-      if (push.lastStep) {
-        record.lastStep = {
-          id: push.lastStep?.id,
-          content: push.lastStep?.content,
-          logs: push.lastStep?.logs,
-          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,
-            committerEmail: pushCommitDataRecord.committerEmail,
-            author: pushCommitDataRecord.author,
-            authorEmail: pushCommitDataRecord.authorEmail,
-            commitTimestamp: pushCommitDataRecord.commitTimestamp,
-            tree: pushCommitDataRecord.tree,
-            parent: pushCommitDataRecord.parent,
-            commitTs: pushCommitDataRecord.commitTs,
-          });
-        });
-        record.commitData = commitData;
-      }
-
-      records.push(record);
     });
 
-    console.log(`${util.inspect(records, false, null, false)}`);
+    console.log(util.inspect(records, false, null, false));
   } catch (error: any) {
-    // default error
-    const errorMessage = `Error: List: '${error.message}'`;
+    console.error(`Error: List: '${error.message}'`);
     process.exitCode = 2;
-    console.error(errorMessage);
   }
 }
 

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

@@ -221,7 +221,6 @@ async function addGitPushToDb(
     parent: 'parent',
     author: 'author',
     committer: 'committer',
-    commitTs: 'commitTs',
     message: 'message',
     authorEmail: 'authorEmail',
     committerEmail: 'committerEmail',

src/config/ConfigLoader.ts

@@ -6,57 +6,10 @@ import { promisify } from 'util';
 import { EventEmitter } from 'events';
 import envPaths from 'env-paths';
 import { GitProxyConfig, Convert } from './generated/config';
+import { Configuration, ConfigurationSource, FileSource, HttpSource, GitSource } from './types';
 
 const execFileAsync = promisify(execFile);
 
-interface GitAuth {
-  type: 'ssh';
-  privateKeyPath: string;
-}
-
-interface HttpAuth {
-  type: 'bearer';
-  token: string;
-}
-
-interface BaseSource {
-  type: 'file' | 'http' | 'git';
-  enabled: boolean;
-}
-
-interface FileSource extends BaseSource {
-  type: 'file';
-  path: string;
-}
-
-interface HttpSource extends BaseSource {
-  type: 'http';
-  url: string;
-  headers?: Record<string, string>;
-  auth?: HttpAuth;
-}
-
-interface GitSource extends BaseSource {
-  type: 'git';
-  repository: string;
-  branch?: string;
-  path: string;
-  auth?: GitAuth;
-}
-
-type ConfigurationSource = FileSource | HttpSource | GitSource;
-
-export interface ConfigurationSources {
-  enabled: boolean;
-  sources: ConfigurationSource[];
-  reloadIntervalSeconds: number;
-  merge?: boolean;
-}
-
-export interface Configuration extends GitProxyConfig {
-  configurationSources?: ConfigurationSources;
-}
-
 // Add path validation helper
 function isValidPath(filePath: string): boolean {
   if (!filePath || typeof filePath !== 'string') return false;

src/config/env.ts

@@ -1,11 +1,4 @@
-export type ServerConfig = {
-  GIT_PROXY_SERVER_PORT: string | number;
-  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;
-};
+import { ServerConfig } from './types';
 
 const {
   GIT_PROXY_SERVER_PORT = 8000,

src/config/generated/config.ts

@@ -225,6 +225,13 @@ export interface AdConfig {
 export interface JwtConfig {
   authorityURL: string;
   clientID: string;
+  expectedAudience?: string;
+  roleMapping?: RoleMapping;
+  [property: string]: any;
+}
+
+export interface RoleMapping {
+  admin?: { [key: string]: any };
   [property: string]: any;
 }
 
@@ -275,10 +282,15 @@ export interface Question {
  * and used to provide additional guidance to the reviewer.
  */
 export interface QuestionTooltip {
-  links?: string[];
+  links?: Link[];
   text: string;
 }
 
+export interface Link {
+  text?: string;
+  url?: string;
+}
+
 export interface AuthorisedRepo {
   name: string;
   project: string;
@@ -754,9 +766,12 @@ const typeMap: any = {
     [
       { json: 'authorityURL', js: 'authorityURL', typ: '' },
       { json: 'clientID', js: 'clientID', typ: '' },
+      { json: 'expectedAudience', js: 'expectedAudience', typ: u(undefined, '') },
+      { json: 'roleMapping', js: 'roleMapping', typ: u(undefined, r('RoleMapping')) },
     ],
     'any',
   ),
+  RoleMapping: o([{ json: 'admin', js: 'admin', typ: u(undefined, m('any')) }], 'any'),
   OidcConfig: o(
     [
       { json: 'callbackURL', js: 'callbackURL', typ: '' },
@@ -780,11 +795,18 @@ const typeMap: any = {
   ),
   QuestionTooltip: o(
     [
-      { json: 'links', js: 'links', typ: u(undefined, a('')) },
+      { json: 'links', js: 'links', typ: u(undefined, a(r('Link'))) },
       { json: 'text', js: 'text', typ: '' },
     ],
     false,
   ),
+  Link: o(
+    [
+      { json: 'text', js: 'text', typ: u(undefined, '') },
+      { json: 'url', js: 'url', typ: u(undefined, '') },
+    ],
+    false,
+  ),
   AuthorisedRepo: o(
     [
       { json: 'name', js: 'name', typ: '' },

src/config/index.ts

@@ -2,7 +2,8 @@ import { existsSync, readFileSync } from 'fs';
 
 import defaultSettings from '../../proxy.config.json';
 import { GitProxyConfig, Convert } from './generated/config';
-import { ConfigLoader, Configuration } from './ConfigLoader';
+import { ConfigLoader } from './ConfigLoader';
+import { Configuration } from './types';
 import { serverConfig } from './env';
 import { configFile } from './file';