Move suggestion post processing to middleware

Author: intitni

Tool/Sources/CodeiumService/CodeiumService.swift

@@ -12,8 +12,7 @@ public protocol CodeiumSuggestionServiceType {
         cursorPosition: CursorPosition,
         tabSize: Int,
         indentSize: Int,
-        usesTabsForIndentation: Bool,
-        ignoreSpaceOnlySuggestions: Bool
+        usesTabsForIndentation: Bool
     ) async throws -> [CodeSuggestion]
     func notifyAccepted(_ suggestion: CodeSuggestion) async
     func notifyOpenTextDocument(fileURL: URL, content: String) async throws
@@ -227,8 +226,7 @@ extension CodeiumSuggestionService: CodeiumSuggestionServiceType {
         cursorPosition: CursorPosition,
         tabSize: Int,
         indentSize: Int,
-        usesTabsForIndentation: Bool,
-        ignoreSpaceOnlySuggestions: Bool
+        usesTabsForIndentation: Bool
     ) async throws -> [CodeSuggestion] {
         ongoingTasks.forEach { $0.cancel() }
         ongoingTasks.removeAll()
@@ -272,12 +270,7 @@ extension CodeiumSuggestionService: CodeiumSuggestionServiceType {
 
             try Task.checkCancellation()
 
-            return result.completionItems?.filter { item in
-                if ignoreSpaceOnlySuggestions {
-                    return !item.completion.text.allSatisfy { $0.isWhitespace || $0.isNewline }
-                }
-                return true
-            }.map { item in
+            return result.completionItems?.map { item in
                 CodeSuggestion(
                     id: item.completion.completionId,
                     text: item.completion.text,

Tool/Sources/GitHubCopilotService/GitHubCopilotService.swift

@@ -22,9 +22,7 @@ public protocol GitHubCopilotSuggestionServiceType {
         cursorPosition: CursorPosition,
         tabSize: Int,
         indentSize: Int,
-        usesTabsForIndentation: Bool,
-        ignoreSpaceOnlySuggestions: Bool,
-        ignoreTrailingNewLinesAndSpaces: Bool
+        usesTabsForIndentation: Bool
     ) async throws -> [CodeSuggestion]
     func notifyAccepted(_ completion: CodeSuggestion) async
     func notifyRejected(_ completions: [CodeSuggestion]) async
@@ -340,9 +338,7 @@ public final class GitHubCopilotSuggestionService: GitHubCopilotBaseService,
         cursorPosition: CursorPosition,
         tabSize: Int,
         indentSize: Int,
-        usesTabsForIndentation: Bool,
-        ignoreSpaceOnlySuggestions: Bool,
-        ignoreTrailingNewLinesAndSpaces: Bool
+        usesTabsForIndentation: Bool
     ) async throws -> [CodeSuggestion] {
         let languageId = languageIdentifierFromFileURL(fileURL)
 
@@ -379,28 +375,13 @@ public final class GitHubCopilotSuggestionService: GitHubCopilotBaseService,
                     position: cursorPosition
                 )))
                 .completions
-                .filter { completion in
-                    if ignoreSpaceOnlySuggestions {
-                        return !completion.text.allSatisfy { $0.isWhitespace || $0.isNewline }
-                    }
-                    return true
-                }
                 .map {
                     let suggestion = CodeSuggestion(
                         id: $0.uuid,
                         text: $0.text,
                         position: $0.position,
                         range: $0.range
                     )
-                    if ignoreTrailingNewLinesAndSpaces {
-                        var updated = suggestion
-                        var text = updated.text[...]
-                        while let last = text.last, last.isNewline || last.isWhitespace {
-                            text = text.dropLast(1)
-                        }
-                        updated.text = String(text)
-                        return updated
-                    }
                     return suggestion
                 }
             try Task.checkCancellation()

Tool/Sources/SuggestionProvider/CodeiumSuggestionProvider.swift

@@ -48,8 +48,7 @@ public extension CodeiumSuggestionProvider {
             cursorPosition: request.cursorPosition,
             tabSize: request.tabSize,
             indentSize: request.indentSize,
-            usesTabsForIndentation: request.usesTabsForIndentation,
-            ignoreSpaceOnlySuggestions: request.ignoreSpaceOnlySuggestions
+            usesTabsForIndentation: request.usesTabsForIndentation
         )
     }
 

Tool/Sources/SuggestionProvider/GitHubCopilotSuggestionProvider.swift

@@ -46,10 +46,7 @@ public extension GitHubCopilotSuggestionProvider {
             cursorPosition: request.cursorPosition,
             tabSize: request.tabSize,
             indentSize: request.indentSize,
-            usesTabsForIndentation: request.usesTabsForIndentation,
-            ignoreSpaceOnlySuggestions: request.ignoreSpaceOnlySuggestions,
-            ignoreTrailingNewLinesAndSpaces: UserDefaults.shared
-                .value(for: \.gitHubCopilotIgnoreTrailingNewLines)
+            usesTabsForIndentation: request.usesTabsForIndentation
         )
     }
 

Tool/Sources/SuggestionProvider/PostProcessingSuggestionServiceMiddleware.swift

@@ -0,0 +1,29 @@
+import Foundation
+import SuggestionModel
+
+public struct PostProcessingSuggestionServiceMiddleware: SuggestionServiceMiddleware {
+    public init() {}
+
+    public func getSuggestion(
+        _ request: SuggestionRequest,
+        configuration: SuggestionServiceConfiguration,
+        next: Next
+    ) async throws -> [CodeSuggestion] {
+        let suggestions = try await next(request)
+        
+        return suggestions.compactMap {
+            var suggestion = $0
+            Self.removeTrailingWhitespacesAndNewlines(&suggestion)
+            if suggestion.text.isEmpty { return nil }
+            return suggestion
+        }
+    }
+    
+    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)
+    }
+}

Tool/Sources/SuggestionProvider/SuggestionProvider.swift

@@ -15,7 +15,6 @@ public struct SuggestionRequest {
     public var tabSize: Int
     public var indentSize: Int
     public var usesTabsForIndentation: Bool
-    public var ignoreSpaceOnlySuggestions: Bool
     public var relevantCodeSnippets: [RelevantCodeSnippet]
 
     public init(
@@ -28,7 +27,6 @@ public struct SuggestionRequest {
         tabSize: Int,
         indentSize: Int,
         usesTabsForIndentation: Bool,
-        ignoreSpaceOnlySuggestions: Bool,
         relevantCodeSnippets: [RelevantCodeSnippet]
     ) {
         self.fileURL = fileURL
@@ -40,7 +38,6 @@ public struct SuggestionRequest {
         self.tabSize = tabSize
         self.indentSize = indentSize
         self.usesTabsForIndentation = usesTabsForIndentation
-        self.ignoreSpaceOnlySuggestions = ignoreSpaceOnlySuggestions
         self.relevantCodeSnippets = relevantCodeSnippets
     }
 }

Tool/Sources/SuggestionProvider/SuggestionServiceMiddleware.swift

@@ -15,6 +15,7 @@ public protocol SuggestionServiceMiddleware {
 public enum SuggestionServiceMiddlewareContainer {
     static var builtInMiddlewares: [SuggestionServiceMiddleware] = [
         DisabledLanguageSuggestionServiceMiddleware(),
+        PostProcessingSuggestionServiceMiddleware()
     ]
 
     static var customMiddlewares: [SuggestionServiceMiddleware] = []

Tool/Sources/WorkspaceSuggestionService/Workspace+SuggestionService.swift

@@ -65,7 +65,6 @@ public extension Workspace {
                 tabSize: editor.tabSize,
                 indentSize: editor.indentSize,
                 usesTabsForIndentation: editor.usesTabsForIndentation,
-                ignoreSpaceOnlySuggestions: true, 
                 relevantCodeSnippets: []
             )
         )