Centralize device functions (setDeviceParam, setDeviceFeature) (#1978)

GladysAssistant · Dec 15, 2023 · 4fa39d6 · 4fa39d6
1 parent b2ab4f6
commit 4fa39d6
Show file tree

Hide file tree

Showing 11 changed files with 95 additions and 151 deletions.
diff --git a/server/services/bluetooth/lib/commands/bluetooth.scanDevice.js b/server/services/bluetooth/lib/commands/bluetooth.scanDevice.js
@@ -2,7 +2,7 @@ const Promise = require('bluebird');
 
 const logger = require('../../../../utils/logger');
 const { EVENTS, WEBSOCKET_MESSAGE_TYPES } = require('../../../../utils/constants');
-const { setDeviceParam } = require('../../../../utils/setDeviceParam');
+const { setDeviceParam } = require('../../../../utils/device');
 
 const { INFORMATION_SERVICES } = require('../device/bluetooth.information');
 const { PARAMS } = require('../utils/bluetooth.constants');
@@ -20,7 +20,7 @@ async function scanDevice(peripheralUuid) {
 
   const device = this.discoveredDevices[peripheralUuid];
 
-  setDeviceParam(device, PARAMS.LOADED, false);
+  setDeviceParam(device, PARAMS.LOADED, 'false');
   this.gladys.event.emit(EVENTS.WEBSOCKET.SEND_ALL, {
     type: WEBSOCKET_MESSAGE_TYPES.BLUETOOTH.DISCOVER,
     payload: device,
@@ -61,7 +61,7 @@ async function scanDevice(peripheralUuid) {
   } catch (e) {
     logger.warn(`Bluetooth: unable to scan ${peripheralUuid} - ${e}`);
   } finally {
-    setDeviceParam(device, PARAMS.LOADED, true);
+    setDeviceParam(device, PARAMS.LOADED, 'true');
     this.gladys.event.emit(EVENTS.WEBSOCKET.SEND_ALL, {
       type: WEBSOCKET_MESSAGE_TYPES.BLUETOOTH.DISCOVER,
       payload: device,

diff --git a/server/services/bluetooth/lib/device/bluetooth.information.js b/server/services/bluetooth/lib/device/bluetooth.information.js
@@ -7,8 +7,8 @@ const {
   DEVICE_POLL_FREQUENCIES,
 } = require('../../../../utils/constants');
 const { addSelector } = require('../../../../utils/addSelector');
-const { setDeviceFeature } = require('../../../../utils/setDeviceFeature');
-const { setDeviceParam } = require('../../../../utils/setDeviceParam');
+const { setDeviceFeature } = require('../../../../utils/device');
+const { setDeviceParam } = require('../../../../utils/device');
 
 const { PARAMS } = require('../utils/bluetooth.constants');
 

diff --git a/server/services/bluetooth/lib/device/bluetooth.transformToDevice.js b/server/services/bluetooth/lib/device/bluetooth.transformToDevice.js
@@ -1,5 +1,5 @@
 const { addSelector } = require('../../../../utils/addSelector');
-const { setDeviceParam } = require('../../../../utils/setDeviceParam');
+const { setDeviceParam } = require('../../../../utils/device');
 
 const { PARAMS } = require('../utils/bluetooth.constants');
 const { encodeParamValue } = require('./bluetooth.information');
@@ -24,7 +24,7 @@ function transformToDevice(peripheral) {
   };
 
   if (!connectable) {
-    setDeviceParam(device, PARAMS.LOADED, true);
+    setDeviceParam(device, PARAMS.LOADED, 'true');
   }
 
   addSelector(device);

diff --git a/server/test/services/bluetooth/lib/commands/bluetooth.scanDevice.test.js b/server/test/services/bluetooth/lib/commands/bluetooth.scanDevice.test.js
@@ -96,7 +96,7 @@ describe('bluetooth.scanDevice', () => {
       params: [
         {
           name: PARAMS.LOADED,
-          value: true,
+          value: 'true',
         },
       ],
     });
@@ -132,7 +132,7 @@ describe('bluetooth.scanDevice', () => {
       params: [
         {
           name: PARAMS.LOADED,
-          value: true,
+          value: 'true',
         },
       ],
     });
@@ -169,7 +169,7 @@ describe('bluetooth.scanDevice', () => {
       params: [
         {
           name: PARAMS.LOADED,
-          value: true,
+          value: 'true',
         },
       ],
     });
@@ -206,7 +206,7 @@ describe('bluetooth.scanDevice', () => {
       params: [
         {
           name: PARAMS.LOADED,
-          value: true,
+          value: 'true',
         },
         {
           name: PARAMS.MANUFACTURER,
@@ -248,7 +248,7 @@ describe('bluetooth.scanDevice', () => {
       params: [
         {
           name: PARAMS.LOADED,
-          value: true,
+          value: 'true',
         },
       ],
     });
@@ -301,7 +301,7 @@ describe('bluetooth.scanDevice', () => {
       params: [
         {
           name: PARAMS.LOADED,
-          value: true,
+          value: 'true',
         },
       ],
     });
@@ -350,7 +350,7 @@ describe('bluetooth.scanDevice', () => {
       params: [
         {
           name: PARAMS.LOADED,
-          value: true,
+          value: 'true',
         },
       ],
     });
@@ -400,7 +400,7 @@ describe('bluetooth.scanDevice', () => {
       params: [
         {
           name: PARAMS.LOADED,
-          value: true,
+          value: 'true',
         },
       ],
     });
@@ -450,7 +450,7 @@ describe('bluetooth.scanDevice', () => {
       params: [
         {
           name: PARAMS.LOADED,
-          value: true,
+          value: 'true',
         },
       ],
     });

diff --git a/server/test/services/bluetooth/lib/device/bluetooth.transformToDevice.test.js b/server/test/services/bluetooth/lib/device/bluetooth.transformToDevice.test.js
@@ -40,7 +40,7 @@ describe('bluetooth.transformToDevice', () => {
       params: [
         {
           name: 'loaded',
-          value: true,
+          value: 'true',
         },
       ],
     };
@@ -61,7 +61,7 @@ describe('bluetooth.transformToDevice', () => {
       params: [
         {
           name: 'loaded',
-          value: true,
+          value: 'true',
         },
       ],
     };
@@ -81,7 +81,7 @@ describe('bluetooth.transformToDevice', () => {
       params: [
         {
           name: 'loaded',
-          value: true,
+          value: 'true',
         },
       ],
     };

diff --git a/server/test/services/bluetooth/lib/events/bluetooth.discover.test.js b/server/test/services/bluetooth/lib/events/bluetooth.discover.test.js
@@ -57,7 +57,7 @@ describe('bluetooth.discover event', () => {
       name: 'ADDRESS',
       selector: 'bluetooth-uuid',
       features: [],
-      params: [{ name: 'loaded', value: true }],
+      params: [{ name: 'loaded', value: 'true' }],
     };
 
     assert.calledWith(eventWS, { payload: expectedWSPeripheral, type: 'bluetooth.discover' });

diff --git a/server/test/utils/device.test.js b/server/test/utils/device.test.js
@@ -3,6 +3,7 @@ const {
   getDeviceParam,
   setDeviceParam,
   getDeviceFeature,
+  setDeviceFeature,
   hasDeviceChanged,
   mergeFeatures,
   mergeDevices,
@@ -135,6 +136,54 @@ describe('getDeviceFeature', () => {
   });
 });
 
+describe('setDeviceFeature', () => {
+  it('should create array and add feature', () => {
+    const device = {};
+    const feature = {
+      selector: 'selector',
+    };
+
+    setDeviceFeature(device, feature);
+
+    expect(device).deep.eq({
+      features: [feature],
+    });
+  });
+
+  it('should add feature to array', () => {
+    const device = { features: [{ selector: 'no-match' }] };
+    const feature = {
+      selector: 'selector',
+    };
+
+    setDeviceFeature(device, feature);
+
+    expect(device).deep.eq({
+      features: [{ selector: 'no-match' }, feature],
+    });
+  });
+
+  it('should replace feature into array', () => {
+    const device = {
+      features: [
+        {
+          selector: 'selector',
+        },
+      ],
+    };
+    const feature = {
+      name: 'name',
+      selector: 'selector',
+    };
+
+    setDeviceFeature(device, feature);
+
+    expect(device).deep.eq({
+      features: [feature],
+    });
+  });
+});
+
 describe('hasDeviceChanged', () => {
   it('should be same device', () => {
     const feature1 = buildFeature('test-1');

diff --git a/server/test/utils/setDeviceFeature.test.js b/server/test/utils/setDeviceFeature.test.js
diff --git a/server/test/utils/setDeviceParam.test.js b/server/test/utils/setDeviceParam.test.js
diff --git a/server/utils/device.js b/server/utils/device.js
@@ -69,6 +69,31 @@ function getDeviceFeature(device, category, type) {
   return null;
 }
 
+/**
+ * @description Add or update a param to a device.
+ * @param {object} device - Device to add parameter.
+ * @param {object} feature - The feature to add.
+ * @returns {object} The device.
+ * @example
+ * setDeviceFeature({ features: [] }, { selector: 'feature' })
+ */
+function setDeviceFeature(device, feature) {
+  let { features } = device;
+  if (!features) {
+    features = [];
+    device.features = features;
+  }
+
+  const featureIndex = features.findIndex((p) => p.selector === feature.selector);
+  if (featureIndex >= 0) {
+    features[featureIndex] = feature;
+  } else {
+    features.push(feature);
+  }
+
+  return device;
+}
+
 const matchFeature = (features, feature) => {
   return features.findIndex((f) => f.external_id === feature.external_id);
 };
@@ -204,6 +229,7 @@ module.exports = {
   getDeviceParam,
   setDeviceParam,
   getDeviceFeature,
+  setDeviceFeature,
   hasDeviceChanged,
   mergeFeatures,
   mergeDevices,