Class: Migrator Private

Inherits:
Object
  • Object
show all
Extended by:
T::Sig
Includes:
Context
Defined in:
migrator.rb

Overview

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

Helper class for migrating a formula from an old to a new name.

Defined Under Namespace

Classes: MigrationNeededError, MigratorDifferentTapsError, MigratorNoOldnameError, MigratorNoOldpathError

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Context

current, current=, #debug?, #quiet?, #verbose?, #with_context

Constructor Details

#initialize(formula, force: false) ⇒ Migrator

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.

Returns a new instance of Migrator.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
# File 'migrator.rb', line 124

def initialize(formula, force: false)
  @oldname = formula.oldname
  @newname = formula.name
  raise MigratorNoOldnameError, formula unless oldname

  @formula = formula
  @old_cellar = HOMEBREW_CELLAR/formula.oldname
  raise MigratorNoOldpathError, formula unless old_cellar.exist?

  @old_tabs = old_cellar.subdirs.map { |d| Tab.for_keg(Keg.new(d)) }
  @old_tap = old_tabs.first.tap

  raise MigratorDifferentTapsError.new(formula, old_tap) if !force && !from_same_tap_user?

  @new_cellar = HOMEBREW_CELLAR/formula.name
  @new_cellar_existed = @new_cellar.exist?

  if (@old_linked_keg = linked_old_linked_keg)
    @old_linked_keg_record = old_linked_keg.linked_keg_record if old_linked_keg.linked?
    @old_opt_record = old_linked_keg.opt_record if old_linked_keg.optlinked?
    @new_linked_keg_record = HOMEBREW_CELLAR/"#{newname}/#{File.basename(old_linked_keg)}"
  end

  @old_pin_record = HOMEBREW_PINNED_KEGS/oldname
  @new_pin_record = HOMEBREW_PINNED_KEGS/newname
  @pinned = old_pin_record.symlink?
  @old_pin_link_record = old_pin_record.readlink if @pinned
end

Instance Attribute Details

#formulaObject (readonly)

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.

Instance of renamed formula.



58
59
60
# File 'migrator.rb', line 58

def formula
  @formula
end

#new_cellarObject (readonly)

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.

Path to newname cellar according to new name.



91
92
93
# File 'migrator.rb', line 91

def new_cellar
  @new_cellar
end

#new_cellar_existedObject (readonly)

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.

True if new cellar existed at initialization time.



94
95
96
# File 'migrator.rb', line 94

def new_cellar_existed
  @new_cellar_existed
end

#new_linked_keg_recordObject (readonly)

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.

Path to newname keg that will be linked if old_linked_keg isn’t nil.



100
101
102
# File 'migrator.rb', line 100

def new_linked_keg_record
  @new_linked_keg_record
end

#new_pin_recordObject (readonly)

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.

Path to newname pin.



97
98
99
# File 'migrator.rb', line 97

def new_pin_record
  @new_pin_record
end

#newnameObject (readonly)

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.

New name of the formula.



88
89
90
# File 'migrator.rb', line 88

def newname
  @newname
end

#old_cellarObject (readonly)

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.

Path to oldname’s cellar.



64
65
66
# File 'migrator.rb', line 64

def old_cellar
  @old_cellar
end

#old_linked_kegObject (readonly)

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.

Oldname linked keg.



73
74
75
# File 'migrator.rb', line 73

def old_linked_keg
  @old_linked_keg
end

#old_linked_keg_recordObject (readonly)

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.

Path to oldname’s linked keg.



76
77
78
# File 'migrator.rb', line 76

def old_linked_keg_record
  @old_linked_keg_record
end

#old_opt_recordObject (readonly)

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.

Path to oldname opt.



70
71
72
# File 'migrator.rb', line 70

def old_opt_record
  @old_opt_record
end

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.

Resolved path to oldname pin.



85
86
87
# File 'migrator.rb', line 85

def old_pin_link_record
  @old_pin_link_record
end

#old_pin_recordObject (readonly)

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.

Path to oldname pin.



67
68
69
# File 'migrator.rb', line 67

def old_pin_record
  @old_pin_record
end

#old_tabsObject (readonly)

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.

Tabs from oldname kegs.



79
80
81
# File 'migrator.rb', line 79

def old_tabs
  @old_tabs
end

#old_tapObject (readonly)

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.

Tap of the old name.



82
83
84
# File 'migrator.rb', line 82

def old_tap
  @old_tap
end

#oldnameObject (readonly)

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.

Old name of the formula.



61
62
63
# File 'migrator.rb', line 61

def oldname
  @oldname
end

Class Method Details

.migrate_if_needed(formula, force:) ⇒ Object

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.



113
114
115
116
117
118
119
120
121
122
# File 'migrator.rb', line 113

def self.migrate_if_needed(formula, force:)
  return unless Migrator.needs_migration?(formula)

  begin
    migrator = Migrator.new(formula, force: force)
    migrator.migrate
  rescue => e
    onoe e
  end
end

.needs_migration?(formula) ⇒ Boolean

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.

Returns:

  • (Boolean)


102
103
104
105
106
107
108
109
110
111
# File 'migrator.rb', line 102

def self.needs_migration?(formula)
  oldname = formula.oldname
  return false unless oldname

  oldname_rack = HOMEBREW_CELLAR/oldname
  return false if oldname_rack.symlink?
  return false unless oldname_rack.directory?

  true
end

Instance Method Details

#backup_old_tabsObject

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.



428
429
430
# File 'migrator.rb', line 428

def backup_old_tabs
  old_tabs.each(&:write)
end

#backup_oldnameObject

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.

Backup everything if errors occur while migrating.



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
# File 'migrator.rb', line 384

def backup_oldname
  unlink_oldname_opt
  unlink_oldname_cellar
  backup_oldname_cellar
  backup_old_tabs

  if pinned? && !old_pin_record.symlink?
    src_oldname = (old_pin_record.dirname/old_pin_link_record).expand_path
    old_pin_record.make_relative_symlink(src_oldname)
    new_pin_record.delete
  end

  if new_cellar.exist?
    new_cellar.subdirs.each do |d|
      newname_keg = Keg.new(d)
      newname_keg.unlink(verbose: verbose?)
      newname_keg.uninstall if new_cellar_existed
    end
  end

  return if old_linked_keg.nil?

  # The keg used to be linked and when we backup everything we restore
  # Cellar/oldname, the target also gets restored, so we are able to
  # create a keg using its old path
  if old_linked_keg_record
    begin
      old_linked_keg.link(verbose: verbose?)
    rescue Keg::LinkError
      old_linked_keg.unlink(verbose: verbose?)
      raise
    rescue Keg::AlreadyLinkedError
      old_linked_keg.unlink(verbose: verbose?)
      retry
    end
  else
    old_linked_keg.optlink(verbose: verbose?)
  end
end

#backup_oldname_cellarObject

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.



424
425
426
# File 'migrator.rb', line 424

def backup_oldname_cellar
  FileUtils.mv(new_cellar, old_cellar) unless old_cellar.exist?
end

#fix_tabsObject

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.

Fix INSTALL_RECEIPTs for tap-migrated formula.



154
155
156
157
158
159
# File 'migrator.rb', line 154

def fix_tabs
  old_tabs.each do |tab|
    tab.tap = formula.tap
    tab.write
  end
end

#from_same_tap_user?Boolean

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.

Returns:

  • (Boolean)


162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
# File 'migrator.rb', line 162

def from_same_tap_user?
  formula_tap_user = formula.tap.user if formula.tap
  old_tap_user = nil

  new_tap = if old_tap
    old_tap_user, = old_tap.user
    if (migrate_tap = old_tap.tap_migrations[formula.oldname])
      new_tap_user, new_tap_repo = migrate_tap.split("/")
      "#{new_tap_user}/#{new_tap_repo}"
    end
  end

  if formula_tap_user == old_tap_user
    true
  # Homebrew didn't use to update tabs while performing tap-migrations,
  # so there can be `INSTALL_RECEIPT`s containing wrong information about tap,
  # so we check if there is an entry about oldname migrated to tap and if
  # newname's tap is the same as tap to which oldname migrated, then we
  # can perform migrations and the taps for oldname and newname are the same.
  elsif formula.tap && old_tap && formula.tap == new_tap
    fix_tabs
    true
  else
    false
  end
end

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.



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
# File 'migrator.rb', line 296

def link_newname
  oh1 "Relinking #{Formatter.identifier(newname)}"
  new_keg = Keg.new(new_linked_keg_record)

  # If old_keg wasn't linked then we just optlink a keg.
  # If old keg wasn't optlinked and linked, we don't call this method at all.
  # If formula is keg-only we also optlink it.
  if formula.keg_only? || !old_linked_keg_record
    begin
      new_keg.optlink(verbose: verbose?)
    rescue Keg::LinkError => e
      onoe "Failed to create #{formula.opt_prefix}"
      raise
    end
    return
  end

  new_keg.remove_linked_keg_record if new_keg.linked?

  begin
    new_keg.link(overwrite: true, verbose: verbose?)
  rescue Keg::ConflictError => e
    onoe "The `brew link` step did not complete successfully."
    puts e
    puts
    puts "Possible conflicting files are:"
    new_keg.link(dry_run: true, overwrite: true, verbose: verbose?)
    raise
  rescue Keg::LinkError => e
    onoe "The `brew link` step did not complete successfully."
    puts e
    puts
    puts "You can try again using:"
    puts "  brew link #{formula.name}"
  rescue Exception => e # rubocop:disable Lint/RescueException
    onoe "An unexpected error occurred during linking"
    puts e
    puts e.backtrace if debug?
    ignore_interrupts { new_keg.unlink(verbose: verbose?) }
    raise
  end
end

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.

Remove Cellar/oldname if it exists.



370
371
372
373
# File 'migrator.rb', line 370

def link_oldname_cellar
  old_cellar.delete if old_cellar.symlink? || old_cellar.exist?
  old_cellar.make_relative_symlink(formula.rack)
end

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.

Link keg to opt if it was linked before migrating.



340
341
342
343
344
345
# File 'migrator.rb', line 340

def link_oldname_opt
  return unless old_opt_record

  old_opt_record.delete if old_opt_record.symlink?
  old_opt_record.make_relative_symlink(new_linked_keg_record)
end

#linked_old_linked_kegObject

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.



189
190
191
192
193
194
195
# File 'migrator.rb', line 189

def linked_old_linked_keg
  keg_dirs = []
  keg_dirs += new_cellar.subdirs if new_cellar.exist?
  keg_dirs += old_cellar.subdirs
  kegs = keg_dirs.map { |d| Keg.new(d) }
  kegs.find(&:linked?) || kegs.find(&:optlinked?)
end

#lockObject

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.



432
433
434
435
436
437
# File 'migrator.rb', line 432

def lock
  @newname_lock = FormulaLock.new newname
  @oldname_lock = FormulaLock.new oldname
  @newname_lock.lock
  @oldname_lock.lock
end

#migrateObject

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.



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
# File 'migrator.rb', line 201

def migrate
  oh1 "Processing #{Formatter.identifier(oldname)} formula rename to #{Formatter.identifier(newname)}"
  lock
  unlink_oldname
  unlink_newname if new_cellar.exist?
  repin
  move_to_new_directory
  link_oldname_cellar
  link_oldname_opt
  link_newname unless old_linked_keg.nil?
  update_tabs
  return unless formula.outdated?

  opoo <<~EOS
    #{Formatter.identifier(newname)} is outdated!
    To avoid broken installations, as soon as possible please run:
      brew upgrade
    Or, if you're OK with a less reliable fix:
      brew upgrade #{newname}
  EOS
rescue Interrupt
  ignore_interrupts { backup_oldname }
rescue Exception => e # rubocop:disable Lint/RescueException
  onoe "The migration did not complete successfully."
  puts e
  puts e.backtrace if debug?
  puts "Backing up..."
  ignore_interrupts { backup_oldname }
ensure
  unlock
end

#move_to_new_directoryObject

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.

Move everything from Cellar/oldname to Cellar/newname.



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
# File 'migrator.rb', line 234

def move_to_new_directory
  return unless old_cellar.exist?

  if new_cellar.exist?
    conflicted = T.let(false, T::Boolean)
    old_cellar.each_child do |c|
      next unless (new_cellar/c.basename).exist?

      begin
        FileUtils.rm_rf c
      rescue Errno::EACCES
        conflicted = true
        onoe "#{new_cellar/c.basename} already exists."
      end
    end

    odie "Remove #{new_cellar} manually and run `brew migrate #{oldname}`." if conflicted
  end

  oh1 "Moving #{Formatter.identifier(oldname)} versions to #{new_cellar}"
  if new_cellar.exist?
    FileUtils.mv(old_cellar.children, new_cellar)
  else
    FileUtils.mv(old_cellar, new_cellar)
  end
end

#pinned?Boolean

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.

Returns:

  • (Boolean)


197
198
199
# File 'migrator.rb', line 197

def pinned?
  @pinned
end

#repinObject

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.



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
# File 'migrator.rb', line 261

def repin
  return unless pinned?

  # old_pin_record is a relative symlink and when we try to to read it
  # from <dir> we actually try to find file
  # <dir>/../<...>/../Cellar/name/version.
  # To repin formula we need to update the link thus that it points to
  # the right directory.
  # NOTE: old_pin_record.realpath.sub(oldname, newname) is unacceptable
  # here, because it resolves every symlink for old_pin_record and then
  # substitutes oldname with newname. It breaks things like
  # Pathname#make_relative_symlink, where Pathname#relative_path_from
  # is used to find relative path from source to destination parent and
  # it assumes no symlinks.
  src_oldname = (old_pin_record.dirname/old_pin_link_record).expand_path
  new_pin_record.make_relative_symlink(src_oldname.sub(oldname, newname))
  old_pin_record.delete
end

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.



288
289
290
291
292
293
294
# File 'migrator.rb', line 288

def unlink_newname
  oh1 "Temporarily unlinking #{Formatter.identifier(newname)}"
  new_cellar.subdirs.each do |d|
    keg = Keg.new(d)
    keg.unlink(verbose: verbose?)
  end
end

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.



280
281
282
283
284
285
286
# File 'migrator.rb', line 280

def unlink_oldname
  oh1 "Unlinking #{Formatter.identifier(oldname)}"
  old_cellar.subdirs.each do |d|
    keg = Keg.new(d)
    keg.unlink(verbose: verbose?)
  end
end

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.

Remove Cellar/oldname link if it belongs to newname.



376
377
378
379
380
381
# File 'migrator.rb', line 376

def unlink_oldname_cellar
  if (old_cellar.symlink? && !old_cellar.exist?) || (old_cellar.symlink? \
        && formula.rack.exist? && formula.rack.realpath == old_cellar.realpath)
    old_cellar.unlink
  end
end

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.

Remove opt/oldname link if it belongs to newname.



358
359
360
361
362
363
364
365
366
367
# File 'migrator.rb', line 358

def unlink_oldname_opt
  return unless old_opt_record

  if old_opt_record.symlink? && old_opt_record.exist? \
      && new_linked_keg_record.exist? \
      && new_linked_keg_record.realpath == old_opt_record.realpath
    old_opt_record.unlink
    old_opt_record.parent.rmdir_if_possible
  end
end

#unlockObject

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.



439
440
441
442
# File 'migrator.rb', line 439

def unlock
  @newname_lock.unlock
  @oldname_lock.unlock
end

#update_tabsObject

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.

After migration every INSTALL_RECEIPT.json has the wrong path to the formula so we must update INSTALL_RECEIPTs.



349
350
351
352
353
354
355
# File 'migrator.rb', line 349

def update_tabs
  new_tabs = new_cellar.subdirs.map { |d| Tab.for_keg(Keg.new(d)) }
  new_tabs.each do |tab|
    tab.source["path"] = formula.path.to_s if tab.source["path"]
    tab.write
  end
end