ehealthsolutions/element-x-ios
3
0
Fork 0
mirror of https://github.com/Novaloop-AG/element-x-ios.git synced 2026-11-04 10:33:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Space flow improvements. (#4430)

Browse Source 
* Space flow improvements

- Use a state machine to select a space.
- Add a SpaceFlowCoordinator for recursively presenting subspaces.
- Get the spaceRoomListProxy when tapping on the space so we can indicate failures.
- Fix the total room count in SpaceListScreen.

* Refactor spaceRoom → spaceRoomProxy.

* Add a UI test for the Spaces flow.
This commit is contained in:
Doug
2025-08-22 15:49:47 +01:00
committed by GitHub
parent bb5deb9c50
commit d119964d50
34 changed files with 503 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ElementX/Sources/Screens/Spaces/Common/SpaceRoomCell.swift
+16 -16
View File
@@ -12,7 +12,7 @@ import SwiftUI
struct SpaceRoomCell: View {
@Environment(\.dynamicTypeSize) var dynamicTypeSize
let spaceRoom: SpaceRoomProxyProtocol
let spaceRoomProxy: SpaceRoomProxyProtocol
let isSelected: Bool
let mediaProvider: MediaProviderProtocol!
@@ -23,25 +23,25 @@ struct SpaceRoomCell: View {
private let horizontalInsets = 16.0
private var subtitle: String {
if spaceRoom.isSpace {
spaceRoom.joinRule == .public ? L10n.commonPublicSpace : L10n.commonPrivateSpace
if spaceRoomProxy.isSpace {
spaceRoomProxy.joinRule == .public ? L10n.commonPublicSpace : L10n.commonPrivateSpace
} else {
L10n.commonMemberCount(spaceRoom.joinedMembersCount)
L10n.commonMemberCount(spaceRoomProxy.joinedMembersCount)
}
}
private var details: String {
if spaceRoom.isSpace {
L10n.screenSpaceListDetails(L10n.commonRooms(spaceRoom.childrenCount),
L10n.commonMemberCount(spaceRoom.joinedMembersCount))
if spaceRoomProxy.isSpace {
L10n.screenSpaceListDetails(L10n.commonRooms(spaceRoomProxy.childrenCount),
L10n.commonMemberCount(spaceRoomProxy.joinedMembersCount))
} else {
spaceRoom.topic ?? " " // Use a single space to reserve a consistent amount of space.
spaceRoomProxy.topic ?? " " // Use a single space to reserve a consistent amount of space.
}
}
var body: some View {
Button {
action(.select(spaceRoom))
action(.select(spaceRoomProxy))
} label: {
HStack(spacing: 16.0) {
avatar
@@ -59,13 +59,13 @@ struct SpaceRoomCell: View {
.accessibilityElement(children: .combine)
}
.buttonStyle(SpaceRoomCellButtonStyle(isSelected: isSelected))
.accessibilityIdentifier(A11yIdentifiers.spaceListScreen.spaceRoomName(spaceRoom.name ?? spaceRoom.id))
.accessibilityIdentifier(A11yIdentifiers.spaceListScreen.spaceRoomName(spaceRoomProxy.name ?? spaceRoomProxy.id))
}
@ViewBuilder @MainActor
private var avatar: some View {
if dynamicTypeSize < .accessibility3 {
RoomAvatarImage(avatar: spaceRoom.avatar,
RoomAvatarImage(avatar: spaceRoomProxy.avatar,
avatarSize: .room(on: .spaces),
mediaProvider: mediaProvider)
.dynamicTypeSize(dynamicTypeSize < .accessibility1 ? dynamicTypeSize : .accessibility1)
@@ -76,7 +76,7 @@ struct SpaceRoomCell: View {
private var content: some View {
HStack(spacing: 16) {
VStack(alignment: .leading, spacing: 2) {
Text(spaceRoom.name ?? spaceRoom.id)
Text(spaceRoomProxy.name ?? spaceRoomProxy.id)
.font(.compound.bodyLGSemibold)
.foregroundColor(.compound.textPrimary)
.lineLimit(1)
@@ -101,7 +101,7 @@ struct SpaceRoomCell: View {
.foregroundStyle(.compound.textSecondary)
.lineLimit(1)
} icon: {
CompoundIcon(spaceRoom.joinRule == .public ? \.public : \.lockSolid,
CompoundIcon(spaceRoomProxy.joinRule == .public ? \.public : \.lockSolid,
size: .xSmall,
relativeTo: .compound.bodyMD)
.foregroundStyle(.compound.iconTertiary)
@@ -111,9 +111,9 @@ struct SpaceRoomCell: View {
@ViewBuilder
private var accessory: some View {
switch spaceRoom.state {
switch spaceRoomProxy.state {
case .none, .left, .invited:
Button(L10n.actionJoin) { action(.join(spaceRoom)) }
Button(L10n.actionJoin) { action(.join(spaceRoomProxy)) }
.font(.compound.bodyLG)
.foregroundStyle(.compound.textActionAccent)
case .joined, .knocked, .banned:
@@ -141,7 +141,7 @@ struct SpaceRoomCell_Previews: PreviewProvider, TestablePreview {
static var previews: some View {
VStack(spacing: 0) {
ForEach(spaces, id: \.id) { space in
SpaceRoomCell(spaceRoom: space,
SpaceRoomCell(spaceRoomProxy: space,
isSelected: false,
mediaProvider: mediaProvider) { _ in }
}
ElementX/Sources/Screens/Spaces/SpaceListScreen/SpaceListScreenCoordinator.swift
+7 -5
View File
@@ -12,11 +12,12 @@ import SwiftUI
struct SpaceListScreenCoordinatorParameters {
let userSession: UserSessionProtocol
let spaceServiceProxy: SpaceServiceProxyProtocol
let selectedSpaceSubject: CurrentValuePublisher<String?, Never>
let userIndicatorController: UserIndicatorControllerProtocol
}
enum SpaceListScreenCoordinatorAction {
case selectSpace(SpaceRoomProxyProtocol)
case selectSpace(SpaceRoomListProxyProtocol)
case showSettings
}
@@ -35,7 +36,8 @@ final class SpaceListScreenCoordinator: CoordinatorProtocol {
self.parameters = parameters
viewModel = SpaceListScreenViewModel(userSession: parameters.userSession,
spaceServiceProxy: parameters.spaceServiceProxy)
selectedSpaceSubject: parameters.selectedSpaceSubject,
userIndicatorController: parameters.userIndicatorController)
}
func start() {
@@ -44,8 +46,8 @@ final class SpaceListScreenCoordinator: CoordinatorProtocol {
guard let self else { return }
switch action {
case .selectSpace(let spaceRoom):
actionsSubject.send(.selectSpace(spaceRoom))
case .selectSpace(let spaceRoomListProxy):
actionsSubject.send(.selectSpace(spaceRoomListProxy))
case .showSettings:
actionsSubject.send(.showSettings)
}
ElementX/Sources/Screens/Spaces/SpaceListScreen/SpaceListScreenModels.swift
+6 -2
View File
@@ -8,7 +8,7 @@
import Foundation
enum SpaceListScreenViewModelAction {
case selectSpace(SpaceRoomProxyProtocol)
case selectSpace(SpaceRoomListProxyProtocol)
case showSettings
}
@@ -18,13 +18,17 @@ struct SpaceListScreenViewState: BindableState {
var userAvatarURL: URL?
var joinedSpaces: [SpaceRoomProxyProtocol]
var joinedRoomsCount: Int
var selectedSpaceID: String?
var bindings: SpaceListScreenViewStateBindings
var subtitle: String {
L10n.screenSpaceListDetails(L10n.commonSpaces(joinedSpaces.count), L10n.commonRooms(joinedRoomsCount))
}
var joinedRoomsCount: Int {
joinedSpaces.map(\.childrenCount).reduce(0, +)
}
}
struct SpaceListScreenViewStateBindings { }
ElementX/Sources/Screens/Spaces/SpaceListScreen/SpaceListScreenViewModel.swift
+35 -5
View File
@@ -12,18 +12,21 @@ typealias SpaceListScreenViewModelType = StateStoreViewModelV2<SpaceListScreenVi
class SpaceListScreenViewModel: SpaceListScreenViewModelType, SpaceListScreenViewModelProtocol {
private let spaceServiceProxy: SpaceServiceProxyProtocol
private let userIndicatorController: UserIndicatorControllerProtocol
private let actionsSubject: PassthroughSubject<SpaceListScreenViewModelAction, Never> = .init()
var actionsPublisher: AnyPublisher<SpaceListScreenViewModelAction, Never> {
actionsSubject.eraseToAnyPublisher()
}
init(userSession: UserSessionProtocol, spaceServiceProxy: SpaceServiceProxyProtocol) {
self.spaceServiceProxy = spaceServiceProxy
init(userSession: UserSessionProtocol,
selectedSpaceSubject: CurrentValuePublisher<String?, Never>,
userIndicatorController: UserIndicatorControllerProtocol) {
spaceServiceProxy = userSession.clientProxy.spaceService
self.userIndicatorController = userIndicatorController
super.init(initialViewState: SpaceListScreenViewState(userID: userSession.clientProxy.userID,
joinedSpaces: spaceServiceProxy.joinedSpacesPublisher.value,
joinedRoomsCount: 0,
bindings: .init()),
mediaProvider: userSession.mediaProvider)
@@ -32,6 +35,10 @@ class SpaceListScreenViewModel: SpaceListScreenViewModelType, SpaceListScreenVie
.weakAssign(to: \.state.joinedSpaces, on: self)
.store(in: &cancellables)
selectedSpaceSubject
.weakAssign(to: \.state.selectedSpaceID, on: self)
.store(in: &cancellables)
userSession.clientProxy.userAvatarURLPublisher
.receive(on: DispatchQueue.main)
.weakAssign(to: \.state.userAvatarURL, on: self)
@@ -49,12 +56,35 @@ class SpaceListScreenViewModel: SpaceListScreenViewModelType, SpaceListScreenVie
MXLog.info("View model: received view action: \(viewAction)")
switch viewAction {
case .spaceAction(.select(let spaceRoom)):
actionsSubject.send(.selectSpace(spaceRoom))
case .spaceAction(.select(let spaceRoomProxy)):
Task { await selectSpace(spaceRoomProxy) }
case .spaceAction(.join(let spaceRoom)):
#warning("Implement joining.")
case .showSettings:
actionsSubject.send(.showSettings)
}
}
// MARK: - Private
private func selectSpace(_ spaceRoomProxy: SpaceRoomProxyProtocol) async {
switch await spaceServiceProxy.spaceRoomList(for: spaceRoomProxy) {
case .success(let spaceRoomListProxy):
actionsSubject.send(.selectSpace(spaceRoomListProxy))
case .failure(let error):
MXLog.error("Unable to select space: \(error)")
showFailureIndicator()
}
}
// MARK: - Indicators
private static var failureIndicatorID: String { "\(Self.self)-Failure" }
private func showFailureIndicator() {
userIndicatorController.submitIndicator(UserIndicator(id: Self.failureIndicatorID,
type: .toast,
title: L10n.errorUnknown,
iconName: "xmark"))
}
}
ElementX/Sources/Screens/Spaces/SpaceListScreen/View/SpaceListScreen.swift
+7 -6
View File
@@ -59,8 +59,8 @@ struct SpaceListScreen: View {
var spaces: some View {
ForEach(context.viewState.joinedSpaces, id: \.id) { spaceRoom in
SpaceRoomCell(spaceRoom: spaceRoom,
isSelected: false,
SpaceRoomCell(spaceRoomProxy: spaceRoom,
isSelected: spaceRoom.id == context.viewState.selectedSpaceID,
mediaProvider: context.mediaProvider) { action in
context.send(viewAction: .spaceAction(action))
}
@@ -102,12 +102,13 @@ struct SpaceListScreen_Previews: PreviewProvider, TestablePreview {
}
}
static func makeViewModel(counterValue: Int = 0) -> SpaceListScreenViewModel {
static func makeViewModel() -> SpaceListScreenViewModel {
let clientProxy = ClientProxyMock(.init())
let userSession = UserSessionMock(.init(clientProxy: clientProxy))
let spaceService = SpaceServiceProxyMock(.init(joinedSpaces: .mockJoinedSpaces))
clientProxy.spaceService = SpaceServiceProxyMock(.init(joinedSpaces: .mockJoinedSpaces))
let viewModel = SpaceListScreenViewModel(userSession: userSession, spaceServiceProxy: spaceService)
let viewModel = SpaceListScreenViewModel(userSession: UserSessionMock(.init(clientProxy: clientProxy)),
selectedSpaceSubject: .init(nil),
userIndicatorController: UserIndicatorControllerMock())
return viewModel
}
ElementX/Sources/Screens/Spaces/SpaceScreen/SpaceScreenCoordinator.swift
+9 -4
View File
@@ -12,11 +12,13 @@ import SwiftUI
struct SpaceScreenCoordinatorParameters {
let spaceRoomListProxy: SpaceRoomListProxyProtocol
let spaceServiceProxy: SpaceServiceProxyProtocol
let mediaProvider: MediaProviderProtocol
let userIndicatorController: UserIndicatorControllerProtocol
}
enum SpaceScreenCoordinatorAction {
case selectSpace(SpaceRoomProxyProtocol)
case selectSpace(SpaceRoomListProxyProtocol)
}
final class SpaceScreenCoordinator: CoordinatorProtocol {
@@ -33,7 +35,10 @@ final class SpaceScreenCoordinator: CoordinatorProtocol {
init(parameters: SpaceScreenCoordinatorParameters) {
self.parameters = parameters
viewModel = SpaceScreenViewModel(spaceRoomList: parameters.spaceRoomListProxy, mediaProvider: parameters.mediaProvider)
viewModel = SpaceScreenViewModel(spaceRoomList: parameters.spaceRoomListProxy,
spaceServiceProxy: parameters.spaceServiceProxy,
mediaProvider: parameters.mediaProvider,
userIndicatorController: parameters.userIndicatorController)
}
func start() {
@@ -42,8 +47,8 @@ final class SpaceScreenCoordinator: CoordinatorProtocol {
guard let self else { return }
switch action {
case .selectSpace(let spaceRoom):
actionsSubject.send(.selectSpace(spaceRoom))
case .selectSpace(let spaceRoomListProxy):
actionsSubject.send(.selectSpace(spaceRoomListProxy))
}
}
.store(in: &cancellables)
ElementX/Sources/Screens/Spaces/SpaceScreen/SpaceScreenModels.swift
+1 -1
View File
@@ -8,7 +8,7 @@
import Foundation
enum SpaceScreenViewModelAction {
case selectSpace(SpaceRoomProxyProtocol)
case selectSpace(SpaceRoomListProxyProtocol)
}
struct SpaceScreenViewState: BindableState {
ElementX/Sources/Screens/Spaces/SpaceScreen/SpaceScreenViewModel.swift
+37 -5
View File
@@ -11,12 +11,21 @@ import SwiftUI
typealias SpaceScreenViewModelType = StateStoreViewModelV2<SpaceScreenViewState, SpaceScreenViewAction>
class SpaceScreenViewModel: SpaceScreenViewModelType, SpaceScreenViewModelProtocol {
private let spaceServiceProxy: SpaceServiceProxyProtocol
private let userIndicatorController: UserIndicatorControllerProtocol
private let actionsSubject: PassthroughSubject<SpaceScreenViewModelAction, Never> = .init()
var actionsPublisher: AnyPublisher<SpaceScreenViewModelAction, Never> {
actionsSubject.eraseToAnyPublisher()
}
init(spaceRoomList: SpaceRoomListProxyProtocol, mediaProvider: MediaProviderProtocol) {
init(spaceRoomList: SpaceRoomListProxyProtocol,
spaceServiceProxy: SpaceServiceProxyProtocol,
mediaProvider: MediaProviderProtocol,
userIndicatorController: UserIndicatorControllerProtocol) {
self.spaceServiceProxy = spaceServiceProxy
self.userIndicatorController = userIndicatorController
super.init(initialViewState: SpaceScreenViewState(space: spaceRoomList.spaceRoom,
rooms: spaceRoomList.spaceRoomsPublisher.value),
mediaProvider: mediaProvider)
@@ -47,14 +56,37 @@ class SpaceScreenViewModel: SpaceScreenViewModelType, SpaceScreenViewModelProtoc
MXLog.info("View model: received view action: \(viewAction)")
switch viewAction {
case .spaceAction(.select(let spaceRoom)):
if spaceRoom.isSpace {
actionsSubject.send(.selectSpace(spaceRoom))
case .spaceAction(.select(let spaceRoomProxy)):
if spaceRoomProxy.isSpace {
Task { await selectSpace(spaceRoomProxy) }
} else {
#warning("Implement joining")
#warning("Implement room flow")
}
case .spaceAction(.join(let spaceID)):
#warning("Implement joining.")
}
}
// MARK: - Private
private func selectSpace(_ spaceRoomProxy: SpaceRoomProxyProtocol) async {
switch await spaceServiceProxy.spaceRoomList(for: spaceRoomProxy) {
case .success(let spaceRoomListProxy):
actionsSubject.send(.selectSpace(spaceRoomListProxy))
case .failure(let error):
MXLog.error("Unable to select space: \(error)")
showFailureIndicator()
}
}
// MARK: - Indicators
private static var failureIndicatorID: String { "\(Self.self)-Failure" }
private func showFailureIndicator() {
userIndicatorController.submitIndicator(UserIndicator(id: Self.failureIndicatorID,
type: .toast,
title: L10n.errorUnknown,
iconName: "xmark"))
}
}
ElementX/Sources/Screens/Spaces/SpaceScreen/View/SpaceScreen.swift
+5 -3
View File
@@ -26,8 +26,8 @@ struct SpaceScreen: View {
@ViewBuilder
var rooms: some View {
ForEach(context.viewState.rooms, id: \.id) { spaceRoom in
SpaceRoomCell(spaceRoom: spaceRoom,
ForEach(context.viewState.rooms, id: \.id) { spaceRoomProxy in
SpaceRoomCell(spaceRoomProxy: spaceRoomProxy,
isSelected: false,
mediaProvider: context.mediaProvider) { action in
context.send(viewAction: .spaceAction(action))
@@ -65,7 +65,9 @@ struct SpaceScreen_Previews: PreviewProvider, TestablePreview {
initialSpaceRooms: .mockSpaceList))
let viewModel = SpaceScreenViewModel(spaceRoomList: spaceRoomListProxy,
mediaProvider: MediaProviderMock(configuration: .init()))
spaceServiceProxy: SpaceServiceProxyMock(.init()),
mediaProvider: MediaProviderMock(configuration: .init()),
userIndicatorController: UserIndicatorControllerMock())
return viewModel
}
}