Enhance financial reporting with contract type integration

workers/main/src/activities/weeklyFinancialReports/sendReportToSlack.test.ts

@@ -32,7 +32,13 @@ const mockTargetUnits: TargetUnit[] = [
 ];
 const mockFinancialsAppData: FinancialsAppData = {
   employees: [{ redmine_id: 3, history: { rate: { '2024-06-01': 100 } } }],
-  projects: [{ redmine_id: 2, history: { rate: { '2024-06-01': 200 } } }],
+  projects: [
+    {
+      name: 'Test Project',
+      redmine_id: 2,
+      history: { rate: { '2024-06-01': 200 } },
+    },
+  ],
 };
 
 describe('sendReportToSlack', () => {

workers/main/src/services/FinApp/FinAppRepository.test.ts

@@ -100,7 +100,7 @@ describe('FinAppRepository', () => {
       expect(result).toEqual(mockEmployees);
       expect(vi.mocked(EmployeeModel).find).toHaveBeenCalledWith(
         { redmine_id: { $in: [1] } },
-        { 'redmine_id': 1, 'history.rate': 1 },
+        { 'redmine_id': 1, 'history.rate': 1, 'history.contractType': 1 },
       );
     });
 
@@ -120,7 +120,13 @@ describe('FinAppRepository', () => {
       expect(result).toEqual(mockProjects);
       expect(vi.mocked(ProjectModel).find).toHaveBeenCalledWith(
         { redmine_id: { $in: [550] } },
-        { 'name': 1, 'redmine_id': 1, 'quick_books_id': 1, 'history.rate': 1 },
+        {
+          'name': 1,
+          'redmine_id': 1,
+          'quick_books_id': 1,
+          'history.rate': 1,
+          'history.contractType': 1,
+        },
       );
     });
 

workers/main/src/services/FinApp/FinAppRepository.ts

@@ -8,7 +8,7 @@ export class FinAppRepository implements IFinAppRepository {
     try {
       return await EmployeeModel.find(
         { redmine_id: { $in: redmineIds } },
-        { 'redmine_id': 1, 'history.rate': 1 },
+        { 'redmine_id': 1, 'history.rate': 1, 'history.contractType': 1 },
       ).lean<Employee[]>();
     } catch (error) {
       throw new FinAppRepositoryError(
@@ -21,7 +21,13 @@ export class FinAppRepository implements IFinAppRepository {
     try {
       return await ProjectModel.find(
         { redmine_id: { $in: redmineIds } },
-        { 'name': 1, 'redmine_id': 1, 'quick_books_id': 1, 'history.rate': 1 },
+        {
+          'name': 1,
+          'redmine_id': 1,
+          'quick_books_id': 1,
+          'history.rate': 1,
+          'history.contractType': 1,
+        },
       ).lean<Project[]>();
     } catch (error) {
       throw new FinAppRepositoryError(

workers/main/src/services/FinApp/FinAppSchemas.ts

@@ -6,6 +6,7 @@ import { Employee, Project } from './types';
 export const historySchema = new mongoose.Schema(
   {
     rate: { type: Map, of: Number },
+    contractType: { type: Map, of: String },
   },
   { _id: false },
 );

workers/main/src/services/FinApp/FinAppUtils.ts

@@ -0,0 +1,23 @@
+export function getContractTypeByDate(
+  contractTypeHistory: { [date: string]: string } | undefined,
+  date: string,
+): string | undefined {
+  if (!contractTypeHistory) {
+    return undefined;
+  }
+
+  const sortedDates = Object.keys(contractTypeHistory).sort(
+    (a, b) => new Date(a).getTime() - new Date(b).getTime(),
+  );
+  let lastContractType: string | undefined = undefined;
+
+  for (const contractDate of sortedDates) {
+    if (contractDate <= date) {
+      lastContractType = contractTypeHistory[contractDate];
+    } else {
+      break;
+    }
+  }
+
+  return lastContractType;
+}

workers/main/src/services/FinApp/types.ts

@@ -1,5 +1,6 @@
 export interface History {
   rate: { [date: string]: number };
+  contractType?: { [date: string]: string };
 }
 
 export interface Employee {

workers/main/src/services/WeeklyFinancialReport/WeeklyFinancialReportFormatter.ts

@@ -25,6 +25,7 @@ export interface FormatDetailInput {
   effectiveRevenue: number;
   effectiveMargin: number;
   effectiveMarginality: number;
+  contractType?: string;
 }
 
 const spacer = ' '.repeat(4);
@@ -42,9 +43,11 @@ export class WeeklyFinancialReportFormatter {
     effectiveRevenue,
     effectiveMargin,
     effectiveMarginality,
+    contractType,
   }: FormatDetailInput) =>
     `*${groupName}*\n` +
     `${spacer}period: ${currentQuarter}\n` +
+    `${spacer}contract type: ${contractType || 'n/a'}\n` +
     `${spacer}total hours: ${groupTotalHours.toFixed(1)}\n` +
     `${spacer}revenue: ${formatCurrency(groupTotalRevenue)}\n` +
     `${spacer}COGS: ${formatCurrency(groupTotalCogs)}\n` +
@@ -130,9 +133,8 @@ export class WeeklyFinancialReportFormatter {
 
     return (
       '\n*Notes:*\n' +
-      '1. *Contract Type* is not implemented\n' +
-      `2. *Effective Revenue* calculated for the last ${qboConfig.effectiveRevenueMonths} months (${startDate} - ${endDate})\n` +
-      '3. *Dept Tech* hours are not implemented\n\n' +
+      `1. *Effective Revenue* calculated for the last ${qboConfig.effectiveRevenueMonths} months (${startDate} - ${endDate})\n` +
+      '2. *Dept Tech* hours are not implemented\n\n' +
       `*Legend*: Marginality :arrowup: ≥${HIGH_MARGINALITY_THRESHOLD}%   :large_yellow_circle: ${MEDIUM_MARGINALITY_THRESHOLD}-${HIGH_MARGINALITY_THRESHOLD - 1}%  :arrowdown: <${MEDIUM_MARGINALITY_THRESHOLD}%`
     );
   };

workers/main/src/services/WeeklyFinancialReport/WeeklyFinancialReportRepository.test.ts

@@ -125,7 +125,6 @@ describe('WeeklyFinancialReportRepository', () => {
     expect(details).toContain('Margin');
     expect(details).toContain('Marginality');
     expect(details).toContain('Notes:');
-    expect(details).toContain('Contract Type');
     expect(details).toContain('Effective Revenue');
     expect(details).toContain('Dept Tech');
     expect(details).toContain('Legend');

workers/main/src/services/WeeklyFinancialReport/WeeklyFinancialReportRepository.ts

@@ -1,6 +1,7 @@
 import { getRateByDate } from '../../common/formatUtils';
 import type { TargetUnit } from '../../common/types';
 import type { Employee, Project } from '../FinApp';
+import { getContractTypeByDate } from '../FinApp/FinAppUtils';
 import { GroupAggregator } from './GroupAggregator';
 import {
   AggregateGroupDataInput,
@@ -23,6 +24,7 @@ interface GroupData {
   effectiveMargin: number;
   effectiveMarginality: number;
   marginality: MarginalityResult;
+  contractType?: string;
 }
 
 export class WeeklyFinancialReportRepository
@@ -132,6 +134,7 @@ export class WeeklyFinancialReportRepository
       effectiveRevenue,
       effectiveMargin,
       effectiveMarginality,
+      contractType,
     } = this.aggregateGroupData({ groupUnits, employees, projects });
     const marginality = MarginalityCalculator.calculate(
       groupTotalRevenue,
@@ -147,6 +150,7 @@ export class WeeklyFinancialReportRepository
       effectiveMargin,
       effectiveMarginality,
       marginality,
+      contractType,
     };
   }
 
@@ -184,6 +188,7 @@ export class WeeklyFinancialReportRepository
         effectiveRevenue: group.effectiveRevenue,
         effectiveMargin: group.effectiveMargin,
         effectiveMarginality: group.effectiveMarginality,
+        contractType: group.contractType,
       });
     }
 
@@ -242,6 +247,7 @@ export class WeeklyFinancialReportRepository
     employees,
     projects,
   }: AggregateGroupDataInput) {
+    let contractType: string | undefined;
     let groupTotalCogs = 0;
     let groupTotalRevenue = 0;
     let effectiveRevenue = 0;
@@ -261,6 +267,11 @@ export class WeeklyFinancialReportRepository
         effectiveRevenue += project.effectiveRevenue || 0;
         processedProjects.add(project.redmine_id);
       }
+
+      contractType = getContractTypeByDate(
+        project?.history?.contractType,
+        date,
+      );
     }
 
     const effectiveMargin = effectiveRevenue - groupTotalCogs;
@@ -273,6 +284,7 @@ export class WeeklyFinancialReportRepository
       effectiveRevenue,
       effectiveMargin,
       effectiveMarginality,
+      contractType,
     };
   }
 }

workers/main/src/services/WeeklyFinancialReport/WeeklyFinancialReportSorting.test.ts

@@ -52,10 +52,26 @@ const createLevelTestData = () => ({
     { redmine_id: 103, history: { rate: { '2024-01-01': 50 } } },
   ],
   projects: [
-    { redmine_id: 10, history: { rate: { '2024-01-01': 100 } } }, // 50% marginality (Low)
-    { redmine_id: 20, history: { rate: { '2024-01-01': 200 } } }, // 75% marginality (High)
-    { redmine_id: 30, history: { rate: { '2024-01-01': 150 } } }, // 67% marginality (Medium)
-    { redmine_id: 40, history: { rate: { '2024-01-01': 180 } } }, // 72% marginality (High)
+    {
+      name: 'Project X',
+      redmine_id: 10,
+      history: { rate: { '2024-01-01': 100 } },
+    }, // 50% marginality (Low)
+    {
+      name: 'Project Y',
+      redmine_id: 20,
+      history: { rate: { '2024-01-01': 200 } },
+    }, // 75% marginality (High)
+    {
+      name: 'Project Z',
+      redmine_id: 30,
+      history: { rate: { '2024-01-01': 150 } },
+    }, // 67% marginality (Medium)
+    {
+      name: 'Project W',
+      redmine_id: 40,
+      history: { rate: { '2024-01-01': 180 } },
+    }, // 72% marginality (High)
   ],
 });