mirror of
https://github.com/lux-tel/session-ios.git
synced 2026-10-30 20:38:32 +00:00
Morgan Pretty
ac9816b118
The `SessionThreadViewModel` has been renamed to `ConversationInfoViewModel` and is now a simple struct (as opposed to a FetchableRecord with a handful of behemoth database queries) The `ConversationInfoViewModel` and `MessageViewModel` now get initialised with a `ConversationDataCache` which is an object that holds a bunch of [ID -> Data] stores for various types that are needed to construct the aforementioned view models. The `ConversationDataCache` will generally be populated via the `ConversationDataHelper` which, when combined with our `ObservableEvent` system, is where the majority of the work for this refactoring has gone. This helper essentially has 4 parts: - `determineFetchRequirements`: Reviews any events which have come through and determines whether anything needs to be fetched from the database - `applyNonDatabaseEvents`: Updates the cached data directly based on delta information included in the `ObservableEvent` instances - `fetchFromDatabase`: Fetches any data from the database based on the info returned from `determineFetchRequirements`, this function will also resolve any dependant data that newly fetched objects need if they aren't already in the cache - `fetchFromLibSession`: Retrieves requested data from libSession Using the above setup all screens which contain conversation or message data now use these two view models, and can share the state of the view models between each other to reduce the need to refetch data when entering a new screen Some additional changes included due to the above are: • No longer need to pass `displayNameRetriever` throughout • Removed deprecated display name retrieval functions • Removed some duplicate code • Removed some synchronous database query hacks we needed until refactoring had been completed • Refactored mentions to be handled by tags • Refactored and optimised the searching logic (also added some caching) • Refactored the ThreadSettingsViewModel to use the new ObservationBuilder system • Refactored the ThreadPickerViewModel to use the new ObservationBuilder system • Refactored the HomeViewModel to retrieve data using the `ConversationDataHelper` • Refactored the ConversationViewModel to retrieve data using the `ConversationDataHelper` • Fixed an issue where communities weren't getting the correct "joined" timestamp
333 lines
15 KiB
Swift
333 lines
15 KiB
Swift
// Copyright © 2023 Rangeproof Pty Ltd. All rights reserved.
|
|
|
|
import Foundation
|
|
import Combine
|
|
import GRDB
|
|
import SessionUIKit
|
|
import SessionUtilitiesKit
|
|
import SessionNetworkingKit
|
|
|
|
// MARK: - Log.Category
|
|
|
|
private extension Log.Category {
|
|
static let cat: Log.Category = .create("GroupPromoteMemberJob", defaultLevel: .info)
|
|
}
|
|
|
|
// MARK: - GroupPromoteMemberJob
|
|
|
|
public enum GroupPromoteMemberJob: JobExecutor {
|
|
public static var maxFailureCount: Int = 1
|
|
public static var requiresThreadId: Bool = true
|
|
public static var requiresInteractionId: Bool = false
|
|
|
|
private static let notificationDebounceDuration: DispatchQueue.SchedulerTimeType.Stride = .milliseconds(1500)
|
|
private static var notifyFailurePublisher: AnyPublisher<Void, Never>?
|
|
private static let notifyFailureTrigger: PassthroughSubject<(), Never> = PassthroughSubject()
|
|
|
|
private struct GroupInfo: Codable, FetchableRecord {
|
|
let name: String
|
|
let groupIdentityPrivateKey: Data
|
|
}
|
|
|
|
public static func run<S: Scheduler>(
|
|
_ job: Job,
|
|
scheduler: S,
|
|
success: @escaping (Job, Bool) -> Void,
|
|
failure: @escaping (Job, Error, Bool) -> Void,
|
|
deferred: @escaping (Job) -> Void,
|
|
using dependencies: Dependencies
|
|
) {
|
|
guard
|
|
let threadId: String = job.threadId,
|
|
let detailsData: Data = job.details,
|
|
let groupInfo: GroupInfo = dependencies[singleton: .storage].read({ db in
|
|
try ClosedGroup
|
|
.filter(id: threadId)
|
|
.select(.name, .groupIdentityPrivateKey)
|
|
.asRequest(of: GroupInfo.self)
|
|
.fetchOne(db)
|
|
}),
|
|
let details: Details = try? JSONDecoder(using: dependencies).decode(Details.self, from: detailsData)
|
|
else { return failure(job, JobRunnerError.missingRequiredDetails, true) }
|
|
|
|
// The first 32 bytes of a 64 byte ed25519 private key are the seed which can be used
|
|
// to generate the KeyPair so extract those and send along with the promotion message
|
|
let sentTimestampMs: Int64 = dependencies[cache: .snodeAPI].currentOffsetTimestampMs()
|
|
let message: GroupUpdatePromoteMessage = GroupUpdatePromoteMessage(
|
|
groupIdentitySeed: groupInfo.groupIdentityPrivateKey.prefix(32),
|
|
groupName: groupInfo.name,
|
|
sentTimestampMs: UInt64(sentTimestampMs)
|
|
)
|
|
|
|
/// Perform the actual message sending
|
|
dependencies[singleton: .storage]
|
|
.writePublisher { db in
|
|
_ = try? GroupMember
|
|
.filter(GroupMember.Columns.groupId == threadId)
|
|
.filter(GroupMember.Columns.profileId == details.memberSessionIdHexString)
|
|
.filter(GroupMember.Columns.role == GroupMember.Role.admin)
|
|
.updateAllAndConfig(
|
|
db,
|
|
GroupMember.Columns.roleStatus.set(to: GroupMember.RoleStatus.sending),
|
|
using: dependencies
|
|
)
|
|
|
|
return try Authentication.with(swarmPublicKey: details.memberSessionIdHexString, using: dependencies)
|
|
}
|
|
.tryFlatMap { _ -> AnyPublisher<(ResponseInfoType, Message), Error> in
|
|
let authMethod: AuthenticationMethod = try Authentication.with(
|
|
swarmPublicKey: details.memberSessionIdHexString,
|
|
using: dependencies
|
|
)
|
|
|
|
return try MessageSender.preparedSend(
|
|
message: message,
|
|
to: .contact(publicKey: details.memberSessionIdHexString),
|
|
namespace: .default,
|
|
interactionId: nil,
|
|
attachments: nil,
|
|
authMethod: authMethod,
|
|
onEvent: MessageSender.standardEventHandling(using: dependencies),
|
|
using: dependencies
|
|
).send(using: dependencies)
|
|
}
|
|
.subscribe(on: scheduler, using: dependencies)
|
|
.receive(on: scheduler, using: dependencies)
|
|
.sinkUntilComplete(
|
|
receiveCompletion: { result in
|
|
switch result {
|
|
case .finished:
|
|
dependencies[singleton: .storage].write { db in
|
|
try GroupMember
|
|
.filter(
|
|
GroupMember.Columns.groupId == threadId &&
|
|
GroupMember.Columns.profileId == details.memberSessionIdHexString &&
|
|
GroupMember.Columns.role == GroupMember.Role.admin &&
|
|
GroupMember.Columns.roleStatus != GroupMember.RoleStatus.accepted
|
|
)
|
|
.updateAllAndConfig(
|
|
db,
|
|
GroupMember.Columns.roleStatus.set(to: GroupMember.RoleStatus.pending),
|
|
using: dependencies
|
|
)
|
|
}
|
|
|
|
success(job, false)
|
|
|
|
case .failure(let error):
|
|
Log.error(.cat, "Couldn't send message due to error: \(error).")
|
|
|
|
// Update the promotion status of the group member (only if the role is 'admin' and
|
|
// the role status isn't already 'accepted')
|
|
dependencies[singleton: .storage].write { db in
|
|
try GroupMember
|
|
.filter(
|
|
GroupMember.Columns.groupId == threadId &&
|
|
GroupMember.Columns.profileId == details.memberSessionIdHexString &&
|
|
GroupMember.Columns.role == GroupMember.Role.admin &&
|
|
GroupMember.Columns.roleStatus != GroupMember.RoleStatus.accepted
|
|
)
|
|
.updateAllAndConfig(
|
|
db,
|
|
GroupMember.Columns.roleStatus.set(to: GroupMember.RoleStatus.failed),
|
|
using: dependencies
|
|
)
|
|
}
|
|
|
|
// Notify about the failure
|
|
dependencies.mutate(cache: .groupPromoteMemberJob) { cache in
|
|
cache.addFailure(groupId: threadId, memberId: details.memberSessionIdHexString)
|
|
}
|
|
|
|
// Register the failure
|
|
switch error {
|
|
case is MessageError: failure(job, error, true)
|
|
case SnodeAPIError.rateLimited: failure(job, error, true)
|
|
|
|
case SnodeAPIError.clockOutOfSync:
|
|
Log.error(.cat, "Permanently Failing to send due to clock out of sync issue.")
|
|
failure(job, error, true)
|
|
|
|
default: failure(job, error, false)
|
|
}
|
|
}
|
|
}
|
|
)
|
|
}
|
|
|
|
public static func failureMessage(groupName: String, memberIds: [String], profileInfo: [String: Profile]) -> ThemedAttributedString {
|
|
let memberZeroName: String = memberIds.first
|
|
.map { profileInfo[$0]?.displayName() ?? $0.truncated() }
|
|
.defaulting(to: "anonymous".localized())
|
|
|
|
switch memberIds.count {
|
|
case 1:
|
|
return "adminPromotionFailedDescription"
|
|
.put(key: "name", value: memberZeroName)
|
|
.put(key: "group_name", value: groupName)
|
|
.localizedFormatted(baseFont: ToastController.font)
|
|
|
|
case 2:
|
|
let memberOneName: String = (
|
|
profileInfo[memberIds[1]]?.displayName() ??
|
|
memberIds[1].truncated()
|
|
)
|
|
|
|
return "adminPromotionFailedDescriptionTwo"
|
|
.put(key: "name", value: memberZeroName)
|
|
.put(key: "other_name", value: memberOneName)
|
|
.put(key: "group_name", value: groupName)
|
|
.localizedFormatted(baseFont: ToastController.font)
|
|
|
|
default:
|
|
return "adminPromotionFailedDescriptionMultiple"
|
|
.put(key: "name", value: memberZeroName)
|
|
.put(key: "count", value: memberIds.count - 1)
|
|
.put(key: "group_name", value: groupName)
|
|
.localizedFormatted(baseFont: ToastController.font)
|
|
}
|
|
}
|
|
}
|
|
|
|
// MARK: - GroupPromoteMemberJob Cache
|
|
|
|
public extension GroupPromoteMemberJob {
|
|
struct Failure: Hashable {
|
|
let groupId: String
|
|
let memberId: String
|
|
}
|
|
|
|
class Cache: GroupPromoteMemberJobCacheType {
|
|
public var failedMemberIds: Set<String> = []
|
|
|
|
private static let notificationDebounceDuration: DispatchQueue.SchedulerTimeType.Stride = .milliseconds(3000)
|
|
|
|
private let dependencies: Dependencies
|
|
private let failedNotificationTrigger: PassthroughSubject<(), Never> = PassthroughSubject()
|
|
private var disposables: Set<AnyCancellable> = Set()
|
|
public private(set) var failures: Set<Failure> = []
|
|
|
|
// MARK: - Initialiation
|
|
|
|
init(using dependencies: Dependencies) {
|
|
self.dependencies = dependencies
|
|
|
|
setupFailureListener()
|
|
}
|
|
|
|
// MARK: - Functions
|
|
|
|
public func addFailure(groupId: String, memberId: String) {
|
|
failures.insert(Failure(groupId: groupId, memberId: memberId))
|
|
failedNotificationTrigger.send(())
|
|
}
|
|
|
|
public func clearPendingFailures(for groupId: String) {
|
|
failures = failures.filter { $0.groupId != groupId }
|
|
}
|
|
|
|
// MARK: - Internal Functions
|
|
|
|
private func setupFailureListener() {
|
|
failedNotificationTrigger
|
|
.subscribe(on: DispatchQueue.global(qos: .userInitiated), using: dependencies)
|
|
.debounce(
|
|
for: Cache.notificationDebounceDuration,
|
|
scheduler: DispatchQueue.global(qos: .userInitiated)
|
|
)
|
|
.map { [dependencies] _ -> (failures: Set<Failure>, groupId: String) in
|
|
dependencies.mutate(cache: .groupPromoteMemberJob) { cache in
|
|
guard let targetGroupId: String = cache.failures.first?.groupId else { return ([], "") }
|
|
|
|
let result: Set<Failure> = cache.failures.filter { $0.groupId == targetGroupId }
|
|
cache.clearPendingFailures(for: targetGroupId)
|
|
return (result, targetGroupId)
|
|
}
|
|
}
|
|
.filter { failures, _ in !failures.isEmpty }
|
|
.setFailureType(to: Error.self)
|
|
.flatMapStorageReadPublisher(using: dependencies, value: { db, data -> (maybeName: String?, failedMemberIds: [String], profiles: [Profile]) in
|
|
let failedMemberIds: [String] = data.failures.map { $0.memberId }
|
|
|
|
return (
|
|
try ClosedGroup
|
|
.filter(id: data.groupId)
|
|
.select(.name)
|
|
.asRequest(of: String.self)
|
|
.fetchOne(db),
|
|
failedMemberIds,
|
|
try Profile.filter(ids: failedMemberIds).fetchAll(db)
|
|
)
|
|
})
|
|
.map { maybeName, failedMemberIds, profiles -> (groupName: String, failedIds: [String], profileMap: [String: Profile]) in
|
|
let profileMap: [String: Profile] = profiles.reduce(into: [:]) { result, next in
|
|
result[next.id] = next
|
|
}
|
|
let sortedFailedMemberIds: [String] = failedMemberIds.sorted { lhs, rhs in
|
|
// Sort by name, followed by id if names aren't present
|
|
switch (profileMap[lhs]?.displayName(), profileMap[rhs]?.displayName()) {
|
|
case (.some(let lhsName), .some(let rhsName)): return lhsName < rhsName
|
|
case (.some, .none): return true
|
|
case (.none, .some): return false
|
|
case (.none, .none): return lhs < rhs
|
|
}
|
|
}
|
|
|
|
return (
|
|
(maybeName ?? "groupUnknown".localized()),
|
|
sortedFailedMemberIds,
|
|
profileMap
|
|
)
|
|
}
|
|
.catch { _ in Just(("", [], [:])).eraseToAnyPublisher() }
|
|
.filter { _, failedIds, _ in !failedIds.isEmpty }
|
|
.receive(on: DispatchQueue.main, using: dependencies)
|
|
.sink(receiveValue: { [dependencies] groupName, failedIds, profileMap in
|
|
guard let mainWindow: UIWindow = dependencies[singleton: .appContext].mainWindow else { return }
|
|
|
|
let toastController: ToastController = ToastController(
|
|
text: GroupPromoteMemberJob.failureMessage(
|
|
groupName: groupName,
|
|
memberIds: failedIds,
|
|
profileInfo: profileMap
|
|
),
|
|
background: .backgroundSecondary
|
|
)
|
|
toastController.presentToastView(fromBottomOfView: mainWindow, inset: Values.largeSpacing)
|
|
})
|
|
.store(in: &disposables)
|
|
}
|
|
}
|
|
}
|
|
|
|
public extension Cache {
|
|
static let groupPromoteMemberJob: CacheConfig<GroupPromoteMemberJobCacheType, GroupPromoteMemberJobImmutableCacheType> = Dependencies.create(
|
|
identifier: "groupPromoteMemberJob",
|
|
createInstance: { dependencies in GroupPromoteMemberJob.Cache(using: dependencies) },
|
|
mutableInstance: { $0 },
|
|
immutableInstance: { $0 }
|
|
)
|
|
}
|
|
|
|
// MARK: - GroupPromoteMemberJobCacheType
|
|
|
|
/// This is a read-only version of the Cache designed to avoid unintentionally mutating the instance in a non-thread-safe way
|
|
public protocol GroupPromoteMemberJobImmutableCacheType: ImmutableCacheType {
|
|
var failures: Set<GroupPromoteMemberJob.Failure> { get }
|
|
}
|
|
|
|
public protocol GroupPromoteMemberJobCacheType: GroupPromoteMemberJobImmutableCacheType, MutableCacheType {
|
|
var failures: Set<GroupPromoteMemberJob.Failure> { get }
|
|
|
|
func addFailure(groupId: String, memberId: String)
|
|
func clearPendingFailures(for groupId: String)
|
|
}
|
|
|
|
// MARK: - GroupPromoteMemberJob.Details
|
|
|
|
extension GroupPromoteMemberJob {
|
|
public struct Details: Codable {
|
|
public let memberSessionIdHexString: String
|
|
}
|
|
}
|