Add async versions of UserToolchain.init and SwiftSDK.hostSwiftSDK

Both methods previously made calls to the version of
`AsyncProcess.checkNonZeroExit` that blocks the calling thread,
forcing consumers to either block or implement workarounds to hop
off the calling thread.

This patch adds async versions of these methods and ports most
usages to use them, marking the required call sites as async and
awaiting them.

Author: plemarquand

Examples/package-info/Sources/package-info/example.swift

@@ -20,7 +20,7 @@ struct Example {
 
         let observability = ObservabilitySystem({ print("\($0): \($1)") })
 
-        let workspace = try Workspace(forRootPackage: packagePath)
+        let workspace = try await Workspace(forRootPackage: packagePath)
 
         let manifest = try await workspace.loadRootManifest(at: packagePath, observabilityScope: observability.topScope)
 

Sources/Commands/PackageCommands/APIDiff.swift

@@ -84,7 +84,12 @@ struct APIDiff: AsyncSwiftCommand {
         let repository = GitRepository(path: packageRoot)
         let baselineRevision = try repository.resolveRevision(identifier: treeish)
 
-        let baselineDir = try overrideBaselineDir?.appending(component: baselineRevision.identifier) ?? swiftCommandState.productsBuildParameters.apiDiff.appending(component: "\(baselineRevision.identifier)-baselines")
+        let baselineDir: Basics.AbsolutePath
+        if let overrideBaselineDir {
+            baselineDir = overrideBaselineDir.appending(component: baselineRevision.identifier)
+        } else {
+            baselineDir = try await swiftCommandState.productsBuildParameters.apiDiff.appending(component: "\(baselineRevision.identifier)-baselines")
+        }
         let packageGraph = try await swiftCommandState.loadPackageGraph()
         let modulesToDiff = try Self.determineModulesToDiff(
             packageGraph: packageGraph,
@@ -115,7 +120,7 @@ struct APIDiff: AsyncSwiftCommand {
     }
 
     private func runWithSwiftPMCoordinatedDiffing(_ swiftCommandState: SwiftCommandState, buildSystem: any BuildSystem, baselineRevision: Revision, modulesToDiff: Set<String>) async throws {
-        let apiDigesterPath = try swiftCommandState.getTargetToolchain().getSwiftAPIDigester()
+        let apiDigesterPath = try await swiftCommandState.getTargetToolchain().getSwiftAPIDigester()
         let apiDigesterTool = SwiftAPIDigester(fileSystem: swiftCommandState.fileSystem, tool: apiDigesterPath)
 
         // Build the current package.
@@ -198,7 +203,7 @@ struct APIDiff: AsyncSwiftCommand {
         let modulesWithBaselines = try await generateAPIBaselineUsingIntegratedAPIDigesterSupport(swiftCommandState, baselineRevision: baselineRevision, baselineDir: baselineDir, modulesNeedingBaselines: modulesToDiff)
 
         // Build the package and run a comparison agains the baselines.
-        var productsBuildParameters = try swiftCommandState.productsBuildParameters
+        var productsBuildParameters = try await swiftCommandState.productsBuildParameters
         productsBuildParameters.apiDigesterMode = .compareToBaselines(
             baselinesDirectory: baselineDir,
             modulesToCompare: modulesWithBaselines,
@@ -258,7 +263,7 @@ struct APIDiff: AsyncSwiftCommand {
 
     private func generateAPIBaselineUsingIntegratedAPIDigesterSupport(_ swiftCommandState: SwiftCommandState, baselineRevision: Revision, baselineDir: Basics.AbsolutePath, modulesNeedingBaselines: Set<String>) async throws -> Set<String> {
         // Setup a temporary directory where we can checkout and build the baseline treeish.
-        let baselinePackageRoot = try swiftCommandState.productsBuildParameters.apiDiff.appending("\(baselineRevision.identifier)-checkout")
+        let baselinePackageRoot = try await swiftCommandState.productsBuildParameters.apiDiff.appending("\(baselineRevision.identifier)-checkout")
         if swiftCommandState.fileSystem.exists(baselinePackageRoot) {
             try swiftCommandState.fileSystem.removeFileTree(baselinePackageRoot)
         }
@@ -279,7 +284,7 @@ struct APIDiff: AsyncSwiftCommand {
         try workingCopy.checkout(revision: baselineRevision)
 
         // Create the workspace for this package.
-        let workspace = try Workspace(
+        let workspace = try await Workspace(
             forRootPackage: baselinePackageRoot,
             cancellator: swiftCommandState.cancellator
         )
@@ -307,7 +312,7 @@ struct APIDiff: AsyncSwiftCommand {
         }
 
         // Update the data path input build parameters so it's built in the sandbox.
-        var productsBuildParameters = try swiftCommandState.productsBuildParameters
+        var productsBuildParameters = try await swiftCommandState.productsBuildParameters
         productsBuildParameters.dataPath = workspace.location.scratchDirectory
         productsBuildParameters.apiDigesterMode = .generateBaselines(baselinesDirectory: baselineDir, modulesRequestingBaselines: modulesNeedingBaselines)
 

Sources/Commands/PackageCommands/AddDependency.swift

@@ -25,7 +25,7 @@ import Workspace
 import class PackageModel.Manifest
 
 extension SwiftPackageCommand {
-    struct AddDependency: SwiftCommand {
+    struct AddDependency: AsyncSwiftCommand {
         package static let configuration = CommandConfiguration(
             abstract: "Add a package dependency to the manifest."
         )
@@ -63,8 +63,8 @@ extension SwiftPackageCommand {
             case registry
         }
 
-        func run(_ swiftCommandState: SwiftCommandState) throws {
-            let workspace = try swiftCommandState.getActiveWorkspace()
+        func run(_ swiftCommandState: SwiftCommandState) async throws {
+            let workspace = try await swiftCommandState.getActiveWorkspace()
             guard let packagePath = try swiftCommandState.getWorkspaceRoot().packages.first else {
                 throw StringError("unknown package")
             }

Sources/Commands/PackageCommands/AddProduct.swift

@@ -23,7 +23,7 @@ import TSCUtility
 import Workspace
 
 extension SwiftPackageCommand {
-    struct AddProduct: SwiftCommand {
+    struct AddProduct: AsyncSwiftCommand {
         /// The package product type used for the command-line. This is a
         /// subset of `ProductType` that expands out the library types.
         enum CommandProductType: String, Codable, ExpressibleByArgument, CaseIterable {
@@ -52,8 +52,8 @@ extension SwiftPackageCommand {
         )
         var targets: [String] = []
 
-        func run(_ swiftCommandState: SwiftCommandState) throws {
-            let workspace = try swiftCommandState.getActiveWorkspace()
+        func run(_ swiftCommandState: SwiftCommandState) async throws {
+            let workspace = try await swiftCommandState.getActiveWorkspace()
 
             guard let packagePath = try swiftCommandState.getWorkspaceRoot().packages.first else {
                 throw StringError("unknown package")

Sources/Commands/PackageCommands/AddSetting.swift

@@ -25,7 +25,7 @@ import TSCUtility
 import Workspace
 
 extension SwiftPackageCommand {
-    struct AddSetting: SwiftCommand {
+    struct AddSetting: AsyncSwiftCommand {
         /// The Swift language setting that can be specified on the command line.
         enum SwiftSetting: String, Codable, ExpressibleByArgument, CaseIterable {
             case experimentalFeature
@@ -68,9 +68,9 @@ extension SwiftPackageCommand {
             }
         }
 
-        func run(_ swiftCommandState: SwiftCommandState) throws {
+        func run(_ swiftCommandState: SwiftCommandState) async throws {
             if !self._swiftSettings.isEmpty {
-                try Self.editSwiftSettings(
+                try await Self.editSwiftSettings(
                     of: self.target,
                     using: swiftCommandState,
                     self.swiftSettings,
@@ -84,8 +84,8 @@ extension SwiftPackageCommand {
             using swiftCommandState: SwiftCommandState,
             _ settings: [(SwiftSetting, String)],
             verbose: Bool = false
-        ) throws {
-            let workspace = try swiftCommandState.getActiveWorkspace()
+        ) async throws {
+            let workspace = try await swiftCommandState.getActiveWorkspace()
             guard let packagePath = try swiftCommandState.getWorkspaceRoot().packages.first else {
                 throw StringError("unknown package")
             }

Sources/Commands/PackageCommands/AddTarget.swift

@@ -75,7 +75,7 @@ extension SwiftPackageCommand {
         var testingLibrary: AddPackageTarget.TestHarness = .default
 
         func run(_ swiftCommandState: SwiftCommandState) async throws {
-            let workspace = try swiftCommandState.getActiveWorkspace()
+            let workspace = try await swiftCommandState.getActiveWorkspace()
 
             guard let packagePath = try swiftCommandState.getWorkspaceRoot().packages.first else {
                 throw StringError("unknown package")

Sources/Commands/PackageCommands/AddTargetDependency.swift

@@ -24,7 +24,7 @@ import TSCUtility
 import Workspace
 
 extension SwiftPackageCommand {
-    struct AddTargetDependency: SwiftCommand {
+    struct AddTargetDependency: AsyncSwiftCommand {
         package static let configuration = CommandConfiguration(
             abstract: "Add a new target dependency to the manifest.")
 
@@ -40,8 +40,8 @@ extension SwiftPackageCommand {
         @Option(help: "The package in which the dependency resides.")
         var package: String?
 
-        func run(_ swiftCommandState: SwiftCommandState) throws {
-            let workspace = try swiftCommandState.getActiveWorkspace()
+        func run(_ swiftCommandState: SwiftCommandState) async throws {
+            let workspace = try await swiftCommandState.getActiveWorkspace()
 
             guard let packagePath = try swiftCommandState.getWorkspaceRoot().packages.first else {
                 throw StringError("unknown package")

Sources/Commands/PackageCommands/AuditBinaryArtifact.swift

@@ -34,7 +34,7 @@ struct AuditBinaryArtifact: AsyncSwiftCommand {
     var path: AbsolutePath
 
     func run(_ swiftCommandState: SwiftCommandState) async throws {
-        let hostToolchain = try swiftCommandState.getHostToolchain()
+        let hostToolchain = try await swiftCommandState.getHostToolchain()
         let clang = try hostToolchain.getClangCompiler()
         let objdump = try hostToolchain.getLLVMObjdump()
         let hostTriple = try Triple.getVersionedHostTriple(

Sources/Commands/PackageCommands/Config.swift

@@ -28,7 +28,7 @@ extension SwiftPackageCommand {
 }
 
 extension SwiftPackageCommand.Config {
-    struct SetMirror: SwiftCommand {
+    struct SetMirror: AsyncSwiftCommand {
         static let configuration = CommandConfiguration(
             abstract: "Set a mirror for a dependency."
         )
@@ -51,8 +51,8 @@ extension SwiftPackageCommand.Config {
         @Option(help: "The mirror url or identity.")
         var mirror: String?
 
-        func run(_ swiftCommandState: SwiftCommandState) throws {
-            let config = try getMirrorsConfig(swiftCommandState)
+        func run(_ swiftCommandState: SwiftCommandState) async throws {
+            let config = try await getMirrorsConfig(swiftCommandState)
 
             if self._deprecate_packageURL != nil {
                 swiftCommandState.observabilityScope.emit(
@@ -86,7 +86,7 @@ extension SwiftPackageCommand.Config {
         }
     }
 
-    struct UnsetMirror: SwiftCommand {
+    struct UnsetMirror: AsyncSwiftCommand {
         static let configuration = CommandConfiguration(
             abstract: "Remove an existing mirror."
         )
@@ -109,8 +109,8 @@ extension SwiftPackageCommand.Config {
         @Option(help: "The mirror url or identity.")
         var mirror: String?
 
-        func run(_ swiftCommandState: SwiftCommandState) throws {
-            let config = try getMirrorsConfig(swiftCommandState)
+        func run(_ swiftCommandState: SwiftCommandState) async throws {
+            let config = try await getMirrorsConfig(swiftCommandState)
 
             if self._deprecate_packageURL != nil {
                 swiftCommandState.observabilityScope.emit(
@@ -141,7 +141,7 @@ extension SwiftPackageCommand.Config {
         }
     }
 
-    struct GetMirror: SwiftCommand {
+    struct GetMirror: AsyncSwiftCommand {
         static let configuration = CommandConfiguration(
             abstract: "Print mirror configuration for the given package dependency."
         )
@@ -157,8 +157,8 @@ extension SwiftPackageCommand.Config {
         @Option(help: "The original url or identity.")
         var original: String?
 
-        func run(_ swiftCommandState: SwiftCommandState) throws {
-            let config = try getMirrorsConfig(swiftCommandState)
+        func run(_ swiftCommandState: SwiftCommandState) async throws {
+            let config = try await getMirrorsConfig(swiftCommandState)
 
             if self._deprecate_packageURL != nil {
                 swiftCommandState.observabilityScope.emit(
@@ -186,8 +186,8 @@ extension SwiftPackageCommand.Config {
         }
     }
 
-    static func getMirrorsConfig(_ swiftCommandState: SwiftCommandState) throws -> Workspace.Configuration.Mirrors {
-        let workspace = try swiftCommandState.getActiveWorkspace()
+    static func getMirrorsConfig(_ swiftCommandState: SwiftCommandState) async throws -> Workspace.Configuration.Mirrors {
+        let workspace = try await swiftCommandState.getActiveWorkspace()
         return try .init(
             fileSystem: swiftCommandState.fileSystem,
             localMirrorsFile: workspace.location.localMirrorsConfigurationFile,

Sources/Commands/PackageCommands/Describe.swift

@@ -32,7 +32,7 @@ extension SwiftPackageCommand {
         var type: DescribeMode = .text
 
         func run(_ swiftCommandState: SwiftCommandState) async throws {
-            let workspace = try swiftCommandState.getActiveWorkspace()
+            let workspace = try await swiftCommandState.getActiveWorkspace()
 
             guard let packagePath = try swiftCommandState.getWorkspaceRoot().packages.first else {
                 throw StringError("unknown package")