Remove temp_await [part 2] (#7845)

Author: AndrewHoos

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

@@ -26,8 +26,8 @@ struct Example {
 
         let package = try await workspace.loadRootPackage(at: packagePath, observabilityScope: observability.topScope)
 
-        let graph = try workspace.loadPackageGraph(rootPath: packagePath, observabilityScope: observability.topScope)
-        
+        let graph = try await workspace.loadPackageGraph(rootPath: packagePath, observabilityScope: observability.topScope)
+
         // EXAMPLES
         // ========
 

Sources/Basics/Graph/GraphAlgorithms.swift

@@ -55,3 +55,34 @@ public func depthFirstSearch<T: Hashable>(
         }
     }
 }
+
+public func depthFirstSearch<T: Hashable>(
+    _ nodes: [T],
+    successors: (T) async throws -> [T],
+    onUnique: (T) -> Void,
+    onDuplicate: (T, T) -> Void
+) async rethrows {
+    var stack = OrderedSet<T>()
+    var visited = Set<T>()
+
+    for node in nodes {
+        precondition(stack.isEmpty)
+        stack.append(node)
+
+        while !stack.isEmpty {
+            let curr = stack.removeLast()
+
+            let visitResult = visited.insert(curr)
+            if visitResult.inserted {
+                onUnique(curr)
+            } else {
+                onDuplicate(visitResult.memberAfterInsert, curr)
+                continue
+            }
+
+            for succ in try await successors(curr) {
+                stack.append(succ)
+            }
+        }
+    }
+}

Sources/Basics/Observability.swift

@@ -250,6 +250,18 @@ extension DiagnosticsEmitterProtocol {
         }
     }
 
+    public func trap<T>(_ closure: () async throws -> T) async -> T? {
+        do {
+            return try await closure()
+        } catch Diagnostics.fatalError {
+            // FIXME: (diagnostics) deprecate this with Diagnostics.fatalError
+            return nil
+        } catch {
+            self.emit(error)
+            return nil
+        }
+    }
+
     /// trap a throwing closure, emitting diagnostics on error and returning boolean representing success
     @discardableResult
     public func trap(_ closure: () throws -> Void) -> Bool {
@@ -265,6 +277,20 @@ extension DiagnosticsEmitterProtocol {
         }
     }
 
+    @discardableResult
+    public func trap(_ closure: () async throws -> Void) async -> Bool {
+        do {
+            try await closure()
+            return true
+        } catch Diagnostics.fatalError {
+            // FIXME: (diagnostics) deprecate this with Diagnostics.fatalError
+            return false
+        } catch {
+            self.emit(error)
+            return false
+        }
+    }
+
     /// If `underlyingError` is not `nil`, its human-readable description is interpolated with `message`,
     /// otherwise `message` itself is returned.
     private func makeMessage(from message: String, underlyingError: Error?) -> String {

Sources/Build/BuildOperation.swift

@@ -266,6 +266,7 @@ public final class BuildOperation: PackageStructureDelegate, SPMBuildCore.BuildS
         self.pkgConfigDirectories = pkgConfigDirectories
     }
 
+    @available(*, noasync, message: "This must only be called from a dispatch queue")
     public func getPackageGraph() throws -> ModulesGraph {
         try self.packageGraph.memoize {
             try self.packageGraphLoader()

Sources/Commands/PackageCommands/APIDiff.swift

@@ -32,7 +32,7 @@ struct DeprecatedAPIDiff: ParsableCommand {
     }
 }
 
-struct APIDiff: SwiftCommand {
+struct APIDiff: AsyncSwiftCommand {
     static let configuration = CommandConfiguration(
         commandName: "diagnose-api-breaking-changes",
         abstract: "Diagnose API-breaking changes to Swift modules in a package",
@@ -77,7 +77,7 @@ struct APIDiff: SwiftCommand {
     @Flag(help: "Regenerate the API baseline, even if an existing one is available.")
     var regenerateBaseline: Bool = false
 
-    func run(_ swiftCommandState: SwiftCommandState) throws {
+    func run(_ swiftCommandState: SwiftCommandState) async throws {
         let apiDigesterPath = try swiftCommandState.getTargetToolchain().getSwiftAPIDigester()
         let apiDigesterTool = SwiftAPIDigester(fileSystem: swiftCommandState.fileSystem, tool: apiDigesterPath)
 
@@ -111,7 +111,7 @@ struct APIDiff: SwiftCommand {
             observabilityScope: swiftCommandState.observabilityScope
         )
 
-        let baselineDir = try baselineDumper.emitAPIBaseline(
+        let baselineDir = try await baselineDumper.emitAPIBaseline(
             for: modulesToDiff,
             at: overrideBaselineDir,
             force: regenerateBaseline,

Sources/Commands/PackageCommands/ArchiveSource.swift

@@ -38,7 +38,7 @@ extension SwiftPackageCommand {
             if let output {
                 archivePath = output
             } else {
-                let graph = try swiftCommandState.loadPackageGraph()
+                let graph = try await swiftCommandState.loadPackageGraph()
                 let packageName = graph.rootPackages[graph.rootPackages.startIndex].manifest.displayName // TODO: use identity instead?
                 archivePath = packageDirectory.appending("\(packageName).zip")
             }

Sources/Commands/PackageCommands/CompletionCommand.swift

@@ -16,7 +16,7 @@ import CoreCommands
 import var TSCBasic.stdoutStream
 
 extension SwiftPackageCommand {
-    struct CompletionCommand: SwiftCommand {
+    struct CompletionCommand: AsyncSwiftCommand {
         static let configuration = CommandConfiguration(
             commandName: "completion-tool",
             abstract: "Completion command (for shell completions)"
@@ -52,7 +52,7 @@ extension SwiftPackageCommand {
         @Argument(help: "generate-bash-script | generate-zsh-script |\ngenerate-fish-script | list-dependencies | list-executables")
         var mode: Mode
 
-        func run(_ swiftCommandState: SwiftCommandState) throws {
+        func run(_ swiftCommandState: SwiftCommandState) async throws {
             switch mode {
             case .generateBashScript:
                 let script = SwiftCommand.completionScript(for: .bash)
@@ -64,7 +64,7 @@ extension SwiftPackageCommand {
                 let script = SwiftCommand.completionScript(for: .fish)
                 print(script)
             case .listDependencies:
-                let graph = try swiftCommandState.loadPackageGraph()
+                let graph = try await swiftCommandState.loadPackageGraph()
                 // command's result output goes on stdout
                 // ie "swift package list-dependencies" should output to stdout
                 ShowDependencies.dumpDependenciesOf(
@@ -74,14 +74,14 @@ extension SwiftPackageCommand {
                     on: TSCBasic.stdoutStream
                 )
             case .listExecutables:
-                let graph = try swiftCommandState.loadPackageGraph()
+                let graph = try await swiftCommandState.loadPackageGraph()
                 let package = graph.rootPackages[graph.rootPackages.startIndex].underlying
                 let executables = package.modules.filter { $0.type == .executable }
                 for executable in executables {
                     print(executable.name)
                 }
             case .listSnippets:
-                let graph = try swiftCommandState.loadPackageGraph()
+                let graph = try await swiftCommandState.loadPackageGraph()
                 let package = graph.rootPackages[graph.rootPackages.startIndex].underlying
                 let executables = package.modules.filter { $0.type == .snippet }
                 for executable in executables {

Sources/Commands/PackageCommands/DumpCommands.swift

@@ -131,7 +131,7 @@ struct DumpPackage: AsyncSwiftCommand {
     }
 }
 
-struct DumpPIF: SwiftCommand {
+struct DumpPIF: AsyncSwiftCommand {
     // hides this command from CLI `--help` output
     static let configuration = CommandConfiguration(shouldDisplay: false) 
 
@@ -141,8 +141,8 @@ struct DumpPIF: SwiftCommand {
     @Flag(help: "Preserve the internal structure of PIF")
     var preserveStructure: Bool = false
 
-    func run(_ swiftCommandState: SwiftCommandState) throws {
-        let graph = try swiftCommandState.loadPackageGraph()
+    func run(_ swiftCommandState: SwiftCommandState) async throws {
+        let graph = try await swiftCommandState.loadPackageGraph()
         let pif = try PIFBuilder.generatePIF(
             buildParameters: swiftCommandState.productsBuildParameters,
             packageGraph: graph,

Sources/Commands/PackageCommands/EditCommands.swift

@@ -16,7 +16,7 @@ import CoreCommands
 import SourceControl
 
 extension SwiftPackageCommand {
-    struct Edit: SwiftCommand {
+    struct Edit: AsyncSwiftCommand {
         static let configuration = CommandConfiguration(
             abstract: "Put a package in editable mode")
 
@@ -35,12 +35,12 @@ extension SwiftPackageCommand {
         @Argument(help: "The name of the package to edit")
         var packageName: String
 
-        func run(_ swiftCommandState: SwiftCommandState) throws {
-            try swiftCommandState.resolve()
+        func run(_ swiftCommandState: SwiftCommandState) async throws {
+            try await swiftCommandState.resolve()
             let workspace = try swiftCommandState.getActiveWorkspace()
 
             // Put the dependency in edit mode.
-            workspace.edit(
+            await workspace.edit(
                 packageName: packageName,
                 path: path,
                 revision: revision,
@@ -50,7 +50,7 @@ extension SwiftPackageCommand {
         }
     }
 
-    struct Unedit: SwiftCommand {
+    struct Unedit: AsyncSwiftCommand {
         static let configuration = CommandConfiguration(
             abstract: "Remove a package from editable mode")
 
@@ -64,11 +64,11 @@ extension SwiftPackageCommand {
         @Argument(help: "The name of the package to unedit")
         var packageName: String
 
-        func run(_ swiftCommandState: SwiftCommandState) throws {
-            try swiftCommandState.resolve()
+        func run(_ swiftCommandState: SwiftCommandState) async throws {
+            try await swiftCommandState.resolve()
             let workspace = try swiftCommandState.getActiveWorkspace()
 
-            try workspace.unedit(
+            try await workspace.unedit(
                 packageName: packageName,
                 forceRemove: shouldForceRemove,
                 root: swiftCommandState.getWorkspaceRoot(),

Sources/Commands/PackageCommands/Install.swift

@@ -18,7 +18,7 @@ import PackageModel
 import TSCBasic
 
 extension SwiftPackageCommand {
-    struct Install: SwiftCommand {
+    struct Install: AsyncSwiftCommand {
         static let configuration = CommandConfiguration(
             commandName: "experimental-install",
             abstract: "Offers the ability to install executable products of the current package."
@@ -30,7 +30,7 @@ extension SwiftPackageCommand {
         @Option(help: "The name of the executable product to install")
         var product: String?
 
-        func run(_ commandState: SwiftCommandState) throws {
+        func run(_ commandState: SwiftCommandState) async throws {
             let swiftpmBinDir = try commandState.fileSystem.getOrCreateSwiftPMInstalledBinariesDirectory()
 
             let env = Environment.current
@@ -49,7 +49,7 @@ extension SwiftPackageCommand {
             let workspace = try commandState.getActiveWorkspace()
             let packageRoot = try commandState.getPackageRoot()
 
-            let packageGraph = try workspace.loadPackageGraph(
+            let packageGraph = try await workspace.loadPackageGraph(
                 rootPath: packageRoot,
                 observabilityScope: commandState.observabilityScope
             )