From 143019f5b7d93757b35433785eb367ee7027ac68 Mon Sep 17 00:00:00 2001
From: Pierre-Gilles Leymarie <pierregilles.leymarie@gmail.com>
Date: Mon, 11 Sep 2023 11:42:47 +0200
Subject: [PATCH] Dashboard: Should display a warning when device state is too
 old (#1875)

---
 .../sensor-value/NoRecentValueBadge.jsx       |  9 ++
 .../sensor-value/SensorDeviceFeature.jsx      |  6 ++
 front/src/config/i18n/en.json                 |  4 +
 front/src/config/i18n/fr.json                 |  4 +
 .../settings-system/SettingsSystemPage.jsx    | 25 ++++++
 .../routes/settings/settings-system/index.js  | 52 +++++++++++-
 server/lib/device/device.get.js               | 30 ++++++-
 server/test/lib/device/device.get.test.js     | 82 +++++++------------
 server/utils/constants.js                     |  1 +
 server/utils/device.js                        | 11 +++
 10 files changed, 169 insertions(+), 55 deletions(-)
 create mode 100644 front/src/components/boxs/device-in-room/device-features/sensor-value/NoRecentValueBadge.jsx

diff --git a/front/src/components/boxs/device-in-room/device-features/sensor-value/NoRecentValueBadge.jsx b/front/src/components/boxs/device-in-room/device-features/sensor-value/NoRecentValueBadge.jsx
new file mode 100644
index 0000000000..299c645f61
--- /dev/null
+++ b/front/src/components/boxs/device-in-room/device-features/sensor-value/NoRecentValueBadge.jsx
@@ -0,0 +1,9 @@
+import { Text } from 'preact-i18n';
+
+const NoRecentValueBadge = () => (
+  <span class="badge bg-warning">
+    <Text id="dashboard.boxes.devicesInRoom.noRecentValue" />
+  </span>
+);
+
+export default NoRecentValueBadge;
diff --git a/front/src/components/boxs/device-in-room/device-features/sensor-value/SensorDeviceFeature.jsx b/front/src/components/boxs/device-in-room/device-features/sensor-value/SensorDeviceFeature.jsx
index b5fa18aa49..197daef96a 100644
--- a/front/src/components/boxs/device-in-room/device-features/sensor-value/SensorDeviceFeature.jsx
+++ b/front/src/components/boxs/device-in-room/device-features/sensor-value/SensorDeviceFeature.jsx
@@ -11,6 +11,7 @@ import IconBinaryDeviceValue from './IconBinaryDeviceValue';
 import SignalQualityDeviceValue from './SignalQualityDeviceValue';
 import ButtonClickDeviceValue from './ButtonClickDeviceValue';
 import TextDeviceValue from './TextDeviceValue';
+import NoRecentValueBadge from './NoRecentValueBadge';
 
 const DISPLAY_BY_FEATURE_CATEGORY = {
   [DEVICE_FEATURE_CATEGORIES.MOTION_SENSOR]: LastSeenDeviceValue,
@@ -39,6 +40,11 @@ const SensorDeviceType = ({ children, ...props }) => {
     elementType = BadgeNumberDeviceValue;
   }
 
+  // If the device feature has no recent value, we display a message to the user
+  if (feature.last_value_is_too_old) {
+    elementType = NoRecentValueBadge;
+  }
+
   return (
     <tr>
       <td>
diff --git a/front/src/config/i18n/en.json b/front/src/config/i18n/en.json
index 7acfef402c..21e388e72c 100644
--- a/front/src/config/i18n/en.json
+++ b/front/src/config/i18n/en.json
@@ -240,6 +240,7 @@
         "editRoomLabel": "Select the room you want to display here.",
         "editDeviceFeaturesLabel": "Select the devices you want to display. Only lights / sensors are showed here.",
         "noValue": "No value recorded",
+        "noRecentValue": "No recent value",
         "deviceTitle": "{{name}} - {{type}}",
         "addButton": "+",
         "substractButton": "-"
@@ -1828,6 +1829,9 @@
     "timezoneText": "The timezone is used in scheduled scene.",
     "deviceStateRetentionTime": "Keep Device State History",
     "deviceStateRetentionTimeDescription": "How long Gladys will keep your device states in database.",
+    "numberOfHoursBeforeStateIsOutdated": "Time to expiry of a state",
+    "numberOfHoursBeforeStateIsOutdatedDescription": "This delay corresponds to the number of hours before a sensor status is considered \"expired\" and therefore no longer displayed on the dashboard.",
+    "hours": "hours",
     "vacuumDatabaseTitle": "Database cleaning",
     "vacuumDatabaseDescription": "By clicking on this button, Gladys will start cleaning the database to free up space. This does not delete any data, it just physically remove old deleted data. Be careful, this task can take some time to run, and during that time Gladys will not be available.",
     "vacuumDatabaseButton": "Start database cleaning",
diff --git a/front/src/config/i18n/fr.json b/front/src/config/i18n/fr.json
index d105199780..5ad42629b3 100644
--- a/front/src/config/i18n/fr.json
+++ b/front/src/config/i18n/fr.json
@@ -240,6 +240,7 @@
         "editRoomLabel": "Sélectionnez la pièce que vous souhaitez afficher ici.",
         "editDeviceFeaturesLabel": "Sélectionnez les appareils que vous voulez afficher ici. Seuls les capteurs / et interrupteurs on/off sont supportés.",
         "noValue": "Aucune valeur enregistrée.",
+        "noRecentValue": "Pas de valeur récente",
         "deviceTitle": "{{name}} - {{type}}",
         "addButton": "+",
         "substractButton": "-"
@@ -1829,6 +1830,9 @@
     "timezoneText": "Le fuseau horaire est utilisé dans les scènes programmées.",
     "deviceStateRetentionTime": "Conserver l'historique des états des appareils",
     "deviceStateRetentionTimeDescription": "La période pendant laquelle Gladys gardera en base de données les états des appareils.",
+    "numberOfHoursBeforeStateIsOutdated": "Délai avant expiration d'un état",
+    "numberOfHoursBeforeStateIsOutdatedDescription": "Ce délai correspond au nombre d'heures avant qu'un état de capteur soit considéré comme \"périmé\" et ainsi plus affiché sur le tableau de bord.",
+    "hours": "heures",
     "vacuumDatabaseTitle": "Nettoyer la base de donnée",
     "vacuumDatabaseDescription": "En cliquant sur ce bouton, Gladys lancera un nettoyage de la base de donnée, ce qui libère de l'espace disque. Cette tâche ne supprime pas de données, elle re-arrange juste la donnée existante sur le disque et vide des vieilles lignes qui ne sont plus utilisées. Attention, cette opération peut prendre un certain temps sur les grosses bases de données, et pendant ce temps Gladys sera indisponible. Ne lancez pas cette commande si vous avez besoin de Gladys dans la prochaine heure.",
     "vacuumDatabaseButton": "Lancer le nettoyage",
diff --git a/front/src/routes/settings/settings-system/SettingsSystemPage.jsx b/front/src/routes/settings/settings-system/SettingsSystemPage.jsx
index 08051246b0..beab584b57 100644
--- a/front/src/routes/settings/settings-system/SettingsSystemPage.jsx
+++ b/front/src/routes/settings/settings-system/SettingsSystemPage.jsx
@@ -200,6 +200,31 @@ const SystemPage = ({ children, ...props }) => (
                 </label>
               </div>
             </form>
+            <form class="mt-4">
+              <label>
+                <Text id="systemSettings.numberOfHoursBeforeStateIsOutdated" />
+              </label>
+              <p>
+                <small>
+                  <Text id="systemSettings.numberOfHoursBeforeStateIsOutdatedDescription" />
+                </small>
+              </p>
+              <div class="input-group">
+                <input
+                  class="form-control"
+                  type="number"
+                  min="1"
+                  disabled={props.savingNumberOfHourseBeforeStateIsOutdated}
+                  value={props.numberOfHoursBeforeStateIsOutdated}
+                  onChange={props.updateNumberOfHoursBeforeStateIsOutdated}
+                />
+                <div class="input-group-append">
+                  <span class="input-group-text">
+                    <Text id="systemSettings.hours" />
+                  </span>
+                </div>
+              </div>
+            </form>
             <form class="mt-4">
               <label>
                 <Text id="systemSettings.vacuumDatabaseTitle" />
diff --git a/front/src/routes/settings/settings-system/index.js b/front/src/routes/settings/settings-system/index.js
index e3dc32ba60..7ab295116e 100644
--- a/front/src/routes/settings/settings-system/index.js
+++ b/front/src/routes/settings/settings-system/index.js
@@ -65,6 +65,26 @@ class SettingsSystem extends Component {
     });
   };
 
+  updateNumberOfHoursBeforeStateIsOutdated = async e => {
+    await this.setState({
+      numberOfHoursBeforeStateIsOutdated: e.target.value,
+      savingNumberOfHourseBeforeStateIsOutdated: true
+    });
+    try {
+      await this.props.httpClient.post(
+        `/api/v1/variable/${SYSTEM_VARIABLE_NAMES.DEVICE_STATE_NUMBER_OF_HOURS_BEFORE_STATE_IS_OUTDATED}`,
+        {
+          value: e.target.value
+        }
+      );
+    } catch (e) {
+      console.error(e);
+    }
+    await this.setState({
+      savingNumberOfHourseBeforeStateIsOutdated: false
+    });
+  };
+
   getDeviceStateHistoryPreference = async () => {
     try {
       const { value } = await this.props.httpClient.get(
@@ -78,12 +98,30 @@ class SettingsSystem extends Component {
     }
   };
 
+  getNumberOfHoursBeforeStateIsOutdated = async () => {
+    try {
+      const { value } = await this.props.httpClient.get(
+        `/api/v1/variable/${SYSTEM_VARIABLE_NAMES.DEVICE_STATE_NUMBER_OF_HOURS_BEFORE_STATE_IS_OUTDATED}`
+      );
+      this.setState({
+        numberOfHoursBeforeStateIsOutdated: value
+      });
+    } catch (e) {
+      console.error(e);
+      // if variable doesn't exist, value is 48
+      this.setState({
+        numberOfHoursBeforeStateIsOutdated: 48
+      });
+    }
+  };
+
   componentDidMount() {
     this.props.getInfos();
     this.props.getDiskSpace();
     this.props.getContainers();
     this.getTimezone();
     this.getDeviceStateHistoryPreference();
+    this.getNumberOfHoursBeforeStateIsOutdated();
     // we start the ping a little bit after to give it some time to breathe
     this.refreshPingIntervalId = setInterval(() => {
       this.props.ping();
@@ -101,7 +139,16 @@ class SettingsSystem extends Component {
     };
   }
 
-  render(props, { selectedTimezone, deviceStateHistoryInDays, vacuumStarted }) {
+  render(
+    props,
+    {
+      selectedTimezone,
+      deviceStateHistoryInDays,
+      vacuumStarted,
+      numberOfHoursBeforeStateIsOutdated,
+      savingNumberOfHourseBeforeStateIsOutdated
+    }
+  ) {
     const isDocker = get(props, 'systemInfos.is_docker');
     const upgradeDownloadInProgress = props.downloadUpgradeStatus === RequestStatus.Getting;
     const upgradeDownloadFinished = props.downloadUpgradeStatus === RequestStatus.Success;
@@ -118,7 +165,10 @@ class SettingsSystem extends Component {
         updateTimezone={this.updateTimezone}
         selectedTimezone={selectedTimezone}
         deviceStateHistoryInDays={deviceStateHistoryInDays}
+        numberOfHoursBeforeStateIsOutdated={numberOfHoursBeforeStateIsOutdated}
+        savingNumberOfHourseBeforeStateIsOutdated={savingNumberOfHourseBeforeStateIsOutdated}
         updateDeviceStateHistory={this.updateDeviceStateHistory}
+        updateNumberOfHoursBeforeStateIsOutdated={this.updateNumberOfHoursBeforeStateIsOutdated}
         vacuumDatabase={this.vacuumDatabase}
         vacuumStarted={vacuumStarted}
       />
diff --git a/server/lib/device/device.get.js b/server/lib/device/device.get.js
index f03f728a98..53051a3b64 100644
--- a/server/lib/device/device.get.js
+++ b/server/lib/device/device.get.js
@@ -1,7 +1,9 @@
 const { Op } = require('sequelize');
 const Sequelize = require('sequelize');
 const db = require('../../models');
+const { isNumeric } = require('../../utils/device');
 const { NotFoundError } = require('../../utils/coreErrors');
+const { SYSTEM_VARIABLE_NAMES } = require('../../utils/constants');
 
 const DEFAULT_OPTIONS = {
   skip: 0,
@@ -9,6 +11,8 @@ const DEFAULT_OPTIONS = {
   order_by: 'name',
 };
 
+const DEFAULT_DEVICE_STATE_NUMBER_OF_HOURS_BEFORE_STATE_IS_OUTDATED = 48;
+
 /**
  * @description Get list of device.
  * @param {object} [options] - Options of the query.
@@ -107,9 +111,33 @@ async function get(options) {
     queryParams.where = queryParams.where ? Sequelize.and(queryParams.where, condition) : condition;
   }
 
+  // A device state is not valid forever, we need to determine when a value is "outdated"
+  // The default is 48 hours, but it can be changed with this setting
+  let numberOfHoursBeforeStateIsOutdated = await this.variable.getValue(
+    SYSTEM_VARIABLE_NAMES.DEVICE_STATE_NUMBER_OF_HOURS_BEFORE_STATE_IS_OUTDATED,
+  );
+  if (!numberOfHoursBeforeStateIsOutdated) {
+    numberOfHoursBeforeStateIsOutdated = DEFAULT_DEVICE_STATE_NUMBER_OF_HOURS_BEFORE_STATE_IS_OUTDATED;
+  } else {
+    numberOfHoursBeforeStateIsOutdated = parseInt(numberOfHoursBeforeStateIsOutdated, 10);
+  }
+
   const devices = await db.Device.findAll(queryParams);
 
-  const devicesPlain = devices.map((device) => device.get({ plain: true }));
+  const devicesPlain = devices.map((device) => {
+    const rawDevice = device.get({ plain: true });
+    // We fill the "last_value_is_too_old" attribute for each feature
+    rawDevice.features.forEach((feature) => {
+      let lastValueInTimestamp = new Date(feature.last_value_changed).getTime();
+      if (!isNumeric(lastValueInTimestamp)) {
+        lastValueInTimestamp = 0;
+      }
+      const tooOldTimestamp = Date.now() - numberOfHoursBeforeStateIsOutdated * 60 * 60 * 1000;
+      const lastValueIsToOld = lastValueInTimestamp < tooOldTimestamp;
+      feature.last_value_is_too_old = lastValueIsToOld;
+    });
+    return rawDevice;
+  });
 
   return devicesPlain;
 }
diff --git a/server/test/lib/device/device.get.test.js b/server/test/lib/device/device.get.test.js
index f01f93b0a7..82af9ecda8 100644
--- a/server/test/lib/device/device.get.test.js
+++ b/server/test/lib/device/device.get.test.js
@@ -9,38 +9,49 @@ const event = new EventEmitter();
 const job = new Job(event);
 
 describe('Device.get', () => {
-  it('should get devices', async () => {
+  let device;
+  beforeEach(() => {
     const stateManager = new StateManager(event);
     const service = {
       getLocalServiceByName: fake.resolves({
         id: 'a810b8db-6d04-4697-bed3-c4b72c996279',
       }),
     };
-    const device = new Device(event, {}, stateManager, service, {}, {}, job);
+    const variable = {
+      getValue: fake.resolves('5'),
+    };
+    device = new Device(event, {}, stateManager, service, {}, variable, job);
+  });
+  it('should get devices', async () => {
     const devices = await device.get();
     expect(devices).to.be.instanceOf(Array);
   });
   it('should get devices filtered by service', async () => {
-    const stateManager = new StateManager(event);
-    const service = {
-      getLocalServiceByName: fake.resolves({
-        id: 'a810b8db-6d04-4697-bed3-c4b72c996279',
-      }),
-    };
-    const device = new Device(event, {}, stateManager, service, {}, {}, job);
     const devices = await device.get({
       service: 'test-service',
     });
     expect(devices).to.be.instanceOf(Array);
   });
+  it('should get devices with last_value_is_too_old', async () => {
+    const devices = await device.get();
+    expect(devices).to.be.instanceOf(Array);
+    devices.forEach((oneDevice) => {
+      oneDevice.features.forEach((feature) => {
+        expect(feature).to.have.property('last_value_is_too_old');
+      });
+    });
+  });
+  it('should get devices with last_value_is_too_old', async () => {
+    device.variable.getValue = fake.resolves(null);
+    const devices = await device.get();
+    expect(devices).to.be.instanceOf(Array);
+    devices.forEach((oneDevice) => {
+      oneDevice.features.forEach((feature) => {
+        expect(feature).to.have.property('last_value_is_too_old');
+      });
+    });
+  });
   it('should get devices filtered by service and name', async () => {
-    const stateManager = new StateManager(event);
-    const service = {
-      getLocalServiceByName: fake.resolves({
-        id: 'a810b8db-6d04-4697-bed3-c4b72c996279',
-      }),
-    };
-    const device = new Device(event, {}, stateManager, service, {}, {}, job);
     const devices = await device.get({
       service: 'test-service',
       search: 'this name does not exist',
@@ -50,13 +61,6 @@ describe('Device.get', () => {
       .and.have.lengthOf(0);
   });
   it('should get devices filtered by model', async () => {
-    const stateManager = new StateManager(event);
-    const service = {
-      getLocalServiceByName: fake.resolves({
-        id: 'a810b8db-6d04-4697-bed3-c4b72c996279',
-      }),
-    };
-    const device = new Device(event, {}, stateManager, service, {}, {}, job);
     const devices = await device.get({
       model: 'my-unknown-model',
     });
@@ -65,13 +69,6 @@ describe('Device.get', () => {
       .and.have.lengthOf(0);
   });
   it('should get devices filtered by device_feature_category', async () => {
-    const stateManager = new StateManager(event);
-    const service = {
-      getLocalServiceByName: fake.resolves({
-        id: 'a810b8db-6d04-4697-bed3-c4b72c996279',
-      }),
-    };
-    const device = new Device(event, {}, stateManager, service, {}, {}, job);
     const devices = await device.get({
       device_feature_category: 'my-unknown-category',
     });
@@ -80,13 +77,6 @@ describe('Device.get', () => {
       .and.have.lengthOf(0);
   });
   it('should get devices filtered by device_feature_type', async () => {
-    const stateManager = new StateManager(event);
-    const service = {
-      getLocalServiceByName: fake.resolves({
-        id: 'a810b8db-6d04-4697-bed3-c4b72c996279',
-      }),
-    };
-    const device = new Device(event, {}, stateManager, service, {}, {}, job);
     const devices = await device.get({
       device_feature_type: 'my-unknown-type',
     });
@@ -95,13 +85,6 @@ describe('Device.get', () => {
       .and.have.lengthOf(0);
   });
   it('should get devices filtered by device_feature_selectors', async () => {
-    const stateManager = new StateManager(event);
-    const service = {
-      getLocalServiceByName: fake.resolves({
-        id: 'a810b8db-6d04-4697-bed3-c4b72c996279',
-      }),
-    };
-    const device = new Device(event, {}, stateManager, service, {}, {}, job);
     const devices = await device.get({
       device_feature_selectors: 'test-device-feature,test-camera-image',
     });
@@ -110,13 +93,6 @@ describe('Device.get', () => {
       .and.have.lengthOf(2);
   });
   it('should return 0 device (take=0)', async () => {
-    const stateManager = new StateManager(event);
-    const service = {
-      getLocalServiceByName: fake.resolves({
-        id: 'a810b8db-6d04-4697-bed3-c4b72c996279',
-      }),
-    };
-    const device = new Device(event, {}, stateManager, service, {}, {}, job);
     const devices = await device.get({
       take: 0,
     });
@@ -129,8 +105,8 @@ describe('Device.get', () => {
     const service = {
       getLocalServiceByName: fake.resolves(null),
     };
-    const device = new Device(event, {}, stateManager, service, {}, {}, job);
-    const promise = device.get({
+    const deviceBroken = new Device(event, {}, stateManager, service, {}, {}, job);
+    const promise = deviceBroken.get({
       service: 'not-found-service',
     });
     return assert.isRejected(promise);
diff --git a/server/utils/constants.js b/server/utils/constants.js
index b19b4c35f6..4de848f105 100644
--- a/server/utils/constants.js
+++ b/server/utils/constants.js
@@ -88,6 +88,7 @@ const SYSTEM_VARIABLE_NAMES = {
   DEVICE_STATE_MONTHLY_AGGREGATES_RETENTION_IN_DAYS: 'DEVICE_STATE_MONTHLY_AGGREGATES_RETENTION_IN_DAYS',
   DEVICE_STATE_DAILY_AGGREGATES_RETENTION_IN_DAYS: 'DEVICE_STATE_DAILY_AGGREGATES_RETENTION_IN_DAYS',
   DEVICE_STATE_HOURLY_AGGREGATES_RETENTION_IN_DAYS: 'DEVICE_STATE_HOURLY_AGGREGATES_RETENTION_IN_DAYS',
+  DEVICE_STATE_NUMBER_OF_HOURS_BEFORE_STATE_IS_OUTDATED: 'DEVICE_STATE_NUMBER_OF_HOURS_BEFORE_STATE_IS_OUTDATED',
   GLADYS_GATEWAY_BACKUP_KEY: 'GLADYS_GATEWAY_BACKUP_KEY',
   GLADYS_GATEWAY_USERS_KEYS: 'GLADYS_GATEWAY_USERS_KEYS',
   GLADYS_GATEWAY_GOOGLE_HOME_USER_IS_CONNECTED_WITH_GATEWAY:
diff --git a/server/utils/device.js b/server/utils/device.js
index 4e6eed8da0..e3e75aabea 100644
--- a/server/utils/device.js
+++ b/server/utils/device.js
@@ -190,6 +190,16 @@ function normalize(value, currentMin, currentMax, newRangeMin, newRangeMax) {
   return ((newRangeMax - newRangeMin) * (value - currentMin)) / (currentMax - currentMin) + newRangeMin;
 }
 
+/**
+ * @description Check if variable is number.
+ * @param {string|number} n - Variable to check.
+ * @returns {boolean} Return true if variable is number.
+ * @example isNumeric(12)
+ */
+function isNumeric(n) {
+  return !Number.isNaN(parseFloat(n)) && Number.isFinite(n);
+}
+
 module.exports = {
   getDeviceParam,
   setDeviceParam,
@@ -198,4 +208,5 @@ module.exports = {
   mergeFeatures,
   mergeDevices,
   normalize,
+  isNumeric,
 };