Give better error when previous installation folder is insecure to remove #7030

deivid-rodriguez · 2023-10-03T12:48:10Z

What was the end-user or developer problem that led to this PR?

In #6460, user was getting a Bundler error due to the previous gem installation folder having insecure permissions.

However, and even if we've lately improved the message, it's still too verbose and real culprit is a bit hidden.

What is your fix for the problem, implemented in this PR?

This error is about insecure permissions of the parent install folder for a gem, so it's independent of the particular gem that it's being uninstalled. Hence, even if you're running 8 installation jobs in parallel, the error should be displayed just once.

So my fix is to create a special error class for this that goes straight to the user, instead of being reported once per installation job.

Before

$ bundle install --force --jobs 2
[DEPRECATED] The `--force` option has been renamed to `--redownload`
Fetching gem metadata from https://rubygems.org/.......
Installing minitest 5.20.0
Installing concurrent-ruby 1.2.2
Installing zeitwerk 2.6.12
Installing public_suffix 5.0.3
Installing did_you_mean 1.6.3
Installing bindata 2.4.15
Installing plist 3.7.0
Installing ruby-macho 4.0.0
Installing sorbet-runtime 0.5.10461
Installing warning 1.3.0
Bundler::DirectoryRemovalError: Could not delete previous installation of `/Users/deivid/Code/playground/world-writable/vendor/bundle/ruby/2.6.0/gems/concurrent-ruby-1.2.2`.
The underlying error was ArgumentError: parent directory is world writable, Bundler::FileUtils#remove_entry_secure does not work; abort:
"/Users/deivid/Code/playground/world-writable/vendor/bundle/ruby/2.6.0/gems/concurrent-ruby-1.2.2" (parent directory mode 40777), with backtrace:
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/vendor/fileutils/lib/fileutils.rb:1387:in `remove_entry_secure'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler.rb:332:in `rm_rf'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/rubygems_gem_installer.rb:111:in `strict_rm_rf'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/rubygems_gem_installer.rb:19:in `install'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/source/rubygems.rb:203:in `install'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/installer/gem_installer.rb:54:in `install'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/installer/gem_installer.rb:16:in `install_from_spec'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/installer/parallel_installer.rb:156:in `do_install'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/installer/parallel_installer.rb:147:in `block in worker_pool'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/worker.rb:62:in `apply_func'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/worker.rb:57:in `block in process_queue'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/worker.rb:54:in `loop'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/worker.rb:54:in `process_queue'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/worker.rb:90:in `block (2 levels) in create_threads'

Bundler Error Backtrace:
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/rubygems_gem_installer.rb:115:in `rescue in strict_rm_rf'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/rubygems_gem_installer.rb:110:in `strict_rm_rf'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/rubygems_gem_installer.rb:19:in `install'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/source/rubygems.rb:203:in `install'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/installer/gem_installer.rb:54:in `install'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/installer/gem_installer.rb:16:in `install_from_spec'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/installer/parallel_installer.rb:156:in `do_install'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/installer/parallel_installer.rb:147:in `block in worker_pool'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/worker.rb:62:in `apply_func'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/worker.rb:57:in `block in process_queue'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/worker.rb:54:in `loop'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/worker.rb:54:in `process_queue'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/worker.rb:90:in `block (2 levels) in create_threads'

An error occurred while installing concurrent-ruby (1.2.2), and Bundler cannot continue.

In Gemfile:
  activesupport was resolved to 6.1.7.6, which depends on
    i18n was resolved to 1.14.1, which depends on
      concurrent-ruby


Bundler::DirectoryRemovalError: Could not delete previous installation of `/Users/deivid/Code/playground/world-writable/vendor/bundle/ruby/2.6.0/gems/minitest-5.20.0`.
The underlying error was ArgumentError: parent directory is world writable, Bundler::FileUtils#remove_entry_secure does not work; abort:
"/Users/deivid/Code/playground/world-writable/vendor/bundle/ruby/2.6.0/gems/minitest-5.20.0" (parent directory mode 40777), with backtrace:
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/vendor/fileutils/lib/fileutils.rb:1387:in `remove_entry_secure'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler.rb:332:in `rm_rf'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/rubygems_gem_installer.rb:111:in `strict_rm_rf'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/rubygems_gem_installer.rb:19:in `install'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/source/rubygems.rb:203:in `install'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/installer/gem_installer.rb:54:in `install'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/installer/gem_installer.rb:16:in `install_from_spec'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/installer/parallel_installer.rb:156:in `do_install'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/installer/parallel_installer.rb:147:in `block in worker_pool'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/worker.rb:62:in `apply_func'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/worker.rb:57:in `block in process_queue'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/worker.rb:54:in `loop'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/worker.rb:54:in `process_queue'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/worker.rb:90:in `block (2 levels) in create_threads'

Bundler Error Backtrace:
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/rubygems_gem_installer.rb:115:in `rescue in strict_rm_rf'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/rubygems_gem_installer.rb:110:in `strict_rm_rf'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/rubygems_gem_installer.rb:19:in `install'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/source/rubygems.rb:203:in `install'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/installer/gem_installer.rb:54:in `install'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/installer/gem_installer.rb:16:in `install_from_spec'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/installer/parallel_installer.rb:156:in `do_install'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/installer/parallel_installer.rb:147:in `block in worker_pool'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/worker.rb:62:in `apply_func'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/worker.rb:57:in `block in process_queue'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/worker.rb:54:in `loop'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/worker.rb:54:in `process_queue'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/worker.rb:90:in `block (2 levels) in create_threads'

An error occurred while installing minitest (5.20.0), and Bundler cannot continue.

In Gemfile:
  activesupport was resolved to 6.1.7.6, which depends on
    minitest


Bundler::DirectoryRemovalError: Could not delete previous installation of `/Users/deivid/Code/playground/world-writable/vendor/bundle/ruby/2.6.0/gems/zeitwerk-2.6.12`.
The underlying error was ArgumentError: parent directory is world writable, Bundler::FileUtils#remove_entry_secure does not work; abort:
"/Users/deivid/Code/playground/world-writable/vendor/bundle/ruby/2.6.0/gems/zeitwerk-2.6.12" (parent directory mode 40777), with backtrace:
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/vendor/fileutils/lib/fileutils.rb:1387:in `remove_entry_secure'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler.rb:332:in `rm_rf'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/rubygems_gem_installer.rb:111:in `strict_rm_rf'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/rubygems_gem_installer.rb:19:in `install'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/source/rubygems.rb:203:in `install'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/installer/gem_installer.rb:54:in `install'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/installer/gem_installer.rb:16:in `install_from_spec'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/installer/parallel_installer.rb:156:in `do_install'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/installer/parallel_installer.rb:147:in `block in worker_pool'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/worker.rb:62:in `apply_func'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/worker.rb:57:in `block in process_queue'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/worker.rb:54:in `loop'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/worker.rb:54:in `process_queue'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/worker.rb:90:in `block (2 levels) in create_threads'

Bundler Error Backtrace:
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/rubygems_gem_installer.rb:115:in `rescue in strict_rm_rf'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/rubygems_gem_installer.rb:110:in `strict_rm_rf'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/rubygems_gem_installer.rb:19:in `install'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/source/rubygems.rb:203:in `install'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/installer/gem_installer.rb:54:in `install'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/installer/gem_installer.rb:16:in `install_from_spec'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/installer/parallel_installer.rb:156:in `do_install'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/installer/parallel_installer.rb:147:in `block in worker_pool'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/worker.rb:62:in `apply_func'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/worker.rb:57:in `block in process_queue'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/worker.rb:54:in `loop'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/worker.rb:54:in `process_queue'
  /Users/deivid/.asdf/installs/ruby/2.6.10/lib/ruby/site_ruby/2.6.0/bundler/worker.rb:90:in `block (2 levels) in create_threads'

An error occurred while installing zeitwerk (2.6.12), and Bundler cannot continue.

In Gemfile:
  activesupport was resolved to 6.1.7.6, which depends on
    zeitwerk

After

$ bundle install --force --jobs 2
[DEPRECATED] The `--force` option has been renamed to `--redownload`
Fetching gem metadata from https://rubygems.org/.......
Installing minitest 5.20.0
Installing concurrent-ruby 1.2.2
Installing zeitwerk 2.6.12
Installing public_suffix 5.0.3
Installing bindata 2.4.15
Installing did_you_mean 1.6.3
Installing plist 3.7.0
Installing ruby-macho 4.0.0
Installing sorbet-runtime 0.5.10461
Installing warning 1.3.0
Your installation path /Users/deivid/Code/playground/world-writable/vendor/bundle/ruby/2.6.0/gems has insecure permissions (it's both world-writable and does not have the sticky bit set), so Bundler can't
reinstall any gems into it since it needs to remove previous installations which is insecure.

Make sure the following tasks are checked

Describe the problem / feature
Write tests for features and bug fixes
Write code to solve the problem
Make sure you follow the current code style and write meaningful commit messages without tags

bundler/lib/bundler/errors.rb

bundler/spec/bundler/bundler_spec.rb

martinemde · 2023-10-07T16:09:13Z

Just a note that this and #6374 define exit status 37. Whichever merges first, the other needs an update (probably bundler checksums, but mentioning just in case so we don't forget.)

It's a `BundlerError`.

martinemde

Now that's a nice looking message, haha ;)

I see you got the exit status code too. Looks good!

(cherry picked from commit a5f8835)

deivid-rodriguez force-pushed the better-parallel-install-errors branch from 594d9f7 to 6de4161 Compare October 3, 2023 15:48

deivid-rodriguez marked this pull request as ready for review October 6, 2023 05:39

deivid-rodriguez added the bundler: enhancement label Oct 6, 2023

martinemde reviewed Oct 7, 2023

View reviewed changes

bundler/lib/bundler/errors.rb Outdated Show resolved Hide resolved

bundler/spec/bundler/bundler_spec.rb Show resolved Hide resolved

deivid-rodriguez added 2 commits October 27, 2023 21:27

Remove redundant error class

53ea676

It's a `BundlerError`.

Better error when having an insecure install folder

e41156e

deivid-rodriguez force-pushed the better-parallel-install-errors branch from 6de4161 to e41156e Compare October 27, 2023 19:55

martinemde approved these changes Oct 28, 2023

View reviewed changes

martinemde merged commit a5f8835 into master Oct 28, 2023
92 checks passed

martinemde deleted the better-parallel-install-errors branch October 28, 2023 15:26

deivid-rodriguez pushed a commit that referenced this pull request Nov 8, 2023

Merge pull request #7030 from rubygems/better-parallel-install-errors

ae24c91

(cherry picked from commit a5f8835)

deivid-rodriguez pushed a commit that referenced this pull request Nov 8, 2023

Merge pull request #7030 from rubygems/better-parallel-install-errors

38baaf2

(cherry picked from commit a5f8835)

deivid-rodriguez pushed a commit that referenced this pull request Nov 8, 2023

Merge pull request #7030 from rubygems/better-parallel-install-errors

8e705ba

(cherry picked from commit a5f8835)

deivid-rodriguez pushed a commit that referenced this pull request Nov 8, 2023

Merge pull request #7030 from rubygems/better-parallel-install-errors

92f0a29

(cherry picked from commit a5f8835)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Give better error when previous installation folder is insecure to remove #7030

Give better error when previous installation folder is insecure to remove #7030

deivid-rodriguez commented Oct 3, 2023 •

edited

martinemde commented Oct 7, 2023

martinemde left a comment

Give better error when previous installation folder is insecure to remove #7030

Give better error when previous installation folder is insecure to remove #7030

Conversation

deivid-rodriguez commented Oct 3, 2023 • edited

What was the end-user or developer problem that led to this PR?

What is your fix for the problem, implemented in this PR?

Before

After

Make sure the following tasks are checked

martinemde commented Oct 7, 2023

martinemde left a comment

Choose a reason for hiding this comment

deivid-rodriguez commented Oct 3, 2023 •

edited