ruby-lsp 0.4.5 → 0.5.0

data/lib/ruby_lsp/server.rb

@@ -23,7 +23,32 @@ module RubyLsp
       @jobs = T.let({}, T::Hash[T.any(String, Integer), Job])
       @mutex = T.let(Mutex.new, Mutex)
       @worker = T.let(new_worker, Thread)
-      @current_request_id = T.let(1, Integer)
+
+      # The messages queue includes requests and notifications to be sent to the client
+      @message_queue = T.let(Thread::Queue.new, Thread::Queue)
+
+      # Create a thread to watch the messages queue and send them to the client
+      @message_dispatcher = T.let(
+        Thread.new do
+          current_request_id = 1
+
+          loop do
+            message = @message_queue.pop
+            break if message.nil?
+
+            @mutex.synchronize do
+              case message
+              when Notification
+                @writer.write(method: message.message, params: message.params)
+              when Request
+                @writer.write(id: current_request_id, method: message.message, params: message.params)
+                current_request_id += 1
+              end
+            end
+          end
+        end,
+        Thread,
+      )
 
       Thread.main.priority = 1
     end
@@ -36,9 +61,8 @@ module RubyLsp
       # fall under the else branch which just pushes requests to the queue
       @reader.read do |request|
         case request[:method]
-        when "initialize", "initialized", "textDocument/didOpen", "textDocument/didClose", "textDocument/didChange",
-              "textDocument/formatting", "textDocument/onTypeFormatting", "codeAction/resolve"
-          result = Executor.new(@store).execute(request)
+        when "initialize", "initialized", "textDocument/didOpen", "textDocument/didClose", "textDocument/didChange"
+          result = Executor.new(@store, @message_queue).execute(request)
           finalize_request(result, request)
         when "$/cancelRequest"
           # Cancel the job if it's still in the queue
@@ -46,6 +70,7 @@ module RubyLsp
         when "shutdown"
           warn("Shutting down Ruby LSP...")
 
+          @message_queue.close
           # Close the queue so that we can no longer receive items
           @job_queue.close
           # Clear any remaining jobs so that the thread can terminate
@@ -53,9 +78,10 @@ module RubyLsp
           @jobs.clear
           # Wait until the thread is finished
           @worker.join
+          @message_dispatcher.join
           @store.clear
 
-          finalize_request(Result.new(response: nil, messages: []), request)
+          finalize_request(Result.new(response: nil), request)
         when "exit"
           # We return zero if shutdown has already been received or one otherwise as per the recommendation in the spec
           # https://microsoft.github.io/language-server-protocol/specification/#exit
@@ -66,8 +92,17 @@ module RubyLsp
           # Default case: push the request to the queue to be executed by the worker
           job = Job.new(request: request, cancelled: false)
 
-          # Remember a handle to the job, so that we can cancel it
-          @mutex.synchronize { @jobs[request[:id]] = job }
+          @mutex.synchronize do
+            # Remember a handle to the job, so that we can cancel it
+            @jobs[request[:id]] = job
+
+            # We must parse the document under a mutex lock or else we might switch threads and accept text edits in the
+            # source. Altering the source reference during parsing will put the parser in an invalid internal state,
+            # since it started parsing with one source but then it changed in the middle
+            uri = request.dig(:params, :textDocument, :uri)
+            @store.get(uri).parse if uri
+          end
+
           @job_queue << job
         end
       end
@@ -89,9 +124,9 @@ module RubyLsp
 
           result = if job.cancelled
             # We need to return nil to the client even if the request was cancelled
-            Result.new(response: nil, messages: [])
+            Result.new(response: nil)
           else
-            Executor.new(@store).execute(request)
+            Executor.new(@store, @message_queue).execute(request)
           end
 
           finalize_request(result, request)
@@ -119,17 +154,6 @@ module RubyLsp
           @writer.write(id: request[:id], result: response)
         end
 
-        # If the response include any messages, go through them and publish each one
-        result.messages.each do |n|
-          case n
-          when Notification
-            @writer.write(method: n.message, params: n.params)
-          when Request
-            @writer.write(id: @current_request_id, method: n.message, params: n.params)
-            @current_request_id += 1
-          end
-        end
-
         request_time = result.request_time
         if request_time
           @writer.write(method: "telemetry/event", params: telemetry_params(request, request_time, error))

data/lib/ruby_lsp/store.rb

@@ -61,7 +61,7 @@ module RubyLsp
       type_parameters(:T)
         .params(
           uri: String,
-          request_name: Symbol,
+          request_name: String,
           block: T.proc.params(document: Document).returns(T.type_parameter(:T)),
         ).returns(T.type_parameter(:T))
     end

data/lib/ruby_lsp/utils.rb

@@ -6,7 +6,7 @@ module RubyLsp
   VOID = T.let(Object.new.freeze, Object)
 
   # This freeze is not redundant since the interpolated string is mutable
-  WORKSPACE_URI = T.let("file://#{Dir.pwd}".freeze, String) # rubocop:disable Style/RedundantFreeze
+  WORKSPACE_URI = T.let(URI("file://#{Dir.pwd}".freeze), URI::Generic) # rubocop:disable Style/RedundantFreeze
 
   # A notification to be sent to the client
   class Message
@@ -38,9 +38,6 @@ module RubyLsp
     sig { returns(T.untyped) }
     attr_reader :response
 
-    sig { returns(T::Array[Message]) }
-    attr_reader :messages
-
     sig { returns(T.nilable(Exception)) }
     attr_reader :error
 
@@ -50,14 +47,12 @@ module RubyLsp
     sig do
       params(
         response: T.untyped,
-        messages: T::Array[Message],
         error: T.nilable(Exception),
         request_time: T.nilable(Float),
       ).void
     end
-    def initialize(response:, messages:, error: nil, request_time: nil)
+    def initialize(response:, error: nil, request_time: nil)
       @response = response
-      @messages = messages
       @error = error
       @request_time = request_time
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.5.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-21 00:00:00.000000000 Z
+date: 2023-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: language_server-protocol
@@ -72,6 +72,7 @@ files:
 - exe/ruby-lsp
 - lib/rubocop/cop/ruby_lsp/use_language_server_aliases.rb
 - lib/ruby-lsp.rb
+- lib/ruby_lsp/check_docs.rb
 - lib/ruby_lsp/document.rb
 - lib/ruby_lsp/event_emitter.rb
 - lib/ruby_lsp/executor.rb