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

Knock and knocked state for the join room screen (#3424)

Browse Source 
* JoinRoomScreen ui for knocking

* code improvement

* updated previews

* added knocked state with tests

* send knock request

* Apply suggestions from code review

Co-authored-by: Doug <6060466+pixlwave@users.noreply.github.com>

* pr comments

---------

Co-authored-by: Doug <6060466+pixlwave@users.noreply.github.com>
This commit is contained in:
Mauro
2024-10-17 16:00:51 +02:00
committed by GitHub
parent 1723542d6a
commit bd4ecdd060
24 changed files with 627 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ElementX/Sources/Screens/JoinRoomScreen/JoinRoomScreenCoordinator.swift
+2
View File
@@ -14,6 +14,7 @@ struct JoinRoomScreenCoordinatorParameters {
let clientProxy: ClientProxyProtocol
let mediaProvider: MediaProviderProtocol
let userIndicatorController: UserIndicatorControllerProtocol
let appSettings: AppSettings
}
enum JoinRoomScreenCoordinatorAction {
@@ -34,6 +35,7 @@ final class JoinRoomScreenCoordinator: CoordinatorProtocol {
init(parameters: JoinRoomScreenCoordinatorParameters) {
viewModel = JoinRoomScreenViewModel(roomID: parameters.roomID,
via: parameters.via,
appSettings: parameters.appSettings,
clientProxy: parameters.clientProxy,
mediaProvider: parameters.mediaProvider,
userIndicatorController: parameters.userIndicatorController)
ElementX/Sources/Screens/JoinRoomScreen/JoinRoomScreenModels.swift
+4
View File
@@ -18,6 +18,7 @@ enum JoinRoomScreenInteractionMode {
case invited
case join
case knock
case knocked
}
struct JoinRoomScreenRoomDetails {
@@ -48,6 +49,7 @@ struct JoinRoomScreenViewState: BindableState {
case .loading: nil
case .unknown: L10n.screenJoinRoomSubtitleNoPreview
case .invited, .join, .knock: roomDetails?.canonicalAlias
case .knocked: nil
}
}
@@ -58,6 +60,7 @@ struct JoinRoomScreenViewState: BindableState {
struct JoinRoomScreenViewStateBindings {
var alertInfo: AlertInfo<JoinRoomScreenAlertType>?
var knockMessage = ""
}
enum JoinRoomScreenAlertType {
@@ -65,6 +68,7 @@ enum JoinRoomScreenAlertType {
}
enum JoinRoomScreenViewAction {
case cancelKnock
case knock
case join
case acceptInvite
ElementX/Sources/Screens/JoinRoomScreen/JoinRoomScreenViewModel.swift
+43 -9
View File
@@ -13,7 +13,7 @@ typealias JoinRoomScreenViewModelType = StateStoreViewModel<JoinRoomScreenViewSt
class JoinRoomScreenViewModel: JoinRoomScreenViewModelType, JoinRoomScreenViewModelProtocol {
private let roomID: String
private let via: [String]
private let allowKnocking: Bool // For preview tests only, actions aren't sent.
private let appSettings: AppSettings
private let clientProxy: ClientProxyProtocol
private let userIndicatorController: UserIndicatorControllerProtocol
@@ -27,13 +27,13 @@ class JoinRoomScreenViewModel: JoinRoomScreenViewModelType, JoinRoomScreenViewMo
init(roomID: String,
via: [String],
allowKnocking: Bool = false,
appSettings: AppSettings,
clientProxy: ClientProxyProtocol,
mediaProvider: MediaProviderProtocol,
userIndicatorController: UserIndicatorControllerProtocol) {
self.roomID = roomID
self.via = via
self.allowKnocking = allowKnocking
self.appSettings = appSettings
self.clientProxy = clientProxy
self.userIndicatorController = userIndicatorController
@@ -51,13 +51,16 @@ class JoinRoomScreenViewModel: JoinRoomScreenViewModelType, JoinRoomScreenViewMo
switch viewAction {
case .knock:
break
Task { await knockRoom() }
case .join:
Task { await joinRoom() }
case .acceptInvite:
Task { await joinRoom() }
case .declineInvite:
showDeclineInviteConfirmationAlert()
case .cancelKnock:
// TODO: implement once available
break
}
}
@@ -106,6 +109,8 @@ class JoinRoomScreenViewModel: JoinRoomScreenViewModelType, JoinRoomScreenViewMo
case .invited(let invitedRoomProxy):
inviter = await invitedRoomProxy.inviter.flatMap(RoomInviterDetails.init)
roomProxy = invitedRoomProxy
case .knocked(let knockedRoomProxy):
roomProxy = knockedRoomProxy
default:
break
}
@@ -122,6 +127,11 @@ class JoinRoomScreenViewModel: JoinRoomScreenViewModelType, JoinRoomScreenViewMo
}
private func updateMode() {
if case .knocked = room {
state.mode = .knocked
return
}
// Check invites first to show Accept/Decline buttons on public rooms.
if case .invited = room {
state.mode = .invited
@@ -133,13 +143,9 @@ class JoinRoomScreenViewModel: JoinRoomScreenViewModelType, JoinRoomScreenViewMo
return
}
if roomPreviewDetails?.isPublic ?? false {
state.mode = .join
} else if roomPreviewDetails?.canKnock ?? false, allowKnocking { // Knocking is not supported yet, the flag is purely for preview tests.
if roomPreviewDetails?.canKnock ?? false, appSettings.knockingEnabled {
state.mode = .knock
} else {
// If everything else fails fallback to showing the join button and
// letting the server figure it out.
state.mode = .join
}
}
@@ -171,6 +177,34 @@ class JoinRoomScreenViewModel: JoinRoomScreenViewModelType, JoinRoomScreenViewMo
}
}
private func knockRoom() async {
showLoadingIndicator()
defer {
hideLoadingIndicator()
}
if let alias = state.roomDetails?.canonicalAlias {
switch await clientProxy.knockRoomAlias(alias,
message: state.bindings.knockMessage.isBlank ? nil : state.bindings.knockMessage) {
case .success:
state.mode = .knocked
case .failure(let error):
MXLog.error("Failed knocking room alias: \(alias) with error: \(error)")
userIndicatorController.submitIndicator(.init(title: L10n.errorUnknown))
}
} else {
switch await clientProxy.knockRoom(roomID,
message: state.bindings.knockMessage.isBlank ? nil : state.bindings.knockMessage) {
case .success:
state.mode = .knocked
case .failure(let error):
MXLog.error("Failed knocking room id: \(roomID) with error: \(error)")
userIndicatorController.submitIndicator(.init(title: L10n.errorUnknown))
}
}
}
private func showDeclineInviteConfirmationAlert() {
guard let roomDetails = state.roomDetails else {
userIndicatorController.submitIndicator(.init(title: L10n.errorUnknown))
ElementX/Sources/Screens/JoinRoomScreen/View/JoinRoomScreen.swift
+80 -2
View File
@@ -29,7 +29,17 @@ struct JoinRoomScreen: View {
.navigationBarTitleDisplayMode(.inline)
}
@ViewBuilder
var mainContent: some View {
if context.viewState.mode == .knocked {
knockedView
} else {
defaultView
}
}
@ViewBuilder
private var defaultView: some View {
VStack(spacing: 16) {
RoomAvatarImage(avatar: context.viewState.avatar,
avatarSize: .room(on: .joinRoom),
@@ -66,10 +76,59 @@ struct JoinRoomScreen: View {
.multilineTextAlignment(.center)
.lineLimit(3)
}
if context.viewState.mode == .knock {
knockMessage
.padding(.top, 19)
}
}
}
}
@ViewBuilder
private var knockedView: some View {
VStack(spacing: 16) {
HeroImage(icon: \.checkCircleSolid, style: .success)
VStack(spacing: 8) {
Text(L10n.screenJoinRoomKnockSentTitle)
.font(.compound.headingMDBold)
.foregroundStyle(.compound.textPrimary)
.multilineTextAlignment(.center)
Text(L10n.screenJoinRoomKnockSentDescription)
.font(.compound.bodyMD)
.foregroundStyle(.compound.textSecondary)
.multilineTextAlignment(.center)
}
}
}
@ViewBuilder
private var knockMessage: some View {
VStack(alignment: .leading, spacing: 12) {
HStack(spacing: 0) {
TextField("", text: $context.knockMessage, axis: .vertical)
.onChange(of: context.knockMessage) { newValue in
context.knockMessage = String(newValue.prefix(1000))
}
.lineLimit(4, reservesSpace: true)
.font(.compound.bodyMD)
.padding(.horizontal, 16)
.padding(.vertical, 12)
}
.background(.compound.bgCanvasDefault)
.cornerRadius(8)
.overlay {
RoundedRectangle(cornerRadius: 8)
.inset(by: 0.5)
.stroke(.compound.borderInteractivePrimary)
}
Text(L10n.screenJoinRoomKnockMessageDescription)
.font(.compound.bodyMD)
.foregroundStyle(.compound.textSecondary)
}
}
@ViewBuilder
var buttons: some View {
switch context.viewState.mode {
@@ -77,7 +136,10 @@ struct JoinRoomScreen: View {
EmptyView()
case .knock:
Button(L10n.screenJoinRoomKnockAction) { context.send(viewAction: .knock) }
.buttonStyle(.compound(.primary))
.buttonStyle(.compound(.super))
case .knocked:
Button(L10n.screenJoinRoomCancelKnockAction) { context.send(viewAction: .cancelKnock) }
.buttonStyle(.compound(.secondary))
case .join:
Button(L10n.screenJoinRoomJoinAction) { context.send(viewAction: .join) }
.buttonStyle(.compound(.super))
@@ -105,6 +167,7 @@ struct JoinRoomScreen_Previews: PreviewProvider, TestablePreview {
static let knockViewModel = makeViewModel(mode: .knock)
static let joinViewModel = makeViewModel(mode: .join)
static let inviteViewModel = makeViewModel(mode: .invited)
static let knockedViewModel = makeViewModel(mode: .knocked)
static var previews: some View {
NavigationStack {
@@ -130,6 +193,12 @@ struct JoinRoomScreen_Previews: PreviewProvider, TestablePreview {
}
.previewDisplayName("Invite")
.snapshotPreferences(delay: 0.25)
NavigationStack {
JoinRoomScreen(context: knockedViewModel.context)
}
.previewDisplayName("Knocked")
.snapshotPreferences(delay: 0.25)
}
static func makeViewModel(mode: JoinRoomScreenInteractionMode) -> JoinRoomScreenViewModel {
@@ -145,11 +214,18 @@ struct JoinRoomScreen_Previews: PreviewProvider, TestablePreview {
(false, false, true, false)
case .knock:
(false, false, false, true)
case .knocked:
(false, false, false, false)
}
if mode == .unknown {
clientProxy.roomPreviewForIdentifierViaReturnValue = .failure(.sdkError(ClientProxyMockError.generic))
} else {
if mode == .knocked {
clientProxy.roomForIdentifierClosure = { _ in
.knocked(KnockedRoomProxyMock(.init()))
}
}
clientProxy.roomPreviewForIdentifierViaReturnValue = .success(.init(roomID: "1",
name: "The Three-Body Problem - 三体",
canonicalAlias: "#3🌞problem:matrix.org",
@@ -164,9 +240,11 @@ struct JoinRoomScreen_Previews: PreviewProvider, TestablePreview {
canKnock: membership.canKnock))
}
ServiceLocator.shared.settings.knockingEnabled = true
return JoinRoomScreenViewModel(roomID: "1",
via: [],
allowKnocking: true,
appSettings: ServiceLocator.shared.settings,
clientProxy: clientProxy,
mediaProvider: MediaProviderMock(configuration: .init()),
userIndicatorController: ServiceLocator.shared.userIndicatorController)