Add Financial Report business logic with validations and calculations…

…, including tests for financial calculations, reporting period, and data validation

controllers/financialReportingController.js

@@ -1,9 +1,154 @@
 // controllers/financialReportingController.js
 const FinancialReport = require("../models/financialReport");
 
-// Create a new financial report
+// Business Logic Functions
+const calculateFinancialMetrics = (reportData) => {
+  try {
+    const revenue = parseFloat(reportData.TotalRevenue);
+    const expenses = parseFloat(reportData.TotalExpenses);
+    const reportedNetIncome = parseFloat(reportData.NetIncome);
+
+    const calculatedNetIncome = (revenue - expenses).toFixed(2);
+    const isValid = calculatedNetIncome === reportedNetIncome.toFixed(2);
+
+    return {
+      isValid,
+      calculatedNetIncome,
+      error: isValid ? null : 'Net income does not match revenue minus expenses'
+    };
+  } catch (error) {
+    return {
+      isValid: false,
+      error: 'Error calculating financial metrics'
+    };
+  }
+};
+
+const validateReportingPeriod = (reportData) => {
+  try {
+    const { Type, Data } = reportData;
+
+    if (Type === 'Annual') {
+      const requiredQuarters = ['q1', 'q2', 'q3', 'q4'];
+      const hasAllQuarters = requiredQuarters.every(quarter => 
+        Data.revenue[quarter] !== undefined && 
+        Data.expenses[quarter] !== undefined
+      );
+
+      if (!hasAllQuarters) {
+        return {
+          isValid: false,
+          error: 'Annual report must include data for all quarters'
+        };
+      }
+    }
+
+    if (Type === 'Quarterly') {
+      const hasQuarterlyData = 
+        Object.keys(Data.revenue).length === 1 && 
+        Object.keys(Data.expenses).length === 1;
+
+      if (!hasQuarterlyData) {
+        return {
+          isValid: false,
+          error: 'Quarterly report must include data for exactly one quarter'
+        };
+      }
+    }
+
+    return {
+      isValid: true,
+      error: null
+    };
+  } catch (error) {
+    return {
+      isValid: false,
+      error: 'Error validating reporting period'
+    };
+  }
+};
+
+const validateFinancialReport = (reportData) => {
+  try {
+    // Check for required fields
+    const requiredFields = [
+      'ReportID',
+      'Type',
+      'Data',
+      'TotalRevenue',
+      'TotalExpenses',
+      'NetIncome',
+      'Timestamp'
+    ];
+
+    const missingFields = requiredFields.filter(field => !reportData[field]);
+    if (missingFields.length > 0) {
+      return {
+        isValid: false,
+        error: `Missing required fields: ${missingFields.join(', ')}`
+      };
+    }
+
+    // Check for negative values in top-level financial fields
+    const financialFields = ['TotalRevenue', 'TotalExpenses', 'NetIncome'];
+    const hasNegativeValues = financialFields.some(field => 
+      parseFloat(reportData[field]) < 0
+    );
+
+    if (hasNegativeValues) {
+      return {
+        isValid: false,
+        error: 'Financial values cannot be negative'
+      };
+    }
+
+    // Check quarterly data for negative values
+    if (reportData.Data) {
+      const hasNegativeQuarterlyData = Object.values(reportData.Data).some(category =>
+        Object.values(category).some(value => value < 0)
+      );
+
+      if (hasNegativeQuarterlyData) {
+        return {
+          isValid: false,
+          error: 'Financial values cannot be negative'
+        };
+      }
+    }
+
+    // Validate financial calculations
+    const financialMetrics = calculateFinancialMetrics(reportData);
+    if (!financialMetrics.isValid) {
+      return financialMetrics;
+    }
+
+    // Validate reporting period
+    const periodValidation = validateReportingPeriod(reportData);
+    if (!periodValidation.isValid) {
+      return periodValidation;
+    }
+
+    return {
+      isValid: true,
+      error: null
+    };
+  } catch (error) {
+    return {
+      isValid: false,
+      error: 'Error validating financial report'
+    };
+  }
+};
+
+// CRUD Controller Functions
 const createFinancialReport = async (req, res, next) => {
   try {
+    // Validate the report data before saving
+    const validation = validateFinancialReport(req.body);
+    if (!validation.isValid) {
+      return res.status(400).json({ error: validation.error });
+    }
+
     const financialReport = new FinancialReport(req.body);
     const newFinancialReport = await financialReport.save();
     res.status(201).json(newFinancialReport);
@@ -12,7 +157,6 @@ const createFinancialReport = async (req, res, next) => {
   }
 };
 
-// Get a single financial report by ID
 const getFinancialReport = async (req, res, next) => {
   try {
     const report = await FinancialReport.findOne({ ReportID: req.params.id });
@@ -25,7 +169,6 @@ const getFinancialReport = async (req, res, next) => {
   }
 };
 
-// List financial reports with pagination
 const listFinancialReports = async (req, res, next) => {
   try {
     const page = parseInt(req.query.page) || 1;
@@ -50,9 +193,14 @@ const listFinancialReports = async (req, res, next) => {
   }
 };
 
-// Update a financial report
 const updateFinancialReport = async (req, res, next) => {
   try {
+    // Validate the update data before applying
+    const validation = validateFinancialReport(req.body);
+    if (!validation.isValid) {
+      return res.status(400).json({ error: validation.error });
+    }
+
     const report = await FinancialReport.findOneAndUpdate(
       { ReportID: req.params.id },
       req.body,
@@ -69,7 +217,6 @@ const updateFinancialReport = async (req, res, next) => {
   }
 };
 
-// Delete a financial report
 const deleteFinancialReport = async (req, res, next) => {
   try {
     const report = await FinancialReport.findOneAndDelete({ 
@@ -90,6 +237,12 @@ const deleteFinancialReport = async (req, res, next) => {
 };
 
 module.exports = {
+  // Business Logic Functions
+  calculateFinancialMetrics,
+  validateReportingPeriod,
+  validateFinancialReport,
+
+  // CRUD Functions
   createFinancialReport,
   getFinancialReport,
   listFinancialReports,