Move PackageRegistryTool to async/await (#7190)

### Motivation: Continue replacing older Dispatch-based concurrency primitives with native `async`/`await`. ### Modifications: Replace all usage of `temp_await` with actual `async`/`await` in the `PackageRegistryTool`. ### Result: One additional executable target that is natively `async`/`await`.

Author: AndrewHoos

Sources/PackageRegistryTool/PackageRegistryTool+Auth.swift

@@ -89,7 +89,7 @@ private func readpassword(_ prompt: String) throws -> String {
 #endif
 
 extension SwiftPackageRegistryTool {
- struct Login: SwiftCommand {
+ struct Login: AsyncSwiftCommand {
 
  static func loginURL(from registryURL: URL, loginAPIPath: String?) throws -> URL {
  // Login URL must be HTTPS
@@ -144,7 +144,7 @@ extension SwiftPackageRegistryTool {
 
  private static let PLACEHOLDER_TOKEN_USER = "token"
 
- func run(_ swiftTool: SwiftTool) throws {
+ func run(_ swiftTool: SwiftTool) async throws {
  // We need to be able to read/write credentials
  // Make sure credentials store is available before proceeding
  let authorizationProvider: AuthorizationProvider?
@@ -220,15 +220,12 @@ extension SwiftPackageRegistryTool {
  }
 
  // Save in cache so we can try the credentials and persist to storage only if login succeeds
- try temp_await { callback in
- authorizationWriter?.addOrUpdate(
- for: registryURL,
- user: storeUsername,
- password: storePassword,
- persist: false,
- callback: callback
- )
- }
+ try await authorizationWriter?.addOrUpdate(
+ for: registryURL,
+ user: storeUsername,
+ password: storePassword,
+ persist: false
+ )
 
  // `url` can either be base URL of the registry, in which case the login API
  // is assumed to be at /login, or the full URL of the login API.
@@ -258,15 +255,13 @@ extension SwiftPackageRegistryTool {
  )
 
  // Try logging in
- try temp_await { callback in
- registryClient.login(
- loginURL: loginURL,
- timeout: .seconds(5),
- observabilityScope: swiftTool.observabilityScope,
- callbackQueue: .sharedConcurrent,
- completion: callback
- )
- }
+ try await registryClient.login(
+ loginURL: loginURL,
+ timeout: .seconds(5),
+ observabilityScope: swiftTool.observabilityScope,
+ callbackQueue: .sharedConcurrent
+ )
+
  print("Login successful.")
 
  // Login successful. Persist credentials to storage.
@@ -296,15 +291,12 @@ extension SwiftPackageRegistryTool {
  }
 
  if saveChanges {
- try temp_await { callback in
- authorizationWriter?.addOrUpdate(
- for: registryURL,
- user: storeUsername,
- password: storePassword,
- persist: true,
- callback: callback
- )
- }
+ try await authorizationWriter?.addOrUpdate(
+ for: registryURL,
+ user: storeUsername,
+ password: storePassword,
+ persist: true
+ )
 
  if osStore {
  print("\nCredentials have been saved to the operating system's secure credential store.")
@@ -323,7 +315,7 @@ extension SwiftPackageRegistryTool {
  }
  }
 
- struct Logout: SwiftCommand {
+ struct Logout: AsyncSwiftCommand {
  static let configuration = CommandConfiguration(
  abstract: "Log out from a registry"
  )
@@ -338,7 +330,7 @@ extension SwiftPackageRegistryTool {
  self.url
  }
 
- func run(_ swiftTool: SwiftTool) throws {
+ func run(_ swiftTool: SwiftTool) async throws {
  // Auth config is in user-level registries config only
  let configuration = try getRegistriesConfig(swiftTool, global: true)
 
@@ -359,7 +351,7 @@ extension SwiftPackageRegistryTool {
 
  // Only OS credential store supports deletion
  if osStore {
- try temp_await { callback in authorizationWriter?.remove(for: registryURL, callback: callback) }
+ try await authorizationWriter?.remove(for: registryURL)
  print("Credentials have been removed from operating system's secure credential store.")
  } else {
  print("netrc file not updated. Please remove credentials from the file manually.")

Sources/PackageRegistryTool/PackageRegistryTool+Publish.swift

@@ -33,7 +33,7 @@ import struct TSCBasic.SHA256
 import struct TSCUtility.Version
 
 extension SwiftPackageRegistryTool {
- struct Publish: SwiftCommand {
+ struct Publish: AsyncSwiftCommand {
  static let metadataFilename = "package-metadata.json"
 
  static let configuration = CommandConfiguration(
@@ -85,7 +85,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) throws {
+ func run(_ swiftTool: SwiftTool) async throws {
  // Require both local and user-level registries config
  let configuration = try getRegistriesConfig(swiftTool, global: false).configuration
 
@@ -207,22 +207,19 @@ extension SwiftPackageRegistryTool {
 
  swiftTool.observabilityScope
  .emit(info: "publishing \(self.packageIdentity) archive at '\(archivePath)' to \(registryURL)")
- let result = try temp_await {
- registryClient.publish(
- registryURL: registryURL,
- packageIdentity: self.packageIdentity,
- packageVersion: self.packageVersion,
- packageArchive: archivePath,
- packageMetadata: metadataLocation?.path,
- signature: archiveSignature,
- metadataSignature: metadataSignature,
- signatureFormat: self.signatureFormat,
- fileSystem: localFileSystem,
- observabilityScope: swiftTool.observabilityScope,
- callbackQueue: .sharedConcurrent,
- completion: $0
- )
- }
+ let result = try await registryClient.publish(
+ registryURL: registryURL,
+ packageIdentity: self.packageIdentity,
+ packageVersion: self.packageVersion,
+ packageArchive: archivePath,
+ packageMetadata: metadataLocation?.path,
+ signature: archiveSignature,
+ metadataSignature: metadataSignature,
+ signatureFormat: self.signatureFormat,
+ fileSystem: localFileSystem,
+ observabilityScope: swiftTool.observabilityScope,
+ callbackQueue: .sharedConcurrent
+ )
 
  switch result {
  case .published(.none):

Sources/PackageRegistryTool/PackageRegistryTool.swift

@@ -19,7 +19,7 @@ import PackageRegistry
 import Workspace
 
 @available(macOS 10.15, macCatalyst 13, iOS 13, tvOS 13, watchOS 6, *)
-public struct SwiftPackageRegistryTool: ParsableCommand {
+public struct SwiftPackageRegistryTool: AsyncParsableCommand {
  public static var configuration = CommandConfiguration(
  commandName: "package-registry",
  _superCommandName: "swift",
@@ -41,7 +41,7 @@ public struct SwiftPackageRegistryTool: ParsableCommand {
 
  public init() {}
 
- struct Set: SwiftCommand {
+ struct Set: AsyncSwiftCommand {
  static let configuration = CommandConfiguration(
  abstract: "Set a custom registry"
  )
@@ -62,7 +62,7 @@ public struct SwiftPackageRegistryTool: ParsableCommand {
  self.url
  }
 
- func run(_ swiftTool: SwiftTool) throws {
+ func run(_ swiftTool: SwiftTool) async throws {
  try self.registryURL.validateRegistryURL()
 
  let scope = try scope.map(PackageIdentity.Scope.init(validating:))
@@ -84,7 +84,7 @@ public struct SwiftPackageRegistryTool: ParsableCommand {
  }
  }
 
- struct Unset: SwiftCommand {
+ struct Unset: AsyncSwiftCommand {
  static let configuration = CommandConfiguration(
  abstract: "Remove a configured registry"
  )
@@ -98,7 +98,7 @@ public struct SwiftPackageRegistryTool: ParsableCommand {
  @Option(help: "Associate the registry with a given scope")
  var scope: String?
 
- func run(_ swiftTool: SwiftTool) throws {
+ func run(_ swiftTool: SwiftTool) async throws {
  let scope = try scope.map(PackageIdentity.Scope.init(validating:))
 
  let unset: (inout RegistryConfiguration) throws -> Void = { configuration in

Sources/swift-package-manager/SwiftPM.swift

@@ -37,7 +37,7 @@ struct SwiftPM {
  case "swift-package-collection":
  await SwiftPackageCollectionsTool.main()
  case "swift-package-registry":
- SwiftPackageRegistryTool.main()
+ await SwiftPackageRegistryTool.main()
  default:
  fatalError("swift-package-manager launched with unexpected name: \(execName ?? "(unknown)")")
  }

Sources/swift-package-registry/runner.swift

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