Add cache for support

Author: jkmassel

Modules/Package.swift

@@ -136,7 +136,8 @@ let package = Package(
         .target(
             name: "Support",
             dependencies: [
-                "AsyncImageKit"
+                "AsyncImageKit",
+                "WordPressCore",
             ]
         ),
         .target(name: "TextBundle"),

Modules/Sources/Support/Extensions/Foundation.swift

@@ -80,3 +80,17 @@ func convertMarkdownTextToAttributedString(_ text: String) -> AttributedString {
         return AttributedString(text)
     }
 }
+
+extension Task where Failure == Error {
+    static func delayedAndRunOnMainActor<C>(
+        for duration: C.Instant.Duration,
+        priority: TaskPriority? = nil,
+        operation: @MainActor @escaping @Sendable () throws -> Success,
+        clock: C = .continuous
+    ) -> Task where C: Clock {
+        Task(priority: priority) {
+            try await clock.sleep(for: duration)
+            return try await MainActor.run(body: operation)
+        }
+    }
+}

Modules/Sources/Support/InternalDataProvider.swift

@@ -1,4 +1,5 @@
 import Foundation
+import WordPressCore
 
 // This file is all module-internal and provides sample data for UI development
 
@@ -14,7 +15,8 @@ extension SupportDataProvider {
     static let supportUser = SupportUser(
         userId: 1234,
         username: "demo-user",
-        email: "[email protected]"
+        email: "[email protected]",
+        permissions: [.createChatConversation, .createSupportRequest]
     )
     static let botConversation = BotConversation(
         id: 1234,
@@ -271,16 +273,20 @@ actor InternalBotConversationDataProvider: BotConversationDataProvider {
         await SupportDataProvider.supportUser
     }
 
-    func loadBotConversations() async throws -> [BotConversation] {
-        [await SupportDataProvider.botConversation]
+    func loadBotConversations() async throws -> any CachedAndFetchedResult<[BotConversation]> {
+        UncachedResult {
+            [await SupportDataProvider.botConversation]
+        }
     }
 
-    func loadBotConversation(id: UInt64) async throws -> BotConversation? {
-        if id == 5678 {
-            return await SupportDataProvider.conversationReferredToHuman
-        }
+    func loadBotConversation(id: UInt64) async throws -> any CachedAndFetchedResult<BotConversation> {
+        UncachedResult {
+            if id == 5678 {
+                return await SupportDataProvider.conversationReferredToHuman
+            }
 
-        return await SupportDataProvider.botConversation
+            return await SupportDataProvider.botConversation
+        }
     }
 
     func delete(conversationIds: [UInt64]) async throws {
@@ -309,23 +315,28 @@ actor InternalBotConversationDataProvider: BotConversationDataProvider {
 }
 
 actor InternalUserDataProvider: CurrentUserDataProvider {
-    func fetchCurrentSupportUser() async throws -> SupportUser {
-        await SupportDataProvider.supportUser
+    func fetchCurrentSupportUser() async throws -> any CachedAndFetchedResult<SupportUser> {
+        UncachedResult {
+            await SupportDataProvider.supportUser
+        }
     }
 }
 
 actor InternalSupportConversationDataProvider: SupportConversationDataProvider {
     private var conversations: [UInt64: Conversation] = [:]
 
-    func loadSupportConversations() async throws -> [ConversationSummary] {
-        try await Task.sleep(for: .seconds(10))
-        return await SupportDataProvider.supportConversationSummaries
+    func loadSupportConversations() async throws -> any CachedAndFetchedResult<[ConversationSummary]> {
+        UncachedResult {
+            return await SupportDataProvider.supportConversationSummaries
+        }
     }
 
-    func loadSupportConversation(id: UInt64) async throws -> Conversation {
-        let conversation = await SupportDataProvider.supportConversation
-        self.conversations[id] = conversation
-        return conversation
+    func loadSupportConversation(id: UInt64) async throws -> any CachedAndFetchedResult<Conversation> {
+        UncachedResult {
+            let conversation = await SupportDataProvider.supportConversation
+            await self.cache(conversation)
+            return conversation
+        }
     }
 
     func replyToSupportConversation(
@@ -335,7 +346,7 @@ actor InternalSupportConversationDataProvider: SupportConversationDataProvider {
         attachments: [URL]
     ) async throws -> Conversation {
 
-        let conversation = try await loadSupportConversation(id: id)
+        let conversation = try await loadSupportConversation(id: id).fetchedResult()
 
         if Bool.random() {
             throw CocoaError(.validationInvalidDate)
@@ -375,4 +386,8 @@ actor InternalSupportConversationDataProvider: SupportConversationDataProvider {
             )]
         )
     }
+
+    private func cache(_ value: Conversation) {
+        self.conversations[value.id] = value
+    }
 }

Modules/Sources/Support/Model/SupportConversation.swift

@@ -1,6 +1,6 @@
 import Foundation
 
-public struct ConversationSummary: Identifiable, Sendable {
+public struct ConversationSummary: Identifiable, Hashable, Sendable, Codable {
     public let id: UInt64
     public let title: String
     public let description: String
@@ -25,7 +25,7 @@ public struct ConversationSummary: Identifiable, Sendable {
     }
 }
 
-public struct Conversation: Identifiable, Sendable {
+public struct Conversation: Identifiable, Sendable, Codable {
     public let id: UInt64
     public let title: String
     public let description: String
@@ -57,7 +57,7 @@ public struct Conversation: Identifiable, Sendable {
     }
 }
 
-public struct Message: Identifiable, Sendable {
+public struct Message: Identifiable, Sendable, Codable {
     public let id: UInt64
     public let content: String
 
@@ -91,7 +91,7 @@ public struct Message: Identifiable, Sendable {
     }
 }
 
-public struct Attachment: Identifiable, Sendable {
+public struct Attachment: Identifiable, Sendable, Codable {
     public let id: UInt64
 
     public init(id: UInt64) {

Modules/Sources/Support/Model/SupportUser.swift

@@ -1,21 +1,24 @@
 import Foundation
 import CryptoKit
 
-public struct SupportUser: Sendable {
+public struct SupportUser: Sendable, Codable {
     public let userId: UInt64
     public let username: String
     public let email: String
+    public let permissions: [SupportUserPermission]
     public let avatarUrl: URL
 
     public init(
         userId: UInt64,
         username: String,
         email: String,
+        permissions: [SupportUserPermission] = [],
         avatarUrl: URL? = nil
     ) {
         self.userId = userId
         self.username = username
         self.email = email
+        self.permissions = permissions
 
         if let avatarUrl {
             self.avatarUrl = avatarUrl

Modules/Sources/Support/SupportDataProvider.swift

@@ -1,9 +1,20 @@
 import Foundation
+import WordPressCore
 
 public enum SupportFormAction {
     case viewSupportForm
 }
 
+public enum DiagnosticAction {
+    case clearDiskCache
+}
+
+public enum DiagnosticActionStatus {
+    case running(progress: Float)
+    case success
+    case error(Error)
+}
+
 @MainActor
 public final class SupportDataProvider: ObservableObject, Sendable {
 
@@ -33,34 +44,38 @@ public final class SupportDataProvider: ObservableObject, Sendable {
         self.supportDelegate?.userDid(action)
     }
 
+    public func userDid(_ action: DiagnosticAction, progress: @escaping (DiagnosticActionStatus) -> Void) {
+        self.supportDelegate?.userDid(action, progress: progress)
+    }
+
     // Support Bots Data Source
-    public func loadSupportIdentity() async throws -> SupportUser {
+    public func loadSupportIdentity() async throws -> any CachedAndFetchedResult<SupportUser> {
         try await self.userDataProvider.fetchCurrentSupportUser()
     }
 
     // Bot Conversation Data Source
-    public func loadConversations() async throws -> [BotConversation] {
+    public func loadConversations() async throws -> any CachedAndFetchedResult<[BotConversation]> {
         try await self.botConversationDataProvider.loadBotConversations()
     }
 
-    public func loadConversation(id: UInt64) async throws -> BotConversation? {
+    public func loadConversation(id: UInt64) async throws -> any CachedAndFetchedResult<BotConversation> {
         try await self.botConversationDataProvider.loadBotConversation(id: id)
     }
 
     public func delete(conversationIds: [UInt64]) async throws {
         try await self.botConversationDataProvider.delete(conversationIds: conversationIds)
     }
 
-    public func sendMessage(message: String, in conversation: BotConversation?) async throws -> BotConversation {
+    public func sendMessage(message: String, in conversation: BotConversation? = nil) async throws -> BotConversation {
         try await self.botConversationDataProvider.sendMessage(message: message, in: conversation)
     }
 
     // Support Conversations Data Source
-    public func loadSupportConversations() async throws -> [ConversationSummary] {
+    public func loadSupportConversations() async throws -> any CachedAndFetchedResult<[ConversationSummary]> {
         try await self.supportConversationDataProvider.loadSupportConversations()
     }
 
-    public func loadSupportConversation(id: UInt64) async throws -> Conversation {
+    public func loadSupportConversation(id: UInt64) async throws -> any CachedAndFetchedResult<Conversation> {
         try await self.supportConversationDataProvider.loadSupportConversation(id: id)
     }
 
@@ -147,10 +162,16 @@ extension SupportFormDataProvider {
 
 public protocol SupportDelegate: NSObject {
     func userDid(_ action: SupportFormAction)
+    func userDid(_ action: DiagnosticAction, progress: (DiagnosticActionStatus) -> Void)
+}
+
+public enum SupportUserPermission: Sendable, Codable {
+    case createChatConversation
+    case createSupportRequest
 }
 
 public protocol CurrentUserDataProvider: Actor {
-    func fetchCurrentSupportUser() async throws -> SupportUser
+    func fetchCurrentSupportUser() async throws -> any CachedAndFetchedResult<SupportUser>
 }
 
 public protocol ApplicationLogDataProvider: Actor {
@@ -173,16 +194,16 @@ public extension ApplicationLogDataProvider {
 }
 
 public protocol BotConversationDataProvider: Actor {
-    func loadBotConversations() async throws -> [BotConversation]
-    func loadBotConversation(id: UInt64) async throws -> BotConversation?
+    func loadBotConversations() async throws -> any CachedAndFetchedResult<[BotConversation]>
+    func loadBotConversation(id: UInt64) async throws -> any CachedAndFetchedResult<BotConversation>
 
     func sendMessage(message: String, in conversation: BotConversation?) async throws -> BotConversation
     func delete(conversationIds: [UInt64]) async throws
 }
 
 public protocol SupportConversationDataProvider: Actor {
-    func loadSupportConversations() async throws -> [ConversationSummary]
-    func loadSupportConversation(id: UInt64) async throws -> Conversation
+    func loadSupportConversations() async throws -> any CachedAndFetchedResult<[ConversationSummary]>
+    func loadSupportConversation(id: UInt64) async throws -> any CachedAndFetchedResult<Conversation>
 
     func replyToSupportConversation(
         id: UInt64,

Modules/Sources/Support/UI/Application Logs/ActivityLogDetailView.swift

@@ -124,7 +124,7 @@ struct ActivityLogDetailView: View {
 }
 
 #Preview {
-    NavigationView {
+    NavigationStack {
         ActivityLogDetailView(
             applicationLog: SupportDataProvider.applicationLog      ).environmentObject(SupportDataProvider.testing)
     }

Modules/Sources/Support/UI/Application Logs/ActivityLogListView.swift

@@ -43,15 +43,7 @@ public struct ActivityLogListView: View {
         }
         .navigationTitle("Activity Logs")
         .overlay {
-            if case .loaded(let array, let deletionState) = self.state {
-                if array.isEmpty {
-                    ContentUnavailableView {
-                        Label("No Logs Found", systemImage: "doc.text")
-                    } description: {
-                        Text("There are no activity logs available")
-                    }
-                }
-
+            if case .loaded(_, let deletionState) = self.state {
                 switch deletionState {
                 case .none: EmptyView() // Do nothing
                 case .deleting: ProgressView()
@@ -110,6 +102,12 @@ public struct ActivityLogListView: View {
                     self.isConfirmingDeletion = true
                 }
             }
+        } else {
+            ContentUnavailableView {
+                Label("No Logs Found", systemImage: "doc.text")
+            } description: {
+                Text("There are no activity logs available")
+            }
         }
     }
 
@@ -166,7 +164,7 @@ public struct ActivityLogListView: View {
 }
 
 #Preview {
-    NavigationView {
+    NavigationStack {
         ActivityLogListView()    .environmentObject(SupportDataProvider.testing)
 
     }

Modules/Sources/Support/UI/Application Logs/ActivityLogSharingView.swift

@@ -33,7 +33,7 @@ struct ActivityLogSharingView: View {
     var destination: () -> AnyView
 
     var body: some View {
-        NavigationView {
+        NavigationStack {
             VStack(alignment: .leading, spacing: 24) {
 
                 VStack(spacing: 12) {