56dd89114d
Valid `strategy` block return types currently vary between strategies. Some only accept a string whereas others accept a string or array of strings. [`strategy` blocks also accept a `nil` return (to simplify early returns) but this was already standardized across strategies.] While some strategies only identify one version by default (where a string is an appropriate return type), it could be that a strategy block identifies more than one version. In this situation, the strategy would need to be modified to accept (and work with) an array from a `strategy` block. Rather than waiting for this to become a problem, this modifies all strategies to standardize on allowing `strategy` blocks to return a string or array of strings (even if only one of these is currently used in practice). Standardizing valid return types helps to further simplify the mental model for `strategy` blocks and reduce cognitive load. This commit extracts related logic from `#find_versions` into methods like `#versions_from_content`, which is conceptually similar to `PageMatch#page_matches` (renamed to `#versions_from_content` for consistency). This allows us to write tests for the related code without having to make network requests (or stub them) at this point. In general, this also helps to better align the structure of strategies and how the various `#find_versions` methods work with versions. There's still more planned work to be done here but this is a step in the right direction.
103 lines
3.5 KiB
Ruby
103 lines
3.5 KiB
Ruby
# typed: true
|
|
# frozen_string_literal: true
|
|
|
|
require_relative "page_match"
|
|
|
|
module Homebrew
|
|
module Livecheck
|
|
module Strategy
|
|
# The {HeaderMatch} strategy follows all URL redirections and scans
|
|
# the resulting headers for matching text using the provided regex.
|
|
#
|
|
# @api private
|
|
class HeaderMatch
|
|
extend T::Sig
|
|
|
|
NICE_NAME = "Header match"
|
|
|
|
# A priority of zero causes livecheck to skip the strategy. We only
|
|
# apply {HeaderMatch} using `strategy :header_match` in a `livecheck`
|
|
# block, as we can't automatically determine when this can be
|
|
# successfully applied to a URL.
|
|
PRIORITY = 0
|
|
|
|
# The `Regexp` used to determine if the strategy applies to the URL.
|
|
URL_MATCH_REGEX = %r{^https?://}i.freeze
|
|
|
|
# The header fields to check when a `strategy` block isn't provided.
|
|
DEFAULT_HEADERS_TO_CHECK = ["content-disposition", "location"].freeze
|
|
|
|
# Whether the strategy can be applied to the provided URL.
|
|
# The strategy will technically match any HTTP URL but is
|
|
# only usable with a `livecheck` block containing a regex
|
|
# or block.
|
|
sig { params(url: String).returns(T::Boolean) }
|
|
def self.match?(url)
|
|
URL_MATCH_REGEX.match?(url)
|
|
end
|
|
|
|
# Identify versions from HTTP headers.
|
|
#
|
|
# @param headers [Hash] a hash of HTTP headers to check for versions
|
|
# @param regex [Regexp, nil] a regex to use to identify versions
|
|
# @return [Array]
|
|
sig {
|
|
params(
|
|
headers: T::Hash[String, String],
|
|
regex: T.nilable(Regexp),
|
|
block: T.nilable(
|
|
T.proc.params(
|
|
arg0: T::Hash[String, String],
|
|
arg1: T.nilable(Regexp),
|
|
).returns(T.any(String, T::Array[String], NilClass)),
|
|
),
|
|
).returns(T::Array[String])
|
|
}
|
|
def self.versions_from_headers(headers, regex = nil, &block)
|
|
return Strategy.handle_block_return(block.call(headers, regex)) if block
|
|
|
|
DEFAULT_HEADERS_TO_CHECK.map do |header_name|
|
|
header_value = headers[header_name]
|
|
next if header_value.blank?
|
|
|
|
if regex
|
|
header_value[regex, 1]
|
|
else
|
|
v = Version.parse(header_value, detected_from_url: true)
|
|
v.null? ? nil : v.to_s
|
|
end
|
|
end.compact.uniq
|
|
end
|
|
|
|
# Checks the final URL for new versions after following all redirections,
|
|
# using the provided regex for matching.
|
|
sig {
|
|
params(
|
|
url: String,
|
|
regex: T.nilable(Regexp),
|
|
cask: T.nilable(Cask::Cask),
|
|
block: T.nilable(
|
|
T.proc.params(arg0: T::Hash[String, String], arg1: T.nilable(Regexp)).returns(T.nilable(String)),
|
|
),
|
|
).returns(T::Hash[Symbol, T.untyped])
|
|
}
|
|
def self.find_versions(url, regex, cask: nil, &block)
|
|
match_data = { matches: {}, regex: regex, url: url }
|
|
|
|
headers = Strategy.page_headers(url)
|
|
|
|
# Merge the headers from all responses into one hash
|
|
merged_headers = headers.reduce(&:merge)
|
|
return match_data if merged_headers.blank?
|
|
|
|
versions_from_headers(merged_headers, regex, &block).each do |version_text|
|
|
match_data[:matches][version_text] = Version.new(version_text)
|
|
end
|
|
|
|
match_data
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|