feat: allow to filter git log

Author: manfredsteyer

apps/backend/src/infrastructure/config.ts

@@ -9,6 +9,7 @@ const initConfig: Config = {
   scopes: [],
   groups: [],
   entries: [],
+  filter: [],
   teams: {
     'example-team-a': ['John Doe', 'Jane Doe'],
     'example-team-b': ['Max Muster', 'Susi Sorglos'],

apps/backend/src/infrastructure/git.ts

@@ -51,7 +51,11 @@ export function getCommitCount(): string {
 export function getGitLog(limits = noLimits): Promise<string> {
   return new Promise<string>((resolve, reject) => {
     try {
-      const args = ['log', '--numstat', '--pretty=format:"%an <%ae>,%ad"'];
+      const args = [
+        'log',
+        '--numstat',
+        '--pretty=format:"%an <%ae>,%ad%x09%H,%s"',
+      ];
 
       if (limits.limitCommits) {
         args.push('-n ' + limits.limitCommits);

apps/backend/src/model/config.ts

@@ -1,6 +1,7 @@
 export type Config = {
   scopes: string[];
   groups: string[];
+  filter: string[];
   teams: Record<string, string[]>;
   entries: [];
 };
@@ -10,4 +11,5 @@ export const emptyConfig: Config = {
   groups: [],
   teams: {},
   entries: [],
+  filter: [],
 };

apps/backend/src/services/change-coupling.ts

@@ -1,7 +1,7 @@
 import { loadConfig } from '../infrastructure/config';
 import { Limits } from '../model/limits';
 import { Options } from '../options/options';
-import { parseGitLog } from '../utils/git-parser';
+import { parseGitLog, ParseOptions } from '../utils/git-parser';
 import { getEmptyMatrix } from '../utils/matrix';
 import { normalizeFolder } from '../utils/normalize-folder';
 
@@ -27,6 +27,11 @@ export async function calcChangeCoupling(
 
   const commitsPerModule: number[] = new Array(matrix.length).fill(0);
 
+  const parseOptions: ParseOptions = {
+    limits,
+    filter: config.filter,
+  };
+
   await parseGitLog((entry) => {
     const touchedModules = new Set<number>();
     for (const change of entry.body) {
@@ -39,7 +44,7 @@ export async function calcChangeCoupling(
       }
     }
     addToMatrix(touchedModules, matrix);
-  }, limits);
+  }, parseOptions);
 
   return {
     matrix,

apps/backend/src/services/hotspot.ts

@@ -2,13 +2,14 @@ import path from 'path';
 import * as fs from 'fs';
 
 import { Options } from '../options/options';
-import { LogBodyEntry, parseGitLog } from '../utils/git-parser';
+import { LogBodyEntry, parseGitLog, ParseOptions } from '../utils/git-parser';
 import { loadConfig } from '../infrastructure/config';
 import { normalizeFolder, toDisplayFolder } from '../utils/normalize-folder';
 import { Limits } from '../model/limits';
 
 import { calcCyclomaticComplexity } from '../utils/complexity';
 import { countLinesInFile } from '../utils/count-lines';
+import { Config } from '../model/config';
 
 export type ComplexityMetric = 'McCabe' | 'Length';
 
@@ -51,10 +52,13 @@ export async function findHotspotFiles(
   limits: Limits,
   options: Options
 ): Promise<HotspotResult> {
+  const config = loadConfig(options);
+
   const hotspots: Record<string, Hotspot> = await analyzeLogs(
     criteria,
     limits,
-    options
+    options,
+    config.filter
   );
 
   const filtered: FlatHotspot[] = [];
@@ -79,8 +83,8 @@ export async function aggregateHotspots(
 ): Promise<AggregatedHotspotsResult> {
   const hotspotResult = await findHotspotFiles(criteria, limits, options);
   const hotspots = hotspotResult.hotspots;
-  const config = loadConfig(options);
 
+  const config = loadConfig(options);
   const modules = config.scopes.map((m) => normalizeFolder(m));
 
   const result: AggregatedHotspot[] = [];
@@ -104,10 +108,16 @@ export async function aggregateHotspots(
 async function analyzeLogs(
   criteria: HotspotCriteria,
   limits: Limits,
-  options: Options
+  options: Options,
+  filter: string[]
 ) {
   const hotspots: Record<string, Hotspot> = {};
 
+  const parseOptions: ParseOptions = {
+    limits,
+    filter,
+  };
+
   await parseGitLog((entry) => {
     for (const change of entry.body) {
       let hotspot: Hotspot;
@@ -134,7 +144,7 @@ async function analyzeLogs(
       hotspot.commits++;
       hotspot.changedLines += change.linesAdded + change.linesRemoved;
     }
-  }, limits);
+  }, parseOptions);
   return hotspots;
 }
 

apps/backend/src/services/team-alignment.ts

@@ -1,7 +1,7 @@
 import { loadConfig } from '../infrastructure/config';
 import { Limits } from '../model/limits';
 import { Options } from '../options/options';
-import { parseGitLog } from '../utils/git-parser';
+import { parseGitLog, ParseOptions } from '../utils/git-parser';
 import { normalizeFolder } from '../utils/normalize-folder';
 
 const UNKNOWN_TEAM = 'unknown';
@@ -30,6 +30,11 @@ export async function calcTeamAlignment(
 
   const users = new Set<string>();
 
+  const parseOptions: ParseOptions = {
+    limits,
+    filter: config.filter,
+  };
+
   let count = 0;
   await parseGitLog((entry) => {
     let userName = entry.header.userName;
@@ -63,7 +68,7 @@ export async function calcTeamAlignment(
         }
       }
     }
-  }, limits);
+  }, parseOptions);
 
   if (byUser) {
     result.teams = Array.from(users);

apps/backend/src/utils/git-parser.spec.ts

@@ -1,6 +1,5 @@
 import { emptyConfig } from '../model/config';
-import { Limits } from '../model/limits';
-import { LogEntry, parseGitLog } from './git-parser';
+import { LogEntry, parseGitLog, ParseOptions } from './git-parser';
 import { getToday, subtractMonths, subtractSeconds } from '../utils/date-utils';
 import { loadCachedLog } from '../infrastructure/log';
 
@@ -16,7 +15,7 @@ jest.mock('../infrastructure/config', () => ({
   })),
 }));
 
-const logWithoutRenames = `"John Doe <john.doe@acme.com>,${today.toISOString()}"
+const logWithoutRenames = `"John Doe <john.doe@acme.com>,${today.toISOString()}\t123456,ci: format with prettier"
 1\t0\t/booking/feature-manage/my.component.ts
 1\t0\t/booking/feature-manage/my-other.component.ts
 0\t1\t/checkin/feature-checkin/my.component.ts
@@ -65,16 +64,19 @@ describe('git parser', () => {
     });
 
     it('returns all log entries', async () => {
-      const limits: Limits = {
-        limitCommits: 0,
-        limitMonths: 0,
+      const parseOptions: ParseOptions = {
+        limits: {
+          limitCommits: 0,
+          limitMonths: 0,
+        },
+        filter: [],
       };
 
       const entries: LogEntry[] = [];
 
       parseGitLog((entry) => {
         entries.push(entry);
-      }, limits);
+      }, parseOptions);
 
       expect(entries).toEqual([
         {
@@ -167,16 +169,19 @@ describe('git parser', () => {
     });
 
     it('returns last 2 log entries', async () => {
-      const limits: Limits = {
-        limitCommits: 2,
-        limitMonths: 0,
+      const parseOptions: ParseOptions = {
+        limits: {
+          limitCommits: 2,
+          limitMonths: 0,
+        },
+        filter: null,
       };
 
       const entries: LogEntry[] = [];
 
       parseGitLog((entry) => {
         entries.push(entry);
-      }, limits);
+      }, parseOptions);
 
       expect(entries).toEqual([
         {
@@ -230,17 +235,134 @@ describe('git parser', () => {
       ]);
     });
 
+    it('returns last 2 log entries after filtering', async () => {
+      const parseOptions: ParseOptions = {
+        limits: {
+          limitCommits: 2,
+          limitMonths: 0,
+        },
+        filter: ['format with prettier'],
+      };
+
+      const entries: LogEntry[] = [];
+
+      parseGitLog((entry) => {
+        entries.push(entry);
+      }, parseOptions);
+
+      expect(entries).toEqual([
+        {
+          header: {
+            userName: 'Jane Doe',
+            email: 'jane.doe@acme.com',
+            date: today,
+          },
+          body: [
+            {
+              linesAdded: 10,
+              linesRemoved: 0,
+              path: '/booking/feature-manage/my.component.ts',
+            },
+            {
+              linesAdded: 0,
+              linesRemoved: 1,
+              path: '/checkin/feature-checkin/my.component.ts',
+            },
+          ],
+        },
+        {
+          header: {
+            userName: 'John Doe',
+            email: 'john.doe@acme.com',
+            date: past,
+          },
+          body: [
+            {
+              linesAdded: 10,
+              linesRemoved: 0,
+              path: '/booking/feature-manage/my.component.ts',
+            },
+            {
+              linesAdded: 0,
+              linesRemoved: 1,
+              path: '/shared/feature-checkin/my.component.ts',
+            },
+          ],
+        },
+      ]);
+    });
+
+    it('returns last 2 log entries after filtering with multiple filters', async () => {
+      const parseOptions: ParseOptions = {
+        limits: {
+          limitCommits: 2,
+          limitMonths: 0,
+        },
+        filter: ['does not match', 'format with prettier'],
+      };
+
+      const entries: LogEntry[] = [];
+
+      parseGitLog((entry) => {
+        entries.push(entry);
+      }, parseOptions);
+
+      expect(entries).toEqual([
+        {
+          header: {
+            userName: 'Jane Doe',
+            email: 'jane.doe@acme.com',
+            date: today,
+          },
+          body: [
+            {
+              linesAdded: 10,
+              linesRemoved: 0,
+              path: '/booking/feature-manage/my.component.ts',
+            },
+            {
+              linesAdded: 0,
+              linesRemoved: 1,
+              path: '/checkin/feature-checkin/my.component.ts',
+            },
+          ],
+        },
+        {
+          header: {
+            userName: 'John Doe',
+            email: 'john.doe@acme.com',
+            date: past,
+          },
+          body: [
+            {
+              linesAdded: 10,
+              linesRemoved: 0,
+              path: '/booking/feature-manage/my.component.ts',
+            },
+            {
+              linesAdded: 0,
+              linesRemoved: 1,
+              path: '/shared/feature-checkin/my.component.ts',
+            },
+          ],
+        },
+      ]);
+    });
+
     it("returns last month's log entries", async () => {
-      const limits: Limits = {
-        limitCommits: 0,
-        limitMonths: 1,
+      const parseOptions: ParseOptions = {
+        limits: {
+          limitCommits: 0,
+          limitMonths: 1,
+        },
+        filter: [],
       };
 
       const entries: LogEntry[] = [];
 
       parseGitLog((entry) => {
         entries.push(entry);
-      }, limits);
+      }, parseOptions);
 
       expect(entries).toEqual([
         {
@@ -318,16 +440,19 @@ describe('git parser', () => {
       mocks.loadCachedLog.mockImplementation(() => logWithRenames);
     });
     it('returns all log entries', async () => {
-      const limits: Limits = {
-        limitCommits: 0,
-        limitMonths: 0,
+      const parseOptions: ParseOptions = {
+        limits: {
+          limitCommits: 0,
+          limitMonths: 0,
+        },
+        filter: [],
       };
 
       const entries: LogEntry[] = [];
 
       parseGitLog((entry) => {
         entries.push(entry);
-      }, limits);
+      }, parseOptions);
 
       expect(entries).toEqual([
         {