ruby-lsp 0.26.2 → 0.26.9

data/lib/ruby_lsp/setup_bundler.rb

@@ -31,12 +31,17 @@ module RubyLsp
 
     FOUR_HOURS = 4 * 60 * 60 #: Integer
 
+    # Gems that should be kept up to date in the composed bundle. When updating, any of these gems that are not
+    # already in the user's Gemfile will be updated together.
+    GEMS_TO_UPDATE = ["ruby-lsp", "debug", "prism", "rbs"].freeze #: Array[String]
+    RUBY_LSP_MIN_VERSION = "0.18.0" #: String
+
     #: (String project_path, **untyped options) -> void
     def initialize(project_path, **options)
       @project_path = project_path
-      @branch = options[:branch] #: String?
       @launcher = options[:launcher] #: bool?
-      patch_thor_to_print_progress_to_stderr! if @launcher
+      @beta = options[:beta] #: bool?
+      force_output_to_stderr! if @launcher
 
       # Regular bundle paths
       @gemfile = begin
@@ -55,7 +60,7 @@ module RubyLsp
       @custom_dir = Pathname.new(".ruby-lsp").expand_path(@project_path) #: Pathname
       @custom_gemfile = @custom_dir + @gemfile_name #: Pathname
       @custom_lockfile = @custom_dir + (@lockfile&.basename || "Gemfile.lock") #: Pathname
-      @lockfile_hash_path = @custom_dir + "main_lockfile_hash" #: Pathname
+      @freshness_hash_path = @custom_dir + "freshness_hash" #: Pathname
       @last_updated_path = @custom_dir + "last_updated" #: Pathname
       @error_path = @custom_dir + "install_error" #: Pathname
       @already_composed_path = @custom_dir + "bundle_is_composed" #: Pathname
@@ -114,17 +119,24 @@ module RubyLsp
         return run_bundle_install(@custom_gemfile)
       end
 
-      if @lockfile_hash && @custom_lockfile.exist? && @lockfile_hash_path.exist? &&
-          @lockfile_hash_path.read == @lockfile_hash
+      # Our freshness hash determines if we need to copy the lockfile from the main app again and run bundle install
+      # from scratch. We use a combination of the main app's lockfile and the composed Gemfile. The goal is to
+      # automatically account for CLI arguments which can change the Gemfile we compose. If the CLI arguments or the
+      # main lockfile change, we need to make sure we're re-composing.
+      freshness_digest = Digest::SHA256.hexdigest("#{@lockfile_hash}#{@custom_gemfile.read}")
+
+      if @lockfile_hash && @custom_lockfile.exist? && @freshness_hash_path.exist? &&
+          @freshness_hash_path.read == freshness_digest
         $stderr.puts(
           "Ruby LSP> Skipping composed bundle setup since #{@custom_lockfile} already exists and is up to date",
         )
         return run_bundle_install(@custom_gemfile)
       end
 
+      @needs_update_path.delete if @needs_update_path.exist?
       FileUtils.cp(@lockfile.to_s, @custom_lockfile.to_s)
       correct_relative_remote_paths
-      @lockfile_hash_path.write(@lockfile_hash)
+      @freshness_hash_path.write(freshness_digest)
       run_bundle_install(@custom_gemfile)
     end
 
@@ -164,9 +176,8 @@ module RubyLsp
       end
 
       unless @dependencies["ruby-lsp"]
-        ruby_lsp_entry = +'gem "ruby-lsp", require: false, group: :development'
-        ruby_lsp_entry << ", github: \"Shopify/ruby-lsp\", branch: \"#{@branch}\"" if @branch
-        parts << ruby_lsp_entry
+        version = @beta ? "0.a" : RUBY_LSP_MIN_VERSION
+        parts << "gem \"ruby-lsp\", \">= #{version}\", require: false, group: :development"
       end
 
       unless @dependencies["debug"]
@@ -234,7 +245,7 @@ module RubyLsp
         # If no error occurred, then clear previous errors
         @error_path.delete if @error_path.exist?
         $stderr.puts("Ruby LSP> Composed bundle installation complete")
-      rescue Errno::EPIPE, Bundler::HTTPError
+      rescue Errno::EPIPE, Bundler::HTTPError, Bundler::InstallError
         # There are cases where we expect certain errors to happen occasionally, and we don't want to write them to
         # a file, which would report to telemetry on the next launch.
         #
@@ -242,6 +253,7 @@ module RubyLsp
         # install. This situation may happen because, while running bundle install, the server is not yet ready to
         # receive shutdown requests and we may continue doing work until the process is killed.
         # - Bundler might also encounter a network error.
+        # - Native extension build failures (InstallError) are user environment issues that Ruby LSP cannot resolve.
         @error_path.delete if @error_path.exist?
       rescue => e
         # Write the error object to a file so that we can read it from the parent process
@@ -270,17 +282,37 @@ module RubyLsp
     #: (Hash[String, String] env, ?force_install: bool) -> Hash[String, String]
     def run_bundle_install_directly(env, force_install: false)
       RubyVM::YJIT.enable if defined?(RubyVM::YJIT.enable)
-      return update(env) if @needs_update_path.exist?
 
-      # The ENV can only be merged after checking if an update is required because we depend on the original value of
-      # ENV["BUNDLE_GEMFILE"], which gets overridden after the merge
-      FileUtils.touch(@needs_update_path) if should_bundle_update?
+      # The should_bundle_update? check needs to run on the original Bundler environment, but everything else (like
+      # updating or running install) requires the modified environment. Here we compute the check ahead of time and
+      # merge the environment to ensure correct results.
+      #
+      # The symptoms of having these operations in the wrong order is seeing unwanted modifications in the application's
+      # main lockfile because we accidentally run update on the main bundle instead of the composed one.
+      needs_update = should_bundle_update?
       ENV.merge!(env)
 
+      return update(env) if @needs_update_path.exist?
+
+      FileUtils.touch(@needs_update_path) if needs_update
+
       $stderr.puts("Ruby LSP> Checking if the composed bundle is satisfied...")
-      missing_gems = bundle_check
 
-      unless missing_gems.empty?
+      begin
+        missing_gems = bundle_check
+      rescue Errno::EPIPE, Bundler::HTTPError
+        # These are errors cases where we cannot recover
+        raise
+      rescue => e
+        # If anything fails with bundle check, try to bundle install
+        $stderr.puts("Ruby LSP> Running bundle install because #{e.message}")
+        bundle_install
+        return env
+      end
+
+      if missing_gems.empty?
+        $stderr.puts("Ruby LSP> Bundle already satisfied")
+      else
         $stderr.puts(<<~MESSAGE)
           Ruby LSP> Running bundle install because the following gems are not installed:
           #{missing_gems.map { |g| "#{g.name}: #{g.version}" }.join("\n")}
@@ -289,11 +321,6 @@ module RubyLsp
         bundle_install
       end
 
-      $stderr.puts("Ruby LSP> Bundle already satisfied")
-      env
-    rescue => e
-      $stderr.puts("Ruby LSP> Running bundle install because #{e.message}")
-      bundle_install
       env
     end
 
@@ -316,26 +343,26 @@ module RubyLsp
     def update(env)
       # Try to auto upgrade the gems we depend on, unless they are in the Gemfile as that would result in undesired
       # source control changes
-      gems = ["ruby-lsp", "debug", "prism"].reject { |dep| @dependencies[dep] }
+      gems = GEMS_TO_UPDATE.reject { |dep| @dependencies[dep] }
       gems << "ruby-lsp-rails" if @rails_app && !@dependencies["ruby-lsp-rails"]
 
       Bundler::CLI::Update.new({ conservative: true }, gems).run
       correct_relative_remote_paths if @custom_lockfile.exist?
-      @needs_update_path.delete
+      @needs_update_path.delete if @needs_update_path.exist?
       @last_updated_path.write(Time.now.iso8601)
       env
     end
 
     #: (Hash[String, String] env) -> Hash[String, String]
     def run_bundle_install_through_command(env)
-      # If `ruby-lsp` and `debug` (and potentially `ruby-lsp-rails`) are already in the Gemfile, then we shouldn't try
-      # to upgrade them or else we'll produce undesired source control changes. If the composed bundle was just created
-      # and any of `ruby-lsp`, `ruby-lsp-rails` or `debug` weren't a part of the Gemfile, then we need to run `bundle
-      # install` for the first time to generate the Gemfile.lock with them included or else Bundler will complain that
-      # they're missing. We can only update if the custom `.ruby-lsp/Gemfile.lock` already exists and includes all gems
+      # If the gems in GEMS_TO_UPDATE (and potentially `ruby-lsp-rails`) are already in the Gemfile, then we shouldn't
+      # try to upgrade them or else we'll produce undesired source control changes. If the composed bundle was just
+      # created and any of those gems weren't a part of the Gemfile, then we need to run `bundle install` for the first
+      # time to generate the Gemfile.lock with them included or else Bundler will complain that they're missing. We can
+      # only update if the custom `.ruby-lsp/Gemfile.lock` already exists and includes all gems
 
       # When not updating, we run `(bundle check || bundle install)`
-      # When updating, we run `((bundle check && bundle update ruby-lsp debug) || bundle install)`
+      # When updating, we run `((bundle check && bundle update <GEMS_TO_UPDATE>) || bundle install)`
       bundler_path = File.join(Gem.default_bindir, "bundle")
       base_command = (!Gem.win_platform? && File.exist?(bundler_path) ? "#{Gem.ruby} #{bundler_path}" : "bundle").dup
 
@@ -346,12 +373,11 @@ module RubyLsp
       command = +"(#{base_command} check"
 
       if should_bundle_update?
-        # If any of `ruby-lsp`, `ruby-lsp-rails` or `debug` are not in the Gemfile, try to update them to the latest
-        # version
+        # If any of the gems in GEMS_TO_UPDATE (or `ruby-lsp-rails` for Rails apps) are not in the Gemfile, try to
+        # update them to the latest version
         command.prepend("(")
         command << " && #{base_command} update "
-        command << "ruby-lsp " unless @dependencies["ruby-lsp"]
-        command << "debug " unless @dependencies["debug"]
+        GEMS_TO_UPDATE.each { |gem| command << "#{gem} " unless @dependencies[gem] }
         command << "ruby-lsp-rails " if @rails_app && !@dependencies["ruby-lsp-rails"]
         command.delete_suffix!(" ")
         command << ")"
@@ -480,11 +506,16 @@ module RubyLsp
     end
 
     #: -> void
-    def patch_thor_to_print_progress_to_stderr!
-      return unless defined?(Bundler::Thor::Shell::Basic)
+    def force_output_to_stderr!
+      # Bundler and RubyGems have different UI objects used for printing. We need to ensure that both are configured to
+      # print only to stderr or else they'll break the connection with the editor
+      Gem::DefaultUserInteraction.ui = Gem::StreamUI.new($stdin, $stderr, $stderr, false)
+
+      ui = Bundler.ui
+      ui.output_stream = :stderr if ui.respond_to?(:output_stream=)
+      ui.level = :info
 
-      Bundler::Thor::Shell::Basic.prepend(ThorPatch)
-      Bundler.ui.level = :info
+      Bundler::Thor::Shell::Basic.prepend(ThorPatch) if defined?(Bundler::Thor::Shell::Basic)
     end
   end
 end

data/lib/ruby_lsp/test_reporters/lsp_reporter.rb

@@ -4,13 +4,40 @@
 require "English"
 require "json"
 require "socket"
-require "singleton"
 require "tmpdir"
 require_relative "../../ruby_indexer/lib/ruby_indexer/uri"
 
 module RubyLsp
   class LspReporter
-    include Singleton
+    @instance = nil #: LspReporter?
+
+    class << self
+      #: -> LspReporter
+      def instance
+        @instance ||= new
+      end
+
+      #: -> bool
+      def start_coverage?
+        ENV["RUBY_LSP_TEST_RUNNER"] == "coverage"
+      end
+
+      #: -> bool
+      def executed_under_test_runner?
+        !!(ENV["RUBY_LSP_TEST_RUNNER"] && ENV["RUBY_LSP_ENV"] != "test")
+      end
+
+      #: (Method | UnboundMethod) -> [URI::Generic, Integer?]?
+      def uri_and_line_for(method_object)
+        file_path, line = method_object.source_location
+        return unless file_path
+        return if file_path.start_with?("(eval at ")
+
+        uri = URI::Generic.from_path(path: File.expand_path(file_path))
+        zero_based_line = line ? line - 1 : nil
+        [uri, zero_based_line]
+      end
+    end
 
     # https://code.visualstudio.com/api/references/vscode-api#Position
     #: type position = { line: Integer, character: Integer }
@@ -35,10 +62,10 @@ module RubyLsp
       @io = begin
         # The environment variable is only used for tests. The extension always writes to the temporary file
         if port
-          TCPSocket.new("localhost", port)
+          socket(port)
         elsif File.exist?(port_db_path)
           db = JSON.load_file(port_db_path)
-          TCPSocket.new("localhost", db[Dir.pwd])
+          socket(db[Dir.pwd])
         else
           # For tests that don't spawn the TCP server
           require "stringio"
@@ -50,6 +77,8 @@ module RubyLsp
       end #: IO | StringIO
 
       @invoked_shutdown = false #: bool
+      @message_queue = Thread::Queue.new #: Thread::Queue
+      @writer = Thread.new { write_loop } #: Thread
     end
 
     #: -> void
@@ -68,6 +97,8 @@ module RubyLsp
       @invoked_shutdown = true
 
       send_message("finish")
+      @message_queue.close
+      @writer.join
       @io.close
     end
 
@@ -96,17 +127,6 @@ module RubyLsp
       send_message("error", id: id, message: message, uri: uri.to_s)
     end
 
-    #: (Method | UnboundMethod) -> [URI::Generic, Integer?]?
-    def uri_and_line_for(method_object)
-      file_path, line = method_object.source_location
-      return unless file_path
-      return if file_path.start_with?("(eval at ")
-
-      uri = URI::Generic.from_path(path: File.expand_path(file_path))
-      zero_based_line = line ? line - 1 : nil
-      [uri, zero_based_line]
-    end
-
     # Gather the results returned by Coverage.result and format like the VS Code test explorer expects
     #
     # Coverage result format:
@@ -195,24 +215,27 @@ module RubyLsp
       internal_shutdown unless @invoked_shutdown
     end
 
-    class << self
-      #: -> bool
-      def start_coverage?
-        ENV["RUBY_LSP_TEST_RUNNER"] == "coverage"
-      end
+    private
 
-      #: -> bool
-      def executed_under_test_runner?
-        !!(ENV["RUBY_LSP_TEST_RUNNER"] && ENV["RUBY_LSP_ENV"] != "test")
-      end
+    #: (String) -> Socket
+    def socket(port)
+      socket = Socket.tcp("localhost", port)
+      socket.binmode
+      socket.sync = true
+      socket
     end
 
-    private
-
     #: (String?, **untyped) -> void
     def send_message(method_name, **params)
       json_message = { method: method_name, params: params }.to_json
-      @io.write("Content-Length: #{json_message.bytesize}\r\n\r\n#{json_message}")
+      @message_queue << "Content-Length: #{json_message.bytesize}\r\n\r\n#{json_message}"
+    end
+
+    #: -> void
+    def write_loop
+      while (message = @message_queue.pop)
+        @io.write(message)
+      end
     end
   end
 end

data/lib/ruby_lsp/test_reporters/minitest_reporter.rb

@@ -89,7 +89,7 @@ module RubyLsp
         test_class_or_wrapper
       end
 
-      uri, line = LspReporter.instance.uri_and_line_for(klass.instance_method(method_name))
+      uri, line = LspReporter.uri_and_line_for(klass.instance_method(method_name))
       return unless uri
 
       id = "#{name}##{handle_spec_test_id(method_name, line)}"

data/lib/ruby_lsp/test_reporters/test_unit_reporter.rb

@@ -25,7 +25,7 @@ module RubyLsp
     def test_started(test)
       super
 
-      uri, line = LspReporter.instance.uri_and_line_for(test.method(test.method_name))
+      uri, line = LspReporter.uri_and_line_for(test.method(test.method_name))
       return unless uri
 
       @current_uri = uri

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp
 version: !ruby/object:Gem::Version
-  version: 0.26.2
+  version: 0.26.9
 platform: ruby
 authors:
 - Shopify
@@ -96,20 +96,6 @@ files:
 - lib/ruby_indexer/lib/ruby_indexer/uri.rb
 - lib/ruby_indexer/lib/ruby_indexer/visibility_scope.rb
 - lib/ruby_indexer/ruby_indexer.rb
-- lib/ruby_indexer/test/class_variables_test.rb
-- lib/ruby_indexer/test/classes_and_modules_test.rb
-- lib/ruby_indexer/test/configuration_test.rb
-- lib/ruby_indexer/test/constant_test.rb
-- lib/ruby_indexer/test/enhancements_test.rb
-- lib/ruby_indexer/test/global_variable_test.rb
-- lib/ruby_indexer/test/index_test.rb
-- lib/ruby_indexer/test/instance_variables_test.rb
-- lib/ruby_indexer/test/method_test.rb
-- lib/ruby_indexer/test/prefix_tree_test.rb
-- lib/ruby_indexer/test/rbs_indexer_test.rb
-- lib/ruby_indexer/test/reference_finder_test.rb
-- lib/ruby_indexer/test/test_case.rb
-- lib/ruby_indexer/test/uri_test.rb
 - lib/ruby_lsp/addon.rb
 - lib/ruby_lsp/base_server.rb
 - lib/ruby_lsp/client_capabilities.rb
@@ -163,6 +149,7 @@ files:
 - lib/ruby_lsp/requests/support/annotation.rb
 - lib/ruby_lsp/requests/support/common.rb
 - lib/ruby_lsp/requests/support/formatter.rb
+- lib/ruby_lsp/requests/support/package_url.rb
 - lib/ruby_lsp/requests/support/rubocop_diagnostic.rb
 - lib/ruby_lsp/requests/support/rubocop_formatter.rb
 - lib/ruby_lsp/requests/support/rubocop_runner.rb
@@ -216,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.3
 specification_version: 4
 summary: An opinionated language server for Ruby
 test_files: []

data/lib/ruby_indexer/test/class_variables_test.rb

@@ -1,140 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-require_relative "test_case"
-
-module RubyIndexer
-  class ClassVariableTest < TestCase
-    def test_class_variable_and_write
-      index(<<~RUBY)
-        class Foo
-          @@bar &&= 1
-        end
-      RUBY
-
-      assert_entry("@@bar", Entry::ClassVariable, "/fake/path/foo.rb:1-2:1-7")
-
-      entry = @index["@@bar"]&.first #: as Entry::ClassVariable
-      owner = entry.owner #: as !nil
-      assert_instance_of(Entry::Class, owner)
-      assert_equal("Foo", owner.name)
-    end
-
-    def test_class_variable_operator_write
-      index(<<~RUBY)
-        class Foo
-          @@bar += 1
-        end
-      RUBY
-
-      assert_entry("@@bar", Entry::ClassVariable, "/fake/path/foo.rb:1-2:1-7")
-    end
-
-    def test_class_variable_or_write
-      index(<<~RUBY)
-        class Foo
-          @@bar ||= 1
-        end
-      RUBY
-
-      assert_entry("@@bar", Entry::ClassVariable, "/fake/path/foo.rb:1-2:1-7")
-    end
-
-    def test_class_variable_target_node
-      index(<<~RUBY)
-        class Foo
-          @@foo, @@bar = 1
-        end
-      RUBY
-
-      assert_entry("@@foo", Entry::ClassVariable, "/fake/path/foo.rb:1-2:1-7")
-      assert_entry("@@bar", Entry::ClassVariable, "/fake/path/foo.rb:1-9:1-14")
-
-      entry = @index["@@foo"]&.first #: as Entry::ClassVariable
-      owner = entry.owner #: as !nil
-      assert_instance_of(Entry::Class, owner)
-      assert_equal("Foo", owner.name)
-
-      entry = @index["@@bar"]&.first #: as Entry::ClassVariable
-      owner = entry.owner #: as !nil
-      assert_instance_of(Entry::Class, owner)
-      assert_equal("Foo", owner.name)
-    end
-
-    def test_class_variable_write
-      index(<<~RUBY)
-        class Foo
-          @@bar = 1
-        end
-      RUBY
-
-      assert_entry("@@bar", Entry::ClassVariable, "/fake/path/foo.rb:1-2:1-7")
-    end
-
-    def test_empty_name_class_variable
-      index(<<~RUBY)
-        module Foo
-          @@ = 1
-        end
-      RUBY
-
-      refute_entry("@@")
-    end
-
-    def test_top_level_class_variable
-      index(<<~RUBY)
-        @@foo = 123
-      RUBY
-
-      entry = @index["@@foo"]&.first #: as Entry::ClassVariable
-      assert_nil(entry.owner)
-    end
-
-    def test_class_variable_inside_self_method
-      index(<<~RUBY)
-        class Foo
-          def self.bar
-            @@bar = 123
-          end
-        end
-      RUBY
-
-      entry = @index["@@bar"]&.first #: as Entry::ClassVariable
-      owner = entry.owner #: as !nil
-      assert_instance_of(Entry::Class, owner)
-      assert_equal("Foo", owner.name)
-    end
-
-    def test_class_variable_inside_singleton_class
-      index(<<~RUBY)
-        class Foo
-          class << self
-            @@bar = 123
-          end
-        end
-      RUBY
-
-      entry = @index["@@bar"]&.first #: as Entry::ClassVariable
-      owner = entry.owner #: as !nil
-      assert_instance_of(Entry::Class, owner)
-      assert_equal("Foo", owner.name)
-    end
-
-    def test_class_variable_in_singleton_class_method
-      index(<<~RUBY)
-        class Foo
-          class << self
-            def self.bar
-              @@bar = 123
-            end
-          end
-        end
-      RUBY
-
-      entry = @index["@@bar"]&.first #: as Entry::ClassVariable
-      owner = entry.owner #: as !nil
-      assert_instance_of(Entry::Class, owner)
-      assert_equal("Foo", owner.name)
-    end
-  end
-end