mirror of
https://github.com/apple/sourcekit-lsp.git
synced 2026-03-06 18:24:36 +01:00
2877675bd5
Change a l public declarations to the `package` access level, accept for: - The `LanguageServerProtocol` module - The `BuildServerProtocol` module - `InProcessClient.InProcessSourceKitLSPClient` - `LanguageServerProtocolJSONRPC` (I would like to create a more ergonomic API for this like `InProcessSourceKitLSPClient` in the future, but for now, we’ll leave it public) Unfortunately, our pattern of marking functions as `@_spi(Testing) public` no longer works with the `package` access level because declarations at the `package` access level cannot be marked as SPI. I have decided to just mark these functions as `package`. Alternatives would be: - Add an underscore to these functions, like we did for functions exposed for testing before the introduction of `SPI` - Use `@testable` import in the test targets and mark the methods as `internal` Resolves #1315 rdar://128295618
88 lines
3.2 KiB
Swift
88 lines
3.2 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2023 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 Crypto
|
|
import Foundation
|
|
|
|
/// An object that can printed for logging and also offers a redacted description
|
|
/// when logging in contexts in which private information shouldn't be captured.
|
|
package protocol CustomLogStringConvertible: CustomStringConvertible, Sendable {
|
|
/// A full description of the object.
|
|
var description: String { get }
|
|
|
|
/// A description of the object that doesn't contain any private information.
|
|
var redactedDescription: String { get }
|
|
}
|
|
|
|
/// When an NSObject is logged with OSLog in private mode and the object
|
|
/// implements `redactedDescription`, OSLog will log that information instead of
|
|
/// just logging `<private>`.
|
|
///
|
|
/// There currently is no way to get equivalent functionality in pure Swift. We
|
|
/// thus pass this object to OSLog, which just forwards to `description` or
|
|
/// `redactedDescription` of an object that implements `CustomLogStringConvertible`.
|
|
package final class CustomLogStringConvertibleWrapper: NSObject, Sendable {
|
|
private let underlyingObject: any CustomLogStringConvertible
|
|
|
|
fileprivate init(_ underlyingObject: any CustomLogStringConvertible) {
|
|
self.underlyingObject = underlyingObject
|
|
}
|
|
|
|
package override var description: String {
|
|
return underlyingObject.description
|
|
}
|
|
|
|
#if canImport(os)
|
|
// When using OSLog mark redactedDescription as @objc so that OSLog can find it via the Objective-C runtime.
|
|
// We can't unconditionally mark it as @objc because eg. Linux doesn't have the Objective-C runtime.
|
|
@objc
|
|
#endif
|
|
package var redactedDescription: String {
|
|
underlyingObject.redactedDescription
|
|
}
|
|
}
|
|
|
|
extension CustomLogStringConvertible {
|
|
/// Returns an object that can be passed to OSLog, which will print the
|
|
/// `redactedDescription` if logging of private information is disabled and
|
|
/// will log `description` otherwise.
|
|
package var forLogging: CustomLogStringConvertibleWrapper {
|
|
return CustomLogStringConvertibleWrapper(self)
|
|
}
|
|
}
|
|
|
|
extension String {
|
|
/// A hash value that can be logged in a redacted description without
|
|
/// disclosing any private information about the string.
|
|
package var hashForLogging: String {
|
|
return Insecure.MD5.hash(data: Data(self.utf8)).description
|
|
}
|
|
}
|
|
|
|
private struct OptionalWrapper<Wrapped>: CustomLogStringConvertible where Wrapped: CustomLogStringConvertible {
|
|
let optional: Optional<Wrapped>
|
|
|
|
package var description: String {
|
|
return optional?.description ?? "<nil>"
|
|
}
|
|
|
|
package var redactedDescription: String {
|
|
return optional?.redactedDescription ?? "<nil>"
|
|
}
|
|
}
|
|
|
|
extension Optional where Wrapped: CustomLogStringConvertible {
|
|
package var forLogging: CustomLogStringConvertibleWrapper {
|
|
return CustomLogStringConvertibleWrapper(OptionalWrapper(optional: self))
|
|
}
|
|
}
|