mirror of
https://github.com/apple/sourcekit-lsp.git
synced 2026-03-02 18:23:24 +01:00
f960d7ed9b
OSLog is the suggesting logging solution on Apple platforms and we should be using it there, taking advantage of the different log levels and privacy masking. Switch sourcekit-lsp to use OSLog on Apple platforms and implement a logger that is API-compatible with OSLog for all uses in sourcekit-lsp and which can be used on non-Darwin platforms. The goal of this commit is to introduce the new logging API. There are still improvements about what we log and we can display more privacy-insensitive information after masking. Those changes will be in follow-up commits.
127 lines
3.3 KiB
Swift
127 lines
3.3 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2018 Apple Inc. and the Swift project authors
|
|
// Licensed under Apache License v2.0 with Runtime Library Exception
|
|
//
|
|
// See https://swift.org/LICENSE.txt for license information
|
|
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
import LSPLogging
|
|
|
|
/// A request object, wrapping the parameters of a `RequestType` and tracking its state.
|
|
public final class Request<R: RequestType> {
|
|
|
|
public typealias Params = R
|
|
|
|
public typealias Response = R.Response
|
|
|
|
/// The request id from the client.
|
|
public let id: RequestID
|
|
|
|
/// The client of the request.
|
|
public let clientID: ObjectIdentifier
|
|
|
|
/// The request parameters.
|
|
public let params: Params
|
|
|
|
private var replyBlock: (LSPResult<Response>) -> Void
|
|
|
|
/// Whether a reply has been made. Every request must reply exactly once.
|
|
private var replied: Bool = false {
|
|
willSet {
|
|
precondition(replied == false, "replied to \(id) more than once")
|
|
}
|
|
}
|
|
|
|
/// The request's cancellation state.
|
|
public let cancellationToken: CancellationToken
|
|
|
|
public init(
|
|
_ request: Params,
|
|
id: RequestID,
|
|
clientID: ObjectIdentifier,
|
|
cancellation: CancellationToken,
|
|
reply: @escaping (LSPResult<Response>) -> Void
|
|
) {
|
|
self.id = id
|
|
self.clientID = clientID
|
|
self.params = request
|
|
self.cancellationToken = cancellation
|
|
self.replyBlock = reply
|
|
}
|
|
|
|
deinit {
|
|
precondition(replied, "request \(id) never received a reply")
|
|
}
|
|
|
|
/// Reply to the request with `result`.
|
|
///
|
|
/// This must be called exactly once for each request.
|
|
public func reply(_ result: LSPResult<Response>) {
|
|
replied = true
|
|
replyBlock(result)
|
|
}
|
|
|
|
/// Reply to the request with `.success(result)`.
|
|
public func reply(_ result: Response) {
|
|
reply(.success(result))
|
|
}
|
|
|
|
/// Whether the result has been cancelled.
|
|
public var isCancelled: Bool { return cancellationToken.isCancelled }
|
|
}
|
|
|
|
/// A request object, wrapping the parameters of a `NotificationType`.
|
|
public final class Notification<N: NotificationType> {
|
|
|
|
public typealias Params = N
|
|
|
|
/// The client of the request.
|
|
public let clientID: ObjectIdentifier
|
|
|
|
/// The request parameters.
|
|
public let params: Params
|
|
|
|
public init(_ notification: Params, clientID: ObjectIdentifier) {
|
|
self.clientID = clientID
|
|
self.params = notification
|
|
}
|
|
}
|
|
|
|
extension Request: CustomStringConvertible, CustomLogStringConvertible {
|
|
public var description: String {
|
|
return """
|
|
Request<\(R.method)>(
|
|
id: \(id),
|
|
clientID: \(clientID),
|
|
params: \(params)
|
|
)
|
|
"""
|
|
}
|
|
|
|
public var redactedDescription: String {
|
|
// FIXME: (logging) Log the non-critical parts of the request
|
|
return "Request<\(R.method)>"
|
|
}
|
|
}
|
|
|
|
extension Notification: CustomStringConvertible, CustomLogStringConvertible {
|
|
public var description: String {
|
|
return """
|
|
Notification<\(N.method)>(
|
|
clientID: \(clientID),
|
|
params: \(params)
|
|
)
|
|
"""
|
|
}
|
|
|
|
public var redactedDescription: String {
|
|
// FIXME: (logging) Log the non-critical parts of the notification
|
|
return "Notification<\(N.method)>"
|
|
}
|
|
}
|