Merge pull request #35 from JoaquinPar/feature/months-left

feature/ calculations done, being displayed dynamically in the plan card

src/router/user.js

@@ -1,5 +1,5 @@
 const getRates = require("../util/exchangeRate");
-const { calculatePlanProgress, updatePlanProgressInDB } = require("../util/calculations");
+const { calculateProgress, updatePlanProgressInDB } = require("../util/calculations");
 const suggestions = require("../util/suggestions");
 const status = require("../util/statuses");
 const ObjectId = require('mongodb').ObjectId;
@@ -86,13 +86,11 @@ module.exports = (middleware, users, plans, assets) => {
                 toCurrencyRates: [],
             };
         }
-        let planSchema = await plans.find({ userId: new ObjectId(user) }).project({
+        const userPlansFromDB = await plans.find({ userId: new ObjectId(req.session.userId) }).toArray();
-            name: 1, retirementAssets: 1, progress: 1, _id: 1,
-        }).toArray();
 
-        for (const plan of planSchema) {
+        for (const plan of userPlansFromDB) {
-            const percentage = await calculatePlanProgress(plan, assets, req.session.user._id);
+            const progress = await calculateProgress(plan, assets, users, req.session.user._id);
-            await updatePlanProgressInDB(plan._id, percentage, plans);
+            await updatePlanProgressInDB(plan._id, progress.percentage, plans);
         }
 
         const updatedUserPlans = await plans.find({ userId: new ObjectId(req.session.user._id) }).toArray();
@@ -122,8 +120,8 @@ module.exports = (middleware, users, plans, assets) => {
             const userPlansFromDB = await plans.find({ userId: new ObjectId(req.session.userId) }).toArray();
 
             for (const plan of userPlansFromDB) {
-                const percentage = await calculatePlanProgress(plan, assets, req.session.user._id);
+                const progress = await calculateProgress(plan, assets, users, req.session.user._id);
-                await updatePlanProgressInDB(plan._id, percentage, plans);
+                await updatePlanProgressInDB(plan._id, progress.percentage, plans);
             }
 
             const updatedUserPlans = await plans.find({ userId: new ObjectId(req.session.user._id) }).toArray();
@@ -159,12 +157,15 @@ module.exports = (middleware, users, plans, assets) => {
                 req.session.errMessage = "Plan not found or you do not have permission to view it.";
                 return res.status(status.NotFound).redirect('/plans');
             }
+            const progress = await calculateProgress(plan, assets, users, req.session.userId);
+
 
             res.render('planDetail', {
                 user: req.session.user,
                 plan: plan,
                 geoData: req.session.geoData,
                 assets: userAssets,
+                progress: progress,
                 suggestions: await suggestions.generateSuggestions(),
             });
 

src/util/calculations.js

@@ -42,4 +42,72 @@ async function updatePlanProgressInDB(planId, percentage, plans) {
     }
 }
 
-module.exports = { calculatePlanProgress, updatePlanProgressInDB };
+
+async function calculateProgress(plan, assets, users, userId) {
+    if (!plan || typeof plan !== 'object') {
+        console.error("Error with the plan");
+        return;
+    }
+    if (!assets || typeof assets.find !== 'function') {
+        console.error("Error with the assets collection");
+        return;
+    }
+    if (!users || typeof users.findOne !== 'function') {
+        console.error("Error with the users collection");
+        return;
+    }
+    if (!userId) {
+        console.error("No user ID provided");
+        return;
+    }
+
+    try {
+        const userAssets = await assets.find({ userId: new ObjectId(userId) }).toArray();
+        const totalUserAssetValue = userAssets.reduce((total, asset) => total + asset.value, 0);
+        const totalUserPlanValue = plan.retirementAssets;
+        
+        const userDoc = await users.findOne({ _id: new ObjectId(userId) });
+        if (!userDoc || !userDoc.dob) {
+            console.error("User document or DOB not found for userId:", userId);
+            return { monthlyInvestment: NaN, totalCostOfRetirement: NaN, monthsUntilRetirement: NaN, yearsRetired: NaN, percentage: NaN };
+        }
+        const userDob = new Date(userDoc.dob);
+
+        if (isNaN(userDob.getTime())) {
+            console.error("userDob is an invalid date. Aborting calculation.");
+            return { monthlyInvestment: NaN, totalCostOfRetirement: NaN, monthsUntilRetirement: NaN, yearsRetired: NaN, percentage: NaN };
+        }
+
+        const today = new Date();
+        const userUnalivedBy = new Date(userDob);
+        userUnalivedBy.setFullYear(userUnalivedBy.getFullYear() + 90);
+        const yearOfRetirement = userDob.getFullYear() + plan.retirementAge;
+        const monthsUntilRetirement = (yearOfRetirement - today.getFullYear()) * 12;
+        const yearsRetired = userUnalivedBy.getFullYear() - yearOfRetirement;
+        
+        const totalCostOfRetirement = ((plan.retirementExpenses + plan.retirementLiabilities) * 12) * yearsRetired;
+        
+        const monthlyInvestment = (totalUserPlanValue - totalUserAssetValue + totalCostOfRetirement) / monthsUntilRetirement;
+        
+        const percentageCalculated = (totalUserAssetValue / (totalUserPlanValue + totalCostOfRetirement)) * 100;
+        
+        const progress = {};
+
+        progress.monthlyInvestment = Math.round(monthlyInvestment);
+        progress.totalCostOfRetirement = totalCostOfRetirement;
+        progress.monthsUntilRetirement = monthsUntilRetirement;
+        progress.yearsRetired = yearsRetired;
+        progress.yearsUntilRetirement = (yearOfRetirement - today.getFullYear());
+        progress.percentage = percentageCalculated;
+        
+        return progress;
+
+    } catch (err) {
+        console.error("Error in calculateProgress:", err);
+        return;
+    }
+}
+    
+
+
+module.exports = { calculatePlanProgress, updatePlanProgressInDB, calculateProgress};

src/views/newPlan.ejs

@@ -2,7 +2,6 @@
 <%- include("./partials/header") %>
 
 <main class="container mx-auto p-4 pt-30">
-    <h2 class="text-xl text-white font-semibold mb-4">Welcome: <%= user.name %></h2>
     <div class="max-w-md mx-auto bg-white p-8 mb-10 rounded-lg shadow-md">
         <h3 class="text-lg font-medium mb-6">Retirement Plan</h3>
         <form action="/newPlan" method="post" class="space-y-4">

src/views/planDetail.ejs

@@ -2,9 +2,7 @@
 <%- include("./partials/header") %>
 
 <main class="container mx-auto p-4 pt-28">
-    <h2 class="text-xl text-white font-semibold mb-4">Welcome: <%= user.name %></h2>
     <div class="max-w-lg mx-auto bg-white p-6 sm:p-8 rounded-xl shadow-lg space-y-6 dark:bg-gray-800">
-        
         <div class="text-center">
             <h3 class="text-2xl font-bold text-gray-800 dark:text-white"><%= plan.name %></h3>
         </div>
@@ -19,6 +17,13 @@
             </div>
         </div>
 
+        <div>
+            <div class="flex justify-between mb-1">
+                <span class="text-sm font-medium text-blue-700 dark:text-blue-400">Calculated Monthly Investment</span>
+                <span class="text-sm font-medium text-blue-700 dark:text-blue-400"><%- new Intl.NumberFormat('en-US', { style: 'currency', currency: geoData.currency ? geoData.currency : 'CAD' }).format(progress.monthlyInvestment > 0 ? progress.monthlyInvestment : 0) %></span>
+            </div>
+        </div>
+
         <div class="border-t border-gray-200 dark:border-gray-700 pt-6 space-y-4">
             <h4 class="text-lg font-semibold text-gray-700 dark:text-gray-300 mb-3">Assets:</h4>
             
@@ -29,7 +34,7 @@
                 </div>
                 <div>
                     <label class="block text-sm font-medium text-gray-600 dark:text-gray-400">Total Value:</label>
-                    <p class="mt-1 text-md text-gray-900 dark:text-white"><%= assets.reduce((total, asset) => total + asset.value, 0) %></p>
+                    <p class="mt-1 text-md text-gray-900 dark:text-white"><%- new Intl.NumberFormat('en-US', { style: 'currency', currency: geoData.currency ? geoData.currency : 'CAD' }).format(assets.reduce((total, asset) => total + asset.value, 0)) %></p>
                 </div>
             </div>
         </div>
@@ -43,16 +48,32 @@
                     <p class="mt-1 text-md text-gray-900 dark:text-white"><%= plan.retirementAge %></p>
                 </div>
                 <div>
-                    <label class="block text-sm font-medium text-gray-600 dark:text-gray-400">Target Monthly Expenses:</label>
+                    <label class="block text-sm font-medium text-gray-600 dark:text-gray-400">Target Monthly Expenses (Minus Liabilities):</label>
-                    <p class="mt-1 text-md text-gray-900 dark:text-white"><%= plan.retirementExpenses %></p>
+                    <p class="mt-1 text-md text-gray-900 dark:text-white"><%- new Intl.NumberFormat('en-US', { style: 'currency', currency: geoData.currency ? geoData.currency : 'CAD' }).format(plan.retirementExpenses) %></p>
                 </div>
                 <div>
-                    <label class="block text-sm font-medium text-gray-600 dark:text-gray-400">Target Retirement Assets:</label>
+                    <label class="block text-sm font-medium text-gray-600 dark:text-gray-400">Target Retirement Assets (Total):</label>
-                    <p class="mt-1 text-md text-gray-900 dark:text-white"><%= plan.retirementAssets %></p>
+                    <p class="mt-1 text-md text-gray-900 dark:text-white"><%- new Intl.NumberFormat('en-US', { style: 'currency', currency: geoData.currency ? geoData.currency : 'CAD' }).format(plan.retirementAssets) %></p>
                 </div>
                 <div>
-                    <label class="block text-sm font-medium text-gray-600 dark:text-gray-400">Target Retirement Liabilities:</label>
+                    <label class="block text-sm font-medium text-gray-600 dark:text-gray-400">Target Retirement Liabilities (Monthly):</label>
-                    <p class="mt-1 text-md text-gray-900 dark:text-white"><%= plan.retirementLiabilities %></p>
+                    <p class="mt-1 text-md text-gray-900 dark:text-white"><%- new Intl.NumberFormat('en-US', { style: 'currency', currency: geoData.currency ? geoData.currency : 'CAD' }).format(plan.retirementLiabilities) %></p>
+                </div>
+                <div>
+                    <label class="block text-sm font-medium text-gray-600 dark:text-gray-400">Years Until Retirement:</label>
+                    <p class="mt-1 text-md text-gray-900 dark:text-white"><%- progress.yearsUntilRetirement %></p>
+                </div>
+                <div>
+                    <label class="block text-sm font-medium text-gray-600 dark:text-gray-400">Years Retired:</label>
+                    <p class="mt-1 text-md text-gray-900 dark:text-white"><%- progress.yearsRetired %></p>
+                </div>
+                <div>
+                    <label class="block text-sm font-medium text-gray-600 dark:text-gray-400">Total Cost of Retirement:</label>
+                    <p class="mt-1 text-md text-gray-900 dark:text-white"><%- new Intl.NumberFormat('en-US', { style: 'currency', currency: geoData.currency ? geoData.currency : 'CAD' }).format(progress.totalCostOfRetirement) %></p>
+                </div>
+                <div>
+                    <label class="block text-sm font-medium text-gray-600 dark:text-gray-400">Total amount needed (Assets + Retirement Expenses): </label>
+                    <p class="mt-1 text-md text-gray-900 dark:text-white"><%- new Intl.NumberFormat('en-US', { style: 'currency', currency: geoData.currency ? geoData.currency : 'CAD' }).format(progress.totalCostOfRetirement + progress.monthlyInvestment * progress.monthsUntilRetirement) %></p>
                 </div>
             </div>
         </div>

src/views/plans.ejs

@@ -2,7 +2,6 @@
 <%- include("./partials/header") %>
 
 <main class="container mx-auto p-4 pt-28">
-    <h2 class="text-xl text-white font-semibold mb-4">Welcome: <%= user.name %></h2>
     <div class="max-w-md mx-auto bg-white p-8 mb-10 rounded-lg shadow-md space-y-4">
         <h3 class="text-lg font-medium mb-6">My Retirement Plans</h3>
         <a href="/newPlan" class="block max-w-sm p-2"><div class="text-center bg-blue-600 text-white py-1 w-full rounded-md hover:bg-blue-700 hover:text-white font-semibold">New Plan</div></a>