Task/refactor params of getValues() in current rate service (#7829)

Refactoring

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

@@ -3,6 +3,7 @@ import { RedisCacheService } from '@ghostfolio/api/app/redis-cache/redis-cache.s
 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 { SubscriptionType } from '@ghostfolio/common/enums';
 import {
   Activity,
   Filter,
@@ -35,6 +36,7 @@ export class PortfolioCalculatorFactory {
     currency,
     filters = [],
     usePortfolioSnapshotCache = true,
+    subscriptionType,
     userId
   }: {
     accountBalanceItems?: HistoricalDataItem[];
@@ -43,6 +45,7 @@ export class PortfolioCalculatorFactory {
     currency: string;
     filters?: Filter[];
     usePortfolioSnapshotCache?: boolean;
+    subscriptionType?: SubscriptionType;
     userId: string;
   }): PortfolioCalculator {
     switch (calculationType) {
@@ -53,6 +56,7 @@ export class PortfolioCalculatorFactory {
           currency,
           filters,
           usePortfolioSnapshotCache,
+          subscriptionType,
           userId,
           configurationService: this.configurationService,
           currentRateService: this.currentRateService,
@@ -68,6 +72,7 @@ export class PortfolioCalculatorFactory {
           currency,
           filters,
           usePortfolioSnapshotCache,
+          subscriptionType,
           userId,
           configurationService: this.configurationService,
           currentRateService: this.currentRateService,
@@ -83,6 +88,7 @@ export class PortfolioCalculatorFactory {
           currency,
           filters,
           usePortfolioSnapshotCache,
+          subscriptionType,
           userId,
           configurationService: this.configurationService,
           currentRateService: this.currentRateService,
@@ -98,6 +104,7 @@ export class PortfolioCalculatorFactory {
           currency,
           filters,
           usePortfolioSnapshotCache,
+          subscriptionType,
           userId,
           configurationService: this.configurationService,
           currentRateService: this.currentRateService,

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

@@ -20,6 +20,7 @@ import {
   PORTFOLIO_SNAPSHOT_COMPUTATION_QUEUE_PRIORITY_HIGH,
   PORTFOLIO_SNAPSHOT_COMPUTATION_QUEUE_PRIORITY_LOW
 } from '@ghostfolio/common/config';
+import { SubscriptionType } from '@ghostfolio/common/enums';
 import {
   DATE_FORMAT,
   getAssetProfileIdentifier,
@@ -89,6 +90,7 @@ export abstract class PortfolioCalculator {
   private snapshot: PortfolioSnapshot;
   private snapshotPromise: Promise<void>;
   private startDate: Date;
+  private subscriptionType?: SubscriptionType;
   private transactionPoints: TransactionPoint[];
   private usePortfolioSnapshotCache: boolean;
   private userId: string;
@@ -104,6 +106,7 @@ export abstract class PortfolioCalculator {
     portfolioSnapshotService,
     redisCacheService,
     usePortfolioSnapshotCache = true,
+    subscriptionType,
     userId
   }: {
     accountBalanceItems: HistoricalDataItem[];
@@ -116,6 +119,7 @@ export abstract class PortfolioCalculator {
     portfolioSnapshotService: PortfolioSnapshotService;
     redisCacheService: RedisCacheService;
     usePortfolioSnapshotCache?: boolean;
+    subscriptionType?: SubscriptionType;
     userId: string;
   }) {
     this.accountBalanceItems = accountBalanceItems;
@@ -179,6 +183,7 @@ export abstract class PortfolioCalculator {
     this.portfolioSnapshotService = portfolioSnapshotService;
     this.redisCacheService = redisCacheService;
     this.usePortfolioSnapshotCache = usePortfolioSnapshotCache;
+    this.subscriptionType = subscriptionType;
     this.userId = userId;
 
     const { endDate, startDate } = getIntervalFromDateRange({
@@ -286,7 +291,8 @@ export abstract class PortfolioCalculator {
       dateQuery: {
         gte: this.startDate,
         lt: this.endDate
-      }
+      },
+      subscriptionType: this.subscriptionType
     });
 
     this.dataProviderInfos = dataProviderInfos;

apps/api/src/app/portfolio/calculator/roai/portfolio-calculator-baln-buy-and-buy.spec.ts

@@ -59,7 +59,7 @@ describe('PortfolioCalculator', () => {
 
     configurationService = new ConfigurationService();
 
-    currentRateService = new CurrentRateService(null, null, null, null);
+    currentRateService = new CurrentRateService(null, null, null);
 
     exchangeRateDataService = new ExchangeRateDataService(
       null,

apps/api/src/app/portfolio/calculator/roai/portfolio-calculator-baln-buy-and-sell-in-two-activities.spec.ts

@@ -59,7 +59,7 @@ describe('PortfolioCalculator', () => {
 
     configurationService = new ConfigurationService();
 
-    currentRateService = new CurrentRateService(null, null, null, null);
+    currentRateService = new CurrentRateService(null, null, null);
 
     exchangeRateDataService = new ExchangeRateDataService(
       null,

apps/api/src/app/portfolio/calculator/roai/portfolio-calculator-baln-buy-and-sell.spec.ts

@@ -59,7 +59,7 @@ describe('PortfolioCalculator', () => {
 
     configurationService = new ConfigurationService();
 
-    currentRateService = new CurrentRateService(null, null, null, null);
+    currentRateService = new CurrentRateService(null, null, null);
 
     exchangeRateDataService = new ExchangeRateDataService(
       null,

apps/api/src/app/portfolio/calculator/roai/portfolio-calculator-baln-buy.spec.ts

@@ -59,7 +59,7 @@ describe('PortfolioCalculator', () => {
 
     configurationService = new ConfigurationService();
 
-    currentRateService = new CurrentRateService(null, null, null, null);
+    currentRateService = new CurrentRateService(null, null, null);
 
     exchangeRateDataService = new ExchangeRateDataService(
       null,

apps/api/src/app/portfolio/calculator/roai/portfolio-calculator-btceur-in-base-currency-eur.spec.ts

@@ -81,7 +81,7 @@ describe('PortfolioCalculator', () => {
 
     configurationService = new ConfigurationService();
 
-    currentRateService = new CurrentRateService(null, null, null, null);
+    currentRateService = new CurrentRateService(null, null, null);
 
     exchangeRateDataService = new ExchangeRateDataService(
       null,

apps/api/src/app/portfolio/calculator/roai/portfolio-calculator-btceur.spec.ts

@@ -69,7 +69,7 @@ describe('PortfolioCalculator', () => {
 
     configurationService = new ConfigurationService();
 
-    currentRateService = new CurrentRateService(null, null, null, null);
+    currentRateService = new CurrentRateService(null, null, null);
 
     exchangeRateDataService = new ExchangeRateDataService(
       null,

apps/api/src/app/portfolio/calculator/roai/portfolio-calculator-btcusd-buy-and-sell-partially.spec.ts

@@ -71,7 +71,7 @@ describe('PortfolioCalculator', () => {
 
     configurationService = new ConfigurationService();
 
-    currentRateService = new CurrentRateService(null, null, null, null);
+    currentRateService = new CurrentRateService(null, null, null);
 
     exchangeRateDataService = new ExchangeRateDataService(
       null,

apps/api/src/app/portfolio/calculator/roai/portfolio-calculator-btcusd-buy-before-first-market-price.spec.ts

@@ -57,7 +57,7 @@ describe('PortfolioCalculator', () => {
 
     configurationService = new ConfigurationService();
 
-    currentRateService = new CurrentRateService(null, null, null, null);
+    currentRateService = new CurrentRateService(null, null, null);
 
     exchangeRateDataService = new ExchangeRateDataService(
       null,

apps/api/src/app/portfolio/calculator/roai/portfolio-calculator-btcusd-short.spec.ts

@@ -69,7 +69,7 @@ describe('PortfolioCalculator', () => {
 
     configurationService = new ConfigurationService();
 
-    currentRateService = new CurrentRateService(null, null, null, null);
+    currentRateService = new CurrentRateService(null, null, null);
 
     exchangeRateDataService = new ExchangeRateDataService(
       null,

apps/api/src/app/portfolio/calculator/roai/portfolio-calculator-btcusd.spec.ts

@@ -69,7 +69,7 @@ describe('PortfolioCalculator', () => {
 
     configurationService = new ConfigurationService();
 
-    currentRateService = new CurrentRateService(null, null, null, null);
+    currentRateService = new CurrentRateService(null, null, null);
 
     exchangeRateDataService = new ExchangeRateDataService(
       null,

apps/api/src/app/portfolio/calculator/roai/portfolio-calculator-cash.spec.ts

@@ -118,7 +118,6 @@ describe('PortfolioCalculator', () => {
     currentRateService = new CurrentRateService(
       null,
       dataProviderService,
-      null,
       null
     );
 

apps/api/src/app/portfolio/calculator/roai/portfolio-calculator-fee.spec.ts

@@ -59,7 +59,7 @@ describe('PortfolioCalculator', () => {
 
     configurationService = new ConfigurationService();
 
-    currentRateService = new CurrentRateService(null, null, null, null);
+    currentRateService = new CurrentRateService(null, null, null);
 
     exchangeRateDataService = new ExchangeRateDataService(
       null,

apps/api/src/app/portfolio/calculator/roai/portfolio-calculator-googl-buy.spec.ts

@@ -71,7 +71,7 @@ describe('PortfolioCalculator', () => {
 
     configurationService = new ConfigurationService();
 
-    currentRateService = new CurrentRateService(null, null, null, null);
+    currentRateService = new CurrentRateService(null, null, null);
 
     exchangeRateDataService = new ExchangeRateDataService(
       null,

apps/api/src/app/portfolio/calculator/roai/portfolio-calculator-jnug-buy-and-sell-and-buy-and-sell.spec.ts

@@ -72,7 +72,7 @@ describe('PortfolioCalculator', () => {
 
     configurationService = new ConfigurationService();
 
-    currentRateService = new CurrentRateService(null, null, null, null);
+    currentRateService = new CurrentRateService(null, null, null);
 
     exchangeRateDataService = new ExchangeRateDataService(
       null,

apps/api/src/app/portfolio/calculator/roai/portfolio-calculator-liability.spec.ts

@@ -59,7 +59,7 @@ describe('PortfolioCalculator', () => {
 
     configurationService = new ConfigurationService();
 
-    currentRateService = new CurrentRateService(null, null, null, null);
+    currentRateService = new CurrentRateService(null, null, null);
 
     exchangeRateDataService = new ExchangeRateDataService(
       null,

apps/api/src/app/portfolio/calculator/roai/portfolio-calculator-manual-buy-before-first-market-price.spec.ts

@@ -57,7 +57,7 @@ describe('PortfolioCalculator', () => {
 
     configurationService = new ConfigurationService();
 
-    currentRateService = new CurrentRateService(null, null, null, null);
+    currentRateService = new CurrentRateService(null, null, null);
 
     exchangeRateDataService = new ExchangeRateDataService(
       null,

apps/api/src/app/portfolio/calculator/roai/portfolio-calculator-msft-buy-and-sell.spec.ts

@@ -56,7 +56,8 @@ describe('PortfolioCalculator', () => {
     RedisCacheServiceMock.reset();
 
     configurationService = new ConfigurationService();
-    currentRateService = new CurrentRateService(null, null, null, null);
+    currentRateService = new CurrentRateService(null, null, null);
+
     exchangeRateDataService = new ExchangeRateDataService(
       null,
       null,

apps/api/src/app/portfolio/calculator/roai/portfolio-calculator-msft-buy-from-two-data-sources.spec.ts

@@ -71,7 +71,7 @@ describe('PortfolioCalculator', () => {
 
     configurationService = new ConfigurationService();
 
-    currentRateService = new CurrentRateService(null, null, null, null);
+    currentRateService = new CurrentRateService(null, null, null);
 
     exchangeRateDataService = new ExchangeRateDataService(
       null,

apps/api/src/app/portfolio/calculator/roai/portfolio-calculator-msft-buy-with-dividend.spec.ts

@@ -59,7 +59,7 @@ describe('PortfolioCalculator', () => {
 
     configurationService = new ConfigurationService();
 
-    currentRateService = new CurrentRateService(null, null, null, null);
+    currentRateService = new CurrentRateService(null, null, null);
 
     exchangeRateDataService = new ExchangeRateDataService(
       null,

apps/api/src/app/portfolio/calculator/roai/portfolio-calculator-no-activities.spec.ts

@@ -54,7 +54,7 @@ describe('PortfolioCalculator', () => {
 
     configurationService = new ConfigurationService();
 
-    currentRateService = new CurrentRateService(null, null, null, null);
+    currentRateService = new CurrentRateService(null, null, null);
 
     exchangeRateDataService = new ExchangeRateDataService(
       null,

apps/api/src/app/portfolio/calculator/roai/portfolio-calculator-novn-buy-and-sell-partially.spec.ts

@@ -72,7 +72,7 @@ describe('PortfolioCalculator', () => {
 
     configurationService = new ConfigurationService();
 
-    currentRateService = new CurrentRateService(null, null, null, null);
+    currentRateService = new CurrentRateService(null, null, null);
 
     exchangeRateDataService = new ExchangeRateDataService(
       null,

apps/api/src/app/portfolio/calculator/roai/portfolio-calculator-novn-buy-and-sell.spec.ts

@@ -72,7 +72,7 @@ describe('PortfolioCalculator', () => {
 
     configurationService = new ConfigurationService();
 
-    currentRateService = new CurrentRateService(null, null, null, null);
+    currentRateService = new CurrentRateService(null, null, null);
 
     exchangeRateDataService = new ExchangeRateDataService(
       null,

apps/api/src/app/portfolio/calculator/roai/portfolio-calculator-stock-split.spec.ts

@@ -60,7 +60,8 @@ describe('RoaiPortfolioCalculator stock splits', () => {
     RedisCacheServiceMock.reset();
 
     configurationService = new ConfigurationService();
-    currentRateService = new CurrentRateService(null, null, null, null);
+    currentRateService = new CurrentRateService(null, null, null);
+
     exchangeRateDataService = new ExchangeRateDataService(
       null,
       null,

apps/api/src/app/portfolio/calculator/roai/portfolio-calculator-valuable.spec.ts

@@ -59,7 +59,7 @@ describe('PortfolioCalculator', () => {
 
     configurationService = new ConfigurationService();
 
-    currentRateService = new CurrentRateService(null, null, null, null);
+    currentRateService = new CurrentRateService(null, null, null);
 
     exchangeRateDataService = new ExchangeRateDataService(
       null,

apps/api/src/app/portfolio/current-rate.service.spec.ts

@@ -119,8 +119,7 @@ describe('CurrentRateService', () => {
     currentRateService = new CurrentRateService(
       null,
       dataProviderService,
-      marketDataService,
+      marketDataService
-      null
     );
   });
 

apps/api/src/app/portfolio/current-rate.service.ts

@@ -11,10 +11,8 @@ import {
   DataProviderInfo,
   ResponseError
 } from '@ghostfolio/common/interfaces';
-import type { RequestWithUser } from '@ghostfolio/common/types';
 
-import { Inject, Injectable } from '@nestjs/common';
+import { Injectable } from '@nestjs/common';
-import { REQUEST } from '@nestjs/core';
 import { isBefore, isToday } from 'date-fns';
 import { isEmpty, uniqBy } from 'lodash';
 
@@ -29,15 +27,14 @@ export class CurrentRateService {
   public constructor(
     private readonly activitiesService: ActivitiesService,
     private readonly dataProviderService: DataProviderService,
-    private readonly marketDataService: MarketDataService,
+    private readonly marketDataService: MarketDataService
-    @Inject(REQUEST) private readonly request: RequestWithUser
   ) {}
 
   @LogPerformance
-  // TODO: Pass user instead of using this.request.user
   public async getValues({
     dataGatheringItems,
-    dateQuery
+    dateQuery,
+    subscriptionType
   }: GetValuesParams): Promise<GetValuesObject> {
     const dataProviderInfos: DataProviderInfo[] = [];
 
@@ -52,8 +49,8 @@ export class CurrentRateService {
 
     if (includesToday) {
       const quotes = await this.dataProviderService.getQuotes({
-        items: dataGatheringItems,
+        subscriptionType,
-        user: this.request?.user
+        items: dataGatheringItems
       });
 
       for (const { dataSource, symbol } of dataGatheringItems) {

apps/api/src/app/portfolio/interfaces/get-values-params.interface.ts

@@ -1,8 +1,10 @@
 import { DataGatheringItem } from '@ghostfolio/api/services/interfaces/interfaces';
+import { SubscriptionType } from '@ghostfolio/common/enums';
 
 import { DateQuery } from './date-query.interface';
 
 export interface GetValuesParams {
   dataGatheringItems: DataGatheringItem[];
   dateQuery: DateQuery;
+  subscriptionType?: SubscriptionType;
 }

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

@@ -546,7 +546,8 @@ export class PortfolioService {
       filters,
       userId,
       calculationType: this.getUserPerformanceCalculationType(user),
-      currency: userCurrency
+      currency: userCurrency,
+      subscriptionType: user.subscription?.type
     });
 
     const { historicalData } = await portfolioCalculator.getSnapshot();
@@ -633,7 +634,8 @@ export class PortfolioService {
       userId,
       calculationType: this.getUserPerformanceCalculationType(user),
       currency: userCurrency,
-      filters: portfolioSnapshotFilters
+      filters: portfolioSnapshotFilters,
+      subscriptionType: user.subscription?.type
     });
 
     const { createdAt, currentValueInBaseCurrency, hasErrors, positions } =
@@ -963,7 +965,8 @@ export class PortfolioService {
       calculationType: this.getUserPerformanceCalculationType(user),
       currency: userCurrency,
       filters: isExcludedHolding ? holdingFilters : undefined,
-      usePortfolioSnapshotCache: !isExcludedHolding
+      usePortfolioSnapshotCache: !isExcludedHolding,
+      subscriptionType: user.subscription?.type
     });
 
     const transactionPoints = portfolioCalculator.getTransactionPoints();
@@ -1218,7 +1221,8 @@ export class PortfolioService {
       filters,
       userId,
       calculationType: this.getUserPerformanceCalculationType(user),
-      currency: userCurrency
+      currency: userCurrency,
+      subscriptionType: user.subscription?.type
     });
 
     const { errors, hasErrors, historicalData } =

apps/api/src/services/data-provider/data-provider.service.ts

@@ -594,13 +594,13 @@ export class DataProviderService implements OnModuleInit {
   public async getQuotes({
     items,
     requestTimeout,
-    useCache = true,
+    subscriptionType,
-    user
+    useCache = true
   }: {
     items: AssetProfileIdentifier[];
     requestTimeout?: number;
+    subscriptionType?: SubscriptionType;
     useCache?: boolean;
-    user?: UserWithSettings;
   }): Promise<{
     [assetProfileIdentifier: string]: DataProviderResponse;
   }> {
@@ -687,7 +687,7 @@ export class DataProviderService implements OnModuleInit {
           } else if (
             dataProvider.getDataProviderInfo().isPremium &&
             this.configurationService.get('ENABLE_FEATURE_SUBSCRIPTION') &&
-            user?.subscription?.type === SubscriptionType.Basic
+            subscriptionType === SubscriptionType.Basic
           ) {
             // Skip symbols of Premium data providers for users without subscription
             return false;