Extract operations' channel state validation to helper

Code largely generated by Cursor at my request.

Author: lawrence-forooghian

Sources/AblyLiveObjects/Internal/CoreSDK.swift

@@ -40,3 +40,28 @@ internal final class DefaultCoreSDK: CoreSDK {
         channel.state
     }
 }
+
+// MARK: - Channel State Validation
+
+/// Extension on CoreSDK to provide channel state validation utilities.
+internal extension CoreSDK {
+    /// Validates that the channel is not in any of the specified invalid states.
+    ///
+    /// - Parameters:
+    ///   - invalidStates: Array of channel states that are considered invalid for the operation
+    ///   - operationDescription: A description of the operation being performed, used in error messages
+    /// - Throws: `ARTErrorInfo` with code 90001 and statusCode 400 if the channel is in any of the invalid states
+    func validateChannelState(
+        notIn invalidStates: [ARTRealtimeChannelState],
+        operationDescription: String,
+    ) throws(ARTErrorInfo) {
+        let currentChannelState = channelState
+        if invalidStates.contains(currentChannelState) {
+            throw LiveObjectsError.objectsOperationFailedInvalidChannelState(
+                operationDescription: operationDescription,
+                channelState: currentChannelState,
+            )
+            .toARTErrorInfo()
+        }
+    }
+}

Sources/AblyLiveObjects/Internal/InternalDefaultLiveCounter.swift

@@ -81,14 +81,7 @@ internal final class InternalDefaultLiveCounter: Sendable {
 
     internal func value(coreSDK: CoreSDK) throws(ARTErrorInfo) -> Double {
         // RTLC5b: If the channel is in the DETACHED or FAILED state, the library should indicate an error with code 90001
-        let currentChannelState = coreSDK.channelState
-        if currentChannelState == .detached || currentChannelState == .failed {
-            throw LiveObjectsError.objectsOperationFailedInvalidChannelState(
-                operationDescription: "LiveCounter.value",
-                channelState: currentChannelState,
-            )
-            .toARTErrorInfo()
-        }
+        try coreSDK.validateChannelState(notIn: [.detached, .failed], operationDescription: "LiveCounter.value")
 
         return mutex.withLock {
             // RTLC5c

Sources/AblyLiveObjects/Internal/InternalDefaultLiveMap.swift

@@ -111,14 +111,7 @@ internal final class InternalDefaultLiveMap: Sendable {
     /// Returns the value associated with a given key, following RTLM5d specification.
     internal func get(key: String, coreSDK: CoreSDK, delegate: LiveMapObjectPoolDelegate) throws(ARTErrorInfo) -> InternalLiveMapValue? {
         // RTLM5c: If the channel is in the DETACHED or FAILED state, the library should indicate an error with code 90001
-        let currentChannelState = coreSDK.channelState
-        if currentChannelState == .detached || currentChannelState == .failed {
-            throw LiveObjectsError.objectsOperationFailedInvalidChannelState(
-                operationDescription: "LiveMap.get",
-                channelState: currentChannelState,
-            )
-            .toARTErrorInfo()
-        }
+        try coreSDK.validateChannelState(notIn: [.detached, .failed], operationDescription: "LiveMap.get")
 
         let entry = mutex.withLock {
             mutableState.data[key]
@@ -135,14 +128,7 @@ internal final class InternalDefaultLiveMap: Sendable {
 
     internal func size(coreSDK: CoreSDK) throws(ARTErrorInfo) -> Int {
         // RTLM10c: If the channel is in the DETACHED or FAILED state, the library should throw an ErrorInfo error with statusCode 400 and code 90001
-        let currentChannelState = coreSDK.channelState
-        if currentChannelState == .detached || currentChannelState == .failed {
-            throw LiveObjectsError.objectsOperationFailedInvalidChannelState(
-                operationDescription: "LiveMap.size",
-                channelState: currentChannelState,
-            )
-            .toARTErrorInfo()
-        }
+        try coreSDK.validateChannelState(notIn: [.detached, .failed], operationDescription: "LiveMap.size")
 
         return mutex.withLock {
             // RTLM10d: Returns the number of non-tombstoned entries (per RTLM14) in the internal data map
@@ -154,14 +140,7 @@ internal final class InternalDefaultLiveMap: Sendable {
 
     internal func entries(coreSDK: CoreSDK, delegate: LiveMapObjectPoolDelegate) throws(ARTErrorInfo) -> [(key: String, value: InternalLiveMapValue)] {
         // RTLM11c: If the channel is in the DETACHED or FAILED state, the library should throw an ErrorInfo error with statusCode 400 and code 90001
-        let currentChannelState = coreSDK.channelState
-        if currentChannelState == .detached || currentChannelState == .failed {
-            throw LiveObjectsError.objectsOperationFailedInvalidChannelState(
-                operationDescription: "LiveMap.entries",
-                channelState: currentChannelState,
-            )
-            .toARTErrorInfo()
-        }
+        try coreSDK.validateChannelState(notIn: [.detached, .failed], operationDescription: "LiveMap.entries")
 
         return mutex.withLock {
             // RTLM11d: Returns key-value pairs from the internal data map

Sources/AblyLiveObjects/Internal/InternalDefaultRealtimeObjects.swift

@@ -93,14 +93,7 @@ internal final class InternalDefaultRealtimeObjects: Sendable, LiveMapObjectPool
 
     internal func getRoot(coreSDK: CoreSDK) async throws(ARTErrorInfo) -> InternalDefaultLiveMap {
         // RTO1b: If the channel is in the DETACHED or FAILED state, the library should indicate an error with code 90001
-        let currentChannelState = coreSDK.channelState
-        if currentChannelState == .detached || currentChannelState == .failed {
-            throw LiveObjectsError.objectsOperationFailedInvalidChannelState(
-                operationDescription: "getRoot",
-                channelState: currentChannelState,
-            )
-            .toARTErrorInfo()
-        }
+        try coreSDK.validateChannelState(notIn: [.detached, .failed], operationDescription: "getRoot")
 
         let syncStatus = mutex.withLock {
             mutableState.syncStatus

Sources/AblyLiveObjects/Internal/LiveObjectMutableState.swift

@@ -88,14 +88,7 @@ internal struct LiveObjectMutableState<Update: Sendable> {
     @discardableResult
     internal mutating func subscribe(listener: @escaping LiveObjectUpdateCallback<Update>, coreSDK: CoreSDK, updateSelfLater: @escaping UpdateLiveObject) throws(ARTErrorInfo) -> any AblyLiveObjects.SubscribeResponse {
         // RTLO4b2
-        let currentChannelState = coreSDK.channelState
-        if currentChannelState == .detached || currentChannelState == .failed {
-            throw LiveObjectsError.objectsOperationFailedInvalidChannelState(
-                operationDescription: "subscribe",
-                channelState: currentChannelState,
-            )
-            .toARTErrorInfo()
-        }
+        try coreSDK.validateChannelState(notIn: [.detached, .failed], operationDescription: "subscribe")
 
         let subscription = Subscription(listener: listener, updateLiveObject: updateSelfLater)
         subscriptionsByID[subscription.id] = subscription