From 0ad221ce979fe746022489283ade745bb8afdf02 Mon Sep 17 00:00:00 2001
From: zaldih <imzaldih@gmail.com>
Date: Mon, 27 May 2024 00:33:30 +0200
Subject: [PATCH] feat(stats): highlight values when updating

---
 src/ui/components/header/stats.ui.ts | 77 +++++++++++++++++++++++++---
 1 file changed, 70 insertions(+), 7 deletions(-)

diff --git a/src/ui/components/header/stats.ui.ts b/src/ui/components/header/stats.ui.ts
index 29b17844..e82dde5a 100644
--- a/src/ui/components/header/stats.ui.ts
+++ b/src/ui/components/header/stats.ui.ts
@@ -4,8 +4,27 @@ import { ResultsService } from '../../../services/results.service.js';
 import { LoggerService } from '../../../services/logger.service.js';
 import colors from 'colors';
 import { IConfig } from 'src/interfaces/config.interface.js';
+import { IPosition } from 'src/interfaces/ui-positions.interface.js';
+
+interface ShowStatProps {
+  description: string;
+  value: string;
+  lastValueKey: 'totalSpace' | 'spaceReleased';
+  position: IPosition;
+  updateColor: 'green' | 'yellow';
+}
 
 export class StatsUi extends BaseUi {
+  private lastValues = {
+    totalSpace: '',
+    spaceReleased: '',
+  };
+
+  private timeouts = {
+    totalSpace: setTimeout(() => {}),
+    spaceReleased: setTimeout(() => {}),
+  };
+
   constructor(
     private readonly config: IConfig,
     private readonly resultsService: ResultsService,
@@ -17,20 +36,64 @@ export class StatsUi extends BaseUi {
   render(): void {
     const { totalSpace, spaceReleased } = this.resultsService.getStats();
 
-    const totalSpacePosition = { ...UI_POSITIONS.TOTAL_SPACE };
-    const spaceReleasedPosition = { ...UI_POSITIONS.SPACE_RELEASED };
-
-    totalSpacePosition.x += INFO_MSGS.TOTAL_SPACE.length;
-    spaceReleasedPosition.x += INFO_MSGS.SPACE_RELEASED.length;
+    this.showStat({
+      description: INFO_MSGS.TOTAL_SPACE,
+      value: totalSpace,
+      lastValueKey: 'totalSpace',
+      position: UI_POSITIONS.TOTAL_SPACE,
+      updateColor: 'yellow',
+    });
 
-    this.printAt(totalSpace, totalSpacePosition);
-    this.printAt(spaceReleased, spaceReleasedPosition);
+    this.showStat({
+      description: INFO_MSGS.SPACE_RELEASED,
+      value: spaceReleased,
+      lastValueKey: 'spaceReleased',
+      position: UI_POSITIONS.SPACE_RELEASED,
+      updateColor: 'green',
+    });
 
     if (this.config.showErrors) {
       this.showErrorsCount();
     }
   }
 
+  /** Print the value of the stat and if it is a different value from the
+   * previous run, highlight it for a while.
+   */
+  private showStat({
+    description,
+    value,
+    lastValueKey,
+    position,
+    updateColor,
+  }: ShowStatProps): void {
+    if (value === this.lastValues[lastValueKey]) {
+      return;
+    }
+
+    const statPosition = { ...position };
+    statPosition.x += description.length;
+
+    // If is first render, initialize.
+    if (!this.lastValues[lastValueKey]) {
+      this.printAt(value, statPosition);
+      this.lastValues[lastValueKey] = value;
+      return;
+    }
+
+    this.printAt(colors[updateColor](`${value} ▲`), statPosition);
+
+    if (this.timeouts[lastValueKey]) {
+      clearTimeout(this.timeouts[lastValueKey]);
+    }
+
+    this.timeouts[lastValueKey] = setTimeout(() => {
+      this.printAt(value + '  ', statPosition);
+    }, 700);
+
+    this.lastValues[lastValueKey] = value;
+  }
+
   private showErrorsCount(): void {
     const errors = this.logger.get('error').length;