Remove usage of temp_await from WorkspaceTests (#7124)

Replace all usage of `temp_await` with `await` in `WorkspaceTests`

### Motivation:

async/await is nicer than callbacks. I want to see it more broadly adopted in SwiftPM.

### Modifications:

All usages of `temp_await` in the WorkspaceTests target have removed.
Where necessary, `async` alternatives have been added and the completion
handler methods have been marked no-async.

### Result:

`async`/`await` adoption in `WorkspaceTests`.

---------

Co-authored-by: Max Desiatov <[email protected]>

Author: AndrewHoos

Sources/PackageGraph/PackageContainer.swift

@@ -164,6 +164,8 @@ extension PackageContainerConstraint: CustomStringConvertible {
 /// An interface for resolving package containers.
 public protocol PackageContainerProvider {
     /// Get the container for a particular identifier asynchronously.
+
+    @available(*, noasync, message: "Use the async alternative")
     func getContainer(
         for package: PackageReference,
         updateStrategy: ContainerUpdateStrategy,
@@ -173,6 +175,24 @@ public protocol PackageContainerProvider {
     )
 }
 
+public extension PackageContainerProvider {
+    func getContainer(
+        for package: PackageReference,
+        updateStrategy: ContainerUpdateStrategy,
+        observabilityScope: ObservabilityScope,
+        on queue: DispatchQueue
+    ) async throws -> PackageContainer {
+        try await safe_async {
+            self.getContainer(
+                for: package,
+                updateStrategy: updateStrategy,
+                observabilityScope: observabilityScope,
+                on: queue,
+                completion: $0)
+        }
+    }
+}
+
 /// Only used for source control containers and as such a mirror of RepositoryUpdateStrategy
 /// This duplication is unfortunate - ideally this is not a concern of the ContainerProvider at all
 /// but it is required give how PackageContainerProvider currently integrated into the resolver

Sources/PackageLoading/ManifestLoader.swift

@@ -293,7 +293,41 @@ public final class ManifestLoader: ManifestLoaderProtocol {
         self.evaluationQueue.maxConcurrentOperationCount = Concurrency.maxOperations
         self.concurrencySemaphore = DispatchSemaphore(value: Concurrency.maxOperations)
     }
-
+    
+    public func load(
+        manifestPath: AbsolutePath,
+        manifestToolsVersion: ToolsVersion,
+        packageIdentity: PackageIdentity,
+        packageKind: PackageReference.Kind,
+        packageLocation: String,
+        packageVersion: (version: Version?, revision: String?)?,
+        identityResolver: IdentityResolver,
+        dependencyMapper: DependencyMapper,
+        fileSystem: FileSystem,
+        observabilityScope: ObservabilityScope,
+        delegateQueue: DispatchQueue,
+        callbackQueue: DispatchQueue
+    ) async throws -> Manifest {
+        try await safe_async {
+            self.load(
+                manifestPath: manifestPath,
+                manifestToolsVersion: manifestToolsVersion,
+                packageIdentity: packageIdentity,
+                packageKind: packageKind,
+                packageLocation: packageLocation,
+                packageVersion: packageVersion,
+                identityResolver: identityResolver,
+                dependencyMapper: dependencyMapper,
+                fileSystem: fileSystem,
+                observabilityScope: observabilityScope,
+                delegateQueue: delegateQueue, 
+                callbackQueue: callbackQueue,
+                completion: $0
+            )
+        }
+    }
+    
+    @available(*, noasync, message: "Use the async alternative")
     public func load(
         manifestPath: AbsolutePath,
         manifestToolsVersion: ToolsVersion,

Sources/Workspace/Workspace.swift

@@ -950,6 +950,7 @@ extension Workspace {
     }
 
     /// Loads and returns manifests at the given paths.
+    @available(*, noasync, message: "Use the async alternative")
     public func loadRootManifests(
         packages: [AbsolutePath],
         observabilityScope: ObservabilityScope,
@@ -1123,9 +1124,20 @@ extension Workspace {
         }
         return importList
     }
+    
+    public func loadPackage(
+        with identity: PackageIdentity,
+        packageGraph: PackageGraph,
+        observabilityScope: ObservabilityScope
+    ) async throws -> Package {
+        try await safe_async {
+            self.loadPackage(with: identity, packageGraph: packageGraph, observabilityScope: observabilityScope, completion: $0)
+        }
+    }
 
     /// Loads a single package in the context of a previously loaded graph. This can be useful for incremental loading
     /// in a longer-lived program, like an IDE.
+    @available(*, noasync, message: "Use the async alternative")
     public func loadPackage(
         with identity: PackageIdentity,
         packageGraph: PackageGraph,

Tests/WorkspaceTests/ManifestSourceGenerationTests.swift

@@ -43,8 +43,8 @@ class ManifestSourceGenerationTests: XCTestCase {
         toolsVersionHeaderComment: String? = .none,
         additionalImportModuleNames: [String] = [],
         fs: FileSystem = localFileSystem
-    ) throws -> String {
-        try withTemporaryDirectory { packageDir in
+    ) async throws -> String {
+        try await withTemporaryDirectory { packageDir in
             let observability = ObservabilitySystem.makeForTesting()
 
             // Write the original manifest file contents, and load it.
@@ -53,23 +53,20 @@ class ManifestSourceGenerationTests: XCTestCase {
             let manifestLoader = ManifestLoader(toolchain: try UserToolchain.default)
             let identityResolver = DefaultIdentityResolver()
             let dependencyMapper = DefaultDependencyMapper(identityResolver: identityResolver)
-            let manifest = try temp_await {
-                manifestLoader.load(
-                    manifestPath: manifestPath,
-                    manifestToolsVersion: toolsVersion,
-                    packageIdentity: .plain("Root"),
-                    packageKind: .root(packageDir),
-                    packageLocation: packageDir.pathString,
-                    packageVersion: nil,
-                    identityResolver: identityResolver,
-                    dependencyMapper: dependencyMapper,
-                    fileSystem: fs,
-                    observabilityScope: observability.topScope,
-                    delegateQueue: .sharedConcurrent,
-                    callbackQueue: .sharedConcurrent,
-                    completion: $0
-                )
-            }
+            let manifest = try await manifestLoader.load(
+                manifestPath: manifestPath,
+                manifestToolsVersion: toolsVersion,
+                packageIdentity: .plain("Root"),
+                packageKind: .root(packageDir),
+                packageLocation: packageDir.pathString,
+                packageVersion: nil,
+                identityResolver: identityResolver,
+                dependencyMapper: dependencyMapper,
+                fileSystem: fs,
+                observabilityScope: observability.topScope,
+                delegateQueue: .sharedConcurrent,
+                callbackQueue: .sharedConcurrent
+            )
 
             XCTAssertNoDiagnostics(observability.diagnostics)
 
@@ -85,23 +82,20 @@ class ManifestSourceGenerationTests: XCTestCase {
 
             // Write out the generated manifest to replace the old manifest file contents, and load it again.
             try fs.writeFileContents(manifestPath, string: newContents)
-            let newManifest = try temp_await {
-                manifestLoader.load(
-                    manifestPath: manifestPath,
-                    manifestToolsVersion: toolsVersion,
-                    packageIdentity: .plain("Root"),
-                    packageKind: .root(packageDir),
-                    packageLocation: packageDir.pathString,
-                    packageVersion: nil,
-                    identityResolver: identityResolver,
-                    dependencyMapper: dependencyMapper,
-                    fileSystem: fs,
-                    observabilityScope: observability.topScope,
-                    delegateQueue: .sharedConcurrent,
-                    callbackQueue: .sharedConcurrent,
-                    completion: $0
-                )
-            }
+            let newManifest = try await manifestLoader.load(
+                manifestPath: manifestPath,
+                manifestToolsVersion: toolsVersion,
+                packageIdentity: .plain("Root"),
+                packageKind: .root(packageDir),
+                packageLocation: packageDir.pathString,
+                packageVersion: nil,
+                identityResolver: identityResolver,
+                dependencyMapper: dependencyMapper,
+                fileSystem: fs,
+                observabilityScope: observability.topScope,
+                delegateQueue: .sharedConcurrent,
+                callbackQueue: .sharedConcurrent
+            )
 
             XCTAssertNoDiagnostics(observability.diagnostics)
 
@@ -125,7 +119,7 @@ class ManifestSourceGenerationTests: XCTestCase {
         }
     }
 
-    func testBasics() throws {
+    func testBasics() async throws {
         let manifestContents = """
             // swift-tools-version:5.3
             // The swift-tools-version declares the minimum version of Swift required to build this package.
@@ -160,10 +154,10 @@ class ManifestSourceGenerationTests: XCTestCase {
                 ]
             )
             """
-        try testManifestWritingRoundTrip(manifestContents: manifestContents, toolsVersion: .v5_3)
+        try await testManifestWritingRoundTrip(manifestContents: manifestContents, toolsVersion: .v5_3)
     }
 
-    func testCustomPlatform() throws {
+    func testCustomPlatform() async throws {
         let manifestContents = """
             // swift-tools-version:5.6
             // The swift-tools-version declares the minimum version of Swift required to build this package.
@@ -197,10 +191,10 @@ class ManifestSourceGenerationTests: XCTestCase {
                 ]
             )
             """
-        try testManifestWritingRoundTrip(manifestContents: manifestContents, toolsVersion: .v5_6)
+        try await testManifestWritingRoundTrip(manifestContents: manifestContents, toolsVersion: .v5_6)
     }
 
-    func testAdvancedFeatures() throws {
+    func testAdvancedFeatures() async throws {
         let manifestContents = """
             // swift-tools-version:5.3
             // The swift-tools-version declares the minimum version of Swift required to build this package.
@@ -246,10 +240,10 @@ class ManifestSourceGenerationTests: XCTestCase {
                 cxxLanguageStandard: .cxx11
             )
             """
-        try testManifestWritingRoundTrip(manifestContents: manifestContents, toolsVersion: .v5_3)
+        try await testManifestWritingRoundTrip(manifestContents: manifestContents, toolsVersion: .v5_3)
     }
 
-    func testPackageDependencyVariations() throws {
+    func testPackageDependencyVariations() async throws {
         let manifestContents = """
             // swift-tools-version:5.4
             import PackageDescription
@@ -281,15 +275,15 @@ class ManifestSourceGenerationTests: XCTestCase {
                 ]
             )
             """
-        let newContents = try testManifestWritingRoundTrip(manifestContents: manifestContents, toolsVersion: .v5_3)
+        let newContents = try await testManifestWritingRoundTrip(manifestContents: manifestContents, toolsVersion: .v5_3)
 
         // Check some things about the contents of the manifest.
         XCTAssertTrue(newContents.contains("url: \"\("../MyPkg10".nativePathString(escaped: true))\""), newContents)
         XCTAssertTrue(newContents.contains("path: \"\("../MyPkg11".nativePathString(escaped: true))\""), newContents)
         XCTAssertTrue(newContents.contains("path: \"\("packages/path/to/MyPkg12".nativePathString(escaped: true))"), newContents)
     }
 
-    func testResources() throws {
+    func testResources() async throws {
         let manifestContents = """
             // swift-tools-version:5.3
             import PackageDescription
@@ -320,10 +314,10 @@ class ManifestSourceGenerationTests: XCTestCase {
                 ]
             )
             """
-        try testManifestWritingRoundTrip(manifestContents: manifestContents, toolsVersion: .v5_3)
+        try await testManifestWritingRoundTrip(manifestContents: manifestContents, toolsVersion: .v5_3)
     }
 
-    func testBuildSettings() throws {
+    func testBuildSettings() async throws {
         let manifestContents = """
             // swift-tools-version:5.3
             import PackageDescription
@@ -356,10 +350,10 @@ class ManifestSourceGenerationTests: XCTestCase {
                 ]
             )
             """
-        try testManifestWritingRoundTrip(manifestContents: manifestContents, toolsVersion: .v5_3)
+        try await testManifestWritingRoundTrip(manifestContents: manifestContents, toolsVersion: .v5_3)
     }
 
-    func testPluginTargets() throws {
+    func testPluginTargets() async throws {
         let manifestContents = """
             // swift-tools-version:5.5
             import PackageDescription
@@ -378,10 +372,10 @@ class ManifestSourceGenerationTests: XCTestCase {
                 ]
             )
             """
-        try testManifestWritingRoundTrip(manifestContents: manifestContents, toolsVersion: .v5_5)
+        try await testManifestWritingRoundTrip(manifestContents: manifestContents, toolsVersion: .v5_5)
     }
 
-    func testCustomToolsVersionHeaderComment() throws {
+    func testCustomToolsVersionHeaderComment() async throws {
         let manifestContents = """
             // swift-tools-version:5.5
             import PackageDescription
@@ -400,12 +394,12 @@ class ManifestSourceGenerationTests: XCTestCase {
                 ]
             )
             """
-        let newContents = try testManifestWritingRoundTrip(manifestContents: manifestContents, toolsVersion: .v5_5, toolsVersionHeaderComment: "a comment")
+        let newContents = try await testManifestWritingRoundTrip(manifestContents: manifestContents, toolsVersion: .v5_5, toolsVersionHeaderComment: "a comment")
 
         XCTAssertTrue(newContents.hasPrefix("// swift-tools-version: 5.5; a comment\n"), "contents: \(newContents)")
     }
 
-    func testAdditionalModuleImports() throws {
+    func testAdditionalModuleImports() async throws {
         let manifestContents = """
             // swift-tools-version:5.5
             import PackageDescription
@@ -420,12 +414,12 @@ class ManifestSourceGenerationTests: XCTestCase {
                 ]
             )
             """
-        let newContents = try testManifestWritingRoundTrip(manifestContents: manifestContents, toolsVersion: .v5_5, additionalImportModuleNames: ["Foundation"])
+        let newContents = try await testManifestWritingRoundTrip(manifestContents: manifestContents, toolsVersion: .v5_5, additionalImportModuleNames: ["Foundation"])
 
         XCTAssertTrue(newContents.contains("import Foundation\n"), "contents: \(newContents)")
     }
 
-    func testLatestPlatformVersions() throws {
+    func testLatestPlatformVersions() async throws {
         let manifestContents = """
             // swift-tools-version: 5.9
             // The swift-tools-version declares the minimum version of Swift required to build this package.
@@ -447,10 +441,10 @@ class ManifestSourceGenerationTests: XCTestCase {
                 ]
             )
             """
-        try testManifestWritingRoundTrip(manifestContents: manifestContents, toolsVersion: .v5_9)
+        try await testManifestWritingRoundTrip(manifestContents: manifestContents, toolsVersion: .v5_9)
     }
 
-    func testTargetPlatformConditions() throws {
+    func testTargetPlatformConditions() async throws {
         let manifestContents = """
             // swift-tools-version: 5.9
             // The swift-tools-version declares the minimum version of Swift required to build this package.
@@ -475,7 +469,7 @@ class ManifestSourceGenerationTests: XCTestCase {
                 ]
             )
             """
-        try testManifestWritingRoundTrip(manifestContents: manifestContents, toolsVersion: .v5_9)
+        try await testManifestWritingRoundTrip(manifestContents: manifestContents, toolsVersion: .v5_9)
     }
 
     func testCustomProductSourceGeneration() throws {
@@ -517,7 +511,7 @@ class ManifestSourceGenerationTests: XCTestCase {
         XCTAssertTrue(contents.contains(".library(name: \"Foo\", targets: [\"Bar\"], type: .static)"), "contents: \(contents)")
     }
 
-    func testModuleAliasGeneration() throws {
+    func testModuleAliasGeneration() async throws {
         let manifest = Manifest.createRootManifest(
             displayName: "thisPkg",
             path: "/thisPkg",
@@ -558,10 +552,10 @@ class ManifestSourceGenerationTests: XCTestCase {
         let isContained = trimmedParts.allSatisfy(trimmedContents.contains(_:))
         XCTAssertTrue(isContained)
 
-        try testManifestWritingRoundTrip(manifestContents: contents, toolsVersion: .v5_8)
+        try await testManifestWritingRoundTrip(manifestContents: contents, toolsVersion: .v5_8)
     }
 
-    func testUpcomingAndExperimentalFeatures() throws {
+    func testUpcomingAndExperimentalFeatures() async throws {
         let manifestContents = """
             // swift-tools-version:5.8
             import PackageDescription
@@ -580,10 +574,10 @@ class ManifestSourceGenerationTests: XCTestCase {
                 ]
             )
             """
-        try testManifestWritingRoundTrip(manifestContents: manifestContents, toolsVersion: .v5_8)
+        try await testManifestWritingRoundTrip(manifestContents: manifestContents, toolsVersion: .v5_8)
     }
 
-    func testPluginNetworkingPermissionGeneration() throws {
+    func testPluginNetworkingPermissionGeneration() async throws {
         let manifest = Manifest.createRootManifest(
             displayName: "thisPkg",
             path: "/thisPkg",
@@ -593,6 +587,6 @@ class ManifestSourceGenerationTests: XCTestCase {
                 try TargetDescription(name: "MyPlugin", type: .plugin, pluginCapability: .command(intent: .custom(verb: "foo", description: "bar"), permissions: [.allowNetworkConnections(scope: .all(ports: [23, 42, 443, 8080]), reason: "internet good")]))
             ])
         let contents = try manifest.generateManifestFileContents(packageDirectory: manifest.path.parentDirectory)
-        try testManifestWritingRoundTrip(manifestContents: contents, toolsVersion: .v5_9)
+        try await testManifestWritingRoundTrip(manifestContents: contents, toolsVersion: .v5_9)
     }
 }