Migrate swiftly to Swift 6 with concurrency checks

Author: cmcgee1024

Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:5.10
+// swift-tools-version:6.0
 
 import PackageDescription
 

Plugins/GenerateDocsReference/GenerateDocsReferenceError.swift

@@ -1,6 +1,7 @@
 import Foundation
-import PackagePlugin
+@preconcurrency import PackagePlugin
 
+@preconcurrency
 enum GenerateDocsReferencePluginError: Error {
     case unknownBuildConfiguration(String)
     case buildFailed(String)

Sources/MacOSPlatform/MacOS.swift

@@ -44,7 +44,7 @@ public struct MacOS: Platform {
         nil
     }
 
-    public func install(_ ctx: SwiftlyCoreContext, from tmpFile: URL, version: ToolchainVersion, verbose: Bool) throws {
+    public func install(_ ctx: SwiftlyCoreContext, from tmpFile: URL, version: ToolchainVersion, verbose: Bool) async throws {
         guard tmpFile.fileExists() else {
             throw SwiftlyError(message: "\(tmpFile) doesn't exist")
         }
@@ -54,12 +54,12 @@ public struct MacOS: Platform {
         }
 
         if ctx.mockedHomeDir == nil {
-            ctx.print("Installing package in user home directory...")
+            await ctx.print("Installing package in user home directory...")
             try runProgram("installer", "-verbose", "-pkg", tmpFile.path, "-target", "CurrentUserHomeDirectory", quiet: !verbose)
         } else {
             // In the case of a mock for testing purposes we won't use the installer, perferring a manual process because
             //  the installer will not install to an arbitrary path, only a volume or user home directory.
-            ctx.print("Expanding pkg...")
+            await ctx.print("Expanding pkg...")
             let tmpDir = self.getTempFilePath()
             let toolchainDir = self.swiftlyToolchainsDir(ctx).appendingPathComponent("\(version.identifier).xctoolchain", isDirectory: true)
             if !toolchainDir.fileExists() {
@@ -73,12 +73,12 @@ public struct MacOS: Platform {
                 payload = tmpDir.appendingPathComponent("\(version.identifier)-osx-package.pkg/Payload")
             }
 
-            ctx.print("Untarring pkg Payload...")
+            await ctx.print("Untarring pkg Payload...")
             try runProgram("tar", "-C", toolchainDir.path, "-xvf", payload.path, quiet: !verbose)
         }
     }
 
-    public func extractSwiftlyAndInstall(_ ctx: SwiftlyCoreContext, from archive: URL) throws {
+    public func extractSwiftlyAndInstall(_ ctx: SwiftlyCoreContext, from archive: URL) async throws {
         guard archive.fileExists() else {
             throw SwiftlyError(message: "\(archive) doesn't exist")
         }
@@ -88,7 +88,7 @@ public struct MacOS: Platform {
         if ctx.mockedHomeDir == nil {
             homeDir = FileManager.default.homeDirectoryForCurrentUser
 
-            ctx.print("Extracting the swiftly package...")
+            await ctx.print("Extracting the swiftly package...")
             try runProgram("installer", "-pkg", archive.path, "-target", "CurrentUserHomeDirectory")
             try? runProgram("pkgutil", "--volume", homeDir.path, "--forget", "org.swift.swiftly")
         } else {
@@ -109,15 +109,15 @@ public struct MacOS: Platform {
                 throw SwiftlyError(message: "Payload file could not be found at \(tmpDir).")
             }
 
-            ctx.print("Extracting the swiftly package into \(installDir.path)...")
+            await ctx.print("Extracting the swiftly package into \(installDir.path)...")
             try runProgram("tar", "-C", installDir.path, "-xvf", payload.path, quiet: false)
         }
 
         try self.runProgram(homeDir.appendingPathComponent(".swiftly/bin/swiftly").path, "init")
     }
 
-    public func uninstall(_ ctx: SwiftlyCoreContext, _ toolchain: ToolchainVersion, verbose: Bool) throws {
-        ctx.print("Uninstalling package in user home directory...")
+    public func uninstall(_ ctx: SwiftlyCoreContext, _ toolchain: ToolchainVersion, verbose: Bool) async throws {
+        await ctx.print("Uninstalling package in user home directory...")
 
         let toolchainDir = self.swiftlyToolchainsDir(ctx).appendingPathComponent("\(toolchain.identifier).xctoolchain", isDirectory: true)
 

Sources/Swiftly/Init.swift

@@ -3,7 +3,7 @@ import Foundation
 import SwiftlyCore
 
 struct Init: SwiftlyCommand {
-    public static var configuration = CommandConfiguration(
+    public static let configuration = CommandConfiguration(
         abstract: "Perform swiftly initialization into your user account."
     )
 
@@ -53,7 +53,7 @@ struct Init: SwiftlyCommand {
             // This is a simple upgrade from the 0.4.0 pre-releases, or 1.x
 
             // Move our executable over to the correct place
-            try Swiftly.currentPlatform.installSwiftlyBin(ctx)
+            try await Swiftly.currentPlatform.installSwiftlyBin(ctx)
 
             // Update and save the version
             config.version = SwiftlyCore.version
@@ -113,9 +113,9 @@ struct Init: SwiftlyCommand {
                 """
             }
 
-            ctx.print(msg)
+            await ctx.print(msg)
 
-            guard ctx.promptForConfirmation(defaultBehavior: true) else {
+            guard await ctx.promptForConfirmation(defaultBehavior: true) else {
                 throw SwiftlyError(message: "swiftly installation has been cancelled")
             }
         }
@@ -177,10 +177,10 @@ struct Init: SwiftlyCommand {
         guard var config else { throw SwiftlyError(message: "Configuration could not be set") }
 
         // Move our executable over to the correct place
-        try Swiftly.currentPlatform.installSwiftlyBin(ctx)
+        try await Swiftly.currentPlatform.installSwiftlyBin(ctx)
 
         if overwrite || !FileManager.default.fileExists(atPath: envFile.path) {
-            ctx.print("Creating shell environment file for the user...")
+            await ctx.print("Creating shell environment file for the user...")
             var env = ""
             if shell.hasSuffix("fish") {
                 env = """
@@ -206,7 +206,7 @@ struct Init: SwiftlyCommand {
         }
 
         if !noModifyProfile {
-            ctx.print("Updating profile...")
+            await ctx.print("Updating profile...")
 
             let userHome = ctx.mockedHomeDir ?? FileManager.default.homeDirectoryForCurrentUser
 
@@ -262,7 +262,7 @@ struct Init: SwiftlyCommand {
                 try Data(sourceLine.utf8).append(to: profileHome)
 
                 if !quietShellFollowup {
-                    ctx.print("""
+                    await ctx.print("""
                     To begin using installed swiftly from your current shell, first run the following command:
                         \(sourceLine)
 
@@ -272,7 +272,7 @@ struct Init: SwiftlyCommand {
 
             // Fish doesn't have path caching, so this might only be needed for bash/zsh
             if pathChanged && !quietShellFollowup && !shell.hasSuffix("fish") {
-                ctx.print("""
+                await ctx.print("""
                 Your shell caches items on your path for better performance. Swiftly has added
                 items to your path that may not get picked up right away. You can update your
                 shell's environment by running
@@ -285,7 +285,7 @@ struct Init: SwiftlyCommand {
             }
 
             if let postInstall {
-                ctx.print("""
+                await ctx.print("""
                 There are some dependencies that should be installed before using this toolchain.
                 You can run the following script as the system administrator (e.g. root) to prepare
                 your system:

Sources/Swiftly/Install.swift

@@ -1,13 +1,13 @@
 import _StringProcessing
 import ArgumentParser
 import Foundation
-import TSCBasic
+@preconcurrency import TSCBasic
 import TSCUtility
 
 import SwiftlyCore
 
 struct Install: SwiftlyCommand {
-    public static var configuration = CommandConfiguration(
+    public static let configuration = CommandConfiguration(
         abstract: "Install a new toolchain."
     )
 
@@ -120,7 +120,7 @@ struct Install: SwiftlyCommand {
 
         // Fish doesn't cache its path, so this instruction is not necessary.
         if pathChanged && !shell.hasSuffix("fish") {
-            ctx.print("""
+            await ctx.print("""
             NOTE: Swiftly has updated some elements in your path and your shell may not yet be
             aware of the changes. You can update your shell's environment by running
 
@@ -157,7 +157,7 @@ struct Install: SwiftlyCommand {
         assumeYes: Bool
     ) async throws -> (postInstall: String?, pathChanged: Bool) {
         guard !config.installedToolchains.contains(version) else {
-            ctx.print("\(version) is already installed.")
+            await ctx.print("\(version) is already installed.")
             return (nil, false)
         }
 
@@ -166,7 +166,7 @@ struct Install: SwiftlyCommand {
         //  script for the user to run afterwards.
         let postInstallScript = try await Swiftly.currentPlatform.verifySystemPrerequisitesForInstall(ctx, platformName: config.platform.name, version: version, requireSignatureValidation: verifySignature)
 
-        ctx.print("Installing \(version)")
+        await ctx.print("Installing \(version)")
 
         let tmpFile = Swiftly.currentPlatform.getTempFilePath()
         FileManager.default.createFile(atPath: tmpFile.path, contents: nil)
@@ -258,7 +258,7 @@ struct Install: SwiftlyCommand {
             )
         }
 
-        try Swiftly.currentPlatform.install(ctx, from: tmpFile, version: version, verbose: verbose)
+        try await Swiftly.currentPlatform.install(ctx, from: tmpFile, version: version, verbose: verbose)
 
         var pathChanged = false
 
@@ -279,19 +279,19 @@ struct Install: SwiftlyCommand {
 
             let overwrite = Set(toolchainBinDirContents).subtracting(existingProxies).intersection(swiftlyBinDirContents)
             if !overwrite.isEmpty && !assumeYes {
-                ctx.print("The following existing executables will be overwritten:")
+                await ctx.print("The following existing executables will be overwritten:")
 
                 for executable in overwrite {
-                    ctx.print("  \(swiftlyBinDir.appendingPathComponent(executable).path)")
+                    await ctx.print("  \(swiftlyBinDir.appendingPathComponent(executable).path)")
                 }
 
-                guard ctx.promptForConfirmation(defaultBehavior: false) else {
+                guard await ctx.promptForConfirmation(defaultBehavior: false) else {
                     throw SwiftlyError(message: "Toolchain installation has been cancelled")
                 }
             }
 
             if verbose {
-                ctx.print("Setting up toolchain proxies...")
+                await ctx.print("Setting up toolchain proxies...")
             }
 
             let proxiesToCreate = Set(toolchainBinDirContents).subtracting(swiftlyBinDirContents).union(overwrite)
@@ -327,18 +327,18 @@ struct Install: SwiftlyCommand {
         if config.inUse == nil {
             config.inUse = version
             try config.save(ctx)
-            ctx.print("The global default toolchain has been set to `\(version)`")
+            await ctx.print("The global default toolchain has been set to `\(version)`")
         }
 
-        ctx.print("\(version) installed successfully!")
+        await ctx.print("\(version) installed successfully!")
         return (postInstallScript, pathChanged)
     }
 
     /// Utilize the swift.org API along with the provided selector to select a toolchain for install.
     public static func resolve(_ ctx: SwiftlyCoreContext, config: Config, selector: ToolchainSelector) async throws -> ToolchainVersion {
         switch selector {
         case .latest:
-            ctx.print("Fetching the latest stable Swift release...")
+            await ctx.print("Fetching the latest stable Swift release...")
 
             guard let release = try await ctx.httpClient.getReleaseToolchains(platform: config.platform, limit: 1).first else {
                 throw SwiftlyError(message: "couldn't get latest releases")
@@ -356,7 +356,7 @@ struct Install: SwiftlyCommand {
                 return .stable(ToolchainVersion.StableRelease(major: major, minor: minor, patch: patch))
             }
 
-            ctx.print("Fetching the latest stable Swift \(major).\(minor) release...")
+            await ctx.print("Fetching the latest stable Swift \(major).\(minor) release...")
             // If a patch was not provided, perform a lookup to get the latest patch release
             // of the provided major/minor version pair.
             let toolchain = try await ctx.httpClient.getReleaseToolchains(platform: config.platform, limit: 1) { release in
@@ -374,7 +374,7 @@ struct Install: SwiftlyCommand {
                 return ToolchainVersion(snapshotBranch: branch, date: date)
             }
 
-            ctx.print("Fetching the latest \(branch) branch snapshot...")
+            await ctx.print("Fetching the latest \(branch) branch snapshot...")
 
             // If a date was not provided, perform a lookup to find the most recent snapshot
             // for the given branch.

Sources/Swiftly/List.swift

@@ -2,7 +2,7 @@ import ArgumentParser
 import SwiftlyCore
 
 struct List: SwiftlyCommand {
-    public static var configuration = CommandConfiguration(
+    public static let configuration = CommandConfiguration(
         abstract: "List installed toolchains."
     )
 
@@ -56,7 +56,7 @@ struct List: SwiftlyCommand {
             if toolchain == config.inUse {
                 message += " (default)"
             }
-            ctx.print(message)
+            await ctx.print(message)
         }
 
         if let selector {
@@ -76,26 +76,26 @@ struct List: SwiftlyCommand {
             }
 
             let message = "Installed \(modifier) toolchains"
-            ctx.print(message)
-            ctx.print(String(repeating: "-", count: message.count))
+            await ctx.print(message)
+            await ctx.print(String(repeating: "-", count: message.count))
             for toolchain in toolchains {
-                printToolchain(toolchain)
+                await printToolchain(toolchain)
             }
         } else {
-            ctx.print("Installed release toolchains")
-            ctx.print("----------------------------")
+            await ctx.print("Installed release toolchains")
+            await ctx.print("----------------------------")
             for toolchain in toolchains {
                 guard toolchain.isStableRelease() else {
                     continue
                 }
-                printToolchain(toolchain)
+                await printToolchain(toolchain)
             }
 
-            ctx.print("")
-            ctx.print("Installed snapshot toolchains")
-            ctx.print("-----------------------------")
+            await ctx.print("")
+            await ctx.print("Installed snapshot toolchains")
+            await ctx.print("-----------------------------")
             for toolchain in toolchains where toolchain.isSnapshot() {
-                printToolchain(toolchain)
+                await printToolchain(toolchain)
             }
         }
     }

Sources/Swiftly/ListAvailable.swift

@@ -2,7 +2,7 @@ import ArgumentParser
 import SwiftlyCore
 
 struct ListAvailable: SwiftlyCommand {
-    public static var configuration = CommandConfiguration(
+    public static let configuration = CommandConfiguration(
         abstract: "List toolchains available for install."
     )
 
@@ -80,7 +80,7 @@ struct ListAvailable: SwiftlyCommand {
             } else if installedToolchains.contains(toolchain) {
                 message += " (installed)"
             }
-            ctx.print(message)
+            await ctx.print(message)
         }
 
         if let selector {
@@ -100,16 +100,16 @@ struct ListAvailable: SwiftlyCommand {
             }
 
             let message = "Available \(modifier) toolchains"
-            ctx.print(message)
-            ctx.print(String(repeating: "-", count: message.count))
+            await ctx.print(message)
+            await ctx.print(String(repeating: "-", count: message.count))
             for toolchain in toolchains {
-                printToolchain(toolchain)
+                await printToolchain(toolchain)
             }
         } else {
             print("Available release toolchains")
             print("----------------------------")
             for toolchain in toolchains where toolchain.isStableRelease() {
-                printToolchain(toolchain)
+                await printToolchain(toolchain)
             }
         }
     }

Sources/Swiftly/Proxy.swift

@@ -68,10 +68,10 @@ public enum Proxy {
         } catch let terminated as RunProgramError {
             exit(terminated.exitCode)
         } catch let error as SwiftlyError {
-            ctx.print(error.message)
+            await ctx.print(error.message)
             exit(1)
         } catch {
-            ctx.print("\(error)")
+            await ctx.print("\(error)")
             exit(1)
         }
     }