Bundler auto-upgrade issue after release 3.0.3 when BUNDLE_PATH is set

[richard-kramer]

I ran into this issue in our CI pipeline running within a ruby docker image and with BUNDLE_PATH set for caching.

Before the upgrade of appraisal2 to v3.0.3 everything worked without problems. Since then, bundle exec appraisal install seems to not automatically switch to the correct version of bundler. An because I have my bundler version pinned within the Gemfile to support upgrading it via Renovate, the install fails.

Here is a minimal reproduction using the exact dependencies I use. Setting APPRAISAL_VERSION=3.0.2 works, but APPRAISAL_VERSION=3.0.3 fails with Your bundle requires a different version of Bundler than the one you're running. Unsetting BUNDLE_PATH also works with both versions (but BUNDLE_PATH= (empty) still fails)

Excuse the convoluted setup, but I wanted exact Gemfiles and Gemfile.lock files for a accurate reproduction.

docker run \
  -e BUNDLE_PATH=/tmp/bundler \
  -e APPRAISAL_VERSION="3.0.3" \
  --rm \
  ruby:4.0.1-alpine@sha256:7d1c4a23da9b3539fdeb5f970950a8fe044a707219e546f12152b84bbd5755d1 \
  sh -ec '
  echo "source \"https://rubygems.org\"; gem \"appraisal2\", \"$APPRAISAL_VERSION\"; gem \"bundler\", \"4.0.6\"" > Gemfile

  echo "GEM
  remote: https://rubygems.org/
  specs:
    appraisal2 ($APPRAISAL_VERSION)
      bundler (>= 1.17.3)
      rake (>= 10)
      thor (>= 0.14)
    rake (13.3.1)
    thor (1.5.0)

PLATFORMS
  ruby
  x86_64-linux-musl

DEPENDENCIES
  appraisal2 (= $APPRAISAL_VERSION)
  bundler (= 4.0.6)

BUNDLED WITH
  4.0.6" > Gemfile.lock

  echo "appraise(\"test\") { gem \"logger\" }" > Appraisals
  
  mkdir -p gemfiles
  echo "source \"https://rubygems.org\"; gem \"appraisal2\", \"$APPRAISAL_VERSION\"; gem \"bundler\", \"4.0.6\"; gem \"logger\"" > gemfiles/test.gemfile

  echo "GEM
  remote: https://rubygems.org/
  specs:
    appraisal2 (3.0.2)
      bundler (>= 1.17.3)
      rake (>= 10)
      thor (>= 0.14)
    logger (1.7.0)
    rake (13.3.1)
    thor (1.5.0)

PLATFORMS
  ruby
  x86_64-linux-musl

DEPENDENCIES
  appraisal2 (= 3.0.2)
  bundler (= 4.0.6)
  logger

BUNDLED WITH
  4.0.6" > gemfiles/test.gemfile.lock

  bundle install
  bundle exec appraisal install
'

[pboling]

Thanks for the detailed report! Looking into it.

[pboling]

I have never seen BUNDLE_PATH="" before. I would like understand that use case. Is it documented? And what is the intent?

I will add some regression tests to ensure I don't break the empty use case again.

[richard-kramer]

I have never seen BUNDLE_PATH="" before. I would like understand that use case. Is it documented? And what is the intent?

Thats no use case of mine at all. I explicitly set it to some directory I can then cache. I just noticed, setting it to an empty string does not "unset" it, but still fail. I'm not even sure, how bundler behaves when it is set to an empty string.

The error happens, when BUNDLE_PATH is set to any directory (e.g. BUNDLE_PATH=/tmp/cache/bundle), which is exactly my use case and currently breaks.

[pboling]

Oh I see. I'll focus on documenting exactly how appraisal2 uses BUNDLE_PATH internally, while I fix the bug.

[pboling]

@richard-kramer I'm interested if you get the same result with appraisal v3.0.4, which I released a couple days ago. I didn't intend to change any behavior related to bundler, but versions 3.0.x have included refactorings of some logic to accommodate using ore instead of bundler, and some of the bugs related to ore were fixed in v3.0.4, which could mean that it also fixed a regression in an earlier version with bundler, since they have a common base "adapter".

[pboling]

@richard-kramer Nevermind about the prior request. I found the regression, just as you said, between 3.0.2 and 3.0.3. I've reverted the logic to what it was in v3.0.2 in the critical path.

That also led me to realize that as-is the gem is only compatible with bundler back to v2.1 at the earliest, due to the use of Bundler.with_original_env.

It is my intent to support back to bundler v1.17.3, so I'll release the fix for this issue, and then work on restoring compatibility with the last version of bundler v1.

[pboling]

@richard-kramer v3.0.5 is released with the fix! Please let me know if it works / does not work for you.

[richard-kramer]

@richard-kramer v3.0.5 is released with the fix! Please let me know if it works / does not work for you.

Unfortunately, it still fails with the new version. Maybe the BUNDLE_PATH was only a symptom? I'm not really sure, what's controlling the bundle auto-upgrade when the Gemfile.lock version does not match the initial version. But maybe it's also connected to the bundler settings reset?

I used the same command for testing/reproduction, just with APPRAISAL_VERSION="3.0.5". You would probably have to modify the docker command quite a bit to test against a local build without a release.

And it's not only the reproducation that still fails, the issue also remains in my actual setup.

docker run \
  -e BUNDLE_PATH=/tmp/bundler \
  -e APPRAISAL_VERSION="3.0.5" \
  --rm \
  ruby:4.0.1-alpine@sha256:7d1c4a23da9b3539fdeb5f970950a8fe044a707219e546f12152b84bbd5755d1 \
  sh -ec '
  echo "source \"https://rubygems.org\"; gem \"appraisal2\", \"$APPRAISAL_VERSION\"; gem \"bundler\", \"4.0.6\"" > Gemfile

  echo "GEM
  remote: https://rubygems.org/
  specs:
    appraisal2 ($APPRAISAL_VERSION)
      bundler (>= 1.17.3)
      rake (>= 10)
      thor (>= 0.14)
    rake (13.3.1)
    thor (1.5.0)

PLATFORMS
  ruby
  x86_64-linux-musl

DEPENDENCIES
  appraisal2 (= $APPRAISAL_VERSION)
  bundler (= 4.0.6)

BUNDLED WITH
  4.0.6" > Gemfile.lock

  echo "appraise(\"test\") { gem \"logger\" }" > Appraisals
  
  mkdir -p gemfiles
  echo "source \"https://rubygems.org\"; gem \"appraisal2\", \"$APPRAISAL_VERSION\"; gem \"bundler\", \"4.0.6\"; gem \"logger\"" > gemfiles/test.gemfile

  echo "GEM
  remote: https://rubygems.org/
  specs:
    appraisal2 (3.0.2)
      bundler (>= 1.17.3)
      rake (>= 10)
      thor (>= 0.14)
    logger (1.7.0)
    rake (13.3.1)
    thor (1.5.0)

PLATFORMS
  ruby
  x86_64-linux-musl

DEPENDENCIES
  appraisal2 (= 3.0.2)
  bundler (= 4.0.6)
  logger

BUNDLED WITH
  4.0.6" > gemfiles/test.gemfile.lock

  bundle install
  bundle exec appraisal install
'

=>

Bundler 4.0.3 is running, but your lockfile was generated with 4.0.6. Installing Bundler 4.0.6 and restarting using that version.
Fetching gem metadata from https://rubygems.org/.
Fetching bundler 4.0.6
Installing bundler 4.0.6
Fetching gem metadata from https://rubygems.org/..
Fetching rake 13.3.1
Installing rake 13.3.1
Fetching thor 1.5.0
Installing thor 1.5.0
Fetching appraisal2 3.0.5
Installing appraisal2 3.0.5
Bundle complete! 2 Gemfile dependencies, 3 gems now installed.
Bundled gems are installed into `./tmp/bundler`
1 installed gem you directly depend on is looking for funding.
  Run `bundle fund` for details
>> BUNDLE_GEMFILE=/gemfiles/test.gemfile bundle check --gemfile='/gemfiles/test.gemfile' || bundle install --gemfile='/gemfiles/test.gemfile' --retry 1
Fetching gem metadata from https://rubygems.org/.
Resolving dependencies...
Bundler can't satisfy your Gemfile's dependencies.
Install missing gems with `bundle install`.
Fetching gem metadata from https://rubygems.org/.
Resolving dependencies...
Could not find compatible versions

Because the current Bundler version (4.0.3) does not satisfy bundler = 4.0.6
  and test.gemfile depends on bundler = 4.0.6,
  version solving has failed.

Your bundle requires a different version of Bundler than the one you're running.
Install the necessary version with `gem install bundler:4.0.6` and rerun bundler
using `bundle _4.0.6_ install --gemfile=/gemfiles/test.gemfile --retry 1`

[pboling]

Thanks for the updated report. Looking into it. I was able to repro, thought I had a valid regression test, and thought I had it fixed. But apparently not quite!