Knocking feature polishing part 2 (#3738)

* improved implementation of the unknown state

* forget button in the banned state

* error handling for forbidden access

* added the forget function

fixed DMs, and updated preview tests

* removed banned room proxy

* code polishing and test improvement
This commit is contained in:
Mauro
2025-02-05 14:48:24 +01:00
committed by GitHub
parent cfaa1b455a
commit 3839025caa
28 changed files with 466 additions and 101 deletions
@@ -50,10 +50,18 @@ struct JoinRoomScreen: View {
@ViewBuilder
private var defaultView: some View {
VStack(spacing: 16) {
RoomAvatarImage(avatar: context.viewState.avatar,
avatarSize: .room(on: .joinRoom),
mediaProvider: context.mediaProvider)
.dynamicTypeSize(dynamicTypeSize < .accessibility1 ? dynamicTypeSize : .accessibility1)
if let avatar = context.viewState.avatar {
RoomAvatarImage(avatar: avatar,
avatarSize: .room(on: .joinRoom),
mediaProvider: context.mediaProvider)
.dynamicTypeSize(dynamicTypeSize < .accessibility1 ? dynamicTypeSize : .accessibility1)
} else {
RoomAvatarImage(avatar: .room(id: "", name: nil, avatarURL: nil),
avatarSize: .room(on: .joinRoom),
mediaProvider: context.mediaProvider)
.dynamicTypeSize(dynamicTypeSize < .accessibility1 ? dynamicTypeSize : .accessibility1)
.hidden()
}
VStack(spacing: 8) {
Text(context.viewState.title)
@@ -68,7 +76,7 @@ struct JoinRoomScreen: View {
.multilineTextAlignment(.center)
}
if let memberCount = context.viewState.roomDetails?.memberCount {
if !context.viewState.isDMInvite, let memberCount = context.viewState.roomDetails?.memberCount {
BadgeLabel(title: "\(memberCount)", icon: \.userProfile, isHighlighted: false)
}
@@ -174,12 +182,31 @@ struct JoinRoomScreen: View {
VStack(spacing: 16) { inviteButtons }
}
case .banned(let sender, let reason):
if let sender, let reason {
bottomErrorMessage(title: L10n.screenJoinRoomBanByMessage(sender),
subtitle: L10n.screenJoinRoomBanReason(reason))
} else {
bottomErrorMessage(title: L10n.screenJoinRoomBanMessage, subtitle: nil)
VStack(spacing: 24) {
if let sender, let reason {
bottomErrorMessage(title: L10n.screenJoinRoomBanByMessage(sender),
subtitle: L10n.screenJoinRoomBanReason(reason))
} else {
bottomErrorMessage(title: L10n.screenJoinRoomBanMessage, subtitle: nil)
}
Button(L10n.screenJoinRoomForgetAction) {
context.send(viewAction: .forget)
}
.buttonStyle(.compound(.primary))
}
case .forbidden:
forbiddenView
}
}
private var forbiddenView: some View {
VStack(spacing: 24) {
bottomErrorMessage(title: L10n.screenJoinRoomFailMessage, subtitle: L10n.screenJoinRoomFailReason)
Button(L10n.actionOk) {
context.send(viewAction: .dismiss)
}
.buttonStyle(.compound(.primary))
}
}
@@ -235,9 +262,11 @@ struct JoinRoomScreen: View {
private var toolbar: some ToolbarContent {
if context.viewState.mode == .knocked {
ToolbarItem(placement: .principal) {
RoomHeaderView(roomName: context.viewState.title,
roomAvatar: context.viewState.avatar,
mediaProvider: context.mediaProvider)
if let avatar = context.viewState.avatar {
RoomHeaderView(roomName: context.viewState.title,
roomAvatar: avatar,
mediaProvider: context.mediaProvider)
}
}
}
}
@@ -250,30 +279,48 @@ struct JoinRoomScreen_Previews: PreviewProvider, TestablePreview {
static let joinableViewModel = makeViewModel(mode: .joinable)
static let restrictedViewModel = makeViewModel(mode: .restricted)
static let inviteRequiredViewModel = makeViewModel(mode: .inviteRequired)
static let invitedViewModel = makeViewModel(mode: .invited)
static let invitedViewModel = makeViewModel(mode: .invited(isDM: false))
static let invitedDMViewModel = makeViewModel(mode: .invited(isDM: true))
static let knockableViewModel = makeViewModel(mode: .knockable)
static let knockedViewModel = makeViewModel(mode: .knocked)
static let bannedViewModel = makeViewModel(mode: .banned(sender: "Bob", reason: "Spamming"))
static let forbiddenViewModel = makeViewModel(mode: .forbidden)
static var previews: some View {
makePreview(viewModel: unknownViewModel, previewDisplayName: "Unknown")
makePreview(viewModel: joinableViewModel, previewDisplayName: "Joinable")
makePreview(viewModel: restrictedViewModel, previewDisplayName: "Restricted")
makePreview(viewModel: inviteRequiredViewModel, previewDisplayName: "InviteRequired")
makePreview(viewModel: invitedViewModel, previewDisplayName: "Invited")
makePreview(viewModel: knockableViewModel, previewDisplayName: "Knockable")
makePreview(viewModel: knockedViewModel, previewDisplayName: "Knocked")
makePreview(viewModel: bannedViewModel, previewDisplayName: "Banned")
makePreview(viewModel: unknownViewModel, mode: .unknown)
makePreview(viewModel: joinableViewModel, mode: .joinable)
makePreview(viewModel: restrictedViewModel, mode: .restricted)
makePreview(viewModel: inviteRequiredViewModel, mode: .inviteRequired)
makePreview(viewModel: invitedViewModel, mode: .invited(isDM: false))
makePreview(viewModel: invitedDMViewModel, mode: .invited(isDM: true))
makePreview(viewModel: knockableViewModel, mode: .knockable)
makePreview(viewModel: knockedViewModel, mode: .knocked)
makePreview(viewModel: bannedViewModel, mode: .banned(sender: nil, reason: nil))
makePreview(viewModel: forbiddenViewModel, mode: .forbidden)
}
static func makePreview(viewModel: JoinRoomScreenViewModel, previewDisplayName: String) -> some View {
NavigationStack {
JoinRoomScreen(context: viewModel.context)
@ViewBuilder
static func makePreview(viewModel: JoinRoomScreenViewModel, mode: JoinRoomScreenMode) -> some View {
if mode == .forbidden {
NavigationStack {
JoinRoomScreen(context: viewModel.context)
}
.snapshotPreferences(expect: viewModel.context.$viewState.map { state in
state.mode == .forbidden
})
.onAppear {
forbiddenViewModel.context.send(viewAction: .join)
}
.previewDisplayName(mode.previewDisplayName)
} else {
NavigationStack {
JoinRoomScreen(context: viewModel.context)
}
.snapshotPreferences(expect: viewModel.context.$viewState.map { state in
state.roomDetails != nil
})
.previewDisplayName(mode.previewDisplayName)
}
.snapshotPreferences(expect: viewModel.context.$viewState.map { state in
state.roomDetails != nil
})
.previewDisplayName(previewDisplayName)
}
static func makeViewModel(mode: JoinRoomScreenMode) -> JoinRoomScreenViewModel {
@@ -294,10 +341,17 @@ struct JoinRoomScreen_Previews: PreviewProvider, TestablePreview {
case .inviteRequired:
clientProxy.roomPreviewForIdentifierViaReturnValue = .success(RoomPreviewProxyMock.inviteRequired)
clientProxy.roomForIdentifierReturnValue = nil
case .invited:
clientProxy.roomPreviewForIdentifierViaReturnValue = .success(RoomPreviewProxyMock.invited())
clientProxy.roomForIdentifierClosure = { _ in
.invited(InvitedRoomProxyMock(.init(avatarURL: .mockMXCAvatar)))
case .invited(let isDM):
if isDM {
clientProxy.roomPreviewForIdentifierViaReturnValue = .success(RoomPreviewProxyMock.inviteDM())
clientProxy.roomForIdentifierClosure = { _ in
.invited(InvitedRoomProxyMock(.init(avatarURL: .mockMXCAvatar)))
}
} else {
clientProxy.roomPreviewForIdentifierViaReturnValue = .success(RoomPreviewProxyMock.invited())
clientProxy.roomForIdentifierClosure = { _ in
.invited(InvitedRoomProxyMock(.init(avatarURL: .mockMXCAvatar)))
}
}
case .knockable:
clientProxy.roomPreviewForIdentifierViaReturnValue = .success(RoomPreviewProxyMock.knockable)
@@ -312,6 +366,12 @@ struct JoinRoomScreen_Previews: PreviewProvider, TestablePreview {
clientProxy.roomForIdentifierClosure = { _ in
.banned
}
case .forbidden:
clientProxy.roomPreviewForIdentifierViaReturnValue = .success(RoomPreviewProxyMock.restricted)
clientProxy.roomForIdentifierReturnValue = nil
clientProxy.joinRoomAliasClosure = { _ in
.failure(.forbiddenAccess)
}
default:
break
}
@@ -324,3 +384,30 @@ struct JoinRoomScreen_Previews: PreviewProvider, TestablePreview {
userIndicatorController: ServiceLocator.shared.userIndicatorController)
}
}
private extension JoinRoomScreenMode {
var previewDisplayName: String {
switch self {
case .unknown:
return "Unknown"
case .loading:
return "Loading"
case .joinable:
return "Joinable"
case .restricted:
return "Restricted"
case .inviteRequired:
return "InviteRequired"
case .invited(isDM: let isDM):
return isDM ? "InvitedDM" : "Invited"
case .knockable:
return "Knockable"
case .knocked:
return "Knocked"
case .banned:
return "Banned"
case .forbidden:
return "Forbidden"
}
}
}