refactor usage of TransactionIdGenerator - now it could be easily mocked for unit test

pawelByszewski · pawelByszewski · commit 3688ca402d61 · 2020-03-05T14:32:50.000+01:00
diff --git a/lib/characteristic.dart b/lib/characteristic.dart
@@ -21,6 +21,7 @@ class Characteristic extends InternalCharacteristic {
   Service service;
 
   ManagerForCharacteristic _manager;
+  TransactionIdGenerator _transactionIdGenerator;
 
   /// The UUID of this characteristic.
   String uuid;
@@ -41,9 +42,10 @@ class Characteristic extends InternalCharacteristic {
   bool isIndicatable;
 
   Characteristic.fromJson(Map<String, dynamic> jsonObject, Service service,
-      ManagerForCharacteristic manager)
+      ManagerForCharacteristic manager, {TransactionIdGenerator transactionIdGenerator = const TransactionIdGenerator()})
       : super(jsonObject[_CharacteristicMetadata.id]) {
     _manager = manager;
+    _transactionIdGenerator = transactionIdGenerator;
     this.service = service;
     uuid = jsonObject[_CharacteristicMetadata.uuid];
     isReadable = jsonObject[_CharacteristicMetadata.isReadable];
@@ -62,7 +64,7 @@ class Characteristic extends InternalCharacteristic {
       _manager.readCharacteristicForIdentifier(
         service.peripheral,
         this,
-        transactionId ?? TransactionIdGenerator.getNextId(),
+        transactionId ?? _transactionIdGenerator.getNextId(),
       );
 
   /// Writes to the value of this characteristic.
@@ -80,7 +82,7 @@ class Characteristic extends InternalCharacteristic {
         this,
         value,
         withResponse,
-        transactionId ?? TransactionIdGenerator.getNextId(),
+        transactionId ?? _transactionIdGenerator.getNextId(),
       );
 
   /// Returns a [Stream] of notifications/indications emitted by this
@@ -95,7 +97,7 @@ class Characteristic extends InternalCharacteristic {
       _manager.monitorCharacteristicForIdentifier(
         service.peripheral,
         this,
-        transactionId ?? TransactionIdGenerator.getNextId(),
+        transactionId ?? _transactionIdGenerator.getNextId(),
       );
 
   /// Returns a list of [Descriptor]s of this characteristic.
@@ -110,7 +112,7 @@ class Characteristic extends InternalCharacteristic {
       _manager.readDescriptorForCharacteristic(
         this,
         descriptorUuid,
-        transactionId ?? TransactionIdGenerator.getNextId(),
+        transactionId ?? _transactionIdGenerator.getNextId(),
       );
 
   /// Writes the [value] of a [Descriptor] identified by [descriptorUuid].
@@ -123,7 +125,7 @@ class Characteristic extends InternalCharacteristic {
         this,
         descriptorUuid,
         value,
-        transactionId ?? TransactionIdGenerator.getNextId(),
+        transactionId ?? _transactionIdGenerator.getNextId(),
       );
 
   @override
diff --git a/lib/descriptor.dart b/lib/descriptor.dart
@@ -8,30 +8,33 @@ abstract class _DescriptorMetadata {
 
 class Descriptor extends InternalDescriptor {
   ManagerForDescriptor _manager;
+  TransactionIdGenerator _transactionIdGenerator;
   Characteristic characteristic;
   String uuid;
 
   Descriptor.fromJson(
     Map<String, dynamic> jsonObject,
     Characteristic characteristic,
     ManagerForDescriptor manager,
+    {TransactionIdGenerator transactionIdGenerator = const TransactionIdGenerator()}
   ) : super(jsonObject[_DescriptorMetadata.id]) {
     _manager = manager;
+    _transactionIdGenerator = transactionIdGenerator;
     this.characteristic = characteristic;
     uuid = jsonObject[_DescriptorMetadata.uuid];
   }
 
   Future<Uint8List> read({String transactionId}) =>
       _manager.readDescriptorForIdentifier(
         this,
-        transactionId ?? TransactionIdGenerator.getNextId(),
+        transactionId ?? _transactionIdGenerator.getNextId(),
       );
 
   Future<void> write(Uint8List value, {String transactionId}) =>
       _manager.writeDescriptorForIdentifier(
         this,
         value,
-        transactionId ?? TransactionIdGenerator.getNextId(),
+        transactionId ?? _transactionIdGenerator.getNextId(),
       );
 
   @override
diff --git a/lib/peripheral.dart b/lib/peripheral.dart
@@ -16,14 +16,16 @@ abstract class _PeripheralMetadata {
 class Peripheral {
   static const int NO_MTU_NEGOTIATION = 0;
   ManagerForPeripheral _manager;
+  TransactionIdGenerator _transactionIdGenerator;
 
   String name;
   String identifier;
 
-  Peripheral.fromJson(Map<String, dynamic> json, ManagerForPeripheral manager)
+  Peripheral.fromJson(Map<String, dynamic> json, ManagerForPeripheral manager, {TransactionIdGenerator transactionIdGenerator = const TransactionIdGenerator()})
       : _manager = manager,
         name = json[_PeripheralMetadata.name],
-        identifier = json[_PeripheralMetadata.identifier];
+        identifier = json[_PeripheralMetadata.identifier],
+        _transactionIdGenerator = transactionIdGenerator;
 
   /// Connects to the peripheral.
   ///
@@ -82,7 +84,7 @@ class Peripheral {
   /// Optional [transactionId] could be used to cancel operation.
   Future<void> discoverAllServicesAndCharacteristics({String transactionId}) =>
       _manager.discoverAllServicesAndCharacteristics(
-          this, transactionId ?? TransactionIdGenerator.getNextId());
+          this, transactionId ?? _transactionIdGenerator.getNextId());
 
   /// Returns a list of [Service]s of this peripheral.
   ///
@@ -103,7 +105,7 @@ class Peripheral {
   ///
   /// Optional [transactionId] could be used to cancel operation.
   Future<int> rssi({String transactionId}) =>
-      _manager.rssi(this, transactionId ?? TransactionIdGenerator.getNextId());
+      _manager.rssi(this, transactionId ?? _transactionIdGenerator.getNextId());
 
   /// Requests new MTU value for current connection and return the negotiation
   /// result on Android, reads MTU on iOS.
@@ -118,7 +120,7 @@ class Peripheral {
   /// If MTU has been requested in [connect()] this method will end with [BleError].
   Future<int> requestMtu(int mtu, {String transactionId}) =>
       _manager.requestMtu(
-          this, mtu, transactionId ?? TransactionIdGenerator.getNextId());
+          this, mtu, transactionId ?? _transactionIdGenerator.getNextId());
 
   /// Reads value of [Characteristic] matching specified UUIDs.
   ///
@@ -135,7 +137,7 @@ class Peripheral {
         this,
         serviceUuid,
         characteristicUuid,
-        transactionId ?? TransactionIdGenerator.getNextId(),
+        transactionId ?? _transactionIdGenerator.getNextId(),
       );
 
   /// Writes value of [Characteristic] matching specified UUIDs.
@@ -157,7 +159,7 @@ class Peripheral {
         characteristicUuid,
         value,
         withResponse,
-        transactionId ?? TransactionIdGenerator.getNextId(),
+        transactionId ?? _transactionIdGenerator.getNextId(),
       );
 
   /// Returns a list of [Descriptor]s for [Characteristic] matching specified UUIDs.
@@ -191,7 +193,7 @@ class Peripheral {
         serviceUuid,
         characteristicUuid,
         descriptorUuid,
-        transactionId ?? TransactionIdGenerator.getNextId(),
+        transactionId ?? _transactionIdGenerator.getNextId(),
       );
 
   /// Writes value of [Descriptor] matching specified UUIDs.
@@ -214,7 +216,7 @@ class Peripheral {
         characteristicUuid,
         descriptorUuid,
         value,
-        transactionId ?? TransactionIdGenerator.getNextId(),
+        transactionId ?? _transactionIdGenerator.getNextId(),
       );
 
   /// Returns a stream of notifications/indications from [Characteristic]
@@ -236,7 +238,7 @@ class Peripheral {
         this,
         serviceUuid,
         characteristicUuid,
-        transactionId ?? TransactionIdGenerator.getNextId(),
+        transactionId ?? _transactionIdGenerator.getNextId(),
       );
 
   @override
diff --git a/lib/service.dart b/lib/service.dart
@@ -11,6 +11,7 @@ class Service extends InternalService {
   Peripheral peripheral;
 
   ManagerForService _manager;
+  TransactionIdGenerator _transactionIdGenerator;
 
   /// The UUID of this service.
   String uuid;
@@ -19,10 +20,12 @@ class Service extends InternalService {
     Map<String, dynamic> jsonObject,
     Peripheral peripheral,
     ManagerForService managerForService,
+    {TransactionIdGenerator transactionIdGenerator = const TransactionIdGenerator()}
   ) : super(jsonObject[_ServiceMetadata.id]) {
     this.peripheral = peripheral;
     uuid = jsonObject[_ServiceMetadata.uuid];
     _manager = managerForService;
+    _transactionIdGenerator = transactionIdGenerator;
   }
 
   /// Returns a list of [Characteristic]s of this service.
@@ -51,7 +54,7 @@ class Service extends InternalService {
           characteristicUuid,
           value,
           withResponse,
-          transactionId ?? TransactionIdGenerator.getNextId());
+          transactionId ?? _transactionIdGenerator.getNextId());
 
   /// Reads the value of a [Characteristic] identified by [characteristicUuid].
   ///
@@ -67,7 +70,7 @@ class Service extends InternalService {
         peripheral,
         this,
         characteristicUuid,
-        transactionId ?? TransactionIdGenerator.getNextId(),
+        transactionId ?? _transactionIdGenerator.getNextId(),
       );
 
   /// Returns a [Stream] of values emitted by a [Characteristic] identified by
@@ -86,7 +89,7 @@ class Service extends InternalService {
         peripheral,
         this,
         characteristicUuid,
-        transactionId ?? TransactionIdGenerator.getNextId(),
+        transactionId ?? _transactionIdGenerator.getNextId(),
       );
 
   /// Returns a list of [Descriptor]s of a [Characteristic] identified by
@@ -114,7 +117,7 @@ class Service extends InternalService {
         this,
         characteristicUuid,
         descriptorUuid,
-        transactionId ?? TransactionIdGenerator.getNextId(),
+        transactionId ?? _transactionIdGenerator.getNextId(),
       );
 
   /// Writes the [value] of a [Descriptor] identified by [descriptorUuid]
@@ -132,7 +135,7 @@ class Service extends InternalService {
         characteristicUuid,
         descriptorUuid,
         value,
-        transactionId ?? TransactionIdGenerator.getNextId(),
+        transactionId ?? _transactionIdGenerator.getNextId(),
       );
 
   @override
diff --git a/lib/src/internal_ble_manager.dart b/lib/src/internal_ble_manager.dart
@@ -8,10 +8,12 @@ class InternalBleManager
         ManagerForCharacteristic,
         ManagerForDescriptor {
   FlutterBleLib _bleLib;
+  TransactionIdGenerator _transactionIdGenerator;
 
-  InternalBleManager() {
+  InternalBleManager({TransactionIdGenerator transactionIdGenerator = const TransactionIdGenerator()}) {
     _bleLib = FlutterBleLib();
     _bleLib.registerManager(this);
+    _transactionIdGenerator = transactionIdGenerator;
   }
 
   @override
@@ -36,11 +38,11 @@ class InternalBleManager
 
   @override
   Future<void> enableRadio({String transactionId}) =>
-      _bleLib.enableRadio(transactionId ?? TransactionIdGenerator.getNextId());
+      _bleLib.enableRadio(transactionId ?? _transactionIdGenerator.getNextId());
 
   @override
   Future<void> disableRadio({String transactionId}) =>
-      _bleLib.disableRadio(transactionId ?? TransactionIdGenerator.getNextId());
+      _bleLib.disableRadio(transactionId ?? _transactionIdGenerator.getNextId());
 
   @override
   Future<BluetoothState> bluetoothState() => _bleLib.state();
diff --git a/lib/src/util/_transaction_id_generator.dart b/lib/src/util/_transaction_id_generator.dart
@@ -1,7 +1,10 @@
-abstract class TransactionIdGenerator {
+class TransactionIdGenerator {
   static int _id = 0;
 
-  static String getNextId() {
+
+  const TransactionIdGenerator();
+
+  String getNextId() {
     _id++;
     return _id.toString();
   }
diff --git a/test/peripheral_test.dart b/test/peripheral_test.dart
@@ -2,27 +2,32 @@
 import 'package:flutter/services.dart';
 import 'package:flutter_ble_lib/flutter_ble_lib.dart';
 import 'package:flutter_ble_lib/src/_managers_for_classes.dart';
+import 'package:flutter_ble_lib/src/util/_transaction_id_generator.dart';
 import 'package:mockito/mockito.dart';
 import 'package:test/test.dart';
 
 class ManagerForPeripheralMock extends Mock implements ManagerForPeripheral {}
 class ServiceMock extends Mock implements Service {}
 class CharacteristicMock extends Mock implements Characteristic {}
+class TransactionIdGeneratorMock extends Mock implements TransactionIdGenerator {}
 
 void main() {
 
   const PERIPHERAL_NAME = 'Peripheral name';
   const PERIPHERAL_ID = 'peripheral id';
 
-  ManagerForPeripheralMock managerForPeripheral = ManagerForPeripheralMock();
+  ManagerForPeripheralMock managerForPeripheral;
+  TransactionIdGeneratorMock transactionIdGeneratorMock;
   Peripheral peripheral;
 
   setUp(() {
     Map<String, dynamic> json = {
       'name': PERIPHERAL_NAME,
       'id' : PERIPHERAL_ID
     };
-    peripheral = Peripheral.fromJson(json, managerForPeripheral);
+    managerForPeripheral = ManagerForPeripheralMock();
+    transactionIdGeneratorMock = TransactionIdGeneratorMock();
+    peripheral = Peripheral.fromJson(json, managerForPeripheral, transactionIdGenerator: transactionIdGeneratorMock);
   });
 
   group("Connect", () {
@@ -126,13 +131,17 @@ void main() {
     });
 
     test("use generated transactionId", () async {
+      //given
+      var ids = ["1", "5"];
+      when(transactionIdGeneratorMock.getNextId()).thenAnswer((_) => ids.removeAt(0));
+
       //when
       await peripheral.discoverAllServicesAndCharacteristics();
       await peripheral.discoverAllServicesAndCharacteristics();
 
       //then
       verify(managerForPeripheral.discoverAllServicesAndCharacteristics(any, '1'));
-      verify(managerForPeripheral.discoverAllServicesAndCharacteristics(any, '2'));
+      verify(managerForPeripheral.discoverAllServicesAndCharacteristics(any, '5'));
     });
   });
 
@@ -181,13 +190,17 @@ void main() {
     });
 
     test("use generated transactionId", () async {
+      //given
+      var ids = ["4", "9"];
+      when(transactionIdGeneratorMock.getNextId()).thenAnswer((_) => ids.removeAt(0));
+
       //when
       await peripheral.rssi();
       await peripheral.rssi();
 
       //then
-      verify(managerForPeripheral.rssi(any, '1'));
-      verify(managerForPeripheral.rssi(any, '2'));
+      verify(managerForPeripheral.rssi(any, '4'));
+      verify(managerForPeripheral.rssi(any, '9'));
     });
   });
 
diff --git a/test/src/util/transcation_id_generator_test.dart b/test/src/util/transcation_id_generator_test.dart
@@ -2,14 +2,17 @@ import 'package:flutter_test/flutter_test.dart';
 import 'package:flutter_ble_lib/src/util/_transaction_id_generator.dart';
 
 void main() {
+
+  TransactionIdGenerator transactionIdGenerator = TransactionIdGenerator();
+
   test("should be able to generate an id", () {
-    expect(TransactionIdGenerator.getNextId(), isNotNull);
+    expect(transactionIdGenerator.getNextId(), isNotNull);
   });
 
   test("should always return unique values", () {
     List<String> generatedIds = [];
     for (var i = 0; i < 1000; i++) {
-      var generatedId = TransactionIdGenerator.getNextId();
+      var generatedId = transactionIdGenerator.getNextId();
       expect(generatedIds, isNot(contains(generatedId)));
       generatedIds.add(generatedId);
     }
