refactor: integrate new initial sync - WPB-10801

WireDomain/Sources/WireDomain/Providers/InitialSyncBuilder.swift

@@ -162,7 +162,8 @@ public struct InitialSyncBuilder: InitialSyncBuilderProtocol {
             conversationsAPI: ConversationsAPIBuilder(apiService: apiService).makeAPI(for: apiVersion),
             usersAPI: UsersAPIBuilder(apiService: apiService).makeAPI(for: apiVersion),
             userPropertiesAPI: UserPropertiesBuilder(apiService: apiService).makeAPI(for: apiVersion),
-            featureConfigsAPI: FeatureConfigsAPIBuilder(apiService: apiService).makeAPI(for: apiVersion)
+            featureConfigsAPI: FeatureConfigsAPIBuilder(apiService: apiService).makeAPI(for: apiVersion),
+            backendInfoAPI: BackendInfoAPIBuilder(apiService: apiService).makeAPI(for: apiVersion)
         )
     }
 
@@ -204,6 +205,8 @@ public struct InitialSyncBuilder: InitialSyncBuilderProtocol {
             userLocalStore: userLocalStore
         )
 
+        let backendConfigLocalStore = BackendConfigLocalStore(sharedUserDefaults: sharedUserDefaults)
+
         return Stores(
             updateEventsLocalStore: updateEventsLocalStore,
             userLocalStore: userLocalStore,
@@ -213,7 +216,8 @@ public struct InitialSyncBuilder: InitialSyncBuilderProtocol {
             conversationsLocalStore: conversationsLocalStore,
             conversationLabelsLocalStore: conversationLabelsLocalStore,
             featureConfigsLocalStore: featureConfigsLocalStore,
-            userClientsLocalStore: userClientsLocalStore
+            userClientsLocalStore: userClientsLocalStore,
+            backendConfigLocalStore: backendConfigLocalStore
         )
     }
 
@@ -293,6 +297,11 @@ public struct InitialSyncBuilder: InitialSyncBuilderProtocol {
             isMLSEnabled: BackendInfo.isMLSEnabled
         )
 
+        let pullMLSStatusSync = PullMLSStatusSync(
+            api: apis.backendInfoAPI,
+            store: stores.backendConfigLocalStore
+        )
+
         let pullLastUpdateEventIDSync = PullLastUpdateEventIDSync(
             selfClientID: selfClientID,
             api: apis.updateEventsAPI,
@@ -313,6 +322,7 @@ public struct InitialSyncBuilder: InitialSyncBuilderProtocol {
             pullAllFeatureConfigsSync: pullAllFeatureConfigsSync,
             pushSupportedProtocolsSync: pushSupportedProtocolsSync,
             pullMLSOneOnOneSync: pullMLSOneOnOneSync,
+            pullMLSStatusSync: pullMLSStatusSync,
             pullLastUpdateEventIDSync: pullLastUpdateEventIDSync
         )
     }
@@ -329,7 +339,8 @@ public struct InitialSyncBuilder: InitialSyncBuilderProtocol {
             pullAllConversationsSync: syncs.pullAllConversationsSync,
             pullKnownUsersSync: syncs.pullKnownUsersSync,
             pullConversationLabelsSync: syncs.pullConversationLabelsSync,
-            pullAllFeatureConfigsSync: syncs.pullAllFeatureConfigsSync
+            pullAllFeatureConfigsSync: syncs.pullAllFeatureConfigsSync,
+            pullMLSStatusSync: syncs.pullMLSStatusSync
         )
     }
 
@@ -343,6 +354,7 @@ public struct InitialSyncBuilder: InitialSyncBuilderProtocol {
         let usersAPI: UsersAPI
         let userPropertiesAPI: UserPropertiesAPI
         let featureConfigsAPI: FeatureConfigsAPI
+        let backendInfoAPI: BackendInfoAPI
 
     }
 
@@ -357,6 +369,7 @@ public struct InitialSyncBuilder: InitialSyncBuilderProtocol {
         let conversationLabelsLocalStore: ConversationLabelsLocalStore
         let featureConfigsLocalStore: FeatureConfigLocalStore
         let userClientsLocalStore: UserClientsLocalStore
+        let backendConfigLocalStore: BackendConfigLocalStore
 
     }
 
@@ -375,6 +388,7 @@ public struct InitialSyncBuilder: InitialSyncBuilderProtocol {
         let pullAllFeatureConfigsSync: PullAllFeatureConfigsSync
         let pushSupportedProtocolsSync: PushSupportedProtocolsSync
         let pullMLSOneOnOneSync: PullMLSOneOnOneSync
+        let pullMLSStatusSync: PullMLSStatusSync
         let pullLastUpdateEventIDSync: PullLastUpdateEventIDSync
 
     }

WireDomain/Sources/WireDomain/Synchronization/PullResourcesSync.swift

@@ -32,6 +32,7 @@ struct PullResourcesSync: PullResourcesSyncProtocol {
     private let pullKnownUsersSync: any PullKnownUsersSyncProtocol
     private let pullConversationLabelsSync: any PullConversationLabelsSyncProtocol
     private let pullAllFeatureConfigsSync: any PullAllFeatureConfigsSyncProtocol
+    private let pullMLSStatusSync: any PullMLSStatusSyncProtocol
 
     private let logger = WireLogger(tag: "pull-resources")
 
@@ -46,7 +47,8 @@ struct PullResourcesSync: PullResourcesSyncProtocol {
         pullAllConversationsSync: any PullAllConversationsSyncProtocol,
         pullKnownUsersSync: any PullKnownUsersSyncProtocol,
         pullConversationLabelsSync: any PullConversationLabelsSyncProtocol,
-        pullAllFeatureConfigsSync: any PullAllFeatureConfigsSyncProtocol
+        pullAllFeatureConfigsSync: any PullAllFeatureConfigsSyncProtocol,
+        pullMLSStatusSync: any PullMLSStatusSyncProtocol
     ) {
         self.pullSelfUserSync = pullSelfUserSync
         self.pullSelfUserSettingsSync = pullSelfUserSettingsSync
@@ -59,6 +61,7 @@ struct PullResourcesSync: PullResourcesSyncProtocol {
         self.pullKnownUsersSync = pullKnownUsersSync
         self.pullConversationLabelsSync = pullConversationLabelsSync
         self.pullAllFeatureConfigsSync = pullAllFeatureConfigsSync
+        self.pullMLSStatusSync = pullMLSStatusSync
     }
 
     func pull() async throws {
@@ -82,6 +85,7 @@ struct PullResourcesSync: PullResourcesSyncProtocol {
 
             try await pullConversationLabels()
             try await pullFeatureConfigs()
+            try await pullMLSStatus()
         }
     }
 
@@ -184,6 +188,15 @@ struct PullResourcesSync: PullResourcesSyncProtocol {
         }
     }
 
+    private func pullMLSStatus() async throws {
+        do {
+            logger.debug("pulling MLS status")
+            try await pullMLSStatusSync.pull()
+        } catch {
+            throw Failure(resourceName: "pull MLS status", reason: error)
+        }
+    }
+
 }
 
 extension PullResourcesSync {

WireDomain/Tests/WireDomainTests/Synchronization/PullResourcesSyncTests.swift

@@ -35,6 +35,7 @@ final class PullResourcesSyncTests: XCTestCase {
     private var pullKnownUsersSync: MockPullKnownUsersSyncProtocol!
     private var pullConversationLabelsSync: MockPullConversationLabelsSyncProtocol!
     private var pullAllFeatureConfigsSync: MockPullAllFeatureConfigsSyncProtocol!
+    private var pullMLSStatusSync: MockPullMLSStatusSyncProtocol!
 
     override func setUp() async throws {
         pullSelfUserSync = MockPullSelfUserSyncProtocol()
@@ -48,6 +49,7 @@ final class PullResourcesSyncTests: XCTestCase {
         pullKnownUsersSync = MockPullKnownUsersSyncProtocol()
         pullConversationLabelsSync = MockPullConversationLabelsSyncProtocol()
         pullAllFeatureConfigsSync = MockPullAllFeatureConfigsSyncProtocol()
+        pullMLSStatusSync = MockPullMLSStatusSyncProtocol()
 
         sut = PullResourcesSync(
             pullSelfUserSync: pullSelfUserSync,
@@ -60,7 +62,8 @@ final class PullResourcesSyncTests: XCTestCase {
             pullAllConversationsSync: pullAllConversationsSync,
             pullKnownUsersSync: pullKnownUsersSync,
             pullConversationLabelsSync: pullConversationLabelsSync,
-            pullAllFeatureConfigsSync: pullAllFeatureConfigsSync
+            pullAllFeatureConfigsSync: pullAllFeatureConfigsSync,
+            pullMLSStatusSync: pullMLSStatusSync
         )
     }
 
@@ -76,6 +79,7 @@ final class PullResourcesSyncTests: XCTestCase {
         pullKnownUsersSync = nil
         pullConversationLabelsSync = nil
         pullAllFeatureConfigsSync = nil
+        pullMLSStatusSync = nil
         sut = nil
     }
 
@@ -96,6 +100,7 @@ final class PullResourcesSyncTests: XCTestCase {
         pullKnownUsersSync.pull_MockMethod = {}
         pullConversationLabelsSync.pull_MockMethod = {}
         pullAllFeatureConfigsSync.pull_MockMethod = {}
+        pullMLSStatusSync.pull_MockMethod = {}
 
         // When
         try await sut.pull()
@@ -112,6 +117,7 @@ final class PullResourcesSyncTests: XCTestCase {
         XCTAssertEqual(pullKnownUsersSync.pull_Invocations.count, 1)
         XCTAssertEqual(pullConversationLabelsSync.pull_Invocations.count, 1)
         XCTAssertEqual(pullAllFeatureConfigsSync.pull_Invocations.count, 1)
+        XCTAssertEqual(pullMLSStatusSync.pull_Invocations.count, 1)
     }
 
 }

wire-ios-request-strategy/Sources/Protocols/ApplicationStatus.swift

@@ -20,11 +20,10 @@ import Foundation
 
 @objc(ZMApplicationStatus)
 public protocol ApplicationStatus: AnyObject {
+
     var synchronizationState: SynchronizationState { get }
     var operationState: OperationState { get }
     var clientRegistrationDelegate: ClientRegistrationDelegate { get }
     var requestCancellation: ZMRequestCancellation { get }
 
-    func requestResyncResources()
-
 }

wire-ios-sync-engine/Source/SessionManager/SessionFactories.swift

@@ -61,29 +61,30 @@ open class AuthenticatedSessionFactory {
         sharedUserDefaults: UserDefaults,
         isDeveloperModeEnabled: Bool
     ) -> ZMUserSession? {
+        let wireAPIBackendEnvironment = BackendEnvironment(
+            url: environment.backendURL,
+            webSocketURL: environment.backendWSURL,
+            pinnedKeys: environment.trustData.map { trustData in
+                PinnedKey(
+                    key: trustData.certificateKey,
+                    hosts: trustData.hosts.map { host in
+                        switch host.rule {
+                        case .equals:
+                            .equals(host.value)
+                        case .endsWith:
+                            .endsWith(host.value)
+                        }
+                    }
+                )
+            },
+            proxySettings: proxySettings
+        )
 
-        let apiServiceFactory: APIServiceFactory = { [weak self, environment, minTLSVersion] clientID, userID in
+        let apiServiceFactory: APIServiceFactory = { [wireAPIBackendEnvironment, minTLSVersion] clientID, userID in
             let wireAssembly = WireAPI.Assembly(
                 userID: userID,
                 clientID: clientID,
-                backendEnvironment: BackendEnvironment(
-                    url: environment.backendURL,
-                    webSocketURL: environment.backendWSURL,
-                    pinnedKeys: environment.trustData.map { trustData in
-                        PinnedKey(
-                            key: trustData.certificateKey,
-                            hosts: trustData.hosts.map { host in
-                                switch host.rule {
-                                case .equals:
-                                    .equals(host.value)
-                                case .endsWith:
-                                    .endsWith(host.value)
-                                }
-                            }
-                        )
-                    },
-                    proxySettings: self?.proxySettings
-                ),
+                backendEnvironment: wireAPIBackendEnvironment,
                 minTLSVersion: WireAPI.TLSVersion.minVersionFrom(minTLSVersion),
                 cookieEncryptionKey: UserDefaults.cookiesKey()
             )
@@ -111,6 +112,8 @@ open class AuthenticatedSessionFactory {
         var userSessionBuilder = ZMUserSessionBuilder()
         userSessionBuilder.withAllDependencies(
             apiServiceFactory: apiServiceFactory,
+            backendEnvironment: environment,
+            wireAPIBackendEnvironment: wireAPIBackendEnvironment,
             appVersion: appVersion,
             application: application,
             cryptoboxMigrationManager: CryptoboxMigrationManager(),
@@ -125,7 +128,8 @@ open class AuthenticatedSessionFactory {
             recurringActionService: nil,
             sharedUserDefaults: sharedUserDefaults,
             transportSession: transportSession,
-            userId: account.userIdentifier
+            userId: account.userIdentifier,
+            minTLSVersion: minTLSVersion
         )
 
         let userSession = userSessionBuilder.build()

wire-ios-sync-engine/Source/SessionManager/SessionManager.swift

@@ -1073,9 +1073,9 @@ public final class SessionManager: NSObject, SessionManagerType {
         let context = userSession.syncContext
         context.perform {
             if context.readMigrationNeedsSlowSyncFlag() {
-                userSession.syncStatus.forceSlowSync()
+                userSession.triggerInitialSync()
             } else if context.readMigrationNeedsSyncResourcesFlag() {
-                userSession.syncStatus.resyncResources()
+                userSession.triggerResourceSync()
             }
         }
     }

wire-ios-sync-engine/Source/Synchronization/ApplicationStatusDirectory.swift

@@ -108,12 +108,4 @@ public final class ApplicationStatusDirectory: NSObject, ApplicationStatus {
         }
     }
 
-    public func requestResyncResources() {
-        syncStatus.resyncResources()
-    }
-
-    public func requestQuickSync() {
-        syncStatus.forceQuickSync()
-    }
-
 }

wire-ios-sync-engine/Source/Synchronization/SyncAgent.swift

@@ -33,7 +33,7 @@ final class SyncAgent: NSObject {
     private let initialSyncBuilder: any InitialSyncBuilderProtocol
     private let legacySyncStatus: any SyncStatusProtocol
 
-    private var hasPerformedInitialSync: Bool {
+    var hasPerformedInitialSync: Bool {
         lastUpdateEventIDRepository.fetchLastEventID() != nil
     }
 
@@ -141,7 +141,7 @@ extension SyncAgent: ZMSyncStateDelegate {
     }
 
     func didFinishQuickSync() {
-        WireLogger.sync.debug("did start finish incremental sync")
+        WireLogger.sync.debug("did finish legacy incremental sync")
         delegate?.syncAgentDidFinishLegacyIncrementalSync(self)
     }
 

wire-ios-sync-engine/Source/UserSession/SyncStatus.swift

@@ -118,26 +118,33 @@ public class SyncStatus: NSObject, SyncStatusProtocol, SyncProgress {
     }
 
     public func forceSlowSync() {
-        // Refetch user settings.
-        ZMUser.selfUser(in: managedObjectContext).needsPropertiesUpdate = true
-        // Reset the status.
-        currentSyncPhase = SyncPhase.fetchingLastUpdateEventID
-        RequestAvailableNotification.notifyNewRequestsAvailable(nil)
-        log("slow sync")
-        syncStateDelegate?.didStartSlowSync()
+        managedObjectContext.performAndWait { [weak self] in
+            guard let self else { return }
+            // Refetch user settings.
+            ZMUser.selfUser(in: managedObjectContext).needsPropertiesUpdate = true
+            // Reset the status.
+            currentSyncPhase = SyncPhase.fetchingLastUpdateEventID
+            RequestAvailableNotification.notifyNewRequestsAvailable(nil)
+            log("slow sync")
+            syncStateDelegate?.didStartSlowSync()
+        }
     }
 
     /// Sync the resources: Teams, Users, Conversations...
     public func resyncResources() {
-        // Refetch user settings.
-        ZMUser.selfUser(in: managedObjectContext).needsPropertiesUpdate = true
-        // If we don't have a last event id, we need to get that first, otherwise the quick sync will fetch all events
-        // in the notification queue.
-        currentSyncPhase = hasPersistedLastEventID ? SyncPhase.fetchingLastUpdateEventID
-            .nextPhase : .fetchingLastUpdateEventID
-        RequestAvailableNotification.notifyNewRequestsAvailable(nil)
-        log("resyncResources")
-        syncStateDelegate?.didStartSlowSync()
+        managedObjectContext.performAndWait { [weak self] in
+            guard let self else { return }
+            // Refetch user settings.
+            ZMUser.selfUser(in: managedObjectContext).needsPropertiesUpdate = true
+            // If we don't have a last event id, we need to get that first, otherwise the quick sync will fetch all
+            // events
+            // in the notification queue.
+            currentSyncPhase = hasPersistedLastEventID ? SyncPhase.fetchingLastUpdateEventID
+                .nextPhase : .fetchingLastUpdateEventID
+            RequestAvailableNotification.notifyNewRequestsAvailable(nil)
+            log("resyncResources")
+            syncStateDelegate?.didStartSlowSync()
+        }
     }
 
     public func performQuickSync() async {

wire-ios-sync-engine/Source/UserSession/ZMUserSession/ZMUserSession+Actions.swift

@@ -86,7 +86,7 @@ public extension ZMUserSession {
 
         let conversation = userInfo.conversation(in: managedObjectContext)
 
-        managedObjectContext.perform {
+        managedObjectContext.performAndWait {
             conversation?.voiceChannel?.leave(userSession: self, completion: nil)
             BackgroundActivityFactory.shared.endBackgroundActivity(activity)
             completionHandler()