RCOCOA-2423 Fix the type signature of async User.functions

CHANGELOG.md

@@ -16,6 +16,8 @@ x.y.z Release notes (yyyy-MM-dd)
   non-null return value despite always returning `nil` (since v10.29.0).
 * Eliminate several clang static analyzer warnings which did not report actual
   bugs.
+* The async and Future versions of `User.functions` only worked for functions
+  which took exactly one argument, which had to be an array ([#8669](https://github.com/realm/realm-swift/issues/8669), since 10.16.0).
 
 ### Compatibility
 * Realm Studio: 15.0.0 or later.

Realm/ObjectServerTests/AsyncSyncTests.swift

@@ -20,7 +20,7 @@
 
 import Realm
 import Realm.Private
 @_spi(RealmSwiftExperimental) import RealmSwift
 import XCTest
 
 #if canImport(RealmTestSupport)
@@ -279,7 +279,7 @@
 
         let configuration = try configuration()
         func isolatedOpen(_ actor: isolated CustomExecutorActor) async throws {
             _ = try await Realm(configuration: configuration, actor: actor, downloadBeforeOpen: .always)
         }
 
         // Try opening the Realm with the Task being cancelled at every possible
@@ -349,8 +349,8 @@
     }
 
     func testUserCallFunctionAsyncAwait() async throws {
         let user = try await self.app.login(credentials: basicCredentials())
-        guard case let .int32(sum) = try await user.functions.sum([1, 2, 3, 4, 5]) else {
+        guard case let .int32(sum) = try await user.functions.sum(.array([1, 2, 3, 4, 5])) else {
             return XCTFail("Should be int32")
         }
         XCTAssertEqual(sum, 15)
@@ -422,7 +422,7 @@
             ["favourite_colour": "green", "apples": 10]
         ])
 
         try await user.refreshCustomData()
         XCTAssertEqual(user.customData["favourite_colour"], .string("green"))
         XCTAssertEqual(user.customData["apples"], .int64(10))
     }
@@ -875,7 +875,7 @@
         let user = try await createUser()
         var config = user.flexibleSyncConfiguration()
         config.objectTypes = [SwiftPerson.self]
         let realm = try await Realm(configuration: config, actor: MainActor.shared)
         let results1 = try await realm.objects(SwiftPerson.self)
             .where { $0.firstName == name && $0.age > 8 }.subscribe(waitForSync: .onCreation)
         XCTAssertEqual(results1.count, 2)
@@ -895,7 +895,7 @@
         let user = try await createUser()
         var config = user.flexibleSyncConfiguration()
         config.objectTypes = [SwiftPerson.self]
         let realm = try await Realm(configuration: config, actor: CustomGlobalActor.shared)
         let results1 = try await realm.objects(SwiftPerson.self)
             .where { $0.firstName == name && $0.age > 8 }.subscribe(waitForSync: .onCreation)
         XCTAssertEqual(results1.count, 2)

Realm/ObjectServerTests/SwiftObjectServerTests.swift

@@ -571,7 +571,7 @@
         proxy.stop()
     }
 
     class LocationOverrideTransport: RLMNetworkTransport, Sendable {
         let hostname: String
         let wsHostname: String
         init(hostname: String = "http://localhost:9090", wsHostname: String = "ws://invalid.com:9090") {
@@ -893,7 +893,7 @@
         let credentials = Credentials.emailPassword(email: email, password: password)
         let syncUser = app.login(credentials: credentials).await(self)
 
-        let bson = syncUser.functions.sum([1, 2, 3, 4, 5]).await(self)
+        let bson = syncUser.functions.sum(.array([1, 2, 3, 4, 5])).await(self)
         guard case let .int32(sum) = bson else {
             XCTFail("unexpected bson type in sum: \(bson)")
             return

RealmSwift/Sync.swift

@@ -667,19 +667,34 @@ public struct FunctionCallable: Sendable {
     fileprivate let name: String
     fileprivate let user: User
 
+    /// :nodoc:
+    @available(*, deprecated, message: "Explicitly specify .array(arg)")
+    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
+    public func dynamicallyCall(withArguments args: [[AnyBSON]]) -> Future<AnyBSON, Error> {
+        return future { promise in
+            let objcArgs = args.first!.map(ObjectiveCSupport.convertBson)
+            self.user.__callFunctionNamed(name, arguments: objcArgs) { (bson: RLMBSON?, error: Error?) in
+                if let b = bson.map(ObjectiveCSupport.convertBson), let bson = b {
+                    promise(.success(bson))
+                } else {
+                    promise(.failure(error ?? Realm.Error.callFailed))
+                }
+            }
+        }
+    }
+
     /// The implementation of @dynamicCallable that allows  for `Future<AnyBSON, Error>` callable return.
     ///
-    ///     let cancellable = user.functions.sum([1, 2, 3, 4, 5])
+    ///     let cancellable = user.functions.sum(.array([1, 2, 3, 4, 5]))
     ///        .sink(receiveCompletion: { result in
     ///     }, receiveValue: { value in
     ///        // Returned value from function
     ///     })
     ///
-    @preconcurrency
     @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
-    public func dynamicallyCall(withArguments args: [[AnyBSON]]) -> Future<AnyBSON, Error> {
+    public func dynamicallyCall(withArguments args: [AnyBSON]) -> Future<AnyBSON, Error> {
         return future { promise in
-            let objcArgs = args.first!.map(ObjectiveCSupport.convertBson)
+            let objcArgs = args.map(ObjectiveCSupport.convertBson)
             self.user.__callFunctionNamed(name, arguments: objcArgs) { (bson: RLMBSON?, error: Error?) in
                 if let b = bson.map(ObjectiveCSupport.convertBson), let bson = b {
                     promise(.success(bson))
@@ -1134,14 +1149,25 @@ public extension User {
 
 @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
 extension FunctionCallable {
+    /// :nodoc:
+    @available(*, deprecated, message: "Explicitly specify .array(arg)")
+    public func dynamicallyCall(withArguments args: [[AnyBSON]]) async throws -> AnyBSON {
+        let objcArgs = args.first!.map(ObjectiveCSupport.convertBson)
+        let ret = try await user.__callFunctionNamed(name, arguments: objcArgs)
+        if let bson = ObjectiveCSupport.convertBson(object: ret) {
+            return bson
+        }
+        throw Realm.Error.callFailed
+    }
+
     /// The implementation of @dynamicMemberLookup that allows  for `async await` callable return.
     ///
-    ///     guard case let .int32(sum) = try await user.functions.sum([1, 2, 3, 4, 5]) else {
+    ///     guard case let .int32(sum) = try await user.functions.sum(.array([1, 2, 3, 4, 5])) else {
     ///        return
     ///     }
     ///
-    public func dynamicallyCall(withArguments args: [[AnyBSON]]) async throws -> AnyBSON {
-        let objcArgs = args.first!.map(ObjectiveCSupport.convertBson)
+    public func dynamicallyCall(withArguments args: [AnyBSON]) async throws -> AnyBSON {
+        let objcArgs = args.map(ObjectiveCSupport.convertBson)
         let ret = try await user.__callFunctionNamed(name, arguments: objcArgs)
         if let bson = ObjectiveCSupport.convertBson(object: ret) {
             return bson