mirror of
https://github.com/apple/sourcekit-lsp.git
synced 2026-03-02 18:23:24 +01:00
6d794aca6b
Having `BuildSettingsLogger` can be problematic if we launch multple `SourceKitLSPServer` instances in the same process (such as during testing). In that case it could happen that a previous `SourceKitLSPServer` instance logs build settings and then the second instance doesn’t log its build settings (if they are the same) because the shared logger has already logged them. This issue is resolved by scoping `BuildSettingsLogger` to the lifetime of `BuildServerManager` (ie. one per workspace).
57 lines
2.0 KiB
Swift
57 lines
2.0 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2020 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
package import LanguageServerProtocol
|
|
package import SKLogging
|
|
|
|
// MARK: - Build settings logger
|
|
|
|
/// Shared logger that only logs build settings for a file once unless they change
|
|
package actor BuildSettingsLogger {
|
|
private var loggedSettings: [DocumentURI: FileBuildSettings] = [:]
|
|
|
|
package func log(level: LogLevel = .default, settings: FileBuildSettings, for uri: DocumentURI) {
|
|
guard loggedSettings[uri] != settings else {
|
|
return
|
|
}
|
|
loggedSettings[uri] = settings
|
|
Self.log(level: level, settings: settings, for: uri)
|
|
}
|
|
|
|
/// Log the given build settings.
|
|
///
|
|
/// In contrast to the instance method `log`, this will always log the build settings. The instance method only logs
|
|
/// the build settings if they have changed.
|
|
package static func log(level: LogLevel = .default, settings: FileBuildSettings, for uri: DocumentURI) {
|
|
let log = """
|
|
Compiler Arguments:
|
|
\(settings.compilerArguments.joined(separator: "\n"))
|
|
|
|
Working directory:
|
|
\(settings.workingDirectory ?? "<nil>")
|
|
"""
|
|
|
|
let chunks = splitLongMultilineMessage(message: log)
|
|
// Only print the first 100 chunks. If the argument list gets any longer, we don't want to spam the log too much.
|
|
// In practice, 100 chunks should be sufficient.
|
|
for (index, chunk) in chunks.enumerated().prefix(100) {
|
|
logger.log(
|
|
level: level,
|
|
"""
|
|
Build settings for \(uri.forLogging) (\(index + 1)/\(chunks.count))
|
|
\(chunk)
|
|
"""
|
|
)
|
|
}
|
|
}
|
|
}
|