refactor(workflows): improve financial report workflow and error handling

- Updated the `weeklyFinancialReportsWorkflow` to accept a customizable period parameter, enhancing flexibility.
- Introduced a new `fetchFinancialData` function to encapsulate financial data retrieval logic, improving code organization.
- Enhanced error handling in the main worker script by simplifying the error handling function call.
- Refactored the validation schema in `worker.ts` to use optional environment variables for better configuration management.

These changes enhance the maintainability and usability of the financial reporting workflow, allowing for more dynamic data handling and improved error management.

Author: anatolyshipitz

workers/main/src/__tests__/weeklyFinancialReports.test.ts

@@ -4,13 +4,23 @@ import * as utils from '../../../common/utils';
 import { weeklyFinancialReportsWorkflow } from '../workflows';
 
 describe('weeklyFinancialReportsWorkflow', () => {
-  it('should return the report string', async () => {
+  it('should return the report string with default parameters', async () => {
     const result = await weeklyFinancialReportsWorkflow();
 
     expect(typeof result).toBe('string');
     expect(result.length).toBeGreaterThan(0);
   });
 
+  it('should return the report string for a custom period and config', async () => {
+    const result = await weeklyFinancialReportsWorkflow({
+      period: 'Q1 2025',
+      config: { reportTitle: 'Custom Report Title' },
+    });
+
+    expect(result.startsWith('Custom Report Title')).toBe(true);
+    expect(result).toContain('Period: Q1 2025');
+  });
+
   it('should log and rethrow errors', async () => {
     const logSpy = vi
       .spyOn(utils, 'logWorkflowError')

workers/main/src/activities/fetchFinancialData.ts

@@ -0,0 +1,32 @@
+export interface FinancialData {
+  period: string;
+  contractType: string;
+  revenue: number;
+  cogs: number;
+  margin: number;
+  marginality: number;
+  effectiveRevenue: number;
+  effectiveMargin: number;
+  effectiveMarginality: number;
+}
+
+/**
+ * Fetches financial data for a given period from an external source or database.
+ * @param period - The period to fetch data for (e.g., 'Q1 2025', 'current')
+ */
+export async function fetchFinancialData(
+  period: string = 'current',
+): Promise<FinancialData> {
+  // TODO: Replace this stub with actual data fetching logic (e.g., DB query, API call)
+  return {
+    period: period,
+    contractType: 'T&M',
+    revenue: 120000,
+    cogs: 80000,
+    margin: 40000,
+    marginality: 33.3,
+    effectiveRevenue: 110000,
+    effectiveMargin: 35000,
+    effectiveMarginality: 31.8,
+  };
+}

workers/main/src/configs/index.ts

@@ -1,11 +1,6 @@
-import { z } from 'zod';
-
 import { temporalSchema } from './temporal';
 import { workerSchema } from './worker';
 
-export const validationResult = z
-  .object({
-    ...temporalSchema.shape,
-    ...workerSchema.shape,
-  })
+export const validationResult = temporalSchema
+  .merge(workerSchema)
   .safeParse(process.env);

workers/main/src/configs/worker.ts

@@ -4,9 +4,10 @@ import { z } from 'zod';
 
 export const workerConfig: WorkerOptions = {
   taskQueue: 'main-queue',
-  workflowsPath: path.join(__dirname, '../workflows'),
+  workflowsPath:
+    process.env.WORKFLOWS_PATH || path.join(__dirname, '../workflows'),
 };
 
 export const workerSchema = z.object({
-  TEMPORAL_ADDRESS: z.string().default('temporal:7233'),
+  WORKFLOWS_PATH: z.string().optional(),
 });

workers/main/src/index.ts

@@ -29,7 +29,7 @@ export async function run(): Promise<void> {
 
     await worker.run();
   } catch (err) {
-    handleRunError(err as Error);
+    handleRunError(err);
   } finally {
     if (connection) {
       await connection.close();

workers/main/src/workflows/weeklyFinancialReports/index.ts

@@ -1,28 +1,18 @@
 import { logWorkflowError } from '../../../../common/utils';
+import { fetchFinancialData } from '../../activities/fetchFinancialData';
 
-export async function weeklyFinancialReportsWorkflow(): Promise<string> {
+export async function weeklyFinancialReportsWorkflow({
+  period = 'current',
+}: { period?: string } = {}): Promise<string> {
   try {
-    const data = {
-      period: 'Q1 2025',
-      contractType: 'T&M',
-      revenue: 120000,
-      cogs: 80000,
-      margin: 40000,
-      marginality: 33.3,
-      effectiveRevenue: 110000,
-      effectiveMargin: 35000,
-      effectiveMarginality: 31.8,
-    };
-
     const reportTitle = 'Weekly Financial Report';
+    const data = await fetchFinancialData(period);
     const report = `Period: ${data.period}
 Contract Type: ${data.contractType}
 Revenue: $${data.revenue.toLocaleString()}
 COGS: $${data.cogs.toLocaleString()}
 Margin: $${data.margin.toLocaleString()}
-Marginality: ${data.marginality}%
-
-Effective Revenue (last 4 months): $${data.effectiveRevenue.toLocaleString()}
+Marginality: ${data.marginality}%\n\nEffective Revenue (last 4 months): $${data.effectiveRevenue.toLocaleString()}
 Effective Margin: $${data.effectiveMargin.toLocaleString()}
 Effective Marginality: ${data.effectiveMarginality}%`;