Make XcodeInspector a bit more thread safe

Author: intitni

Core/Sources/PromptToCodeService/OpenAIPromptToCodeService.swift

@@ -31,7 +31,7 @@ public final class OpenAIPromptToCodeService: PromptToCodeServiceType {
             return userPreferredLanguage.isEmpty ? "" : " in \(userPreferredLanguage)"
         }()
 
-        let editor: EditorInformation = XcodeInspector.shared.getFocusedEditorContent() ?? .init(
+        let editor: EditorInformation = await XcodeInspector.shared.getFocusedEditorContent() ?? .init(
             editorContent: .init(
                 content: source.content,
                 lines: source.lines,

ExtensionService/AppDelegate+Menu.swift

@@ -218,7 +218,9 @@ extension AppDelegate: NSMenuDelegate {
 
 private extension AppDelegate {
     @objc func restartXcodeInspector() {
-        XcodeInspector.shared.restart(cleanUp: true)
+        Task {
+            await XcodeInspector.shared.restart(cleanUp: true)
+        }
     }
 
     @objc func reactivateObservationsToXcode() {

Pro

@@ -22,7 +22,8 @@ public final class ActiveDocumentChatContextCollector: ChatContextCollector {
         content: String,
         configuration: ChatGPTConfiguration
     ) async -> ChatContext {
-        guard let info = getEditorInformation() else { return .empty }
+        guard let info = await XcodeInspector.shared.getFocusedEditorContent()
+        else { return .empty }
         let context = getActiveDocumentContext(info)
         activeDocumentContext = context
 

Tool/Sources/ChatContextCollectors/ActiveDocumentChatContextCollector/ActiveDocumentChatContextCollector.swift

@@ -13,8 +13,9 @@ public struct LegacyActiveDocumentChatContextCollector: ChatContextCollector {
         scopes: Set<ChatContext.Scope>,
         content: String,
         configuration: ChatGPTConfiguration
-    ) -> ChatContext {
-        guard let content = getEditorInformation() else { return .empty }
+    ) async -> ChatContext {
+        guard let content = await XcodeInspector.shared.getFocusedEditorContent()
+        else { return .empty }
         let relativePath = content.relativePath
         let selectionRange = content.editorContent?.selections.first ?? .outOfScope
         let editorContent = {
@@ -79,26 +80,26 @@ public struct LegacyActiveDocumentChatContextCollector: ChatContextCollector {
 
         return .init(
             systemPrompt: """
-                Active Document Context:###
-                Document Relative Path: \(relativePath)
-                Selection Range Start: \
-                Line \(selectionRange.start.line) \
-                Character \(selectionRange.start.character)
-                Selection Range End: \
-                Line \(selectionRange.end.line) \
-                Character \(selectionRange.end.character)
-                Cursor Position: \
-                Line \(selectionRange.end.line) \
-                Character \(selectionRange.end.character)
-                \(editorContent)
-                Line Annotations:
-                \(
-                    content.editorContent?.lineAnnotations
-                        .map { "  - \($0)" }
-                        .joined(separator: "\n") ?? "N/A"
-                )
-                ###
-                """,
+            Active Document Context:###
+            Document Relative Path: \(relativePath)
+            Selection Range Start: \
+            Line \(selectionRange.start.line) \
+            Character \(selectionRange.start.character)
+            Selection Range End: \
+            Line \(selectionRange.end.line) \
+            Character \(selectionRange.end.character)
+            Cursor Position: \
+            Line \(selectionRange.end.line) \
+            Character \(selectionRange.end.character)
+            \(editorContent)
+            Line Annotations:
+            \(
+                content.editorContent?.lineAnnotations
+                    .map { "  - \($0)" }
+                    .joined(separator: "\n") ?? "N/A"
+            )
+            ###
+            """,
             retrievedContent: [],
             functions: []
         )

Tool/Sources/ChatContextCollectors/ActiveDocumentChatContextCollector/GetEditorInfo.swift

@@ -20,13 +20,26 @@ public enum XcodeInspectorActor: GlobalActor {
 
 public final class XcodeInspector: ObservableObject {
     public static let shared = XcodeInspector()
+    
+    @XcodeInspectorActor
+    @dynamicMemberLookup
+    public class Safe {
+        var inspector: XcodeInspector { .shared }
+        nonisolated init() {}
+        public subscript<T>(dynamicMember member: KeyPath<XcodeInspector, T>) -> T {
+            inspector[keyPath: member]
+        }
+    }
 
     private var toast: ToastController { ToastControllerDependencyKey.liveValue }
 
     private var cancellable = Set<AnyCancellable>()
     private var activeXcodeObservations = Set<Task<Void, Error>>()
     private var appChangeObservations = Set<Task<Void, Never>>()
     private var activeXcodeCancellable = Set<AnyCancellable>()
+    
+    #warning("TODO: Find a good way to make XcodeInspector thread safe!")
+    public var safe = Safe()
 
     @Published public fileprivate(set) var activeApplication: AppInstanceInspector?
     @Published public fileprivate(set) var previousActiveApplication: AppInstanceInspector?
@@ -45,13 +58,14 @@ public final class XcodeInspector: ObservableObject {
     ///
     /// - note: This method is expensive. It needs to convert index based ranges to line based
     /// ranges.
-    public func getFocusedEditorContent() -> EditorInformation? {
-        guard let documentURL = XcodeInspector.shared.realtimeActiveDocumentURL,
-              let workspaceURL = XcodeInspector.shared.realtimeActiveWorkspaceURL,
-              let projectURL = XcodeInspector.shared.activeProjectRootURL
+    @XcodeInspectorActor
+    public func getFocusedEditorContent() async -> EditorInformation? {
+        guard let documentURL = realtimeActiveDocumentURL,
+              let workspaceURL = realtimeActiveWorkspaceURL,
+              let projectURL = activeProjectRootURL
         else { return nil }
 
-        let editorContent = XcodeInspector.shared.focusedEditor?.getContent()
+        let editorContent = focusedEditor?.getContent()
         let language = languageIdentifierFromFileURL(documentURL)
         let relativePath = documentURL.path.replacingOccurrences(of: projectURL.path, with: "")
 
@@ -98,9 +112,12 @@ public final class XcodeInspector: ObservableObject {
 
     init() {
         AXUIElement.setGlobalMessagingTimeout(3)
-        restart()
+        Task { @XcodeInspectorActor in
+            restart()
+        }
     }
 
+    @XcodeInspectorActor
     public func restart(cleanUp: Bool = false) {
         if cleanUp {
             activeXcodeObservations.forEach { $0.cancel() }
@@ -135,7 +152,7 @@ public final class XcodeInspector: ObservableObject {
         let appChangeTask = Task(priority: .utility) { [weak self] in
             guard let self else { return }
             if let activeXcode {
-                await setActiveXcode(activeXcode)
+                setActiveXcode(activeXcode)
             }
 
             await withThrowingTaskGroup(of: Void.self) { [weak self] group in
@@ -318,24 +335,24 @@ public final class XcodeInspector: ObservableObject {
             checkForAccessibilityMalfunction("Reactivate Xcode")
         }
 
-        xcode.$completionPanel.receive(on: DispatchQueue.main).sink { [weak self] element in
-            self?.completionPanel = element
+        xcode.$completionPanel.sink { [weak self] element in
+            Task { @XcodeInspectorActor in self?.completionPanel = element }
         }.store(in: &activeXcodeCancellable)
 
-        xcode.$documentURL.receive(on: DispatchQueue.main).sink { [weak self] url in
-            self?.activeDocumentURL = url
+        xcode.$documentURL.sink { [weak self] url in
+            Task { @XcodeInspectorActor in self?.activeDocumentURL = url }
         }.store(in: &activeXcodeCancellable)
 
-        xcode.$workspaceURL.receive(on: DispatchQueue.main).sink { [weak self] url in
-            self?.activeWorkspaceURL = url
+        xcode.$workspaceURL.sink { [weak self] url in
+            Task { @XcodeInspectorActor in self?.activeWorkspaceURL = url }
         }.store(in: &activeXcodeCancellable)
 
-        xcode.$projectRootURL.receive(on: DispatchQueue.main).sink { [weak self] url in
-            self?.activeProjectRootURL = url
+        xcode.$projectRootURL.sink { [weak self] url in
+            Task { @XcodeInspectorActor in self?.activeProjectRootURL = url }
         }.store(in: &activeXcodeCancellable)
 
-        xcode.$focusedWindow.receive(on: DispatchQueue.main).sink { [weak self] window in
-            self?.focusedWindow = window
+        xcode.$focusedWindow.sink { [weak self] window in
+            Task { @XcodeInspectorActor in self?.focusedWindow = window }
         }.store(in: &activeXcodeCancellable)
     }