Skip to content

Commit

Permalink
Expose sliding sync proxy URL on the server selection screen; make ap…
Browse files Browse the repository at this point in the history
…p more resilient to slidinc sync configuration errors, remove fatal errors
  • Loading branch information
stefanceriu committed Nov 17, 2022
1 parent 2fd0491 commit 119933e
Show file tree
Hide file tree
Showing 10 changed files with 91 additions and 54 deletions.
12 changes: 10 additions & 2 deletions ElementX/Sources/Application/BuildSettings.swift
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,19 @@
import Foundation

final class BuildSettings {
static var defaults: UserDefaults = {
guard let userDefaults = UserDefaults(suiteName: ElementInfoPlist.appGroupIdentifier) else {
fatalError("[RiotSettings] Fail to load shared UserDefaults")
}
return userDefaults
}()

// MARK: - Servers

static let defaultHomeserverAddress = "matrix.org"
static let slidingSyncProxyBaseURL = URL(staticString: "https://slidingsync.lab.element.dev")


static let defaultSlidingSyncProxyBaseURLString = "https://slidingsync.lab.element.dev"

// MARK: - Bug report

static let bugReportServiceBaseURL = URL(staticString: "https://riot.im/bugreports")
Expand Down
6 changes: 6 additions & 0 deletions ElementX/Sources/Other/ElementSettings.swift
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ final class ElementSettings: ObservableObject {
case timelineStyle
case enableAnalytics
case isIdentifiedForAnalytics
case slidingSyncProxyBaseURLString
}

static let shared = ElementSettings()
Expand Down Expand Up @@ -59,4 +60,9 @@ final class ElementSettings: ObservableObject {

@AppStorage(UserDefaultsKeys.timelineStyle.rawValue, store: store)
var timelineStyle = BuildSettings.defaultRoomTimelineStyle

// MARK: - Client

@AppStorage(UserDefaultsKeys.slidingSyncProxyBaseURLString.rawValue, store: store)
var slidingSyncProxyBaseURLString = BuildSettings.defaultSlidingSyncProxyBaseURLString
}
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@ struct ServerSelectionViewState: BindableState {
struct ServerSelectionBindings {
/// The homeserver address input by the user.
var homeserverAddress: String
/// The sliding sync proxy address input by the user.
var slidingSyncProxyAddress: String
/// Information describing the currently displayed alert.
var alertInfo: AlertInfo<ServerSelectionErrorType>?
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,9 @@ class ServerSelectionViewModel: ServerSelectionViewModelType, ServerSelectionVie
// MARK: - Setup

init(homeserverAddress: String, isModallyPresented: Bool) {
let bindings = ServerSelectionBindings(homeserverAddress: homeserverAddress)
let bindings = ServerSelectionBindings(homeserverAddress: homeserverAddress,
slidingSyncProxyAddress: ElementSettings.shared.slidingSyncProxyBaseURLString)

super.init(initialViewState: ServerSelectionViewState(bindings: bindings,
isModallyPresented: isModallyPresented))
}
Expand All @@ -40,6 +42,10 @@ class ServerSelectionViewModel: ServerSelectionViewModelType, ServerSelectionVie
override func process(viewAction: ServerSelectionViewAction) async {
switch viewAction {
case .confirm:
if !state.bindings.slidingSyncProxyAddress.isEmpty {
ElementSettings.shared.slidingSyncProxyBaseURLString = state.bindings.slidingSyncProxyAddress
}

callback?(.confirm(homeserverAddress: state.bindings.homeserverAddress))
case .dismiss:
callback?(.dismiss)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,8 @@
import SwiftUI

struct ServerSelectionScreen: View {
// MARK: - Properties

// MARK: Private

@FocusState var isTextFieldFocused: Bool

// MARK: Public

@ObservedObject var context: ServerSelectionViewModel.Context

// MARK: Views

var body: some View {
ScrollView {
VStack(spacing: 0) {
Expand Down Expand Up @@ -69,8 +59,8 @@ struct ServerSelectionScreen: View {
var serverForm: some View {
VStack(alignment: .leading, spacing: 12) {
TextField(ElementL10n.ftueAuthChooseServerEntryHint, text: $context.homeserverAddress)
.focused($isTextFieldFocused)
.textFieldStyle(.elementInput(footerText: context.viewState.footerMessage,
.textFieldStyle(.elementInput(labelText: ElementL10n.hsUrl,
footerText: context.viewState.footerMessage,
isError: context.viewState.isShowingFooterError))
.keyboardType(.URL)
.autocapitalization(.none)
Expand All @@ -80,6 +70,17 @@ struct ServerSelectionScreen: View {
.onSubmit(submit)
.accessibilityIdentifier("addressTextField")

Divider()

TextField(ElementL10n.ftueAuthChooseServerEntryHint, text: $context.slidingSyncProxyAddress)
.textFieldStyle(.elementInput(labelText: "Sliding sync proxy URL"))
.keyboardType(.URL)
.autocapitalization(.none)
.disableAutocorrection(true)
.submitLabel(.done)
.onSubmit(submit)
.accessibilityIdentifier("slidingSyncProxyAddressTextField")

Button(action: submit) {
Text(context.viewState.buttonTitle)
}
Expand Down
49 changes: 33 additions & 16 deletions ElementX/Sources/Screens/HomeScreen/HomeScreenViewModel.swift
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ typealias HomeScreenViewModelType = StateStoreViewModel<HomeScreenViewState, Hom

class HomeScreenViewModel: HomeScreenViewModelType, HomeScreenViewModelProtocol {
private let userSession: UserSessionProtocol
private let roomSummaryProvider: RoomSummaryProviderProtocol
private let roomSummaryProvider: RoomSummaryProviderProtocol?
private let attributedStringBuilder: AttributedStringBuilderProtocol
private var roomsForIdentifiers = [String: HomeScreenRoom]()

Expand Down Expand Up @@ -51,6 +51,25 @@ class HomeScreenViewModel: HomeScreenViewModelType, HomeScreenViewModelProtocol
}
.store(in: &cancellables)

Task {
if case let .success(userAvatarURLString) = await userSession.clientProxy.loadUserAvatarURLString() {
if case let .success(avatar) = await userSession.mediaProvider.loadImageFromURLString(userAvatarURLString, avatarSize: .user(on: .home)) {
state.userAvatar = avatar
}
}
}

Task {
if case let .success(userDisplayName) = await userSession.clientProxy.loadUserDisplayName() {
state.userDisplayName = userDisplayName
}
}

guard let roomSummaryProvider else {
MXLog.error("Room summary provider unavailable")
return
}

Publishers.CombineLatest3(roomSummaryProvider.statePublisher,
roomSummaryProvider.countPublisher,
roomSummaryProvider.roomListPublisher)
Expand All @@ -77,20 +96,6 @@ class HomeScreenViewModel: HomeScreenViewModelType, HomeScreenViewModelProtocol
}
.store(in: &cancellables)

Task {
if case let .success(userAvatarURLString) = await userSession.clientProxy.loadUserAvatarURLString() {
if case let .success(avatar) = await userSession.mediaProvider.loadImageFromURLString(userAvatarURLString, avatarSize: .user(on: .home)) {
state.userAvatar = avatar
}
}
}

Task {
if case let .success(userDisplayName) = await userSession.clientProxy.loadUserDisplayName() {
state.userDisplayName = userDisplayName
}
}

updateRooms()
}

Expand All @@ -99,7 +104,9 @@ class HomeScreenViewModel: HomeScreenViewModelType, HomeScreenViewModelProtocol
override func process(viewAction: HomeScreenViewAction) async {
switch viewAction {
case .loadRoomData(let roomIdentifier):
loadDataForRoomIdentifier(roomIdentifier)
if state.roomListMode != .skeletons {
loadDataForRoomIdentifier(roomIdentifier)
}
case .selectRoom(let roomIdentifier):
callback?(.selectRoom(roomIdentifier: roomIdentifier))
case .userMenu(let action):
Expand All @@ -118,6 +125,11 @@ class HomeScreenViewModel: HomeScreenViewModelType, HomeScreenViewModelProtocol
// MARK: - Private

private func loadDataForRoomIdentifier(_ identifier: String) {
guard let roomSummaryProvider else {
MXLog.error("Room summary provider unavailable")
return
}

guard let roomSummary = roomSummaryProvider.roomListPublisher.value.first(where: { $0.asFilled?.id == identifier })?.asFilled,
let roomIndex = state.rooms.firstIndex(where: { $0.id == identifier }) else {
return
Expand All @@ -140,6 +152,11 @@ class HomeScreenViewModel: HomeScreenViewModelType, HomeScreenViewModelProtocol
}

private func updateRooms() {
guard let roomSummaryProvider else {
MXLog.error("Room summary provider unavailable")
return
}

var rooms = [HomeScreenRoom]()
var newRoomsForIdentifiers = [String: HomeScreenRoom]()

Expand Down
38 changes: 17 additions & 21 deletions ElementX/Sources/Services/Client/ClientProxy.swift
Original file line number Diff line number Diff line change
Expand Up @@ -55,22 +55,16 @@ class ClientProxy: ClientProxyProtocol {
private let clientQueue: DispatchQueue

private var slidingSyncObserverToken: StoppableSpawn?
private var slidingSync: SlidingSync!
private var slidingSync: SlidingSync?

var roomSummaryProviderInternal: RoomSummaryProviderProtocol!
var roomSummaryProvider: RoomSummaryProviderProtocol {
guard let roomSummaryProviderInternal else {
fatalError("There is an issue with ClientProxy object initialization")
}
return roomSummaryProviderInternal
}
var roomSummaryProvider: RoomSummaryProviderProtocol?

deinit {
// These need to be inlined instead of using stopSync()
// as we can't call async methods safely from deinit
client.setDelegate(delegate: nil)
slidingSyncObserverToken?.cancel()
slidingSync.setObserver(observer: nil)
slidingSync?.setObserver(observer: nil)
}

let callbacks = PassthroughSubject<ClientProxyCallback, Never>()
Expand All @@ -84,7 +78,7 @@ class ClientProxy: ClientProxyProtocol {

await Task.dispatch(on: clientQueue) {
do {
let slidingSyncBuilder = try client.slidingSync().homeserver(url: BuildSettings.slidingSyncProxyBaseURL.absoluteString)
let slidingSyncBuilder = try client.slidingSync().homeserver(url: ElementSettings.shared.slidingSyncProxyBaseURLString)

let slidingSyncView = try SlidingSyncViewBuilder()
.timelineLimit(limit: 10)
Expand All @@ -94,16 +88,18 @@ class ClientProxy: ClientProxyProtocol {
.syncMode(mode: .fullSync)
.build()

self.slidingSync = try slidingSyncBuilder
let slidingSync = try slidingSyncBuilder
.addView(v: slidingSyncView)
.withCommonExtensions()
.build()

self.roomSummaryProviderInternal = RoomSummaryProvider(slidingSyncController: self.slidingSync,
slidingSyncView: slidingSyncView,
roomMessageFactory: RoomMessageFactory())

self.roomSummaryProvider = RoomSummaryProvider(slidingSyncController: slidingSync,
slidingSyncView: slidingSyncView,
roomMessageFactory: RoomMessageFactory())

self.slidingSync = slidingSync
} catch {
fatalError("Failed configuring sliding sync")
MXLog.error("Failed configuring sliding sync with error: \(error)")
}
}

Expand Down Expand Up @@ -150,15 +146,15 @@ class ClientProxy: ClientProxyProtocol {
return
}

slidingSync.setObserver(observer: WeakClientProxyWrapper(clientProxy: self))
slidingSyncObserverToken = slidingSync.sync()
slidingSync?.setObserver(observer: WeakClientProxyWrapper(clientProxy: self))
slidingSyncObserverToken = slidingSync?.sync()
}

func stopSync() {
client.setDelegate(delegate: nil)

slidingSyncObserverToken?.cancel()
slidingSync.setObserver(observer: nil)
slidingSync?.setObserver(observer: nil)
}

func roomForIdentifier(_ identifier: String) async -> RoomProxyProtocol? {
Expand Down Expand Up @@ -252,7 +248,7 @@ class ClientProxy: ClientProxyProtocol {

private func roomTupleForIdentifier(_ identifier: String) -> (SlidingSyncRoom?, Room?) {
do {
let slidingSyncRoom = try slidingSync.getRoom(roomId: identifier)
let slidingSyncRoom = try slidingSync?.getRoom(roomId: identifier)
let fullRoom = slidingSyncRoom?.fullRoom()

return (slidingSyncRoom, fullRoom)
Expand All @@ -271,7 +267,7 @@ class ClientProxy: ClientProxyProtocol {
}

fileprivate func didReceiveSlidingSyncUpdate(summary: UpdateSummary) {
roomSummaryProvider.updateRoomsWithIdentifiers(summary.rooms)
roomSummaryProvider?.updateRoomsWithIdentifiers(summary.rooms)

callbacks.send(.receivedSyncUpdate)
}
Expand Down
2 changes: 1 addition & 1 deletion ElementX/Sources/Services/Client/ClientProxyProtocol.swift
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ protocol ClientProxyProtocol {

var restorationToken: RestorationToken? { get }

var roomSummaryProvider: RoomSummaryProviderProtocol { get }
var roomSummaryProvider: RoomSummaryProviderProtocol? { get }

func startSync()

Expand Down
2 changes: 1 addition & 1 deletion ElementX/Sources/Services/Client/MockClientProxy.swift
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ struct MockClientProxy: ClientProxyProtocol {
let homeserver = ""
let restorationToken: RestorationToken? = nil

var roomSummaryProvider: RoomSummaryProviderProtocol = MockRoomSummaryProvider()
var roomSummaryProvider: RoomSummaryProviderProtocol? = MockRoomSummaryProvider()

func startSync() { }

Expand Down
1 change: 1 addition & 0 deletions changelog.d/320.feature
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Expose sliding sync proxy configuration URL on the server selection screen

0 comments on commit 119933e

Please sign in to comment.