Add timeout for write-without-response (#1186)

Author: LuoPeiQin

kable-core/api/android/kable-core.api

@@ -325,6 +325,7 @@ public final class com/juul/kable/PeripheralBuilder {
 	public final fun autoConnectIf (Lkotlin/jvm/functions/Function0;)V
 	public final fun getDisconnectTimeout-UwyO8pc ()J
 	public final fun getForceCharacteristicEqualityByUuid ()Z
+	public final fun getWriteWithoutResponseTimeout-UwyO8pc ()J
 	public final fun getPhy ()Lcom/juul/kable/Phy;
 	public final fun getThreadingStrategy ()Lcom/juul/kable/ThreadingStrategy;
 	public final fun getTransport ()Lcom/juul/kable/Transport;
@@ -333,6 +334,7 @@ public final class com/juul/kable/PeripheralBuilder {
 	public final fun onServicesDiscovered (Lkotlin/jvm/functions/Function2;)V
 	public final fun setDisconnectTimeout-LRDsOJo (J)V
 	public final fun setForceCharacteristicEqualityByUuid (Z)V
+	public final fun setWriteWithoutResponseTimeout-LRDsOJo (J)V
 	public final fun setPhy (Lcom/juul/kable/Phy;)V
 	public final fun setThreadingStrategy (Lcom/juul/kable/ThreadingStrategy;)V
 	public final fun setTransport (Lcom/juul/kable/Transport;)V

kable-core/api/jvm/kable-core.api

@@ -272,11 +272,13 @@ public final class com/juul/kable/Peripheral$DefaultImpls {
 public final class com/juul/kable/PeripheralBuilder {
 	public final fun getDisconnectTimeout-UwyO8pc ()J
 	public final fun getForceCharacteristicEqualityByUuid ()Z
+	public final fun getWriteWithoutResponseTimeout-UwyO8pc ()J
 	public final fun logging (Lkotlin/jvm/functions/Function1;)V
 	public final fun observationExceptionHandler (Lkotlin/jvm/functions/Function3;)V
 	public final fun onServicesDiscovered (Lkotlin/jvm/functions/Function2;)V
 	public final fun setDisconnectTimeout-LRDsOJo (J)V
 	public final fun setForceCharacteristicEqualityByUuid (Z)V
+	public final fun setWriteWithoutResponseTimeout-LRDsOJo (J)V
 }
 
 public final class com/juul/kable/PeripheralKt {

kable-core/src/androidMain/kotlin/PeripheralBuilder.kt

@@ -119,4 +119,6 @@ public actual class PeripheralBuilder internal actual constructor() {
     public actual var disconnectTimeout: Duration = defaultDisconnectTimeout
 
     public actual var forceCharacteristicEqualityByUuid: Boolean = false
+
+    public actual var writeWithoutResponseTimeout: Duration = defaultWriteWithoutResponseTimeout
 }

kable-core/src/appleMain/kotlin/CBPeripheralCoreBluetoothPeripheral.kt

@@ -15,6 +15,7 @@ import com.juul.kable.logs.Logging.DataProcessor.Operation.Write
 import com.juul.kable.logs.detail
 import kotlinx.coroutines.CancellationException
 import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.TimeoutCancellationException
 import kotlinx.coroutines.cancel
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.MutableStateFlow
@@ -28,6 +29,7 @@ import kotlinx.coroutines.flow.onEach
 import kotlinx.coroutines.flow.onSubscription
 import kotlinx.coroutines.flow.updateAndGet
 import kotlinx.coroutines.sync.withLock
+import kotlinx.coroutines.withTimeout
 import kotlinx.io.IOException
 import platform.CoreBluetooth.CBCharacteristicWriteWithResponse
 import platform.CoreBluetooth.CBCharacteristicWriteWithoutResponse
@@ -56,6 +58,7 @@ internal class CBPeripheralCoreBluetoothPeripheral(
     private val logging: Logging,
     private val disconnectTimeout: Duration,
     private val forceCharacteristicEqualityByUuid: Boolean,
+    private val writeWithoutResponseTimeout: Duration,
 ) : BasePeripheral(cbPeripheral.identifier.toUuid()), CoreBluetoothPeripheral {
 
     private val central = CentralManager.Default
@@ -213,7 +216,15 @@ internal class CBPeripheralCoreBluetoothPeripheral(
             }
             WithoutResponse -> connectionOrThrow().guard.withLock {
                 if (!canSendWriteWithoutResponse.updateAndGet { cbPeripheral.canSendWriteWithoutResponse }) {
-                    canSendWriteWithoutResponse.first { it }
+                    try {
+                        withTimeout(writeWithoutResponseTimeout) {
+                            canSendWriteWithoutResponse.first { it }
+                        }
+                    } catch (e: TimeoutCancellationException) {
+                        logger.warn {
+                            message = "Timed out waiting for canSendWriteWithoutResponse, proceeding with write attempt"
+                        }
+                    }
                 }
                 central.writeValue(cbPeripheral, data, platformCharacteristic, CBWithoutResponse)
             }

kable-core/src/appleMain/kotlin/Peripheral.kt

@@ -33,5 +33,6 @@ public fun Peripheral(
         builder.logging,
         builder.disconnectTimeout,
         builder.forceCharacteristicEqualityByUuid,
+        builder.writeWithoutResponseTimeout,
     )
 }

kable-core/src/appleMain/kotlin/PeripheralBuilder.kt

@@ -60,4 +60,6 @@ public actual class PeripheralBuilder internal actual constructor() {
     public actual var disconnectTimeout: Duration = defaultDisconnectTimeout
 
     public actual var forceCharacteristicEqualityByUuid: Boolean = false
+
+    public actual var writeWithoutResponseTimeout: Duration = defaultWriteWithoutResponseTimeout
 }

kable-core/src/appleMain/kotlin/PeripheralDelegate.kt

@@ -323,6 +323,7 @@ internal class PeripheralDelegate(
     fun close(cause: Throwable?) {
         _response.close(NotConnectedException(cause = cause))
         characteristicChanges.emitBlocking(ObservationEvent.Disconnected)
+        canSendWriteWithoutResponse.value = true
     }
 }
 

kable-core/src/commonMain/kotlin/PeripheralBuilder.kt

@@ -3,6 +3,7 @@ package com.juul.kable
 import com.juul.kable.logs.LoggingBuilder
 import kotlinx.coroutines.flow.StateFlow
 import kotlin.time.Duration
+import kotlin.time.Duration.Companion.milliseconds
 import kotlin.time.Duration.Companion.seconds
 
 public expect class ServicesDiscoveredPeripheral {
@@ -35,6 +36,7 @@ internal typealias ServicesDiscoveredAction = suspend ServicesDiscoveredPeripher
 internal typealias ObservationExceptionHandler = suspend ObservationExceptionPeripheral.(cause: Exception) -> Unit
 
 internal val defaultDisconnectTimeout = 5.seconds
+internal val defaultWriteWithoutResponseTimeout = 30.milliseconds
 
 public expect class PeripheralBuilder internal constructor() {
     public fun logging(init: LoggingBuilder)
@@ -91,4 +93,18 @@ public expect class PeripheralBuilder internal constructor() {
      */
     @ObsoleteKableApi // Will be removed after https://github.com/JuulLabs/kable/issues/1016 is fixed.
     public var forceCharacteristicEqualityByUuid: Boolean
+
+    /**
+     * Amount of time to wait for `peripheralIsReady(toSendWriteWithoutResponse:)` before
+     * proceeding with the write.
+     *
+     * On some iOS versions/chipsets, the callback may be delayed or never fired, causing the
+     * write pipeline to stall indefinitely. When the timeout expires, a warning is logged and the
+     * write proceeds.
+     *
+     * Set to a large duration to effectively disable the timeout.
+     *
+     * Only applicable on Apple.
+     */
+    public var writeWithoutResponseTimeout: Duration
 }

kable-core/src/jvmMain/kotlin/com/juul/kable/PeripheralBuilder.kt

@@ -52,4 +52,6 @@ public actual class PeripheralBuilder internal actual constructor() {
     public actual var disconnectTimeout: Duration = defaultDisconnectTimeout
 
     public actual var forceCharacteristicEqualityByUuid: Boolean = false
+
+    public actual var writeWithoutResponseTimeout: Duration = defaultWriteWithoutResponseTimeout
 }

kable-core/src/webMain/kotlin/PeripheralBuilder.kt

@@ -56,6 +56,8 @@ public actual class PeripheralBuilder internal actual constructor() {
 
     public actual var forceCharacteristicEqualityByUuid: Boolean = false
 
+    public actual var writeWithoutResponseTimeout: Duration = defaultWriteWithoutResponseTimeout
+
     internal fun build(bluetoothDevice: BluetoothDevice) =
         BluetoothDeviceWebBluetoothPeripheral(
             bluetoothDevice,