Start returning composed bundle environment from initialize request (#2880)

### Motivation

Currently, we are always spawning the debug client with the incorrect environment. The reason is because the composed bundle process does a lot of heavy lifting to determine the exact environment variables that need to be set to apply an accurate Bundler configuration.

We need the debug client to have access to the composed environment if we want to be able to launch the debugger properly for all scenarios.

### Implementation

Started reading the bundle env and returning it as part of the initialize request.

### Automated Tests

Added a test to verify that we're returning the environment.

Author: vinistock

exe/ruby-lsp-launcher

@@ -74,9 +74,6 @@ rescue StandardError => e
   # If Bundler.setup fails, we need to restore the original $LOAD_PATH so that we can still require the Ruby LSP server
   # in degraded mode
   $LOAD_PATH.unshift(File.expand_path("../lib", __dir__))
-ensure
-  require "fileutils"
-  FileUtils.rm(bundle_env_path) if File.exist?(bundle_env_path)
 end
 
 error_path = File.join(".ruby-lsp", "install_error")

lib/ruby_lsp/internal.rb

@@ -21,6 +21,7 @@
 require "prism/visitor"
 require "language_server-protocol"
 require "rbs"
+require "fileutils"
 
 require "ruby-lsp"
 require "ruby_lsp/base_server"

lib/ruby_lsp/server.rb

@@ -216,6 +216,13 @@ def run_initialize(message)
         Hash.new(true)
       end
 
+      bundle_env_path = File.join(".ruby-lsp", "bundle_env")
+      bundle_env = if File.exist?(bundle_env_path)
+        env = File.readlines(bundle_env_path).to_h { |line| T.cast(line.chomp.split("=", 2), [String, String]) }
+        FileUtils.rm(bundle_env_path)
+        env
+      end
+
       document_symbol_provider = Requests::DocumentSymbol.provider if enabled_features["documentSymbols"]
       document_link_provider = Requests::DocumentLink.provider if enabled_features["documentLink"]
       code_lens_provider = Requests::CodeLens.provider if enabled_features["codeLens"]
@@ -269,6 +276,7 @@ def run_initialize(message)
         },
         formatter: @global_state.formatter,
         degraded_mode: !!(@install_error || @setup_error),
+        bundle_env: bundle_env,
       }
 
       send_message(Result.new(id: message[:id], response: response))

project-words

@@ -58,6 +58,7 @@ quxx
 quux
 qorge
 rdbg
+readlines
 realpath
 reparsing
 requireds

test/server_test.rb

@@ -33,6 +33,29 @@ def test_initialize_enabled_features_with_array
     assert_includes(capabilities, "semanticTokensProvider")
   end
 
+  def test_initialize_returns_bundle_env
+    bundle_env_path = File.join(".ruby-lsp", "bundle_env")
+    FileUtils.mkdir(".ruby-lsp") unless File.exist?(".ruby-lsp")
+    File.write(bundle_env_path, "BUNDLE_PATH=vendor/bundle")
+    @server.process_message({
+      id: 1,
+      method: "initialize",
+      params: {
+        initializationOptions: { enabledFeatures: [] },
+        capabilities: { general: { positionEncodings: ["utf-8"] } },
+      },
+    })
+
+    result = find_message(RubyLsp::Result, id: 1)
+    hash = JSON.parse(result.response.to_json)
+
+    begin
+      assert_equal({ "BUNDLE_PATH" => "vendor/bundle" }, hash["bundle_env"])
+    ensure
+      FileUtils.rm(bundle_env_path) if File.exist?(bundle_env_path)
+    end
+  end
+
   def test_initialize_enabled_features_with_hash
     capture_subprocess_io do
       @server.process_message({