Files
element-x-ios/ElementX/Sources/Services/UserSession/UserSessionManagerProtocol.swift
T
Mauro 7752ae3f6a Keep every signed-in account live (#6299)
* Keep every signed-in account live

With the multi-account flag on, the accounts other than the active one are now
restored at launch, one after the other once the active account's UI is up.
They run their migrations, sync while the app is active, get a pusher (appended
so accounts on the same homeserver keep each other's) and count towards the app
badge, and background refresh and search backfill cover them too. Only the
active account's remote settings are ever applied.

Calls stay with the active account until the call service handles every account,
and an auth error on another account is only logged until accounts can be signed
out one at a time. With the flag off only the active account is live, as before.

* Sum the app badge across every signed in account

Each live account now reports its own unread count, and the app badge
shows their sum. Delivered notifications are only cleared for the
account whose rooms were read, so a room shared by two accounts keeps
the other account's notifications.

The room list observer for the badge and the notifications moves from
the UserSessionFlowCoordinator to the AppCoordinator's per-account
wiring. The flow keeps updating the chats tab badge.

* Let the user session manager manage every session

- The AppCoordinator tells the manager to pause, resume, go offline or
  run the search backfill, instead of looping over the sessions itself.
- The manager also restores the other accounts, preparing each with the
  AppCoordinator's migrations and wiring, and resumes them while the
  services are running. With a single account nothing changes.
- Wiring an account again (e.g. after clearing the cache) replaces its
  observers rather than adding to them.
- Add addAccountFlowEnabled, a developer-only switch for the upcoming
  add account flow. It isn't a user preference, so testers enabling
  multi-account can't add a second account yet.

* Apply review suggestions to keeping every account live

- Move the notification changes (pushers for every account, the summed
  app badge and per-account clearing) to their own PR, so notifications
  follow the active account again for now.
- Revert loading only the active account's remote settings: they load in
  the store again, as on develop, until the hooks are reworked.
- The user session manager reports the auth errors of every live session,
  so the AppCoordinator subscribes once instead of keeping per-account
  observers.
- Restoring a single account is private to the manager now.
- Rename otherSessionsRestoreTask to otherSessionsRestorationTask.

* Restore every signed in account through one path

The user session manager now restores every account in a single pass,
most recently selected first, instead of separate restores for the
active account and the others. The AppCoordinator shows the first
account that comes back and no longer reads the multi-account flag:
without it, the manager only ever makes one account live.

- Clearing the cache clears every live account, and the next pass
  replaces their sessions.
- Each account is migrated once per launch, and an account that just
  signed in is never migrated.
- A pass also runs after signing in, so the other accounts come live.
- Remove UserSessionManagerError, restoreActiveSession and
  restoreOtherSessions.

* Only clear the cache of the active account

Clearing the cache goes back to clearing the account shown in the UI.
Its session stays live until the next restore pass replaces it, and when
that restore fails another live account becomes the active one.

* Apply review suggestions to restoring every account

- Remove the search backfill guard: with no sessions the manager starts
  nothing and reports that nothing is running, so the task completes.
- Add a TODO to switch to the most recently used account when the
  active one signs out while others are signed in (element-meta#3325).
- Disable SwiftLint's type_body_length on the AppCoordinator again, it's
  just over the limit with develop's new migrations.
2026-10-13 17:06:05 +00:00

64 lines
3.2 KiB
Swift

//
// Copyright 2026 Element Creations Ltd.
//
// SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial.
// Please see LICENSE files in the repository root for full details.
//
import Combine
import Foundation
import MatrixRustSDK
enum UserSessionManagerCallback: Equatable {
case didReceiveAuthError(userID: String, isSoftLogout: Bool)
}
// sourcery: AutoMockable
protocol UserSessionManagerProtocol: AnyObject {
/// Every signed in account, most recently active first. Known before any session is live, so use it to count accounts.
var userIDs: [String] { get }
/// The live sessions, in the same order as `userIDs`.
var sessionsPublisher: CurrentValuePublisher<[UserSessionProtocol], Never> { get }
/// The session of the account whose UI is on screen.
var activeSession: UserSessionProtocol? { get }
/// The auth errors of every live session, with the account they belong to.
var callbacksPublisher: AnyPublisher<UserSessionManagerCallback, Never> { get }
/// The delegate that stores changes to a client's session, such as refreshed tokens.
var clientSessionDelegate: ClientSessionDelegate { get }
func session(for userID: String) -> UserSessionProtocol?
// MARK: - Lifecycle
/// Restores every account that isn't live, or whose caches were cleared, most recently selected first and one after the other.
/// Each session is `prepare`d (e.g. migrated), added, passed to `didAdd`, then resumed if the services are running.
/// An account that fails is removed (the store deletes its data). Without `multiAccountEnabled` only one account is ever live.
func restoreSessions(prepare: @MainActor (UserSessionProtocol) async -> Void, didAdd: @MainActor (UserSessionProtocol) -> Void) async
/// Clears an account's caches. Its session stays live until `restoreSessions` replaces it.
func clearCaches(userID: String) async
/// Creates the session of an account that has just signed in, and stores its credentials.
///
/// The session isn't registered: `add` it once it's ready to be used.
func userSession(for client: ClientProtocol, sessionDirectories: SessionDirectories, passphrase: Data) async -> Result<UserSessionProtocol, UserSessionStoreError>
/// Registers a session that's ready to be used, replacing any previous session for its account.
/// A new account becomes the active one, a known account keeps its place.
func add(_ userSession: UserSessionProtocol)
/// Deletes an account's credentials and data, and forgets its session.
func remove(userID: String)
/// Deletes every account's credentials and data.
func reset()
// MARK: - Services
/// Whether any live session is still running a search backfill.
var isSearchBackfillRunning: Bool { get }
/// Resumes every live session's services, and those of the sessions restored while they're running.
func resumeServices() async
/// Pauses every live session's services.
func pauseServices() async
func configurePresence(_ presence: ClientProxyPresence, sendImmediately: Bool) async
func startSearchBackfill(strategy: SearchBackfillStrategy)
func stopSearchBackfill()
}