Merge remote-tracking branch 'origin/main' into 1-add-documentation-comments

# Conflicts:
#	Sources/AblyChat/Errors.swift
#	Sources/AblyChat/Rooms.swift

Author: maratal

Example/AblyChatExample/Mocks/MockClients.swift

@@ -32,7 +32,7 @@ actor MockRooms: Rooms {
         return room
     }
 
-    func release(roomID _: String) async throws {
+    func release(roomID _: String) async {
         fatalError("Not yet implemented")
     }
 

Sources/AblyChat/Errors.swift

@@ -11,10 +11,8 @@ public let errorDomain = "AblyChatErrorDomain"
  The error codes for errors in the ``errorDomain`` error domain.
  */
 public enum ErrorCode: Int {
-    /// ``Rooms/get(roomID:options:)`` was called with a different set of room options than was used on a previous call. You must first release the existing room instance using ``Rooms/release(roomID:)``.
-    ///
-    /// TODO this code is a guess, revisit in https://github.com/ably-labs/ably-chat-swift/issues/32
-    case inconsistentRoomOptions = 1
+    /// The user attempted to perform an invalid action.
+    case badRequest = 40000
 
     /**
      * The messages feature failed to attach.
@@ -90,7 +88,7 @@ public enum ErrorCode: Int {
 
     /// Has a case for each of the ``ErrorCode`` cases that imply a fixed status code.
     internal enum CaseThatImpliesFixedStatusCode {
-        case inconsistentRoomOptions
+        case badRequest
         case messagesAttachmentFailed
         case presenceAttachmentFailed
         case reactionsAttachmentFailed
@@ -108,8 +106,8 @@ public enum ErrorCode: Int {
 
         internal var toNumericErrorCode: ErrorCode {
             switch self {
-            case .inconsistentRoomOptions:
-                .inconsistentRoomOptions
+            case .badRequest:
+                .badRequest
             case .messagesAttachmentFailed:
                 .messagesAttachmentFailed
             case .presenceAttachmentFailed:
@@ -145,7 +143,7 @@ public enum ErrorCode: Int {
         internal var statusCode: Int {
             // These status codes are taken from the "Chat-specific Error Codes" section of the spec.
             switch self {
-            case .inconsistentRoomOptions,
+            case .badRequest,
                  .roomInFailedState,
                  .roomIsReleasing,
                  .roomIsReleased,
@@ -227,7 +225,7 @@ internal enum ChatError {
     internal var codeAndStatusCode: ErrorCodeAndStatusCode {
         switch self {
         case .inconsistentRoomOptions:
-            .fixedStatusCode(.inconsistentRoomOptions)
+            .fixedStatusCode(.badRequest)
         case let .attachmentFailed(feature, _):
             switch feature {
             case .messages:

Sources/AblyChat/Rooms.swift

@@ -40,7 +40,7 @@ public protocol Rooms: AnyObject, Sendable {
      * - Parameters:
      *   - roomID: The ID of the room.
      */
-    func release(roomID: String) async throws
+    func release(roomID: String) async
 
     /**
      * Get the client options used to create the chat instance.
@@ -302,7 +302,7 @@ internal actor DefaultRooms<RoomFactory: AblyChat.RoomFactory>: Rooms {
         }
     #endif
 
-    internal func release(roomID: String) async throws {
+    internal func release(roomID: String) async {
         guard let roomState = roomStates[roomID] else {
             // CHA-RC1g2 (no-op)
             return

Tests/AblyChatTests/DefaultRoomsTests.swift

@@ -143,13 +143,13 @@ struct DefaultRoomsTests {
         _ = try await rooms.get(roomID: roomID, options: options)
 
         // When: get(roomID:options:) is called with the same ID but different options
-        // Then: It throws an inconsistentRoomOptions error
+        // Then: It throws a `badRequest` error
         let differentOptions = RoomOptions(presence: .init(subscribe: false))
 
         await #expect {
             try await rooms.get(roomID: roomID, options: differentOptions)
         } throws: { error in
-            isChatError(error, withCodeAndStatusCode: .fixedStatusCode(.inconsistentRoomOptions))
+            isChatError(error, withCodeAndStatusCode: .fixedStatusCode(.badRequest))
         }
     }
 
@@ -183,13 +183,13 @@ struct DefaultRoomsTests {
         _ = await operationWaitSubscription.first { $0.waitingOperationType == .get && $0.waitedOperationType == .release }
 
         // When: get(roomID:options:) is called with the same ID but different options
-        // Then: The second call to get(roomID:options:) throws an inconsistentRoomOptions error
+        // Then: The second call to get(roomID:options:) throws a `badRequest` error
         let differentOptions = RoomOptions(presence: .init(subscribe: false))
 
         await #expect {
             try await rooms.get(roomID: roomID, options: differentOptions)
         } throws: { error in
-            isChatError(error, withCodeAndStatusCode: .fixedStatusCode(.inconsistentRoomOptions))
+            isChatError(error, withCodeAndStatusCode: .fixedStatusCode(.badRequest))
         }
 
         // Post-test: Allow the CHA-RC1g release operation to complete
@@ -251,7 +251,7 @@ struct DefaultRoomsTests {
         // When: `release(roomID:)` is called with this room ID
         // Then: The call to `release(roomID:)` completes (this is as much as I can do to test the spec’s “no-op”; i.e. check it doesn’t seem to wait for anything or have any obvious side effects)
         let roomID = "basketball"
-        try await rooms.release(roomID: roomID)
+        await rooms.release(roomID: roomID)
     }
 
     // @spec CHA-RC1g3
@@ -290,7 +290,7 @@ struct DefaultRoomsTests {
         roomReleaseOperation.complete()
 
         // Then: The second call to `release(roomID:)` completes, and this second release call does not trigger a CHA-RL3 room release operation (i.e. in the language of the spec it reuses the “future” of the existing CHA-RC1g release operation)
-        try await secondReleaseResult
+        await secondReleaseResult
         #expect(await roomToReturn.releaseCallCount == 1)
     }
 
@@ -344,7 +344,7 @@ struct DefaultRoomsTests {
         roomReleaseOperation.complete()
 
         // Then: The second call to `release(roomID:)` completes, and this second release call does not trigger a CHA-RL3 room release operation (i.e. in the language of the spec it reuses the “future” of the existing CHA-RC1g release operation)
-        try await secondReleaseResult
+        await secondReleaseResult
         #expect(await roomToReturn.releaseCallCount == 1)
     }
 
@@ -371,7 +371,7 @@ struct DefaultRoomsTests {
         try #require(await rooms.testsOnly_hasRoomMapEntryWithID(roomID))
 
         // When: `release(roomID:)` is called with this room ID
-        _ = try await rooms.release(roomID: roomID)
+        _ = await rooms.release(roomID: roomID)
 
         // Then:
         // 1. first, the room is removed from the room map

Tests/AblyChatTests/IntegrationTests.swift

@@ -281,7 +281,7 @@ struct IntegrationTests {
         // MARK: - Release
 
         // (1) Release the room
-        try await rxClient.rooms.release(roomID: roomID)
+        await rxClient.rooms.release(roomID: roomID)
 
         // (2) Check that we received a RELEASED status change as a result of releasing the room
         _ = try #require(await rxRoomStatusSubscription.first { $0.current == .released })