averello/sourcekit-lsp
1
0
Fork 0
mirror of https://github.com/apple/sourcekit-lsp.git synced 2026-03-02 18:23:24 +01:00
Code Issues Packages Projects Releases Wiki Activity

Retry loading the build description if it fails to write output-file-map.json on Windows

Browse Source 
Loading the build description sometimes fails non-deterministically on Windows because it's unable to write `output-file-map.json`, probably due to https://github.com/swiftlang/swift-package-manager/issues/8038.

If this happens, retry loading the build description up to 5 times.
This commit is contained in:
Alex Hoppen
2025-02-25 08:59:24 -08:00
parent 02ee070707
commit faa2232f2c
1 changed files with 47 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
Sources/BuildSystemIntegration/SwiftPMBuildSystem.swift
View File

@@ -341,6 +341,52 @@ package actor SwiftPMBuildSystem: BuiltInBuildSystem {
}
}
/// Loading the build description sometimes fails non-deterministically on Windows because it's unable to write
/// `output-file-map.json`, probably due to https://github.com/swiftlang/swift-package-manager/issues/8038.
/// If this happens, retry loading the build description up to `maxLoadAttempt` times.
private func loadBuildDescriptionWithRetryOnOutputFileMapWriteErrorOnWindows(
modulesGraph: ModulesGraph,
maxLoadAttempts: Int = 5
) async throws -> (description: SourceKitLSPAPI.BuildDescription, errors: String) {
// TODO: Remove this workaround once https://github.com/swiftlang/swift-package-manager/issues/8038 is fixed.
var loadAttempt = 0
while true {
loadAttempt += 1
do {
return try await BuildDescription.load(
destinationBuildParameters: destinationBuildParameters,
toolsBuildParameters: toolsBuildParameters,
packageGraph: modulesGraph,
pluginConfiguration: pluginConfiguration,
traitConfiguration: traitConfiguration,
disableSandbox: options.swiftPMOrDefault.disableSandbox ?? false,
scratchDirectory: swiftPMWorkspace.location.scratchDirectory.asURL,
fileSystem: localFileSystem,
observabilityScope: observabilitySystem.topScope.makeChildScope(
description: "Create SwiftPM build description"
)
)
} catch let error as NSError {
#if os(Windows)
if error.domain == NSCocoaErrorDomain, error.code == CocoaError.fileWriteNoPermission.rawValue,
let url = error.userInfo["NSURL"] as? URL, url.lastPathComponent == "output-file-map.json",
loadAttempt < maxLoadAttempts
{
logger.log(
"""
Loading the build description failed to write output-file-map.json \
(attempt \(loadAttempt)/\(maxLoadAttempts)), trying again.
\(error)
"""
)
continue
}
#endif
throw error
}
}
}
/// (Re-)load the package settings by parsing the manifest and resolving all the targets and
/// dependencies.
///
@@ -372,17 +418,7 @@ package actor SwiftPMBuildSystem: BuiltInBuildSystem {
// plugins, without having to worry about messing up any regular build state.
let buildDescription: SourceKitLSPAPI.BuildDescription
if isForIndexBuild && !(options.swiftPMOrDefault.skipPlugins ?? false) {
let loaded = try await BuildDescription.load(
destinationBuildParameters: destinationBuildParameters,
toolsBuildParameters: toolsBuildParameters,
packageGraph: modulesGraph,
pluginConfiguration: pluginConfiguration,
traitConfiguration: traitConfiguration,
disableSandbox: options.swiftPMOrDefault.disableSandbox ?? false,
scratchDirectory: swiftPMWorkspace.location.scratchDirectory.asURL,
fileSystem: localFileSystem,
observabilityScope: observabilitySystem.topScope.makeChildScope(description: "Create SwiftPM build description")
)
let loaded = try await loadBuildDescriptionWithRetryOnOutputFileMapWriteErrorOnWindows(modulesGraph: modulesGraph)
if !loaded.errors.isEmpty {
logger.error("Loading SwiftPM description had errors: \(loaded.errors)")
}