Merge 4daa663be7 into 37adca2abe

apps/api/src/app/portfolio/calculator/portfolio-calculator.ts

@@ -1427,10 +1427,8 @@ export abstract class PortfolioCalculator {
         // Take the values at the start date from the first day of the date
         // range
         if (historicalDataItemsOfDateRange.length === 0) {
-          // TODO: Remove the fallback to 0 with the next release, when each
-          // cached portfolio snapshot contains the dividend
           dividendInBaseCurrencyAtStartDate =
-            historicalDataItem.dividendInBaseCurrency ?? 0;
+            historicalDataItem.dividendInBaseCurrency;
 
           netPerformanceAtStartDate = historicalDataItem.netPerformance;
 
@@ -1440,10 +1438,8 @@ export abstract class PortfolioCalculator {
 
         historicalDataItemsOfDateRange.push({
           ...historicalDataItem,
-          // TODO: Remove the fallback to 0 with the next release, when each
-          // cached portfolio snapshot contains the dividend
           dividendInBaseCurrency:
-            (historicalDataItem.dividendInBaseCurrency ?? 0) -
+            historicalDataItem.dividendInBaseCurrency -
             dividendInBaseCurrencyAtStartDate,
           netPerformance:
             historicalDataItem.netPerformance - netPerformanceAtStartDate,

apps/api/src/app/portfolio/portfolio.service.spec.ts

@@ -1241,6 +1241,8 @@ describe('PortfolioService', () => {
         getLiabilitiesInBaseCurrency: jest.fn().mockResolvedValue(new Big(0)),
         getSnapshot: jest.fn().mockResolvedValue({
           currentValueInBaseCurrency: new Big(3000),
+          dividendYieldPercent: new Big(0),
+          dividendYieldPercentWithCurrencyEffect: new Big(0),
           totalCashInBaseCurrency: new Big(1000),
           totalInvestment: new Big(2000),
           totalInvestmentWithCurrencyEffect: new Big(2000)

apps/api/src/app/portfolio/portfolio.service.ts

@@ -996,15 +996,12 @@ export class PortfolioService {
 
     const {
       activitiesCount,
-      averageInvestment,
-      averageInvestmentWithCurrencyEffect,
       averagePrice,
       currency,
       dateOfFirstActivity,
       dividendInBaseCurrency,
-      dividendYieldPercent: dividendYieldPercentOfSnapshot,
+      dividendYieldPercent,
-      dividendYieldPercentWithCurrencyEffect:
+      dividendYieldPercentWithCurrencyEffect,
-        dividendYieldPercentWithCurrencyEffectOfSnapshot,
       feeInBaseCurrency,
       grossPerformance,
       grossPerformancePercentage,
@@ -1020,34 +1017,6 @@ export class PortfolioService {
       tags
     } = holding;
 
-    // TODO: Remove the block below with the next release, when each cached
-    // portfolio snapshot contains the dividend yield. Then take
-    // dividendYieldPercent and dividendYieldPercentWithCurrencyEffect
-    // directly from the holding and remove averageInvestment and
-    // averageInvestmentWithCurrencyEffect from the properties above
-    const daysInMarket = differenceInDays(
-      new Date(),
-      parseDate(dateOfFirstActivity)
-    );
-
-    const dividendYieldPercent =
-      dividendYieldPercentOfSnapshot ??
-      getAnnualizedPerformancePercent({
-        daysInMarket,
-        netPerformancePercentage: averageInvestment.eq(0)
-          ? new Big(0)
-          : dividendInBaseCurrency.div(averageInvestment)
-      });
-
-    const dividendYieldPercentWithCurrencyEffect =
-      dividendYieldPercentWithCurrencyEffectOfSnapshot ??
-      getAnnualizedPerformancePercent({
-        daysInMarket,
-        netPerformancePercentage: averageInvestmentWithCurrencyEffect.eq(0)
-          ? new Big(0)
-          : dividendInBaseCurrency.div(averageInvestmentWithCurrencyEffect)
-      });
-
     const activitiesOfHolding = activities.filter((activity) => {
       return (
         activity.assetProfile.dataSource === dataSource &&
@@ -2323,11 +2292,9 @@ export class PortfolioService {
       activityCount: activities.filter(({ type }) => {
         return ['BUY', 'SELL'].includes(type);
       }).length,
-      // TODO: Remove the fallback to 0 with the next release, when each
+      dividendYieldPercent: dividendYieldPercent.toNumber(),
-      // cached portfolio snapshot contains the dividend yield
-      dividendYieldPercent: dividendYieldPercent?.toNumber() ?? 0,
       dividendYieldPercentWithCurrencyEffect:
-        dividendYieldPercentWithCurrencyEffect?.toNumber() ?? 0,
+        dividendYieldPercentWithCurrencyEffect.toNumber(),
       emergencyFund: {
         assets: emergencyFundHoldingsValueInBaseCurrency,
         cash: totalEmergencyFund

libs/common/src/lib/models/portfolio-snapshot-holding.ts

@@ -7,41 +7,16 @@ import type { Tag } from '@ghostfolio/prisma/browser';
 import { DataSource } from '@ghostfolio/prisma/enums';
 
 import { Big } from 'big.js';
-import { Expose, Transform, Type } from 'class-transformer';
+import { Transform, Type } from 'class-transformer';
-
-/**
- * @deprecated Backward compatibility to read the portfolio snapshots which
- * have been cached with the former name of the property
- *
- * TODO: Remove the fallback with the next release, together with the
- * `@Expose()` decorators of `averageInvestment` and
- * `averageInvestmentWithCurrencyEffect`
- */
-function transformToBigWithFallback(formerKey: string) {
-  return ({ obj, value }: { obj: Record<string, string>; value: string }) => {
-    const valueOrFallback = value ?? obj[formerKey];
-
-    return valueOrFallback === undefined
-      ? undefined
-      : transformToBig({ value: valueOrFallback });
-  };
-}
 
 export class PortfolioSnapshotHolding {
   activitiesCount: number;
 
-  @Expose()
+  @Transform(transformToBig, { toClassOnly: true })
-  @Transform(transformToBigWithFallback('timeWeightedInvestment'), {
-    toClassOnly: true
-  })
   @Type(() => Big)
   averageInvestment: Big;
 
-  @Expose()
+  @Transform(transformToBig, { toClassOnly: true })
-  @Transform(
-    transformToBigWithFallback('timeWeightedInvestmentWithCurrencyEffect'),
-    { toClassOnly: true }
-  )
   @Type(() => Big)
   averageInvestmentWithCurrencyEffect: Big;