ruby-lsp 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9762389a7b7979afb57d6e6d2cf0d65b0b0a0b31f5a1fdd7045311c33a0c21d6
-  data.tar.gz: 35cc2318946e650ee311129955d3674c7e693a87d25c5cc2f29c5a55e479d880
+  metadata.gz: 3e09a85000549c0b7b7dd2886b49d44ca2e32b830616a4af7181a2d7952f948f
+  data.tar.gz: f19b017ebffce3a090d9fe9c39c94cb0dad75a7a74856c099443839524d513f3
 SHA512:
-  metadata.gz: 4735e18c297c992727d0a151ed7948cf6d4ea32b01fe411ed0774efdda7cdc0cf6533f5d71ad288aad9e6e717149932744376fdceda9fa4cd039b560934a9b47
-  data.tar.gz: bd6e0c9a81a373c509f2f96b480543657a8d241a6e58ea25ec21c62ac60094f299af1c5f85d1555ad6ca1908c325e46569119271d4c6b7117f33f9919cf40bca
+  metadata.gz: e0b75fa95c43a4a15a46e3cd663b5dd637c9288497116b356eb69dc3f831cfdbb3e167c1c578b68feee715e85c72d26c7d63236e3250552ddbf0f2db334e8f46
+  data.tar.gz: c80518dba77375f07f9944f0401f6836ca69bba60ba6723677e33e366104dd69b70832e8ce76c05312b47c3a032a5308711505e88be2ce69f3f837bec2db3c21

data/CHANGELOG.md

@@ -6,6 +6,11 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 
 ## [Unreleased]
 
+## [0.3.2]
+
+- Make the diagnostic request parallel (https://github.com/Shopify/ruby-lsp/pull/293)
+- Improve worker stability (https://github.com/Shopify/ruby-lsp/pull/295)
+
 ## [0.3.1]
 
 - Resolve TODO for LSP v3.17 (https://github.com/Shopify/ruby-lsp/pull/268)

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.3.2

data/lib/ruby_lsp/queue.rb

@@ -7,8 +7,6 @@ module RubyLsp
   class Queue
     extend T::Sig
 
-    class Cancelled < StandardError; end
-
     class Result < T::Struct
       const :response, T.untyped # rubocop:disable Sorbet/ForbidUntypedStructProps
       const :error, T.nilable(Exception)
@@ -40,8 +38,6 @@ module RubyLsp
       @job_queue = T.let(Thread::Queue.new, Thread::Queue)
       # The jobs hash is just a way of keeping a handle to jobs based on the request ID, so we can cancel them
       @jobs = T.let({}, T::Hash[T.any(String, Integer), Job])
-      # The current job is a handle to cancel jobs that are currently being processed
-      @current_job = T.let(nil, T.nilable(Job))
       @mutex = T.let(Mutex.new, Mutex)
       @worker = T.let(new_worker, Thread)
 
@@ -65,11 +61,6 @@ module RubyLsp
       @mutex.synchronize do
         # Cancel the job if it's still in the queue
         @jobs[id]&.cancel
-
-        # Cancel the job if we're in the middle of processing it
-        if @current_job&.request&.dig(:id) == id
-          @worker.raise(Cancelled)
-        end
       end
     end
 
@@ -92,8 +83,6 @@ module RubyLsp
 
       request_time = Benchmark.realtime do
         response = T.must(@handlers[request[:method]]).action.call(request)
-      rescue Cancelled
-        raise
       rescue StandardError, LoadError => e
         error = e
       end
@@ -109,25 +98,27 @@ module RubyLsp
       ).void
     end
     def finalize_request(result, request)
-      error = result.error
-      if error
-        T.must(@handlers[request[:method]]).error_handler&.call(error, request)
-
-        @writer.write(
-          id: request[:id],
-          error: {
-            code: LanguageServer::Protocol::Constant::ErrorCodes::INTERNAL_ERROR,
-            message: result.error.inspect,
-            data: request.to_json,
-          },
-        )
-      elsif result.response != Handler::VOID
-        @writer.write(id: request[:id], result: result.response)
-      end
+      @mutex.synchronize do
+        error = result.error
+        if error
+          T.must(@handlers[request[:method]]).error_handler&.call(error, request)
+
+          @writer.write(
+            id: request[:id],
+            error: {
+              code: LanguageServer::Protocol::Constant::ErrorCodes::INTERNAL_ERROR,
+              message: result.error.inspect,
+              data: request.to_json,
+            },
+          )
+        elsif result.response != Handler::VOID
+          @writer.write(id: request[:id], result: result.response)
+        end
 
-      request_time = result.request_time
-      if request_time
-        @writer.write(method: "telemetry/event", params: telemetry_params(request, request_time, result.error))
+        request_time = result.request_time
+        if request_time
+          @writer.write(method: "telemetry/event", params: telemetry_params(request, request_time, result.error))
+        end
       end
     end
 
@@ -139,28 +130,20 @@ module RubyLsp
         # Thread::Queue#pop is thread safe and will wait until an item is available
         loop do
           job = T.let(@job_queue.pop, T.nilable(Job))
-          break if job.nil?
-
           # The only time when the job is nil is when the queue is closed and we can then terminate the thread
+          break if job.nil?
 
           request = job.request
-          @mutex.synchronize do
-            @jobs.delete(request[:id])
-            @current_job = job
-          end
-
-          next if job.cancelled
+          @mutex.synchronize { @jobs.delete(request[:id]) }
 
-          result = execute(request)
-        rescue Cancelled
-          # We need to return nil to the client even if the request was cancelled
-          result = Queue::Result.new(response: nil, error: nil, request_time: nil)
-        ensure
-          @mutex.synchronize { @current_job = nil }
+          result = if job.cancelled
+            # We need to return nil to the client even if the request was cancelled
+            Queue::Result.new(response: nil, error: nil, request_time: nil)
+          else
+            execute(request)
+          end
 
-          # If there's request, it means the worker was cancelled while waiting to pop from the queue or immediately
-          # after
-          finalize_request(result, request) unless result.nil? || request.nil?
+          finalize_request(result, request)
         end
       end
     end

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

@@ -14,6 +14,8 @@ module RubyLsp
       class RuboCopRunner < RuboCop::Runner
         extend T::Sig
 
+        class ConfigurationError < StandardError; end
+
         sig { returns(T::Array[RuboCop::Cop::Offense]) }
         attr_reader :offenses
 
@@ -50,6 +52,8 @@ module RubyLsp
           super([path])
         rescue RuboCop::Runner::InfiniteCorrectionLoop => error
           raise Formatting::Error, error.message
+        rescue RuboCop::ValidationError => error
+          raise ConfigurationError, error.message
         end
 
         sig { returns(String) }

data/lib/ruby_lsp/server.rb

@@ -191,7 +191,7 @@ module RubyLsp
       Handler::VOID
     end
 
-    on("textDocument/diagnostic") do |request|
+    on("textDocument/diagnostic", parallel: true) do |request|
       uri = request.dig(:params, :textDocument, :uri)
       response = store.cache_fetch(uri, :diagnostics) do |document|
         Requests::Diagnostics.new(uri, document).run
@@ -199,9 +199,7 @@ module RubyLsp
 
       { kind: "full", items: response.map(&:to_lsp_diagnostic) } if response
     end.on_error do |error|
-      if error.is_a?(RuboCop::ValidationError)
-        show_message(Constant::MessageType::ERROR, "Error in RuboCop configuration file: #{error.message}")
-      end
+      show_message(Constant::MessageType::ERROR, "Error running diagnostics: #{error.message}")
     end
 
     on("shutdown") { shutdown }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-06 00:00:00.000000000 Z
+date: 2022-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: language_server-protocol