Skip to content

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

Task/improve type safety in fire calculator component (#6385)

Kenrick Tandrian90cc7af87c10
diff --git a/libs/ui/src/lib/fire-calculator/fire-calculator.component.ts b/libs/ui/src/lib/fire-calculator/fire-calculator.component.ts
index 7461f67291..8b472fc474 100644
--- a/libs/ui/src/lib/fire-calculator/fire-calculator.component.ts
+++ b/libs/ui/src/lib/fire-calculator/fire-calculator.component.ts
@@ -13,13 +13,13 @@ import {
ChangeDetectorRef,
Component,
ElementRef,
- EventEmitter,
Input,
OnChanges,
OnDestroy,
- Output,
- ViewChild
+ ViewChild,
+ output
} from '@angular/core';
+import { takeUntilDestroyed } from '@angular/core/rxjs-interop';
import {
FormBuilder,
FormControl,
@@ -55,9 +55,9 @@ import {
startOfMonth,
sub
} from 'date-fns';
-import { isNumber } from 'lodash';
+import { isNil, isNumber } from 'lodash';
import { NgxSkeletonLoaderModule } from 'ngx-skeleton-loader';
-import { Subject, debounceTime, takeUntil } from 'rxjs';
+import { debounceTime } from 'rxjs';
import { FireCalculatorService } from './fire-calculator.service';
@@ -90,32 +90,31 @@ export class GfFireCalculatorComponent implements OnChanges, OnDestroy {
@Input() retirementDate: Date;
@Input() savingsRate = 0;
- @Output() annualInterestRateChanged = new EventEmitter<number>();
- @Output() calculationCompleted =
- new EventEmitter<FireCalculationCompleteEvent>();
- @Output() projectedTotalAmountChanged = new EventEmitter<number>();
- @Output() retirementDateChanged = new EventEmitter<Date>();
- @Output() savingsRateChanged = new EventEmitter<number>();
-
@ViewChild('chartCanvas') chartCanvas: ElementRef<HTMLCanvasElement>;
public calculatorForm = this.formBuilder.group({
- annualInterestRate: new FormControl<number>(undefined),
- paymentPerPeriod: new FormControl<number>(undefined),
- principalInvestmentAmount: new FormControl<number>(undefined),
- projectedTotalAmount: new FormControl<number>(undefined),
- retirementDate: new FormControl<Date>(undefined)
+ annualInterestRate: new FormControl<number | null>(null),
+ paymentPerPeriod: new FormControl<number | null>(null),
+ principalInvestmentAmount: new FormControl<number | null>(null),
+ projectedTotalAmount: new FormControl<number | null>(null),
+ retirementDate: new FormControl<Date | null>(null)
});
public chart: Chart<'bar'>;
public isLoading = true;
public minDate = addDays(new Date(), 1);
public periodsToRetire = 0;
+ protected readonly annualInterestRateChanged = output<number>();
+ protected readonly calculationCompleted =
+ output<FireCalculationCompleteEvent>();
+ protected readonly projectedTotalAmountChanged = output<number>();
+ protected readonly retirementDateChanged = output<Date>();
+ protected readonly savingsRateChanged = output<number>();
+
private readonly CONTRIBUTION_PERIOD = 12;
private readonly DEFAULT_RETIREMENT_DATE = startOfMonth(
addYears(new Date(), 10)
);
- private unsubscribeSubject = new Subject<void>();
public constructor(
private changeDetectorRef: ChangeDetectorRef,
@@ -131,46 +130,56 @@ export class GfFireCalculatorComponent implements OnChanges, OnDestroy {
);
this.calculatorForm.valueChanges
- .pipe(takeUntil(this.unsubscribeSubject))
+ .pipe(takeUntilDestroyed())
.subscribe(() => {
this.initialize();
});
this.calculatorForm.valueChanges
- .pipe(debounceTime(500), takeUntil(this.unsubscribeSubject))
+ .pipe(debounceTime(500), takeUntilDestroyed())
.subscribe(() => {
const { projectedTotalAmount, retirementDate } =
this.calculatorForm.getRawValue();
- this.calculationCompleted.emit({
- projectedTotalAmount,
- retirementDate
- });
+ if (projectedTotalAmount !== null && retirementDate !== null) {
+ this.calculationCompleted.emit({
+ projectedTotalAmount,
+ retirementDate
+ });
+ }
});
this.calculatorForm
.get('annualInterestRate')
- .valueChanges.pipe(debounceTime(500), takeUntil(this.unsubscribeSubject))
+ ?.valueChanges.pipe(debounceTime(500), takeUntilDestroyed())
.subscribe((annualInterestRate) => {
- this.annualInterestRateChanged.emit(annualInterestRate);
+ if (annualInterestRate !== null) {
+ this.annualInterestRateChanged.emit(annualInterestRate);
+ }
});
this.calculatorForm
.get('paymentPerPeriod')
- .valueChanges.pipe(debounceTime(500), takeUntil(this.unsubscribeSubject))
+ ?.valueChanges.pipe(debounceTime(500), takeUntilDestroyed())
.subscribe((savingsRate) => {
- this.savingsRateChanged.emit(savingsRate);
+ if (savingsRate !== null) {
+ this.savingsRateChanged.emit(savingsRate);
+ }
});
this.calculatorForm
.get('projectedTotalAmount')
- .valueChanges.pipe(debounceTime(500), takeUntil(this.unsubscribeSubject))
+ ?.valueChanges.pipe(debounceTime(500), takeUntilDestroyed())
.subscribe((projectedTotalAmount) => {
- this.projectedTotalAmountChanged.emit(projectedTotalAmount);
+ if (projectedTotalAmount !== null) {
+ this.projectedTotalAmountChanged.emit(projectedTotalAmount);
+ }
});
this.calculatorForm
.get('retirementDate')
- .valueChanges.pipe(debounceTime(500), takeUntil(this.unsubscribeSubject))
+ ?.valueChanges.pipe(debounceTime(500), takeUntilDestroyed())
.subscribe((retirementDate) => {
- this.retirementDateChanged.emit(retirementDate);
+ if (retirementDate !== null) {
+ this.retirementDateChanged.emit(retirementDate);
+ }
});
}
@@ -196,11 +205,11 @@ export class GfFireCalculatorComponent implements OnChanges, OnDestroy {
this.calculatorForm.patchValue(
{
annualInterestRate:
- this.calculatorForm.get('annualInterestRate').value,
+ this.calculatorForm.get('annualInterestRate')?.value,
paymentPerPeriod: this.getPMT(),
principalInvestmentAmount: this.calculatorForm.get(
'principalInvestmentAmount'
- ).value,
+ )?.value,
projectedTotalAmount:
Math.round(this.getProjectedTotalAmount()) || 0,
retirementDate:
@@ -210,7 +219,7 @@ export class GfFireCalculatorComponent implements OnChanges, OnDestroy {
emitEvent: false
}
);
- this.calculatorForm.get('principalInvestmentAmount').disable();
+ this.calculatorForm.get('principalInvestmentAmount')?.disable();
this.changeDetectorRef.markForCheck();
});
@@ -219,42 +228,43 @@ export class GfFireCalculatorComponent implements OnChanges, OnDestroy {
if (this.hasPermissionToUpdateUserSettings === true) {
this.calculatorForm
.get('annualInterestRate')
- .enable({ emitEvent: false });
- this.calculatorForm.get('paymentPerPeriod').enable({ emitEvent: false });
+ ?.enable({ emitEvent: false });
+ this.calculatorForm.get('paymentPerPeriod')?.enable({ emitEvent: false });
this.calculatorForm
.get('projectedTotalAmount')
- .enable({ emitEvent: false });
+ ?.enable({ emitEvent: false });
} else {
this.calculatorForm
.get('annualInterestRate')
- .disable({ emitEvent: false });
- this.calculatorForm.get('paymentPerPeriod').disable({ emitEvent: false });
+ ?.disable({ emitEvent: false });
+ this.calculatorForm
+ .get('paymentPerPeriod')
+ ?.disable({ emitEvent: false });
this.calculatorForm
.get('projectedTotalAmount')
- .disable({ emitEvent: false });
+ ?.disable({ emitEvent: false });
}
- this.calculatorForm.get('retirementDate').disable({ emitEvent: false });
+ this.calculatorForm.get('retirementDate')?.disable({ emitEvent: false });
}
public setMonthAndYear(
normalizedMonthAndYear: Date,
datepicker: MatDatepicker<Date>
) {
- const retirementDate = this.calculatorForm.get('retirementDate').value;
+ const retirementDate =
+ this.calculatorForm.get('retirementDate')?.value ??
+ this.DEFAULT_RETIREMENT_DATE;
const newRetirementDate = setMonth(
setYear(retirementDate, normalizedMonthAndYear.getFullYear()),
normalizedMonthAndYear.getMonth()
);
- this.calculatorForm.get('retirementDate').setValue(newRetirementDate);
+ this.calculatorForm.get('retirementDate')?.setValue(newRetirementDate);
datepicker.close();
}
public ngOnDestroy() {
this.chart?.destroy();
-
- this.unsubscribeSubject.next();
- this.unsubscribeSubject.complete();
}
private initialize() {
@@ -288,8 +298,6 @@ export class GfFireCalculatorComponent implements OnChanges, OnDestroy {
return `Total: ${new Intl.NumberFormat(this.locale, {
currency: this.currency,
- // eslint-disable-next-line @typescript-eslint/ban-ts-comment
- // @ts-ignore: Only supported from ES2020 or later
currencyDisplay: 'code',
style: 'currency'
}).format(totalAmount)}`;
@@ -426,12 +434,16 @@ export class GfFireCalculatorComponent implements OnChanges, OnDestroy {
}
private getPeriodsToRetire(): number {
- if (this.calculatorForm.get('projectedTotalAmount').value) {
+ const projectedTotalAmount = this.calculatorForm.get(
+ 'projectedTotalAmount'
+ )?.value;
+
+ if (projectedTotalAmount) {
let periods = this.fireCalculatorService.calculatePeriodsToRetire({
P: this.getP(),
PMT: this.getPMT(),
r: this.getR(),
- totalAmount: this.calculatorForm.get('projectedTotalAmount').value
+ totalAmount: projectedTotalAmount
});
if (periods === Infinity) {
@@ -453,12 +465,16 @@ export class GfFireCalculatorComponent implements OnChanges, OnDestroy {
}
private getPMT() {
- return this.calculatorForm.get('paymentPerPeriod').value;
+ return this.calculatorForm.get('paymentPerPeriod')?.value ?? 0;
}
private getProjectedTotalAmount() {
- if (this.calculatorForm.get('projectedTotalAmount').value) {
- return this.calculatorForm.get('projectedTotalAmount').value;
+ const projectedTotalAmount = this.calculatorForm.get(
+ 'projectedTotalAmount'
+ )?.value;
+
+ if (!isNil(projectedTotalAmount)) {
+ return projectedTotalAmount;
}
const { totalAmount } =
@@ -473,12 +489,12 @@ export class GfFireCalculatorComponent implements OnChanges, OnDestroy {
}
private getR() {
- return this.calculatorForm.get('annualInterestRate').value / 100;
+ return (this.calculatorForm.get('annualInterestRate')?.value ?? 0) / 100;
}
private getRetirementDate(): Date {
if (this.periodsToRetire === Number.MAX_SAFE_INTEGER) {
- return undefined;
+ return this.DEFAULT_RETIREMENT_DATE;
}
const monthsToRetire = this.periodsToRetire % 12;