feat: address review suggestions

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

@@ -1161,7 +1161,7 @@ export class PortfolioService {
     const userId = await this.getUserId(impersonationId, this.request.user.id);
     const userSettings = <UserSettings>this.request.user.Settings.settings;
 
-    const { accounts, holdings, summary, markets } = await this.getDetails({
+    const { accounts, holdings, markets, summary } = await this.getDetails({
       impersonationId,
       userId,
       withMarkets: true,
@@ -1181,10 +1181,18 @@ export class PortfolioService {
                   new AccountClusterRiskSingleAccount(
                     this.exchangeRateDataService,
                     accounts
-                  ),
+                  )
+                ],
+                userSettings
+              )
+            : undefined,
+        allocationClusterRisk:
+          summary.ordersCount > 0
+            ? await this.rulesService.evaluate(
+                [
                   new AllocationClusterRiskEmergingMarkets(
                     this.exchangeRateDataService,
-                    summary.committedFunds,
+                    summary.currentValueInBaseCurrency,
                     markets.emergingMarkets.valueInBaseCurrency
                   )
                 ],
@@ -1248,9 +1256,7 @@ export class PortfolioService {
     await this.orderService.assignTags({ dataSource, symbol, tags, userId });
   }
 
-  private getAggregatedMarkets(holdings: {
-    [symbol: string]: PortfolioPosition;
-  }): {
+  private getAggregatedMarkets(holdings: Record<string, PortfolioPosition>): {
     markets: PortfolioDetails['markets'];
     marketsAdvanced: PortfolioDetails['marketsAdvanced'];
   } {
@@ -1909,7 +1915,7 @@ export class PortfolioService {
   }: {
     activities: Activity[];
     filters?: Filter[];
-    portfolioItemsNow: { [p: string]: TimelinePosition };
+    portfolioItemsNow: Record<string, TimelinePosition>;
     userCurrency: string;
     userId: string;
     withExcludedAccounts?: boolean;

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

@@ -217,9 +217,11 @@ export class UserService {
         {}
       ).getSettings(user.Settings.settings),
       AllocationClusterRiskEmergingMarkets:
-        new AllocationClusterRiskEmergingMarkets(undefined, 0, 0).getSettings(
-          user.Settings.settings
-        ),
+        new AllocationClusterRiskEmergingMarkets(
+          undefined,
+          undefined,
+          undefined
+        ).getSettings(user.Settings.settings),
       CurrencyClusterRiskBaseCurrencyCurrentInvestment:
         new CurrencyClusterRiskBaseCurrencyCurrentInvestment(
           undefined,

apps/api/src/models/rules/allocation-cluster-risk/emerging-markets.ts

@@ -4,12 +4,12 @@ import { ExchangeRateDataService } from '@ghostfolio/api/services/exchange-rate-
 import { UserSettings } from '@ghostfolio/common/interfaces';
 
 export class AllocationClusterRiskEmergingMarkets extends Rule<Settings> {
+  private currentValueInBaseCurrency: number;
   private emergingMarketsValueInBaseCurrency: number;
-  private totalInvestment: number;
 
   public constructor(
     protected exchangeRateDataService: ExchangeRateDataService,
-    totalInvestment: number,
+    currentValueInBaseCurrency: number,
     emergingMarketsValueInBaseCurrency: number
   ) {
     super(exchangeRateDataService, {
@@ -19,38 +19,41 @@ export class AllocationClusterRiskEmergingMarkets extends Rule<Settings> {
 
     this.emergingMarketsValueInBaseCurrency =
       emergingMarketsValueInBaseCurrency;
-    this.totalInvestment = totalInvestment;
+    this.currentValueInBaseCurrency = currentValueInBaseCurrency;
   }
 
   public evaluate(ruleSettings: Settings) {
-    const emergingMarketsValueRatio = this.totalInvestment
-      ? this.emergingMarketsValueInBaseCurrency / this.totalInvestment
+    const emergingMarketsValueRatio = this.currentValueInBaseCurrency
+      ? this.emergingMarketsValueInBaseCurrency /
+        this.currentValueInBaseCurrency
       : 0;
 
     if (emergingMarketsValueRatio > ruleSettings.thresholdMax) {
       return {
-        evaluation: `The emerging markets contribution exceed ${(
+        evaluation: `The emerging markets contribution exceeds ${(
           ruleSettings.thresholdMax * 100
         ).toPrecision(
           3
-        )}% of your initial investment (${(emergingMarketsValueRatio * 100).toPrecision(3)}%)`,
+        )}% of your current investment (${(emergingMarketsValueRatio * 100).toPrecision(3)}%)`,
         value: false
       };
     } else if (emergingMarketsValueRatio < ruleSettings.thresholdMin) {
       return {
-        evaluation: `The emerging markets contribution does not exceed ${(
+        evaluation: `The emerging markets contribution is below ${(
           ruleSettings.thresholdMin * 100
         ).toPrecision(
           3
-        )}% of your initial investment (${(emergingMarketsValueRatio * 100).toPrecision(3)}%)`,
+        )}% of your current investment (${(emergingMarketsValueRatio * 100).toPrecision(3)}%)`,
         value: false
       };
     }
 
     return {
-      evaluation: `The emerging markets contribution does not exceed ${
-        ruleSettings.thresholdMax * 100
-      }% of your initial investment (${(emergingMarketsValueRatio * 100).toPrecision(3)}%)`,
+      evaluation: `The emerging markets contribution is within the range of ${(
+        ruleSettings.thresholdMin * 100
+      ).toPrecision(
+        3
+      )}% and ${(ruleSettings.thresholdMax * 100).toPrecision(3)}% of your current investment (${(emergingMarketsValueRatio * 100).toPrecision(3)}%)`,
       value: true
     };
   }
@@ -60,10 +63,11 @@ export class AllocationClusterRiskEmergingMarkets extends Rule<Settings> {
       threshold: {
         max: 1,
         min: 0,
-        step: 0.0025,
+        step: 0.01,
         unit: '%'
       },
-      thresholdMax: true
+      thresholdMax: true,
+      thresholdMin: true
     };
   }
 

apps/client/src/app/pages/portfolio/fire/fire-page.component.ts

@@ -22,6 +22,7 @@ import { takeUntil } from 'rxjs/operators';
 })
 export class FirePageComponent implements OnDestroy, OnInit {
   public accountClusterRiskRules: PortfolioReportRule[];
+  public allocationClusterRiskRules: PortfolioReportRule[];
   public currencyClusterRiskRules: PortfolioReportRule[];
   public deviceType: string;
   public emergencyFundRules: PortfolioReportRule[];
@@ -203,6 +204,13 @@ export class FirePageComponent implements OnDestroy, OnInit {
             }
           ) ?? null;
 
+        this.allocationClusterRiskRules =
+          portfolioReport.rules['allocationClusterRisk']?.filter(
+            ({ isActive }) => {
+              return isActive;
+            }
+          ) ?? null;
+
         this.currencyClusterRiskRules =
           portfolioReport.rules['currencyClusterRisk']?.filter(
             ({ isActive }) => {

apps/client/src/app/pages/portfolio/fire/fire-page.html

@@ -174,6 +174,25 @@
           (rulesUpdated)="onRulesUpdated($event)"
         />
       </div>
+      <div class="mb-4">
+        <h4 class="align-items-center d-flex m-0">
+          <span i18n>Allocation Cluster Risks</span>
+          @if (user?.subscription?.type === 'Basic') {
+            <gf-premium-indicator class="ml-1" />
+          }
+        </h4>
+        <gf-rules
+          [hasPermissionToUpdateUserSettings]="
+            !hasImpersonationId &&
+            hasPermissionToUpdateUserSettings &&
+            user?.settings?.isExperimentalFeatures
+          "
+          [isLoading]="isLoadingPortfolioReport"
+          [rules]="allocationClusterRiskRules"
+          [settings]="user?.settings?.xRayRules"
+          (rulesUpdated)="onRulesUpdated($event)"
+        />
+      </div>
       <div class="mb-4">
         <h4 class="align-items-center d-flex m-0">
           <span i18n>Fees</span>

libs/common/src/lib/types/x-ray-rules-settings.type.ts

@@ -1,7 +1,7 @@
 export type XRayRulesSettings = {
   AccountClusterRiskCurrentInvestment?: RuleSettings;
-  AllocationClusterRiskEmergingMarkets?: RuleSettings;
   AccountClusterRiskSingleAccount?: RuleSettings;
+  AllocationClusterRiskEmergingMarkets?: RuleSettings;
   CurrencyClusterRiskBaseCurrencyCurrentInvestment?: RuleSettings;
   CurrencyClusterRiskCurrentInvestment?: RuleSettings;
   EmergencyFundSetup?: RuleSettings;