Refactor automatic update flow to use custom Sparkle user driver #3274

quanganhdo · 2024-09-13T19:08:20Z

Task/Issue URL: https://app.asana.com/0/1201037661562251/1208183525704010/f
Tech Design URL:
CC:

Description:

Refactors automatic update flow to use a custom Sparkle user driver.

Steps to test this PR:

Refer to https://app.asana.com/0/1201037661562251/1208230039908704/f

Definition of Done:

Does this PR satisfy our Definition of Done?

Internal references:

Pull Request Review Checklist
Software Engineering Expectations
Technical Design Template
Pull Request Documentation

quanganhdo · 2024-09-13T19:08:42Z

Increase build number to 265 #3276
Use test appcast URL #3275
Refactor automatic update flow to use custom Sparkle user driver #3274 👈
main

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @quanganhdo and the rest of your teammates on Graphite

github-actions · 2024-09-13T19:09:57Z

	Warnings
⚠️	PR has more than 500 lines of code changing. Consider splitting into smaller PRs if possible.

	Messages
📖	You seem to be updating localized strings. Make sure that you request translations and include translated strings before you ship your change. See Localization Guidelines for more information.

Generated by 🚫 dangerJS against ccfe27b

This reverts commit c165e74. # Conflicts: # DuckDuckGo/Updates/BinaryOwnershipChecker.swift # DuckDuckGo/Updates/UpdateController.swift

…ere UI stuck loading when switching between browser update modes

…'s due based on SULastCheckTime

…RL (to be reverted) This reverts commit e1deee3.

tomasstrba

The code looks really good. 💯 I'm going to test the solution now

DuckDuckGo/Preferences/Model/AboutPreferences.swift

tomasstrba · 2024-09-18T07:36:38Z

DuckDuckGo/Updates/UpdateController.swift

-    func checkForUpdate() {
+    func checkForUpdateIfNeeded() {
+        guard let updater, !updater.sessionInProgress else { return }
+
        Logger.updates.debug("Checking for updates")


There was a mistake when refactoring pixels and all update pixels are just debug pixels. Do you think it would be beneficial to make them available in release builds for potential debugging?

It may be beneficial to have pixels at different states to see if our users make it to the end of the update cycle. Have we defined those, or do they have to be created?

There are couple of pixels and the error pixel in case something goes wrong. Monitoring various states as you suggested may be a good idea too 👍

tomasstrba

@quanganhdo, after installation of the build number 261, it says the app is up to date which is not expected. Am I missing something? I'm currently at the coffee shop with a low connection or maybe the phased rollout is the reason?

Another minor thing is the empty box in the release notes which I suppose is caused by empty release notes in the appcast. Just flagging it in case not.

quanganhdo · 2024-09-18T13:43:41Z

The test appcast pointed to internal-channel so internal user state was needed https://github.com/quanganhdo/playground/blob/main/appcast2.xml

I've removed that channel from the file. Update should show up now (along with the release note).

tomasstrba

LGMT! 👍 Works as expected including edge cases

quanganhdo changed the title ~~Revert "Resolving automatic update edge cases (#3142)"~~ Refactor automatic update flow to use custom Sparkle user driver Sep 13, 2024

quanganhdo marked this pull request as ready for review September 13, 2024 19:10

This was referenced Sep 13, 2024

Use test appcast URL #3275

Closed

Increase build number to 265 #3276

Closed

quanganhdo added 24 commits September 16, 2024 10:48

Revert "Resolving automatic update edge cases (#3142)"

db2d967

This reverts commit c165e74. # Conflicts: # DuckDuckGo/Updates/BinaryOwnershipChecker.swift # DuckDuckGo/Updates/UpdateController.swift

UpdateUserDriver draft

44b9cc6

Refactor UpdateState to show progress

ec6fa60

Fix wrong deferInstallation param

f246827

Show update progress

d1048f4

Add manual restart

5d5fd33

Rename delegate methods

f6e6b41

Remove AppRestarter

fc0a056

Fix updateCycleDone state

269b309

Remove shouldShowManualUpdateDialog

9b9820d

Simplify the states (double check needed)

4bf9d67

Add more logging, tweak last check date

cf42cd6

Refactor updateCycleDone state

bb10153

Move from delegate method to Combine

fd8b608

Put popup on hold till update cycle is done

e0e6812

Reconfigure updater whenever setting changes

4cb268e

Refactor updateProgress

de820d1

Minor refactoring

251ca8b

Reintroduce cached result

384e3f1

Refactor new version check for UI

6f0eceb

Fix overaggressive updater reconfiguration

fc251fc

Fix release note tab state

4758c06

Different checkpoints for different update options

2e4b10e

Remove unnecessary code

83a6a4b

quanganhdo added 19 commits September 16, 2024 10:49

Disable update mode switching if session is in progress

5bca35e

Rename isNewVersionAvailable to hasPendingUpdate and fix edge case wh…

922c6a6

…ere UI stuck loading when switching between browser update modes

Fix stuck hasPendingStatus

eb529ff

Check for update upon starting the app

41a0edf

Simplify user driver

50b5eed

Dot goes away when menu opens

11154e2

Add setNeedsDisplay

ace4614

Add shouldShowUpdateNotification logic

1cbe380

Check for update when release note / about page is loaded and when it…

ee28b73

…'s due based on SULastCheckTime

Fix stuck state when switching between modes

71e0df2

Add DEBUG check

ff79e90

Avoid overlapping popup

214490c

Code cleanup

633945c

Update copy

c5fd490

Fix last checked date showing - when idling

19d5930

Revert "Increase build number (to be reverted)" and update appcast2 U…

29dfa4f

…RL (to be reverted) This reverts commit e1deee3.

Oops, wrong URL

f28e978

Revert browserRestart behaviour and undo debug changes

e72aad8

Fix swiftlint

ce71bd1

quanganhdo force-pushed the anh/refactor/sparkle-user-driver branch from 608e991 to ce71bd1 Compare September 16, 2024 14:55

Add missing SPARKLE checks

ccfe27b

quanganhdo force-pushed the anh/refactor/sparkle-user-driver branch from 1a1d4e6 to ccfe27b Compare September 16, 2024 15:34

quanganhdo requested review from tomasstrba and ayoy September 16, 2024 15:37

tomasstrba reviewed Sep 18, 2024

View reviewed changes

quanganhdo requested a review from tomasstrba September 18, 2024 21:18

tomasstrba approved these changes Sep 19, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor automatic update flow to use custom Sparkle user driver #3274

Refactor automatic update flow to use custom Sparkle user driver #3274

quanganhdo commented Sep 13, 2024 •

edited

Loading

quanganhdo commented Sep 13, 2024 •

edited

Loading

github-actions bot commented Sep 13, 2024 •

edited

Loading

tomasstrba left a comment

tomasstrba Sep 18, 2024

quanganhdo Sep 18, 2024

tomasstrba Sep 19, 2024

tomasstrba left a comment

quanganhdo commented Sep 18, 2024 •

edited

Loading

tomasstrba left a comment

Refactor automatic update flow to use custom Sparkle user driver #3274

Are you sure you want to change the base?

Refactor automatic update flow to use custom Sparkle user driver #3274

Conversation

quanganhdo commented Sep 13, 2024 • edited Loading

Internal references:

quanganhdo commented Sep 13, 2024 • edited Loading

github-actions bot commented Sep 13, 2024 • edited Loading

tomasstrba left a comment

Choose a reason for hiding this comment

tomasstrba Sep 18, 2024

Choose a reason for hiding this comment

quanganhdo Sep 18, 2024

Choose a reason for hiding this comment

tomasstrba Sep 19, 2024

Choose a reason for hiding this comment

tomasstrba left a comment

Choose a reason for hiding this comment

quanganhdo commented Sep 18, 2024 • edited Loading

tomasstrba left a comment

Choose a reason for hiding this comment

quanganhdo commented Sep 13, 2024 •

edited

Loading

quanganhdo commented Sep 13, 2024 •

edited

Loading

github-actions bot commented Sep 13, 2024 •

edited

Loading

quanganhdo commented Sep 18, 2024 •

edited

Loading