Skip to content

Open Source Wealth Management Software. Angular + NestJS + Prisma + Nx + TypeScript 🤍

Feature/add business logic of rule settings (#3826)

Shaunak Das24a3d92da00e
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 9d746a062c..78862da6da 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## Unreleased
+### Added
+
+- Added support to customize the rule thresholds in the _X-ray_ section (experimental)
+
### Changed
- Improved the language localization for German (`de`)
diff --git a/apps/api/src/app/user/update-user-setting.dto.ts b/apps/api/src/app/user/update-user-setting.dto.ts
index 6ea6d74277..b4d3edb77c 100644
--- a/apps/api/src/app/user/update-user-setting.dto.ts
+++ b/apps/api/src/app/user/update-user-setting.dto.ts
@@ -1,4 +1,5 @@
import { IsCurrencyCode } from '@ghostfolio/api/validators/is-currency-code';
+import { PortfolioReportRule } from '@ghostfolio/common/interfaces';
import type {
ColorScheme,
DateRange,
diff --git a/apps/api/src/models/rules/account-cluster-risk/current-investment.ts b/apps/api/src/models/rules/account-cluster-risk/current-investment.ts
index e25bb2f085..13680270ec 100644
--- a/apps/api/src/models/rules/account-cluster-risk/current-investment.ts
+++ b/apps/api/src/models/rules/account-cluster-risk/current-investment.ts
@@ -76,11 +76,11 @@ export class AccountClusterRiskCurrentInvestment extends Rule<Settings> {
};
}
- public getSettings(aUserSettings: UserSettings): Settings {
+ public getSettings({ baseCurrency, xRayRules }: UserSettings): Settings {
return {
- baseCurrency: aUserSettings.baseCurrency,
- isActive: aUserSettings.xRayRules[this.getKey()].isActive,
- thresholdMax: 0.5
+ baseCurrency,
+ isActive: xRayRules[this.getKey()].isActive,
+ thresholdMax: xRayRules[this.getKey()]?.thresholdMax ?? 0.5
};
}
}
diff --git a/apps/api/src/models/rules/account-cluster-risk/single-account.ts b/apps/api/src/models/rules/account-cluster-risk/single-account.ts
index 1f61b96594..feaaf4e38f 100644
--- a/apps/api/src/models/rules/account-cluster-risk/single-account.ts
+++ b/apps/api/src/models/rules/account-cluster-risk/single-account.ts
@@ -34,9 +34,9 @@ export class AccountClusterRiskSingleAccount extends Rule<RuleSettings> {
};
}
- public getSettings(aUserSettings: UserSettings): RuleSettings {
+ public getSettings({ xRayRules }: UserSettings): RuleSettings {
return {
- isActive: aUserSettings.xRayRules[this.getKey()].isActive
+ isActive: xRayRules[this.getKey()].isActive
};
}
}
diff --git a/apps/api/src/models/rules/currency-cluster-risk/base-currency-current-investment.ts b/apps/api/src/models/rules/currency-cluster-risk/base-currency-current-investment.ts
index 1258eb889a..e3050efcca 100644
--- a/apps/api/src/models/rules/currency-cluster-risk/base-currency-current-investment.ts
+++ b/apps/api/src/models/rules/currency-cluster-risk/base-currency-current-investment.ts
@@ -62,10 +62,10 @@ export class CurrencyClusterRiskBaseCurrencyCurrentInvestment extends Rule<Setti
};
}
- public getSettings(aUserSettings: UserSettings): Settings {
+ public getSettings({ baseCurrency, xRayRules }: UserSettings): Settings {
return {
- baseCurrency: aUserSettings.baseCurrency,
- isActive: aUserSettings.xRayRules[this.getKey()].isActive
+ baseCurrency,
+ isActive: xRayRules[this.getKey()].isActive
};
}
}
diff --git a/apps/api/src/models/rules/currency-cluster-risk/current-investment.ts b/apps/api/src/models/rules/currency-cluster-risk/current-investment.ts
index 5627ae254d..fadf47ba55 100644
--- a/apps/api/src/models/rules/currency-cluster-risk/current-investment.ts
+++ b/apps/api/src/models/rules/currency-cluster-risk/current-investment.ts
@@ -62,11 +62,11 @@ export class CurrencyClusterRiskCurrentInvestment extends Rule<Settings> {
};
}
- public getSettings(aUserSettings: UserSettings): Settings {
+ public getSettings({ baseCurrency, xRayRules }: UserSettings): Settings {
return {
- baseCurrency: aUserSettings.baseCurrency,
- isActive: aUserSettings.xRayRules[this.getKey()].isActive,
- thresholdMax: 0.5
+ baseCurrency,
+ isActive: xRayRules[this.getKey()].isActive,
+ thresholdMax: xRayRules[this.getKey()]?.thresholdMax ?? 0.5
};
}
}
diff --git a/apps/api/src/models/rules/emergency-fund/emergency-fund-setup.ts b/apps/api/src/models/rules/emergency-fund/emergency-fund-setup.ts
index 0ba7a109c1..c59701438e 100644
--- a/apps/api/src/models/rules/emergency-fund/emergency-fund-setup.ts
+++ b/apps/api/src/models/rules/emergency-fund/emergency-fund-setup.ts
@@ -19,7 +19,7 @@ export class EmergencyFundSetup extends Rule<Settings> {
}
public evaluate(ruleSettings: Settings) {
- if (this.emergencyFund < ruleSettings.thresholdMin) {
+ if (!this.emergencyFund) {
return {
evaluation: 'No emergency fund has been set up',
value: false
@@ -32,16 +32,14 @@ export class EmergencyFundSetup extends Rule<Settings> {
};
}
- public getSettings(aUserSettings: UserSettings): Settings {
+ public getSettings({ baseCurrency, xRayRules }: UserSettings): Settings {
return {
- baseCurrency: aUserSettings.baseCurrency,
- isActive: aUserSettings.xRayRules[this.getKey()].isActive,
- thresholdMin: 0
+ baseCurrency,
+ isActive: xRayRules[this.getKey()].isActive
};
}
}
interface Settings extends RuleSettings {
baseCurrency: string;
- thresholdMin: number;
}
diff --git a/apps/api/src/models/rules/fees/fee-ratio-initial-investment.ts b/apps/api/src/models/rules/fees/fee-ratio-initial-investment.ts
index 09029fd3ef..9b1961ed68 100644
--- a/apps/api/src/models/rules/fees/fee-ratio-initial-investment.ts
+++ b/apps/api/src/models/rules/fees/fee-ratio-initial-investment.ts
@@ -43,11 +43,11 @@ export class FeeRatioInitialInvestment extends Rule<Settings> {
};
}
- public getSettings(aUserSettings: UserSettings): Settings {
+ public getSettings({ baseCurrency, xRayRules }: UserSettings): Settings {
return {
- baseCurrency: aUserSettings.baseCurrency,
- isActive: aUserSettings.xRayRules[this.getKey()].isActive,
- thresholdMax: 0.01
+ baseCurrency,
+ isActive: xRayRules[this.getKey()].isActive,
+ thresholdMax: xRayRules[this.getKey()]?.thresholdMax ?? 0.01
};
}
}
diff --git a/apps/client/src/app/components/rule/rule-settings-dialog/rule-settings-dialog.component.ts b/apps/client/src/app/components/rule/rule-settings-dialog/rule-settings-dialog.component.ts
index 41ebf49dbe..4fb68e7802 100644
--- a/apps/client/src/app/components/rule/rule-settings-dialog/rule-settings-dialog.component.ts
+++ b/apps/client/src/app/components/rule/rule-settings-dialog/rule-settings-dialog.component.ts
@@ -2,6 +2,7 @@ import { PortfolioReportRule } from '@ghostfolio/common/interfaces';
import { CommonModule } from '@angular/common';
import { Component, Inject } from '@angular/core';
+import { FormsModule } from '@angular/forms';
import { MatButtonModule } from '@angular/material/button';
import {
MAT_DIALOG_DATA,
@@ -16,6 +17,7 @@ import { IRuleSettingsDialogParams } from './interfaces/interfaces';
@Component({
imports: [
CommonModule,
+ FormsModule,
MatButtonModule,
MatDialogModule,
MatFormFieldModule,
diff --git a/apps/client/src/app/components/rule/rule-settings-dialog/rule-settings-dialog.html b/apps/client/src/app/components/rule/rule-settings-dialog/rule-settings-dialog.html
index e24db29f74..ef86549f6a 100644
--- a/apps/client/src/app/components/rule/rule-settings-dialog/rule-settings-dialog.html
+++ b/apps/client/src/app/components/rule/rule-settings-dialog/rule-settings-dialog.html
@@ -1,23 +1,37 @@
<div mat-dialog-title>{{ data.rule.name }}</div>
<div class="py-3" mat-dialog-content>
- <mat-form-field appearance="outline" class="w-100">
+ <mat-form-field
+ appearance="outline"
+ class="w-100"
+ [ngClass]="{ 'd-none': settings.thresholdMin === undefined }"
+ >
<mat-label i18n>Threshold Min</mat-label>
- <input matInput name="thresholdMin" type="number" />
+ <input
+ matInput
+ name="thresholdMin"
+ type="number"
+ [(ngModel)]="settings.thresholdMin"
+ />
</mat-form-field>
- <mat-form-field appearance="outline" class="w-100">
+ <mat-form-field
+ appearance="outline"
+ class="w-100"
+ [ngClass]="{ 'd-none': settings.thresholdMax === undefined }"
+ >
<mat-label i18n>Threshold Max</mat-label>
- <input matInput name="thresholdMax" type="number" />
+ <input
+ matInput
+ name="thresholdMax"
+ type="number"
+ [(ngModel)]="settings.thresholdMax"
+ />
</mat-form-field>
</div>
<div align="end" mat-dialog-actions>
<button i18n mat-button (click)="dialogRef.close()">Close</button>
- <button
- color="primary"
- mat-flat-button
- (click)="dialogRef.close({ settings })"
- >
+ <button color="primary" mat-flat-button (click)="dialogRef.close(settings)">
<ng-container i18n>Save</ng-container>
</button>
</div>
diff --git a/apps/client/src/app/components/rule/rule.component.html b/apps/client/src/app/components/rule/rule.component.html
index f19436aba1..5491933c00 100644
--- a/apps/client/src/app/components/rule/rule.component.html
+++ b/apps/client/src/app/components/rule/rule.component.html
@@ -62,7 +62,7 @@
<ion-icon name="ellipsis-horizontal" />
</button>
<mat-menu #rulesMenu="matMenu" xPosition="before">
- @if (rule?.isActive && !isEmpty(rule.settings) && false) {
+ @if (rule?.isActive && !isEmpty(rule.settings)) {
<button mat-menu-item (click)="onCustomizeRule(rule)">
<ng-container i18n>Customize</ng-container>...
</button>
diff --git a/apps/client/src/app/components/rule/rule.component.ts b/apps/client/src/app/components/rule/rule.component.ts
index e6aafdcb18..6e6c368f07 100644
--- a/apps/client/src/app/components/rule/rule.component.ts
+++ b/apps/client/src/app/components/rule/rule.component.ts
@@ -55,16 +55,15 @@ export class RuleComponent implements OnInit {
dialogRef
.afterClosed()
.pipe(takeUntil(this.unsubscribeSubject))
- .subscribe(
- ({ settings }: { settings: PortfolioReportRule['settings'] }) => {
- if (settings) {
- console.log(settings);
-
- // TODO
- // this.ruleUpdated.emit(settings);
- }
+ .subscribe((settings: PortfolioReportRule['settings']) => {
+ if (settings) {
+ this.ruleUpdated.emit({
+ xRayRules: {
+ [rule.key]: settings
+ }
+ });
}
- );
+ });
}
public onUpdateRule(rule: PortfolioReportRule) {
diff --git a/apps/client/src/app/pages/portfolio/fire/fire-page.component.ts b/apps/client/src/app/pages/portfolio/fire/fire-page.component.ts
index 5aca4b3759..10a2eb604c 100644
--- a/apps/client/src/app/pages/portfolio/fire/fire-page.component.ts
+++ b/apps/client/src/app/pages/portfolio/fire/fire-page.component.ts
@@ -134,8 +134,6 @@ export class FirePageComponent implements OnDestroy, OnInit {
}
public onRulesUpdated(event: UpdateUserSettingDto) {
- this.isLoading = true;
-
this.dataService
.putUserSetting(event)
.pipe(takeUntil(this.unsubscribeSubject))
diff --git a/libs/common/src/lib/types/x-ray-rules-settings.type.ts b/libs/common/src/lib/types/x-ray-rules-settings.type.ts
index bc27825477..a55487f0b4 100644
--- a/libs/common/src/lib/types/x-ray-rules-settings.type.ts
+++ b/libs/common/src/lib/types/x-ray-rules-settings.type.ts
@@ -1,3 +1,5 @@
+import { PortfolioReportRule } from '@ghostfolio/common/interfaces';
+
export type XRayRulesSettings = {
AccountClusterRiskCurrentInvestment?: RuleSettings;
AccountClusterRiskSingleAccount?: RuleSettings;
@@ -7,6 +9,6 @@ export type XRayRulesSettings = {
FeeRatioInitialInvestment?: RuleSettings;
};
-interface RuleSettings {
+interface RuleSettings extends Pick<PortfolioReportRule, 'settings'> {
isActive: boolean;
}