Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor rename/migration handling in Formulary. #16595

Merged
merged 1 commit into from
Feb 8, 2024
Merged

Refactor rename/migration handling in Formulary. #16595

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Library/Homebrew/cmd/install.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ def self.install
end

begin
formulae, casks = args.named.to_formulae_and_casks
formulae, casks = args.named.to_formulae_and_casks(warn: false)
.partition { |formula_or_cask| formula_or_cask.is_a?(Formula) }
rescue FormulaOrCaskUnavailableError, Cask::CaskUnavailableError
cask_tap = CoreCaskTap.instance
Expand Down
105 changes: 50 additions & 55 deletions Library/Homebrew/formulary.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -902,47 +902,49 @@ def self.path(ref)
loader_for(ref).path
end

def self.tap_formula_name_path(tapped_name, warn:)
def self.tap_formula_name_type(tapped_name, warn:)
user, repo, name = tapped_name.split("/", 3).map(&:downcase)
tap = Tap.fetch user, repo
path = Formulary.find_formula_in_tap(name, tap)

unless path.file?
if (possible_alias = tap.alias_dir/name).file?
path = possible_alias.resolved_path
name = path.basename(".rb").to_s
elsif (new_name = tap.formula_renames[name].presence) &&
(new_path = Formulary.find_formula_in_tap(new_name, tap)).file?
old_name = name
path = new_path
name = new_name
new_name = tap.core_tap? ? name : "#{tap}/#{name}"
elsif (new_tap_name = tap.tap_migrations[name].presence)
new_tap_user, new_tap_repo, = new_tap_name.split("/")
new_tap_name = "#{new_tap_user}/#{new_tap_repo}"
new_tap = Tap.fetch new_tap_name
new_tap.ensure_installed!
new_tapped_name = "#{new_tap_name}/#{name}"
name, path, tap = Formulary.tap_formula_name_path(new_tapped_name, warn: false)
old_name = tapped_name
new_name = new_tap.core_tap? ? name : new_tapped_name
end

opoo "Formula #{old_name} was renamed to #{new_name}." if warn && old_name && new_name
type = nil

if (possible_alias = tap.alias_table[name].presence)
name = possible_alias
type = :alias
elsif (new_name = tap.formula_renames[name].presence)
old_name = name
name = new_name
new_name = tap.core_tap? ? name : "#{tap}/#{name}"
type = :rename
elsif (new_tap_name = tap.tap_migrations[name].presence)
new_tap_user, new_tap_repo, = new_tap_name.split("/")
new_tap_name = "#{new_tap_user}/#{new_tap_repo}"
new_tap = Tap.fetch new_tap_name
new_tap.ensure_installed!
new_tapped_name = "#{new_tap_name}/#{name}"
name, tap, = Formulary.tap_formula_name_type(new_tapped_name, warn: false)
old_name = tapped_name
new_name = new_tap.core_tap? ? name : new_tapped_name
type = :migration
Comment on lines -905 to +927
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess the main difference in this logic at second glance is the removal of the Formulary.find_formula_in_tap and file path checks. Maybe those helped prevent infinite loops before and would have helped prevent what happened in #16628.

CC: @dduugg

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, previously it would just skip all this if the formula path exists.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the attention and fix here, @apainintheneck @reitermarkus 🥰

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@reitermarkus @apainintheneck @dduugg Should we revert this PR given #16628 is still open?

end

[name, path, tap]
opoo "Formula #{old_name} was renamed to #{new_name}." if warn && old_name && new_name

[name, tap, type]
end

def self.tap_loader_for(tapped_name, warn:)
name, path, tap = Formulary.tap_formula_name_path(tapped_name, warn: warn)
name, tap, type = Formulary.tap_formula_name_type(tapped_name, warn: warn)

if tap.core_tap? && !Homebrew::EnvConfig.no_install_from_api? &&
Homebrew::API::Formula.all_formulae.key?(name)
FormulaAPILoader.new(name)
else
TapLoader.new(name, path, tap: tap)
if tap.core_tap? && !Homebrew::EnvConfig.no_install_from_api?
if type == :alias
return AliasAPILoader.new(name)
elsif Homebrew::API::Formula.all_formulae.key?(name)
return FormulaAPILoader.new(name)
end
end

path = find_formula_in_tap(name, tap)
TapLoader.new(name, path, tap: tap)
end

def self.loader_for(ref, from: nil, warn: true)
Expand All @@ -952,12 +954,6 @@ def self.loader_for(ref, from: nil, warn: true)
when URL_START_REGEX
return FromUrlLoader.new(ref, from: from)
when HOMEBREW_TAP_FORMULA_REGEX
if ref.match?(%r{^homebrew/(?:homebrew-)?core/}i) && !Homebrew::EnvConfig.no_install_from_api?
name = ref.split("/", 3).last
return FormulaAPILoader.new(name) if Homebrew::API::Formula.all_formulae.key?(name)
return AliasAPILoader.new(name) if Homebrew::API::Formula.all_aliases.key?(name)
end

return Formulary.tap_loader_for(ref, warn: warn)
end

Expand All @@ -979,37 +975,36 @@ def self.loader_for(ref, from: nil, warn: true)
end
return AliasLoader.new(possible_alias) if possible_alias.symlink?

possible_tap_formulae = tap_paths(ref)
raise TapFormulaAmbiguityError.new(ref, possible_tap_formulae) if possible_tap_formulae.size > 1

if possible_tap_formulae.size == 1
case (possible_tap_formulae = tap_paths(ref)).count
when 1
path = possible_tap_formulae.first.resolved_path
name = path.basename(".rb").to_s
return FormulaLoader.new(name, path)
when 2..Float::INFINITY
raise TapFormulaAmbiguityError.new(ref, possible_tap_formulae)
end

if CoreTap.instance.formula_renames.key?(ref)
unless Homebrew::EnvConfig.no_install_from_api?
return FormulaAPILoader.new(CoreTap.instance.formula_renames[ref])
end

return Formulary.tap_loader_for("#{CoreTap.instance}/#{ref}", warn: warn)
end

possible_taps = Tap.select { |tap| tap.formula_renames.key?(ref) }

if possible_taps.size > 1
case possible_taps.count
when 1
return Formulary.tap_loader_for("#{possible_taps.first}/#{ref}", warn: warn)
when 2..Float::INFINITY
possible_tap_newname_formulae = possible_taps.map { |tap| "#{tap}/#{tap.formula_renames[ref]}" }
raise TapFormulaWithOldnameAmbiguityError.new(ref, possible_tap_newname_formulae)
end

return Formulary.tap_loader_for("#{possible_taps.first}/#{ref}", warn: warn) unless possible_taps.empty?

possible_keg_formula = Pathname.new("#{HOMEBREW_PREFIX}/opt/#{ref}/.brew/#{ref}.rb")
return FormulaLoader.new(ref, possible_keg_formula) if possible_keg_formula.file?
if (keg_formula = HOMEBREW_PREFIX/"opt/#{ref}/.brew/#{ref}.rb").file?
return FormulaLoader.new(ref, keg_formula)
end

possible_cached_formula = Pathname.new("#{HOMEBREW_CACHE_FORMULA}/#{ref}.rb")
return FormulaLoader.new(ref, possible_cached_formula) if possible_cached_formula.file?
if (cached_formula = HOMEBREW_CACHE_FORMULA/"#{ref}.rb").file?
return FormulaLoader.new(ref, cached_formula)
end

NullLoader.new(ref)
end
Expand All @@ -1022,9 +1017,9 @@ def self.core_alias_path(name)
CoreTap.instance.alias_dir/name.to_s.downcase
end

def self.tap_paths(name, taps = Tap)
def self.tap_paths(name)
name = name.to_s.downcase
taps.map do |tap|
Tap.map do |tap|
formula_path = find_formula_in_tap(name, tap)

alias_path = tap.alias_dir/name
Expand Down
Loading