ruby-lsp 0.26.6 → 0.26.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce859aba34e036ede0a47740d7a1beb65ed4680d58bf95fa17ac85e7c74e8560
-  data.tar.gz: 49e26820d59a101fb64bbef651741225f4670b892ce7f6317eb7566389e62f8c
+  metadata.gz: 54c4bc57589939f89d9db6539395d9036679979455346126c6bb1e1421364a20
+  data.tar.gz: debb4a5808a5d0ef964b919fd613743aa452e7ef686fb28c9fd78c1a2d178b21
 SHA512:
-  metadata.gz: 7a5dc4ad02c3e8fc462a08fc059e84039b2d63b39e066a46aedfa724837161941a92a8fd198f645818de819a7140e8abe576bc3a770fe355cab4f689ef9d568e
-  data.tar.gz: 2e7fa7e3d5e409c91fc4e3a05d1c15ea4b3bbabf41e2edd4078acb80e9817e1436b50a0a6656f1c46e7e6eb6d4f19f8b499cb89dc8aa761e7984bbad94cb5263
+  metadata.gz: 2de6eb23b63121880662e02ebff976e69023b1fbf57a6c1a34ea620623f68ed9e6628a9e546237e93fd21e2a76050ad3033c08017539b020727e5607304e891c
+  data.tar.gz: 1d62a8f58593ad5a04667a6bf4c64ce0111a42de7940b8d6408eaa886055f946760203898e35905d07b163764e4f12cb689264848908e97381b68fbfbc7298b8

data/VERSION

@@ -1 +1 @@
-0.26.6
+0.26.8

data/exe/ruby-lsp

@@ -3,7 +3,6 @@
 
 require "optparse"
 
-original_args = ARGV.dup
 options = {}
 parser = OptionParser.new do |opts|
   opts.banner = "Usage: ruby-lsp [options]"
@@ -37,6 +36,10 @@ parser = OptionParser.new do |opts|
     options[:launcher] = true
   end
 
+  opts.on("--beta", "Use pre-release server gems") do
+    options[:beta] = true
+  end
+
   opts.on("-h", "--help", "Print this help") do
     puts opts.help
     puts
@@ -46,7 +49,7 @@ parser = OptionParser.new do |opts|
 end
 
 begin
-  parser.parse!
+  parser.parse(ARGV)
 rescue OptionParser::InvalidOption => e
   warn(e)
   warn("")
@@ -66,6 +69,8 @@ if ENV["BUNDLE_GEMFILE"].nil?
   if options[:launcher]
     flags = []
     flags << "--debug" if options[:debug]
+    flags << "--beta" if options[:beta]
+    flags.push("--branch", options[:branch]) if options[:branch]
     exit exec(Gem.ruby, File.expand_path("ruby-lsp-launcher", __dir__), *flags)
   end
 
@@ -85,7 +90,7 @@ if ENV["BUNDLE_GEMFILE"].nil?
     base_command << " _#{env["BUNDLER_VERSION"]}_"
   end
 
-  exit exec(env, "#{base_command} exec ruby-lsp #{original_args.join(" ")}".strip)
+  exit exec(env, "#{base_command} exec ruby-lsp #{ARGV.join(" ")}".strip)
 end
 
 $stdin.sync = true

data/exe/ruby-lsp-launcher

@@ -20,6 +20,12 @@ reboot = false
 workspace_uri = ARGV.first
 raw_initialize_path = File.join(".ruby-lsp", "raw_initialize")
 
+# Extract CLI options that affect bundle composition (e.g. --branch, --beta) from the arguments passed by the server
+cli_options = {}
+branch_index = ARGV.index("--branch")
+cli_options[:branch] = ARGV[branch_index + 1] if branch_index
+cli_options[:beta] = true if ARGV.include?("--beta")
+
 raw_initialize = if workspace_uri && !workspace_uri.start_with?("--")
   # If there's an argument without `--`, then it's the server asking to compose the bundle and passing to this
   # executable the workspace URI. We can't require gems at this point, so we built a fake initialize request manually
@@ -49,16 +55,21 @@ pid = if Gem.win_platform?
     ["-I", File.expand_path(path)]
   end
 
+  cli_flags = []
+  cli_flags << "--beta" if cli_options[:beta]
+  cli_flags.push("--branch", cli_options[:branch]) if cli_options[:branch]
+
   Process.spawn(
     Gem.ruby,
     *load_path,
     File.expand_path("../lib/ruby_lsp/scripts/compose_bundle_windows.rb", __dir__),
     raw_initialize,
+    *cli_flags,
   )
 else
   fork do
     require_relative "../lib/ruby_lsp/scripts/compose_bundle"
-    compose(raw_initialize)
+    compose(raw_initialize, **cli_options)
   end
 end
 
@@ -101,7 +112,7 @@ begin
     Bundler.setup
     $stderr.puts("Composed Bundle set up successfully")
   end
-rescue Bundler::GemNotFound, Bundler::GitError
+rescue Bundler::GemNotFound, Bundler::GitError => e
   # Sometimes, we successfully set up the bundle, but users either change their Gemfile or uninstall gems from an
   # external process. If there's no install error, but the gem is still not found, then we need to attempt to start from
   # scratch
@@ -113,6 +124,10 @@ rescue Bundler::GemNotFound, Bundler::GitError
       exec(Gem.ruby, __FILE__, *ARGV, "--retry")
     end
   end
+
+  setup_error = e
+  $stderr.puts("Failed to set up composed Bundle\n#{e.full_message}")
+  $LOAD_PATH.unshift(File.expand_path("../lib", __dir__))
 rescue StandardError => e
   setup_error = e
   $stderr.puts("Failed to set up composed Bundle\n#{e.full_message}")

data/lib/ruby_lsp/base_server.rb

@@ -165,18 +165,20 @@ module RubyLsp
 
       # Check if the request was cancelled before trying to process it
       @global_state.synchronize do
-        if id && @cancelled_requests.include?(id)
+        if id && @cancelled_requests.delete(id)
           send_message(Error.new(
             id: id,
             code: Constant::ErrorCodes::REQUEST_CANCELLED,
             message: "Request #{id} was cancelled",
           ))
-          @cancelled_requests.delete(id)
+
           return
         end
       end
 
       process_message(message)
+      # Ensure we remove the request if it got cancelled while it was being processed
+      @cancelled_requests.delete(id)
     end
 
     #: ((Result | Error | Notification | Request) message) -> void
@@ -197,7 +199,7 @@ module RubyLsp
 
     #: (String message, ?type: Integer) -> void
     def send_log_message(message, type: Constant::MessageType::LOG)
-      send_message(Notification.window_log_message(message, type: Constant::MessageType::LOG))
+      send_message(Notification.window_log_message(message, type: type))
     end
   end
 end

data/lib/ruby_lsp/listeners/semantic_highlighting.rb

@@ -94,7 +94,7 @@ module RubyLsp
 
       #: (Prism::MatchWriteNode node) -> void
       def on_match_write_node_leave(node)
-        @inside_regex_capture = true if node.call.message == "=~"
+        @inside_regex_capture = false if node.call.message == "=~"
       end
 
       #: (Prism::DefNode node) -> void

data/lib/ruby_lsp/requests/support/rubocop_diagnostic.rb

@@ -14,6 +14,12 @@ module RubyLsp
           fatal: Constant::DiagnosticSeverity::ERROR,
         }.freeze #: Hash[Symbol, Integer]
 
+        # Cops where adding a `rubocop:disable` inline comment would itself resolve the offense,
+        # causing Lint/RedundantCopDisableDirective to flag the disable as unnecessary.
+        SELF_RESOLVING_DISABLE_COPS = Set.new([
+          "Layout/EmptyComment",
+        ]).freeze #: Set[String]
+
         ENHANCED_DOC_URL = begin
           gem("rubocop", ">= 1.64.0")
           true
@@ -35,7 +41,7 @@ module RubyLsp
           code_actions = []
 
           code_actions << autocorrect_action if correctable?
-          code_actions << disable_line_action
+          code_actions << disable_line_action unless SELF_RESOLVING_DISABLE_COPS.include?(@offense.cop_name)
 
           code_actions
         end

data/lib/ruby_lsp/scripts/compose_bundle.rb

@@ -1,7 +1,7 @@
 # typed: true
 # frozen_string_literal: true
 
-def compose(raw_initialize)
+def compose(raw_initialize, **options)
   require_relative "../setup_bundler"
   require "json"
   require "uri"
@@ -12,7 +12,7 @@ def compose(raw_initialize)
   workspace_path = workspace_uri && URI(workspace_uri).to_standardized_path
   workspace_path ||= Dir.pwd
 
-  env = RubyLsp::SetupBundler.new(workspace_path, launcher: true).setup!
+  env = RubyLsp::SetupBundler.new(workspace_path, launcher: true, **options).setup!
 
   File.open(File.join(".ruby-lsp", "bundle_env"), "w") do |f|
     f.flock(File::LOCK_EX)

data/lib/ruby_lsp/scripts/compose_bundle_windows.rb

@@ -5,4 +5,8 @@ require_relative "compose_bundle"
 
 # When this is invoked on Windows, we pass the raw initialize as an argument to this script. On other platforms, we
 # invoke the compose method from inside a forked process
-compose(ARGV.first)
+options = {}
+options[:beta] = true if ARGV.include?("--beta")
+branch_index = ARGV.index("--branch")
+options[:branch] = ARGV[branch_index + 1] if branch_index
+compose(ARGV.first, **options)

data/lib/ruby_lsp/server.rb

@@ -1436,6 +1436,7 @@ module RubyLsp
             ),
             File.expand_path("../../exe/ruby-lsp-launcher", __dir__),
             @global_state.workspace_uri.to_s,
+            *ARGV,
             chdir: @global_state.workspace_path,
           )
         end

data/lib/ruby_lsp/setup_bundler.rb

@@ -34,12 +34,14 @@ module RubyLsp
     # 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?
+      @beta = options[:beta] #: bool?
       force_output_to_stderr! if @launcher
 
       # Regular bundle paths
@@ -59,7 +61,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
@@ -118,17 +120,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
 
@@ -168,7 +177,8 @@ module RubyLsp
       end
 
       unless @dependencies["ruby-lsp"]
-        ruby_lsp_entry = +'gem "ruby-lsp", require: false, group: :development'
+        version = @beta ? "0.a" : RUBY_LSP_MIN_VERSION
+        ruby_lsp_entry = +"gem \"ruby-lsp\", \">= #{version}\", require: false, group: :development"
         ruby_lsp_entry << ", github: \"Shopify/ruby-lsp\", branch: \"#{@branch}\"" if @branch
         parts << ruby_lsp_entry
       end
@@ -238,7 +248,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.
         #
@@ -246,6 +256,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
@@ -340,7 +351,7 @@ module RubyLsp
 
       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

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 }
@@ -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,23 +215,11 @@ module RubyLsp
       internal_shutdown unless @invoked_shutdown
     end
 
-    class << self
-      #: -> 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
-    end
-
     private
 
-    #: (String) -> TCPSocket
+    #: (String) -> Socket
     def socket(port)
-      socket = TCPSocket.new("localhost", port)
+      socket = Socket.tcp("localhost", port)
       socket.binmode
       socket.sync = true
       socket
@@ -220,7 +228,14 @@ module RubyLsp
     #: (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.6
+  version: 0.26.8
 platform: ruby
 authors:
 - Shopify