Unregister SyncSession callbacks when SyncManager is destroyed

Author: danieltabacaru

src/realm/object-store/sync/sync_session.cpp

@@ -402,6 +402,17 @@ SyncSession::SyncSession(Private, SyncClient& client, std::shared_ptr<DB> db, co
 
 void SyncSession::detach_from_sync_manager()
 {
+    // Unregister all callbacks when the App and SyncManager are destroyed.
+    {
+        util::CheckedLockGuard lk(m_state_mutex);
+        m_completion_callbacks.clear();
+    }
+    {
+        util::CheckedLockGuard lk(m_connection_state_mutex);
+        m_connection_change_notifier.remove_callbacks();
+    }
+    m_progress_notifier.unregister_callbacks();
+
     shutdown_and_wait();
     util::CheckedLockGuard lk(m_state_mutex);
     m_sync_manager = nullptr;
@@ -1555,6 +1566,14 @@ void SyncProgressNotifier::unregister_callback(uint64_t token)
     m_packages.erase(token);
 }
 
+void SyncProgressNotifier::unregister_callbacks()
+{
+    std::lock_guard<std::mutex> lock(m_mutex);
+    m_packages.clear();
+    m_current_progress.reset();
+    m_local_transaction_version = 0;
+}
+
 void SyncProgressNotifier::update(uint64_t downloaded, uint64_t downloadable, uint64_t uploaded, uint64_t uploadable,
                                   uint64_t snapshot_version, double download_estimate, double upload_estimate,
                                   int64_t query_version)
@@ -1662,6 +1681,14 @@ void SyncSession::ConnectionChangeNotifier::remove_callback(uint64_t token)
     }
 }
 
+void SyncSession::ConnectionChangeNotifier::remove_callbacks()
+{
+    std::lock_guard<std::mutex> lock(m_callback_mutex);
+    m_callbacks.clear();
+    m_callback_count = -1;
+    m_callback_index = -1;
+}
+
 void SyncSession::ConnectionChangeNotifier::invoke_callbacks(ConnectionState old_state, ConnectionState new_state)
 {
     std::unique_lock lock(m_callback_mutex);

src/realm/object-store/sync/sync_session.hpp

@@ -57,6 +57,7 @@ class SyncProgressNotifier {
     uint64_t register_callback(std::function<ProgressNotifierCallback>, NotifierType direction, bool is_streaming,
                                int64_t pending_query_version);
     void unregister_callback(uint64_t);
+    void unregister_callbacks();
 
     void set_local_version(uint64_t);
     void update(uint64_t downloaded, uint64_t downloadable, uint64_t uploaded, uint64_t uploadable,
@@ -368,6 +369,7 @@ class SyncSession : public std::enable_shared_from_this<SyncSession> {
     public:
         uint64_t add_callback(std::function<ConnectionStateChangeCallback> callback);
         void remove_callback(uint64_t token);
+        void remove_callbacks();
         void invoke_callbacks(ConnectionState old_state, ConnectionState new_state);
 
     private:
@@ -394,8 +396,6 @@ class SyncSession : public std::enable_shared_from_this<SyncSession> {
     }
     // }
 
-    std::shared_ptr<SyncManager> sync_manager() const REQUIRES(!m_state_mutex);
-
     static util::UniqueFunction<void(std::optional<app::AppError>)>
     handle_refresh(const std::shared_ptr<SyncSession>&, bool);
 

test/object-store/sync/session/connection_change_notifications.cpp

@@ -117,4 +117,24 @@ TEST_CASE("sync: Connection state changes", "[sync][session][connection change]"
         REQUIRE(listener1_call_cnt == 1); // Only called once before unregister
         REQUIRE(listener2_called);
     }
+
+    SECTION("Callback not invoked when SyncSession is detached from SyncManager") {
+        auto session = sync_session(
+            user, "/connection-state-changes-1", [](auto, auto) {}, SyncSessionStopPolicy::AfterChangesUploaded);
+
+        EventLoop::main().run_until([&] {
+            return sessions_are_active(*session);
+        });
+        EventLoop::main().run_until([&] {
+            return sessions_are_connected(*session);
+        });
+
+        bool listener_called = false;
+        session->register_connection_change_callback([&](SyncSession::ConnectionState, SyncSession::ConnectionState) {
+            listener_called = true;
+        });
+
+        session->detach_from_sync_manager();
+        REQUIRE_FALSE(listener_called);
+    }
 }