fix(#1240): fix overall balance to stay anchored to today across calendar navigation

Author: rbalogic

__tests__/__renderer__/calendar.mjs

@@ -21,8 +21,14 @@ const testPreferences = structuredClone(getDefaultPreferences());
 describe('Test Calendar Window', () =>
 {
     let handleToggleMainWindowWaitCallback = undefined;
+    let waitUntilHandlersSetup = undefined;
     before(async() =>
     {
+        waitUntilHandlersSetup = new Promise(resolve =>
+        {
+            window.__resolveCalendarHandlersSetup = resolve;
+        });
+
         // Mocking APIs
         window.rendererApi = {
             getLanguageDataPromise: () =>
@@ -37,7 +43,11 @@ describe('Test Calendar Window', () =>
         };
 
         window.calendarApi = {
-            handleToggleMainWindowWait: (callback) => { handleToggleMainWindowWaitCallback = callback; },
+            handleToggleMainWindowWait: (callback) =>
+            {
+                handleToggleMainWindowWaitCallback = callback;
+                window.__resolveCalendarHandlersSetup();
+            },
             handleCalendarReload: () => {},
             handleRefreshOnDayChange: () => {},
             handlePreferencesSaved: () => {},
@@ -50,6 +60,8 @@ describe('Test Calendar Window', () =>
         // Using dynamic imports because when the file is imported a $() callback is triggered and
         // methods must be mocked before-hand
         await import('../../src/calendar.js');
+        await waitUntilHandlersSetup;
+        delete window.__resolveCalendarHandlersSetup;
     });
 
     beforeEach(async function()

__tests__/__renderer__/classes/DayCalendar.mjs

@@ -313,6 +313,34 @@ describe('DayCalendar class Tests', () =>
         assert.strictEqual(calendar._getCalendarYear(), today.getFullYear());
     });
 
+    describe('DayCalendar overall balance target date', () =>
+    {
+        it('Stays anchored to today while browsing other days', () =>
+        {
+            const expectedTargetDate = new Date(today.getFullYear(), today.getMonth(), today.getDate());
+
+            calendar._prevDay();
+            assert.strictEqual(calendar._getTargetDayForAllTimeBalance().getTime(), expectedTargetDate.getTime());
+
+            calendar._goToCurrentDate();
+            calendar._nextDay();
+            assert.strictEqual(calendar._getTargetDayForAllTimeBalance().getTime(), expectedTargetDate.getTime());
+        });
+
+        it('Includes today when count-today is enabled', async() =>
+        {
+            const preferences = structuredClone(getDefaultPreferences());
+            preferences['view'] = 'day';
+            preferences['count-today'] = true;
+            const anchoredCalendar = await CalendarFactory.getInstance(preferences, languageData);
+            const expectedTargetDate = new Date(today.getFullYear(), today.getMonth(), today.getDate() + 1);
+
+            anchoredCalendar._prevDay();
+
+            assert.strictEqual(anchoredCalendar._getTargetDayForAllTimeBalance().getTime(), expectedTargetDate.getTime());
+        });
+    });
+
     describe('DayCalendar RefreshOnDayChange', () =>
     {
         it('DayCalendar refresh set correctly', () =>

__tests__/__renderer__/classes/MonthCalendar.mjs

@@ -206,6 +206,33 @@ describe('MonthCalendar class Tests', () =>
         assert.strictEqual(calendar._getCalendarYear(), today.getFullYear());
     });
 
+    describe('MonthCalendar overall balance target date', () =>
+    {
+        it('Stays anchored to today while browsing other months', () =>
+        {
+            const expectedTargetDate = new Date(today.getFullYear(), today.getMonth(), today.getDate());
+
+            calendar._prevMonth();
+            assert.strictEqual(calendar._getTargetDayForAllTimeBalance().getTime(), expectedTargetDate.getTime());
+
+            calendar._goToCurrentDate();
+            calendar._nextMonth();
+            assert.strictEqual(calendar._getTargetDayForAllTimeBalance().getTime(), expectedTargetDate.getTime());
+        });
+
+        it('Includes today when count-today is enabled', async() =>
+        {
+            const preferences = structuredClone(getDefaultPreferences());
+            preferences['count-today'] = true;
+            const anchoredCalendar = await CalendarFactory.getInstance(preferences, languageData);
+            const expectedTargetDate = new Date(today.getFullYear(), today.getMonth(), today.getDate() + 1);
+
+            anchoredCalendar._prevMonth();
+
+            assert.strictEqual(anchoredCalendar._getTargetDayForAllTimeBalance().getTime(), expectedTargetDate.getTime());
+        });
+    });
+
     describe('MonthCalendar RefreshOnDayChange', () =>
     {
         it('MonthCalendar refresh set correctly', () =>

locales/en/translation.json

@@ -4,7 +4,7 @@
         "month-balance": "Month Balance",
         "month-balance-title": "Balance up until today for this month. A positive balance means extra hours you don't need to work today (or the rest of the month).",
         "overall-balance": "Overall Balance",
-        "overall-balance-title": "Overall balance until end of the month or current day",
+        "overall-balance-title": "Overall balance up to the current day",
         "switch-view": "Switch View"
     },
     "$DateUtil": {

renderer/classes/BaseCalendar.js

@@ -38,14 +38,28 @@ class BaseCalendar
 
     /**
      * Returns a date object for which the all time balance will be calculated.
-     * If current month, returns the actual day. If not, first day of following month.
      * @return {Date}
      */
     _getTargetDayForAllTimeBalance()
     {
         throw Error('Please implement this.');
     }
 
+    /**
+     * Returns the current-day target date for overall balance calculations.
+     * If "count today" is active, returns the following day so today is included.
+     * @return {Date}
+     */
+    _getCurrentDayTargetForAllTimeBalance()
+    {
+        const targetDate = new Date(this._getTodayYear(), this._getTodayMonth(), this._getTodayDate());
+        if (this._getCountToday())
+        {
+            targetDate.setDate(targetDate.getDate() + 1);
+        }
+        return targetDate;
+    }
+
     /**
      * Searches for an i18n code inside the last loaded language data
      * @return {String}

renderer/classes/DayCalendar.js

@@ -710,18 +710,12 @@ class DayCalendar extends BaseCalendar
 
     /**
      * Returns a date object for which the all time balance will be calculated.
-     * For DayCalendar, it's the day of CalendarDate => the day being displayed.
-     * If "count_today" is active, the following day.
+     * Overall balance is anchored to the current day even while browsing other days.
      * @return {Date}
      */
     _getTargetDayForAllTimeBalance()
     {
-        const targetDate = new Date(this._getCalendarYear(), this._getCalendarMonth(), this._getCalendarDate());
-        if (this._getCountToday())
-        {
-            targetDate.setDate(targetDate.getDate() + 1);
-        }
-        return targetDate;
+        return this._getCurrentDayTargetForAllTimeBalance();
     }
 }
 

renderer/classes/MonthCalendar.js

@@ -35,24 +35,12 @@ class MonthCalendar extends BaseCalendar
 
     /**
      * Returns a date object for which the all time balance will be calculated.
-     * If current month, returns the actual day. If not, first day of following month.
+     * Overall balance is anchored to the current day even while browsing other months.
      * @return {Date}
      */
     _getTargetDayForAllTimeBalance()
     {
-        const targetYear = this._getCalendarYear(),
-            targetMonth = this._getCalendarMonth(),
-            // If we are not displaying the current month we need to compute the balance including the
-            // last day of the month. To do so we move to the first day of the following month
-            isCurrentMonth = targetYear === this._getTodayYear() && targetMonth === this._getTodayMonth(),
-            targetDate = isCurrentMonth ?
-                new Date(targetYear, targetMonth, this._getTodayDate()) :
-                new Date(targetYear, targetMonth + 1, 1);
-        if (isCurrentMonth && this._getCountToday())
-        {
-            targetDate.setDate(targetDate.getDate() + 1);
-        }
-        return targetDate;
+        return this._getCurrentDayTargetForAllTimeBalance();
     }
 
     /*