feat: enhance Lyfi actions with error handling and logging; update version to 0.5.1

Author: oldrev

client/packages/borneo_wot/lib/borneo/lyfi/wot_actions.dart

@@ -4,51 +4,65 @@ import 'package:borneo_kernel/drivers/borneo/device_api.dart';
 import 'package:borneo_kernel/drivers/borneo/lyfi/api.dart';
 import 'package:borneo_kernel/drivers/borneo/lyfi/models.dart';
 import 'package:borneo_kernel_abstractions/device.dart';
+import 'package:logger/logger.dart';
 import 'package:lw_wot/wot.dart';
 
 /// Custom action for switching Lyfi states
 class LyfiSwitchStateAction extends WotAction<Map<String, dynamic>> {
-  final LyfiState targetState;
   final ILyfiDeviceApi lyfiApi;
   final Device device;
+  final Logger? logger;
 
   LyfiSwitchStateAction({
     required super.id,
     required super.thing,
-    required this.targetState,
     required this.lyfiApi,
     required this.device,
-  }) : super(name: 'switchState', input: {'state': targetState.name});
+    required super.input,
+    this.logger,
+  }) : super(name: 'switchState');
 
   @override
   Future<void> performAction() async {
-    await lyfiApi.switchState(device, targetState);
-    thing.findProperty('state')?.value.notifyOfExternalUpdate(targetState);
+    try {
+      final targetState = LyfiState.fromString(input['state']);
+      await lyfiApi.switchState(device, targetState);
+      thing.findProperty('state')?.value.notifyOfExternalUpdate(input['state']);
+    } catch (e, st) {
+      logger?.e('switchState failed for device ${device.id}', error: e, stackTrace: st);
+      rethrow;
+    }
   }
 }
 
 /// Custom action for switching Lyfi modes
 class LyfiSwitchModeAction extends WotAction<Map<String, dynamic>?> {
-  final LyfiMode targetMode;
   final ILyfiDeviceApi lyfiApi;
   final Device device;
-  final List<int>? color;
+  final Logger? logger;
 
   LyfiSwitchModeAction({
     required super.id,
     required super.thing,
-    required this.targetMode,
     required this.lyfiApi,
     required this.device,
-    this.color,
-  }) : super(name: 'switchMode', input: {'mode': targetMode.name, 'color': ?color});
+    required super.input,
+    this.logger,
+  }) : super(name: 'switchMode');
 
   @override
   Future<void> performAction() async {
-    await lyfiApi.switchMode(device, targetMode);
-    thing.findProperty('mode')?.value.notifyOfExternalUpdate(targetMode);
-    if (color != null && targetMode == LyfiMode.manual) {
-      await lyfiApi.setColor(device, color!);
+    try {
+      final targetMode = LyfiMode.fromString(input!['mode']);
+      final targetColor = input?['color'];
+      await lyfiApi.switchMode(device, targetMode);
+      thing.findProperty('mode')?.value.notifyOfExternalUpdate(input!['mode']);
+      if (targetColor != null && targetMode == LyfiMode.manual) {
+        await lyfiApi.setColor(device, targetColor);
+      }
+    } catch (e, st) {
+      logger?.e('switchMode failed for device ${device.id}', error: e, stackTrace: st);
+      rethrow;
     }
   }
 }
@@ -58,19 +72,26 @@ class LyfiSetColorAction extends WotAction<Map<String, dynamic>> {
   final List<int> color;
   final ILyfiDeviceApi lyfiApi;
   final Device device;
+  final Logger? logger;
 
   LyfiSetColorAction({
     required super.id,
     required super.thing,
     required this.color,
     required this.lyfiApi,
     required this.device,
+    this.logger,
   }) : super(name: 'setColor', input: {'color': color});
 
   @override
   Future<void> performAction() async {
-    await lyfiApi.setColor(device, color);
-    thing.findProperty('color')!.value.notifyOfExternalUpdate(color);
+    try {
+      await lyfiApi.setColor(device, color);
+      thing.findProperty('color')!.value.notifyOfExternalUpdate(color);
+    } catch (e, st) {
+      logger?.e('setColor failed for device ${device.id}', error: e, stackTrace: st);
+      rethrow;
+    }
   }
 }
 
@@ -79,19 +100,26 @@ class LyfiSetScheduleAction extends WotAction<Map<String, dynamic>> {
   final ScheduleTable schedule;
   final ILyfiDeviceApi lyfiApi;
   final Device device;
+  final Logger? logger;
 
   LyfiSetScheduleAction({
     required super.id,
     required super.thing,
     required this.schedule,
     required this.lyfiApi,
     required this.device,
+    this.logger,
   }) : super(name: 'setSchedule', input: {'schedule': schedule.map((s) => s.toPayload()).toList()});
 
   @override
   Future<void> performAction() async {
-    await lyfiApi.setSchedule(device, schedule);
-    thing.findProperty('schedule')!.value.notifyOfExternalUpdate(schedule);
+    try {
+      await lyfiApi.setSchedule(device, schedule);
+      thing.findProperty('schedule')!.value.notifyOfExternalUpdate(schedule);
+    } catch (e, st) {
+      logger?.e('setSchedule failed for device ${device.id}', error: e, stackTrace: st);
+      rethrow;
+    }
   }
 }
 
@@ -100,13 +128,15 @@ class LyfiSetAcclimationAction extends WotAction<Map<String, dynamic>> {
   final AcclimationSettings settings;
   final ILyfiDeviceApi lyfiApi;
   final Device device;
+  final Logger? logger;
 
   LyfiSetAcclimationAction({
     required super.id,
     required super.thing,
     required this.settings,
     required this.lyfiApi,
     required this.device,
+    this.logger,
   }) : super(
          name: 'setAcclimation',
          input: {
@@ -119,8 +149,13 @@ class LyfiSetAcclimationAction extends WotAction<Map<String, dynamic>> {
 
   @override
   Future<void> performAction() async {
-    await lyfiApi.setAcclimation(device, settings);
-    thing.findProperty('acclimation')?.value.notifyOfExternalUpdate(settings);
+    try {
+      await lyfiApi.setAcclimation(device, settings);
+      thing.findProperty('acclimation')?.value.notifyOfExternalUpdate(settings);
+    } catch (e, st) {
+      logger?.e('setAcclimation failed for device ${device.id}', error: e, stackTrace: st);
+      rethrow;
+    }
   }
 }
 
@@ -129,18 +164,25 @@ class LyfiSetLocationAction extends WotAction<Map<String, dynamic>> {
   final GeoLocation location;
   final ILyfiDeviceApi lyfiApi;
   final Device device;
+  final Logger? logger;
 
   LyfiSetLocationAction({
     required super.id,
     required super.thing,
     required this.location,
     required this.lyfiApi,
     required this.device,
+    this.logger,
   }) : super(name: 'setLocation', input: {'lat': location.lat, 'lng': location.lng});
 
   @override
   Future<void> performAction() async {
-    await lyfiApi.setLocation(device, location);
+    try {
+      await lyfiApi.setLocation(device, location);
+    } catch (e, st) {
+      logger?.e('setLocation failed for device ${device.id}', error: e, stackTrace: st);
+      rethrow;
+    }
   }
 }
 
@@ -149,18 +191,25 @@ class LyfiSetCorrectionMethodAction extends WotAction<Map<String, dynamic>> {
   final LedCorrectionMethod method;
   final ILyfiDeviceApi lyfiApi;
   final Device device;
+  final Logger? logger;
 
   LyfiSetCorrectionMethodAction({
     required super.id,
     required super.thing,
     required this.method,
     required this.lyfiApi,
     required this.device,
+    this.logger,
   }) : super(name: 'setCorrectionMethod', input: {'method': method.name});
 
   @override
   Future<void> performAction() async {
-    await lyfiApi.setCorrectionMethod(device, method);
+    try {
+      await lyfiApi.setCorrectionMethod(device, method);
+    } catch (e, st) {
+      logger?.e('setCorrectionMethod failed for device ${device.id}', error: e, stackTrace: st);
+      rethrow;
+    }
   }
 }
 
@@ -169,18 +218,25 @@ class LyfiSetPowerBehaviorAction extends WotAction<Map<String, dynamic>> {
   final PowerBehavior behavior;
   final IBorneoDeviceApi borneoApi;
   final Device device;
+  final Logger? logger;
 
   LyfiSetPowerBehaviorAction({
     required super.id,
     required super.thing,
     required this.behavior,
     required this.borneoApi,
     required this.device,
+    this.logger,
   }) : super(name: 'setPowerBehavior', input: {'behavior': behavior.name});
 
   @override
   Future<void> performAction() async {
-    await borneoApi.setPowerBehavior(device, behavior);
+    try {
+      await borneoApi.setPowerBehavior(device, behavior);
+    } catch (e, st) {
+      logger?.e('setPowerBehavior failed for device ${device.id}', error: e, stackTrace: st);
+      rethrow;
+    }
   }
 }
 
@@ -189,20 +245,27 @@ class LyfiSetMoonConfigAction extends WotAction<Map<String, dynamic>> {
   final MoonConfig config;
   final ILyfiDeviceApi lyfiApi;
   final Device device;
+  final Logger? logger;
 
   LyfiSetMoonConfigAction({
     required super.id,
     required super.thing,
     required this.config,
     required this.lyfiApi,
     required this.device,
+    this.logger,
   }) : super(name: 'setMoonConfig', input: {'config': config.toPayload()});
 
   @override
   Future<void> performAction() async {
-    await lyfiApi.setMoonConfig(device, config);
-    final curve = await lyfiApi.getMoonCurve(device);
-    thing.findProperty('moonConfig')!.value.notifyOfExternalUpdate(config);
-    thing.findProperty('moonCurve')!.value.notifyOfExternalUpdate(curve);
+    try {
+      await lyfiApi.setMoonConfig(device, config);
+      final curve = await lyfiApi.getMoonCurve(device);
+      thing.findProperty('moonConfig')!.value.notifyOfExternalUpdate(config);
+      thing.findProperty('moonCurve')!.value.notifyOfExternalUpdate(curve);
+    } catch (e, st) {
+      logger?.e('setMoonConfig failed for device ${device.id}', error: e, stackTrace: st);
+      rethrow;
+    }
   }
 }

client/packages/borneo_wot/lib/borneo/lyfi/wot_thing.actions.dart

@@ -12,14 +12,13 @@ extension LyfiThingActions on LyfiThing {
           input: {'state': 'string'},
         ),
         (thing, input) {
-          final stateName = input['state'] as String;
-          final targetState = LyfiState.values.firstWhere((e) => e.name == stateName);
           return LyfiSwitchStateAction(
             id: DateTime.now().millisecondsSinceEpoch.toString(),
             thing: thing,
-            targetState: targetState,
             lyfiApi: _requireLyfiApi(),
             device: _requireDevice(),
+            logger: logger,
+            input: input,
           );
         },
       );
@@ -33,16 +32,13 @@ extension LyfiThingActions on LyfiThing {
           input: {'mode': 'string', 'color': 'array'},
         ),
         (thing, input) {
-          final modeName = input['mode'] as String;
-          final targetMode = LyfiMode.values.firstWhere((e) => e.name == modeName);
-          final color = input['color'] as List<int>?;
           return LyfiSwitchModeAction(
             id: DateTime.now().millisecondsSinceEpoch.toString(),
             thing: thing,
-            targetMode: targetMode,
             lyfiApi: _requireLyfiApi(),
             device: _requireDevice(),
-            color: color,
+            input: input,
+            logger: logger,
           );
         },
       );
@@ -63,6 +59,7 @@ extension LyfiThingActions on LyfiThing {
             color: color,
             lyfiApi: _requireLyfiApi(),
             device: _requireDevice(),
+            logger: logger,
           );
         },
       );
@@ -83,6 +80,7 @@ extension LyfiThingActions on LyfiThing {
             schedule: schedule,
             lyfiApi: _requireLyfiApi(),
             device: _requireDevice(),
+            logger: logger,
           );
         },
       );
@@ -108,6 +106,7 @@ extension LyfiThingActions on LyfiThing {
             settings: settings,
             lyfiApi: _requireLyfiApi(),
             device: _requireDevice(),
+            logger: logger,
           );
         },
       );
@@ -128,6 +127,7 @@ extension LyfiThingActions on LyfiThing {
             location: location,
             lyfiApi: _requireLyfiApi(),
             device: _requireDevice(),
+            logger: logger,
           );
         },
       );
@@ -149,6 +149,7 @@ extension LyfiThingActions on LyfiThing {
             method: method,
             lyfiApi: _requireLyfiApi(),
             device: _requireDevice(),
+            logger: logger,
           );
         },
       );
@@ -170,6 +171,7 @@ extension LyfiThingActions on LyfiThing {
             behavior: behavior,
             borneoApi: _requireBorneoApi(),
             device: _requireDevice(),
+            logger: logger,
           );
         },
       );
@@ -190,6 +192,7 @@ extension LyfiThingActions on LyfiThing {
             config: config,
             lyfiApi: _requireLyfiApi(),
             device: _requireDevice(),
+            logger: logger,
           );
         },
       );