wip

Author: andyw8

README.md

@@ -52,16 +52,9 @@ See the [documentation](https://shopify.github.io/ruby-lsp-rails) for more in-de
 
 ## How It Works
 
-This gem consists of two components that enable enhanced Rails functionality in the editor:
-
-1. A Rack app that automatically exposes APIs when Rails server is running
-1. A Ruby LSP addon that connects to the exposed APIs to fetch runtime information from the Rails server
-
-This is why the Rails server needs to be running for some features to work.
-
-> [!NOTE]
-> There is no need to restart the Ruby LSP every time the Rails server is booted.
-> If the server is shut down, the extra features will temporarily disappear and reappear once the server is running again.
+When Ruby LSP Rails starts, it spawns a `rails runner` instance which runs
+`[server.rb](https://github.com/Shopify/ruby-lsp-rails/blob/main/lib/ruby_lsp/ruby_lsp_rails/server.rb)`.
+The addon communicates with this process over a pipe (i.e. stdin/stdout) to fetch runtime information about the Rails application.
 
 ## Contributing
 

lib/ruby_lsp/ruby_lsp_rails/addon.rb

@@ -3,7 +3,7 @@
 
 require "ruby_lsp/addon"
 
-require_relative "rails_client"
+require_relative "runner_client"
 require_relative "hover"
 require_relative "code_lens"
 
@@ -12,18 +12,20 @@ module Rails
     class Addon < ::RubyLsp::Addon
       extend T::Sig
 
-      sig { returns(RailsClient) }
+      sig { returns(RunnerClient) }
       def client
-        @client ||= T.let(RailsClient.new, T.nilable(RailsClient))
+        @client ||= T.let(RunnerClient.new, T.nilable(RunnerClient))
       end
 
       sig { override.params(message_queue: Thread::Queue).void }
       def activate(message_queue)
-        client.check_if_server_is_running!
+        # @client ||= T.let(RunnerClient.new, T.nilable(RunnerClient))
       end
 
       sig { override.void }
-      def deactivate; end
+      def deactivate
+        T.must(@client).shutdown
+      end
 
       # Creates a new CodeLens listener. This method is invoked on every CodeLens request
       sig do

lib/ruby_lsp/ruby_lsp_rails/hover.rb

@@ -22,7 +22,7 @@ class Hover
 
       sig do
         params(
-          client: RailsClient,
+          client: RunnerClient,
           response_builder: ResponseBuilders::Hover,
           nesting: T::Array[String],
           index: RubyIndexer::Index,

lib/ruby_lsp_rails/rack_app.rb

@@ -2,34 +2,23 @@
 # frozen_string_literal: true
 
 require "rails"
-require "ruby_lsp_rails/rack_app"
 
 module RubyLsp
   module Rails
     class Railtie < ::Rails::Railtie
       config.ruby_lsp_rails = ActiveSupport::OrderedOptions.new
-      config.ruby_lsp_rails.server = true
+      # TODO: should we allow the runner to be enabled/disabled?
+      # config.ruby_lsp_rails.runner = true
 
       initializer "ruby_lsp_rails.setup" do |_app|
-        config.after_initialize do |app|
-          # If we start the app with `bin/rails console` then `Rails::Server` is not defined.
-          if defined?(::Rails::Server) && config.ruby_lsp_rails.server
-            app.routes.prepend do
-              T.bind(self, ActionDispatch::Routing::Mapper)
-              mount(RackApp.new => RackApp::BASE_PATH)
-            end
-
-            ssl_enable, host, port = ::Rails::Server::Options.new.parse!(ARGV).values_at(:SSLEnable, :Host, :Port)
-            app_uri = "#{ssl_enable ? "https" : "http"}://#{host}:#{port}"
-            app_uri_path = ::Rails.root.join("tmp", "app_uri.txt")
-            app_uri_path.write(app_uri)
+        config.after_initialize do |_app|
+          if config.ruby_lsp_rails.server
+            # TODO: confirm text
+            raise "The `config.ruby_lsp_rails.server` configuration option is no longer needed"
+          end
 
-            at_exit do
-              # The app_uri.txt file should only exist when the server is running. The addon uses its presence to
-              # report if the server is running or not. If the server is not running, some of the addon features
-              # will not be available.
-              File.delete(app_uri_path) if File.exist?(app_uri_path)
-            end
+          at_exit do
+            # TBC
           end
         end
       end