Add SuggestionServiceEventHandler

Author: intitni

Core/Sources/SuggestionService/SuggestionService.swift

@@ -17,8 +17,8 @@ import ProExtension
 public protocol SuggestionServiceType: SuggestionServiceProvider {}
 
 public actor SuggestionService: SuggestionServiceType {
-    typealias Middleware = SuggestionServiceMiddleware
-    typealias EventHandler = SuggestionServiceEventHandler
+    public typealias Middleware = SuggestionServiceMiddleware
+    public typealias EventHandler = SuggestionServiceEventHandler
     public var configuration: SuggestionProvider.SuggestionServiceConfiguration {
         get async { await suggestionProvider.configuration }
     }

Tool/Sources/SuggestionBasic/CodeSuggestion.swift

@@ -6,13 +6,16 @@ public struct CodeSuggestion: Codable, Equatable {
         id: String,
         text: String,
         position: CursorPosition,
-        range: CursorRange
+        range: CursorRange,
+        middlewareComments: [String] = [],
+        metadata: [String: String] = [:]
     ) {
         self.text = text
         self.position = position
         self.id = id
         self.range = range
-        middlewareComments = []
+        self.middlewareComments = middlewareComments
+        self.metadata = metadata
     }
 
     public static func == (lhs: CodeSuggestion, rhs: CodeSuggestion) -> Bool {
@@ -32,5 +35,7 @@ public struct CodeSuggestion: Codable, Equatable {
     public var range: CursorRange
     /// A place to store comments inserted by middleware for debugging use.
     @FallbackDecoding<EmptyArray> public var middlewareComments: [String]
+    /// A place to store extra data.
+    @FallbackDecoding<EmptyDictionary> public var metadata: [String: String]
 }
 

Tool/Sources/SuggestionProvider/PostProcessingSuggestionServiceMiddleware.swift

@@ -21,11 +21,7 @@ public struct PostProcessingSuggestionServiceMiddleware: SuggestionServiceMiddle
     }
 
     static func removeTrailingWhitespacesAndNewlines(_ suggestion: inout CodeSuggestion) {
-        var text = suggestion.text[...]
-        while let last = text.last, last.isNewline || last.isWhitespace {
-            text = text.dropLast(1)
-        }
-        suggestion.text = String(text)
+        suggestion.text = suggestion.text.removedTrailingWhitespacesAndNewlines()
     }
 
     static func checkIfSuggestionHasNoEffect(

Tool/Sources/SuggestionProvider/String+Extension.swift

@@ -0,0 +1,11 @@
+import Foundation
+
+public extension String {
+    func removedTrailingWhitespacesAndNewlines() -> String {
+        var text = self[...]
+        while let last = text.last, last.isNewline || last.isWhitespace {
+            text = text.dropLast(1)
+        }
+        return String(text)
+    }
+}

Tool/Sources/SuggestionProvider/SuggestionServiceEventHandler.swift

@@ -1,10 +1,10 @@
+import CopilotForXcodeKit
 import Foundation
 import SuggestionBasic
-import CopilotForXcodeKit
 
 public protocol SuggestionServiceEventHandler {
-    func didAccept(_ suggestion: CodeSuggestion, workspaceInfo: WorkspaceInfo)
-    func didReject(_ suggestion: CodeSuggestion, workspaceInfo: WorkspaceInfo)
+    func didAccept(_ suggestion: SuggestionBasic.CodeSuggestion, workspaceInfo: WorkspaceInfo)
+    func didReject(_ suggestions: [SuggestionBasic.CodeSuggestion], workspaceInfo: WorkspaceInfo)
 }
 
 public enum SuggestionServiceEventHandlerContainer {
@@ -19,4 +19,9 @@ public enum SuggestionServiceEventHandlerContainer {
     public static func addHandler(_ handler: SuggestionServiceEventHandler) {
         customHandlers.append(handler)
     }
+
+    public static func addHandlers(_ handlers: [SuggestionServiceEventHandler]) {
+        customHandlers.append(contentsOf: handlers)
+    }
 }
+

Tool/Sources/SuggestionProvider/SuggestionServiceMiddleware.swift

@@ -27,6 +27,10 @@ public enum SuggestionServiceMiddlewareContainer {
     public static func addMiddleware(_ middleware: SuggestionServiceMiddleware) {
         customMiddlewares.append(middleware)
     }
+    
+    public static func addMiddlewares(_ middlewares: [SuggestionServiceMiddleware]) {
+        customMiddlewares.append(contentsOf: middlewares)
+    }
 }
 
 public struct DisabledLanguageSuggestionServiceMiddleware: SuggestionServiceMiddleware {