Notify every signed-in account and turn notifications on and off per account (#6337)

* Store the notifications switch per account

Adds AccountSettings.enableNotifications and moves the app-wide value into the signed in accounts before they're restored: the first account takes it out of the app settings and the others get the same switch, so someone who turned notifications off keeps them off.

* Add a notification service to every user session

Each account's NotificationService sets its pusher when its notifications are on and deletes it when they're off (appending with multiple accounts), keeps the account's unread count and decides which of its delivered notifications to clear. It asks the NotificationManager, the only owner of the notification center, through actions: remove the notifications matching a rule, request authorization and the unread count. The UserSessionManager connects every live session's service to the manager, and flows and screens use the session's service instead of the manager, which leaves the flow parameters.

* Route notifications by account

Taps only open rooms of the active account for now, a tap made while restoring only opens once its account is the active one, replies are sent from the account they were made for, and signing out only clears that account's notifications unless it was the last one. The notification extension hides pushes for an account that signed out while other accounts are still signed in.

* Turn notifications on and off for each account

The notification settings switch is now saved per account, and each account's NotificationService sets or deletes its pusher when it changes, asking for permission when it's turned on.

* Apply review suggestions to multi-account notifications

Migration
- Move the notifications switch with a single per-account migration, like 26.10.1 and 26.10.2, and drop its dedicated test.

Notification manager and service
- Follow each account's badge count publisher directly, removing the badge count action and the stored counts.
- Only reset the badge and unregister from APNs when the last account signs out, as each account already clears its own notifications.
- Set up the service's subscriptions in a single setupSubscriptions().
- Rename switchChanged(to:) to enableNotificationsChanged(to:) and pusherConfiguration(identifiers:) to pusherConfiguration(for:).
- Build the service without hopping to the main actor, it already runs there.

Notification service extension
- Check the account's switch in NotificationHandler using the session's settings, and log an error when a push arrives for an account that's turned off.
- Always show pushes that match no signed-in account and log an error, so a broken setup stays visible.

Other
- Store a pending inline reply in a PendingInlineReplyDetails struct.
- Assign the chats tab badge with weakAssign.
- Make PusherConfiguration Equatable so the pusher test checks it in one expectation.
- Clarify the comment about notifications without a receiver.

* Print instead of logging before the app hooks run in the NSE

A push that matches no signed-in account goes back to printing, as MXLog shouldn't be used before the app hooks have run. The push is still shown so a broken setup stays visible.
This commit is contained in:
Mauro
2026-10-15 13:10:26 +02:00
committed by GitHub
parent 09ecec4306
commit 268d6c8ead
45 changed files with 1233 additions and 501 deletions
@@ -15,26 +15,25 @@ import Testing
@MainActor
final class NotificationManagerTests {
var notificationManager: NotificationManager!
private let clientProxy = ClientProxyMock(.init(userID: "@test:user.net"))
private lazy var mockUserSession = UserSessionMock(.init(clientProxy: clientProxy))
private var notificationCenter: UserNotificationCenterMock!
private let appSettings: AppSettings
private var authorizationStatusWasGranted = false
private var shouldDisplayInAppNotificationReturnValue = false
private var handleInlineReplyDelegateCalled = false
private var notificationTappedDelegateCalled = false
private var registerForRemoteNotificationsDelegateCalled: (() -> Void)?
private let appSettings: AppSettings
private var unregisterForRemoteNotificationsDelegateCalled = false
init() {
appSettings = AppSettings.volatile()
notificationCenter = UserNotificationCenterMock()
notificationCenter.requestAuthorizationOptionsReturnValue = true
notificationCenter.authorizationStatusReturnValue = .authorized
notificationCenter.deliveredNotificationsReturnValue = []
notificationCenter.notificationSettingsClosure = { await UNUserNotificationCenter.current().notificationSettings() }
notificationManager = NotificationManager(notificationCenter: notificationCenter, appSettings: appSettings)
notificationManager.start()
notificationManager.setUserSession(mockUserSession)
}
isolated deinit {
@@ -42,73 +41,239 @@ final class NotificationManagerTests {
notificationManager = nil
}
// MARK: - Device token
@Test
func whenRegistered_pusherIsCalled() async {
_ = await notificationManager.register(with: Data())
func registeringHandsTheTokenToEveryAccount() async {
let alice = makeService("@alice:example.com")
let bob = makeService("@bob:example.com")
notificationManager.add(alice.service)
notificationManager.add(bob.service)
let deviceToken = Data("1234".utf8)
#expect(clientProxy.setPusherWithCalled)
await notificationManager.register(with: deviceToken)
#expect(alice.service.registerDeviceTokenReceivedDeviceToken == deviceToken)
#expect(bob.service.registerDeviceTokenReceivedDeviceToken == deviceToken)
}
@Test
func whenRegisteredSuccess_completionSuccessIsCalled() async {
let success = await notificationManager.register(with: Data())
#expect(success)
}
@Test
func whenRegisteredAndPusherThrowsError_completionFalseIsCalled() async {
enum TestError: Error {
case someError
func anAccountAddedAfterwardsGetsTheSavedToken() async {
let deviceToken = Data("1234".utf8)
await notificationManager.register(with: deviceToken)
let alice = makeService("@alice:example.com")
await waitForConfirmation("The saved token should be registered", timeout: .seconds(10)) { confirm in
alice.service.registerDeviceTokenClosure = { _ in confirm() }
notificationManager.add(alice.service)
}
clientProxy.setPusherWithThrowableError = TestError.someError
let success = await notificationManager.register(with: Data())
#expect(!success)
#expect(alice.service.registerDeviceTokenReceivedDeviceToken == deviceToken)
}
@Test
func whenRegistered_pusherIsCalledWithCorrectValues() async throws {
let pushkeyData = Data("1234".utf8)
_ = await notificationManager.register(with: pushkeyData)
func aReplacedServiceRegistersAgainAndTheOldOneIsIgnored() async {
let oldBadgeCountSubject = CurrentValueSubject<Int, Never>(3)
let oldAlice = makeService("@alice:example.com")
oldAlice.service.badgeCountPublisher = oldBadgeCountSubject.asCurrentValuePublisher()
notificationManager.add(oldAlice.service)
await notificationManager.register(with: Data("1234".utf8))
let newAlice = makeService("@alice:example.com", badgeCount: 1)
guard let configuration = clientProxy.setPusherWithReceivedInvocations.first else {
Issue.record("Invalid pusher configuration sent")
return
await waitForConfirmation("The new service should register", timeout: .seconds(10)) { confirm in
newAlice.service.registerDeviceTokenClosure = { _ in confirm() }
notificationManager.add(newAlice.service)
}
oldBadgeCountSubject.send(5)
#expect(oldAlice.service.registerDeviceTokenCallsCount == 1)
#expect(appSettings.lastKnownBadgeCount == 1)
}
@Test
func theTokenIsForgottenOnceTheLastAccountIsRemoved() async throws {
notificationManager.add(makeService("@alice:example.com").service)
await notificationManager.register(with: Data("1234".utf8))
notificationManager.remove(userID: "@alice:example.com")
let bob = makeService("@bob:example.com")
// The app unregisters from APNs when signing out of the last account, so the old token is dead.
notificationManager.add(bob.service)
try await Task.sleep(for: .milliseconds(500))
#expect(!bob.service.registerDeviceTokenCalled)
}
// MARK: - Permission
@Test
func addingAnAccountRegistersWhenPermissionWasGiven() async {
notificationManager.delegate = self
await waitForConfirmation("registerForRemoteNotifications should be called", timeout: .seconds(10)) { confirm in
registerForRemoteNotificationsDelegateCalled = { confirm() }
notificationManager.add(makeService("@alice:example.com").service)
}
#expect(configuration.identifiers.pushkey == pushkeyData.base64EncodedString())
#expect(configuration.identifiers.appId == appSettings.pusherAppID)
#expect(configuration.appDisplayName == "\(InfoPlistReader.main.bundleDisplayName) (iOS)")
#expect(configuration.deviceDisplayName == UIDevice.current.name)
#expect(configuration.profileTag != nil)
#expect(configuration.lang == Bundle.app.preferredLocalizations.first)
guard case let .http(data) = configuration.kind else {
Issue.record("Http kind expected")
return
#expect(authorizationStatusWasGranted)
}
@Test
func addingAnAccountRegistersEvenWhenItIsOff() async {
notificationManager.delegate = self
// So that accounts turned off delete any pusher left on their homeserver.
await waitForConfirmation("registerForRemoteNotifications should be called", timeout: .seconds(10)) { confirm in
registerForRemoteNotificationsDelegateCalled = { confirm() }
notificationManager.add(makeService("@alice:example.com", isEnabled: false).service)
}
#expect(data.url == appSettings.pushGatewayNotifyEndpoint.absoluteString)
#expect(data.format == .eventIdOnly)
let defaultPayload = APNSPayload(aps: APSInfo(mutableContent: 1,
alert: APSAlert(locKey: "Notification",
locArgs: [])),
pusherNotificationClientIdentifier: nil)
#expect(try data.defaultPayload == (defaultPayload.toJsonString()))
#expect(authorizationStatusWasGranted)
}
@Test
func whenRegisteredAndPusherTagNotSetInSettings_tagGeneratedAndSavedInSettings() async {
appSettings.pusherProfileTag = nil
_ = await notificationManager.register(with: Data())
#expect(appSettings.pusherProfileTag != nil)
func addingAnAccountNeverAsksForPermission() async throws {
notificationCenter.authorizationStatusReturnValue = .notDetermined
notificationManager.delegate = self
notificationManager.add(makeService("@alice:example.com").service)
try await Task.sleep(for: .seconds(1))
#expect(!notificationCenter.requestAuthorizationOptionsCalled)
#expect(!authorizationStatusWasGranted)
}
@Test
func whenRegisteredAndPusherTagIsSetInSettings_tagNotGenerated() async {
appSettings.pusherProfileTag = "12345"
_ = await notificationManager.register(with: Data())
#expect(appSettings.pusherProfileTag == "12345")
func anAccountAskingForPermissionRequestsAuthorization() async {
let alice = makeService("@alice:example.com")
notificationManager.add(alice.service)
await waitForConfirmation("requestAuthorization should be called", timeout: .seconds(10)) { confirm in
notificationCenter.requestAuthorizationOptionsClosure = { _ in
confirm()
return true
}
alice.actions.send(.requestAuthorization)
}
#expect(notificationCenter.requestAuthorizationOptionsReceivedOptions == [.alert, .sound, .badge])
}
@Test
func grantingPermissionRegistersForRemoteNotifications() async {
notificationCenter.authorizationStatusReturnValue = .notDetermined
notificationManager.delegate = self
let alice = makeService("@alice:example.com")
notificationManager.add(alice.service)
await waitForConfirmation("registerForRemoteNotifications should be called", timeout: .seconds(10)) { confirm in
registerForRemoteNotificationsDelegateCalled = { confirm() }
alice.actions.send(.requestAuthorization)
}
#expect(notificationCenter.requestAuthorizationOptionsReceivedOptions == [.alert, .sound, .badge])
}
@Test
func askingForPermissionWithEveryAccountOffDoesNothing() async throws {
let alice = makeService("@alice:example.com", isEnabled: false)
notificationManager.add(alice.service)
alice.actions.send(.requestAuthorization)
try await Task.sleep(for: .seconds(1))
#expect(!notificationCenter.requestAuthorizationOptionsCalled)
}
// MARK: - Badge
@Test
func appBadgeSumsEveryAccount() {
notificationManager.add(makeService("@alice:example.com", badgeCount: 3).service)
notificationManager.add(makeService("@bob:example.com", badgeCount: 2).service)
#expect(appSettings.lastKnownBadgeCount == 5)
}
@Test
func appBadgeFollowsAnAccountsCount() {
let badgeCountSubject = CurrentValueSubject<Int, Never>(3)
let alice = makeService("@alice:example.com")
alice.service.badgeCountPublisher = badgeCountSubject.asCurrentValuePublisher()
notificationManager.add(alice.service)
badgeCountSubject.send(7)
#expect(appSettings.lastKnownBadgeCount == 7)
}
@Test
func appBadgeDropsARemovedAccount() {
notificationManager.add(makeService("@alice:example.com", badgeCount: 3).service)
notificationManager.add(makeService("@bob:example.com", badgeCount: 2).service)
notificationManager.remove(userID: "@bob:example.com")
#expect(appSettings.lastKnownBadgeCount == 3)
}
@Test
func appBadgeIsLeftAloneWithoutAnAccount() {
appSettings.lastKnownBadgeCount = 4
notificationManager.remove(userID: "@alice:example.com")
#expect(appSettings.lastKnownBadgeCount == 4)
#expect(!notificationCenter.setBadgeCountCalled)
}
@Test
func updatingTheAppBadge() async {
await waitForConfirmation("The app badge should be set", timeout: .seconds(10)) { confirm in
notificationCenter.setBadgeCountClosure = { _ in confirm() }
notificationManager.add(makeService("@alice:example.com", badgeCount: 7).service)
}
#expect(notificationCenter.setBadgeCountReceivedNewBadgeCount == 7)
}
@Test
func resettingStopsReceivingNotifications() async {
notificationManager.delegate = self
appSettings.lastKnownBadgeCount = 4
await waitForConfirmation("The app badge should be reset", timeout: .seconds(10)) { confirm in
notificationCenter.setBadgeCountClosure = { _ in confirm() }
notificationManager.reset()
}
#expect(notificationCenter.setBadgeCountReceivedNewBadgeCount == 0)
#expect(appSettings.lastKnownBadgeCount == 0)
#expect(unregisterForRemoteNotificationsDelegateCalled)
}
// MARK: - Delivered notifications
@Test
func removingNotificationsOnlyTouchesThatAccount() async throws {
notificationCenter.deliveredNotificationsReturnValue = try [notification("alice room", roomID: "!room:example.com", receiverID: "@alice:example.com"),
notification("bob room", roomID: "!room:example.com", receiverID: "@bob:example.com"),
notification("alice other", roomID: "!other:example.com", receiverID: "@alice:example.com"),
notification("legacy room", roomID: "!room:example.com", receiverID: nil)]
let alice = makeService("@alice:example.com")
notificationManager.add(alice.service)
await waitForConfirmation("Notifications should be removed", timeout: .seconds(10)) { confirm in
notificationCenter.removeDeliveredNotificationsWithIdentifiersClosure = { _ in confirm() }
alice.actions.send(.removeDeliveredNotifications { $0.request.content.roomID == "!room:example.com" })
}
// Notifications without a receiver weren't processed by the extension, so any account may clear them.
#expect(notificationCenter.removeDeliveredNotificationsWithIdentifiersReceivedIdentifiers == ["alice room", "legacy room"])
}
// MARK: - System
@Test
func whenShowLocalNotification_notificationRequestGetsAdded() async throws {
await notificationManager.showLocalNotification(with: "Title", subtitle: "Subtitle")
@@ -140,81 +305,6 @@ final class NotificationManagerTests {
#expect(delegate.isEqual(notificationManager))
}
@Test
func whenStart_requestAuthorizationCalledWithCorrectParams() async {
await waitForConfirmation("requestAuthorization should be called", timeout: .seconds(10)) { confirm in
notificationCenter.requestAuthorizationOptionsClosure = { _ in
confirm()
return true
}
notificationManager.requestAuthorization()
}
#expect(notificationCenter.requestAuthorizationOptionsReceivedOptions == [.alert, .sound, .badge])
}
@Test
func whenStartAndAuthorizationGranted_delegateCalled() async {
authorizationStatusWasGranted = false
notificationManager.delegate = self
await waitForConfirmation("registerForRemoteNotifications delegate function should be called", timeout: .seconds(10)) { confirm in
registerForRemoteNotificationsDelegateCalled = {
confirm()
}
notificationManager.requestAuthorization()
}
#expect(authorizationStatusWasGranted)
}
@Test
func whenStartAndAuthorizedAndNotificationDisabled_registerForRemoteNotificationsNotCalled() async throws {
appSettings.enableNotifications = false
notificationCenter.authorizationStatusReturnValue = .authorized
notificationManager.delegate = self
notificationManager.setUserSession(UserSessionMock(.init()))
try await Task.sleep(for: .seconds(1))
#expect(!authorizationStatusWasGranted)
}
@Test
func whenStartAndAuthorized_registerForRemoteNotificationsCalled() async {
appSettings.enableNotifications = true
notificationCenter.authorizationStatusReturnValue = .authorized
notificationManager.delegate = self
await waitForConfirmation("registerForRemoteNotifications delegate function should be called", timeout: .seconds(10)) { confirm in
registerForRemoteNotificationsDelegateCalled = {
confirm()
}
notificationManager.setUserSession(UserSessionMock(.init()))
}
#expect(authorizationStatusWasGranted)
}
@Test
func removeDeliveredNotificationsForFullyReadRooms() async throws {
let room = RoomSummary(room: RoomSDKMock(), id: "!room:matrix.org", settingsMode: .allMessages,
hasUnreadMessages: false, hasUnreadMentions: false, hasUnreadNotifications: false)
let lastMessageDate = try #require(room.lastMessageDate)
// Delivered after the last message was sent, which is always the case for the last message's notification.
let readNotification = try UNNotification.with(userInfo: [NotificationConstants.UserInfoKey.roomIdentifier: room.id,
NotificationConstants.UserInfoKey.eventDate: lastMessageDate.addingTimeInterval(0.5)],
identifier: "read",
date: lastMessageDate.addingTimeInterval(5))
let newerNotification = try UNNotification.with(userInfo: [NotificationConstants.UserInfoKey.roomIdentifier: room.id,
NotificationConstants.UserInfoKey.eventDate: lastMessageDate.addingTimeInterval(1)],
identifier: "newer",
date: lastMessageDate.addingTimeInterval(5))
notificationCenter.deliveredNotificationsReturnValue = [readNotification, newerNotification]
await notificationManager.removeDeliveredNotificationsForFullyReadRooms([room])
#expect(notificationCenter.removeDeliveredNotificationsWithIdentifiersReceivedIdentifiers == ["read"])
}
@Test
func whenWillPresentNotificationsDelegateNotSet_CorrectPresentationOptionsReturned() async throws {
let archiver = MockCoder(requiringSecureCoding: false)
@@ -261,21 +351,19 @@ final class NotificationManagerTests {
#expect(notificationTappedDelegateCalled)
}
@Test
func updatingAppBadgeCount() async {
await notificationManager.updateAppBadgeCount(7)
#expect(notificationCenter.setBadgeCountReceivedNewBadgeCount == 7)
#expect(appSettings.lastKnownBadgeCount == 7)
// MARK: - Helpers
private func makeService(_ userID: String, isEnabled: Bool = true, badgeCount: Int = 0) -> (service: NotificationServiceMock, actions: PassthroughSubject<NotificationServiceAction, Never>) {
let actions = PassthroughSubject<NotificationServiceAction, Never>()
let service = NotificationServiceMock(.init(userID: userID, isEnabled: isEnabled, badgeCount: badgeCount))
service.actionsPublisher = actions.eraseToAnyPublisher()
return (service, actions)
}
@Test
func updatingAppBadgeCountWithoutASessionDoesNothing() async {
notificationManager.setUserSession(nil)
await notificationManager.updateAppBadgeCount(7)
#expect(!notificationCenter.setBadgeCountCalled)
private func notification(_ identifier: String, roomID: String, receiverID: String?) throws -> UNNotification {
var userInfo: [AnyHashable: Any] = [NotificationConstants.UserInfoKey.roomIdentifier: roomID]
userInfo[NotificationConstants.UserInfoKey.receiverIdentifier] = receiverID
return try UNNotification.with(userInfo: userInfo, identifier: identifier)
}
}
@@ -286,7 +374,7 @@ extension NotificationManagerTests: @MainActor NotificationManagerDelegate {
}
func unregisterForRemoteNotifications() {
authorizationStatusWasGranted = false
unregisterForRemoteNotificationsDelegateCalled = true
}
func shouldDisplayInAppNotification(content: UNNotificationContent) -> Bool {