Merge pull request #81 from ably-labs/use-main-ably-cocoa

Use `main` branch of ably-cocoa

Author: lawrence-forooghian

AblyChat.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -44,6 +44,10 @@ final class MockRealtime: NSObject, RealtimeClientProtocol, Sendable {
             fatalError("Not implemented")
         }
 
+        var properties: ARTChannelProperties {
+            fatalError("Not implemented")
+        }
+
         func attach() {
             fatalError("Not implemented")
         }
@@ -211,4 +215,8 @@ final class MockRealtime: NSObject, RealtimeClientProtocol, Sendable {
     func close() {
         fatalError("Not implemented")
     }
+
+    func request(_: String, path _: String, params _: [String: String]?, body _: Any?, headers _: [String: String]?, callback _: @escaping ARTHTTPPaginatedCallback) throws {
+        fatalError("Not implemented")
+    }
 }

Example/AblyChatExample/Mocks/MockRealtime.swift

@@ -20,7 +20,8 @@ let package = Package(
     dependencies: [
         .package(
             url: "https://github.com/ably/ably-cocoa",
-            from: "1.2.0"
+            // TODO: Switch back to using a tag (https://github.com/ably-labs/ably-chat-swift/issues/80)
+            branch: "main"
         ),
         .package(
             url: "https://github.com/apple/swift-argument-parser",

Package.resolved

@@ -1,10 +1,7 @@
 import Ably
 
-// TODO: remove "@unchecked Sendable" once https://github.com/ably/ably-cocoa/issues/1962 done
+extension ARTRealtime: RealtimeClientProtocol {}
 
-// This @retroactive is needed to silence the Swift 6 compiler error "extension declares a conformance of imported type 'ARTRealtimeChannels' to imported protocol 'Sendable'; this will not behave correctly if the owners of 'Ably' introduce this conformance in the future (…) add '@retroactive' to silence this warning". I don’t fully understand the implications of this but don’t really mind since both libraries are in our control.
-extension ARTRealtime: RealtimeClientProtocol, @retroactive @unchecked Sendable {}
+extension ARTRealtimeChannels: RealtimeChannelsProtocol {}
 
-extension ARTRealtimeChannels: RealtimeChannelsProtocol, @retroactive @unchecked Sendable {}
-
-extension ARTRealtimeChannel: RealtimeChannelProtocol, @retroactive @unchecked Sendable {}
+extension ARTRealtimeChannel: RealtimeChannelProtocol {}

Package.swift

@@ -96,6 +96,7 @@ struct Lint: AsyncParsableCommand {
     enum Error: Swift.Error {
         case malformedSwiftVersionFile
         case malformedPackageManifestFile
+        case malformedPackageLockfile
         case mismatchedVersions(swiftVersionFileVersion: String, packageManifestFileVersion: String)
         case packageLockfilesHaveDifferentContents(paths: [String])
     }
@@ -152,12 +153,14 @@ struct Lint: AsyncParsableCommand {
     }
 
     /// Checks that the SPM-managed Package.resolved matches the Xcode-managed one. (I still don’t fully understand _why_ there are two files).
+    ///
+    /// Ignores the `originHash` property of the Package.resolved file, because this property seems to frequently be different between the SPM version and the Xcode version, and I don’t know enough about SPM to know what this property means or whether there’s a reproducible way to get them to match.
     func comparePackageLockfiles() async throws {
         let lockfilePaths = ["Package.resolved", "AblyChat.xcworkspace/xcshareddata/swiftpm/Package.resolved"]
-        let lockfileContents = try await withThrowingTaskGroup(of: String.self) { group in
+        let lockfileContents = try await withThrowingTaskGroup(of: Data.self) { group in
             for lockfilePath in lockfilePaths {
                 group.addTask {
-                    try await loadUTF8StringFromFile(at: lockfilePath)
+                    try await loadDataFromFile(at: lockfilePath)
                 }
             }
 
@@ -166,13 +169,30 @@ struct Lint: AsyncParsableCommand {
             }
         }
 
-        if Set(lockfileContents).count > 1 {
+        // Remove the `originHash` property from the Package.resolved contents before comparing (for reasons described above).
+        let lockfileContentsWeCareAbout = try lockfileContents.map { data in
+            guard var dictionary = try JSONSerialization.jsonObject(with: data) as? [String: Any] else {
+                throw Error.malformedPackageLockfile
+            }
+
+            dictionary.removeValue(forKey: "originHash")
+
+            // We use .sortedKeys to get a canonical JSON encoding for comparison.
+            return try JSONSerialization.data(withJSONObject: dictionary, options: .sortedKeys)
+        }
+
+        if Set(lockfileContentsWeCareAbout).count > 1 {
             throw Error.packageLockfilesHaveDifferentContents(paths: lockfilePaths)
         }
     }
 
-    private func loadUTF8StringFromFile(at path: String) async throws -> String {
+    private func loadDataFromFile(at path: String) async throws -> Data {
         let (data, _) = try await URLSession.shared.data(from: .init(filePath: path))
+        return data
+    }
+
+    private func loadUTF8StringFromFile(at path: String) async throws -> String {
+        let data = try await loadDataFromFile(at: path)
         return try String(data: data, encoding: .utf8)
     }
 }

Sources/AblyChat/AblyCocoaExtensions/Ably+Dependencies.swift

@@ -62,4 +62,8 @@ final class MockRealtime: NSObject, RealtimeClientProtocol, Sendable {
     func close() {
         fatalError("Not implemented")
     }
+
+    func request(_: String, path _: String, params _: [String: String]?, body _: Any?, headers _: [String: String]?, callback _: @escaping ARTHTTPPaginatedCallback) throws {
+        fatalError("Not implemented")
+    }
 }

Sources/BuildTool/BuildTool.swift

@@ -54,6 +54,10 @@ final class MockRealtimeChannel: NSObject, RealtimeChannelProtocol {
         fatalError("Not implemented")
     }
 
+    var properties: ARTChannelProperties {
+        fatalError("Not implemented")
+    }
+
     func attach() {
         fatalError("Not implemented")
     }