Add version check and prompt for self update (#313)

* feat: add version check and defer print till end of func
* feat: move version check inside `validateSwiftly`
* fix: discard update handler for `self-update`
* feat: print update msg to stderr
* chore: rename variable
* fix: await async Config.load() op
* chore: add period
* fix: non faliure version checking with `try?`
* fix(ListTests): mocked Swiftly Version
* test(Platform): mock swiftly verison
* test(Run): mock swiftly verison
* test(Uninstall): mock swiftly verison
* test(Use): mock swiftly version
* feat: add MockSwiftlyVersion Test Trait

Author: louisunlimited

Sources/Swiftly/Install.swift

@@ -82,7 +82,10 @@ struct Install: SwiftlyCommand {
     }
 
     mutating func run(_ ctx: SwiftlyCoreContext) async throws {
-        try await validateSwiftly(ctx)
+        let versionUpdateReminder = try await validateSwiftly(ctx)
+        defer {
+            versionUpdateReminder()
+        }
 
         var config = try await Config.load(ctx)
 

Sources/Swiftly/List.swift

@@ -38,7 +38,11 @@ struct List: SwiftlyCommand {
     }
 
     mutating func run(_ ctx: SwiftlyCoreContext) async throws {
-        try await validateSwiftly(ctx)
+        let versionUpdateReminder = try await validateSwiftly(ctx)
+        defer {
+            versionUpdateReminder()
+        }
+
         let selector = try self.toolchainSelector.map { input in
             try ToolchainSelector(parsing: input)
         }

Sources/Swiftly/ListAvailable.swift

@@ -44,7 +44,11 @@ struct ListAvailable: SwiftlyCommand {
     }
 
     mutating func run(_ ctx: SwiftlyCoreContext) async throws {
-        try await validateSwiftly(ctx)
+        let versionUpdateReminder = try await validateSwiftly(ctx)
+        defer {
+            versionUpdateReminder()
+        }
+
         let selector = try self.toolchainSelector.map { input in
             try ToolchainSelector(parsing: input)
         }

Sources/Swiftly/Run.swift

@@ -58,7 +58,10 @@ struct Run: SwiftlyCommand {
     }
 
     mutating func run(_ ctx: SwiftlyCoreContext) async throws {
-        try await validateSwiftly(ctx)
+        let versionUpdateReminder = try await validateSwiftly(ctx)
+        defer {
+            versionUpdateReminder()
+        }
 
         // Handle the specific case where help is requested of the run subcommand
         if command == ["--help"] {

Sources/Swiftly/SelfUpdate.swift

@@ -21,7 +21,7 @@ struct SelfUpdate: SwiftlyCommand {
     }
 
     mutating func run(_ ctx: SwiftlyCoreContext) async throws {
-        try await validateSwiftly(ctx)
+        let _ = try await validateSwiftly(ctx)
 
         let swiftlyBin = Swiftly.currentPlatform.swiftlyBinDir(ctx) / "swiftly"
         guard try await fs.exists(atPath: swiftlyBin) else {

Sources/Swiftly/Swiftly.swift

@@ -93,7 +93,7 @@ extension Data {
 }
 
 extension SwiftlyCommand {
-    public mutating func validateSwiftly(_ ctx: SwiftlyCoreContext) async throws {
+    public mutating func validateSwiftly(_ ctx: SwiftlyCoreContext) async throws -> () -> Void {
         for requiredDir in Swiftly.requiredDirectories(ctx) {
             guard try await fs.exists(atPath: requiredDir) else {
                 do {
@@ -107,5 +107,27 @@ extension SwiftlyCommand {
 
         // Verify that the configuration exists and can be loaded
         _ = try await Config.load(ctx)
+
+        let shouldUpdateSwiftly: Bool
+        if let swiftlyRelease = try? await ctx.httpClient.getCurrentSwiftlyRelease() {
+            shouldUpdateSwiftly = try swiftlyRelease.swiftlyVersion > SwiftlyCore.version
+        } else {
+            shouldUpdateSwiftly = false
+        }
+
+        return {
+            if shouldUpdateSwiftly {
+                let updateMessage = """
+                -----------------------------
+                A new release of swiftly is available.
+                Please run `swiftly self-update` to update.
+                -----------------------------\n
+                """
+
+                if let data = updateMessage.data(using: .utf8) {
+                    FileHandle.standardError.write(data)
+                }
+            }
+        }
     }
 }

Sources/Swiftly/Uninstall.swift

@@ -48,7 +48,11 @@ struct Uninstall: SwiftlyCommand {
     }
 
     mutating func run(_ ctx: SwiftlyCoreContext) async throws {
-        try await validateSwiftly(ctx)
+        let versionUpdateReminder = try await validateSwiftly(ctx)
+        defer {
+            versionUpdateReminder()
+        }
+
         let startingConfig = try await Config.load(ctx)
 
         let toolchains: [ToolchainVersion]

Sources/Swiftly/Update.swift

@@ -83,7 +83,11 @@ struct Update: SwiftlyCommand {
     }
 
     public mutating func run(_ ctx: SwiftlyCoreContext) async throws {
-        try await validateSwiftly(ctx)
+        let versionUpdateReminder = try await validateSwiftly(ctx)
+        defer {
+            versionUpdateReminder()
+        }
+
         var config = try await Config.load(ctx)
 
         guard let parameters = try await self.resolveUpdateParameters(ctx, &config) else {

Sources/Swiftly/Use.swift

@@ -60,7 +60,11 @@ struct Use: SwiftlyCommand {
     }
 
     mutating func run(_ ctx: SwiftlyCoreContext) async throws {
-        try await validateSwiftly(ctx)
+        let versionUpdateReminder = try await validateSwiftly(ctx)
+        defer {
+            versionUpdateReminder()
+        }
+
         var config = try await Config.load(ctx)
 
         // This is the bare use command where we print the selected toolchain version (or the path to it)

Tests/SwiftlyTests/ListTests.swift

@@ -19,17 +19,21 @@ import Testing
         .oldReleaseSnapshot,
     ]
 
+    private static let swiftlyVersion = SwiftlyVersion(major: SwiftlyCore.version.major, minor: 0, patch: 0)
+
     /// Constructs a mock home directory with the toolchains listed above installed and runs the provided closure within
     /// the context of that home.
     func runListTest(f: () async throws -> Void) async throws {
         try await SwiftlyTests.withTestHome(name: Self.homeName) {
-            for toolchain in Set<ToolchainVersion>.allToolchains() {
-                try await SwiftlyTests.installMockedToolchain(toolchain: toolchain)
-            }
+            try await SwiftlyTests.withMockedSwiftlyVersion(latestSwiftlyVersion: Self.swiftlyVersion) {
+                for toolchain in Set<ToolchainVersion>.allToolchains() {
+                    try await SwiftlyTests.installMockedToolchain(toolchain: toolchain)
+                }
 
-            try await SwiftlyTests.runCommand(Use.self, ["use", "latest"])
+                try await SwiftlyTests.runCommand(Use.self, ["use", "latest"])
 
-            try await f()
+                try await f()
+            }
         }
     }
 
@@ -155,16 +159,18 @@ import Testing
 
     /// Tests that `list` properly handles the case where no toolchains have been installed yet.
     @Test(.testHome(Self.homeName)) func listEmpty() async throws {
-        var toolchains = try await self.runList(selector: nil)
-        #expect(toolchains == [])
+        try await SwiftlyTests.withMockedSwiftlyVersion(latestSwiftlyVersion: Self.swiftlyVersion) {
+            var toolchains = try await self.runList(selector: nil)
+            #expect(toolchains == [])
 
-        toolchains = try await self.runList(selector: "5")
-        #expect(toolchains == [])
+            toolchains = try await self.runList(selector: "5")
+            #expect(toolchains == [])
 
-        toolchains = try await self.runList(selector: "main-snapshot")
-        #expect(toolchains == [])
+            toolchains = try await self.runList(selector: "main-snapshot")
+            #expect(toolchains == [])
 
-        toolchains = try await self.runList(selector: "5.7-snapshot")
-        #expect(toolchains == [])
+            toolchains = try await self.runList(selector: "5.7-snapshot")
+            #expect(toolchains == [])
+        }
     }
 }