#1098 - Stopped relying on the SDK in the suggestionService and added unit and ui tests.

This commit is contained in:
Stefan Ceriu
2021-10-06 14:42:48 +03:00
parent 1ce7195abd
commit 17041e00dd
11 changed files with 294 additions and 268 deletions
@@ -1,112 +0,0 @@
// File created from SimpleUserProfileExample
// $ createScreen.sh Room/UserSuggestion UserSuggestion
//
// Copyright 2021 New Vector Ltd
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
import Foundation
import Combine
@available(iOS 14.0, *)
struct UserSuggestionServiceItem: UserSuggestionItemProtocol {
let userId: String
let displayName: String?
let avatarUrl: String?
}
@available(iOS 14.0, *)
class UserSuggestionService: UserSuggestionServiceProtocol {
// MARK: - Properties
// MARK: Private
private let room: MXRoom
private var suggestionItems: [UserSuggestionItemProtocol] = []
private var roomJoinedMembers: [MXRoomMember] = []
// MARK: Public
var items: CurrentValueSubject<[UserSuggestionItemProtocol], Never>
var currentTextTrigger: String?
// MARK: - Setup
init(room: MXRoom) {
self.room = room
self.items = CurrentValueSubject([])
self.room.members { [weak self] members in
guard let self = self, let joinedMembers = members?.joinedMembers else {
return
}
self.roomJoinedMembers = joinedMembers
self.suggestionItems = joinedMembers.map { member in
UserSuggestionServiceItem(userId: member.userId, displayName: member.displayname, avatarUrl: member.avatarUrl)
}
} lazyLoadedMembers: { [weak self] lazyMembers in
guard let self = self, let joinedMembers = lazyMembers?.joinedMembers else {
return
}
self.roomJoinedMembers = joinedMembers
self.suggestionItems = joinedMembers.map { member in
UserSuggestionServiceItem(userId: member.userId, displayName: member.displayname, avatarUrl: member.avatarUrl)
}
} failure: { error in
MXLog.error("[UserSuggestionService] Failed loading room with error: \(String(describing: error))")
}
}
func roomMemberForIdentifier(_ identifier: String) -> MXRoomMember? {
return roomJoinedMembers.filter { $0.userId == identifier }.first
}
// MARK: - UserSuggestionServiceProtocol
func processTextMessage(_ textMessage: String) {
items.send([])
currentTextTrigger = nil
guard textMessage.count > 0 else {
return
}
let components = textMessage.components(separatedBy: .whitespaces)
guard let lastComponent = components.last else {
return
}
guard lastComponent.hasPrefix("@") else {
return
}
currentTextTrigger = lastComponent
var partialName = lastComponent
partialName.removeFirst()
items.send(suggestionItems.filter({ userSuggestion in
let containedInUsername = userSuggestion.userId.lowercased().range(of: partialName.lowercased()) != .none
let containedInDisplayName = (userSuggestion.displayName ?? "").lowercased().range(of: partialName.lowercased()) != .none
return (containedInUsername || containedInDisplayName)
}))
}
}
@@ -28,12 +28,7 @@ enum MockUserSuggestionScreenState: MockScreenState, CaseIterable {
}
var screenView: ([Any], AnyView) {
let service: MockUserSuggestionService
switch self {
case .multipleResults:
service = MockUserSuggestionService(userCount: 10)
}
let service = UserSuggestionService(roomMembersProvider: self)
let listViewModel = UserSuggestionViewModel.makeUserSuggestionViewModel(userSuggestionService: service)
let viewModel = UserSuggestionListWithInputViewModel(listViewModel: listViewModel) { textMessage in
@@ -47,3 +42,17 @@ enum MockUserSuggestionScreenState: MockScreenState, CaseIterable {
)
}
}
@available(iOS 14.0, *)
extension MockUserSuggestionScreenState: RoomMembersProviderProtocol {
func fetchMembers(_ members: ([RoomMembersProviderMember]) -> Void) {
members(generateUsersWithCount(10))
}
private func generateUsersWithCount(_ count: UInt) -> [RoomMembersProviderMember] {
return (0..<count).map { _ in
let identifier = "@" + UUID().uuidString
return RoomMembersProviderMember(identifier: identifier, displayName: identifier, avatarURL: "mxc://matrix.org/VyNYAgahaiAzUoOeZETtQ")
}
}
}
@@ -1,74 +0,0 @@
// File created from SimpleUserProfileExample
// $ createScreen.sh Room/UserSuggestion UserSuggestion
//
// Copyright 2021 New Vector Ltd
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
import Foundation
import Combine
@available(iOS 14.0, *)
struct MockUserSuggestionServiceItem: UserSuggestionItemProtocol {
let userId: String
let displayName: String?
let avatarUrl: String?
}
@available(iOS 14.0, *)
class MockUserSuggestionService: UserSuggestionServiceProtocol {
private var suggestionItems: [UserSuggestionItemProtocol] = []
var items: CurrentValueSubject<[UserSuggestionItemProtocol], Never>
init(userCount: UInt) {
items = CurrentValueSubject([])
generateUsersWithCount(userCount)
items.send(suggestionItems)
}
func processTextMessage(_ textMessage: String) {
items.send([])
guard textMessage.count > 0 else {
return
}
let components = textMessage.components(separatedBy: .whitespaces)
guard let lastComponent = components.last else {
return
}
guard lastComponent.hasPrefix("@") else {
return
}
var partialName = lastComponent
partialName.removeFirst()
items.send(suggestionItems.filter({ userSuggestion in
return (userSuggestion.displayName?.lowercased().range(of: partialName.lowercased()) != .none)
}))
}
private func generateUsersWithCount(_ count: UInt) {
suggestionItems.removeAll()
for _ in 0..<count {
let identifier = "@" + UUID().uuidString
suggestionItems.append(MockUserSuggestionServiceItem(userId: identifier, displayName: identifier, avatarUrl: "mxc://matrix.org/VyNYAgahaiAzUoOeZETtQ"))
}
}
}
@@ -0,0 +1,107 @@
// File created from SimpleUserProfileExample
// $ createScreen.sh Room/UserSuggestion UserSuggestion
//
// Copyright 2021 New Vector Ltd
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
import Foundation
import Combine
@available(iOS 14.0, *)
struct RoomMembersProviderMember {
var identifier: String
var displayName: String
var avatarURL: String
}
@available(iOS 14.0, *)
protocol RoomMembersProviderProtocol {
func fetchMembers(_ members: @escaping ([RoomMembersProviderMember]) -> Void)
}
@available(iOS 14.0, *)
struct UserSuggestionServiceItem: UserSuggestionItemProtocol {
let userId: String
let displayName: String?
let avatarUrl: String?
}
@available(iOS 14.0, *)
class UserSuggestionService: UserSuggestionServiceProtocol {
// MARK: - Properties
// MARK: Private
private let roomMembersProvider: RoomMembersProviderProtocol
private var suggestionItems: [UserSuggestionItemProtocol] = []
// MARK: Public
var items: CurrentValueSubject<[UserSuggestionItemProtocol], Never>
var currentTextTrigger: String?
// MARK: - Setup
init(roomMembersProvider: RoomMembersProviderProtocol) {
self.roomMembersProvider = roomMembersProvider
self.items = CurrentValueSubject([])
}
// MARK: - UserSuggestionServiceProtocol
func processTextMessage(_ textMessage: String) {
roomMembersProvider.fetchMembers { [weak self] members in
guard let self = self else {
return
}
self.suggestionItems = members.map { member in
UserSuggestionServiceItem(userId: member.identifier, displayName: member.displayName, avatarUrl: member.avatarURL)
}
self.items.send([])
self.currentTextTrigger = nil
guard textMessage.count > 0 else {
return
}
let components = textMessage.components(separatedBy: .whitespaces)
guard let lastComponent = components.last else {
return
}
// Partial username should start with one and only one "@" character
guard lastComponent.prefix(while: { character in character == "@" }).count == 1 else {
return
}
self.currentTextTrigger = lastComponent
var partialName = lastComponent
partialName.removeFirst()
self.items.send(self.suggestionItems.filter({ userSuggestion in
let containedInUsername = userSuggestion.userId.lowercased().range(of: partialName.lowercased()) != .none
let containedInDisplayName = (userSuggestion.displayName ?? "").lowercased().range(of: partialName.lowercased()) != .none
return (containedInUsername || containedInDisplayName)
}))
}
}
}
@@ -31,6 +31,8 @@ protocol UserSuggestionServiceProtocol {
var items: CurrentValueSubject<[UserSuggestionItemProtocol], Never> { get }
var currentTextTrigger: String? { get }
func processTextMessage(_ textMessage: String)
}