Merge branch 'feature/keyword-base-retrieval' into develop

Author: intitni

Core/Sources/HostApp/DebugView.swift

@@ -16,6 +16,7 @@ final class DebugSettings: ObservableObject {
     var disableGitHubCopilotSettingsAutoRefreshOnAppear
     @AppStorage(\.useUserDefaultsBaseAPIKeychain) var useUserDefaultsBaseAPIKeychain
     @AppStorage(\.disableEnhancedWorkspace) var disableEnhancedWorkspace
+    @AppStorage(\.disableGitIgnoreCheck) var disableGitIgnoreCheck
     init() {}
 }
 
@@ -64,6 +65,10 @@ struct DebugSettingsView: View {
                         Text("Disable Enhanced Workspace")
                     }
 
+                    Toggle(isOn: $settings.disableGitIgnoreCheck) {
+                        Text("Disable Git Ignore Check")
+                    }
+                    
                     Button("Reset Migration Version to 0") {
                         UserDefaults.shared.set(nil, forKey: "OldMigrationVersion")
                     }

Pro

@@ -42,6 +42,7 @@ let package = Package(
                 "AppActivator",
             ]
         ),
+        .library(name: "GitIgnoreCheck", targets: ["GitIgnoreCheck"]),
     ],
     dependencies: [
         // A fork of https://github.com/aespinilla/Tiktoken to allow loading from local files.
@@ -202,6 +203,7 @@ let package = Package(
         .target(
             name: "Workspace",
             dependencies: [
+                "GitIgnoreCheck",
                 "UserDefaultsObserver",
                 "SuggestionModel",
                 "Environment",
@@ -235,6 +237,18 @@ let package = Package(
             dependencies: ["FocusedCodeFinder"]
         ),
 
+        .target(
+            name: "GitIgnoreCheck",
+            dependencies: [
+                "Terminal",
+                "Preferences",
+                .product(
+                    name: "ComposableArchitecture",
+                    package: "swift-composable-architecture"
+                ),
+            ]
+        ),
+
         // MARK: - Services
 
         .target(
@@ -302,7 +316,7 @@ let package = Package(
                 .product(
                     name: "ComposableArchitecture",
                     package: "swift-composable-architecture"
-                )
+                ),
             ]
         ),
         .testTarget(
@@ -312,7 +326,7 @@ let package = Package(
                 .product(
                     name: "ComposableArchitecture",
                     package: "swift-composable-architecture"
-                )
+                ),
             ]
         ),
 
@@ -344,6 +358,7 @@ let package = Package(
                 "Preferences",
                 "FocusedCodeFinder",
                 "XcodeInspector",
+                "GitIgnoreCheck",
             ],
             path: "Sources/ChatContextCollectors/ActiveDocumentChatContextCollector"
         ),

Tool/Package.swift

@@ -1,7 +1,9 @@
 import ASTParser
 import ChatContextCollector
+import Dependencies
 import FocusedCodeFinder
 import Foundation
+import GitIgnoreCheck
 import OpenAIService
 import Preferences
 import SuggestionModel
@@ -12,22 +14,27 @@ public final class ActiveDocumentChatContextCollector: ChatContextCollector {
 
     public var activeDocumentContext: ActiveDocumentContext?
 
+    @Dependency(\.gitIgnoredChecker) var gitIgnoredChecker
+
     public func generateContext(
         history: [ChatMessage],
         scopes: Set<ChatContext.Scope>,
         content: String,
         configuration: ChatGPTConfiguration
-    ) -> ChatContext {
+    ) async -> ChatContext {
         guard let info = getEditorInformation() else { return .empty }
         let context = getActiveDocumentContext(info)
         activeDocumentContext = context
 
-        guard scopes.contains(.code) else {
+        let isSensitive = await gitIgnoredChecker.checkIfGitIgnored(fileURL: info.documentURL)
+
+        guard scopes.contains(.code)
+        else {
             if scopes.contains(.file) {
                 var removedCode = context
                 removedCode.focusedContext = nil
                 return .init(
-                    systemPrompt: extractSystemPrompt(removedCode),
+                    systemPrompt: extractSystemPrompt(removedCode, isSensitive: isSensitive),
                     retrievedContent: [],
                     functions: []
                 )
@@ -37,36 +44,39 @@ public final class ActiveDocumentChatContextCollector: ChatContextCollector {
 
         var functions = [any ChatGPTFunction]()
 
-        // When the bot is already focusing on a piece of code, it can expand the range.
+        if !isSensitive {
+            // When the bot is already focusing on a piece of code, it can expand the range.
 
-        if context.focusedContext != nil {
-            functions.append(ExpandFocusRangeFunction(contextCollector: self))
-        }
+            if context.focusedContext != nil {
+                functions.append(ExpandFocusRangeFunction(contextCollector: self))
+            }
 
-        // When the bot is not focusing on any code, or the focusing area is not the user's
-        // selection, it can move the focus back to the user's selection.
+            // When the bot is not focusing on any code, or the focusing area is not the user's
+            // selection, it can move the focus back to the user's selection.
 
-        if context.focusedContext == nil ||
-            !(context.focusedContext?.codeRange.contains(context.selectionRange) ?? false)
-        {
-            functions.append(MoveToFocusedCodeFunction(contextCollector: self))
-        }
+            if context.focusedContext == nil ||
+                !(context.focusedContext?.codeRange.contains(context.selectionRange) ?? false)
+            {
+                functions.append(MoveToFocusedCodeFunction(contextCollector: self))
+            }
 
-        // When there is a line annotation not in the focused area, the bot can move the focus area
-        // to the code covering the line of the annotation.
+            // When there is a line annotation not in the focused area, the bot can move the focus
+            // area
+            // to the code covering the line of the annotation.
 
-        if let focusedContext = context.focusedContext,
-           !focusedContext.otherLineAnnotations.isEmpty
-        {
-            functions.append(MoveToCodeAroundLineFunction(contextCollector: self))
-        }
+            if let focusedContext = context.focusedContext,
+               !focusedContext.otherLineAnnotations.isEmpty
+            {
+                functions.append(MoveToCodeAroundLineFunction(contextCollector: self))
+            }
 
-        if context.focusedContext == nil, !context.lineAnnotations.isEmpty {
-            functions.append(MoveToCodeAroundLineFunction(contextCollector: self))
+            if context.focusedContext == nil, !context.lineAnnotations.isEmpty {
+                functions.append(MoveToCodeAroundLineFunction(contextCollector: self))
+            }
         }
 
         return .init(
-            systemPrompt: extractSystemPrompt(context),
+            systemPrompt: extractSystemPrompt(context, isSensitive: isSensitive),
             retrievedContent: [],
             functions: functions
         )
@@ -90,7 +100,7 @@ public final class ActiveDocumentChatContextCollector: ChatContextCollector {
         return activeDocumentContext
     }
 
-    func extractSystemPrompt(_ context: ActiveDocumentContext) -> String {
+    func extractSystemPrompt(_ context: ActiveDocumentContext, isSensitive: Bool) -> String {
         let start = """
         ## File and Code Scope
 
@@ -108,7 +118,7 @@ public final class ActiveDocumentChatContextCollector: ChatContextCollector {
         let language = "Language: \(context.language.rawValue)"
 
         if let focusedContext = context.focusedContext {
-            let codeContext = focusedContext.context.isEmpty
+            let codeContext = focusedContext.context.isEmpty || isSensitive
                 ? ""
                 : """
                 Focused Context:
@@ -119,14 +129,16 @@ public final class ActiveDocumentChatContextCollector: ChatContextCollector {
 
             let codeRange = "Focused Range [line, character]: \(focusedContext.codeRange)"
 
-            let code = """
-            Focused Code (start from line \(focusedContext.codeRange.start.line + 1)):
-            ```\(context.language.rawValue)
-            \(focusedContext.code)
-            ```
-            """
+            let code = context.selectionRange.isEmpty && isSensitive
+                ? ""
+                : """
+                Focused Code (start from line \(focusedContext.codeRange.start.line + 1)):
+                ```\(context.language.rawValue)
+                \(focusedContext.code)
+                ```
+                """
 
-            let fileAnnotations = focusedContext.otherLineAnnotations.isEmpty
+            let fileAnnotations = focusedContext.otherLineAnnotations.isEmpty || isSensitive
                 ? ""
                 : """
                 Other Annotations:\"""
@@ -139,7 +151,7 @@ public final class ActiveDocumentChatContextCollector: ChatContextCollector {
                 \"""
                 """
 
-            let codeAnnotations = focusedContext.lineAnnotations.isEmpty
+            let codeAnnotations = focusedContext.lineAnnotations.isEmpty || isSensitive
                 ? ""
                 : """
                 Annotations Inside Focused Range:\"""
@@ -165,7 +177,7 @@ public final class ActiveDocumentChatContextCollector: ChatContextCollector {
             .joined(separator: "\n\n")
         } else {
             let selectionRange = "Selection Range [line, character]: \(context.selectionRange)"
-            let lineAnnotations = context.lineAnnotations.isEmpty
+            let lineAnnotations = context.lineAnnotations.isEmpty || isSensitive
                 ? ""
                 : """
                 Line Annotations:\"""

Tool/Sources/ChatContextCollectors/ActiveDocumentChatContextCollector/ActiveDocumentChatContextCollector.swift

@@ -0,0 +1,104 @@
+import Dependencies
+import Foundation
+import Terminal
+import Preferences
+
+public struct CheckIfGitIgnoredDependencyKey: DependencyKey {
+    public static var liveValue: GitIgnoredChecker = DefaultGitIgnoredChecker()
+    public static var testValue: GitIgnoredChecker = DefaultGitIgnoredChecker(isTest: true)
+}
+
+public extension DependencyValues {
+    var gitIgnoredChecker: GitIgnoredChecker {
+        get { self[CheckIfGitIgnoredDependencyKey.self] }
+        set { self[CheckIfGitIgnoredDependencyKey.self] = newValue }
+    }
+}
+
+public protocol GitIgnoredChecker {
+    func checkIfGitIgnored(fileURL: URL) async -> Bool
+    func checkIfGitIgnored(fileURLs: [URL]) async -> [URL]
+}
+
+public extension GitIgnoredChecker {
+    func checkIfGitIgnored(filePath: String) async -> Bool {
+        await checkIfGitIgnored(fileURL: URL(fileURLWithPath: filePath))
+    }
+    
+    func checkIfGitIgnored(filePaths: [String]) async -> [String] {
+        await checkIfGitIgnored(fileURLs: filePaths.map { URL(fileURLWithPath: $0) })
+            .map(\.path)
+    }
+}
+
+public struct DefaultGitIgnoredChecker: GitIgnoredChecker {
+    var isTest = false
+    
+    var noCheck: Bool {
+        if isTest { return false }
+        return UserDefaults.shared.value(for: \.disableGitIgnoreCheck)
+    }
+    
+    public init() {}
+    
+    init(isTest: Bool) {
+        self.isTest = isTest
+    }
+    
+    public func checkIfGitIgnored(fileURL: URL) async -> Bool {
+        if noCheck { return false }
+        let terminal = Terminal()
+        guard let gitFolderURL = gitFolderURL(forFileURL: fileURL) else {
+            return false
+        }
+        do {
+            _ = try await terminal.runCommand(
+                "/bin/bash",
+                arguments: ["-c", "check-ignore \"\(fileURL.path)\""],
+                currentDirectoryPath: gitFolderURL.path,
+                environment: [:]
+            )
+            return true
+        } catch {
+            return false
+        }
+    }
+    
+    public func checkIfGitIgnored(fileURLs: [URL]) async -> [URL] {
+        if noCheck { return [] }
+        let filePaths = fileURLs.map { "\"\($0.path)\"" }.joined(separator: " ")
+        guard let firstFileURL = fileURLs.first else { return [] }
+        let terminal = Terminal()
+        guard let gitFolderURL = gitFolderURL(forFileURL: firstFileURL) else {
+            return []
+        }
+        do {
+            let result = try await terminal.runCommand(
+                "/bin/bash",
+                arguments: ["-c", "check-ignore \(filePaths)"],
+                currentDirectoryPath: gitFolderURL.path,
+                environment: [:]
+            )
+            return result
+                .split(separator: "\n")
+                .map(String.init)
+                .compactMap(URL.init(fileURLWithPath:))
+        } catch {
+            return []
+        }
+    }
+}
+
+func gitFolderURL(forFileURL fileURL: URL) -> URL? {
+    var currentURL = fileURL
+    let fileManager = FileManager.default
+    while currentURL.path != "/" {
+        let gitFolderURL = currentURL.appendingPathComponent(".git")
+        if fileManager.fileExists(atPath: gitFolderURL.path) {
+            return currentURL
+        }
+        currentURL = currentURL.deletingLastPathComponent()
+    }
+    return nil
+}
+

Tool/Sources/GitIgnoreCheck/GitIgnoreCheck.swift

@@ -546,6 +546,10 @@ public extension UserDefaultPreferenceKeys {
             key: "FeatureFlag-DisableGitHubCopilotSettingsAutoRefreshOnAppear"
         )
     }
+    
+    var disableGitIgnoreCheck: FeatureFlag {
+        .init(defaultValue: false, key: "FeatureFlag-DisableGitIgnoreCheck")
+    }
 
     var disableEnhancedWorkspace: FeatureFlag {
         .init(