Deprecate temp_await and being moving to async/await across multiple commands

AndrewHoos · AndrewHoos · commit e9280310d950 · 2024-07-08T12:10:10.000-07:00
diff --git a/Sources/Basics/Concurrency/ConcurrencyHelpers.swift b/Sources/Basics/Concurrency/ConcurrencyHelpers.swift
@@ -25,14 +25,14 @@ public enum Concurrency {
 }
 
 // FIXME: mark as deprecated once async/await is available
-// @available(*, deprecated, message: "replace with async/await when available")
+@available(*, deprecated, message: "replace with async/await when available")
 @inlinable
 public func temp_await<T, ErrorType>(_ body: (@escaping (Result<T, ErrorType>) -> Void) -> Void) throws -> T {
     try tsc_await(body)
 }
 
 // FIXME: mark as deprecated once async/await is available
-// @available(*, deprecated, message: "replace with async/await when available")
+@available(*, deprecated, message: "replace with async/await when available")
 @inlinable
 public func temp_await<T>(_ body: (@escaping (T) -> Void) -> Void) -> T {
     tsc_await(body)
diff --git a/Sources/Commands/PackageCommands/ArchiveSource.swift b/Sources/Commands/PackageCommands/ArchiveSource.swift
@@ -16,7 +16,7 @@ import CoreCommands
 import SourceControl
 
 extension SwiftPackageCommand {
-    struct ArchiveSource: SwiftCommand {
+    struct ArchiveSource: AsyncSwiftCommand {
         static let configuration = CommandConfiguration(
             commandName: "archive-source",
             abstract: "Create a source archive for the package"
@@ -31,7 +31,7 @@ extension SwiftPackageCommand {
         )
         var output: AbsolutePath?
 
-        func run(_ swiftCommandState: SwiftCommandState) throws {
+        func run(_ swiftCommandState: SwiftCommandState) async throws {
             let packageDirectory = try globalOptions.locations.packageDirectory ?? swiftCommandState.getPackageRoot()
 
             let archivePath: AbsolutePath
@@ -43,7 +43,7 @@ extension SwiftPackageCommand {
                 archivePath = packageDirectory.appending("\(packageName).zip")
             }
 
-            try SwiftPackageCommand.archiveSource(
+            try await SwiftPackageCommand.archiveSource(
                 at: packageDirectory,
                 to: archivePath,
                 fileSystem: localFileSystem,
@@ -64,15 +64,15 @@ extension SwiftPackageCommand {
         to archivePath: AbsolutePath,
         fileSystem: FileSystem,
         cancellator: Cancellator?
-    ) throws  {
+    ) async throws {
         let gitRepositoryProvider = GitRepositoryProvider()
         if gitRepositoryProvider.repositoryExists(at: packageDirectory) &&
             (try? gitRepositoryProvider.isValidDirectory(packageDirectory)) == true {
             let repository = GitRepository(path: packageDirectory, cancellator: cancellator)
             try repository.archive(to: archivePath)
         } else {
             let zipArchiver = ZipArchiver(fileSystem: fileSystem, cancellator: cancellator)
-            try temp_await {
+            try await safe_async {
                 zipArchiver.compress(directory: packageDirectory, to: archivePath, completion: $0)
             }
         }
diff --git a/Sources/Commands/PackageCommands/PluginCommand.swift b/Sources/Commands/PackageCommands/PluginCommand.swift
@@ -19,7 +19,7 @@ import PackageGraph
 
 import PackageModel
 
-struct PluginCommand: SwiftCommand {
+struct PluginCommand: AsyncSwiftCommand {
     static let configuration = CommandConfiguration(
         commandName: "plugin",
         abstract: "Invoke a command plugin or perform other actions on command plugins"
@@ -137,7 +137,7 @@ struct PluginCommand: SwiftCommand {
     )
     var arguments: [String] = []
 
-    func run(_ swiftCommandState: SwiftCommandState) throws {
+    func run(_ swiftCommandState: SwiftCommandState) async throws {
         // Check for a missing plugin command verb.
         if self.command == "" && !self.listCommands {
             throw ValidationError("Missing expected plugin command")
@@ -166,7 +166,7 @@ struct PluginCommand: SwiftCommand {
             return
         }
 
-        try Self.run(
+        try await Self.run(
             command: self.command,
             options: self.pluginOptions,
             arguments: self.arguments,
@@ -179,7 +179,7 @@ struct PluginCommand: SwiftCommand {
         options: PluginOptions,
         arguments: [String],
         swiftCommandState: SwiftCommandState
-    ) throws {
+    ) async throws {
         // Load the workspace and resolve the package graph.
         let packageGraph = try swiftCommandState.loadPackageGraph()
 
@@ -203,7 +203,7 @@ struct PluginCommand: SwiftCommand {
             .shouldDisableSandbox
 
         // At this point we know we found exactly one command plugin, so we run it. In SwiftPM CLI, we have only one root package.
-        try PluginCommand.run(
+        try await PluginCommand.run(
             plugin: matchingPlugins[0],
             package: packageGraph.rootPackages[packageGraph.rootPackages.startIndex],
             packageGraph: packageGraph,
@@ -220,7 +220,7 @@ struct PluginCommand: SwiftCommand {
         options: PluginOptions,
         arguments: [String],
         swiftCommandState: SwiftCommandState
-    ) throws {
+    ) async throws {
         let pluginTarget = plugin.underlying as! PluginModule
 
         swiftCommandState.observabilityScope
@@ -355,7 +355,7 @@ struct PluginCommand: SwiftCommand {
 
         // Run the command plugin.
         let buildEnvironment = buildParameters.buildEnvironment
-        let _ = try temp_await { pluginTarget.invoke(
+        let _ = try await safe_async { pluginTarget.invoke(
             action: .performCommand(package: package, arguments: arguments),
             buildEnvironment: buildEnvironment,
             scriptRunner: pluginScriptRunner,
diff --git a/Sources/Commands/PackageCommands/SwiftPackageCommand.swift b/Sources/Commands/PackageCommands/SwiftPackageCommand.swift
@@ -86,7 +86,7 @@ public struct SwiftPackageCommand: AsyncParsableCommand {
 extension SwiftPackageCommand {
     // This command is the default when no other subcommand is passed. It is not shown in the help and is never invoked
     // directly.
-    struct DefaultCommand: SwiftCommand {
+    struct DefaultCommand: AsyncSwiftCommand {
         static let configuration = CommandConfiguration(
             commandName: nil,
             shouldDisplay: false
@@ -101,7 +101,7 @@ extension SwiftPackageCommand {
         @Argument(parsing: .captureForPassthrough)
         var remaining: [String] = []
 
-        func run(_ swiftCommandState: SwiftCommandState) throws {
+        func run(_ swiftCommandState: SwiftCommandState) async throws {
             // See if have a possible plugin command.
             guard let command = remaining.first else {
                 print(SwiftPackageCommand.helpMessage())
@@ -116,7 +116,7 @@ extension SwiftPackageCommand {
             }
 
             // Otherwise see if we can find a plugin.
-            try PluginCommand.run(
+            try await PluginCommand.run(
                 command: command,
                 options: self.pluginOptions,
                 arguments: self.remaining,
diff --git a/Sources/Commands/SwiftTestCommand.swift b/Sources/Commands/SwiftTestCommand.swift
@@ -391,7 +391,7 @@ public struct SwiftTestCommand: AsyncSwiftCommand {
         }
 
         if self.options.shouldPrintCodeCovPath {
-            try printCodeCovPath(swiftCommandState)
+            try await printCodeCovPath(swiftCommandState)
         } else if self.options._deprecated_shouldListTests {
             // backward compatibility 6/2022 for deprecation of flag into a subcommand
             let command = try List.parse()
@@ -610,10 +610,10 @@ public struct SwiftTestCommand: AsyncSwiftCommand {
 }
 
 extension SwiftTestCommand {
-    func printCodeCovPath(_ swiftCommandState: SwiftCommandState) throws {
+    func printCodeCovPath(_ swiftCommandState: SwiftCommandState) async throws {
         let workspace = try swiftCommandState.getActiveWorkspace()
         let root = try swiftCommandState.getWorkspaceRoot()
-        let rootManifests = try temp_await {
+        let rootManifests = try await safe_async {
             workspace.loadRootManifests(
                 packages: root.packages,
                 observabilityScope: swiftCommandState.observabilityScope,
diff --git a/Sources/PackageRegistryCommand/PackageRegistryCommand+Publish.swift b/Sources/PackageRegistryCommand/PackageRegistryCommand+Publish.swift
@@ -171,7 +171,7 @@ extension PackageRegistryCommand {
                     certificateChainPaths: self.certificateChainPaths
                 )
 
-                let result = try PackageArchiveSigner.prepareArchiveAndSign(
+                let result = try await PackageArchiveSigner.prepareArchiveAndSign(
                     packageIdentity: packageIdentity,
                     packageVersion: packageVersion,
                     packageDirectory: packageDirectory,
@@ -190,7 +190,7 @@ extension PackageRegistryCommand {
                 // step 2: generate source archive for the package release
                 // step 3: signing not required
                 swiftCommandState.observabilityScope.emit(info: "archiving the source at '\(packageDirectory)'")
-                archivePath = try PackageArchiver.archive(
+                archivePath = try await PackageArchiver.archive(
                     packageIdentity: self.packageIdentity,
                     packageVersion: self.packageVersion,
                     packageDirectory: packageDirectory,
@@ -314,7 +314,7 @@ enum PackageArchiveSigner {
         cancellator: Cancellator?,
         fileSystem: FileSystem,
         observabilityScope: ObservabilityScope
-    ) throws -> ArchiveAndSignResult {
+    ) async throws -> ArchiveAndSignResult {
         // signing identity
         let (signingIdentity, intermediateCertificates) = try Self.signingIdentityAndIntermediateCertificates(
             mode: mode,
@@ -349,7 +349,7 @@ enum PackageArchiveSigner {
 
         // create the archive
         observabilityScope.emit(info: "archiving the source at '\(packageDirectory)'")
-        let archivePath = try PackageArchiver.archive(
+        let archivePath = try await PackageArchiver.archive(
             packageIdentity: packageIdentity,
             packageVersion: packageVersion,
             packageDirectory: packageDirectory,
@@ -473,7 +473,7 @@ enum PackageArchiver {
         workingFilesToCopy: [String],
         cancellator: Cancellator?,
         observabilityScope: ObservabilityScope
-    ) throws -> AbsolutePath {
+    ) async throws -> AbsolutePath {
         let archivePath = workingDirectory.appending("\(packageIdentity)-\(packageVersion).zip")
 
         // create temp location for sources
@@ -500,7 +500,7 @@ enum PackageArchiver {
             try localFileSystem.writeFileContents(toBeReplacedPath, bytes: replacement)
         }
 
-        try SwiftPackageCommand.archiveSource(
+        try await SwiftPackageCommand.archiveSource(
             at: sourceDirectory,
             to: archivePath,
             fileSystem: localFileSystem,
diff --git a/Sources/_InternalTestSupport/MockWorkspace.swift b/Sources/_InternalTestSupport/MockWorkspace.swift
@@ -86,7 +86,7 @@ public final class MockWorkspace {
         skipDependenciesUpdates: Bool = false,
         sourceControlToRegistryDependencyTransformation: WorkspaceConfiguration.SourceControlToRegistryDependencyTransformation = .disabled,
         defaultRegistry: Registry? = .none
-    ) throws {
+    ) async throws {
         try fileSystem.createMockToolchain()
 
         self.sandbox = sandbox
@@ -121,7 +121,7 @@ public final class MockWorkspace {
             archiver: MockArchiver()
         )
         self.customHostToolchain = try UserToolchain.mockHostToolchain(fileSystem)
-        try self.create()
+        try await self.create()
     }
 
     public var rootsDir: AbsolutePath {
@@ -148,7 +148,7 @@ public final class MockWorkspace {
         return try AbsolutePath(validating: name, relativeTo: self.packagesDir)
     }
 
-    private func create() throws {
+    private func create() async throws {
         // Remove the sandbox if present.
         try self.fileSystem.removeFileTree(self.sandbox)
 
@@ -159,7 +159,7 @@ public final class MockWorkspace {
 
         var manifests: [MockManifestLoader.Key: Manifest] = [:]
 
-        func create(package: MockPackage, basePath: AbsolutePath, isRoot: Bool) throws {
+        func create(package: MockPackage, basePath: AbsolutePath, isRoot: Bool) async throws {
             let packagePath: AbsolutePath
             switch package.location {
             case .fileSystem(let path):
@@ -168,7 +168,7 @@ public final class MockWorkspace {
                 if let containerProvider = customPackageContainerProvider {
                     let observability = ObservabilitySystem.makeForTesting()
                     let packageRef = PackageReference(identity: PackageIdentity(url: url), kind: .remoteSourceControl(url))
-                    let container = try temp_await {
+                    let container = try await safe_async {
                         containerProvider.getContainer(
                             for: packageRef,
                             updateStrategy: .never,
@@ -289,12 +289,12 @@ public final class MockWorkspace {
 
         // Create root packages.
         for package in self.roots {
-            try create(package: package, basePath: self.rootsDir, isRoot: true)
+            try await create(package: package, basePath: self.rootsDir, isRoot: true)
         }
 
         // Create dependency packages.
         for package in self.packages {
-            try create(package: package, basePath: self.packagesDir, isRoot: false)
+            try await create(package: package, basePath: self.packagesDir, isRoot: false)
         }
 
         self.manifestLoader = MockManifestLoader(manifests: manifests)
@@ -771,14 +771,14 @@ public final class MockWorkspace {
         roots: [String] = [],
         deps: [MockDependency] = [],
         _ result: (Workspace.DependencyManifests,  [Basics.Diagnostic]) -> Void
-    ) throws {
+    ) async throws {
         let observability = ObservabilitySystem.makeForTesting()
         let dependencies = try deps.map { try $0.convert(baseURL: packagesDir, identityResolver: self.identityResolver) }
         let workspace = try self.getOrCreateWorkspace()
         let rootInput = PackageGraphRootInput(
             packages: try rootPaths(for: roots), dependencies: dependencies
         )
-        let rootManifests = try temp_await { workspace.loadRootManifests(packages: rootInput.packages, observabilityScope: observability.topScope, completion: $0) }
+        let rootManifests = try await safe_async { workspace.loadRootManifests(packages: rootInput.packages, observabilityScope: observability.topScope, completion: $0) }
         let graphRoot = PackageGraphRoot(input: rootInput, manifests: rootManifests, observabilityScope: observability.topScope)
         let manifests = try workspace.loadDependencyManifests(
             root: graphRoot,
diff --git a/Tests/CommandsTests/PackageRegistryCommandTests.swift b/Tests/CommandsTests/PackageRegistryCommandTests.swift
@@ -358,7 +358,7 @@ final class PackageRegistryCommandTests: CommandsTestCase {
 
             let workingDirectory = temporaryDirectory.appending(component: UUID().uuidString)
 
-            let archivePath = try PackageArchiver.archive(
+            let archivePath = try await PackageArchiver.archive(
                 packageIdentity: packageIdentity,
                 packageVersion: "1.3.5",
                 packageDirectory: packageDirectory,
@@ -388,7 +388,7 @@ final class PackageRegistryCommandTests: CommandsTestCase {
 
             let workingDirectory = temporaryDirectory.appending(component: UUID().uuidString)
 
-            let archivePath = try PackageArchiver.archive(
+            let archivePath = try await PackageArchiver.archive(
                 packageIdentity: packageIdentity,
                 packageVersion: "1.5.4",
                 packageDirectory: packageDirectory,
@@ -423,7 +423,7 @@ final class PackageRegistryCommandTests: CommandsTestCase {
 
             let workingDirectory = temporaryDirectory.appending(component: UUID().uuidString)
 
-            let archivePath = try PackageArchiver.archive(
+            let archivePath = try await PackageArchiver.archive(
                 packageIdentity: packageIdentity,
                 packageVersion: "0.3.1",
                 packageDirectory: packageDirectory,
diff --git a/Tests/PackageGraphTests/PubgrubTests.swift b/Tests/PackageGraphTests/PubgrubTests.swift
@@ -360,12 +360,13 @@ final class PubgrubTests: XCTestCase {
         XCTAssertThrowsError(try solver1.resolve(state: state1, conflict: notRoot))
     }
 
-    func testResolverDecisionMaking() throws {
+    func testResolverDecisionMaking() async throws {
         let solver1 = PubGrubDependencyResolver(provider: emptyProvider, observabilityScope: ObservabilitySystem.NOOP)
         let state1 = PubGrubDependencyResolver.State(root: rootNode)
 
         // No decision can be made if no unsatisfied terms are available.
-        XCTAssertNil(try temp_await { solver1.makeDecision(state: state1, completion: $0) })
+        let decisionNil = try await safe_async { solver1.makeDecision(state: state1, completion: $0) }
+        XCTAssertNil(decisionNil)
 
         let a = MockContainer(package: aRef, dependenciesByVersion: [
             "0.0.0": [:],
@@ -381,7 +382,7 @@ final class PubgrubTests: XCTestCase {
 
         XCTAssertEqual(state2.incompatibilities.count, 0)
 
-        let decision = try temp_await { solver2.makeDecision(state: state2, completion: $0) }
+        let decision = try await safe_async {solver2.makeDecision(state: state2, completion: $0) }
         XCTAssertEqual(decision, .product("a", package: "a"))
 
         XCTAssertEqual(state2.incompatibilities.count, 3)
diff --git a/Tests/WorkspaceTests/WorkspaceTests.swift b/Tests/WorkspaceTests/WorkspaceTests.swift
