Allow generating restorable tab data

Author: intitni

Core/Sources/ChatGPTChatTab/ChatGPTChatTab.swift

@@ -2,6 +2,7 @@ import ChatService
 import ChatTab
 import Combine
 import Foundation
+import OpenAIService
 import Preferences
 import SwiftUI
 
@@ -13,6 +14,11 @@ public class ChatGPTChatTab: ChatTab {
     public let provider: ChatProvider
     private var cancellable = Set<AnyCancellable>()
 
+    struct RestorableState: Codable {
+        var history: [OpenAIService.ChatMessage]
+        var configuration: OverridingChatGPTConfiguration.Overriding
+    }
+
     struct Builder: ChatTabBuilder {
         var title: String
         var buildable: Bool { true }
@@ -37,6 +43,28 @@ public class ChatGPTChatTab: ChatTab {
         ChatContextMenu(chat: provider)
     }
 
+    public func restorableState() async -> Data {
+        let state = RestorableState(
+            history: await service.memory.history,
+            configuration: service.configuration.overriding
+        )
+        return (try? JSONEncoder().encode(state)) ?? Data()
+    }
+
+    public static func restore(
+        from data: Data,
+        externalDependency: Void
+    ) async throws -> any ChatTab {
+        let state = try JSONDecoder().decode(RestorableState.self, from: data)
+        let tab = ChatGPTChatTab()
+        tab.service.configuration.overriding = state.configuration
+        await tab.service.memory.mutateHistory { history in
+            history = state.history
+        }
+
+        return tab
+    }
+
     public static func chatBuilders(externalDependency: Void) -> [ChatTabBuilder] {
         let customCommands = UserDefaults.shared.value(for: \.customCommands).compactMap {
             command in

Core/Sources/ChatService/ChatService.swift

@@ -7,7 +7,7 @@ import Preferences
 
 public final class ChatService: ObservableObject {
     public let memory: ContextAwareAutoManagedChatGPTMemory
-    public let configuration: ChatGPTConfiguration
+    public let configuration: OverridingChatGPTConfiguration
     public let chatGPTService: any ChatGPTServiceType
     public var allPluginCommands: [String] { allPlugins.map { $0.command } }
     @Published public internal(set) var isReceivingMessage = false
@@ -20,7 +20,7 @@ public final class ChatService: ObservableObject {
 
     init<T: ChatGPTServiceType>(
         memory: ContextAwareAutoManagedChatGPTMemory,
-        configuration: ChatGPTConfiguration,
+        configuration: OverridingChatGPTConfiguration,
         chatGPTService: T
     ) {
         self.memory = memory

Core/Sources/SuggestionWidget/ChatWindowView.swift

@@ -386,6 +386,14 @@ class FakeChatTab: ChatTab {
         )
     }
 
+    func restorableState() async -> Data {
+        return Data()
+    }
+
+    static func restore(from data: Data, externalDependency: ()) async throws -> any ChatTab {
+        return FakeChatTab(id: "id", title: "Title")
+    }
+
     override init(id: String, title: String) {
         super.init(id: id, title: title)
     }

Pro

@@ -2,6 +2,10 @@ import ComposableArchitecture
 import Foundation
 import SwiftUI
 
+public extension Notification.Name {
+    static let chatTabDidChange = Notification.Name("chatTabDidChange")
+}
+
 public struct ChatTabInfo: Identifiable, Equatable {
     public var id: String
     public var title: String
@@ -126,6 +130,15 @@ public protocol ChatTabType {
     /// Available builders for this chat tab.
     /// It's used to generate a list of tab types for user to create.
     static func chatBuilders(externalDependency: ExternalDependency) -> [ChatTabBuilder]
+    /// Restorable state
+    func restorableState() async -> Data
+    /// Restore state
+    static func restore(from data: Data, externalDependency: ExternalDependency) async throws
+        -> any ChatTab
+}
+
+public extension ChatTabType {
+    var name: String { Self.name }
 }
 
 public extension ChatTabType where ExternalDependency == Void {
@@ -165,5 +178,16 @@ public class EmptyChatTab: ChatTab {
     public init(id: String = UUID().uuidString) {
         super.init(id: id, title: "Empty")
     }
+
+    public func restorableState() async -> Data {
+        return Data()
+    }
+
+    public static func restore(
+        from data: Data,
+        externalDependency: Void
+    ) async throws -> any ChatTab {
+        return Builder(title: "Empty").build()
+    }
 }
 

Tool/Sources/ChatTab/ChatTab.swift

@@ -44,7 +44,7 @@ public struct UserPreferenceChatGPTConfiguration: ChatGPTConfiguration {
 }
 
 public class OverridingChatGPTConfiguration: ChatGPTConfiguration {
-    public struct Overriding {
+    public struct Overriding: Codable {
         public var featureProvider: ChatFeatureProvider?
         public var temperature: Double?
         public var model: String?

Tool/Sources/OpenAIService/Configuration/UserPreferenceChatGPTConfiguration.swift

@@ -1,4 +1,4 @@
-public enum ChatFeatureProvider: String, CaseIterable {
+public enum ChatFeatureProvider: String, CaseIterable, Codable {
     case openAI
     case azureOpenAI
 }