Actually use the error handler set in EventConfiguration (#8217)

realm · Apr 25, 2023 · 44de6c4 · 44de6c4
1 parent 4386694
commit 44de6c4
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 10 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,8 +4,7 @@ x.y.z Release notes (yyyy-MM-dd)
 * None.
 
 ### Fixed
-* <How to hit and notice issue? what was the impact?> ([#????](https://github.com/realm/realm-swift/issues/????), since v?.?.?)
-* None.
+* The error handler set on EventsConfiguration was not actually used (since v10.26.0).
 
 <!-- ### Breaking Changes - ONLY INCLUDE FOR NEW MAJOR version -->
 

diff --git a/Realm/ObjectServerTests/EventTests.swift b/Realm/ObjectServerTests/EventTests.swift
@@ -23,6 +23,7 @@ import XCTest
 
 #if canImport(RealmTestSupport)
 import RealmSwiftSyncTestSupport
+import RealmSwiftTestSupport
 import RealmSyncTestSupport
 import RealmTestSupport
 #endif
@@ -415,25 +416,25 @@ class SwiftEventTests: SwiftSyncTestCase {
         assertEvent("link via subscript", personCount: 1, linkAccessed)
         assertEvent("link via dynamic", personCount: 1, linkAccessed)
 
-        let listAccsssed: NSDictionary = [
+        let listAccessed: NSDictionary = [
             "_id": id!.stringValue,
             "realm_id": NSNull(),
             "person": idOnly(a),
             "people": [full(b), full(c)],
             "peopleByName": [b.firstName: idOnly(b), c.firstName: idOnly(c)]
         ]
-        assertEvent("list property", personCount: 1, listAccsssed)
-        assertEvent("dynamic list property", personCount: 1, listAccsssed)
+        assertEvent("list property", personCount: 1, listAccessed)
+        assertEvent("dynamic list property", personCount: 1, listAccessed)
 
-        let dictionaryAccsssed: NSDictionary = [
+        let dictionaryAccessed: NSDictionary = [
             "_id": id!.stringValue,
             "realm_id": NSNull(),
             "person": idOnly(a),
             "people": [idOnly(b), idOnly(c)],
             "peopleByName": [b.firstName: full(b), c.firstName: full(c)]
         ]
-        assertEvent("dictionary property", personCount: 1, dictionaryAccsssed)
-        assertEvent("dynamic dictionary property", personCount: 1, dictionaryAccsssed)
+        assertEvent("dictionary property", personCount: 1, dictionaryAccessed)
+        assertEvent("dynamic dictionary property", personCount: 1, dictionaryAccessed)
     }
 
     func testMetadata() throws {
@@ -537,4 +538,25 @@ class SwiftEventTests: SwiftSyncTestCase {
         let result = getEvents(expectedCount: 1)
         XCTAssertEqual(result[0].activity, "scope")
     }
+
+    func testErrorHandler() throws {
+        var config = try self.config()
+        let blockCalled = Locked(false)
+        let ex = expectation(description: "Error callback called")
+        config.eventConfiguration?.errorHandler = { error in
+            assertSyncError(error, .clientUserError, "Unable to refresh the user access token.")
+            blockCalled.value = true
+            ex.fulfill()
+        }
+        let realm = try openRealm(configuration: config)
+        let events = realm.events!
+        manuallySetAccessToken(for: user, value: badAccessToken())
+        manuallySetRefreshToken(for: user, value: badAccessToken())
+
+        // Recording the audit event should succeed, but we should get a sync
+        // error when trying to actually upload it due to the user having
+        // an invalid access token
+        events.recordEvent(activity: "activity which should fail").await(self)
+        wait(for: [ex], timeout: 4.0)
+    }
 }
diff --git a/Realm/RLMEvent.h b/Realm/RLMEvent.h
@@ -51,7 +51,7 @@ FOUNDATION_EXTERN void RLMEventUpdateMetadata(struct RLMEventContext *context,
 @property (nonatomic, nullable) RLMUser *syncUser;
 @property (nonatomic, nullable) NSDictionary<NSString *, NSString *> *metadata;
 @property (nonatomic, nullable) void (^logger)(RLMSyncLogLevel, NSString *);
-@property (nonatomic, nullable) void (^errorHandler)(NSError *);
+@property (nonatomic, nullable) RLM_SWIFT_SENDABLE void (^errorHandler)(NSError *);
 
 #ifdef __cplusplus
 - (std::shared_ptr<realm::AuditConfig>)auditConfigWithRealmConfiguration:(RLMRealmConfiguration *)realmConfig;

diff --git a/RealmSwift/RealmConfiguration.swift b/RealmSwift/RealmConfiguration.swift
@@ -310,6 +310,7 @@ extension Realm {
                 rlmConfig.syncUser = eventConfiguration.syncUser
                 rlmConfig.metadata = eventConfiguration.metadata
                 rlmConfig.logger = eventConfiguration.logger
+                rlmConfig.errorHandler = eventConfiguration.errorHandler
                 configuration.eventConfiguration = rlmConfig
             }
 
@@ -338,7 +339,8 @@ extension Realm {
             if let eventConfiguration = rlmConfiguration.eventConfiguration {
                 configuration.eventConfiguration = EventConfiguration(metadata: eventConfiguration.metadata,
                                                                       syncUser: eventConfiguration.syncUser,
-                                                                      partitionPrefix: eventConfiguration.partitionPrefix)
+                                                                      partitionPrefix: eventConfiguration.partitionPrefix,
+                                                                      errorHandler: eventConfiguration.errorHandler)
             }
 
             configuration.initialSubscriptions = ObjectiveCSupport.convert(block: rlmConfiguration.initialSubscriptions)