Preperation for server addons (#440)

Author: Andy Waite

lib/ruby_lsp/ruby_lsp_rails/addon.rb

@@ -26,23 +26,27 @@ def initialize
 
         # We first initialize the client as a NullClient, so that we can start the server in a background thread. Until
         # the real client is initialized, features that depend on it will not be blocked by using the NullClient
-        @client = T.let(NullClient.new, RunnerClient)
+        @rails_runner_client = T.let(NullClient.new, RunnerClient)
+        @global_state = T.let(nil, T.nilable(GlobalState))
       end
 
+      sig { returns(RunnerClient) }
+      attr_reader :rails_runner_client
+
       sig { override.params(global_state: GlobalState, message_queue: Thread::Queue).void }
       def activate(global_state, message_queue)
-        @global_state = T.let(global_state, T.nilable(RubyLsp::GlobalState))
+        @global_state = global_state
         $stderr.puts("Activating Ruby LSP Rails addon v#{VERSION}")
         # Start booting the real client in a background thread. Until this completes, the client will be a NullClient
-        Thread.new { @client = RunnerClient.create_client }
+        Thread.new { @rails_runner_client = RunnerClient.create_client }
         register_additional_file_watchers(global_state: global_state, message_queue: message_queue)
 
-        T.must(@global_state).index.register_enhancement(IndexingEnhancement.new)
+        @global_state.index.register_enhancement(IndexingEnhancement.new)
       end
 
       sig { override.void }
       def deactivate
-        @client.shutdown
+        @rails_runner_client.shutdown
       end
 
       # Creates a new CodeLens listener. This method is invoked on every CodeLens request
@@ -54,7 +58,7 @@ def deactivate
         ).void
       end
       def create_code_lens_listener(response_builder, uri, dispatcher)
-        CodeLens.new(@client, T.must(@global_state), response_builder, uri, dispatcher)
+        CodeLens.new(@rails_runner_client, T.must(@global_state), response_builder, uri, dispatcher)
       end
 
       sig do
@@ -65,7 +69,7 @@ def create_code_lens_listener(response_builder, uri, dispatcher)
         ).void
       end
       def create_hover_listener(response_builder, node_context, dispatcher)
-        Hover.new(@client, response_builder, node_context, T.must(@global_state), dispatcher)
+        Hover.new(@rails_runner_client, response_builder, node_context, T.must(@global_state), dispatcher)
       end
 
       sig do
@@ -90,15 +94,15 @@ def create_document_symbol_listener(response_builder, dispatcher)
       end
       def create_definition_listener(response_builder, uri, node_context, dispatcher)
         index = T.must(@global_state).index
-        Definition.new(@client, response_builder, node_context, index, dispatcher)
+        Definition.new(@rails_runner_client, response_builder, node_context, index, dispatcher)
       end
 
       sig { params(changes: T::Array[{ uri: String, type: Integer }]).void }
       def workspace_did_change_watched_files(changes)
         if changes.any? do |change|
              change[:uri].end_with?("db/schema.rb") || change[:uri].end_with?("structure.sql")
            end
-          @client.trigger_reload
+          @rails_runner_client.trigger_reload
         end
       end
 

lib/ruby_lsp/ruby_lsp_rails/runner_client.rb

@@ -63,8 +63,11 @@ def initialize
         @stdout = T.let(stdout, IO)
         @stderr = T.let(stderr, IO)
         @wait_thread = T.let(wait_thread, Process::Waiter)
-        @stdin.binmode # for Windows compatibility
-        @stdout.binmode # for Windows compatibility
+
+        # We set binmode for Windows compatibility
+        @stdin.binmode
+        @stdout.binmode
+        @stderr.binmode
 
         $stderr.puts("Ruby LSP Rails booting server")
         count = 0
@@ -158,8 +161,6 @@ def stopped?
         [@stdin, @stdout, @stderr].all?(&:closed?) && !@wait_thread.alive?
       end
 
-      private
-
       sig do
         params(
           request: String,
@@ -171,6 +172,12 @@ def make_request(request, params = nil)
         read_response
       end
 
+      # Notifications are like messages, but one-way, with no response sent back.
+      sig { params(request: String, params: T.nilable(T::Hash[Symbol, T.untyped])).void }
+      def send_notification(request, params = nil) = send_message(request, params)
+
+      private
+
       sig { overridable.params(request: String, params: T.nilable(T::Hash[Symbol, T.untyped])).void }
       def send_message(request, params = nil)
         message = { method: request }
@@ -184,10 +191,6 @@ def send_message(request, params = nil)
         # The server connection died
       end
 
-      # Notifications are like messages, but one-way, with no response sent back.
-      sig { params(request: String, params: T.nilable(T::Hash[Symbol, T.untyped])).void }
-      def send_notification(request, params = nil) = send_message(request, params)
-
       sig { overridable.returns(T.nilable(T::Hash[Symbol, T.untyped])) }
       def read_response
         raw_response = @mutex.synchronize do

test/ruby_lsp_rails/code_lens_test.rb

@@ -384,7 +384,7 @@ def index
 
       def generate_code_lens_for_source(source, file: "/fake.rb")
         with_server(source, URI(file)) do |server, uri|
-          sleep(0.1) while RubyLsp::Addon.addons.first.instance_variable_get(:@client).is_a?(NullClient)
+          sleep(0.1) while RubyLsp::Addon.addons.first.instance_variable_get(:@rails_runner_client).is_a?(NullClient)
 
           server.process_message(
             id: 1,

test/ruby_lsp_rails/definition_test.rb

@@ -225,7 +225,7 @@ def baz; end
 
       def generate_definitions_for_source(source, position)
         with_server(source) do |server, uri|
-          sleep(0.1) while RubyLsp::Addon.addons.first.instance_variable_get(:@client).is_a?(NullClient)
+          sleep(0.1) while RubyLsp::Addon.addons.first.instance_variable_get(:@rails_runner_client).is_a?(NullClient)
 
           server.process_message(
             id: 1,