Merge pull request #890 from Shopify/vs/use_absolute_path_for_running_lsp

Use the absolute BUNDLE_PATH to run the server

Author: vinistock

lib/ruby_lsp/setup_bundler.rb

@@ -156,11 +156,12 @@ def run_bundle_install(bundle_gemfile = @gemfile)
       # `.ruby-lsp` folder, which is not the user's intention. For example, if the path is configured as `vendor`, we
       # want to install it in the top level `vendor` and not `.ruby-lsp/vendor`
       path = Bundler.settings["path"]
+      expanded_path = File.expand_path(path, Dir.pwd) if path
 
       # Use the absolute `BUNDLE_PATH` to prevent accidentally creating unwanted folders under `.ruby-lsp`
       env = {}
       env["BUNDLE_GEMFILE"] = bundle_gemfile.to_s
-      env["BUNDLE_PATH"] = File.expand_path(path, Dir.pwd) if path
+      env["BUNDLE_PATH"] = expanded_path if expanded_path
 
       # If both `ruby-lsp` and `debug` are already in the Gemfile, then we shouldn't try to upgrade them or else we'll
       # produce undesired source control changes. If the custom bundle was just created and either `ruby-lsp` or `debug`
@@ -187,7 +188,7 @@ def run_bundle_install(bundle_gemfile = @gemfile)
       # Add bundle update
       warn("Ruby LSP> Running bundle install for the custom bundle. This may take a while...")
       system(env, command)
-      [bundle_gemfile.to_s, path]
+      [bundle_gemfile.to_s, expanded_path]
     end
   end
 end

test/setup_bundler_test.rb

@@ -124,7 +124,7 @@ def test_uses_absolute_bundle_path_for_bundle_install
     Bundler.settings.set_global("path", "vendor/bundle")
     Object.any_instance.expects(:system).with(bundle_env(".ruby-lsp/Gemfile"), "bundle install 1>&2")
     Bundler::LockfileParser.any_instance.expects(:dependencies).returns({}).at_least_once
-    run_script
+    run_script(expected_path: File.expand_path("vendor/bundle", Dir.pwd))
   ensure
     # We need to revert the changes to the bundler config or else this actually changes ~/.bundle/config
     Bundler.settings.set_global("path", nil)
@@ -212,8 +212,10 @@ def test_does_nothing_if_both_ruby_lsp_and_debug_are_gemspec_dependencies
 
   # This method runs the script and then immediately unloads it. This allows us to make assertions against the effects
   # of running the script multiple times
-  def run_script(path = "/fake/project/path")
-    RubyLsp::SetupBundler.new(path).setup!
+  def run_script(path = "/fake/project/path", expected_path: nil)
+    _bundle_gemfile, bundle_path = RubyLsp::SetupBundler.new(path).setup!
+
+    assert_equal(expected_path, bundle_path) if expected_path
   end
 
   def bundle_env(bundle_gemfile = "Gemfile")