Merge pull request #286 from Polidea/fix/canSendWriteWithoutResponseCheck

fixes Characteristic writeWithoutResponse request does not return #282

Author: bartoszstelmaszuk

Cartfile.resolved

@@ -1 +1 @@
-github "ReactiveX/RxSwift" "4.2.0"
+github "ReactiveX/RxSwift" "4.3.0"

Source/Peripheral.swift

@@ -411,7 +411,8 @@ public class Peripheral {
     /// - parameter data: Data that'll be written to `Characteristic` instance
     /// - parameter characteristic: `Characteristic` instance to write value to.
     /// - parameter type: Type of write operation. Possible values: `.withResponse`, `.withoutResponse`
-    /// - returns: Observable that emition depends on `CBCharacteristicWriteType` passed to the function call.
+    /// - parameter canSendWriteWithoutResponseCheckEnabled: check if canSendWriteWithoutResponse should be enabled. Done because of internal MacOS bug.
+    /// - returns: Observable that emission depends on `CBCharacteristicWriteType` passed to the function call.
     ///
     /// Observable can ends with following errors:
     /// * `BluetoothError.characteristicWriteFailed`
@@ -424,7 +425,8 @@ public class Peripheral {
     /// * `BluetoothError.bluetoothResetting`
     public func writeValue(_ data: Data,
                            for characteristic: Characteristic,
-                           type: CBCharacteristicWriteType) -> Single<Characteristic> {
+                           type: CBCharacteristicWriteType,
+                           canSendWriteWithoutResponseCheckEnabled: Bool = true) -> Single<Characteristic> {
         let writeOperationPerformingAndListeningObservable = { [weak self] (observable: Observable<Characteristic>)
             -> Observable<Characteristic> in
             guard let strongSelf = self else { return Observable.error(BluetoothError.destroyed) }
@@ -442,7 +444,7 @@ public class Peripheral {
                     guard let strongSelf = self else { throw BluetoothError.destroyed }
                     return strongSelf.observeWriteWithoutResponseReadiness()
                         .map { _ in true }
-                        .startWith(strongSelf.canSendWriteWithoutResponse)
+                        .startWith(canSendWriteWithoutResponseCheckEnabled ? strongSelf.canSendWriteWithoutResponse : true)
                         .filter { $0 }
                         .take(1)
                         .flatMap { _ in

Tests/Autogenerated/_Peripheral.generated.swift

@@ -412,7 +412,8 @@ class _Peripheral {
     /// - parameter data: Data that'll be written to `_Characteristic` instance
     /// - parameter characteristic: `_Characteristic` instance to write value to.
     /// - parameter type: Type of write operation. Possible values: `.withResponse`, `.withoutResponse`
-    /// - returns: Observable that emition depends on `CBCharacteristicWriteType` passed to the function call.
+    /// - parameter canSendWriteWithoutResponseCheckEnabled: check if canSendWriteWithoutResponse should be enabled. Done because of internal MacOS bug.
+    /// - returns: Observable that emission depends on `CBCharacteristicWriteType` passed to the function call.
     ///
     /// Observable can ends with following errors:
     /// * `_BluetoothError.characteristicWriteFailed`
@@ -425,7 +426,8 @@ class _Peripheral {
     /// * `_BluetoothError.bluetoothResetting`
     func writeValue(_ data: Data,
                            for characteristic: _Characteristic,
-                           type: CBCharacteristicWriteType) -> Single<_Characteristic> {
+                           type: CBCharacteristicWriteType,
+                           canSendWriteWithoutResponseCheckEnabled: Bool = true) -> Single<_Characteristic> {
         let writeOperationPerformingAndListeningObservable = { [weak self] (observable: Observable<_Characteristic>)
             -> Observable<_Characteristic> in
             guard let strongSelf = self else { return Observable.error(_BluetoothError.destroyed) }
@@ -443,7 +445,7 @@ class _Peripheral {
                     guard let strongSelf = self else { throw _BluetoothError.destroyed }
                     return strongSelf.observeWriteWithoutResponseReadiness()
                         .map { _ in true }
-                        .startWith(strongSelf.canSendWriteWithoutResponse)
+                        .startWith( canSendWriteWithoutResponseCheckEnabled ? strongSelf.canSendWriteWithoutResponse : true)
                         .filter { $0 }
                         .take(1)
                         .flatMap { _ in

Tests/PeripheralTest+CharacteristicOperation.swift

@@ -105,6 +105,25 @@ class PeripheralCharacteristicOperationsTest: BasePeripheralTest {
         XCTAssertEqual(obs.events[0].value.element, characteristic, "should receive next events with characteristic")
         XCTAssertTrue(obs.events[1].value == .completed, "should receive completed event")
     }
+
+    func testWriteValueWithoutResponseWithCanSendWriteWithoutResponseCheckDisabled() {
+        let characteristic = _Characteristic(characteristic: createCharacteristic(uuid: "0x0001", service: service), peripheral: peripheral)
+        let data = Data(bytes: [0, 1, 2, 3])
+        peripheral.peripheral.canSendWriteWithoutResponse = false
+
+        let obs: ScheduledObservable<_Characteristic> = testScheduler.scheduleObservable {
+					self.peripheral.writeValue(data, for: characteristic, type: .withoutResponse, canSendWriteWithoutResponseCheckEnabled: false).asObservable()
+        }
+
+        testScheduler.advanceTo(subscribeTime)
+
+        XCTAssertEqual(peripheral.peripheral.writeValueWithTypeParams.count, 1, "should call writeValueWithType method for the peripheral")
+        let params = peripheral.peripheral.writeValueWithTypeParams[0]
+        XCTAssertTrue(params.0 == data && params.1 == characteristic.characteristic && params.2 == .withoutResponse, "should call writeValueWithType with correct parameters")
+        XCTAssertEqual(obs.events.count, 2, "should not receive two events immediately after subscription")
+        XCTAssertEqual(obs.events[0].value.element, characteristic, "should receive next events with characteristic")
+        XCTAssertTrue(obs.events[1].value == .completed, "should receive completed event")
+    }
 
     func testWriteValueWithoutResponseWaitingOnReadiness() {
         let characteristic = _Characteristic(characteristic: createCharacteristic(uuid: "0x0001", service: service), peripheral: peripheral)

scripts/generate-mocks.sh

@@ -27,10 +27,10 @@ fi
 IOS_VERSION="$1"
 
 if [ -z "$IOS_VERSION" ]; then
-	echo "Please specify ios version to compile (default 11.1):"
+	echo "Please specify ios version to compile (default 11.4):"
 	read IOS_VERSION
 	if [ -z "$IOS_VERSION" ]; then
-		IOS_VERSION="11.1"
+		IOS_VERSION="11.4"
 	fi
 fi
 
@@ -93,4 +93,4 @@ create_intermediate_source_file "CoreBluetooth.CBCentral"
 sourcery --sources ./Intermediates --sources ../Source --templates ../Templates --output ../Tests/Autogenerated
 
 rm temp.yml
-rm -rf ./Intermediates
+rm -rf ./Intermediates