Only warn about add-on compatibility when updating to an incompatible API#17370
Merged
Conversation
SaschaCowley
added a commit
that referenced
this pull request
Dec 12, 2024
…ng to an incompatible API (#17506) Closes #17490 Fix up of #17370 Summary of the issue: NVDA still presents the add-on incompatibility message in some situations when updating to a backwards-compatible add-on API with incompatible add-ons installed. Description of user facing changes The add-on incompatibility message should no-longer be presented when updating to a backwards-compatible add-on API. Description of development approach Updated the logic in `UpdateAskInstallDialog` to match the new logic in `UpdateResultDialog`, so they both only present the warning when updating to a backwards-incompatible API and incompatible add-ons are installed. Testing strategy: Tested from source while spoofing to allow update checks, with version (and addon backcompat) set to 2025.1 and 2024.1 (to simulate both situations). Known issues with pull request: None.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Link to issue number:
Closes #17071
Summary of the issue:
NVDA complains about incompatible updates whenever it is updated with add-ons installed that are incompatible with the updated API version. This is particularly annoying for beta and alpha u8sers.
Description of user facing changes
The add-on incompatibility message is now only presented when updating to a version with an incompatible API to that of the installed copy. That is, when the update will cause
addonAPIVersion.BACK_COMPAT_TO[0]to increase.Description of development approach
Make increasing the add-on API backcompat's year a precondition of showing the warning in
updateCheck.py.Testing strategy:
Created two builds of NVDA, both with their version spoofed to 2024.4, and update version type to alpha.
In the first, set
addonAPIVersion.BACK_COMPAT_TOto(2024.1.0), and the other to(2025.1.0).Installed an add-on that is incompatible with the 2025 API in both copies.
Ensured that updating the first copy caused the add-on incompatibility message to appear, and updating the second copy did not.
Known issues with pull request:
None.
Code Review Checklist:
@coderabbitai summary