Add package Logger

intitni · intitni · commit d5a40d57d749 · 2023-03-09T22:32:02.000+08:00
diff --git a/Core/Package.swift b/Core/Package.swift
@@ -15,11 +15,18 @@ let package = Package(
                 "FileChangeChecker",
                 "LaunchAgentManager",
                 "UpdateChecker",
+                "Logger",
             ]
         ),
         .library(
             name: "Client",
-            targets: ["CopilotModel", "Client", "XPCShared", "LaunchAgentManager"]
+            targets: [
+                "CopilotModel",
+                "Client",
+                "XPCShared",
+                "LaunchAgentManager",
+                "Logger",
+            ]
         ),
     ],
     dependencies: [
@@ -56,7 +63,7 @@ let package = Package(
         ),
         .target(
             name: "Client",
-            dependencies: ["CopilotModel", "XPCShared"]
+            dependencies: ["CopilotModel", "XPCShared", "Logger"]
         ),
         .target(
             name: "Service",
@@ -71,6 +78,7 @@ let package = Package(
                 "Environment",
                 "SuggestionWidget",
                 "AXExtension",
+                "Logger",
                 .product(name: "AsyncAlgorithms", package: "swift-async-algorithms"),
             ]
         ),
@@ -108,7 +116,8 @@ let package = Package(
                 "Splash",
             ]
         ),
-        .target(name: "UpdateChecker"),
+        .target(name: "UpdateChecker", dependencies: ["Logger"]),
         .target(name: "AXExtension"),
+        .target(name: "Logger"),
     ]
 )
diff --git a/Core/Sources/CGEventObserver/CGEventObserver.swift b/Core/Sources/CGEventObserver/CGEventObserver.swift
@@ -1,6 +1,6 @@
 import Cocoa
 import Foundation
-import os.log
+import Logger
 
 public protocol CGEventObserverType {
     @discardableResult
@@ -51,7 +51,7 @@ public final class CGEventObserver: CGEventObserverType {
 
     public func deactivate() {
         guard let port else { return }
-        os_log(.info, "CGEventObserver deactivated.")
+        Logger.service.info("CGEventObserver deactivated.")
         CFMachPortInvalidate(port)
         self.port = nil
     }
@@ -107,7 +107,7 @@ public final class CGEventObserver: CGEventObserverType {
         self.port = port
         let runLoopSource = CFMachPortCreateRunLoopSource(kCFAllocatorDefault, port, 0)
         CFRunLoopAddSource(RunLoop.main.getCFRunLoop(), runLoopSource, .commonModes)
-        os_log(.info, "CGEventObserver activated.")
+        Logger.service.info("CGEventObserver activated.")
         return true
     }
 }
diff --git a/Core/Sources/Client/XPCService.swift b/Core/Sources/Client/XPCService.swift
@@ -1,6 +1,7 @@
 import Foundation
 import os.log
 import XPCShared
+import Logger
 
 let shared = XPCService()
 
@@ -36,11 +37,11 @@ class XPCService {
         connection.remoteObjectInterface =
             NSXPCInterface(with: XPCServiceProtocol.self)
         connection.invalidationHandler = { [weak self] in
-            os_log(.info, "XPCService Invalidated")
+            Logger.client.info("XPCService Invalidated")
             self?.isInvalidated = true
         }
         connection.interruptionHandler = { [weak self] in
-            os_log(.info, "XPCService interrupted")
+            Logger.client.info("XPCService interrupted")
             self?.isInvalidated = true
         }
         connection.resume()
diff --git a/Core/Sources/Logger/Logger.swift b/Core/Sources/Logger/Logger.swift
@@ -0,0 +1,54 @@
+import Foundation
+import os.log
+
+enum LogLevel: String {
+    case debug
+    case info
+    case error
+}
+
+public final class Logger {
+    private let subsystem: String
+    private let category: String
+
+    public static let service = Logger(category: "Service")
+    public static let ui = Logger(category: "UI")
+    public static let client = Logger(category: "Client")
+    public static let updateChecker = Logger(category: "UpdateChecker")
+
+    public init(subsystem: String = "com.intii.CopilotForXcode", category: String) {
+        self.subsystem = subsystem
+        self.category = category
+    }
+
+    func log(level: LogLevel, message: String) {
+        let osLogType: OSLogType
+        switch level {
+        case .debug:
+            osLogType = .debug
+        case .info:
+            osLogType = .info
+        case .error:
+            osLogType = .error
+        }
+
+        let osLog = OSLog(subsystem: subsystem, category: category)
+        os_log("%@", log: osLog, type: osLogType, message as CVarArg)
+    }
+
+    public func debug(_ message: String) {
+        log(level: .debug, message: message)
+    }
+
+    public func info(_ message: String) {
+        log(level: .info, message: message)
+    }
+
+    public func error(_ message: String) {
+        log(level: .error, message: message)
+    }
+
+    public func error(_ error: Error) {
+        log(level: .error, message: error.localizedDescription)
+    }
+}
diff --git a/Core/Sources/Service/RealtimeSuggestionController.swift b/Core/Sources/Service/RealtimeSuggestionController.swift
@@ -6,7 +6,7 @@ import AXNotificationStream
 import CGEventObserver
 import Environment
 import Foundation
-import os.log
+import Logger
 import QuartzCore
 import XPCShared
 
@@ -63,7 +63,7 @@ public class RealtimeSuggestionController {
     }
 
     private func startHIDObservation(by listener: AnyHashable) {
-        os_log(.info, "Add auto trigger listener: %@.", listener as CVarArg)
+        Logger.service.info("Add auto trigger listener: \(listener).")
 
         if task == nil {
             task = Task { [weak self, eventObserver] in
@@ -77,7 +77,7 @@ public class RealtimeSuggestionController {
     }
 
     private func stopHIDObservation(by listener: AnyHashable) {
-        os_log(.info, "Remove auto trigger listener: %@.", listener as CVarArg)
+        Logger.service.info("Remove auto trigger listener: \(listener).")
         task?.cancel()
         task = nil
         eventObserver.deactivate()
@@ -191,10 +191,10 @@ public class RealtimeSuggestionController {
 
             if Task.isCancelled { return }
 
-            os_log(.info, "Prefetch suggestions.")
+            Logger.service.info("Prefetch suggestions.")
             
             if !force, isCommentMode, await !Environment.frontmostXcodeWindowIsEditor() {
-                os_log(.info, "Completion panel is open, blocked.")
+                Logger.service.info("Completion panel is open, blocked.")
                 return
             }
 
diff --git a/Core/Sources/Service/SuggestionCommandHandler/WindowBaseCommandHandler.swift b/Core/Sources/Service/SuggestionCommandHandler/WindowBaseCommandHandler.swift
@@ -2,7 +2,7 @@ import CopilotModel
 import CopilotService
 import Environment
 import Foundation
-import os.log
+import Logger
 import SuggestionInjector
 import XPCShared
 
@@ -17,7 +17,7 @@ struct WindowBaseCommandHandler: SuggestionCommandHandler {
             do {
                 try await _presentSuggestions(editor: editor)
             } catch {
-                os_log(.error, "%@", error.localizedDescription)
+                Logger.service.error(error)
             }
         }
         return nil
diff --git a/Core/Sources/Service/XPCService.swift b/Core/Sources/Service/XPCService.swift
@@ -3,7 +3,7 @@ import CopilotService
 import Environment
 import Foundation
 import LanguageServerProtocol
-import os.log
+import Logger
 import XPCShared
 
 @globalActor enum ServiceActor {
@@ -128,7 +128,7 @@ public class XPCService: NSObject, XPCServiceProtocol {
                 try Task.checkCancellation()
                 reply(try JSONEncoder().encode(updatedContent), nil)
             } catch {
-                os_log(.error, "%@", "\(file):\(line) \(error.localizedDescription)")
+                Logger.service.error("\(file):\(line) \(error.localizedDescription)")
                 reply(nil, NSError.from(error))
             }
         }
diff --git a/Core/Sources/UpdateChecker/UpdateChecker.swift b/Core/Sources/UpdateChecker/UpdateChecker.swift
@@ -1,6 +1,6 @@
 import AppKit
 import Foundation
-import os.log
+import Logger
 import SwiftUI
 
 struct Release: Codable {
@@ -84,7 +84,7 @@ public struct UpdateChecker {
                 }
             }
         } catch {
-            os_log(.error, "%@", error.localizedDescription)
+            Logger.updateChecker.error(error)
         }
     }
 }
diff --git a/ExtensionService/AppDelegate.swift b/ExtensionService/AppDelegate.swift
@@ -1,7 +1,7 @@
 import AppKit
 import FileChangeChecker
 import LaunchAgentManager
-import os.log
+import Logger
 import Service
 import ServiceManagement
 import SwiftUI
@@ -29,7 +29,7 @@ class AppDelegate: NSObject, NSApplicationDelegate, NSWindowDelegate {
         setupQuitOnUpdate()
         setupQuitOnUserTerminated()
         xpcListener = setupXPCListener()
-        os_log(.info, "XPC Service started.")
+        Logger.service.info("XPC Service started.")
         NSApp.setActivationPolicy(.prohibited)
         buildStatusBarMenu()
         checkForUpdate()
@@ -136,10 +136,10 @@ class AppDelegate: NSObject, NSApplicationDelegate, NSWindowDelegate {
                     app.isUserOfService
                 else { continue }
                 guard await checker.checkIfChanged() else {
-                    os_log(.info, "Extension Service is not updated, no need to quit.")
+                    Logger.service.info("Extension Service is not updated, no need to quit.")
                     continue
                 }
-                os_log(.info, "Extension Service will quit.")
+                Logger.service.info("Extension Service will quit.")
                 #if DEBUG
                 #else
                 exit(0)

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`import AppKit`
`2`	`2`	`import Foundation`
`3`		`-import os.log`
	`3`	`+import Logger`
`4`	`4`	`import SwiftUI`
`5`	`5`
`6`	`6`	`struct Release: Codable {`
`@@ -84,7 +84,7 @@ public struct UpdateChecker {`
`84`	`84`	`}`
`85`	`85`	`}`
`86`	`86`	`} catch {`
`87`		`- os_log(.error, "%@", error.localizedDescription)`
	`87`	`+ Logger.updateChecker.error(error)`
`88`	`88`	`}`
`89`	`89`	`}`
`90`	`90`	`}`