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

Move search users into a dedicated service (#789)

Browse Source 
* add users provider with test

* add ui test for search users

* add changelog

* Update ElementX/Sources/Services/Users/UsersProvider.swift

Co-authored-by: Alfonso Grillo <alfogrillo@gmail.com>

* add error handling in usersprovider

* remove empty section

* add search in invite users

* add CancellableTask, add setup App Settings in UnitTest, screenshots

* rename of UserDiscoveryService

* Update ElementX/Sources/Other/Extensions/Publisher.swift

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

* new error management for User Discovery Service

* Update ElementX/Sources/Other/CancellableTask.swift

Co-authored-by: Alfonso Grillo <alfogrillo@gmail.com>

* Update ElementX/Sources/Services/Users/UserDiscoveryService.swift

Co-authored-by: Alfonso Grillo <alfogrillo@gmail.com>

* fix invite users and start chat errors

* use only one task to fetch user profile

---------

Co-authored-by: Alfonso Grillo <alfogrillo@gmail.com>
Co-authored-by: Doug <6060466+pixlwave@users.noreply.github.com>
This commit is contained in:
Flescio
2023-04-21 10:11:15 +02:00
committed by GitHub
parent b564036b68
commit 88d3faf77d
48 changed files with 549 additions and 236 deletions
Download Patch File Download Diff File Expand all files Collapse all files
UnitTests/Sources/Extensions/XCTest.swift
+27
View File
@@ -0,0 +1,27 @@
//
// Copyright 2023 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 XCTest
@testable import ElementX
extension XCTestCase {
func setupAppSettings() {
AppSettings.configureWithSuiteName("io.element.elementx.unitests")
AppSettings.reset()
ServiceLocator.shared.register(appSettings: AppSettings())
}
}
UnitTests/Sources/InviteUsersViewModelTests.swift
+5 -1
View File
@@ -22,6 +22,7 @@ import XCTest
class InviteUsersScreenViewModelTests: XCTestCase {
var viewModel: InviteUsersViewModelProtocol!
var clientProxy: MockClientProxy!
var userDiscoveryService: UserDiscoveryServiceMock!
var context: InviteUsersViewModel.Context {
viewModel.context
@@ -29,8 +30,11 @@ class InviteUsersScreenViewModelTests: XCTestCase {
override func setUpWithError() throws {
clientProxy = .init(userID: "")
userDiscoveryService = UserDiscoveryServiceMock()
userDiscoveryService.fetchSuggestionsReturnValue = .success([])
userDiscoveryService.searchProfilesWithReturnValue = .success([])
let userSession = MockUserSession(clientProxy: clientProxy, mediaProvider: MockMediaProvider())
let viewModel = InviteUsersViewModel(userSession: userSession)
let viewModel = InviteUsersViewModel(userSession: userSession, userDiscoveryService: userDiscoveryService)
viewModel.state.usersSection = .init(type: .suggestions, users: [.mockAlice, .mockBob, .mockCharlie])
self.viewModel = viewModel
}
UnitTests/Sources/StartChatViewModelTests.swift
+13 -57
View File
@@ -22,6 +22,7 @@ import XCTest
class StartChatScreenViewModelTests: XCTestCase {
var viewModel: StartChatViewModelProtocol!
var clientProxy: MockClientProxy!
var userDiscoveryService: UserDiscoveryServiceMock!
var context: StartChatViewModel.Context {
viewModel.context
@@ -29,66 +30,29 @@ class StartChatScreenViewModelTests: XCTestCase {
override func setUpWithError() throws {
clientProxy = .init(userID: "")
userDiscoveryService = UserDiscoveryServiceMock()
userDiscoveryService.fetchSuggestionsReturnValue = .success([])
userDiscoveryService.searchProfilesWithReturnValue = .success([])
let userSession = MockUserSession(clientProxy: clientProxy, mediaProvider: MockMediaProvider())
viewModel = StartChatViewModel(userSession: userSession, userIndicatorController: nil)
viewModel = StartChatViewModel(userSession: userSession, userIndicatorController: nil, userDiscoveryService: userDiscoveryService)
setupAppSettings()
ServiceLocator.shared.settings.startChatUserSuggestionsEnabled = true
}
func testQueryShowingNoResults() async throws {
await search(query: "A")
XCTAssertEqual(context.viewState.usersSection.type, .empty)
XCTAssertEqual(context.viewState.usersSection.type, .suggestions)
XCTAssertTrue(userDiscoveryService.fetchSuggestionsCalled)
await search(query: "AA")
XCTAssertEqual(context.viewState.usersSection.type, .empty)
XCTAssertEqual(context.viewState.usersSection.type, .suggestions)
XCTAssertFalse(userDiscoveryService.searchProfilesWithCalled)
await search(query: "AAA")
assertSearchResults(toBe: 0)
}
func testQueryShowingResults() async throws {
clientProxy.searchUsersResult = .success(.init(results: [UserProfile.mockAlice], limited: true))
await search(query: "AAA")
assertSearchResults(toBe: 1)
}
func testGetProfileIsNotCalled() async {
clientProxy.searchUsersResult = .success(.init(results: searchResults, limited: true))
clientProxy.getProfileResult = .success(.init(userID: "@alice:matrix.org"))
await search(query: "AAA")
assertSearchResults(toBe: 3)
XCTAssertFalse(clientProxy.getProfileCalled)
}
func testLocalResultShows() async {
clientProxy.searchUsersResult = .success(.init(results: searchResults, limited: true))
clientProxy.getProfileResult = .success(.init(userID: "@some:matrix.org"))
await search(query: "@a:b.com")
assertSearchResults(toBe: 4)
XCTAssertTrue(clientProxy.getProfileCalled)
}
func testLocalResultWithDuplicates() async {
clientProxy.searchUsersResult = .success(.init(results: searchResults, limited: true))
clientProxy.getProfileResult = .success(.init(userID: "@bob:matrix.org"))
await search(query: "@a:b.com")
assertSearchResults(toBe: 3)
let firstUserID = viewModel.context.viewState.usersSection.users.first?.userID
XCTAssertEqual(firstUserID, "@bob:matrix.org")
XCTAssertTrue(clientProxy.getProfileCalled)
}
func testSearchResultsShowWhenGetProfileFails() async {
clientProxy.searchUsersResult = .success(.init(results: searchResults, limited: true))
clientProxy.getProfileResult = .failure(.failedGettingUserProfile)
await search(query: "@a:b.com")
assertSearchResults(toBe: 4)
XCTAssertTrue(userDiscoveryService.searchProfilesWithCalled)
}
// MARK: - Private
@@ -105,12 +69,4 @@ class StartChatScreenViewModelTests: XCTestCase {
viewModel.context.searchQuery = query
return await context.$viewState.nextValue
}
private var searchResults: [UserProfile] {
[
.mockAlice,
.mockBob,
.mockCharlie
]
}
}
UnitTests/Sources/UserDiscoveryService/UserDiscoveryServiceTest.swift
+99
View File
@@ -0,0 +1,99 @@
//
// Copyright 2023 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 XCTest
@testable import ElementX
@MainActor
class UserDiscoveryServiceTest: XCTestCase {
var service: UserDiscoveryService!
var clientProxy: MockClientProxy!
override func setUpWithError() throws {
clientProxy = .init(userID: "")
service = UserDiscoveryService(clientProxy: clientProxy)
}
func testQueryShowingResults() async throws {
clientProxy.searchUsersResult = .success(.init(results: [UserProfile.mockAlice], limited: true))
let results = await (try? search(query: "AAA").get()) ?? []
assertSearchResults(results, toBe: 1)
}
func testGetProfileIsNotCalled() async {
clientProxy.searchUsersResult = .success(.init(results: searchResults, limited: true))
clientProxy.getProfileResult = .success(.init(userID: "@alice:matrix.org"))
let results = await (try? search(query: "AAA").get()) ?? []
assertSearchResults(results, toBe: 3)
XCTAssertFalse(clientProxy.getProfileCalled)
}
func testLocalResultShows() async {
clientProxy.searchUsersResult = .success(.init(results: searchResults, limited: true))
clientProxy.getProfileResult = .success(.init(userID: "@some:matrix.org"))
let results = await (try? search(query: "@a:b.com").get()) ?? []
assertSearchResults(results, toBe: 4)
XCTAssertTrue(clientProxy.getProfileCalled)
}
func testLocalResultWithDuplicates() async {
clientProxy.searchUsersResult = .success(.init(results: searchResults, limited: true))
clientProxy.getProfileResult = .success(.init(userID: "@bob:matrix.org"))
let results = await (try? search(query: "@a:b.com").get()) ?? []
assertSearchResults(results, toBe: 3)
let firstUserID = results.first?.userID
XCTAssertEqual(firstUserID, "@bob:matrix.org")
XCTAssertTrue(clientProxy.getProfileCalled)
}
func testSearchResultsShowWhenGetProfileFails() async {
clientProxy.searchUsersResult = .success(.init(results: searchResults, limited: true))
clientProxy.getProfileResult = .failure(.failedGettingUserProfile)
let results = await (try? search(query: "@a:b.com").get()) ?? []
let firstUserID = results.first?.userID
XCTAssertEqual(firstUserID, "@a:b.com")
XCTAssertTrue(clientProxy.getProfileCalled)
}
// MARK: - Private
private func assertSearchResults(_ results: [UserProfile], toBe count: Int) {
XCTAssertTrue(count >= 0)
XCTAssertEqual(results.count, count)
XCTAssertEqual(results.isEmpty, count == 0)
}
private func search(query: String) async -> Result<[UserProfile], UserDiscoveryErrorType> {
await service.searchProfiles(with: query)
}
private var searchResults: [UserProfile] {
[
.mockAlice,
.mockBob,
.mockCharlie
]
}
}