User verification state indicators (#3793)

* Introduce a `UserIdentityProxy` and have it combine upstream methods into an easy to digest  `UserIdentityVerificationState`. Use it in a dedicated `VerificationBadge` UI component

* Show a DMs counterpart verification state in the room header

* Show a warning on the room details `People` entry when there are identity verification state violations on any of the members.

* Show verification badges in the room member list

* Show a withdraw verification section on the room member details for users that have pinning violations.

* Remove the verification section from the profile screen as there's no reliable way to keep it up to date
- the underlying Rust SDK Olm Machine can be rebuilt without notice which would break any existing user identity change streams.

* Update preview test snapshots
This commit is contained in:
Stefan Ceriu
2025-02-18 08:37:34 +02:00
committed by GitHub
parent b71c93dfaa
commit f77faee981
101 changed files with 722 additions and 305 deletions
@@ -9,8 +9,9 @@ import Combine
import SwiftUI
struct RoomMembersListScreenCoordinatorParameters {
let mediaProvider: MediaProviderProtocol
let clientProxy: ClientProxyProtocol
let roomProxy: JoinedRoomProxyProtocol
let mediaProvider: MediaProviderProtocol
let userIndicatorController: UserIndicatorControllerProtocol
let analytics: AnalyticsService
}
@@ -31,7 +32,8 @@ final class RoomMembersListScreenCoordinator: CoordinatorProtocol {
}
init(parameters: RoomMembersListScreenCoordinatorParameters) {
viewModel = RoomMembersListScreenViewModel(roomProxy: parameters.roomProxy,
viewModel = RoomMembersListScreenViewModel(clientProxy: parameters.clientProxy,
roomProxy: parameters.roomProxy,
mediaProvider: parameters.mediaProvider,
userIndicatorController: parameters.userIndicatorController,
analytics: parameters.analytics)
@@ -29,10 +29,15 @@ enum RoomMembersListScreenMode {
case banned
}
struct RoomMemberListScreenEntry: Equatable {
let member: RoomMemberDetails
let verificationState: UserIdentityVerificationState
}
struct RoomMembersListScreenViewState: BindableState {
private var joinedMembers: [RoomMemberDetails]
private var invitedMembers: [RoomMemberDetails]
private var bannedMembers: [RoomMemberDetails]
private var joinedMembers: [RoomMemberListScreenEntry]
private var invitedMembers: [RoomMemberListScreenEntry]
private var bannedMembers: [RoomMemberListScreenEntry]
let joinedMembersCount: Int
var bannedMembersCount: Int { bannedMembers.count }
@@ -44,9 +49,9 @@ struct RoomMembersListScreenViewState: BindableState {
var bindings: RoomMembersListScreenViewStateBindings
init(joinedMembersCount: Int,
joinedMembers: [RoomMemberDetails] = [],
invitedMembers: [RoomMemberDetails] = [],
bannedMembers: [RoomMemberDetails] = [],
joinedMembers: [RoomMemberListScreenEntry] = [],
invitedMembers: [RoomMemberListScreenEntry] = [],
bannedMembers: [RoomMemberListScreenEntry] = [],
bindings: RoomMembersListScreenViewStateBindings) {
self.joinedMembersCount = joinedMembersCount
self.joinedMembers = joinedMembers
@@ -55,19 +60,19 @@ struct RoomMembersListScreenViewState: BindableState {
self.bindings = bindings
}
var visibleJoinedMembers: [RoomMemberDetails] {
var visibleJoinedMembers: [RoomMemberListScreenEntry] {
joinedMembers
.filter { $0.matches(searchQuery: bindings.searchQuery) }
.filter { $0.member.matches(searchQuery: bindings.searchQuery) }
}
var visibleInvitedMembers: [RoomMemberDetails] {
var visibleInvitedMembers: [RoomMemberListScreenEntry] {
invitedMembers
.filter { $0.matches(searchQuery: bindings.searchQuery) }
.filter { $0.member.matches(searchQuery: bindings.searchQuery) }
}
var visibleBannedMembers: [RoomMemberDetails] {
var visibleBannedMembers: [RoomMemberListScreenEntry] {
bannedMembers
.filter { $0.matches(searchQuery: bindings.searchQuery) }
.filter { $0.member.matches(searchQuery: bindings.searchQuery) }
}
}
@@ -11,6 +11,7 @@ import SwiftUI
typealias RoomMembersListScreenViewModelType = StateStoreViewModel<RoomMembersListScreenViewState, RoomMembersListScreenViewAction>
class RoomMembersListScreenViewModel: RoomMembersListScreenViewModelType, RoomMembersListScreenViewModelProtocol {
private let clientProxy: ClientProxyProtocol
private let roomProxy: JoinedRoomProxyProtocol
private let userIndicatorController: UserIndicatorControllerProtocol
private let analytics: AnalyticsService
@@ -24,10 +25,12 @@ class RoomMembersListScreenViewModel: RoomMembersListScreenViewModelType, RoomMe
}
init(initialMode: RoomMembersListScreenMode = .members,
clientProxy: ClientProxyProtocol,
roomProxy: JoinedRoomProxyProtocol,
mediaProvider: MediaProviderProtocol,
userIndicatorController: UserIndicatorControllerProtocol,
analytics: AnalyticsService) {
self.clientProxy = clientProxy
self.roomProxy = roomProxy
self.userIndicatorController = userIndicatorController
self.analytics = analytics
@@ -59,22 +62,23 @@ class RoomMembersListScreenViewModel: RoomMembersListScreenViewModelType, RoomMe
}
func stop() {
hideLoader()
hideLoadingIndicator(Self.setupMembersLoadingIndicatorIdentifier)
hideLoadingIndicator(Self.updateStateLoadingIndicatorIdentifier)
}
// MARK: - Members
private func setupMembers() {
Task {
showLoader()
showLoadingIndicator(Self.setupMembersLoadingIndicatorIdentifier)
await roomProxy.updateMembers()
hideLoader()
hideLoadingIndicator(Self.setupMembersLoadingIndicatorIdentifier)
}
roomProxy.membersPublisher
.filter { !$0.isEmpty }
roomProxy.membersPublisher.combineLatest(roomProxy.identityStatusChangesPublisher)
.filter { !$0.0.isEmpty }
.receive(on: DispatchQueue.main)
.sink { [weak self] members in
.sink { [weak self] members, _ in
self?.updateState(members: members)
}
.store(in: &cancellables)
@@ -87,11 +91,12 @@ class RoomMembersListScreenViewModel: RoomMembersListScreenViewModelType, RoomMe
private func updateState(members: [RoomMemberProxyProtocol]) {
Task {
showLoader()
showLoadingIndicator(Self.updateStateLoadingIndicatorIdentifier)
let members = members.sorted()
let roomMembersDetails = await buildMembersDetails(members: members)
self.members = members
self.state = .init(joinedMembersCount: roomProxy.infoPublisher.value.joinedMembersCount,
joinedMembers: roomMembersDetails.joinedMembers,
invitedMembers: roomMembersDetails.invitedMembers,
@@ -102,25 +107,32 @@ class RoomMembersListScreenViewModel: RoomMembersListScreenViewModelType, RoomMe
self.state.canKickUsers = await (try? roomProxy.canUserKick(userID: roomProxy.ownUserID).get()) == true
self.state.canBanUsers = await (try? roomProxy.canUserBan(userID: roomProxy.ownUserID).get()) == true
hideLoader()
hideLoadingIndicator(Self.updateStateLoadingIndicatorIdentifier)
}
}
private func buildMembersDetails(members: [RoomMemberProxyProtocol]) async -> RoomMembersDetails {
await Task.detached {
await Task.detached { [clientProxy, roomProxy] in
// accessing RoomMember's properties is very slow. We need to do it in a background thread.
var invitedMembers: [RoomMemberDetails] = .init()
var joinedMembers: [RoomMemberDetails] = .init()
var bannedMembers: [RoomMemberDetails] = .init()
var invitedMembers: [RoomMemberListScreenEntry] = .init()
var joinedMembers: [RoomMemberListScreenEntry] = .init()
var bannedMembers: [RoomMemberListScreenEntry] = .init()
for member in members {
var verificationState: UserIdentityVerificationState = .notVerified
if roomProxy.isEncrypted, // We don't care about identity statuses on non-encrypted rooms
case let .success(userIdentity) = await clientProxy.userIdentity(for: member.userID),
let userIdentity {
verificationState = userIdentity.verificationState
}
switch member.membership {
case .invite:
invitedMembers.append(.init(withProxy: member))
invitedMembers.append(.init(member: .init(withProxy: member), verificationState: verificationState))
case .join:
joinedMembers.append(.init(withProxy: member))
joinedMembers.append(.init(member: .init(withProxy: member), verificationState: verificationState))
case .ban:
bannedMembers.append(.init(withProxy: member))
bannedMembers.append(.init(member: .init(withProxy: member), verificationState: verificationState))
default:
continue
}
@@ -128,7 +140,7 @@ class RoomMembersListScreenViewModel: RoomMembersListScreenViewModelType, RoomMe
return .init(invitedMembers: invitedMembers,
joinedMembers: joinedMembers,
bannedMembers: bannedMembers.sorted { $0.id.localizedStandardCompare($1.id) == .orderedAscending }) // Re-sort ignoring display name.
bannedMembers: bannedMembers.sorted { $0.member.id.localizedStandardCompare($1.member.id) == .orderedAscending }) // Re-sort ignoring display name.
}
.value
}
@@ -215,18 +227,19 @@ class RoomMembersListScreenViewModel: RoomMembersListScreenViewModelType, RoomMe
// MARK: - Indicators
private let userIndicatorID = UUID().uuidString
private static let setupMembersLoadingIndicatorIdentifier = "\(RoomMembersListScreenViewModel.self)-SetupMembers"
private static let updateStateLoadingIndicatorIdentifier = "\(RoomMembersListScreenViewModel.self)-UpdateState"
private func showLoader() {
userIndicatorController.submitIndicator(UserIndicator(id: userIndicatorID,
private func showLoadingIndicator(_ identifier: String) {
userIndicatorController.submitIndicator(UserIndicator(id: identifier,
type: .modal(progress: .indeterminate, interactiveDismissDisabled: false, allowsInteraction: true),
title: L10n.commonLoading,
persistent: true),
delay: .milliseconds(200))
}
private func hideLoader() {
userIndicatorController.retractIndicatorWithId(userIndicatorID)
private func hideLoadingIndicator(_ identifier: String) {
userIndicatorController.retractIndicatorWithId(identifier)
}
private func showManageMemberIndicator(title: String) {
@@ -247,7 +260,7 @@ class RoomMembersListScreenViewModel: RoomMembersListScreenViewModelType, RoomMe
}
private struct RoomMembersDetails {
var invitedMembers: [RoomMemberDetails]
var joinedMembers: [RoomMemberDetails]
var bannedMembers: [RoomMemberDetails]
var invitedMembers: [RoomMemberListScreenEntry]
var joinedMembers: [RoomMemberListScreenEntry]
var bannedMembers: [RoomMemberListScreenEntry]
}
@@ -97,6 +97,7 @@ struct RoomMembersListManageMemberSheetLive_Previews: PreviewProvider {
private extension RoomMembersListScreenViewModel {
static var mock: RoomMembersListScreenViewModel {
RoomMembersListScreenViewModel(initialMode: .members,
clientProxy: ClientProxyMock(.init()),
roomProxy: JoinedRoomProxyMock(.init(members: .allMembersAsAdmin)),
mediaProvider: MediaProviderMock(configuration: .init()),
userIndicatorController: ServiceLocator.shared.userIndicatorController,
@@ -59,23 +59,23 @@ struct RoomMembersListScreen: View {
var roomMembers: some View {
LazyVStack(alignment: .leading, spacing: 12) {
membersSection(data: context.viewState.visibleInvitedMembers, sectionTitle: L10n.screenRoomMemberListPendingHeaderTitle)
membersSection(data: context.viewState.visibleJoinedMembers, sectionTitle: L10n.screenRoomMemberListHeaderTitle(Int(context.viewState.joinedMembersCount)))
membersSection(entries: context.viewState.visibleInvitedMembers, sectionTitle: L10n.screenRoomMemberListPendingHeaderTitle)
membersSection(entries: context.viewState.visibleJoinedMembers, sectionTitle: L10n.screenRoomMemberListHeaderTitle(Int(context.viewState.joinedMembersCount)))
}
}
var bannedUsers: some View {
LazyVStack(alignment: .leading, spacing: 12) {
membersSection(data: context.viewState.visibleBannedMembers)
membersSection(entries: context.viewState.visibleBannedMembers)
}
}
@ViewBuilder
private func membersSection(data: [RoomMemberDetails], sectionTitle: String? = nil) -> some View {
if !data.isEmpty {
private func membersSection(entries: [RoomMemberListScreenEntry], sectionTitle: String? = nil) -> some View {
if !entries.isEmpty {
Section {
ForEach(data, id: \.id) { member in
RoomMembersListScreenMemberCell(member: member, context: context)
ForEach(entries, id: \.member.id) { entry in
RoomMembersListScreenMemberCell(listEntry: entry, context: context)
}
} header: {
if let sectionTitle {
@@ -179,7 +179,22 @@ struct RoomMembersListScreen_Previews: PreviewProvider, TestablePreview {
members.append(.mockInvited)
}
let clientProxyMock = ClientProxyMock(.init())
clientProxyMock.userIdentityForClosure = { userID in
let identity = switch userID {
case RoomMemberProxyMock.mockAlice.userID:
UserIdentityProxyMock(configuration: .init(verificationState: .verified))
case RoomMemberProxyMock.mockBob.userID:
UserIdentityProxyMock(configuration: .init(verificationState: .verificationViolation))
default:
UserIdentityProxyMock(configuration: .init())
}
return .success(identity)
}
return RoomMembersListScreenViewModel(initialMode: initialMode,
clientProxy: clientProxyMock,
roomProxy: JoinedRoomProxyMock(.init(name: "Some room",
members: members,
ownUserID: ownUserID,
@@ -8,22 +8,22 @@
import SwiftUI
struct RoomMembersListScreenMemberCell: View {
let member: RoomMemberDetails
let listEntry: RoomMemberListScreenEntry
let context: RoomMembersListScreenViewModel.Context
var body: some View {
Button {
context.send(viewAction: .selectMember(member))
context.send(viewAction: .selectMember(listEntry.member))
} label: {
HStack(spacing: 8) {
LoadableAvatarImage(url: avatarURL,
name: avatarName,
contentID: member.id,
contentID: listEntry.member.id,
avatarSize: .user(on: .roomDetails),
mediaProvider: context.mediaProvider)
.accessibilityHidden(true)
HStack(alignment: .firstTextBaseline, spacing: 4) {
HStack(alignment: .center, spacing: 4) {
VStack(alignment: .leading, spacing: 0) {
Text(title)
.font(.compound.bodyMDSemibold)
@@ -39,6 +39,8 @@ struct RoomMembersListScreenMemberCell: View {
}
.frame(maxWidth: .infinity, alignment: .leading)
VerificationBadge(verificationState: listEntry.verificationState)
if let role {
Text(role)
.font(.compound.bodyXS)
@@ -52,7 +54,7 @@ struct RoomMembersListScreenMemberCell: View {
}
var role: String? {
switch member.role {
switch listEntry.member.role {
case .administrator:
L10n.screenRoomMemberListRoleAdministrator
case .moderator:
@@ -65,55 +67,72 @@ struct RoomMembersListScreenMemberCell: View {
// Computed properties to hide the user's profile when banned.
var title: String {
guard !member.isBanned else { return member.id }
return member.name ?? member.id
guard !listEntry.member.isBanned else { return listEntry.member.id }
return listEntry.member.name ?? listEntry.member.id
}
var subtitle: String? {
member.isBanned ? nil : member.id
listEntry.member.isBanned ? nil : listEntry.member.id
}
var avatarName: String? {
member.isBanned ? nil : member.name
listEntry.member.isBanned ? nil : listEntry.member.name
}
var avatarURL: URL? {
member.isBanned ? nil : member.avatarURL
listEntry.member.isBanned ? nil : listEntry.member.avatarURL
}
}
struct RoomMembersListMemberCell_Previews: PreviewProvider, TestablePreview {
static let members: [RoomMemberProxyMock] = [
.mockAlice,
.mockAdmin,
.mockModerator,
.init(with: .init(userID: "@nodisplayname:matrix.org", membership: .join)),
.init(with: .init(userID: "@avatar:matrix.org", displayName: "Avatar", avatarURL: .mockMXCUserAvatar, membership: .join))
static let members: [RoomMemberListScreenEntry] = [
.init(member: .init(withProxy: RoomMemberProxyMock.mockAlice),
verificationState: .notVerified),
.init(member: .init(withProxy: RoomMemberProxyMock.mockAdmin),
verificationState: .verified),
.init(member: .init(withProxy: RoomMemberProxyMock.mockModerator),
verificationState: .verificationViolation),
.init(member: .init(withProxy: RoomMemberProxyMock(with: .init(userID: "@nodisplayname:matrix.org",
membership: .join))),
verificationState: .notVerified),
.init(member: .init(withProxy: RoomMemberProxyMock(with: .init(userID: "@avatar:matrix.org",
displayName: "Avatar",
avatarURL: .mockMXCUserAvatar,
membership: .join))),
verificationState: .notVerified)
]
static let bannedMembers: [RoomMemberProxyMock] = [
.init(with: .init(userID: "@nodisplayname:matrix.org", membership: .ban)),
.init(with: .init(userID: "@fake:matrix.org", displayName: "President", membership: .ban)),
.init(with: .init(userID: "@badavatar:matrix.org", avatarURL: .mockMXCUserAvatar, membership: .ban))
static let bannedMembers: [RoomMemberListScreenEntry] = [
.init(member: .init(withProxy: RoomMemberProxyMock(with: .init(userID: "@nodisplayname:matrix.org",
membership: .ban))),
verificationState: .notVerified),
.init(member: .init(withProxy: RoomMemberProxyMock(with: .init(userID: "@fake:matrix.org",
displayName: "President",
membership: .ban))),
verificationState: .verified),
.init(member: .init(withProxy: RoomMemberProxyMock(with: .init(userID: "@badavatar:matrix.org",
avatarURL: .mockMXCUserAvatar,
membership: .ban))),
verificationState: .verificationViolation)
]
static let viewModel = RoomMembersListScreenViewModel(roomProxy: JoinedRoomProxyMock(.init(name: "Some room",
members: members)),
static let viewModel = RoomMembersListScreenViewModel(clientProxy: ClientProxyMock(.init()),
roomProxy: JoinedRoomProxyMock(.init(name: "Some room", members: [])),
mediaProvider: MediaProviderMock(configuration: .init()),
userIndicatorController: ServiceLocator.shared.userIndicatorController,
analytics: ServiceLocator.shared.analytics)
static var previews: some View {
VStack(spacing: 12) {
Section("Invited/Joined") {
ForEach(members, id: \.userID) { member in
RoomMembersListScreenMemberCell(member: .init(withProxy: member), context: viewModel.context)
ForEach(members, id: \.member.id) { entry in
RoomMembersListScreenMemberCell(listEntry: entry, context: viewModel.context)
}
}
// Banned members should have their profiles hidden and the avatar should use the first letter from their user ID.
Section("Banned") {
ForEach(bannedMembers, id: \.userID) { member in
RoomMembersListScreenMemberCell(member: .init(withProxy: member), context: viewModel.context)
ForEach(bannedMembers, id: \.member.id) { entry in
RoomMembersListScreenMemberCell(listEntry: entry, context: viewModel.context)
}
}
}