#119 feat: Merge the initial config with defaults

TWilkin · Jun 11, 2024 · fae9a45 · fae9a45
1 parent 903e331
commit fae9a45
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 36 deletions.
diff --git a/services/api/src/services/DeviceStateService.test.ts b/services/api/src/services/DeviceStateService.test.ts
@@ -54,6 +54,7 @@ describe("DeviceStateService", () => {
                 type: "Light",
                 location: "Hallway",
                 categories: ["Light", "Something"],
+                visible: false,
             },
         ]);
 
@@ -127,7 +128,7 @@ describe("DeviceStateService", () => {
         expect(device.name).toBe("HallwayLight");
         expect(device.display_name).toBe("Hallway Light");
         expect(device.type).toBe("Light");
-        expect(device.visible).toBeTruthy();
+        expect(device.visible).toBeFalsy();
         expect(device.location).toBe("Hallway");
         expect(device.categories).toStrictEqual(["Light", "Something"]);
     });
@@ -256,6 +257,7 @@ describe("DeviceStateService", () => {
             expect(device.display_name).toBe("Hallway Light");
             expect(device.location).toBe("Hallway");
             expect(device.categories).toStrictEqual(["Light", "Something"]);
+            expect(device.visible).toBeFalsy();
 
             // check the initial state
             expect(device.state).toBe(DeviceState.Unknown);
@@ -281,6 +283,7 @@ describe("DeviceStateService", () => {
             expect(device.display_name).toBe("Office Socket");
             expect(device.location).toBe("Office");
             expect(device.categories).toStrictEqual(["Socket", "Something Else"]);
+            expect(device.visible).toBeTruthy();
 
             // check the state is unchanged
             expect(device.state).toBe(DeviceState.Unknown);
@@ -311,6 +314,7 @@ describe("DeviceStateService", () => {
             // check the device is new
             expect(device.name).toBe("Something Else");
             expect(device.display_name).toBe("Office Socket");
+            expect(device.visible).toBeTruthy();
 
             // check the state is initialised
             expect(device.state).toBe(DeviceState.Unknown);

diff --git a/services/api/src/services/DeviceStateService.ts b/services/api/src/services/DeviceStateService.ts
@@ -108,7 +108,7 @@ export default class DeviceStateService extends DeviceStateListener {
                 // otherwise merge them
                 return {
                     ...device,
-                    ...newConfig,
+                    ...this.defaultDevice(newConfig),
                     display_name: newConfig.displayName ?? device.display_name,
                 };
             })
@@ -130,19 +130,18 @@ export default class DeviceStateService extends DeviceStateListener {
         this._devices = this.config.devices.map(this.initialiseDevice);
     }
 
-    private initialiseDevice(device: IDevice): Device {
-        return {
-            name: device.name,
-            display_name: device.displayName,
-            type: device.type,
-            visible: device.visible ?? true,
-            location: device.location,
-            categories: device.categories,
-            state: DeviceState.Unknown,
-            since: -1,
-            battery: undefined,
-            batterySince: undefined,
-            charging: false,
-        };
-    }
+    private initialiseDevice = (device: IDevice): Device => ({
+        ...this.defaultDevice(device),
+        display_name: device.displayName,
+        state: DeviceState.Unknown,
+        since: -1,
+        battery: undefined,
+        batterySince: undefined,
+        charging: false,
+    });
+
+    private defaultDevice = (device: IDevice) => ({
+        ...device,
+        visible: device.visible ?? true,
+    });
 }
diff --git a/services/api/src/services/SensorStateService.ts b/services/api/src/services/SensorStateService.ts
@@ -117,7 +117,7 @@ export default class SensorStateService extends SensorStateListener {
                 // otherwise merge them
                 return {
                     ...sensor,
-                    ...newConfig,
+                    ...this.defaultSensor(newConfig),
                     display_name: newConfig.displayName ?? sensor.display_name,
                 };
             })
@@ -139,22 +139,24 @@ export default class SensorStateService extends SensorStateListener {
         this._sensors = this.config.sensors.map(this.initialiseSensor);
     }
 
-    private initialiseSensor(sensor: ISensor): Sensor {
-        return {
-            name: sensor.name,
-            display_name: sensor.displayName ?? sensor.name,
-            type: sensor.type,
-            location: sensor.location,
-            entity: sensor.entity ?? sensor.name,
-            action: sensor.action ?? sensor.type,
-            visible: sensor.visible ?? true,
-            state: undefined,
-            value: undefined,
-            unit: undefined,
-            since: -1,
-            battery: undefined,
-            batterySince: undefined,
-            charging: false,
-        };
-    }
+    /** The options a sensor should have when it's first loaded. */
+    private initialiseSensor = (sensor: ISensor): Sensor => ({
+        ...this.defaultSensor(sensor),
+        display_name: sensor.displayName ?? sensor.name,
+        state: undefined,
+        value: undefined,
+        unit: undefined,
+        since: -1,
+        battery: undefined,
+        batterySince: undefined,
+        charging: false,
+    });
+
+    /** The optional options default values for ISensor. */
+    private defaultSensor = (sensor: ISensor) => ({
+        ...sensor,
+        entity: sensor.entity ?? sensor.name,
+        action: sensor.action ?? sensor.type,
+        visible: sensor.visible ?? true,
+    });
 }