Files
sourcekit-lsp/Sources/LanguageServerProtocolJSONRPC/LoggableMessageTypes.swift
Alex Hoppen 2877675bd5 Adopt package access level
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
2024-07-19 09:54:30 -07:00

104 lines
2.6 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 Foundation
import LSPLogging
import LanguageServerProtocol
fileprivate extension Encodable {
var prettyPrintJSON: String {
let encoder = JSONEncoder()
encoder.outputFormatting.insert(.prettyPrinted)
encoder.outputFormatting.insert(.sortedKeys)
guard let data = try? encoder.encode(self) else {
return "\(self)"
}
guard let string = String(data: data, encoding: .utf8) else {
return "\(self)"
}
// Don't escape '/'. Most JSON readers don't need it escaped and it makes
// paths a lot easier to read and copy-paste.
return string.replacingOccurrences(of: "\\/", with: "/")
}
}
// MARK: - RequestType
fileprivate struct AnyRequestType: CustomLogStringConvertible {
let request: any RequestType
public var description: String {
return """
\(type(of: request).method)
\(request.prettyPrintJSON)
"""
}
public var redactedDescription: String {
return "\(type(of: request).method)"
}
}
extension RequestType {
package var forLogging: CustomLogStringConvertibleWrapper {
return AnyRequestType(request: self).forLogging
}
}
// MARK: - NotificationType
fileprivate struct AnyNotificationType: CustomLogStringConvertible {
let notification: any NotificationType
public var description: String {
return """
\(type(of: notification).method)
\(notification.prettyPrintJSON)
"""
}
public var redactedDescription: String {
return "\(type(of: notification).method)"
}
}
extension NotificationType {
package var forLogging: CustomLogStringConvertibleWrapper {
return AnyNotificationType(notification: self).forLogging
}
}
// MARK: - ResponseType
fileprivate struct AnyResponseType: CustomLogStringConvertible {
let response: any ResponseType
var description: String {
return """
\(type(of: response))
\(response.prettyPrintJSON)
"""
}
var redactedDescription: String {
return """
\(type(of: response))
"""
}
}
extension ResponseType {
package var forLogging: CustomLogStringConvertibleWrapper {
return AnyResponseType(response: self).forLogging
}
}