Remove the short-name content-addressed gem after a wide-named identical gem has been installed

Author: OughtPuts

lib/bundler/rubygems_gem_installer.rb

@@ -68,6 +68,10 @@ def install
 
       run_post_install_hooks
 
+      if Gem::ContentAddress.widened?(spec.content_address)
+        remove_stale_matching_gems
+      end
+
       spec
     end
 

lib/rubygems/content_address.rb

@@ -34,6 +34,13 @@ def self.match?(value)
     value.is_a?(String) && PATTERN.match?(value)
   end
 
+  ##
+  # Whether +value+ is a valid content address longer than the default.
+
+  def self.widened?(value)
+    match?(value) && value.length > DEFAULT_LENGTH
+  end
+
   ##
   # Whether +value+ is a well-formed Ruby ABI ("X.Y").
 

lib/rubygems/installer.rb

@@ -11,6 +11,7 @@
 require_relative "package"
 require_relative "ext"
 require_relative "user_interaction"
+require_relative "uninstaller"
 
 ##
 # The installer installs the files contained in the .gem into the Gem.home.
@@ -318,6 +319,10 @@ def install
 
     run_post_install_hooks
 
+    if Gem::ContentAddress.widened?(spec.content_address)
+      remove_stale_matching_gems
+    end
+
     spec
   rescue Errno::EACCES => e
     # Permission denied - /path/to/foo
@@ -1000,6 +1005,41 @@ def incompatible_abi_install?
     Gem::ContentAddress.content_addressed?(spec) && spec.ruby_abi != Gem.ruby_abi
   end
 
+  def remove_stale_matching_gems
+    require "digest"
+    incoming_sha = Digest::SHA256.file(gem).hexdigest
+
+    canonical_gem_home = File.exist?(gem_home) ? File.realpath(gem_home) : gem_home
+
+    spec_dirs = [
+      File.join(canonical_gem_home, "specifications"),
+      Gem::SpecificationRecord.specification_dir_for(spec, canonical_gem_home),
+    ].uniq
+
+    cleanup_specs = spec_dirs.flat_map do |dir|
+      Gem::Util.glob_files_in_dir("*.gemspec", dir).filter_map do |path|
+        Gem::Specification.load(path)
+      end
+    end
+
+    cleanup_specs.each do |installed_spec|
+      next unless installed_spec.name == spec.name
+      next unless installed_spec.version == spec.version
+      next unless installed_spec.platform == spec.platform
+      next unless installed_spec.ruby_abi == spec.ruby_abi
+      next unless installed_spec.content_address&.length == Gem::ContentAddress::DEFAULT_LENGTH
+      next unless spec.content_address.start_with?(installed_spec.content_address)
+      next unless File.exist?(installed_spec.cache_file)
+      installed_sha = Digest::SHA256.file(installed_spec.cache_file).hexdigest
+      next unless installed_sha == incoming_sha
+
+      uninstaller = Gem::Uninstaller.new(nil, install_dir: canonical_gem_home)
+      uninstaller.remove(installed_spec)
+      FileUtils.rm_f installed_spec.build_info_file
+      Gem::Specification.remove_spec(installed_spec) unless @install_dir
+    end
+  end
+
   def assign_content_address
     address = @package.content_address
     expected = options[:content_address]

spec/install/gemfile/content_addressable_spec.rb

@@ -80,7 +80,7 @@
       short_cache = Dir[default_bundle_path("cache", "mygem-1.0-*.gem").to_s].first
       short_address = File.basename(short_cache, ".gem").rpartition("-").last
       short_gem_dir = default_bundle_path("gems", "mygem-1.0-#{short_address}")
-      short_gemspec = default_bundle_path("specifications", "mygem-1.0-#{short_address}.gemspec")
+      short_gemspec = default_bundle_path("specifications", current_abi, "mygem-1.0-#{short_address}.gemspec")
 
       expect(short_gem_dir).to exist
       expect(short_gemspec).to exist
@@ -101,7 +101,7 @@
       bundle "install --redownload", artifice: "compact_index_v2", env: { "BUNDLER_SPEC_GEM_REPO" => gem_repo2.to_s }
 
       expect(default_bundle_path("gems", "mygem-1.0-#{widened_address}")).to exist
-      expect(default_bundle_path("specifications", "mygem-1.0-#{widened_address}.gemspec")).to exist
+      expect(default_bundle_path("specifications", current_abi, "mygem-1.0-#{widened_address}.gemspec")).to exist
       expect(default_bundle_path("cache", "mygem-1.0-#{widened_address}.gem")).to exist
       expect(short_gem_dir).not_to exist
       expect(short_gemspec).not_to exist
@@ -147,7 +147,7 @@
 
       expect(lockfile).to include("mygem (1.0-x86_64-linux) #{widened_address}")
       expect(default_bundle_path("gems", "mygem-1.0-#{widened_address}")).to exist
-      expect(default_bundle_path("specifications", "mygem-1.0-#{widened_address}.gemspec")).to exist
+      expect(default_bundle_path("specifications", current_abi, "mygem-1.0-#{widened_address}.gemspec")).to exist
       expect(default_bundle_path("cache", "mygem-1.0-#{widened_address}.gem")).to exist
       expect(lockfile).not_to match(/mygem \(1\.0-x86_64-linux\) #{short_address}\s/)
     end

test/rubygems/test_gem_content_address.rb

@@ -26,6 +26,13 @@ def test_match_rejects_uppercase
     refute Gem::ContentAddress.match?("ABCDEF12")
   end
 
+  def test_widened
+    refute Gem::ContentAddress.widened?("a" * 8)
+    assert Gem::ContentAddress.widened?("a" * 9)
+    refute Gem::ContentAddress.widened?(nil)
+    refute Gem::ContentAddress.widened?("not-an-address")
+  end
+
   def test_valid_ruby_abi
     assert Gem::ContentAddress.valid_ruby_abi?("3.4")
     assert Gem::ContentAddress.valid_ruby_abi?("10.0")

test/rubygems/test_gem_installer.rb

@@ -1391,6 +1391,141 @@ def test_reinstalling_content_addressed_gem_is_idempotent
     assert_equal 1, Dir[File.join(@gemhome, "specifications", "3.4", "a-2*.gemspec")].size
   end
 
+  def test_reinstalling_a_content_addressed_gem_with_a_widened_sha_removes_the_old_gem
+    install_home = @gemhome
+
+    # Exercise cleanup through a symlinked gem home when supported.
+    if symlink_supported?
+      install_home = File.join(@tempdir, "symlinked_gemhome")
+      FileUtils.ln_s(@gemhome, install_home)
+    end
+
+    source_spec, a_gem = util_gem("a", 2) do |spec|
+      spec.required_ruby_version = "~> 3.4.0"
+      spec.platform = "x86_64-linux"
+    end
+    FileUtils.rm_rf source_spec.gem_dir
+
+    digest = Digest::SHA256.file(a_gem).hexdigest
+    address = digest[0, 8]
+    dir = File.dirname(a_gem)
+    filename = File.join(dir, "a-2-#{address}.gem")
+    FileUtils.cp a_gem, filename
+    installer = Gem::Installer.at filename, install_dir: install_home, force: true
+
+    # Make the short installation create a build info file
+    # To later ensure they are also removed
+    installer.build_args = ["--example"]
+    short_spec = installer.install
+    short_build_info_file = short_spec.build_info_file
+    assert_path_exist short_build_info_file
+
+    short_extension_dir = short_spec.extension_dir
+    FileUtils.mkdir_p short_extension_dir
+    assert_path_exist short_extension_dir
+
+    widened_address = digest[0, 12]
+    widened_filename = File.join(dir, "a-2-#{widened_address}.gem")
+    FileUtils.cp a_gem, widened_filename
+    installer2 = Gem::Installer.at widened_filename, install_dir: install_home, force: true
+    spec2 = installer2.install
+
+    assert_path_not_exist short_extension_dir
+    assert_equal "a-2-#{widened_address}", spec2.full_name
+    assert_path_exist File.join(@gemhome, "gems", "a-2-#{widened_address}")
+    assert_path_exist File.join(@gemhome, "specifications", "3.4", "a-2-#{widened_address}.gemspec")
+    assert_equal 1, Dir[File.join(@gemhome, "gems", "a-2*")].size
+    assert_equal 1, Dir[File.join(@gemhome, "specifications", "3.4", "a-2*.gemspec")].size
+    assert_path_not_exist short_build_info_file
+  end
+
+  def test_reinstalling_with_a_widened_sha_removes_the_old_specification_from_the_record
+    source_spec, a_gem = util_gem("a", 2) do |spec|
+      spec.required_ruby_version = "~> #{Gem.ruby_abi}.0"
+      spec.platform = Gem::Platform.local
+    end
+    FileUtils.rm_rf source_spec.gem_dir
+
+    digest = Digest::SHA256.file(a_gem).hexdigest
+    address = digest[0, 8]
+    dir = File.dirname(a_gem)
+    filename = File.join(dir, "a-2-#{address}.gem")
+    FileUtils.cp a_gem, filename
+    short_spec = Gem::Installer.at(filename, force: true).install
+
+    assert_includes Gem::Specification.stubs.map(&:full_name), short_spec.full_name
+
+    widened_address = digest[0, 12]
+    widened_filename = File.join(dir, "a-2-#{widened_address}.gem")
+    FileUtils.cp a_gem, widened_filename
+    widened_spec = Gem::Installer.at(widened_filename, force: true).install
+
+    refute_includes Gem::Specification.stubs.map(&:full_name), short_spec.full_name
+    assert_includes Gem::Specification.stubs.map(&:full_name), widened_spec.full_name
+  end
+
+  def test_installing_widened_gem_does_not_remove_short_gem_when_checksums_differ
+    source_spec, a_gem = util_gem("a", 2) do |spec|
+      spec.required_ruby_version = "~> 3.4.0"
+      spec.platform = "x86_64-linux"
+    end
+    FileUtils.rm_rf source_spec.gem_dir
+
+    digest = Digest::SHA256.file(a_gem).hexdigest
+    address = digest[0, 8]
+    dir = File.dirname(a_gem)
+    filename = File.join(dir, "a-2-#{address}.gem")
+    FileUtils.cp a_gem, filename
+    installer = Gem::Installer.at filename, install_dir: @gemhome, force: true
+    short_spec = installer.install
+    File.binwrite(short_spec.cache_file, "different gem contents")
+
+    widened_address = digest[0, 12]
+    widened_filename = File.join(dir, "a-2-#{widened_address}.gem")
+    FileUtils.cp a_gem, widened_filename
+    installer2 = Gem::Installer.at widened_filename, install_dir: @gemhome, force: true
+    spec2 = installer2.install
+
+    assert_path_exist File.join(@gemhome, "gems", "a-2-#{address}")
+    assert_path_exist short_spec.spec_file
+    assert_equal "a-2-#{widened_address}", spec2.full_name
+    assert_path_exist File.join(@gemhome, "gems", "a-2-#{widened_address}")
+    assert_path_exist spec2.spec_file
+    assert_equal 2, Dir[File.join(@gemhome, "gems", "a-2*")].size
+    assert_equal 2, Dir[File.join(File.dirname(spec2.spec_file), "a-2*.gemspec")].size
+    assert_path_exist short_spec.cache_file
+  end
+
+  def test_failed_widened_install_does_not_remove_existing_short_gem
+    source_spec, a_gem = util_gem("a", 2) do |spec|
+      spec.required_ruby_version = "~> 3.4.0"
+      spec.platform = "x86_64-linux"
+    end
+    FileUtils.rm_rf source_spec.gem_dir
+
+    digest = Digest::SHA256.file(a_gem).hexdigest
+    address = digest[0, 8]
+    dir = File.dirname(a_gem)
+    filename = File.join(dir, "a-2-#{address}.gem")
+    FileUtils.cp a_gem, filename
+    short_spec = Gem::Installer.at(filename, install_dir: @gemhome, force: true).install
+
+    widened_address = digest[0, 12]
+    widened_filename = File.join(dir, "a-2-#{widened_address}.gem")
+    FileUtils.cp a_gem, widened_filename
+    widened_installer = Gem::Installer.at widened_filename, install_dir: @gemhome, force: true
+
+    Gem.pre_install { false }
+
+    assert_raise Gem::InstallError do
+      widened_installer.install
+    end
+
+    assert_path_exist short_spec.full_gem_path
+    assert_path_exist short_spec.spec_file
+    assert_path_exist short_spec.cache_file
+  end
+
   def test_install_assigns_content_address_from_filename_with_full_sha
     _, a_gem = util_gem("a", 2) do |spec|
       spec.required_ruby_version = "~> 3.4.0"