Adjust real-time suggestions

Author: intitni

Core/Sources/CopilotService/CopilotService.swift

@@ -72,7 +72,6 @@ public class CopilotBaseService {
             let localServer = CopilotLocalProcessServer(executionParameters: executionParams)
             localServer.logMessages = false
             localServer.notificationHandler = { notification, respond in
-                print(notification)
                 respond(.timeout)
             }
             let server = InitializingServer(server: localServer)

Core/Sources/Service/RealtimeSuggestionController.swift

@@ -18,6 +18,7 @@ public actor RealtimeSuggestionController {
     ])
     private var task: Task<Void, Error>?
     private var inflightPrefetchTask: Task<Void, Error>?
+    private var ignoreUntil = Date(timeIntervalSince1970: 0)
     let realtimeSuggestionIndicatorController = RealtimeSuggestionIndicatorController()
 
     private init() {
@@ -81,27 +82,13 @@ public actor RealtimeSuggestionController {
     }
 
     func handleKeyboardEvent(event: CGEvent) async {
-        inflightPrefetchTask?.cancel()
+        await cancelInFlightTasks()
 
         if Task.isCancelled { return }
         guard await Environment.isXcodeActive() else { return }
 
-        // cancel in-flight tasks
-        await withTaskGroup(of: Void.self) { group in
-            for (_, workspace) in await workspaces {
-                group.addTask {
-                    await workspace.cancelInFlightRealtimeSuggestionRequests()
-                }
-            }
-            group.addTask {
-                await { @ServiceActor in
-                    inflightRealtimeSuggestionsTasks.forEach { $0.cancel() }
-                    inflightRealtimeSuggestionsTasks.removeAll()
-                }()
-            }
-        }
-
         let escape = 0x35
+        let arrowKeys = [0x7B, 0x7C, 0x7D, 0x7E]
         let isEditing = await Environment.frontmostXcodeWindowIsEditor()
 
         // if Xcode suggestion panel is presenting, and we are not trying to close it
@@ -111,22 +98,29 @@ public actor RealtimeSuggestionController {
         }
 
         let shouldTrigger = {
+            let code = Int(event.getIntegerValueField(.keyboardEventKeycode))
             // closing auto-complete panel
-            if isEditing, event.getIntegerValueField(.keyboardEventKeycode) == escape {
+            if isEditing, code == escape {
                 return true
             }
+            
+            // escape and arrows to cancel
 
-            // normally typing
-            if event.type == .keyUp,
-               event.getIntegerValueField(.keyboardEventKeycode) != escape
-            {
-                return true
+            if code == escape {
+                return false
             }
+            
+            if arrowKeys.contains(code) {
+                return false
+            }
+
+            // normally typing
 
-            return false
+            return event.type == .keyUp
         }()
 
         guard shouldTrigger else { return }
+        guard Date().timeIntervalSince(ignoreUntil) > 0 else { return }
 
         inflightPrefetchTask = Task { @ServiceActor in
             try? await Task.sleep(nanoseconds: UInt64((
@@ -146,6 +140,31 @@ public actor RealtimeSuggestionController {
             }
         }
     }
+
+    func cancelInFlightTasks() async {
+        inflightPrefetchTask?.cancel()
+
+        // cancel in-flight tasks
+        await withTaskGroup(of: Void.self) { group in
+            for (_, workspace) in await workspaces {
+                group.addTask {
+                    await workspace.cancelInFlightRealtimeSuggestionRequests()
+                }
+            }
+            group.addTask {
+                await { @ServiceActor in
+                    inflightRealtimeSuggestionsTasks.forEach { $0.cancel() }
+                    inflightRealtimeSuggestionsTasks.removeAll()
+                }()
+            }
+        }
+    }
+
+    /// Prevent prefetch to be triggered by commands. Quick and dirty.
+    func cancelInFlightTasksAndIgnoreTriggerForAWhile() async {
+        ignoreUntil = Date(timeIntervalSinceNow: 5)
+        await cancelInFlightTasks()
+    }
 }
 
 /// Present a tiny dot next to mouse cursor if real-time suggestion is enabled.

Core/Sources/Service/XPCService.swift

@@ -19,7 +19,8 @@ public class XPCService: NSObject, XPCServiceProtocol {
     public func getXPCServiceVersion(withReply reply: @escaping (String, String) -> Void) {
         reply(
             Bundle.main.infoDictionary?["CFBundleShortVersionString"] as? String ?? "N/A",
-            Bundle.main.infoDictionary?["CFBundleVersion"] as? String ?? "N/A")
+            Bundle.main.infoDictionary?["CFBundleVersion"] as? String ?? "N/A"
+        )
     }
 
     @ServiceActor
@@ -88,6 +89,7 @@ public class XPCService: NSObject, XPCServiceProtocol {
         withReply reply: @escaping (Data?, Error?) -> Void
     ) {
         Task { @ServiceActor in
+            await RealtimeSuggestionController.shared.cancelInFlightTasksAndIgnoreTriggerForAWhile()
             do {
                 let editor = try JSONDecoder().decode(EditorContent.self, from: editorContent)
                 let fileURL = try await Environment.fetchCurrentFileURL()
@@ -118,6 +120,7 @@ public class XPCService: NSObject, XPCServiceProtocol {
         withReply reply: @escaping (Data?, Error?) -> Void
     ) {
         Task { @ServiceActor in
+            await RealtimeSuggestionController.shared.cancelInFlightTasksAndIgnoreTriggerForAWhile()
             do {
                 let editor = try JSONDecoder().decode(EditorContent.self, from: editorContent)
                 let fileURL = try await Environment.fetchCurrentFileURL()
@@ -145,6 +148,7 @@ public class XPCService: NSObject, XPCServiceProtocol {
         withReply reply: @escaping (Data?, Error?) -> Void
     ) {
         Task { @ServiceActor in
+            await RealtimeSuggestionController.shared.cancelInFlightTasksAndIgnoreTriggerForAWhile()
             do {
                 let editor = try JSONDecoder().decode(EditorContent.self, from: editorContent)
                 let fileURL = try await Environment.fetchCurrentFileURL()
@@ -172,6 +176,7 @@ public class XPCService: NSObject, XPCServiceProtocol {
         withReply reply: @escaping (Data?, Error?) -> Void
     ) {
         Task { @ServiceActor in
+            await RealtimeSuggestionController.shared.cancelInFlightTasksAndIgnoreTriggerForAWhile()
             do {
                 let editor = try JSONDecoder().decode(EditorContent.self, from: editorContent)
                 let fileURL = try await Environment.fetchCurrentFileURL()
@@ -196,6 +201,7 @@ public class XPCService: NSObject, XPCServiceProtocol {
         withReply reply: @escaping (Data?, Error?) -> Void
     ) {
         Task { @ServiceActor in
+            await RealtimeSuggestionController.shared.cancelInFlightTasksAndIgnoreTriggerForAWhile()
             do {
                 let editor = try JSONDecoder().decode(EditorContent.self, from: editorContent)
                 let fileURL = try await Environment.fetchCurrentFileURL()
@@ -250,7 +256,7 @@ public class XPCService: NSObject, XPCServiceProtocol {
                 reply(nil, NSError.from(error))
             }
         }
-        
+
         Task { @ServiceActor in inflightRealtimeSuggestionsTasks.insert(task) }
     }
 
@@ -260,6 +266,7 @@ public class XPCService: NSObject, XPCServiceProtocol {
             return
         }
         Task { @ServiceActor in
+            await RealtimeSuggestionController.shared.cancelInFlightTasksAndIgnoreTriggerForAWhile()
             UserDefaults.shared.set(
                 !UserDefaults.shared.bool(forKey: SettingsKey.realtimeSuggestionToggle),
                 forKey: SettingsKey.realtimeSuggestionToggle
@@ -293,7 +300,7 @@ public class XPCService: NSObject, XPCServiceProtocol {
                 reply()
             }
         }
-        
+
         Task { @ServiceActor in inflightRealtimeSuggestionsTasks.insert(task) }
     }
 }