ruby-lsp-rails 0.2.10 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41272ca8c9212dc08dc09beeef481c282656946e182e0c62c72585ecc6cfe658
-  data.tar.gz: 0dc3c80ab252123291ab7b77a02b22fff1f27dd5bc07eb49ea51dfdbff4310f2
+  metadata.gz: ecc8c1b4cd4569bdb9c816f842a90f0dfb1122931adcd9c96d1e2eb8a3799471
+  data.tar.gz: 3c1bcc4f69a361ae6a26b635331f6475413fed38bac9a88c7ed45ffea02129eb
 SHA512:
-  metadata.gz: fb753c4c3a4282faeefbd254840be186969179e6eaff83320a79e6fd5d2149e4d35acd68f7c38d8bd436e07b233f5e3cebf553c53317576333b83c4b81582dc0
-  data.tar.gz: 881b3d77f931f890ed68a12b478b7762ea491165e70c4cd61af078eccdeb139c28d9f9eed83406b7fa01927e6b0ea3a07993e0d73ae4c0eede146c6fb124a4aa
+  metadata.gz: eff545775dfa463c99b301a94ab450070f683d3f70a3c974683ac1b311a53d10da57acbd051a6fd0e4c8b005629c1d18bd8d61e33c94548e2fcf2b22b70df606
+  data.tar.gz: 927c991dc2d499be19c626b4a64cfcc11064f2bbadad41abb71ebea13e1e33592810c7fe6135393d7a1c2140d760e8518eee085d3a2d596942af5e031ff8f272

data/README.md

@@ -52,16 +52,15 @@ 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:
+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` and `stdout`) to fetch runtime information about the application.
 
-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.
+When extension is stopped (e.g. by quitting the editor), the server instance is shut down.
 
 > [!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.
+> Prior to v0.3, `ruby-lsp-rails` used a different approach which involved mounting a Rack application within the Rails app.
+> That approach was brittle and susceptible to the application's configuration, such as routing and middleware.
 
 ## Contributing
 

data/lib/ruby-lsp-rails.rb

@@ -1,9 +1,6 @@
 # typed: strict
 # frozen_string_literal: true
 
-require "sorbet-runtime"
-require "pathname"
-
 require "ruby_lsp_rails/version"
 require "ruby_lsp_rails/railtie"
 

data/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,18 @@ module RubyLsp
     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!
-      end
+      def activate(message_queue); end
 
       sig { override.void }
-      def deactivate; end
+      def deactivate
+        client.shutdown
+      end
 
       # Creates a new CodeLens listener. This method is invoked on every CodeLens request
       sig do

data/lib/ruby_lsp/ruby_lsp_rails/hover.rb

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

data/lib/ruby_lsp_rails/railtie.rb

@@ -2,34 +2,17 @@
 # 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
 
       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)
-
-            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
+        config.after_initialize do |_app|
+          unless config.ruby_lsp_rails.server.nil?
+            ActiveSupport::Deprecation.new.warn("The `ruby_lsp_rails.server` configuration option is no longer " \
+              "needed and will be removed in a future release.")
           end
         end
       end

data/lib/ruby_lsp_rails/version.rb

@@ -3,6 +3,6 @@
 
 module RubyLsp
   module Rails
-    VERSION = "0.2.10"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.10
+  version: 0.3.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-13 00:00:00.000000000 Z
+date: 2024-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -100,11 +100,9 @@ files:
 - lib/ruby_lsp/ruby_lsp_rails/addon.rb
 - lib/ruby_lsp/ruby_lsp_rails/code_lens.rb
 - lib/ruby_lsp/ruby_lsp_rails/hover.rb
-- lib/ruby_lsp/ruby_lsp_rails/rails_client.rb
 - lib/ruby_lsp/ruby_lsp_rails/runner_client.rb
 - lib/ruby_lsp/ruby_lsp_rails/server.rb
 - lib/ruby_lsp/ruby_lsp_rails/support/rails_document_client.rb
-- lib/ruby_lsp_rails/rack_app.rb
 - lib/ruby_lsp_rails/railtie.rb
 - lib/ruby_lsp_rails/version.rb
 - lib/tasks/ruby_lsp_rails_tasks.rake

data/lib/ruby_lsp/ruby_lsp_rails/rails_client.rb

@@ -1,77 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-require "net/http"
-
-module RubyLsp
-  module Rails
-    class RailsClient
-      class ServerAddressUnknown < StandardError; end
-
-      extend T::Sig
-
-      SERVER_NOT_RUNNING_MESSAGE = "Rails server is not running. " \
-        "To get Rails features in the editor, boot the Rails server"
-
-      sig { returns(Pathname) }
-      attr_reader :root
-
-      sig { void }
-      def initialize
-        project_root = T.let(Bundler.with_unbundled_env { Bundler.default_gemfile }.dirname, Pathname)
-        dummy_path = project_root.join("test", "dummy")
-
-        @root = T.let(dummy_path.exist? ? dummy_path : project_root, Pathname)
-        app_uri_path = @root.join("tmp", "app_uri.txt")
-
-        if app_uri_path.exist?
-          url = URI(app_uri_path.read.chomp)
-
-          @ssl = T.let(url.scheme == "https", T::Boolean)
-          @address = T.let(
-            [url.host, url.path].reject { |component| component.nil? || component.empty? }.join("/"),
-            T.nilable(String),
-          )
-          @port = T.let(T.must(url.port).to_i, Integer)
-        end
-      end
-
-      sig { params(name: String).returns(T.nilable(T::Hash[Symbol, T.untyped])) }
-      def model(name)
-        response = request("models/#{name}")
-        return unless response.code == "200"
-
-        JSON.parse(response.body.chomp, symbolize_names: true)
-      rescue Errno::ECONNREFUSED,
-             Errno::EADDRNOTAVAIL,
-             Errno::ECONNRESET,
-             Net::ReadTimeout,
-             Net::OpenTimeout,
-             ServerAddressUnknown
-        nil
-      end
-
-      sig { void }
-      def check_if_server_is_running!
-        request("activate", 0.2)
-      rescue Errno::ECONNREFUSED, Errno::EADDRNOTAVAIL, Errno::ECONNRESET, ServerAddressUnknown
-        warn(SERVER_NOT_RUNNING_MESSAGE)
-      rescue Net::ReadTimeout, Net::OpenTimeout
-        # If the server is running, but the initial request is taking too long, we don't want to block the
-        # initialization of the Ruby LSP
-      end
-
-      private
-
-      sig { params(path: String, timeout: T.nilable(Float)).returns(Net::HTTPResponse) }
-      def request(path, timeout = nil)
-        raise ServerAddressUnknown unless @address
-
-        http = Net::HTTP.new(@address, @port)
-        http.use_ssl = @ssl
-        http.read_timeout = timeout if timeout
-        http.get("/ruby_lsp_rails/#{path}")
-      end
-    end
-  end
-end

data/lib/ruby_lsp_rails/rack_app.rb

@@ -1,58 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-module RubyLsp
-  module Rails
-    class RackApp
-      extend T::Sig
-
-      BASE_PATH = "/ruby_lsp_rails/"
-
-      sig { params(env: T::Hash[T.untyped, T.untyped]).returns(T::Array[T.untyped]) }
-      def call(env)
-        request = ActionDispatch::Request.new(env)
-        path = request.path
-
-        route, argument = path.delete_prefix(BASE_PATH).split("/")
-
-        case route
-        when "activate"
-          [200, { "Content-Type" => "application/json" }, []]
-        when "models"
-          resolve_database_info_from_model(argument)
-        else
-          not_found
-        end
-      end
-
-      private
-
-      sig { params(model_name: String).returns(T::Array[T.untyped]) }
-      def resolve_database_info_from_model(model_name)
-        const = ActiveSupport::Inflector.safe_constantize(model_name)
-
-        if const && const < ActiveRecord::Base && !const.abstract_class?
-          begin
-            schema_file = ActiveRecord::Tasks::DatabaseTasks.schema_dump_path(const.connection.pool.db_config)
-          rescue => e
-            warn("Could not locate schema: #{e.message}")
-          end
-
-          body = JSON.dump({
-            columns: const.columns.map { |column| [column.name, column.type] },
-            schema_file: schema_file,
-          })
-
-          [200, { "Content-Type" => "application/json" }, [body]]
-        else
-          not_found
-        end
-      end
-
-      sig { returns(T::Array[T.untyped]) }
-      def not_found
-        [404, { "Content-Type" => "text/plain" }, ["Not Found"]]
-      end
-    end
-  end
-end