Refactor fetchFinancialAppData to Integrate QBO Effective Revenue

- Updated the `fetchFinancialAppData` function to utilize the `QBORepository` for fetching effective revenue data, enhancing the accuracy of financial reports.
- Adjusted the handling of effective revenue in the report generation process to ensure it correctly maps to project IDs.
- Added necessary mocks for `QBORepository` in the corresponding test file to ensure proper testing of the new functionality.

These changes improve the integration of financial data from QuickBooks Online, providing more reliable insights into project performance.

Author: anatolyshipitz

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

@@ -5,9 +5,10 @@ import { AppError } from '../../common/errors';
 import * as fileUtils from '../../common/fileUtils';
 import * as mongoPoolModule from '../../common/MongoPool';
 import type { TargetUnit } from '../../common/types';
-import type { Employee, Project } from '../../services/FinApp';
-import type { IFinAppRepository } from '../../services/FinApp';
+import type { Employee, IFinAppRepository, Project } from '../../services/FinApp';
 import * as finAppService from '../../services/FinApp';
+import type { CustomerRevenueByRef } from '../../services/QBO';
+import * as qboService from '../../services/QBO';
 import { fetchFinancialAppData } from './fetchFinancialAppData';
 
 type MongoPoolMock = {
@@ -30,6 +31,9 @@ vi.mock('../../common/MongoPool', () => ({
 vi.mock('../../services/FinApp', () => ({
   FinAppRepository: vi.fn(),
 }));
+vi.mock('../../services/QBO', () => ({
+  QBORepository: vi.fn(),
+}));
 
 const mockTargetUnits: TargetUnit[] = [
   {
@@ -49,11 +53,19 @@ const mockEmployees: Employee[] = [
 const mockProjects: Project[] = [
   {
     redmine_id: 2,
-    quick_books_id: 10,
+    quick_books_id: '10',
     history: { rate: { '2024-01-01': 200 } },
   },
 ];
 
+const mockEffectiveRevenue: CustomerRevenueByRef = {
+  '10': {
+    customerName: 'Test Customer',
+    totalAmount: 5000,
+    invoiceCount: 3,
+  },
+};
+
 function createRepoInstance(
   overrides: Partial<IFinAppRepository> = {},
 ): IFinAppRepository {
@@ -83,8 +95,10 @@ describe('getFinAppData', () => {
   let connect: Mock;
   let disconnect: Mock;
   let FinAppRepository: Mock;
+  let QBORepository: Mock;
   let dateSpy: ReturnType<typeof vi.spyOn>;
   let repoInstance: IFinAppRepository;
+  let qboRepoInstance: { getEffectiveRevenue: Mock };
   let mongoPoolInstance: MongoPoolMock;
 
   const fileLink = 'input.json';
@@ -100,6 +114,7 @@ describe('getFinAppData', () => {
     (repoInstance.getProjectsByRedmineIds as Mock).mockResolvedValue(
       mockProjects,
     );
+    qboRepoInstance.getEffectiveRevenue.mockResolvedValue(mockEffectiveRevenue);
   }
 
   async function expectAppError(promise: Promise<unknown>, msg: string) {
@@ -113,10 +128,16 @@ describe('getFinAppData', () => {
     readJsonFile = vi.mocked(fileUtils.readJsonFile);
     writeJsonFile = vi.mocked(fileUtils.writeJsonFile);
     FinAppRepository = vi.mocked(finAppService.FinAppRepository);
+    QBORepository = vi.mocked(qboService.QBORepository);
 
     repoInstance = createRepoInstance();
     FinAppRepository.mockImplementation(() => repoInstance);
 
+    qboRepoInstance = {
+      getEffectiveRevenue: vi.fn().mockResolvedValue(mockEffectiveRevenue),
+    };
+    QBORepository.mockImplementation(() => qboRepoInstance);
+
     connect = vi.fn().mockResolvedValue(undefined);
     disconnect = vi.fn().mockResolvedValue(undefined);
     mongoPoolInstance = createMongoPoolInstance(connect, disconnect);
@@ -141,13 +162,19 @@ describe('getFinAppData', () => {
       expect(readJsonFile).toHaveBeenCalledWith(fileLink);
       expect(writeJsonFile).toHaveBeenCalledWith(expectedFilename, {
         employees: mockEmployees,
-        projects: mockProjects,
+        projects: [
+          {
+            ...mockProjects[0],
+            effectiveRevenue: 5000,
+          },
+        ],
+        effectiveRevenue: mockEffectiveRevenue,
       });
     });
 
     it('always disconnects the mongo pool', async () => {
       setupSuccessMocks();
-      await fetchFinancialAppData(fileLink).catch(() => {});
+      await fetchFinancialAppData(fileLink).catch(() => { });
       expect(() => mongoPoolInstance.disconnect()).not.toThrow();
     });
   });

workers/main/src/activities/weeklyFinancialReports/fetchFinancialAppData.ts

@@ -28,21 +28,23 @@ export const fetchFinancialAppData = async (
     const employeeIds = getUniqueIds(targetUnits, 'user_id');
     const projectIds = getUniqueIds(targetUnits, 'project_id');
 
-    const [employees, projects, effectiveRevenue] = await Promise.all([
-      repo.getEmployeesByRedmineIds(employeeIds),
-      repo.getProjectsByRedmineIds(projectIds),
-      qboRepo.getEffectiveRevenue(),
-    ]);
+    const [employees, projects, effectiveRevenueByCustomerRef] =
+      await Promise.all([
+        repo.getEmployeesByRedmineIds(employeeIds),
+        repo.getProjectsByRedmineIds(projectIds),
+        qboRepo.getEffectiveRevenue(),
+      ]);
 
     await writeJsonFile(filename, {
       employees,
       projects: projects.map((project) => ({
         ...project,
         effectiveRevenue: project.quick_books_id
-          ? effectiveRevenue[project.quick_books_id]?.totalAmount || 0
+          ? effectiveRevenueByCustomerRef[project.quick_books_id]
+            ?.totalAmount || 0
           : 0,
       })),
-      effectiveRevenue,
+      effectiveRevenue: effectiveRevenueByCustomerRef,
     });
 
     return { fileLink: filename };