Repository navigation
Fix Sparkle update dialog requiring two presses #1908
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,35 @@ | ||
| import Cocoa | ||
| import Sparkle | ||
|
|
||
| enum UpdateUserInitiatedCheckPresentation { | ||
| case dialog | ||
| case custom | ||
| } | ||
|
|
||
| /// SPUUserDriver that updates the view model for custom update UI. | ||
| class UpdateDriver: NSObject, SPUUserDriver { | ||
| let viewModel: UpdateViewModel | ||
| private let standard: SPUStandardUserDriver | ||
| private let minimumCheckDuration: TimeInterval = UpdateTiming.minimumCheckDisplayDuration | ||
| private var lastCheckStart: Date? | ||
| private var pendingCheckTransition: DispatchWorkItem? | ||
| private var checkTimeoutWorkItem: DispatchWorkItem? | ||
| private var lastFeedURLString: String? | ||
| private var pendingUserInitiatedCheckPresentation: UpdateUserInitiatedCheckPresentation? | ||
| private var activeUserInitiatedCheckPresentation: UpdateUserInitiatedCheckPresentation? | ||
|
|
||
| init(viewModel: UpdateViewModel, hostBundle: Bundle) { | ||
| self.viewModel = viewModel | ||
| self.standard = SPUStandardUserDriver(hostBundle: hostBundle, delegate: nil) | ||
| super.init() | ||
| } | ||
|
|
||
| func prepareForUserInitiatedCheck(presentation: UpdateUserInitiatedCheckPresentation) { | ||
| runOnMain { [weak self] in | ||
| self?.pendingUserInitiatedCheckPresentation = presentation | ||
| } | ||
| } | ||
|
|
||
| func show(_ request: SPUUpdatePermissionRequest, | ||
| reply: @escaping @Sendable (SUUpdatePermissionResponse) -> Void) { | ||
| #if DEBUG | ||
|
|
@@ -36,14 +51,36 @@ class UpdateDriver: NSObject, SPUUserDriver { | |
| } | ||
|
|
||
| func showUserInitiatedUpdateCheck(cancellation: @escaping () -> Void) { | ||
| let presentation = activateUserInitiatedCheckPresentation() | ||
| UpdateLogStore.shared.append("show user-initiated update check (\(describe(presentation)))") | ||
| let cancel = { [weak self] in | ||
| self?.finishUserInitiatedCheckPresentation() | ||
| cancellation() | ||
| } | ||
|
|
||
| switch presentation { | ||
| case .dialog: | ||
| clearCustomStateForStandardPresentation() | ||
| standard.showUserInitiatedUpdateCheck(cancellation: cancel) | ||
| case .custom: | ||
| beginChecking(cancel: cancel) | ||
| } | ||
| } | ||
|
|
||
| func showUpdateFound(with appcastItem: SUAppcastItem, | ||
| state: SPUUserUpdateState, | ||
| reply: @escaping @Sendable (SPUUserUpdateChoice) -> Void) { | ||
| UpdateLogStore.shared.append("show update found: \(appcastItem.displayVersionString)") | ||
| if usesStandardPresentation { | ||
| clearCustomStateForStandardPresentation() | ||
| standard.showUpdateFound(with: appcastItem, state: state) { [weak self] choice in | ||
| if choice != .install { | ||
| self?.finishUserInitiatedCheckPresentation() | ||
| } | ||
| reply(choice) | ||
| } | ||
| return | ||
| } | ||
| setStateAfterMinimumCheckDelay(.updateAvailable(.init(appcastItem: appcastItem, reply: reply))) | ||
| } | ||
|
|
||
|
|
@@ -58,13 +95,29 @@ class UpdateDriver: NSObject, SPUUserDriver { | |
| func showUpdateNotFoundWithError(_ error: any Error, | ||
| acknowledgement: @escaping () -> Void) { | ||
| UpdateLogStore.shared.append("show update not found: \(formatErrorForLog(error))") | ||
| if usesStandardPresentation { | ||
| clearCustomStateForStandardPresentation() | ||
| standard.showUpdateNotFoundWithError(error) { [weak self] in | ||
| self?.finishUserInitiatedCheckPresentation() | ||
| acknowledgement() | ||
| } | ||
| return | ||
| } | ||
| setStateAfterMinimumCheckDelay(.notFound(.init(acknowledgement: acknowledgement))) | ||
| } | ||
|
coderabbitai[bot] marked this conversation as resolved.
Resolved
|
||
|
|
||
| func showUpdaterError(_ error: any Error, | ||
| acknowledgement: @escaping () -> Void) { | ||
| let details = formatErrorForLog(error) | ||
| UpdateLogStore.shared.append("show updater error: \(details)") | ||
| if usesStandardPresentation { | ||
| clearCustomStateForStandardPresentation() | ||
| standard.showUpdaterError(error) { [weak self] in | ||
| self?.finishUserInitiatedCheckPresentation() | ||
| acknowledgement() | ||
| } | ||
| return | ||
| } | ||
| setState(.error(.init( | ||
| error: error, | ||
| retry: { [weak viewModel] in | ||
|
|
@@ -85,6 +138,10 @@ class UpdateDriver: NSObject, SPUUserDriver { | |
|
|
||
| func showDownloadInitiated(cancellation: @escaping () -> Void) { | ||
| UpdateLogStore.shared.append("show download initiated") | ||
| if usesStandardPresentation { | ||
| standard.showDownloadInitiated(cancellation: cancellation) | ||
| return | ||
| } | ||
| setState(.downloading(.init( | ||
| cancel: cancellation, | ||
| expectedLength: nil, | ||
|
|
@@ -93,6 +150,10 @@ class UpdateDriver: NSObject, SPUUserDriver { | |
|
|
||
| func showDownloadDidReceiveExpectedContentLength(_ expectedContentLength: UInt64) { | ||
| UpdateLogStore.shared.append("download expected length: \(expectedContentLength)") | ||
| if usesStandardPresentation { | ||
| standard.showDownloadDidReceiveExpectedContentLength(expectedContentLength) | ||
| return | ||
| } | ||
| guard case let .downloading(downloading) = viewModel.state else { | ||
| return | ||
| } | ||
|
|
@@ -105,6 +166,10 @@ class UpdateDriver: NSObject, SPUUserDriver { | |
|
|
||
| func showDownloadDidReceiveData(ofLength length: UInt64) { | ||
| UpdateLogStore.shared.append("download received data: \(length)") | ||
| if usesStandardPresentation { | ||
| standard.showDownloadDidReceiveData(ofLength: length) | ||
| return | ||
| } | ||
| guard case let .downloading(downloading) = viewModel.state else { | ||
| return | ||
| } | ||
|
|
@@ -117,21 +182,37 @@ class UpdateDriver: NSObject, SPUUserDriver { | |
|
|
||
| func showDownloadDidStartExtractingUpdate() { | ||
| UpdateLogStore.shared.append("show extraction started") | ||
| if usesStandardPresentation { | ||
| standard.showDownloadDidStartExtractingUpdate() | ||
| return | ||
| } | ||
| setState(.extracting(.init(progress: 0))) | ||
| } | ||
|
|
||
| func showExtractionReceivedProgress(_ progress: Double) { | ||
| UpdateLogStore.shared.append(String(format: "show extraction progress: %.2f", progress)) | ||
| if usesStandardPresentation { | ||
| standard.showExtractionReceivedProgress(progress) | ||
| return | ||
| } | ||
| setState(.extracting(.init(progress: progress))) | ||
| } | ||
|
|
||
| func showReady(toInstallAndRelaunch reply: @escaping @Sendable (SPUUserUpdateChoice) -> Void) { | ||
| UpdateLogStore.shared.append("show ready to install") | ||
| if usesStandardPresentation { | ||
| standard.showReady(toInstallAndRelaunch: reply) | ||
| return | ||
| } | ||
| reply(.install) | ||
| } | ||
|
|
||
| func showInstallingUpdate(withApplicationTerminated applicationTerminated: Bool, retryTerminatingApplication: @escaping () -> Void) { | ||
| UpdateLogStore.shared.append("show installing update") | ||
| if usesStandardPresentation { | ||
| standard.showInstallingUpdate(withApplicationTerminated: applicationTerminated, retryTerminatingApplication: retryTerminatingApplication) | ||
| return | ||
| } | ||
| setState(.installing(.init( | ||
| retryTerminatingApplication: retryTerminatingApplication, | ||
| dismiss: { [weak viewModel] in | ||
|
|
@@ -142,16 +223,29 @@ class UpdateDriver: NSObject, SPUUserDriver { | |
|
|
||
| func showUpdateInstalledAndRelaunched(_ relaunched: Bool, acknowledgement: @escaping () -> Void) { | ||
| UpdateLogStore.shared.append("show update installed (relaunched=\(relaunched))") | ||
| if usesStandardPresentation { | ||
| standard.showUpdateInstalledAndRelaunched(relaunched) { [weak self] in | ||
| self?.finishUserInitiatedCheckPresentation() | ||
| acknowledgement() | ||
| } | ||
| return | ||
| } | ||
| setState(.idle) | ||
| acknowledgement() | ||
| } | ||
|
|
||
| func showUpdateInFocus() { | ||
| if usesStandardPresentation { | ||
| standard.showUpdateInFocus() | ||
| } | ||
| } | ||
|
|
||
| func dismissUpdateInstallation() { | ||
| UpdateLogStore.shared.append("dismiss update installation") | ||
| if usesStandardPresentation { | ||
| standard.dismissUpdateInstallation() | ||
| return | ||
| } | ||
| if case .error = viewModel.state { | ||
| UpdateLogStore.shared.append("dismiss update installation ignored (error visible)") | ||
| return | ||
|
|
@@ -275,6 +369,13 @@ class UpdateDriver: NSObject, SPUUserDriver { | |
| return parts.joined(separator: " | ") | ||
| } | ||
|
|
||
| func finishUserInitiatedCheckPresentation() { | ||
| runOnMain { [weak self] in | ||
| self?.pendingUserInitiatedCheckPresentation = nil | ||
| self?.activeUserInitiatedCheckPresentation = nil | ||
| } | ||
| } | ||
|
|
||
| private func describe(_ state: UpdateState) -> String { | ||
| switch state { | ||
| case .idle: | ||
|
|
@@ -302,6 +403,45 @@ class UpdateDriver: NSObject, SPUUserDriver { | |
| } | ||
| } | ||
|
|
||
| private func describe(_ presentation: UpdateUserInitiatedCheckPresentation) -> String { | ||
| switch presentation { | ||
| case .dialog: | ||
| return "dialog" | ||
| case .custom: | ||
| return "custom" | ||
| } | ||
| } | ||
|
|
||
| private var usesStandardPresentation: Bool { | ||
| currentUserInitiatedCheckPresentation() == .dialog | ||
| } | ||
|
|
||
| private func currentUserInitiatedCheckPresentation() -> UpdateUserInitiatedCheckPresentation? { | ||
| activeUserInitiatedCheckPresentation ?? pendingUserInitiatedCheckPresentation | ||
| } | ||
|
|
||
| private func activateUserInitiatedCheckPresentation() -> UpdateUserInitiatedCheckPresentation { | ||
| let presentation = currentUserInitiatedCheckPresentation() ?? .dialog | ||
| activeUserInitiatedCheckPresentation = presentation | ||
| pendingUserInitiatedCheckPresentation = nil | ||
| return presentation | ||
| } | ||
|
|
||
| private func clearCustomStateForStandardPresentation() { | ||
| runOnMain { [weak self] in | ||
| guard let self else { return } | ||
| pendingCheckTransition?.cancel() | ||
| pendingCheckTransition = nil | ||
| checkTimeoutWorkItem?.cancel() | ||
| checkTimeoutWorkItem = nil | ||
| lastCheckStart = nil | ||
| if case .idle = viewModel.state { | ||
| return | ||
| } | ||
| applyState(.idle) | ||
| } | ||
| } | ||
|
|
||
| private func runOnMain(_ action: @escaping () -> Void) { | ||
| if Thread.isMainThread { | ||
| action() | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -47,12 +47,12 @@ final class SidebarHelpMenuUITests: XCTestCase { | |
| XCTAssertTrue(app.staticTexts["ShortcutRecordingHint"].waitForExistence(timeout: 6.0)) | ||
| } | ||
|
|
||
| func testHelpMenuCheckForUpdatesShowsSparkleDialogOnFirstAttempt() { | ||
| let app = XCUIApplication() | ||
| app.launchEnvironment["CMUX_UI_TEST_MODE"] = "1" | ||
| app.launchEnvironment["CMUX_UI_TEST_FEED_URL"] = "https://cmux.test/appcast.xml" | ||
| app.launchEnvironment["CMUX_UI_TEST_FEED_MODE"] = "available" | ||
| app.launchEnvironment["CMUX_UI_TEST_UPDATE_VERSION"] = "99.0.0" | ||
| app.launchEnvironment["CMUX_UI_TEST_AUTO_ALLOW_PERMISSION"] = "1" | ||
| launchAndActivate(app) | ||
|
coderabbitai[bot] marked this conversation as resolved.
Resolved
|
||
|
|
||
|
|
@@ -72,9 +72,11 @@ final class SidebarHelpMenuUITests: XCTestCase { | |
| ) | ||
| checkForUpdatesItem.click() | ||
|
|
||
| let installButton = app.buttons["Install Update"] | ||
| XCTAssertTrue(installButton.waitForExistence(timeout: 8.0)) | ||
| XCTAssertTrue(app.buttons["Remind Me Later"].exists) | ||
| XCTAssertTrue(app.buttons["Skip This Version"].exists) | ||
| XCTAssertTrue(app.staticTexts["99.0.0"].exists) | ||
| } | ||
|
|
||
| func testHelpMenuSendFeedbackOpensComposerSheet() { | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
prepareForUserInitiatedChecksets pending presentation before the previous check is cancelledWhen
viewModel.state != .idle,prepareForUserInitiatedCheck(presentation:)is called at line 218 beforeviewModel.state.cancel()at line 225. If cancelling the in-flight check causes Sparkle to calldismissUpdateInstallationsynchronously (or before the 100 ms async block runs),usesStandardPresentationevaluates totruebecausependingUserInitiatedCheckPresentationis already set. This causesstandard.dismissUpdateInstallation()to be called on aSPUStandardUserDriverthat was never activated (noshowUserInitiatedUpdateCheckwas forwarded to it), which could leave the standard driver in an unexpected internal state.Moving the first
prepareForUserInitiatedCheckcall inside the async block alongside the second one would ensure the pending presentation is only set immediately beforeupdater.checkForUpdates()is actually invoked: