Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add deprecations/warnings for incorrect feed & update checking usage #2295

Merged
merged 8 commits into from
Dec 20, 2022
Merged

Add deprecations/warnings for incorrect feed & update checking usage #2295

merged 8 commits into from
Dec 20, 2022

Conversation

zorgiepoo
Copy link
Member

@zorgiepoo zorgiepoo commented Dec 3, 2022 •
edited
Loading

This change deprecates -[SPUUpdater setFeedURL:] and logs warnings when the updater detects that feed URLs from user defaults are still being used. This change also adds an API that needs to be called to clear the feed URL from user defaults when migrating away from -[SPUUpdater setFeedURL:]

This change also logs a warning when -[SPUUpdater checkForUpdatesInBackground] is used incorrectly if Sparkle is configured to ask the user's permission to check for updates but a check is done when automatic update checking is NO.

Misc Checklist

  • My change requires a documentation update on Sparkle's website repository
  • My change requires changes to generate_appcast, generate_keys, or sign_update

Only bug fixes to regressions or security fixes are being backported to the 1.x (master) branch now. If you believe your change is significant enough to backport, please also create a separate pull request against the master branch.

Testing

I tested and verified my change by using one or multiple of these methods:

  • Sparkle Test App
  • Unit Tests
  • My own app
  • Other (please specify)

Tested calling checkForUpdatesInBackground incorrectly and calling setFeedURL then forgetting to clear the feed url, then calling clearFeedURLFromUserDefaults both from obj-c and swift projects.

macOS version tested: 13.0.1 (22A400)

@zorgiepoo
Add deprecations/warnings for incorrect feed & update checking usage
0a9579c 
This change deprecates -[SPUUpdater setFeedURL:] and logs warnings when the updater detects that feed URLs from user defaults are still being used.

This change also logs a warning when checkForUpdatesInBackground is used incorrectly if Sparkle is configured to ask the user's permission to check for updates but a check is done when automatic update checking is NO.
@zorgiepoo
Update documentation for checkForUpdatesInBackground
c4b3b9a
@zorgiepoo
Update error message
a5e24c6
@zorgiepoo zorgiepoo added this to the 2.4 milestone Dec 3, 2022
@zorgiepoo zorgiepoo merged commit 8154b1e into 2.x Dec 20, 2022
@zorgiepoo zorgiepoo deleted the warn-feed-url-and-background-checks branch December 20, 2022 04:34
danielpunkass added a commit to danielpunkass/Sparkle that referenced this pull request Feb 27, 2023
@danielpunkass
Merge upstream 2.x into HEAD, preparing to remerge with latest change…
4bf361d 
…s on my branch.

* commit '362f50a8a19cfb1a18202c5912ce4ce6f94d0190': (60 commits)
  Exit with an error if generate_appcast cannot sign an update (sparkle-project#2322)
  Update SUVersionDisplay to allow including build versions and update information (sparkle-project#2321)
  Update Package management files for version 2.3.2
  Update CHANGELOG for 2.3.2
  Remove unnecessary min macro checks (sparkle-project#2318)
  Add support for plain text release notes view (sparkle-project#2315)
  Don't construct appcast item if enclosure URL is invalid (sparkle-project#2317)
  Finnish localization grammar fixes (sparkle-project#2311)
  Reduce code size and make codebase more consistent (sparkle-project#2305)
  Add delegate method to hide showing version history option (sparkle-project#2303)
  Update Package management files for version 2.3.1
  Update CHANGELOG for 2.3.1
  Add deprecations/warnings for incorrect feed & update checking usage (sparkle-project#2295)
  Log the URL that failed to download correctly (sparkle-project#2296)
  Remove duplicate Sparkle localization strings in Updater app (sparkle-project#2288)
  Ask permission for automatically downloading and installing new updates (sparkle-project#2285)
  Upgrade CI to default to using Xcode 14.1 (sparkle-project#2287)
  Enable deployment post processing for Release configurations (sparkle-project#2286)
  Fix update permission alert title text overlapping with question text (sparkle-project#2284)
  Update Czech translation (sparkle-project#2275)
  ...
zorgiepoo added a commit that referenced this pull request May 12, 2024
@zorgiepoo
Guard update timer update check against sessionInProgress
5b403be 
Make sure we don't perform a background update check when a user update check was initiated. This may have regressed from #2295.

Also replaces an assert with an error log if the _driver already exists.

Fixes #2560
@zorgiepoo zorgiepoo mentioned this pull request May 12, 2024
Merged
6 tasks
zorgiepoo added a commit that referenced this pull request May 12, 2024
@zorgiepoo
Guard update timer update check against sessionInProgress (#2561)
be8247e 
Make sure we don't perform a background update check when a user update check was initiated. This may have regressed from #2295.

Also replaces an assert with an error log if the _driver already exists.

Fixes #2560
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
2.4
Development

Successfully merging this pull request may close these issues.
1 participant
@zorgiepoo