feat(project-currency): implement project-specific currency support

- Added a currency column to the projects table to allow different projects to use different currencies. - Updated existing projects to default to 'USD' if no currency is set. - Enhanced project finance controller to handle currency retrieval and updates. - Introduced API endpoints for updating project currency with validation. - Updated frontend components to display and manage project currency effectively.
2025-06-04 11:30:51 +05:30
parent 1ec9759434
commit d6686d64be
18 changed files with 269 additions and 23 deletions
--- a/worklenz-backend/database/migrations/20250117000000-add-project-currency.sql
+++ b/worklenz-backend/database/migrations/20250117000000-add-project-currency.sql
@@ -0,0 +1,20 @@
+-- Migration: Add currency column to projects table
+-- Date: 2025-01-17
+-- Description: Adds project-specific currency support to allow different projects to use different currencies
+
+-- Add currency column to projects table
+ALTER TABLE projects
+    ADD COLUMN IF NOT EXISTS currency VARCHAR(3) DEFAULT 'USD';
+
+-- Add comment for documentation
+COMMENT ON COLUMN projects.currency IS 'Project-specific currency code (e.g., USD, EUR, GBP, JPY, etc.)';
+
+-- Add constraint to ensure currency codes are uppercase and 3 characters
+ALTER TABLE projects
+    ADD CONSTRAINT projects_currency_format_check 
+    CHECK (currency ~ '^[A-Z]{3}$');
+
+-- Update existing projects to have a default currency if they don't have one
+UPDATE projects 
+SET currency = 'USD' 
+WHERE currency IS NULL; 
--- a/worklenz-backend/database/sql/1_tables.sql
+++ b/worklenz-backend/database/sql/1_tables.sql
@@ -783,9 +783,12 @@ CREATE TABLE IF NOT EXISTS projects (
    estimated_working_days INTEGER                  DEFAULT 0,
    use_manual_progress    BOOLEAN                  DEFAULT FALSE,
    use_weighted_progress  BOOLEAN                  DEFAULT FALSE,
-    use_time_progress      BOOLEAN                  DEFAULT FALSE
+    use_time_progress      BOOLEAN                  DEFAULT FALSE,
+    currency               VARCHAR(3)               DEFAULT 'USD'
 );

+COMMENT ON COLUMN projects.currency IS 'Project-specific currency code (e.g., USD, EUR, GBP, JPY, etc.)';
+
 ALTER TABLE projects
    ADD CONSTRAINT projects_pk
        PRIMARY KEY (id);
--- a/worklenz-backend/database/sql/4_functions.sql
+++ b/worklenz-backend/database/sql/4_functions.sql
@@ -5401,7 +5401,8 @@ BEGIN
        updated_at             = CURRENT_TIMESTAMP,
        estimated_working_days = (_body ->> 'working_days')::INTEGER,
        estimated_man_days     = (_body ->> 'man_days')::INTEGER,
-        hours_per_day          = (_body ->> 'hours_per_day')::INTEGER
+        hours_per_day          = (_body ->> 'hours_per_day')::INTEGER,
+        currency               = COALESCE(UPPER((_body ->> 'currency')::TEXT), currency)
    WHERE id = (_body ->> 'id')::UUID
      AND team_id = _team_id
    RETURNING id INTO _project_id;
--- a/worklenz-backend/src/controllers/project-finance-controller.ts
+++ b/worklenz-backend/src/controllers/project-finance-controller.ts
@@ -51,6 +51,20 @@ export default class ProjectfinanceController extends WorklenzControllerBase {
    const projectId = req.params.project_id;
    const groupBy = req.query.group_by || "status";

+    // Get project information including currency
+    const projectQuery = `
+      SELECT id, name, currency
+      FROM projects 
+      WHERE id = $1
+    `;
+    const projectResult = await db.query(projectQuery, [projectId]);
+    
+    if (projectResult.rows.length === 0) {
+      return res.status(404).send(new ServerResponse(false, null, "Project not found"));
+    }
+    
+    const project = projectResult.rows[0];
+
    // First, get the project rate cards for this project
    const rateCardQuery = `
      SELECT 
@@ -339,10 +353,15 @@ export default class ProjectfinanceController extends WorklenzControllerBase {
      };
    });

-    // Include project rate cards in the response for reference
+    // Include project rate cards and currency in the response for reference
    const responseData = {
      groups: groupedTasks,
      project_rate_cards: projectRateCards,
+      project: {
+        id: project.id,
+        name: project.name,
+        currency: project.currency || "USD"
+      }
    };

    return res.status(200).send(new ServerResponse(true, responseData));
@@ -703,10 +722,12 @@ export default class ProjectfinanceController extends WorklenzControllerBase {
    const projectId = req.params.project_id;
    const groupBy = (req.query.groupBy as string) || "status";

-    // Get project name for filename
-    const projectNameQuery = `SELECT name FROM projects WHERE id = $1`;
-    const projectNameResult = await db.query(projectNameQuery, [projectId]);
-    const projectName = projectNameResult.rows[0]?.name || "Unknown Project";
+    // Get project name and currency for filename and export
+    const projectQuery = `SELECT name, currency FROM projects WHERE id = $1`;
+    const projectResult = await db.query(projectQuery, [projectId]);
+    const project = projectResult.rows[0];
+    const projectName = project?.name || "Unknown Project";
+    const projectCurrency = project?.currency || "USD";

    // First, get the project rate cards for this project
    const rateCardQuery = `
@@ -1025,7 +1046,7 @@ export default class ProjectfinanceController extends WorklenzControllerBase {
    // Add title row
    worksheet.getCell(
      "A1"
-    ).value = `Finance Data Export - ${projectName} - ${moment().format(
+    ).value = `Finance Data Export - ${projectName} (${projectCurrency}) - ${moment().format(
      "MMM DD, YYYY"
    )}`;
    worksheet.mergeCells("A1:L1");
@@ -1096,4 +1117,77 @@ export default class ProjectfinanceController extends WorklenzControllerBase {
    // Send the Excel file as a response
    res.end(buffer);
  }
+
+  @HandleExceptions()
+  public static async updateProjectCurrency(
+    req: IWorkLenzRequest,
+    res: IWorkLenzResponse
+  ): Promise<IWorkLenzResponse> {
+    const projectId = req.params.project_id;
+    const { currency } = req.body;
+
+    // Validate currency format (3-character uppercase code)
+    if (!currency || typeof currency !== "string" || !/^[A-Z]{3}$/.test(currency)) {
+      return res
+        .status(400)
+        .send(new ServerResponse(false, null, "Invalid currency format. Currency must be a 3-character uppercase code (e.g., USD, EUR, GBP)"));
+    }
+
+    // Check if project exists and user has access
+    const projectCheckQuery = `
+      SELECT p.id, p.name, p.currency as current_currency
+      FROM projects p
+      WHERE p.id = $1 AND p.team_id = $2
+    `;
+
+    const projectCheckResult = await db.query(projectCheckQuery, [projectId, req.user?.team_id]);
+
+    if (projectCheckResult.rows.length === 0) {
+      return res
+        .status(404)
+        .send(new ServerResponse(false, null, "Project not found or access denied"));
+    }
+
+    const project = projectCheckResult.rows[0];
+
+    // Update project currency
+    const updateQuery = `
+      UPDATE projects 
+      SET currency = $1, updated_at = NOW()
+      WHERE id = $2 AND team_id = $3
+      RETURNING id, name, currency;
+    `;
+
+    const result = await db.query(updateQuery, [currency, projectId, req.user?.team_id]);
+
+    if (result.rows.length === 0) {
+      return res
+        .status(500)
+        .send(new ServerResponse(false, null, "Failed to update project currency"));
+    }
+
+    const updatedProject = result.rows[0];
+
+    // Log the currency change for audit purposes
+    const logQuery = `
+      INSERT INTO project_logs (team_id, project_id, description)
+      VALUES ($1, $2, $3)
+    `;
+
+    const logDescription = `Project currency changed from ${project.current_currency || "USD"} to ${currency}`;
+    
+    try {
+      await db.query(logQuery, [req.user?.team_id, projectId, logDescription]);
+    } catch (error) {
+      console.error("Failed to log currency change:", error);
+      // Don't fail the request if logging fails
+    }
+
+    return res.status(200).send(new ServerResponse(true, {
+      id: updatedProject.id,
+      name: updatedProject.name,
+      currency: updatedProject.currency,
+      message: `Project currency updated to ${currency}`
+    }));
+  }
 }
--- a/worklenz-backend/src/controllers/projects-controller.ts
+++ b/worklenz-backend/src/controllers/projects-controller.ts
@@ -395,6 +395,7 @@ export default class ProjectsController extends WorklenzControllerBase {
             projects.folder_id,
             projects.phase_label,
             projects.category_id,
+             projects.currency,
             (projects.estimated_man_days) AS man_days,
             (projects.estimated_working_days) AS working_days,
             (projects.hours_per_day) AS hours_per_day,
--- a/worklenz-backend/src/routes/apis/project-finance-api-router.ts
+++ b/worklenz-backend/src/routes/apis/project-finance-api-router.ts
@@ -14,6 +14,7 @@ projectFinanceApiRouter.get(
  safeControllerFunction(ProjectfinanceController.getTaskBreakdown)
 );
 projectFinanceApiRouter.put("/task/:task_id/fixed-cost", ProjectfinanceController.updateTaskFixedCost);
+projectFinanceApiRouter.put("/project/:project_id/currency", ProjectfinanceController.updateProjectCurrency);
 projectFinanceApiRouter.get("/project/:project_id/export", ProjectfinanceController.exportFinanceData);

 export default projectFinanceApiRouter;