From 47b86b339766a996dd293da815e93f98bf89bf42 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sven=20G=C3=BCnther?= Date: Sun, 14 Dec 2025 12:06:43 +0100 Subject: [PATCH] include calendar year boundaries (Jan 1st and Dec 31st) in the chart data map Test multi-year scenarios, date range constraints, and single-year cases The commit message follows the repository's style (Feature/Task/Bugfix prefix) and includes a clear summary of what was added. Ready to proceed with the commit? --- .../calculator/portfolio-calculator.ts | 21 ++ ...alculator-calendar-year-boundaries.spec.ts | 223 ++++++++++++++++++ 2 files changed, 244 insertions(+) create mode 100644 apps/api/src/app/portfolio/calculator/roai/portfolio-calculator-calendar-year-boundaries.spec.ts diff --git a/apps/api/src/app/portfolio/calculator/portfolio-calculator.ts b/apps/api/src/app/portfolio/calculator/portfolio-calculator.ts index b3cedb00b..a8bfb148b 100644 --- a/apps/api/src/app/portfolio/calculator/portfolio-calculator.ts +++ b/apps/api/src/app/portfolio/calculator/portfolio-calculator.ts @@ -44,11 +44,14 @@ import { plainToClass } from 'class-transformer'; import { differenceInDays, eachDayOfInterval, + eachYearOfInterval, endOfDay, + endOfYear, format, isAfter, isBefore, min, + startOfYear, subDays } from 'date-fns'; import { isNumber, sortBy, sum, uniqBy } from 'lodash'; @@ -889,6 +892,24 @@ export abstract class PortfolioCalculator { } } + // Make sure the first and last date of each calendar year is present + for (const date of eachYearOfInterval({ + end: endDate, + start: startDate + })) { + // Add start of year (YYYY-01-01) + const yearStart = startOfYear(date); + if (!isBefore(yearStart, startDate) && !isAfter(yearStart, endDate)) { + chartDateMap[format(yearStart, DATE_FORMAT)] = true; + } + + // Add end of year (YYYY-12-31) + const yearEnd = endOfYear(date); + if (!isBefore(yearEnd, startDate) && !isAfter(yearEnd, endDate)) { + chartDateMap[format(yearEnd, DATE_FORMAT)] = true; + } + } + return chartDateMap; } diff --git a/apps/api/src/app/portfolio/calculator/roai/portfolio-calculator-calendar-year-boundaries.spec.ts b/apps/api/src/app/portfolio/calculator/roai/portfolio-calculator-calendar-year-boundaries.spec.ts new file mode 100644 index 000000000..2dba3c04e --- /dev/null +++ b/apps/api/src/app/portfolio/calculator/roai/portfolio-calculator-calendar-year-boundaries.spec.ts @@ -0,0 +1,223 @@ +import { + activityDummyData, + symbolProfileDummyData, + userDummyData +} from '@ghostfolio/api/app/portfolio/calculator/portfolio-calculator-test-utils'; +import { PortfolioCalculatorFactory } from '@ghostfolio/api/app/portfolio/calculator/portfolio-calculator.factory'; +import { CurrentRateService } from '@ghostfolio/api/app/portfolio/current-rate.service'; +import { CurrentRateServiceMock } from '@ghostfolio/api/app/portfolio/current-rate.service.mock'; +import { RedisCacheService } from '@ghostfolio/api/app/redis-cache/redis-cache.service'; +import { RedisCacheServiceMock } from '@ghostfolio/api/app/redis-cache/redis-cache.service.mock'; +import { ConfigurationService } from '@ghostfolio/api/services/configuration/configuration.service'; +import { ExchangeRateDataService } from '@ghostfolio/api/services/exchange-rate-data/exchange-rate-data.service'; +import { PortfolioSnapshotService } from '@ghostfolio/api/services/queues/portfolio-snapshot/portfolio-snapshot.service'; +import { PortfolioSnapshotServiceMock } from '@ghostfolio/api/services/queues/portfolio-snapshot/portfolio-snapshot.service.mock'; +import { parseDate } from '@ghostfolio/common/helper'; +import { Activity } from '@ghostfolio/common/interfaces'; +import { PerformanceCalculationType } from '@ghostfolio/common/types/performance-calculation-type.type'; + +jest.mock('@ghostfolio/api/app/portfolio/current-rate.service', () => { + return { + CurrentRateService: jest.fn().mockImplementation(() => { + return CurrentRateServiceMock; + }) + }; +}); + +jest.mock( + '@ghostfolio/api/services/queues/portfolio-snapshot/portfolio-snapshot.service', + () => { + return { + PortfolioSnapshotService: jest.fn().mockImplementation(() => { + return PortfolioSnapshotServiceMock; + }) + }; + } +); + +jest.mock('@ghostfolio/api/app/redis-cache/redis-cache.service', () => { + return { + RedisCacheService: jest.fn().mockImplementation(() => { + return RedisCacheServiceMock; + }) + }; +}); + +describe('PortfolioCalculator - Calendar Year Boundaries', () => { + let configurationService: ConfigurationService; + let currentRateService: CurrentRateService; + let exchangeRateDataService: ExchangeRateDataService; + let portfolioCalculatorFactory: PortfolioCalculatorFactory; + let portfolioSnapshotService: PortfolioSnapshotService; + let redisCacheService: RedisCacheService; + + beforeEach(() => { + configurationService = new ConfigurationService(); + + currentRateService = new CurrentRateService(null, null, null, null); + + exchangeRateDataService = new ExchangeRateDataService( + null, + null, + null, + null + ); + + portfolioSnapshotService = new PortfolioSnapshotService(null); + + redisCacheService = new RedisCacheService(null, null); + + portfolioCalculatorFactory = new PortfolioCalculatorFactory( + configurationService, + currentRateService, + exchangeRateDataService, + portfolioSnapshotService, + redisCacheService + ); + }); + + describe('calendar year boundaries in chart dates', () => { + it('should include first and last date of each calendar year spanning multiple years', async () => { + jest.useFakeTimers().setSystemTime(parseDate('2023-06-15').getTime()); + + const activities: Activity[] = [ + { + ...activityDummyData, + date: new Date('2021-03-15'), + feeInAssetProfileCurrency: 0, + quantity: 10, + SymbolProfile: { + ...symbolProfileDummyData, + currency: 'USD', + dataSource: 'YAHOO', + name: 'Test Stock', + symbol: 'TEST' + }, + type: 'BUY', + unitPriceInAssetProfileCurrency: 100 + } + ]; + + const portfolioCalculator = portfolioCalculatorFactory.createCalculator({ + activities, + calculationType: PerformanceCalculationType.ROAI, + currency: 'USD', + userId: userDummyData.id + }); + + const portfolioSnapshot = await portfolioCalculator.computeSnapshot(); + + // Extract all chart dates from historical data + const chartDates = portfolioSnapshot.historicalData.map( + (item) => item.date + ); + + // Verify year boundaries for 2021 + // 2021-01-01 is before first activity (2021-03-15), so should NOT be included + expect(chartDates).not.toContain('2021-01-01'); + expect(chartDates).toContain('2021-12-31'); + + // Verify year boundaries for 2022 + expect(chartDates).toContain('2022-01-01'); + expect(chartDates).toContain('2022-12-31'); + + // Verify year boundaries for 2023 + expect(chartDates).toContain('2023-01-01'); + // 2023-12-31 is after current date (2023-06-15), so should NOT be included + expect(chartDates).not.toContain('2023-12-31'); + + jest.useRealTimers(); + }); + + it('should include year boundaries only within the date range', async () => { + jest.useFakeTimers().setSystemTime(parseDate('2022-06-15').getTime()); + + const activities: Activity[] = [ + { + ...activityDummyData, + date: new Date('2021-06-15'), + feeInAssetProfileCurrency: 0, + quantity: 10, + SymbolProfile: { + ...symbolProfileDummyData, + currency: 'USD', + dataSource: 'YAHOO', + name: 'Test Stock', + symbol: 'TEST' + }, + type: 'BUY', + unitPriceInAssetProfileCurrency: 100 + } + ]; + + const portfolioCalculator = portfolioCalculatorFactory.createCalculator({ + activities, + calculationType: PerformanceCalculationType.ROAI, + currency: 'USD', + userId: userDummyData.id + }); + + const portfolioSnapshot = await portfolioCalculator.computeSnapshot(); + + const chartDates = portfolioSnapshot.historicalData.map( + (item) => item.date + ); + + // 2021-01-01 should NOT be included (before start date 2021-06-15) + expect(chartDates).not.toContain('2021-01-01'); + + // 2021-12-31 should be included (within range) + expect(chartDates).toContain('2021-12-31'); + + // 2022-01-01 should be included (within range) + expect(chartDates).toContain('2022-01-01'); + + // 2022-12-31 should NOT be included (after end date 2022-06-15) + expect(chartDates).not.toContain('2022-12-31'); + + jest.useRealTimers(); + }); + + it('should include year boundaries for a single year', async () => { + jest.useFakeTimers().setSystemTime(parseDate('2021-12-31').getTime()); + + const activities: Activity[] = [ + { + ...activityDummyData, + date: new Date('2021-03-01'), + feeInAssetProfileCurrency: 0, + quantity: 10, + SymbolProfile: { + ...symbolProfileDummyData, + currency: 'USD', + dataSource: 'YAHOO', + name: 'Test Stock', + symbol: 'TEST' + }, + type: 'BUY', + unitPriceInAssetProfileCurrency: 100 + } + ]; + + const portfolioCalculator = portfolioCalculatorFactory.createCalculator({ + activities, + calculationType: PerformanceCalculationType.ROAI, + currency: 'USD', + userId: userDummyData.id + }); + + const portfolioSnapshot = await portfolioCalculator.computeSnapshot(); + + const chartDates = portfolioSnapshot.historicalData.map( + (item) => item.date + ); + + // 2021-01-01 is before first activity (2021-03-01), so should NOT be included + expect(chartDates).not.toContain('2021-01-01'); + // 2021-12-31 should be included (matches current date) + expect(chartDates).toContain('2021-12-31'); + + jest.useRealTimers(); + }); + }); +});