Update XPCService

Author: intitni

Core/Sources/Client/AsyncXPCService.swift

@@ -20,7 +20,7 @@ public struct AsyncXPCService {
             }
         }
     }
-    
+
     public func getXPCServiceAccessibilityPermission() async throws -> Bool {
         try await withXPCServiceConnected(connection: connection) {
             service, continuation in
@@ -85,7 +85,7 @@ public struct AsyncXPCService {
             { $0.getRealtimeSuggestedCode }
         )
     }
-    
+
     public func getPromptToCodeAcceptedCode(editorContent: EditorContent) async throws
         -> UpdatedContent?
     {
@@ -144,7 +144,7 @@ public struct AsyncXPCService {
             { service in { service.customCommand(id: id, editorContent: $0, withReply: $1) } }
         )
     }
-    
+
     public func postNotification(name: String) async throws {
         try await withXPCServiceConnected(connection: connection) {
             service, continuation in
@@ -153,17 +153,41 @@ public struct AsyncXPCService {
             }
         }
     }
-    
-    public func performAction(name: String, arguments: String) async throws -> String {
-        try await withXPCServiceConnected(connection: connection) {
-            service, continuation in
-            service.performAction(name: name, arguments: arguments) {
-                continuation.resume($0)
+
+    public func send<M: ExtensionServiceRequestType>(
+        requestBody: M
+    ) async throws -> M.ResponseBody {
+        try await withXPCServiceConnected(connection: connection) { service, continuation in
+            do {
+                let requestBodyData = try JSONEncoder().encode(requestBody)
+                service.send(endpoint: M.endpoint, requestBody: requestBodyData) { data, error in
+                    if let error {
+                        continuation.reject(error)
+                    } else {
+                        do {
+                            guard let data = data else {
+                                continuation.reject(NoDataError())
+                                return
+                            }
+                            let responseBody = try JSONDecoder().decode(
+                                M.ResponseBody.self,
+                                from: data
+                            )
+                            continuation.resume(responseBody)
+                        } catch {
+                            continuation.reject(error)
+                        }
+                    }
+                }
+            } catch {
+                continuation.reject(error)
             }
         }
     }
 }
 
+struct NoDataError: Error {}
+
 struct AutoFinishContinuation<T> {
     var continuation: AsyncThrowingStream<T, Error>.Continuation
 

Core/Sources/Service/XPCService.swift

@@ -45,7 +45,7 @@ public class XPCService: NSObject, XPCServiceProtocol {
                     return
                 }
                 try Task.checkCancellation()
-                reply(try JSONEncoder().encode(updatedContent), nil)
+                try reply(JSONEncoder().encode(updatedContent), nil)
             } catch {
                 Logger.service.error("\(file):\(line) \(error.localizedDescription)")
                 reply(nil, NSError.from(error))
@@ -102,7 +102,7 @@ public class XPCService: NSObject, XPCServiceProtocol {
             try await handler.acceptSuggestion(editor: editor)
         }
     }
-    
+
     public func getPromptToCodeAcceptedCode(
         editorContent: Data,
         withReply reply: @escaping (Data?, Error?) -> Void
@@ -191,12 +191,34 @@ public class XPCService: NSObject, XPCServiceProtocol {
         NSWorkspace.shared.notificationCenter.post(name: .init(name), object: nil)
     }
 
-    public func performAction(
-        name: String,
-        arguments: String,
-        withReply reply: @escaping (String) -> Void
+    // MARK: - Requests
+    
+    public func send(
+        endpoint: String,
+        requestBody: Data,
+        reply: @escaping (Data?, Error?) -> Void
     ) {
-        reply("None")
+        do {
+            try ExtensionServiceRequests.OpenExtensionManager.handle(
+                endpoint: endpoint,
+                requestBody: requestBody,
+                reply: reply
+            ) { _ in
+                .none
+            }
+
+            try ExtensionServiceRequests.GetExtensionSuggestionServices.handle(
+                endpoint: endpoint,
+                requestBody: requestBody,
+                reply: reply
+            ) { _ in
+                []
+            }
+        } catch is XPCRequestHandlerHitError {
+            return
+        } catch {
+            reply(nil, error)
+        }
     }
 }
 

Tool/Sources/XPCShared/XPCServiceProtocol.swift

@@ -1,5 +1,5 @@
-import SuggestionModel
 import Foundation
+import SuggestionModel
 
 @objc(XPCServiceProtocol)
 public protocol XPCServiceProtocol {
@@ -55,5 +55,96 @@ public protocol XPCServiceProtocol {
     func getXPCServiceVersion(withReply reply: @escaping (String, String) -> Void)
     func getXPCServiceAccessibilityPermission(withReply reply: @escaping (Bool) -> Void)
     func postNotification(name: String, withReply reply: @escaping () -> Void)
-    func performAction(name: String, arguments: String, withReply reply: @escaping (String) -> Void)
+    func send(endpoint: String, requestBody: Data, reply: @escaping (Data?, Error?) -> Void)
+}
+
+public struct NoResponse: Codable {
+    public static let none = NoResponse()
+}
+
+public protocol ExtensionServiceRequestType: Codable {
+    associatedtype ResponseBody: Codable
+    static var endpoint: String { get }
+}
+
+public enum ExtensionServiceRequests {
+    public struct OpenExtensionManager: ExtensionServiceRequestType {
+        public typealias ResponseBody = NoResponse
+        public static let endpoint = "OpenExtensionManager"
+
+        public init() {}
+    }
+
+    public struct GetExtensionSuggestionServices: ExtensionServiceRequestType {
+        public struct ServiceInfo: Codable {
+            public var bundleIdentifier: String
+            public var name: String
+        }
+
+        public typealias ResponseBody = [ServiceInfo]
+        public static let endpoint = "GetExtensionSuggestionServices"
+
+        public init() {}
+    }
+}
+
+public struct XPCRequestHandlerHitError: Error, LocalizedError {
+    public var errorDescription: String? {
+        "This is not an actual error, it just indicates a request handler was hit, and no more check is needed."
+    }
+
+    public init() {}
 }
+
+public struct XPCRequestNotHandledError: Error, LocalizedError {
+    public var errorDescription: String? {
+        "The request was not handled by the XPC server."
+    }
+
+    public init() {}
+}
+
+extension ExtensionServiceRequestType {
+    /// A helper method to handle requests.
+    static func _handle<Request: Codable, Response: Codable>(
+        endpoint: String,
+        requestBody data: Data,
+        reply: @escaping (Data?, Error?) -> Void,
+        handler: @escaping (Request) async throws -> Response
+    ) throws {
+        guard endpoint == Self.endpoint else {
+            return
+        }
+        do {
+            let requestBody = try JSONDecoder().decode(Request.self, from: data)
+            Task {
+                do {
+                    let responseBody = try await handler(requestBody)
+                    let responseBodyData = try JSONEncoder().encode(responseBody)
+                    reply(responseBodyData, nil)
+                } catch {
+                    reply(nil, error)
+                }
+            }
+        } catch {
+            reply(nil, error)
+        }
+        throw XPCRequestHandlerHitError()
+    }
+
+    public static func handle(
+        endpoint: String,
+        requestBody data: Data,
+        reply: @escaping (Data?, Error?) -> Void,
+        handler: @escaping (Self) async throws -> Self.ResponseBody
+    ) throws {
+        try _handle(
+            endpoint: endpoint,
+            requestBody: data,
+            reply: reply
+        ) { (request: Self) async throws -> Self.ResponseBody in
+            try await handler(request)
+        }
+    }
+}
+