feat: add auto-updates

ethanndickson · ethanndickson · commit 6a86c64fec2e · 2025-06-02T05:35:20.000Z
diff --git a/Coder-Desktop/Coder-Desktop/Coder_DesktopApp.swift b/Coder-Desktop/Coder-Desktop/Coder_DesktopApp.swift
@@ -3,6 +3,7 @@ import NetworkExtension
 import os
 import SDWebImageSVGCoder
 import SDWebImageSwiftUI
+import Sparkle
 import SwiftUI
 import UserNotifications
 import VPNLib
@@ -26,6 +27,7 @@ struct DesktopApp: App {
                 .environmentObject(appDelegate.vpn)
                 .environmentObject(appDelegate.state)
                 .environmentObject(appDelegate.helper)
+                .environmentObject(appDelegate.autoUpdater)
         }
         .windowResizability(.contentSize)
         Window("Coder File Sync", id: Windows.fileSync.rawValue) {
@@ -47,11 +49,13 @@ class AppDelegate: NSObject, NSApplicationDelegate {
     let urlHandler: URLHandler
     let notifDelegate: NotifDelegate
     let helper: HelperService
+    let autoUpdater: UpdaterService
 
     override init() {
         notifDelegate = NotifDelegate()
         vpn = CoderVPNService()
         helper = HelperService()
+        autoUpdater = UpdaterService()
         let state = AppState(onChange: vpn.configureTunnelProviderProtocol)
         vpn.onStart = {
             // We don't need this to have finished before the VPN actually starts
diff --git a/Coder-Desktop/Coder-Desktop/Info.plist b/Coder-Desktop/Coder-Desktop/Info.plist
@@ -35,5 +35,7 @@
 	<string>Ae2oQLTcx89/a73XrpOt+IVvqdo+fMTjo3UKEm77VdA=</string>
 	<key>CommitHash</key>
 	<string>$(GIT_COMMIT_HASH)</string>
+	<key>SUFeedURL</key>
+	<string>https://releases.coder.com/coder-desktop/mac/appcast.xml</string>
 </dict>
 </plist>
diff --git a/Coder-Desktop/Coder-Desktop/UpdaterService.swift b/Coder-Desktop/Coder-Desktop/UpdaterService.swift
@@ -0,0 +1,86 @@
+import Sparkle
+import SwiftUI
+
+final class UpdaterService: NSObject, ObservableObject {
+    private lazy var inner: SPUStandardUpdaterController = .init(
+        startingUpdater: true,
+        updaterDelegate: self,
+        userDriverDelegate: self,
+    )
+    private var updater: SPUUpdater!
+    @Published var canCheckForUpdates = true
+
+    @Published var autoCheckForUpdates: Bool = false {
+        didSet {
+            if autoCheckForUpdates != oldValue {
+                updater.automaticallyChecksForUpdates = autoCheckForUpdates
+            }
+        }
+    }
+
+    @Published var updateChannel: UpdateChannel {
+        didSet {
+            UserDefaults.standard.set(updateChannel.rawValue, forKey: Self.updateChannelKey)
+        }
+    }
+
+    static let updateChannelKey = "updateChannel"
+
+    override init() {
+        updateChannel = UserDefaults.standard.string(forKey: Self.updateChannelKey)
+            .flatMap { UpdateChannel(rawValue: $0) } ?? .stable
+        super.init()
+        updater = inner.updater
+        updater.publisher(for: \.canCheckForUpdates).assign(to: &$canCheckForUpdates)
+    }
+
+    func checkForUpdates() {
+        guard canCheckForUpdates else { return }
+        updater.checkForUpdates()
+    }
+}
+
+enum UpdateChannel: String, CaseIterable, Identifiable {
+    case stable
+    case preview
+
+    var name: String {
+        switch self {
+        case .stable:
+            "Stable"
+        case .preview:
+            "Preview"
+        }
+    }
+
+    var id: String { rawValue }
+}
+
+extension UpdaterService: SPUUpdaterDelegate {
+    func allowedChannels(for _: SPUUpdater) -> Set<String> {
+        // There's currently no point in subscribing to both channels, as
+        // preview >= stable
+        [updateChannel.rawValue]
+    }
+}
+
+extension UpdaterService: SUVersionDisplay {
+    func formatUpdateVersion(
+        fromUpdate update: SUAppcastItem,
+        andBundleDisplayVersion inOutBundleDisplayVersion: AutoreleasingUnsafeMutablePointer<NSString>,
+        withBundleVersion bundleVersion: String
+    ) -> String {
+        // Replace CFBundleShortVersionString with CFBundleVersion, as the
+        // latter shows build numbers.
+        inOutBundleDisplayVersion.pointee = bundleVersion as NSString
+        // This is already CFBundleVersion, as that's the only version in the
+        // appcast.
+        return update.displayVersionString
+    }
+}
+
+extension UpdaterService: SPUStandardUserDriverDelegate {
+    func standardUserDriverRequestsVersionDisplayer() -> (any SUVersionDisplay)? {
+        self
+    }
+}
diff --git a/Coder-Desktop/Coder-Desktop/VPN/VPNSystemExtension.swift b/Coder-Desktop/Coder-Desktop/VPN/VPNSystemExtension.swift
@@ -174,7 +174,7 @@ class SystemExtensionDelegate<AsyncDelegate: SystemExtensionAsyncRecorder>:
         actionForReplacingExtension existing: OSSystemExtensionProperties,
         withExtension extension: OSSystemExtensionProperties
     ) -> OSSystemExtensionRequest.ReplacementAction {
-        logger.info("Replacing \(request.identifier) v\(existing.bundleVersion) with v\(`extension`.bundleVersion)")
+        logger.info("Replacing \(request.identifier) \(existing.bundleVersion) with \(`extension`.bundleVersion)")
         // This is counterintuitive, but this function is only called if the
         // versions are the same in a dev environment.
         // In a release build, this only gets called when the version string is
diff --git a/Coder-Desktop/Coder-Desktop/Views/Settings/GeneralTab.swift b/Coder-Desktop/Coder-Desktop/Views/Settings/GeneralTab.swift
@@ -3,6 +3,7 @@ import SwiftUI
 
 struct GeneralTab: View {
     @EnvironmentObject var state: AppState
+    @EnvironmentObject var updater: UpdaterService
     var body: some View {
         Form {
             Section {
@@ -18,10 +19,20 @@ struct GeneralTab: View {
                     Text("Start Coder Connect on launch")
                 }
             }
+            Section {
+                Toggle(isOn: $updater.autoCheckForUpdates) {
+                    Text("Automatically check for updates")
+                }
+                Picker("Update channel", selection: $updater.updateChannel) {
+                    ForEach(UpdateChannel.allCases) { channel in
+                        Text(channel.name).tag(channel)
+                    }
+                }
+                HStack {
+                    Spacer()
+                    Button("Check for updates") { updater.checkForUpdates() }.disabled(!updater.canCheckForUpdates)
+                }
+            }
         }.formStyle(.grouped)
     }
 }
-
-#Preview {
-    GeneralTab()
-}
diff --git a/Coder-Desktop/project.yml b/Coder-Desktop/project.yml
@@ -11,8 +11,8 @@ options:
 
 settings:
   base:
-    MARKETING_VERSION: ${MARKETING_VERSION} # Sets the version number.
-    CURRENT_PROJECT_VERSION: ${CURRENT_PROJECT_VERSION} # Sets the build number.
+    MARKETING_VERSION: ${MARKETING_VERSION} # Sets CFBundleShortVersionString
+    CURRENT_PROJECT_VERSION: ${CURRENT_PROJECT_VERSION} # CFBundleVersion
     GIT_COMMIT_HASH: ${GIT_COMMIT_HASH}
 
     ALWAYS_SEARCH_USER_PATHS: NO
diff --git a/scripts/update-cask.sh b/scripts/update-cask.sh
@@ -101,6 +101,7 @@ cask "coder-desktop${SUFFIX}" do
   name "Coder Desktop"
   desc "Native desktop client for Coder"
   homepage "https://github.com/coder/coder-desktop-macos"
+  auto_updates true
 
   conflicts_with cask: "coder/coder/${CONFLICTS_WITH}"
   depends_on macos: ">= :sonoma"
