Merge branch 'feature/search-scope' into develop

Author: intitni

Core/Sources/ChatContextCollectors/SystemInfoChatContextCollector/SystemInfoChatContextCollector.swift

@@ -13,7 +13,7 @@ public final class SystemInfoChatContextCollector: ChatContextCollector {
 
     public func generateContext(
         history: [ChatMessage],
-        scopes: Set<String>,
+        scopes: Set<ChatContext.Scope>,
         content: String,
         configuration: ChatGPTConfiguration
     ) -> ChatContext {

Core/Sources/ChatContextCollectors/WebChatContextCollector/WebChatContextCollector.swift

@@ -9,11 +9,11 @@ public final class WebChatContextCollector: ChatContextCollector {
 
     public func generateContext(
         history: [ChatMessage],
-        scopes: Set<String>,
+        scopes: Set<ChatContext.Scope>,
         content: String,
         configuration: ChatGPTConfiguration
     ) -> ChatContext {
-        guard scopes.contains("web") || scopes.contains("w") else { return .empty }
+        guard scopes.contains(.web) else { return .empty }
         let links = Self.detectLinks(from: history) + Self.detectLinks(from: content)
         let functions: [(any ChatGPTFunction)?] = [
             SearchFunction(maxTokens: configuration.maxTokens),

Core/Sources/ChatGPTChatTab/Chat.swift

@@ -51,11 +51,13 @@ struct Chat: ReducerProtocol {
         case observeIsReceivingMessageChange
         case observeSystemPromptChange
         case observeExtraSystemPromptChange
+        case observeDefaultScopesChange
 
         case historyChanged
         case isReceivingMessageChanged
         case systemPromptChanged
         case extraSystemPromptChanged
+        case defaultScopesChanged
 
         case chatMenu(ChatMenu.Action)
     }
@@ -68,6 +70,7 @@ struct Chat: ReducerProtocol {
         case observeIsReceivingMessageChange(UUID)
         case observeSystemPromptChange(UUID)
         case observeExtraSystemPromptChange(UUID)
+        case observeDefaultScopesChange(UUID)
     }
 
     var body: some ReducerProtocol<State, Action> {
@@ -131,6 +134,7 @@ struct Chat: ReducerProtocol {
                     await send(.observeIsReceivingMessageChange)
                     await send(.observeSystemPromptChange)
                     await send(.observeExtraSystemPromptChange)
+                    await send(.observeDefaultScopesChange)
                 }
 
             case .observeHistoryChange:
@@ -198,6 +202,22 @@ struct Chat: ReducerProtocol {
                     }
                 }.cancellable(id: CancelID.observeExtraSystemPromptChange(id), cancelInFlight: true)
 
+            case .observeDefaultScopesChange:
+                return .run { send in
+                    let stream = AsyncStream<Void> { continuation in
+                        let cancellable = service.$defaultScopes
+                            .sink { _ in
+                                continuation.yield()
+                            }
+                        continuation.onTermination = { _ in
+                            cancellable.cancel()
+                        }
+                    }
+                    for await _ in stream {
+                        await send(.defaultScopesChanged)
+                    }
+                }.cancellable(id: CancelID.observeDefaultScopesChange(id), cancelInFlight: true)
+
             case .historyChanged:
                 state.history = service.chatHistory.map { message in
                     .init(
@@ -250,6 +270,10 @@ struct Chat: ReducerProtocol {
                 state.chatMenu.extraSystemPrompt = service.extraSystemPrompt
                 return .none
 
+            case .defaultScopesChanged:
+                state.chatMenu.defaultScopes = service.defaultScopes
+                return .none
+
             case .binding:
                 return .none
 
@@ -266,6 +290,7 @@ struct ChatMenu: ReducerProtocol {
         var extraSystemPrompt: String = ""
         var temperatureOverride: Double? = nil
         var chatModelIdOverride: String? = nil
+        var defaultScopes: Set<ChatService.Scope> = []
     }
 
     enum Action: Equatable {
@@ -274,6 +299,8 @@ struct ChatMenu: ReducerProtocol {
         case temperatureOverrideSelected(Double?)
         case chatModelIdOverrideSelected(String?)
         case customCommandButtonTapped(CustomCommand)
+        case resetDefaultScopesButtonTapped
+        case toggleScope(ChatService.Scope)
     }
 
     let service: ChatService
@@ -304,6 +331,15 @@ struct ChatMenu: ReducerProtocol {
                 return .run { _ in
                     try await service.handleCustomCommand(command)
                 }
+
+            case .resetDefaultScopesButtonTapped:
+                return .run { _ in
+                    service.resetDefaultScopes()
+                }
+            case let .toggleScope(scope):
+                return .run { _ in
+                    service.defaultScopes.formSymmetricDifference([scope])
+                }
             }
         }
     }

Core/Sources/ChatGPTChatTab/ChatContextMenu.swift

@@ -1,4 +1,5 @@
 import AppKit
+import ChatService
 import ComposableArchitecture
 import SharedUIComponents
 import SwiftUI
@@ -30,6 +31,7 @@ struct ChatContextMenu: View {
 
         chatModel
         temperature
+        defaultScopes
 
         Divider()
 
@@ -153,6 +155,34 @@ struct ChatContextMenu: View {
         }
     }
 
+    @ViewBuilder
+    var defaultScopes: some View {
+        Menu("Default Scopes") {
+            WithViewStore(store, observe: \.defaultScopes) { viewStore in
+                Button(action: {
+                    store.send(.resetDefaultScopesButtonTapped)
+                }) {
+                    Text("Reset Default Scopes")
+                }
+
+                Divider()
+
+                ForEach(ChatService.Scope.allCases, id: \.rawValue) { value in
+                    Button(action: {
+                        viewStore.send(.toggleScope(value))
+                    }) {
+                        HStack {
+                            Text("@" + value.rawValue)
+                            if viewStore.state.contains(value) {
+                                Image(systemName: "checkmark")
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+
     var customCommandMenu: some View {
         Menu("Custom Commands") {
             ForEach(

Core/Sources/ChatGPTChatTab/ChatGPTChatTab.swift

@@ -1,5 +1,7 @@
+import ChatContextCollector
 import ChatService
 import ChatTab
+import CodableWrappers
 import Combine
 import ComposableArchitecture
 import Foundation
@@ -21,6 +23,7 @@ public class ChatGPTChatTab: ChatTab {
         var configuration: OverridingChatGPTConfiguration.Overriding
         var systemPrompt: String
         var extraSystemPrompt: String
+        var defaultScopes: Set<ChatContext.Scope>?
     }
 
     struct Builder: ChatTabBuilder {
@@ -65,7 +68,8 @@ public class ChatGPTChatTab: ChatTab {
             history: await service.memory.history,
             configuration: service.configuration.overriding,
             systemPrompt: service.systemPrompt,
-            extraSystemPrompt: service.extraSystemPrompt
+            extraSystemPrompt: service.extraSystemPrompt,
+            defaultScopes: service.defaultScopes
         )
         return (try? JSONEncoder().encode(state)) ?? Data()
     }
@@ -79,6 +83,9 @@ public class ChatGPTChatTab: ChatTab {
             tab.service.configuration.overriding = state.configuration
             tab.service.mutateSystemPrompt(state.systemPrompt)
             tab.service.mutateExtraSystemPrompt(state.extraSystemPrompt)
+            if let scopes = state.defaultScopes {
+                tab.service.defaultScopes = scopes
+            }
             await tab.service.memory.mutateHistory { history in
                 history = state.history
             }

Core/Sources/ChatGPTChatTab/ChatPanel.swift

@@ -54,7 +54,7 @@ struct ChatPanelMessages: View {
                     Group {
                         Spacer(minLength: 12)
 
-                        Instruction()
+                        Instruction(chat: chat)
 
                         ChatHistory(chat: chat)
                             .listItemTint(.clear)
@@ -225,8 +225,7 @@ private struct StopRespondingButton: View {
 }
 
 private struct Instruction: View {
-    @AppStorage(\.useCodeScopeByDefaultInChatContext)
-    var useCodeScopeByDefaultInChatContext
+    let chat: StoreOf<Chat>
 
     var body: some View {
         Group {
@@ -255,8 +254,9 @@ private struct Instruction: View {
                 | --- | --- |
                 | `@file` | Read the metadata of the editing file |
                 | `@code` | Read the code and metadata in the editing file |
-                | `@web` (beta) | Search on Bing or query from a web page |
+                | `@sense`| Experimental. Read the relevant code of the focused editor |
                 | `@project` | Experimental. Access content of the project |
+                | `@web` (beta) | Search on Bing or query from a web page |
 
                 To use scopes, you can prefix a message with `@code`.
 
@@ -265,18 +265,24 @@ private struct Instruction: View {
             )
             .modifier(InstructionModifier())
 
-            Markdown(
-                """
-                Hello, I am your AI programming assistant. I can identify issues, explain and even improve code.
+            WithViewStore(chat, observe: \.chatMenu.defaultScopes) { viewStore in
+                Markdown(
+                    """
+                    Hello, I am your AI programming assistant. I can identify issues, explain and even improve code.
 
-                \(
-                    useCodeScopeByDefaultInChatContext
-                        ? "Scope **`@code`** is enabled by default."
-                        : "Scope **`@file`** is enabled by default."
+                    \({
+                        if viewStore.state.isEmpty {
+                            return "No scope is enabled by default"
+                        } else {
+                            let scopes = viewStore.state.map(\.rawValue).sorted()
+                                .joined(separator: ", ")
+                            return "Default scopes: `\(scopes)`"
+                        }
+                    }())
+                    """
                 )
-                """
-            )
-            .modifier(InstructionModifier())
+                .modifier(InstructionModifier())
+            }
         }
     }
 

Core/Sources/ChatService/ChatService.swift

@@ -6,6 +6,8 @@ import OpenAIService
 import Preferences
 
 public final class ChatService: ObservableObject {
+    public typealias Scope = ChatContext.Scope
+    
     public let memory: ContextAwareAutoManagedChatGPTMemory
     public let configuration: OverridingChatGPTConfiguration
     public let chatGPTService: any ChatGPTServiceType
@@ -15,6 +17,7 @@ public final class ChatService: ObservableObject {
     @Published public internal(set) var systemPrompt = UserDefaults.shared
         .value(for: \.defaultChatSystemPrompt)
     @Published public internal(set) var extraSystemPrompt = ""
+    @Published public var defaultScopes = Set<Scope>()
 
     let pluginController: ChatPluginController
     var cancellable = Set<AnyCancellable>()
@@ -37,20 +40,22 @@ public final class ChatService: ObservableObject {
 
     public convenience init() {
         let configuration = UserPreferenceChatGPTConfiguration().overriding()
+        /// Used by context collector
+        let extraConfiguration = configuration.overriding()
         let memory = ContextAwareAutoManagedChatGPTMemory(
-            configuration: configuration,
+            configuration: extraConfiguration,
             functionProvider: ChatFunctionProvider()
         )
         self.init(
             memory: memory,
             configuration: configuration,
             chatGPTService: ChatGPTService(
                 memory: memory,
-                configuration: configuration,
+                configuration: extraConfiguration,
                 functionProvider: memory.functionProvider
             )
         )
-        
+
         resetDefaultScopes()
 
         memory.chatService = self
@@ -60,20 +65,38 @@ public final class ChatService: ObservableObject {
             }
         }
     }
-    
+
     public func resetDefaultScopes() {
-        if UserDefaults.shared.value(for: \.useCodeScopeByDefaultInChatContext) {
-            memory.contextController.defaultScopes = ["code"]
-        } else {
-            memory.contextController.defaultScopes = ["file"]
+        var scopes = Set<Scope>()
+        if UserDefaults.shared.value(for: \.enableFileScopeByDefaultInChatContext) {
+            scopes.insert(.file)
+        }
+
+        if UserDefaults.shared.value(for: \.enableCodeScopeByDefaultInChatContext) {
+            scopes.insert(.code)
         }
+
+        if UserDefaults.shared.value(for: \.enableProjectScopeByDefaultInChatContext) {
+            scopes.insert(.project)
+        }
+
+        if UserDefaults.shared.value(for: \.enableSenseScopeByDefaultInChatContext) {
+            scopes.insert(.sense)
+        }
+
+        if UserDefaults.shared.value(for: \.enableWebScopeByDefaultInChatContext) {
+            scopes.insert(.web)
+        }
+        
+        defaultScopes = scopes
     }
 
     public func send(content: String) async throws {
+        memory.contextController.defaultScopes = defaultScopes
         guard !isReceivingMessage else { throw CancellationError() }
         let handledInPlugin = try await pluginController.handleContent(content)
         if handledInPlugin { return }
-       
+
         let stream = try await chatGPTService.send(content: content, summary: nil)
         isReceivingMessage = true
         do {
@@ -115,7 +138,6 @@ public final class ChatService: ObservableObject {
     public func resetPrompt() async {
         systemPrompt = UserDefaults.shared.value(for: \.defaultChatSystemPrompt)
         extraSystemPrompt = ""
-        resetDefaultScopes()
     }
 
     public func deleteMessage(id: String) async {