remove the use of async/await in commands (#6254)

motivation: async-await does not work on our CI systems :(

changes:
* make all commands sync
* changes signing APIs to sync

Author: tomerd

Sources/PackageRegistryTool/PackageRegistryTool+Auth.swift

@@ -58,7 +58,7 @@ private func getpass(_ prompt: String) -> UnsafePointer<CChar> {
 #endif
 
 extension SwiftPackageRegistryTool {
-    struct Login: AsyncSwiftCommand {
+    struct Login: SwiftCommand {
         static let configuration = CommandConfiguration(
             abstract: "Log in to a registry"
         )
@@ -87,7 +87,7 @@ extension SwiftPackageRegistryTool {
 
         private static let PLACEHOLDER_TOKEN_USER = "token"
 
-        func run(_ swiftTool: SwiftTool) async throws {
+        func run(_ swiftTool: SwiftTool) throws {
             let configuration = try getRegistriesConfig(swiftTool)
 
             // compute and validate registry URL
@@ -257,7 +257,7 @@ extension SwiftPackageRegistryTool {
         }
     }
 
-    struct Logout: AsyncSwiftCommand {
+    struct Logout: SwiftCommand {
         static let configuration = CommandConfiguration(
             abstract: "Log out from a registry"
         )
@@ -272,7 +272,7 @@ extension SwiftPackageRegistryTool {
             self.url
         }
 
-        func run(_ swiftTool: SwiftTool) async throws {
+        func run(_ swiftTool: SwiftTool) throws {
             let configuration = try getRegistriesConfig(swiftTool)
 
             // compute and validate registry URL

Sources/PackageRegistryTool/PackageRegistryTool+Publish.swift

@@ -10,7 +10,6 @@
 //
 //===----------------------------------------------------------------------===//
 
-import _Concurrency
 import ArgumentParser
 import Basics
 import Commands
@@ -25,8 +24,7 @@ import Workspace
 import struct TSCUtility.Version
 
 extension SwiftPackageRegistryTool {
-    @available(macOS 12, iOS 15, tvOS 15, watchOS 8, *)
-    struct Publish: AsyncSwiftCommand {
+    struct Publish: SwiftCommand {
         static let metadataFilename = "package-metadata.json"
 
         static let configuration = CommandConfiguration(
@@ -78,7 +76,7 @@ extension SwiftPackageRegistryTool {
         @Flag(help: "Dry run only; prepare the archive and sign it but do not publish to the registry.")
         var dryRun: Bool = false
 
-        func run(_ swiftTool: SwiftTool) async throws {
+        func run(_ swiftTool: SwiftTool) throws {
             let configuration = try getRegistriesConfig(swiftTool).configuration
 
             // validate package location
@@ -194,7 +192,7 @@ extension SwiftPackageRegistryTool {
                 swiftTool.observabilityScope.emit(info: "signing the archive at '\(archivePath)'")
                 let signaturePath = workingDirectory
                     .appending("\(self.packageIdentity)-\(self.packageVersion).sig")
-                signature = try await PackageArchiveSigner.sign(
+                signature = try PackageArchiveSigner.sign(
                     archivePath: archivePath,
                     signaturePath: signaturePath,
                     mode: signingMode,
@@ -214,17 +212,21 @@ extension SwiftPackageRegistryTool {
 
             swiftTool.observabilityScope
                 .emit(info: "publishing '\(self.packageIdentity)' archive at '\(archivePath)' to '\(registryURL)'")
-            let result = try await registryClient.publish(
-                registryURL: registryURL,
-                packageIdentity: self.packageIdentity,
-                packageVersion: self.packageVersion,
-                packageArchive: archivePath,
-                packageMetadata: self.customMetadataPath,
-                signature: signature,
-                signatureFormat: self.signatureFormat,
-                fileSystem: localFileSystem,
-                observabilityScope: swiftTool.observabilityScope
-            )
+            let result = try tsc_await {
+                registryClient.publish(
+                    registryURL: registryURL,
+                    packageIdentity: self.packageIdentity,
+                    packageVersion: self.packageVersion,
+                    packageArchive: archivePath,
+                    packageMetadata: self.customMetadataPath,
+                    signature: signature,
+                    signatureFormat: self.signatureFormat,
+                    fileSystem: localFileSystem,
+                    observabilityScope: swiftTool.observabilityScope,
+                    callbackQueue: .sharedConcurrent,
+                    completion: $0
+                )
+            }
 
             switch result {
             case .published(.none):
@@ -289,36 +291,3 @@ enum MetadataLocation {
         }
     }
 }
-
-// TODO: migrate registry client to async
-extension RegistryClient {
-    @available(macOS 12, iOS 15, tvOS 15, watchOS 8, *)
-    public func publish(
-        registryURL: URL,
-        packageIdentity: PackageIdentity,
-        packageVersion: Version,
-        packageArchive: AbsolutePath,
-        packageMetadata: AbsolutePath?,
-        signature: [UInt8]?,
-        signatureFormat: SignatureFormat?,
-        timeout: DispatchTimeInterval? = .none,
-        fileSystem: FileSystem,
-        observabilityScope: ObservabilityScope
-    ) async throws -> PublishResult {
-        try await withCheckedThrowingContinuation { continuation in
-            self.publish(
-                registryURL: registryURL,
-                packageIdentity: packageIdentity,
-                packageVersion: packageVersion,
-                packageArchive: packageArchive,
-                packageMetadata: packageMetadata,
-                signature: signature,
-                signatureFormat: signatureFormat,
-                fileSystem: fileSystem,
-                observabilityScope: observabilityScope,
-                callbackQueue: .sharedConcurrent,
-                completion: continuation.resume(with:)
-            )
-        }
-    }
-}

Sources/PackageRegistryTool/PackageRegistryTool+Sign.swift

@@ -10,18 +10,17 @@
 //
 //===----------------------------------------------------------------------===//
 
-import _Concurrency
-
 import ArgumentParser
 import Basics
 import CoreCommands
 import PackageSigning
 import TSCBasic
 @_implementationOnly import X509 // FIXME: need this import or else SwiftSigningIdentity init at L139 fails
 
+import struct Foundation.Data
+
 extension SwiftPackageRegistryTool {
-    @available(macOS 12, iOS 15, tvOS 15, watchOS 8, *)
-    struct Sign: AsyncSwiftCommand {
+    struct Sign: SwiftCommand {
         static let configuration = CommandConfiguration(
             abstract: "Sign a package source archive"
         )
@@ -56,7 +55,7 @@ extension SwiftPackageRegistryTool {
         )
         var certificateChainPaths: [AbsolutePath] = []
 
-        func run(_ swiftTool: SwiftTool) async throws {
+        func run(_ swiftTool: SwiftTool) throws {
             // Validate source archive path
             guard localFileSystem.exists(self.sourceArchivePath) else {
                 throw StringError("Source archive not found at '\(self.sourceArchivePath)'.")
@@ -90,7 +89,7 @@ extension SwiftPackageRegistryTool {
             }
 
             swiftTool.observabilityScope.emit(info: "signing the archive at '\(self.sourceArchivePath)'")
-            try await PackageArchiveSigner.sign(
+            try PackageArchiveSigner.sign(
                 archivePath: self.sourceArchivePath,
                 signaturePath: self.signaturePath,
                 mode: signingMode,
@@ -108,7 +107,6 @@ extension SignatureFormat: ExpressibleByArgument {
     }
 }
 
-@available(macOS 12, iOS 15, tvOS 15, watchOS 8, *)
 public enum PackageArchiveSigner {
     @discardableResult
     public static func sign(
@@ -118,15 +116,15 @@ public enum PackageArchiveSigner {
         signatureFormat: SignatureFormat,
         fileSystem: FileSystem,
         observabilityScope: ObservabilityScope
-    ) async throws -> [UInt8] {
+    ) throws -> [UInt8] {
         let archiveData = try fileSystem.readFileContents(archivePath)
 
         let signingIdentity: SigningIdentity
         let intermediateCertificates: [[UInt8]]
         switch mode {
         case .identityStore(let label, let intermediateCertPaths):
             let signingIdentityStore = SigningIdentityStore(observabilityScope: observabilityScope)
-            let matches = await signingIdentityStore.find(by: label)
+            let matches = signingIdentityStore.find(by: label)
             guard let identity = matches.first else {
                 throw StringError("'\(label)' not found in the system identity store.")
             }
@@ -144,7 +142,7 @@ public enum PackageArchiveSigner {
             intermediateCertificates = try intermediateCertPaths.map { try fileSystem.readFileContents($0).contents }
         }
 
-        let signature = try await SignatureProvider.sign(
+        let signature = try SignatureProvider.sign(
             content: archiveData.contents,
             identity: signingIdentity,
             intermediateCertificates: intermediateCertificates,

Sources/PackageRegistryTool/PackageRegistryTool.swift

@@ -20,43 +20,30 @@ import TSCBasic
 import Workspace
 
 @available(macOS 10.15, macCatalyst 13, iOS 13, tvOS 13, watchOS 6, *)
-public struct SwiftPackageRegistryTool: AsyncParsableCommand {
+public struct SwiftPackageRegistryTool: ParsableCommand {
     public static var configuration = CommandConfiguration(
         commandName: "package-registry",
         _superCommandName: "swift",
         abstract: "Interact with package registry and manage related configuration",
         discussion: "SEE ALSO: swift package",
         version: SwiftVersion.current.completeDisplayString,
-        subcommands: Self.subcommands,
+        subcommands:[
+            Set.self,
+            Unset.self,
+            Login.self,
+            Logout.self,
+            Publish.self,
+            Sign.self,
+        ],
         helpNames: [.short, .long, .customLong("help", withSingleDash: true)]
     )
 
-    private static var subcommands: [ParsableCommand.Type] {
-        if #available(macOS 12, iOS 15, tvOS 15, watchOS 8, *) {
-            return [
-                Set.self,
-                Unset.self,
-                Login.self,
-                Logout.self,
-                Publish.self,
-                Sign.self,
-            ] as [ParsableCommand.Type]
-        } else {
-            return [
-                Set.self,
-                Unset.self,
-                Login.self,
-                Logout.self,
-            ] as [ParsableCommand.Type]
-        }
-    }
-
     @OptionGroup()
     var globalOptions: GlobalOptions
 
     public init() {}
 
-    struct Set: AsyncSwiftCommand {
+    struct Set: SwiftCommand {
         static let configuration = CommandConfiguration(
             abstract: "Set a custom registry"
         )
@@ -77,7 +64,7 @@ public struct SwiftPackageRegistryTool: AsyncParsableCommand {
             self.url
         }
 
-        func run(_ swiftTool: SwiftTool) async throws {
+        func run(_ swiftTool: SwiftTool) throws {
             try self.registryURL.validateRegistryURL()
 
             let scope = try scope.map(PackageIdentity.Scope.init(validating:))
@@ -99,7 +86,7 @@ public struct SwiftPackageRegistryTool: AsyncParsableCommand {
         }
     }
 
-    struct Unset: AsyncSwiftCommand {
+    struct Unset: SwiftCommand {
         static let configuration = CommandConfiguration(
             abstract: "Remove a configured registry"
         )
@@ -113,7 +100,7 @@ public struct SwiftPackageRegistryTool: AsyncParsableCommand {
         @Option(help: "Associate the registry with a given scope")
         var scope: String?
 
-        func run(_ swiftTool: SwiftTool) async throws {
+        func run(_ swiftTool: SwiftTool) throws {
             let scope = try scope.map(PackageIdentity.Scope.init(validating:))
 
             let unset: (inout RegistryConfiguration) throws -> Void = { configuration in

Sources/PackageSigning/SignatureProvider.swift

@@ -27,9 +27,9 @@ public enum SignatureProvider {
         intermediateCertificates: [[UInt8]],
         format: SignatureFormat,
         observabilityScope: ObservabilityScope
-    ) async throws -> [UInt8] {
+    ) throws -> [UInt8] {
         let provider = format.provider
-        return try await provider.sign(
+        return try provider.sign(
             content: content,
             identity: identity,
             intermediateCertificates: intermediateCertificates,
@@ -141,7 +141,7 @@ protocol SignatureProviderProtocol {
         identity: SigningIdentity,
         intermediateCertificates: [[UInt8]],
         observabilityScope: ObservabilityScope
-    ) async throws -> [UInt8]
+    ) throws -> [UInt8]
 
     func status(
         signature: [UInt8],
@@ -165,7 +165,7 @@ struct CMSSignatureProvider: SignatureProviderProtocol {
         identity: SigningIdentity,
         intermediateCertificates: [[UInt8]],
         observabilityScope: ObservabilityScope
-    ) async throws -> [UInt8] {
+    ) throws -> [UInt8] {
         #if canImport(Security)
         if CFGetTypeID(identity as CFTypeRef) == SecIdentityGetTypeID() {
             let secIdentity = identity as! SecIdentity // !-safe because we ensure type above

Sources/PackageSigning/SigningIdentity.swift

@@ -79,7 +79,7 @@ public struct SigningIdentityStore {
         self.observabilityScope = observabilityScope
     }
 
-    public func find(by label: String) async -> [SigningIdentity] {
+    public func find(by label: String) -> [SigningIdentity] {
         #if os(macOS)
         // Find in Keychain
         let query: [String: Any] = [

Sources/swift-package-registry/runner.swift

@@ -15,7 +15,7 @@ import PackageRegistryTool
 
 @main
 struct Runner {
-    static func main() async {
-        await SwiftPackageRegistryTool.main()
+    static func main() {
+        SwiftPackageRegistryTool.main()
     }
 }