Cask::Audit: Align user agents with livecheck #17512
Merged
Conversation
This file contains 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
The `#page_headers` and `#page_content` methods in `Livecheck::Strategy` will fetch a URL using our default user agent but if the request fails it will retry with the `:browser` user agent. [For context, it was added as an interim measure to make URLs work that require a different user agent but I aim to remove it in the future in favor of specifying the user agent in a `livecheck` block (so we don't make unnecessary requests that we know will fail).] `Cask::Audit#audit_livecheck_https_availability` checks the `livecheck` block URL but it only does so using our default user agent (i.e., it calls `#validate_url_for_https_availability` which calls `Utils::Curl#curl_check_http_content` which has a `user_agents: [:default]` parameter). Due to this behavioral mismatch, it's possible for a `livecheck` block to work but for this cask audit to fail. This addresses the issue by adding `user_agents: [:default, :browser]` to the arguments the audit uses, which aligns its behavior with livecheck's.
MikeMcQuaid
approved these changes
Jun 15, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
brew stylewith your changes locally?brew typecheckwith your changes locally?brew testswith your changes locally?The
#page_headersand#page_contentmethods inLivecheck::Strategywill fetch a URL using our default user agent but if the request fails it will retry with the:browseruser agent. [For context, it was added as an interim measure to make URLs work that require a different user agent but I aim to remove it in the future in favor of specifying the user agent in alivecheckblock (so we don't make unnecessary requests that we know will fail).]Cask::Audit#audit_livecheck_https_availabilitychecks thelivecheckblock URL but it only does so using our default user agent (i.e., it calls#validate_url_for_https_availabilitywhich callsUtils::Curl#curl_check_http_contentwhich has auser_agents: [:default]parameter). Due to this behavioral mismatch, it's possible for alivecheckblock to work but for this cask audit to fail.This addresses the issue by adding
user_agents: [:default, :browser]to the arguments the audit uses, which aligns its behavior with livecheck's.I know there's some discussion in #15350 around whether we should be switching user agents at all and I'll reply to that issue to further the discussion. In the interim time, this PR is simply about aligning existing behavior, so PRs like Homebrew/homebrew-cask#175619 will correctly pass.