Merge branch 'feature/passing-relevant-snippets-to-suggestion-service' into develop

Author: intitni

Copilot for Xcode.xcodeproj/project.pbxproj

@@ -448,7 +448,7 @@
 			isa = PBXProject;
 			attributes = {
 				BuildIndependentTargetsInParallel = 1;
-				LastSwiftUpdateCheck = 1420;
+				LastSwiftUpdateCheck = 1520;
 				LastUpgradeCheck = 1410;
 				TargetAttributes = {
 					C814588B2939EFDC00135263 = {

Core/Package.swift

@@ -89,7 +89,7 @@ let package = Package(
     ],
     dependencies: [
         .package(path: "../Tool"),
-        .package(url: "https://github.com/apple/swift-async-algorithms", from: "0.1.0"),
+        .package(url: "https://github.com/apple/swift-async-algorithms", from: "1.0.0"),
         .package(url: "https://github.com/gonzalezreal/swift-markdown-ui", from: "2.1.0"),
         .package(url: "https://github.com/sparkle-project/Sparkle", from: "2.0.0"),
         .package(url: "https://github.com/pointfreeco/swift-parsing", from: "0.12.1"),

Core/Sources/Service/RealtimeSuggestionController.swift

@@ -81,7 +81,7 @@ public actor RealtimeSuggestionController {
                     }
 
                     if #available(macOS 13.0, *) {
-                        for await _ in valueChange.throttle(for: .milliseconds(200)) {
+                        for await _ in valueChange._throttle(for: .milliseconds(200)) {
                             if Task.isCancelled { return }
                             await handler()
                         }
@@ -103,7 +103,7 @@ public actor RealtimeSuggestionController {
                     }
 
                     if #available(macOS 13.0, *) {
-                        for await _ in selectedTextChanged.throttle(for: .milliseconds(200)) {
+                        for await _ in selectedTextChanged._throttle(for: .milliseconds(200)) {
                             if Task.isCancelled { return }
                             await handler()
                         }

Core/Sources/SuggestionService/SuggestionService.swift

@@ -11,6 +11,10 @@ import ProExtension
 public protocol SuggestionServiceType: SuggestionServiceProvider {}
 
 public actor SuggestionService: SuggestionServiceType {
+    public var configuration: SuggestionServiceConfiguration {
+        get async { await suggestionProvider.configuration }
+    }
+
     var middlewares: [SuggestionServiceMiddleware] {
         SuggestionServiceMiddlewareContainer.middlewares
     }
@@ -50,7 +54,7 @@ public actor SuggestionService: SuggestionServiceType {
             return provider
         }
         #endif
-        
+
         switch serviceType {
         case .builtIn(.codeium):
             return CodeiumSuggestionProvider(
@@ -75,10 +79,15 @@ public extension SuggestionService {
         _ request: SuggestionRequest
     ) async throws -> [SuggestionModel.CodeSuggestion] {
         var getSuggestion = suggestionProvider.getSuggestions
+        let configuration = await configuration
 
         for middleware in middlewares.reversed() {
             getSuggestion = { [getSuggestion] request in
-                try await middleware.getSuggestion(request, next: getSuggestion)
+                try await middleware.getSuggestion(
+                    request,
+                    configuration: configuration,
+                    next: getSuggestion
+                )
             }
         }
 

Pro

@@ -52,7 +52,7 @@ let package = Package(
         // TODO: Update LanguageClient some day.
         .package(url: "https://github.com/ChimeHQ/LanguageClient", exact: "0.3.1"),
         .package(url: "https://github.com/ChimeHQ/LanguageServerProtocol", exact: "0.8.0"),
-        .package(url: "https://github.com/apple/swift-async-algorithms", from: "0.1.0"),
+        .package(url: "https://github.com/apple/swift-async-algorithms", from: "1.0.0"),
         .package(url: "https://github.com/pointfreeco/swift-parsing", from: "0.12.1"),
         .package(url: "https://github.com/ChimeHQ/JSONRPC", exact: "0.6.0"),
         .package(url: "https://github.com/scinfu/SwiftSoup.git", from: "2.6.0"),
@@ -66,6 +66,7 @@ let package = Package(
         .package(url: "https://github.com/GottaGetSwifty/CodableWrappers", from: "2.0.7"),
         .package(url: "https://github.com/krzyzanowskim/STTextView", from: "0.8.21"),
         .package(url: "https://github.com/google/generative-ai-swift", from: "0.4.4"),
+        .package(url: "https://github.com/intitni/CopilotForXcodeKit", from: "0.4.0"),
 
         // TreeSitter
         .package(url: "https://github.com/intitni/SwiftTreeSitter.git", branch: "main"),
@@ -279,6 +280,7 @@ let package = Package(
             "GitHubCopilotService",
             "CodeiumService",
             "UserDefaultsObserver",
+            .product(name: "CopilotForXcodeKit", package: "CopilotForXcodeKit"),
         ]),
 
         // MARK: - GitHub Copilot

Tool/Package.swift

@@ -43,6 +43,8 @@ private actor TimedDebounceFunction<Element> {
 
 public extension AsyncSequence {
     /// Debounce, but only if the value is received within a certain time frame.
+    ///
+    /// In the future when we drop macOS 12 support we should just use chunked from AsyncAlgorithms.
     func timedDebounce(
         for duration: TimeInterval
     ) -> AsyncThrowingStream<Element, Error> {

Tool/Sources/CustomAsyncAlgorithms/TimedDebounce.swift

@@ -4,6 +4,14 @@ import Preferences
 import SuggestionModel
 
 public actor CodeiumSuggestionProvider: SuggestionServiceProvider {
+    public nonisolated var configuration: SuggestionServiceConfiguration {
+        .init(
+            acceptsRelevantCodeSnippets: true,
+            mixRelevantCodeSnippetsInSource: true,
+            acceptsRelevantSnippetsFromOpenedFiles: false
+        )
+    }
+
     let projectRootURL: URL
     let onServiceLaunched: (SuggestionServiceProvider) -> Void
     var codeiumService: CodeiumSuggestionServiceType?

Tool/Sources/SuggestionProvider/CodeiumSuggestionProvider.swift

@@ -4,11 +4,22 @@ import Preferences
 import SuggestionModel
 
 public actor GitHubCopilotSuggestionProvider: SuggestionServiceProvider {
+    public nonisolated var configuration: SuggestionServiceConfiguration {
+        .init(
+            acceptsRelevantCodeSnippets: true,
+            mixRelevantCodeSnippetsInSource: true, 
+            acceptsRelevantSnippetsFromOpenedFiles: false
+        )
+    }
+
     let projectRootURL: URL
     let onServiceLaunched: (SuggestionServiceProvider) -> Void
     var gitHubCopilotService: GitHubCopilotSuggestionServiceType?
 
-    public init(projectRootURL: URL, onServiceLaunched: @escaping (SuggestionServiceProvider) -> Void) {
+    public init(
+        projectRootURL: URL,
+        onServiceLaunched: @escaping (SuggestionServiceProvider) -> Void
+    ) {
         self.projectRootURL = projectRootURL
         self.onServiceLaunched = onServiceLaunched
     }

Tool/Sources/SuggestionProvider/GitHubCopilotSuggestionProvider.swift

@@ -1,4 +1,5 @@
-import AppKit 
+import AppKit
+import struct CopilotForXcodeKit.SuggestionServiceConfiguration
 import Foundation
 import Preferences
 import SuggestionModel
@@ -13,7 +14,8 @@ public struct SuggestionRequest {
     public var tabSize: Int
     public var indentSize: Int
     public var usesTabsForIndentation: Bool
-    public var ignoreSpaceOnlySuggestions: Bool 
+    public var ignoreSpaceOnlySuggestions: Bool
+    public var relevantCodeSnippets: [RelevantCodeSnippet]
 
     public init(
         fileURL: URL,
@@ -24,7 +26,8 @@ public struct SuggestionRequest {
         tabSize: Int,
         indentSize: Int,
         usesTabsForIndentation: Bool,
-        ignoreSpaceOnlySuggestions: Bool
+        ignoreSpaceOnlySuggestions: Bool,
+        relevantCodeSnippets: [RelevantCodeSnippet]
     ) {
         self.fileURL = fileURL
         self.relativePath = relativePath
@@ -35,12 +38,24 @@ public struct SuggestionRequest {
         self.indentSize = indentSize
         self.usesTabsForIndentation = usesTabsForIndentation
         self.ignoreSpaceOnlySuggestions = ignoreSpaceOnlySuggestions
+        self.relevantCodeSnippets = relevantCodeSnippets
+    }
+}
+
+public struct RelevantCodeSnippet: Codable {
+    public var content: String
+    public var priority: Int
+    public var filePath: String
+
+    public init(content: String, priority: Int, filePath: String) {
+        self.content = content
+        self.priority = priority
+        self.filePath = filePath
     }
 }
 
 public protocol SuggestionServiceProvider {
     func getSuggestions(_ request: SuggestionRequest) async throws -> [CodeSuggestion]
-
     func notifyAccepted(_ suggestion: CodeSuggestion) async
     func notifyRejected(_ suggestions: [CodeSuggestion]) async
     func notifyOpenTextDocument(fileURL: URL, content: String) async throws
@@ -49,5 +64,8 @@ public protocol SuggestionServiceProvider {
     func notifySaveTextDocument(fileURL: URL) async throws
     func cancelRequest() async
     func terminate() async
+
+    var configuration: SuggestionServiceConfiguration { get async }
 }
 
+public typealias SuggestionServiceConfiguration = CopilotForXcodeKit.SuggestionServiceConfiguration