Module: Homebrew::Upgrade Private

Extended by:
Utils::Output::Mixin
Defined in:
upgrade.rb

Overview

This module is part of a private API. This module may only be used in the Homebrew/brew repository. Third parties should avoid using this module if possible, as it may be removed or changed without warning.

Helper functions for upgrading formulae.

Defined Under Namespace

Classes: Dependents, self

Class Method Summary collapse

Methods included from Utils::Output::Mixin

issue_reporting_message, odebug, odeprecated, odie, odisabled, ofail, oh1, oh1_title, ohai, ohai_title, onoe, opoo, opoo_outside_github_actions, pretty_deprecated, pretty_disabled, pretty_duration, pretty_install_status, pretty_installed, pretty_outdated, pretty_uninstalled, pretty_upgradable

Class Method Details

.dependants(formulae, flags:, dry_run: false, ask: false, installed_on_request: false, force_bottle: false, build_from_source_formulae: [], interactive: false, keep_tmp: false, debug_symbols: false, force: false, debug: false, quiet: false, verbose: false) ⇒ Dependents

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

  • formulae (Array<Formula>)
  • flags (Array<String>)
  • dry_run (Boolean) (defaults to: false)
  • ask (Boolean) (defaults to: false)
  • installed_on_request (Boolean) (defaults to: false)
  • force_bottle (Boolean) (defaults to: false)
  • build_from_source_formulae (Array<String>) (defaults to: [])
  • interactive (Boolean) (defaults to: false)
  • keep_tmp (Boolean) (defaults to: false)
  • debug_symbols (Boolean) (defaults to: false)
  • force (Boolean) (defaults to: false)
  • debug (Boolean) (defaults to: false)
  • quiet (Boolean) (defaults to: false)
  • verbose (Boolean) (defaults to: false)

Returns:



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'upgrade.rb', line 176

def dependants(
  formulae,
  flags:,
  dry_run: false,
  ask: false,
  installed_on_request: false,
  force_bottle: false,
  build_from_source_formulae: [],
  interactive: false,
  keep_tmp: false,
  debug_symbols: false,
  force: false,
  debug: false,
  quiet: false,
  verbose: false
)
  no_dependents = Dependents.new(upgradeable: [], pinned: [], skipped: [])
  if Homebrew::EnvConfig.no_installed_dependents_check?
    unless Homebrew::EnvConfig.no_env_hints?
      opoo <<~EOS
        `$HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK` is set: not checking for outdated
        dependents or dependents with broken linkage!
      EOS
    end
    return no_dependents
  end
  formulae_to_install = formulae.reject { |f| f.core_formula? && f.versioned_formula? }
  return no_dependents if formulae_to_install.empty?

  # TODO: this should be refactored to use FormulaInstaller new logic
  outdated = formulae_to_install.flat_map(&:runtime_installed_formula_dependents)
                                .uniq
                                .select(&:outdated?)

  # Ensure we never attempt a source build for outdated dependents of upgraded formulae.
  outdated, skipped = outdated.partition do |dependent|
    dependent.bottled? && dependent.deps.map(&:to_formula).all?(&:bottled?)
  end
  return no_dependents if outdated.blank?

  outdated -= formulae_to_install if dry_run
  upgradeable = outdated.reject(&:pinned?)
                        .sort { |a, b| depends_on(a, b) }
  pinned = outdated.select(&:pinned?)
                   .sort { |a, b| depends_on(a, b) }

  Dependents.new(upgradeable:, pinned:, skipped:)
end

.formula_installers(formulae_to_install, flags:, dry_run: false, force_bottle: false, build_from_source_formulae: [], dependents: false, interactive: false, keep_tmp: false, debug_symbols: false, force: false, overwrite: false, debug: false, quiet: false, verbose: false) ⇒ Array<FormulaInstaller>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

  • formulae_to_install (Array<Formula>)
  • flags (Array<String>)
  • dry_run (Boolean) (defaults to: false)
  • force_bottle (Boolean) (defaults to: false)
  • build_from_source_formulae (Array<String>) (defaults to: [])
  • dependents (Boolean) (defaults to: false)
  • interactive (Boolean) (defaults to: false)
  • keep_tmp (Boolean) (defaults to: false)
  • debug_symbols (Boolean) (defaults to: false)
  • force (Boolean) (defaults to: false)
  • overwrite (Boolean) (defaults to: false)
  • debug (Boolean) (defaults to: false)
  • quiet (Boolean) (defaults to: false)
  • verbose (Boolean) (defaults to: false)

Returns:



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'upgrade.rb', line 34

def formula_installers(
  formulae_to_install,
  flags:,
  dry_run: false,
  force_bottle: false,
  build_from_source_formulae: [],
  dependents: false,
  interactive: false,
  keep_tmp: false,
  debug_symbols: false,
  force: false,
  overwrite: false,
  debug: false,
  quiet: false,
  verbose: false
)
  return [] if formulae_to_install.empty?

  # Sort keg-only before non-keg-only formulae to avoid any needless conflicts
  # with outdated, non-keg-only versions of formulae being upgraded.
  formulae_to_install.sort! do |a, b|
    if !a.keg_only? && b.keg_only?
      1
    elsif a.keg_only? && !b.keg_only?
      -1
    else
      0
    end
  end

  dependency_graph = Utils::TopologicalHash.graph_package_dependencies(formulae_to_install)
  begin
    formulae_to_install = dependency_graph.tsort & formulae_to_install
  rescue TSort::Cyclic
    if Homebrew::EnvConfig.developer?
      raise CyclicDependencyError, dependency_graph.strongly_connected_components
    end
  end

  # We need to fetch the bottle tabs ahead of the `Install.fetch_formulae`
  # pipeline because we need to first filter out those formulae with all
  # runtime dependencies already satisfied (see below).
  download_queue = Homebrew::DownloadQueue.new
  begin
    installers = formulae_to_install.filter_map do |formula|
      Migrator.migrate_if_needed(formula, force:, dry_run:)
      begin
        fi = create_formula_installer(
          formula,
          flags:,
          force_bottle:,
          build_from_source_formulae:,
          interactive:,
          keep_tmp:,
          debug_symbols:,
          force:,
          overwrite:,
          debug:,
          quiet:,
          verbose:,
        )
        fi.download_queue = download_queue
        fi.fetch_bottle_tab(quiet: !debug, enqueue: true)
        fi
      rescue CannotInstallFormulaError => e
        ofail e
        nil
      rescue UnsatisfiedRequirements, DownloadError => e
        ofail "#{formula}: #{e}"
        nil
      end
    end

    download_queue.fetch
  ensure
    download_queue.shutdown
  end

  installers.filter_map do |fi|
    fi.determine_bottle_tab_attributes

    all_runtime_deps_installed = fi.bottle_tab_runtime_dependencies.presence&.all? do |dependency, hash|
      minimum_version = if (version = hash["version"])
        Version.new(version)
      end
      Dependency.new(dependency).installed?(minimum_version:, minimum_revision: hash["revision"].to_i)
    end

    if !dry_run && dependents && all_runtime_deps_installed
      # Don't need to install this bottle if all of the runtime
      # dependencies have the same or newer version already installed.
      next
    end

    fi
  end
end

.outdated_kegs(formula) ⇒ Array<Keg>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



150
151
152
153
154
 
# File 'upgrade.rb', line 150

def outdated_kegs(formula)
  [formula, *formula.old_installed_formulae].map(&:linked_keg)
                                            .select(&:directory?)
                                            .map { |k| Keg.new(k.resolved_path) }
end

.print_upgrade_message(formula, fi_options) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Parameters:



157
158
159
160
161
162
163
164
165
 
# File 'upgrade.rb', line 157

def print_upgrade_message(formula, fi_options)
  version_upgrade = if formula.optlinked?
    "#{Keg.new(formula.opt_prefix).version} -> #{formula.pkg_version}"
  else
    "-> #{formula.pkg_version}"
  end
  oh1 "Upgrading #{Formatter.identifier(formula.full_specified_name)}"
  puts "  #{version_upgrade} #{fi_options.to_a.join(" ")}"
end

.upgrade_dependents(deps, formulae, flags:, dry_run: false, installed_on_request: false, force_bottle: false, build_from_source_formulae: [], interactive: false, keep_tmp: false, debug_symbols: false, force: false, debug: false, quiet: false, verbose: false) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Parameters:

  • deps (Dependents)
  • formulae (Array<Formula>)
  • flags (Array<String>)
  • dry_run (Boolean) (defaults to: false)
  • installed_on_request (Boolean) (defaults to: false)
  • force_bottle (Boolean) (defaults to: false)
  • build_from_source_formulae (Array<String>) (defaults to: [])
  • interactive (Boolean) (defaults to: false)
  • keep_tmp (Boolean) (defaults to: false)
  • debug_symbols (Boolean) (defaults to: false)
  • force (Boolean) (defaults to: false)
  • debug (Boolean) (defaults to: false)
  • quiet (Boolean) (defaults to: false)
  • verbose (Boolean) (defaults to: false) 


232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'upgrade.rb', line 232

def upgrade_dependents(deps, formulae,
                       flags:,
                       dry_run: false,
                       installed_on_request: false,
                       force_bottle: false,
                       build_from_source_formulae: [],
                       interactive: false,
                       keep_tmp: false,
                       debug_symbols: false,
                       force: false,
                       debug: false,
                       quiet: false,
                       verbose: false)
  return if deps.blank?

  upgradeable = deps.upgradeable
  pinned      = deps.pinned
  skipped     = deps.skipped
  if pinned.present?
    plural = Utils.pluralize("dependent", pinned.count)
    opoo "Not upgrading #{pinned.count} pinned #{plural}:"
    puts(pinned.map do |f|
      "#{f.full_specified_name} #{f.pkg_version}"
    end.join(", "))
  end
  if skipped.present?
    opoo <<~EOS
      The following dependents of upgraded formulae are outdated but will not
      be upgraded because they are not bottled:
        #{skipped * "\n  "}
    EOS
  end

  upgradeable.reject! { |f| FormulaInstaller.installed.include?(f) }

  # Print the upgradable dependents.
  if upgradeable.present?
    installed_formulae = (dry_run ? formulae : FormulaInstaller.installed.to_a).dup
    formula_plural = Utils.pluralize("formula", installed_formulae.count)
    upgrade_verb = dry_run ? "Would upgrade" : "Upgrading"
    ohai "#{upgrade_verb} #{Utils.pluralize("dependent", upgradeable.count,
                                            include_count: true)} of upgraded #{formula_plural}:"
    puts_no_installed_dependents_check_disable_message_if_not_already!
    formulae_upgrades = upgradeable.map do |f|
      name = f.full_specified_name
      if f.optlinked?
        "#{name} #{Keg.new(f.opt_prefix).version} -> #{f.pkg_version}"
      else
        "#{name} #{f.pkg_version}"
      end
    end
    puts formulae_upgrades.join(", ")
  end

  return if upgradeable.blank?

  unless dry_run
    dependent_installers = formula_installers(
      upgradeable,
      flags:,
      force_bottle:,
      build_from_source_formulae:,
      dependents:                 true,
      interactive:,
      keep_tmp:,
      debug_symbols:,
      force:,
      debug:,
      quiet:,
      verbose:,
    )
    upgrade_formulae(dependent_installers, dry_run:, verbose:)
  end

  # Update non-core installed formulae for linkage checks after upgrading
  # Don't need to check core formulae because we do so at CI time.
  installed_non_core_formulae = FormulaInstaller.installed.to_a.reject(&:core_formula?)
  return if installed_non_core_formulae.blank?

  # Assess the dependents tree again now we've upgraded.
  unless dry_run
    oh1 "Checking for dependents of upgraded formulae..."
    puts_no_installed_dependents_check_disable_message_if_not_already!
  end

  broken_dependents = check_broken_dependents(installed_non_core_formulae)
  if broken_dependents.blank?
    if dry_run
      ohai "No currently broken dependents found!"
      opoo "If they are broken by the upgrade they will also be upgraded or reinstalled."
    else
      ohai "No broken dependents found!"
    end
    return
  end

  reinstallable_broken_dependents =
    broken_dependents.reject(&:outdated?)
                     .reject(&:pinned?)
                     .sort { |a, b| depends_on(a, b) }
  outdated_pinned_broken_dependents =
    broken_dependents.select(&:outdated?)
                     .select(&:pinned?)
                     .sort { |a, b| depends_on(a, b) }

  # Print the pinned dependents.
  if outdated_pinned_broken_dependents.present?
    count = outdated_pinned_broken_dependents.count
    plural = Utils.pluralize("dependent", outdated_pinned_broken_dependents.count)
    onoe "Not reinstalling #{count} broken and outdated, but pinned #{plural}:"
    $stderr.puts(outdated_pinned_broken_dependents.map do |f|
      "#{f.full_specified_name} #{f.pkg_version}"
    end.join(", "))
  end

  # Print the broken dependents.
  if reinstallable_broken_dependents.blank?
    ohai "No broken dependents to reinstall!"
  else
    ohai "Reinstalling #{Utils.pluralize("dependent", reinstallable_broken_dependents.count,
                                         include_count: true)} with broken linkage from source:"
    puts_no_installed_dependents_check_disable_message_if_not_already!
    puts reinstallable_broken_dependents.map(&:full_specified_name)
                                        .join(", ")
  end

  return if dry_run

  reinstall_contexts = reinstallable_broken_dependents.map do |formula|
    Reinstall.build_install_context(
      formula,
      flags:,
      force_bottle:,
      build_from_source_formulae: build_from_source_formulae + [formula.full_name],
      interactive:,
      keep_tmp:,
      debug_symbols:,
      force:,
      debug:,
      quiet:,
      verbose:,
    )
  end

  valid_formula_installers = Install.fetch_formulae(reinstall_contexts.map(&:formula_installer))

  reinstall_contexts.each do |reinstall_context|
    next unless valid_formula_installers.include?(reinstall_context.formula_installer)

    Reinstall.reinstall_formula(reinstall_context)
  rescue FormulaInstallationAlreadyAttemptedError
    # We already attempted to reinstall f as part of the dependency tree of
    # another formula. In that case, don't generate an error, just move on.
    nil
  rescue CannotInstallFormulaError, DownloadError => e
    ofail e
  rescue BuildError => e
    e.dump(verbose:)
    puts
    Homebrew.failed = true
  end
end

.upgrade_formulae(formula_installers, dry_run: false, verbose: false, fetch: true) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Parameters:

  • formula_installers (Array<FormulaInstaller>)
  • dry_run (Boolean) (defaults to: false)
  • verbose (Boolean) (defaults to: false)
  • fetch (Boolean) (defaults to: true) 


136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'upgrade.rb', line 136

def upgrade_formulae(formula_installers, dry_run: false, verbose: false, fetch: true)
  valid_formula_installers = if dry_run || !fetch
    formula_installers
  else
    Install.fetch_formulae(formula_installers)
  end

  valid_formula_installers.each do |fi|
    upgrade_formula(fi, dry_run:, verbose:)
    Cleanup.install_formula_clean!(fi.formula, dry_run:)
  end
end