Merge tag 'tweak-caching' into develop

Author: intitni

Copilot for Xcode/DebugView.swift

@@ -5,6 +5,8 @@ import SwiftUI
 final class DebugSettings: ObservableObject {
     @AppStorage(\.disableLazyVStack)
     var disableLazyVStack: Bool
+    @AppStorage(\.preCacheOnFileOpen)
+    var preCacheOnFileOpen: Bool
     init() {}
 }
 
@@ -18,6 +20,10 @@ struct DebugSettingsView: View {
                     Text("Disable LazyVStack")
                 }
                 .toggleStyle(.switch)
+                Toggle(isOn: $settings.preCacheOnFileOpen) {
+                    Text("Cache editor information on file open")
+                }
+                .toggleStyle(.switch)
             }
         }.buttonStyle(.copilot)
     }

Core/Sources/AXExtension/AXUIElement.swift

@@ -11,6 +11,10 @@ public extension AXUIElement {
     var value: String {
         (try? copyValue(key: kAXValueAttribute)) ?? ""
     }
+    
+    var doubleValue: Double {
+        (try? copyValue(key: kAXValueAttribute)) ?? 0.0
+    }
 
     var document: String? {
         try? copyValue(key: kAXDocumentAttribute)
@@ -19,6 +23,10 @@ public extension AXUIElement {
     var description: String {
         (try? copyValue(key: kAXDescriptionAttribute)) ?? ""
     }
+    
+    var isSourceEditor: Bool {
+        description == "Source Editor"
+    }
 
     var selectedTextRange: Range<Int>? {
         guard let value: AXValue = try? copyValue(key: kAXSelectedTextRangeAttribute)

Core/Sources/Preferences/Keys.swift

@@ -153,11 +153,17 @@ public struct UserDefaultPreferenceKeys {
     }
 
     public var disableLazyVStack: FeatureFlags.DisableLazyVStack { .init() }
+    public var preCacheOnFileOpen: FeatureFlags.PreCacheOnFileOpen { .init() }
 }
 
 public enum FeatureFlags {
     public struct DisableLazyVStack: UserDefaultPreferenceKey {
         public let defaultValue = false
         public let key = "FeatureFlag-DisableLazyVStack"
     }
+    
+    public struct PreCacheOnFileOpen: UserDefaultPreferenceKey {
+        public let defaultValue = true
+        public let key = "FeatureFlag-PreCacheOnFileOpen"
+    }
 }

Core/Sources/Service/RealtimeSuggestionController.swift

@@ -25,6 +25,7 @@ public class RealtimeSuggestionController {
     private var activeApplicationMonitorTask: Task<Void, Error>?
     private var editorObservationTask: Task<Void, Error>?
     private var focusedUIElement: AXUIElement?
+    private var sourceEditor: AXUIElement?
 
     var isCommentMode: Bool {
         UserDefaults.shared.value(for: \.suggestionPresentationMode) == .comment
@@ -108,8 +109,9 @@ public class RealtimeSuggestionController {
         let application = AXUIElementCreateApplication(activeXcode.processIdentifier)
         guard let focusElement = application.focusedElement else { return }
         let focusElementType = focusElement.description
-        guard focusElementType == "Source Editor" else { return }
         focusedUIElement = focusElement
+        guard focusElementType == "Source Editor" else { return }
+        sourceEditor = focusElement
 
         editorObservationTask?.cancel()
         editorObservationTask = nil
@@ -134,6 +136,28 @@ public class RealtimeSuggestionController {
                 }
             }
         }
+
+        Task { // Get cache ready for real-time suggestions.
+            guard UserDefaults.shared.value(for: \.preCacheOnFileOpen) else { return }
+            guard
+                let fileURL = try? await Environment.fetchCurrentFileURL(),
+                let (_, filespace) = try? await Workspace
+                .fetchOrCreateWorkspaceIfNeeded(fileURL: fileURL)
+            else { return }
+
+            if filespace.uti == nil {
+                Logger.service.info("Generate cache for file.")
+                // avoid the command get called twice
+                filespace.uti = ""
+                do {
+                    try await Environment.triggerAction("Real-time Suggestions")
+                } catch {
+                    if filespace.uti?.isEmpty ?? true {
+                        filespace.uti = nil
+                    }
+                }
+            }
+        }
     }
 
     func handleHIDEvent(event: CGEvent) async {
@@ -203,7 +227,7 @@ public class RealtimeSuggestionController {
             }
 
             // So the editor won't be blocked (after information are cached)!
-            await PseudoCommandHandler().generateRealtimeSuggestions()
+            await PseudoCommandHandler().generateRealtimeSuggestions(sourceEditor: sourceEditor)
         }
     }
 

Core/Sources/Service/SuggestionCommandHandler/PseudoCommandHandler.swift

@@ -38,19 +38,10 @@ struct PseudoCommandHandler {
         ))
     }
 
-    func generateRealtimeSuggestions() async {
-        // Can't use handler directly if content is not available.
-        guard let editor = await getEditorContent() else {
-            try? await Environment.triggerAction("Prefetch Suggestions")
-            return
-        }
-        
-        // If no cache is available, and completion panel is not displayed, try to get it with command.
-        if editor.uti.isEmpty, await Environment.frontmostXcodeWindowIsEditor() {
-            try? await Environment.triggerAction("Prefetch Suggestions")
-            return
-        }
-        
+    func generateRealtimeSuggestions(sourceEditor: AXUIElement?) async {
+        // Can't use handler if content is not available.
+        guard let editor = await getEditorContent(sourceEditor: sourceEditor) else { return }
+
         // Otherwise, get it from pseudo handler directly.
         let mode = UserDefaults.shared.value(for: \.suggestionPresentationMode)
         switch mode {
@@ -84,7 +75,8 @@ struct PseudoCommandHandler {
             guard let focusElement = application.focusedElement,
                   focusElement.description == "Source Editor"
             else { return }
-            guard let (content, lines, cursorPosition) = await getFileContent() else {
+            guard let (content, lines, cursorPosition) = await getFileContent(sourceEditor: nil)
+            else {
                 PresentInWindowSuggestionPresenter()
                     .presentErrorMessage("Unable to get file content.")
                 return
@@ -103,6 +95,7 @@ struct PseudoCommandHandler {
                 )) else { return }
 
                 let oldPosition = focusElement.selectedTextRange
+                let oldScrollPosition = focusElement.parent?.verticalScrollBar?.doubleValue
 
                 let error = AXUIElementSetAttributeValue(
                     focusElement,
@@ -138,6 +131,14 @@ struct PseudoCommandHandler {
                     }
                 }
 
+                if let oldScrollPosition, let scrollBar = focusElement.parent?.verticalScrollBar {
+                    AXUIElementSetAttributeValue(
+                        scrollBar,
+                        kAXValueAttribute as CFString,
+                        oldScrollPosition as CFTypeRef
+                    )
+                }
+
             } catch {
                 PresentInWindowSuggestionPresenter().presentError(error)
             }
@@ -153,13 +154,13 @@ struct PseudoCommandHandler {
 }
 
 private extension PseudoCommandHandler {
-    func getFileContent() async
+    func getFileContent(sourceEditor: AXUIElement?) async
         -> (content: String, lines: [String], cursorPosition: CursorPosition)?
     {
         guard let xcode = ActiveApplicationMonitor.activeXcode
             ?? ActiveApplicationMonitor.latestXcode else { return nil }
         let application = AXUIElementCreateApplication(xcode.processIdentifier)
-        guard let focusElement = application.focusedElement,
+        guard let focusElement = sourceEditor ?? application.focusedElement,
               focusElement.description == "Source Editor"
         else { return nil }
         guard let selectionRange = focusElement.selectedTextRange else { return nil }
@@ -196,10 +197,10 @@ private extension PseudoCommandHandler {
     }
 
     @ServiceActor
-    func getEditorContent() async -> EditorContent? {
+    func getEditorContent(sourceEditor: AXUIElement?) async -> EditorContent? {
         guard
             let filespace = await getFilespace(),
-            let content = await getFileContent()
+            let content = await getFileContent(sourceEditor: sourceEditor)
         else { return nil }
         let uti = filespace.uti ?? ""
         let tabSize = filespace.tabSize ?? 4

Core/Sources/Service/Workspace.swift

@@ -152,6 +152,13 @@ final class Workspace {
     static func fetchOrCreateWorkspaceIfNeeded(fileURL: URL) async throws
         -> (workspace: Workspace, filespace: Filespace)
     {
+        // never create duplicated filespaces
+        for workspace in workspaces.values {
+            if let filespace = workspace.filespaces[fileURL] {
+                return (workspace, filespace)
+            }
+        }
+        
         let projectURL = try await Environment.fetchCurrentProjectRootURL(fileURL)
         let workspaceURL = projectURL ?? fileURL
         let workspace = workspaces[workspaceURL] ?? Workspace(projectRootURL: workspaceURL)

README.md

@@ -190,7 +190,6 @@ fi
 - The first run of the extension will be slow. Be patient.
 - The extension uses some dirty tricks to get the file and project/workspace paths. It may fail, it may be incorrect, especially when you have multiple Xcode windows running, and maybe even worse when they are in different displays. I am not sure about that though.
 - The suggestions are presented as C-style comments in comment mode, they may break your code if you are editing a JSON file or something.
-- When a real-time suggestion request is triggered, there is a chance that it may briefly block the editor. This can occur at most once for each file after each restart of the extension because the extension needs to initiate real-time suggestion by clicking an item from the menu bar. However, once a command has been executed and some information is cached, the extension will be able to trigger real-time suggestion using a different method.
 
 ## License 
 

Version.xcconfig

@@ -1,2 +1,2 @@
-APP_VERSION = 0.11.1
-APP_BUILD = 81
+APP_VERSION = 0.11.2
+APP_BUILD = 84

appcast.xml

@@ -4,15 +4,15 @@
     <title>Copilot for Xcode</title>
 
     <item>
-      <title>0.11.1</title>
-      <pubDate>Mon, 10 Apr 2023 19:04:48 +0800</pubDate>
-      <sparkle:version>81</sparkle:version>
-      <sparkle:shortVersionString>0.11.1</sparkle:shortVersionString>
+      <title>0.11.2</title>
+      <pubDate>Wed, 12 Apr 2023 12:23:29 +0800</pubDate>
+      <sparkle:version>84</sparkle:version>
+      <sparkle:shortVersionString>0.11.2</sparkle:shortVersionString>
       <sparkle:minimumSystemVersion>12.0</sparkle:minimumSystemVersion>
       <sparkle:releaseNotesLink>
-        https://github.com/intitni/CopilotForXcode/releases/tag/0.11.1
+        https://github.com/intitni/CopilotForXcode/releases/tag/0.11.2
       </sparkle:releaseNotesLink>
-      <enclosure url="https://github.com/intitni/CopilotForXcode/releases/download/0.11.1/Copilot.for.Xcode.app.zip" length="19038951" type="application/octet-stream" sparkle:edSignature="fp0vSUUH7JyIeyeUrMa9p6u3UFkgl5EeNjkmuzPL9hTmjfkVR77IM/9BIe2730OYy7PR429ngSjWPS+PGIT0Bg=="/>
+      <enclosure url="https://github.com/intitni/CopilotForXcode/releases/download/0.11.2/Copilot.for.Xcode.app.zip" length="19043705" type="application/octet-stream" sparkle:edSignature="oIfDoluwAzNJmZnN6zZtjRt7uyIMpS738kBNnOvsM8Ic06UQSW5v2bYyIRKnLJAfAygu7DM2/z+alzrUWvW6DA=="/>
     </item>
 
     <item>
@@ -61,4 +61,4 @@
         type="application/octet-stream" />
     </item>
   </channel>
-</rss>
+</rss>