swift/Beam
swift/Beam
1
0
Fork 0
mirror of https://github.com/element-hq/element-x-ios.git synced 2025-03-10 21:39:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added room avatar caching and room list loading state.

Browse Source
This commit is contained in:
Stefan Ceriu 2022-02-22 12:37:44 +02:00
parent ad80b91b16
commit c35438cbb8
11 changed files with 118 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
ElementX.xcodeproj/project.pbxproj
View File

@ -19,6 +19,7 @@
182BC47727C4CD6D00A30C33 /* ActivityDismissal.swift in Sources */ = {isa = PBXBuildFile; fileRef = 182BC46E27C4CD6D00A30C33 /* ActivityDismissal.swift */; };
182BC47927C4CE2200A30C33 /* LabelledActivityIndicatorView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 182BC47827C4CE2200A30C33 /* LabelledActivityIndicatorView.swift */; };
182BC47B27C4D05200A30C33 /* FullscreenLoadingActivityPresenter.swift in Sources */ = {isa = PBXBuildFile; fileRef = 182BC47A27C4D05200A30C33 /* FullscreenLoadingActivityPresenter.swift */; };
182BC48127C4EBBB00A30C33 /* Kingfisher in Frameworks */ = {isa = PBXBuildFile; productRef = 182BC48027C4EBBB00A30C33 /* Kingfisher */; };
1850253F27B6918D002E6B18 /* ElementXTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1850253E27B6918D002E6B18 /* ElementXTests.swift */; };
1850254927B6918D002E6B18 /* ElementXUITests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1850254827B6918D002E6B18 /* ElementXUITests.swift */; };
1850254B27B6918D002E6B18 /* ElementXUITestsLaunchTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1850254A27B6918D002E6B18 /* ElementXUITestsLaunchTests.swift */; };
@ -154,6 +155,7 @@
isa = PBXFrameworksBuildPhase;
buildActionMask = 2147483647;
files = (
182BC48127C4EBBB00A30C33 /* Kingfisher in Frameworks */,
1863A3FC27BA5A9100B52E4D /* KeychainAccess in Frameworks */,
1850255927B69388002E6B18 /* MatrixRustSDK in Frameworks */,
1863A40627BA6DFC00B52E4D /* SwiftyBeaver in Frameworks */,
@ -489,6 +491,7 @@
1850255827B69388002E6B18 /* MatrixRustSDK */,
1863A3FB27BA5A9100B52E4D /* KeychainAccess */,
1863A40527BA6DFC00B52E4D /* SwiftyBeaver */,
182BC48027C4EBBB00A30C33 /* Kingfisher */,
);
productName = ElementX;
productReference = 1850252427B6918C002E6B18 /* ElementX.app */;
@ -566,6 +569,7 @@
1850255727B69388002E6B18 /* XCRemoteSwiftPackageReference "matrix-rust-components-swift" */,
1863A3FA27BA5A9100B52E4D /* XCRemoteSwiftPackageReference "KeychainAccess" */,
1863A40427BA6DFC00B52E4D /* XCRemoteSwiftPackageReference "SwiftyBeaver" */,
182BC47F27C4EBBB00A30C33 /* XCRemoteSwiftPackageReference "Kingfisher" */,
);
productRefGroup = 1850252527B6918C002E6B18 /* Products */;
projectDirPath = "";
@ -1021,6 +1025,14 @@
/* End XCConfigurationList section */
/* Begin XCRemoteSwiftPackageReference section */
182BC47F27C4EBBB00A30C33 /* XCRemoteSwiftPackageReference "Kingfisher" */ = {
isa = XCRemoteSwiftPackageReference;
repositoryURL = "https://github.com/onevcat/Kingfisher";
requirement = {
kind = upToNextMajorVersion;
minimumVersion = 7.0.0;
};
};
1850255727B69388002E6B18 /* XCRemoteSwiftPackageReference "matrix-rust-components-swift" */ = {
isa = XCRemoteSwiftPackageReference;
repositoryURL = "https://github.com/matrix-org/matrix-rust-components-swift.git";
@ -1048,6 +1060,11 @@
/* End XCRemoteSwiftPackageReference section */
/* Begin XCSwiftPackageProductDependency section */
182BC48027C4EBBB00A30C33 /* Kingfisher */ = {
isa = XCSwiftPackageProductDependency;
package = 182BC47F27C4EBBB00A30C33 /* XCRemoteSwiftPackageReference "Kingfisher" */;
productName = Kingfisher;
};
1850255827B69388002E6B18 /* MatrixRustSDK */ = {
isa = XCSwiftPackageProductDependency;
package = 1850255727B69388002E6B18 /* XCRemoteSwiftPackageReference "matrix-rust-components-swift" */;

10
ElementX.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
View File

@ -11,12 +11,12 @@
}
},
{
"package": "MatrixRustSDK",
"repositoryURL": "https://github.com/matrix-org/matrix-rust-components-swift.git",
"package": "Kingfisher",
"repositoryURL": "https://github.com/onevcat/Kingfisher",
"state": {
"branch": "main",
"revision": "cb680b1783849ecabd0bdf61f65faff767ce32c8",
"version": null
"branch": null,
"revision": "0c02c46cfdc0656ce74fd0963a75e5000a0b7f23",
"version": "7.1.2"
}
},
{

3
ElementX/Sources/AppCoordinator.swift
View File

@ -6,6 +6,7 @@
//
import UIKit
import Kingfisher
class AppCoordinator: AuthenticationCoordinatorDelegate, Coordinator {
private let window: UIWindow
@ -76,7 +77,7 @@ class AppCoordinator: AuthenticationCoordinatorDelegate, Coordinator {
}
let parameters = HomeScreenCoordinatorParameters(userSession: userSession)
let coordinator = HomeScreenCoordinator(parameters: parameters)
let coordinator = HomeScreenCoordinator(parameters: parameters, imageCache: ImageCache.default)
coordinator.completion = { [weak self] result in
switch result {

2
ElementX/Sources/Modules/Authentication/UserSession.swift
View File

@ -50,7 +50,7 @@ class UserSession: ClientDelegate {
}
}
func getUserAvatar(_ completion: @escaping (Result<UIImage?, Error>) -> Void) {
func loadUserAvatar(_ completion: @escaping (Result<UIImage?, Error>) -> Void) {
DispatchQueue.global(qos: .background).async {
do {
let avatarData = try self.client.avatar()

7
ElementX/Sources/Modules/HomeScreen/HomeScreenCoordinator.swift
View File

@ -16,6 +16,7 @@
import SwiftUI
import Combine
import Kingfisher
struct HomeScreenCoordinatorParameters {
let userSession: UserSession
@ -45,11 +46,11 @@ final class HomeScreenCoordinator: Coordinator, Presentable {
// MARK: - Setup
init(parameters: HomeScreenCoordinatorParameters) {
init(parameters: HomeScreenCoordinatorParameters, imageCache: Kingfisher.ImageCache) {
self.parameters = parameters
let userDisplayName = self.parameters.userSession.userDisplayName ?? self.parameters.userSession.userIdentifier
viewModel = HomeScreenViewModel(userDisplayName: userDisplayName)
viewModel = HomeScreenViewModel(userDisplayName: userDisplayName, imageCache: imageCache)
let view = HomeScreen(context: viewModel.context)
hostingController = UIHostingController(rootView: view)
@ -61,7 +62,7 @@ final class HomeScreenCoordinator: Coordinator, Presentable {
case .logout:
self.completion?(.logout)
case .loadUserAvatar:
self.parameters.userSession.getUserAvatar({ result in
self.parameters.userSession.loadUserAvatar({ result in
switch result {
case .success(let avatar):
self.viewModel.updateWithUserAvatar(avatar)

1
ElementX/Sources/Modules/HomeScreen/HomeScreenModels.swift
View File

@ -33,6 +33,7 @@ struct HomeScreenViewState: BindableState {
var userAvatar: UIImage?
var rooms: [HomeScreenRoom] = []
var isLoadingRooms: Bool = false
var directRooms: [HomeScreenRoom] {
rooms.filter { $0.isDirect }

79
ElementX/Sources/Modules/HomeScreen/HomeScreenViewModel.swift
View File

@ -15,6 +15,7 @@
//
import SwiftUI
import Kingfisher
@available(iOS 14, *)
typealias HomeScreenViewModelType = StateStoreViewModel<HomeScreenViewState,
@ -27,7 +28,12 @@ class HomeScreenViewModel: HomeScreenViewModelType, HomeScreenViewModelProtocol
// MARK: Private
private var roomList: [RoomModelProtocol]?
private var roomList: [RoomModelProtocol]? {
didSet {
self.state.isLoadingRooms = (roomList == nil)
}
}
private let imageCache: ImageCache
// MARK: Public
@ -35,8 +41,9 @@ class HomeScreenViewModel: HomeScreenViewModelType, HomeScreenViewModelProtocol
// MARK: - Setup
init(userDisplayName: String) {
super.init(initialViewState: HomeScreenViewState(userDisplayName: userDisplayName))
init(userDisplayName: String, imageCache: Kingfisher.ImageCache) {
self.imageCache = imageCache
super.init(initialViewState: HomeScreenViewState(userDisplayName: userDisplayName, isLoadingRooms: true))
}
// MARK: - Public
@ -46,24 +53,7 @@ class HomeScreenViewModel: HomeScreenViewModelType, HomeScreenViewModelProtocol
case .logout:
self.completion?(.logout)
case .loadRoomAvatar(let roomId):
guard let room = roomList?.filter({ $0.identifier == roomId }).first else {
break
}
room.getAvatar { [weak self] result in
guard let self = self else { return }
switch result {
case .success(let image):
guard let index = self.state.rooms.firstIndex(where: { $0.id == roomId }) else {
return
}
self.state.rooms[index].avatar = image
default:
break
}
}
self.loadAvatarForRoomWithIdentifier(roomId)
case .loadUserAvatar:
self.completion?(.loadUserAvatar)
}
@ -84,4 +74,51 @@ class HomeScreenViewModel: HomeScreenViewModelType, HomeScreenViewModelProtocol
func updateWithUserAvatar(_ avatar: UIImage?) {
self.state.userAvatar = avatar
}
// MARK: - Private
private func loadAvatarForRoomWithIdentifier(_ roomIdentifier: String) {
guard let room = roomList?.filter({ $0.identifier == roomIdentifier }).first,
let cacheKey = room.avatarURL?.path else {
return
}
if imageCache.isCached(forKey: cacheKey) {
imageCache.retrieveImage(forKey: cacheKey) { [weak self] result in
guard let self = self else { return }
switch result {
case .success(let value):
self.updateAvatar(value.image, forRoomWithIdentifier: roomIdentifier)
case .failure(let error):
MXLog.error("Failed retrieving avatar from cache with error: \(error)")
}
}
return
}
room.loadAvatar { [weak self] result in
guard let self = self else { return }
switch result {
case .success(let avatar):
guard let avatar = avatar else {
return
}
self.imageCache.store(avatar, forKey: cacheKey)
self.updateAvatar(avatar, forRoomWithIdentifier: roomIdentifier)
default:
break
}
}
}
private func updateAvatar(_ avatar: UIImage?, forRoomWithIdentifier roomIdentifier: String) {
guard let index = self.state.rooms.firstIndex(where: { $0.id == roomIdentifier }) else {
return
}
self.state.rooms[index].avatar = avatar
}
}

40
ElementX/Sources/Modules/HomeScreen/View/HomeScreen.swift
View File

@ -15,6 +15,7 @@
//
import SwiftUI
import Kingfisher
struct HomeScreen: View {
@ -31,6 +32,7 @@ struct HomeScreen: View {
.resizable()
.scaledToFill()
.frame(width: 40, height: 40, alignment: .center)
.mask(Circle())
} else {
let _ = context.send(viewAction: .loadUserAvatar)
}
@ -40,21 +42,30 @@ struct HomeScreen: View {
}
.padding(.vertical, 32.0)
List {
Section("People") {
ForEach(context.viewState.directRooms) { room in
RoomCell(room: room, context: context)
}
}
Section("Rooms") {
ForEach(context.viewState.nondirectRooms) { room in
RoomCell(room: room, context: context)
if context.viewState.isLoadingRooms {
VStack {
Text("Loading rooms")
ProgressView()
}
} else {
List {
Section("People") {
ForEach(context.viewState.directRooms) { room in
RoomCell(room: room, context: context)
}
}
Section("Rooms") {
ForEach(context.viewState.nondirectRooms) { room in
RoomCell(room: room, context: context)
}
}
}
.headerProminence(.increased)
.listStyle(.plain)
}
.headerProminence(.increased)
.listStyle(.plain)
Spacer()
}
.navigationBarTitleDisplayMode(.inline)
.toolbar {
@ -81,6 +92,7 @@ struct RoomCell: View {
.resizable()
.scaledToFill()
.frame(width: 40, height: 40)
.mask(Circle())
} else {
let _ = context.send(viewAction: .loadRoomAvatar(roomId: room.id))
Image(systemName: "person.3")
@ -119,7 +131,7 @@ struct RoomCell: View {
struct HomeScreen_Previews: PreviewProvider {
static var previews: some View {
let viewModel = HomeScreenViewModel(userDisplayName: "Johnny Appleseed")
let viewModel = HomeScreenViewModel(userDisplayName: "Johnny Appleseed", imageCache: ImageCache.default)
let rooms = [MockRoomModel(displayName: "Alfa"),
MockRoomModel(displayName: "Beta"),
@ -127,6 +139,8 @@ struct HomeScreen_Previews: PreviewProvider {
viewModel.updateWithRoomList(rooms)
viewModel.updateWithUserAvatar(UIImage(systemName: "person.fill.questionmark"))
return HomeScreen(context: viewModel.context)
}
}

2
ElementX/Sources/Modules/Models/MockRoomModel.swift
View File

@ -23,7 +23,7 @@ struct MockRoomModel: RoomModelProtocol {
let isPublic = Bool.random()
let isEncrypted = Bool.random()
func getAvatar(_ completion: (Result<UIImage?, Error>) -> Void) {
func loadAvatar(_ completion: (Result<UIImage?, Error>) -> Void) {
completion(.success(UIImage(systemName: "wand.and.stars")))
}
}

2
ElementX/Sources/Modules/Models/RoomModel.swift
View File

@ -74,7 +74,7 @@ struct RoomModel: RoomModelProtocol {
return URL(string: urlString)
}
func getAvatar(_ completion: @escaping (Result<UIImage?, Error>) -> Void) {
func loadAvatar(_ completion: @escaping (Result<UIImage?, Error>) -> Void) {
DispatchQueue.global(qos: .background).async {
do {
let avatarData = try room.avatar()

2
ElementX/Sources/Modules/Models/RoomModelProtocol.swift
View File

@ -22,5 +22,5 @@ protocol RoomModelProtocol {
var avatarURL: URL? { get }
func getAvatar(_ completion: @escaping (Result<UIImage?, Error>) -> Void)
func loadAvatar(_ completion: @escaping (Result<UIImage?, Error>) -> Void)
}