add validation of update mirror urls #17310
Conversation
…unction (nvaccess#17205) Moved the logic for parsing update check responses into a new function `parseUpdateCheckResponse`.
Co-authored-by: Sean Budd <[email protected]>
seanbudd
added
the
conceptApproved
There was a problem hiding this comment.
Thanks @christopherpross. A couple of minor adjustments, plus I think you may have forgotten to push the schema validation.
| if not response.ok: | ||
| return False | ||
|
|
||
| responseContent = response.text |
There was a problem hiding this comment.
response is necessarily OK, as testing fails before running the validator for any status other than 200.
| if not response.ok: | |
| return False | |
| responseContent = response.text | |
| responseContent = response.text |
| @@ -5595,3 +5596,18 @@ def _isResponseAddonStoreCacheHash(response: requests.Response) -> bool: | |||
| # While the NV Access Add-on Store cache hash is a git commit hash as a string, other implementations may use a different format. | |||
| # Therefore, we only check if the data is a non-empty string. | |||
| return isinstance(data, str) and bool(data) | |||
|
|
|||
|
|
|||
| def _isResponseUpdateMirrorValid(response: requests.Response) -> bool: | |||
There was a problem hiding this comment.
In your PR description, you say:
- Defined the minimum schema for an update mirror response based on the following required keys:
versionlauncherUrlapiVersion
However it doesn't seem that you have implemented this in _isResponseUpdateMirrorValid or anywhere else. Am I missing something?
There was a problem hiding this comment.
@SaschaCowley Hey, sorry I see. While merging, there is a change not applied. So this is lost. In the next few days, I will fix that. Sorry for the inconvinience.
| data = res.text | ||
| info = parseUpdateCheckResponse(data) |
There was a problem hiding this comment.
| data = res.text | |
| info = parseUpdateCheckResponse(data) | |
| info = parseUpdateCheckResponse(res.text) |
Co-authored-by: Sascha Cowley <[email protected]>
Link to issue number:
#17205
Summary of the issue:
Users could configure an invalid update mirror URL, which would only be discovered when attempting to check for updates. This PR implements a validation mechanism that ensures the specified update mirror is valid before allowing it to be set in the settings.
Description of user facing changes
A new validation process has been added when setting an update mirror URL in NVDA's settings. Users will now receive feedback if the URL they provide is not a valid update mirror. The "Test" button in the settings will now ensure that the mirror responds with the expected format, preventing invalid configurations.
Description of development approach
parseUpdateCheckResponse.versionlauncherUrlapiVersion_isResponseUpdateMirrorValidinsettingsDialogs.py, which callsparseUpdateCheckResponseto validate the mirror's response._isResponseUpdateMirrorValidas theresponseValidatorin the_SetURLDialogfor update mirrors.Testing strategy:
Known issues with pull request:
No known issues.
Code Review Checklist:
@coderabbitai summary