admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

Merge pull request #14675 from Bo98/api-bash

Browse Source 
Further improvements to API handling in shell
This commit is contained in:
Mike McQuaid 2023-02-20 09:45:56 +00:00 committed by GitHub
commit 3d3b20b6d6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 211 additions and 97 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Library/Homebrew/api.rb
View File

@ -35,7 +35,7 @@ module Homebrew
raise ArgumentError, "Invalid JSON file: #{Tty.underline}#{api_url}#{Tty.reset}"
end
sig { params(endpoint: String, target: Pathname).returns(T.any(Array, Hash)) }
sig { params(endpoint: String, target: Pathname).returns([T.any(Array, Hash), T::Boolean]) }
def self.fetch_json_api_file(endpoint, target:)
retry_count = 0
url = "#{Homebrew::EnvConfig.api_domain}/#{endpoint}"
@ -83,7 +83,7 @@ module Homebrew
end
FileUtils.touch(target) unless skip_download
JSON.parse(target.read)
[JSON.parse(target.read), !skip_download]
rescue JSON::ParserError
target.unlink
retry_count += 1
@ -129,5 +129,16 @@ module Homebrew
json.except("variations")
end
sig { params(names: T::Array[String], type: String, regenerate: T::Boolean).returns(T::Boolean) }
def self.write_names_file(names, type, regenerate:)
names_path = HOMEBREW_CACHE_API/"#{type}_names.txt"
if !names_path.exist? || regenerate
names_path.write(names.join("\n"))
return true
end
false
end
end
end

37
Library/Homebrew/api/cask.rb
View File

@ -1,6 +1,8 @@
# typed: true
# frozen_string_literal: true
require "extend/cachable"
module Homebrew
module API
# Helper functions for using the cask JSON API.
@ -8,8 +10,11 @@ module Homebrew
# @api private
module Cask
class << self
include Cachable
extend T::Sig
private :cache
sig { params(token: String).returns(Hash) }
def fetch(token)
Homebrew::API.fetch "cask/#{token}.json"
@ -20,16 +25,34 @@ module Homebrew
Homebrew::API.fetch_homebrew_cask_source token, git_head: git_head
end
sig { returns(T::Boolean) }
def download_and_cache_data!
json_casks, updated = Homebrew::API.fetch_json_api_file "cask.json",
target: HOMEBREW_CACHE_API/"cask.json"
cache["casks"] = json_casks.to_h do |json_cask|
[json_cask["token"], json_cask.except("token")]
end
updated
end
private :download_and_cache_data!
sig { returns(Hash) }
def all_casks
@all_casks ||= begin
json_casks = Homebrew::API.fetch_json_api_file "cask.json",
target: HOMEBREW_CACHE_API/"cask.json"
json_casks.to_h do |json_cask|
[json_cask["token"], json_cask.except("token")]
end
unless cache.key?("casks")
json_updated = download_and_cache_data!
write_names(regenerate: json_updated)
end
cache["casks"]
end
sig { params(regenerate: T::Boolean).void }
def write_names(regenerate: false)
download_and_cache_data! unless cache.key?("casks")
Homebrew::API.write_names_file(all_casks.keys, "cask", regenerate: regenerate)
end
end
end

60
Library/Homebrew/api/formula.rb
View File

@ -1,6 +1,8 @@
# typed: true
# frozen_string_literal: true
require "extend/cachable"
module Homebrew
module API
# Helper functions for using the formula JSON API.
@ -8,35 +10,65 @@ module Homebrew
# @api private
module Formula
class << self
include Cachable
extend T::Sig
private :cache
sig { params(name: String).returns(Hash) }
def fetch(name)
Homebrew::API.fetch "formula/#{name}.json"
end
sig { returns(T::Boolean) }
def download_and_cache_data!
json_formulae, updated = Homebrew::API.fetch_json_api_file "formula.json",
target: HOMEBREW_CACHE_API/"formula.json"
cache["aliases"] = {}
cache["formulae"] = json_formulae.to_h do |json_formula|
json_formula["aliases"].each do |alias_name|
cache["aliases"][alias_name] = json_formula["name"]
end
[json_formula["name"], json_formula.except("name")]
end
updated
end
private :download_and_cache_data!
sig { returns(Hash) }
def all_formulae
@all_formulae ||= begin
json_formulae = Homebrew::API.fetch_json_api_file "formula.json",
target: HOMEBREW_CACHE_API/"formula.json"
@all_aliases = {}
json_formulae.to_h do |json_formula|
json_formula["aliases"].each do |alias_name|
@all_aliases[alias_name] = json_formula["name"]
end
[json_formula["name"], json_formula.except("name")]
end
unless cache.key?("formulae")
json_updated = download_and_cache_data!
write_names_and_aliases(regenerate: json_updated)
end
cache["formulae"]
end
sig { returns(Hash) }
def all_aliases
all_formulae if @all_aliases.blank?
unless cache.key?("aliases")
json_updated = download_and_cache_data!
write_names_and_aliases(regenerate: json_updated)
end
@all_aliases
cache["aliases"]
end
sig { params(regenerate: T::Boolean).void }
def write_names_and_aliases(regenerate: false)
download_and_cache_data! unless cache.key?("formulae")
return unless Homebrew::API.write_names_file(all_formulae.keys, "formula", regenerate: regenerate)
(HOMEBREW_CACHE_API/"formula_aliases.txt").open("w") do |file|
all_aliases.each do |alias_name, real_name|
file.puts "#{alias_name}|#{real_name}"
end
end
end
end
end

8
Library/Homebrew/brew.sh
View File

@ -75,10 +75,10 @@ case "$*" in
homebrew-casks
exit 0
;;
# falls back to cmd/prefix.rb on a non-zero return
--prefix*)
source "${HOMEBREW_LIBRARY}/Homebrew/prefix.sh"
homebrew-prefix "$@" && exit 0
# falls back to cmd/--prefix.rb and cmd/--cellar.rb on a non-zero return
--prefix* | --cellar*)
source "${HOMEBREW_LIBRARY}/Homebrew/formula_path.sh"
homebrew-formula-path "$@" && exit 0
;;
esac

11
Library/Homebrew/cmd/casks.sh
View File

@ -8,5 +8,14 @@
source "${HOMEBREW_LIBRARY}/Homebrew/items.sh"
homebrew-casks() {
homebrew-items '*/Casks/*\.rb' '' 's|/Casks/|/|' '^homebrew/cask'
# HOMEBREW_CACHE is set by brew.sh
# shellcheck disable=SC2154
if [[ -z "${HOMEBREW_NO_INSTALL_FROM_API}" &&
-f "${HOMEBREW_CACHE}/api/cask_names.txt" ]]
then
cat "${HOMEBREW_CACHE}/api/cask_names.txt"
echo
else
homebrew-items '*/Casks/*\.rb' '' 's|/Casks/|/|' '^homebrew/cask'
fi
}

14
Library/Homebrew/cmd/formulae.sh
View File

@ -8,18 +8,14 @@
source "${HOMEBREW_LIBRARY}/Homebrew/items.sh"
homebrew-formulae() {
local formulae
formulae="$(homebrew-items '*\.rb' 'Casks' 's|/Formula/|/|' '^homebrew/core')"
# HOMEBREW_CACHE is set by brew.sh
# shellcheck disable=SC2154
if [[ -z "${HOMEBREW_NO_INSTALL_FROM_API}" &&
-f "${HOMEBREW_CACHE}/api/formula.json" ]]
-f "${HOMEBREW_CACHE}/api/formula_names.txt" ]]
then
local api_formulae
api_formulae="$(ruby -e "require 'json'; JSON.parse(File.read('${HOMEBREW_CACHE}/api/formula.json')).each { |f| puts f['name'] }" 2>/dev/null)"
formulae="$(echo -e "${formulae}\n${api_formulae}" | sort -uf | grep .)"
cat "${HOMEBREW_CACHE}/api/formula_names.txt"
echo
else
homebrew-items '*\.rb' 'Casks' 's|/Formula/|/|' '^homebrew/core'
fi
echo "${formulae}"
}

6
Library/Homebrew/cmd/update-report.rb
View File

@ -146,6 +146,12 @@ module Homebrew
end
end
# Check if we can parse the JSON and do any Ruby-side follow-up.
if Homebrew::EnvConfig.install_from_api?
Homebrew::API::Formula.write_names_and_aliases
Homebrew::API::Cask.write_names
end
Homebrew.failed = true if ENV["HOMEBREW_UPDATE_FAILED"]
return if Homebrew::EnvConfig.disable_load_formula?

6
Library/Homebrew/cmd/update.sh
View File

@ -796,9 +796,15 @@ EOS
done
if [[ ${curl_exit_code} -eq 0 ]]
then
touch "${HOMEBREW_CACHE}/api/${formula_or_cask}.json"
CURRENT_JSON_BYTESIZE="$(wc -c "${HOMEBREW_CACHE}"/api/"${formula_or_cask}".json)"
if [[ "${INITIAL_JSON_BYTESIZE}" != "${CURRENT_JSON_BYTESIZE}" ]]
then
rm -f "${HOMEBREW_CACHE}/api/${formula_or_cask}_names.txt"
if [[ "${formula_or_cask}" == "formula" ]]
then
rm -f "${HOMEBREW_CACHE}/api/formula_aliases.txt"
fi
HOMEBREW_UPDATED="1"
fi
else

89
Library/Homebrew/formula_path.sh Normal file
View File

@ -0,0 +1,89 @@
# does the quickest output of brew --prefix/--cellar possible for the basic cases:
# - `brew --prefix` (output HOMEBREW_PREFIX)
# - `brew --cellar` (output HOMEBREW_CELLAR)
# - `brew --prefix <formula>` (output HOMEBREW_PREFIX/opt/<formula>)
# - `brew --cellar <formula>` (output HOMEBREW_CELLAR/<formula>)
# anything else? delegate to the slower cmd/--prefix.rb and cmd/--cellar.rb
# HOMEBREW_PREFIX and HOMEBREW_REPOSITORY are set by brew.sh
# shellcheck disable=SC2154
homebrew-formula-path() {
while [[ "$#" -gt 0 ]]
do
case "$1" in
# check we actually have --prefix and not e.g. --prefixsomething
--prefix)
local prefix="1"
shift
;;
--cellar)
local cellar="1"
shift
;;
# reject all other flags
-*) return 1 ;;
*)
[[ -n "${formula}" ]] && return 1
local formula="$1"
shift
;;
esac
done
[[ -z "${prefix}" && -z "${cellar}" ]] && return 1
[[ -n "${prefix}" && -n "${cellar}" ]] && return 1 # don't allow both!
if [[ -z "${formula}" ]]
then
if [[ -n "${prefix}" ]]
then
echo "${HOMEBREW_PREFIX}"
else
echo "${HOMEBREW_CELLAR}"
fi
return 0
fi
local formula_exists
if [[ -f "${HOMEBREW_REPOSITORY}/Library/Taps/homebrew/homebrew-core/Formula/${formula}.rb" ]]
then
formula_exists="1"
else
local formula_path
formula_path="$(
shopt -s nullglob
echo "${HOMEBREW_REPOSITORY}/Library/Taps"/*/*/{Formula/,HomebrewFormula/,}"${formula}.rb"
)"
[[ -n "${formula_path}" ]] && formula_exists="1"
fi
if [[ -z "${formula_exists}" &&
-z "${HOMEBREW_NO_INSTALL_FROM_API}" ]]
then
if [[ -f "${HOMEBREW_CACHE}/api/formula_names.txt" ]] &&
grep -Fxq "${formula}" "${HOMEBREW_CACHE}/api/formula_names.txt"
then
formula_exists="1"
elif [[ -f "${HOMEBREW_CACHE}/api/formula_aliases.txt" ]]
then
while IFS="|" read -r alias_name real_name
do
case "${alias_name}" in
"${formula}")
formula_exists="1"
formula="${real_name}"
break
;;
*) ;;
esac
done <"${HOMEBREW_CACHE}/api/formula_aliases.txt"
fi
fi
[[ -z "${formula_exists}" ]] && return 1
if [[ -n "${prefix}" ]]
then
echo "${HOMEBREW_PREFIX}/opt/${formula}"
else
echo "${HOMEBREW_CELLAR}/${formula}"
fi
return 0
}

58
Library/Homebrew/prefix.sh
View File

@ -1,58 +0,0 @@
# does the quickest output of brew --prefix possible for the basic cases:
# - `brew --prefix` (output HOMEBREW_PREFIX)
# - `brew --prefix <formula>` (output HOMEBREW_PREFIX/opt/<formula>)
# anything else? delegate to the slower cmd/--prefix.rb
# HOMEBREW_PREFIX and HOMEBREW_REPOSITORY are set by brew.sh
# shellcheck disable=SC2154
homebrew-prefix() {
while [[ "$#" -gt 0 ]]
do
case "$1" in
# check we actually have --prefix and not e.g. --prefixsomething
--prefix)
local prefix="1"
shift
;;
# reject all other flags
-*) return 1 ;;
*)
[[ -n "${formula}" ]] && return 1
local formula="$1"
shift
;;
esac
done
[[ -z "${prefix}" ]] && return 1
[[ -z "${formula}" ]] && echo "${HOMEBREW_PREFIX}" && return 0
local formula_exists
if [[ -f "${HOMEBREW_REPOSITORY}/Library/Taps/homebrew/homebrew-core/Formula/${formula}.rb" ]]
then
formula_exists="1"
else
local formula_path
formula_path="$(
shopt -s nullglob
echo "${HOMEBREW_REPOSITORY}/Library/Taps"/*/*/{Formula/,HomebrewFormula/,}"${formula}.rb"
)"
[[ -n "${formula_path}" ]] && formula_exists="1"
fi
if [[ -z "${formula_exists}" &&
-z "${HOMEBREW_NO_INSTALL_FROM_API}" &&
-f "${HOMEBREW_CACHE}/api/formula.json" ]]
then
formula_exists="$(
ruby -rjson <<RUBY 2>/dev/null
puts 1 if JSON.parse(File.read("${HOMEBREW_CACHE}/api/formula.json")).any? do |f|
f["name"] == "${formula}"
end
RUBY
)"
fi
[[ -z "${formula_exists}" ]] && return 1
echo "${HOMEBREW_PREFIX}/opt/${formula}"
return 0
}

4
Library/Homebrew/test/api_spec.rb
View File

@ -51,13 +51,13 @@ describe Homebrew::API do
it "fetches a JSON file" do
mock_curl_download stdout: json
fetched_json = described_class.fetch_json_api_file("foo.json", target: cache_dir/"foo.json")
fetched_json, = described_class.fetch_json_api_file("foo.json", target: cache_dir/"foo.json")
expect(fetched_json).to eq json_hash
end
it "updates an existing JSON file" do
mock_curl_download stdout: json
fetched_json = described_class.fetch_json_api_file("bar.json", target: cache_dir/"bar.json")
fetched_json, = described_class.fetch_json_api_file("bar.json", target: cache_dir/"bar.json")
expect(fetched_json).to eq json_hash
end