[ECO-5397, WIP] Investigate hangs in integration tests

.github/workflows/check.yaml

@@ -136,7 +136,16 @@ jobs:
         run: swift run BuildTool build-library-for-testing --platform ${{ matrix.platform }}
 
       - name: Run tests
-        run: swift run BuildTool test-library --platform ${{ matrix.platform }}
+        run: |
+          if [ "${{ matrix.platform }}" == "iOS" ]; then
+            for i in {1..100}; do
+              echo "BEGIN: Test run $i of 100"
+              swift run BuildTool test-library --platform ${{ matrix.platform }}
+              echo "END: Test run $i of 100"
+            done
+          else
+            swift run BuildTool test-library --platform ${{ matrix.platform }}
+          fi
 
   # TODO: Disabled after this started failing when we switched to Xcode 26; investigate https://github.com/ably/ably-chat-swift/issues/361
   #  code-coverage:

Package.swift

@@ -26,7 +26,7 @@ let package = Package(
         // This is the SDK's only dependency.
         .package(
             url: "https://github.com/ably/ably-cocoa",
-            from: "1.2.48",
+            branch: "remove-UIDevice-access", // from: "1.2.48",
         ),
 
         // All of the following dependencies are only used for internal purposes (testing or build tooling).

TestPlans/AllTests.xctestplan

@@ -13,12 +13,102 @@
   },
   "testTargets" : [
     {
+      "skippedTests" : {
+        "suites" : [
+          {
+            "name" : "ChatAPITests"
+          },
+          {
+            "name" : "ChatClientTests"
+          },
+          {
+            "name" : "DefaultInternalLoggerTests"
+          },
+          {
+            "name" : "DefaultMessageReactionsTests"
+          },
+          {
+            "name" : "DefaultMessagesTests"
+          },
+          {
+            "name" : "DefaultPresenceTests"
+          },
+          {
+            "name" : "DefaultRoomLifecycleManagerTests"
+          },
+          {
+            "name" : "DefaultRoomOccupancyTests"
+          },
+          {
+            "name" : "DefaultRoomReactionsTests"
+          },
+          {
+            "name" : "DefaultRoomsTests"
+          },
+          {
+            "name" : "DefaultRoomTests"
+          },
+          {
+            "name" : "DefaultTypingTests"
+          },
+          {
+            "name" : "ErrorInfoTests"
+          },
+          {
+            "name" : "IntegrationTests",
+            "testFunctions" : [
+              "roomNameWithSlashInTheName()"
+            ]
+          },
+          {
+            "name" : "InternalLoggerTests"
+          },
+          {
+            "name" : "JSONValueTests"
+          },
+          {
+            "name" : "MessageSubscriptionResponseAsyncSequenceTests"
+          },
+          {
+            "name" : "MessageTests"
+          },
+          {
+            "name" : "RoomOptionsTests"
+          },
+          {
+            "name" : "RoomReactionDTOTests"
+          },
+          {
+            "name" : "StringEncodeTests"
+          },
+          {
+            "name" : "SubscriptionAsyncSequenceTests"
+          },
+          {
+            "name" : "SubscriptionStorageTests"
+          },
+          {
+            "name" : "TypingOperationQueueTests"
+          },
+          {
+            "name" : "TypingTimerManagerTests"
+          }
+        ],
+        "xctestClasses" : [
+          {
+            "name" : "DefaultRoomLifecycleManager"
+          },
+          {
+            "name" : "DefaultRooms"
+          }
+        ]
+      },
       "target" : {
         "containerPath" : "container:",
         "identifier" : "AblyChatTests",
         "name" : "AblyChatTests"
       }
     }
   ],
-  "version" : 1
+  "version" : 2
 }

Tests/AblyChatTests/IntegrationTests.swift

@@ -58,17 +58,15 @@ struct IntegrationTests {
         realtimeOptions.environment = "sandbox"
         realtimeOptions.clientId = UUID().uuidString
 
-        if TestLogger.loggingEnabled {
-            realtimeOptions.logLevel = .verbose
-            realtimeOptions.logHandler = AblyCocoaLogger(label: loggingLabel)
-        }
+        realtimeOptions.logLevel = .verbose
+        realtimeOptions.logHandler = AblyCocoaLogger(label: loggingLabel)
 
         return ARTRealtime(options: realtimeOptions)
     }
 
     private static func createSandboxChatClient(apiKey: String, loggingLabel: String) -> ChatClient {
         let realtime = createSandboxRealtime(apiKey: apiKey, loggingLabel: loggingLabel)
-        let clientOptions = TestLogger.loggingEnabled ? ChatClientOptions(logHandler: .simple(ChatLogger(label: loggingLabel)), logLevel: .trace) : nil
+        let clientOptions = ChatClientOptions(logHandler: .simple(ChatLogger(label: loggingLabel)), logLevel: .trace)
 
         return ChatClient(realtime: realtime, clientOptions: clientOptions)
     }
@@ -82,9 +80,9 @@ struct IntegrationTests {
         Self.logAwait("AFTER Sandbox.createAPIKey()")
 
         // (1) Create a couple of chat clients — one for sending and one for receiving
-        let txClient = Self.createSandboxChatClient(apiKey: apiKey, loggingLabel: "tx")
+        let txClient = Self.createSandboxChatClient(apiKey: apiKey, loggingLabel: "basic-tx")
         let txClientID = try #require(txClient.clientID)
-        let rxClient = Self.createSandboxChatClient(apiKey: apiKey, loggingLabel: "rx")
+        let rxClient = Self.createSandboxChatClient(apiKey: apiKey, loggingLabel: "basic-rx")
 
         // (2) Fetch a room
         let roomName = "basketball"
@@ -668,8 +666,8 @@ struct IntegrationTests {
         Self.logAwait("AFTER Sandbox.createAPIKey()")
 
         // (1) Create a couple of chat clients — one for sending and one for receiving
-        let txClient = Self.createSandboxChatClient(apiKey: apiKey, loggingLabel: "tx-slash")
-        let rxClient = Self.createSandboxChatClient(apiKey: apiKey, loggingLabel: "rx-slash")
+        let txClient = Self.createSandboxChatClient(apiKey: apiKey, loggingLabel: "slash-tx")
+        let rxClient = Self.createSandboxChatClient(apiKey: apiKey, loggingLabel: "slash-rx")
 
         // (2) Fetch a room with a slash in the name
         let roomName = "room/with/slash"

Tests/AblyChatTests/Mocks/MockAblyCocoaRealtime.swift

@@ -71,6 +71,10 @@ final class MockAblyCocoaRealtime: NSObject, RealtimeClientProtocol, @unchecked
             fatalError("Not implemented")
         }
 
+        var modes: ARTChannelMode {
+            fatalError("Not implemented")
+        }
+
         var properties: ARTChannelProperties {
             fatalError("Not implemented")
         }
@@ -311,6 +315,30 @@ final class MockAblyCocoaRealtime: NSObject, RealtimeClientProtocol, @unchecked
     }
 
     final class Annotations: RealtimeAnnotationsProtocol {
+        func publish(for _: ARTMessage, annotation _: ARTOutboundAnnotation, callback _: ARTCallback? = nil) {
+            fatalError("Not implemented")
+        }
+
+        func publish(forMessageSerial _: String, annotation _: ARTOutboundAnnotation, callback _: ARTCallback? = nil) {
+            fatalError("Not implemented")
+        }
+
+        func delete(for _: ARTMessage, annotation _: ARTOutboundAnnotation, callback _: ARTCallback? = nil) {
+            fatalError("Not implemented")
+        }
+
+        func delete(forMessageSerial _: String, annotation _: ARTOutboundAnnotation, callback _: ARTCallback? = nil) {
+            fatalError("Not implemented")
+        }
+
+        func getFor(_: ARTMessage, query _: ARTAnnotationsQuery, callback _: @escaping ARTPaginatedAnnotationsCallback) {
+            fatalError("Not implemented")
+        }
+
+        func getForMessageSerial(_: String, query _: ARTAnnotationsQuery, callback _: @escaping ARTPaginatedAnnotationsCallback) {
+            fatalError("Not implemented")
+        }
+
         func subscribe(_: @escaping ARTAnnotationCallback) -> ARTEventListener? {
             fatalError("Not implemented")
         }