create debug logger

Author: remonh87

example/lib/src/ui/device_list.dart

@@ -125,7 +125,8 @@ class _DeviceListState extends State<_DeviceList> {
                       if (widget.scannerState.scanIsInProgress ||
                           widget.scannerState.discoveredDevices.isNotEmpty)
                         Padding(
-                          padding: const EdgeInsetsDirectional.only(start: 18.0),
+                          padding:
+                              const EdgeInsetsDirectional.only(start: 18.0),
                           child: Text(
                               'count: ${widget.scannerState.discoveredDevices.length}'),
                         ),

lib/flutter_reactive_ble.dart

@@ -6,6 +6,7 @@ export 'src/model/connection_priority.dart';
 export 'src/model/connection_state_update.dart';
 export 'src/model/discovered_device.dart';
 export 'src/model/generic_failure.dart';
+export 'src/model/log_level.dart';
 export 'src/model/qualified_characteristic.dart';
 export 'src/model/result.dart';
 export 'src/model/scan_mode.dart';

lib/src/debug_logger.dart

@@ -0,0 +1,23 @@
+import 'package:flutter_reactive_ble/src/model/log_level.dart';
+
+class DebugLogger {
+  DebugLogger(void Function(Object object) printToConsole)
+      : _printToConsole = printToConsole;
+
+  void enable() {
+    _logLevel = LogLevel.verbose;
+  }
+
+  void disable() {
+    _logLevel = LogLevel.none;
+  }
+
+  void log(Object message) {
+    if (_logLevel == LogLevel.verbose) {
+      _printToConsole('REACTIVE_BLE: $message');
+    }
+  }
+
+  final void Function(Object object) _printToConsole;
+  LogLevel _logLevel = LogLevel.none;
+}

lib/src/model/log_level.dart

@@ -0,0 +1 @@
+enum LogLevel { none, verbose }

lib/src/reactive_ble.dart

@@ -2,6 +2,7 @@ import 'dart:async';
 import 'dart:io';
 
 import 'package:flutter_reactive_ble/src/connected_device_operation.dart';
+import 'package:flutter_reactive_ble/src/debug_logger.dart';
 import 'package:flutter_reactive_ble/src/device_connector.dart';
 import 'package:flutter_reactive_ble/src/device_scanner.dart';
 import 'package:flutter_reactive_ble/src/discovered_devices_registry.dart';
@@ -10,6 +11,7 @@ import 'package:flutter_reactive_ble/src/model/characteristic_value.dart';
 import 'package:flutter_reactive_ble/src/model/connection_priority.dart';
 import 'package:flutter_reactive_ble/src/model/connection_state_update.dart';
 import 'package:flutter_reactive_ble/src/model/discovered_device.dart';
+import 'package:flutter_reactive_ble/src/model/log_level.dart';
 import 'package:flutter_reactive_ble/src/model/qualified_characteristic.dart';
 import 'package:flutter_reactive_ble/src/model/scan_mode.dart';
 import 'package:flutter_reactive_ble/src/model/uuid.dart';
@@ -31,12 +33,13 @@ class FlutterReactiveBle {
     @required DeviceScanner deviceScanner,
     @required DeviceConnector deviceConnector,
     @required ConnectedDeviceOperation connectedDeviceOperation,
+    @required DebugLogger debugLogger,
   }) {
     _pluginController = pluginController;
     _deviceScanner = deviceScanner;
     _deviceConnector = deviceConnector;
     _connectedDeviceOperator = connectedDeviceOperation;
-
+    _debugLogger = debugLogger;
     _trackStatus();
   }
 
@@ -93,6 +96,7 @@ class FlutterReactiveBle {
   DeviceConnector _deviceConnector;
   ConnectedDeviceOperation _connectedDeviceOperator;
   DeviceScanner _deviceScanner;
+  DebugLogger _debugLogger;
 
   /// Initializes this [FlutterReactiveBle] instance and its platform-specific
   /// counterparts.
@@ -116,6 +120,8 @@ class FlutterReactiveBle {
       scanRegistry: scanRegistry,
     );
 
+    _debugLogger ??= DebugLogger(print);
+
     _deviceConnector ??= DeviceConnector(
       pluginController: _pluginController,
       discoveredDevicesRegistry: scanRegistry,
@@ -296,6 +302,9 @@ class FlutterReactiveBle {
       .clearGattCache(deviceId)
       .then((info) => info.dematerialize());
 
+  /// Subscribes to a updates from a the characteristic specified.
+  ///
+  /// This stream terminates automatically when the device is disconnected.
   Stream<List<int>> subscribeToCharacteristic(
       QualifiedCharacteristic characteristic) {
     final terminateFuture = connectedDeviceStream
@@ -313,4 +322,19 @@ class FlutterReactiveBle {
           ),
         );
   }
+
+  /// Sets the verbosity of debug output.
+  ///
+  /// Use [LogLevel.verbose] for full debug output. Make sure to  run this only for debugging purposes.
+  /// Use [LogLevel.none] to disable logging. This is also the default.
+  void setLogLevel(LogLevel logLevel) {
+    switch (logLevel) {
+      case LogLevel.none:
+        _debugLogger.disable();
+        break;
+      case LogLevel.verbose:
+        _debugLogger.enable();
+        break;
+    }
+  }
 }

test/debug_logger_test.dart

@@ -0,0 +1,41 @@
+import 'package:flutter_reactive_ble/src/debug_logger.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:mockito/mockito.dart';
+
+void main() {
+  group('$DebugLogger', () {
+    DebugLogger sut;
+    _PrinterMock printerMock;
+
+    setUp(() {
+      printerMock = _PrinterMock();
+      sut = DebugLogger(printerMock.print);
+    });
+
+    group('Given debuglevel is enabled', () {
+      setUp(() {
+        sut.enable();
+      });
+
+      test('It logs message', () {
+        const message = "Log message";
+        sut.log(message);
+        verify(printerMock.print('REACTIVE_BLE: $message')).called(1);
+      });
+    });
+
+    group('Given debuglevel is disabled', () {
+      test('It does not log message', () {
+        const message = "Log message";
+        sut.log(message);
+        verifyNever(printerMock.print(any));
+      });
+    });
+  });
+}
+
+abstract class _Printer {
+  void print(Object object);
+}
+
+class _PrinterMock extends Mock implements _Printer {}

test/reactive_ble_test.dart

@@ -2,9 +2,11 @@ import 'dart:async';
 
 import 'package:flutter_reactive_ble/flutter_reactive_ble.dart';
 import 'package:flutter_reactive_ble/src/connected_device_operation.dart';
+import 'package:flutter_reactive_ble/src/debug_logger.dart';
 import 'package:flutter_reactive_ble/src/device_connector.dart';
 import 'package:flutter_reactive_ble/src/device_scanner.dart';
 import 'package:flutter_reactive_ble/src/model/clear_gatt_cache_error.dart';
+import 'package:flutter_reactive_ble/src/model/log_level.dart';
 import 'package:flutter_reactive_ble/src/model/unit.dart';
 import 'package:flutter_reactive_ble/src/plugin_controller.dart';
 import 'package:flutter_test/flutter_test.dart';
@@ -17,6 +19,7 @@ void main() {
     _DeviceConnectorMock _deviceConnector;
     _DeviceOperationMock _deviceOperation;
     StreamController<BleStatus> _bleStatusController;
+    _DebugLoggerMock _debugLoggerMock;
 
     FlutterReactiveBle _sut;
 
@@ -26,6 +29,7 @@ void main() {
       _deviceConnector = _DeviceConnectorMock();
       _deviceOperation = _DeviceOperationMock();
       _bleStatusController = StreamController();
+      _debugLoggerMock = _DebugLoggerMock();
 
       when(_pluginController.initialize()).thenAnswer(
         (_) => Future.value(),
@@ -40,6 +44,7 @@ void main() {
         deviceScanner: _deviceScanner,
         deviceConnector: _deviceConnector,
         connectedDeviceOperation: _deviceOperation,
+        debugLogger: _debugLoggerMock,
       );
     });
 
@@ -544,6 +549,28 @@ void main() {
         );
       });
     });
+
+    group('Logging', () {
+      group('When loglevel is set to verbose', () {
+        setUp(() {
+          _sut.setLogLevel(LogLevel.verbose);
+        });
+
+        test('It enables debug logging', () {
+          verify(_debugLoggerMock.enable()).called(1);
+        });
+      });
+
+      group('When loglevel is set to none', () {
+        setUp(() {
+          _sut.setLogLevel(LogLevel.none);
+        });
+
+        test('It enables debug logging', () {
+          verify(_debugLoggerMock.disable()).called(1);
+        });
+      });
+    });
   });
 }
 
@@ -560,3 +587,5 @@ class _DeviceScannerMock extends Mock implements DeviceScanner {}
 class _DeviceConnectorMock extends Mock implements DeviceConnector {}
 
 class _DeviceOperationMock extends Mock implements ConnectedDeviceOperation {}
+
+class _DebugLoggerMock extends Mock implements DebugLogger {}