Support Ruby LSP's full test discovery feature (#62)

* WIP

* Implement RSpec command resolution

* Support streaming RSpec results

* Generate ids purely based on locations

This makes sure that we can always match the ids
even for anonymous examples.

* Add tests for the rspec formatter

* Don't fail fast on CI

* Allow RSpecFormatter to not have typed: strict

* Requires ruby-lsp 0.23.17

For Shopify/ruby-lsp#3452

Author: st0012

.github/workflows/main.yml

@@ -12,6 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     name: Ruby ${{ matrix.ruby }}
     strategy:
+      fail-fast: false
       matrix:
         ruby:
           - "3.4"

.rspec

@@ -1,3 +1,4 @@
 --format documentation
 --color
 --require spec_helper
+--exclude-pattern **/fixtures/*

.rubocop.yml

@@ -32,6 +32,7 @@ Sorbet/StrictSigil:
     - "lib/**/*.rb"
   Exclude:
     - "**/*.rake"
+    - "lib/ruby_lsp/ruby_lsp_rspec/rspec_formatter.rb"
     - "spec/**/*.rb"
 
 Style/StderrPuts:

Gemfile.lock

@@ -2,7 +2,7 @@ PATH
   remote: .
   specs:
     ruby-lsp-rspec (0.1.22)
-      ruby-lsp (~> 0.23.0)
+      ruby-lsp (~> 0.23.17)
 
 GEM
   remote: https://rubygems.org/
@@ -43,7 +43,7 @@ GEM
       prism (~> 1.0)
       rbs (>= 3.4.4)
       sorbet-runtime (>= 0.5.9204)
-    rbs (3.9.2)
+    rbs (3.9.3)
       logger
     rdoc (6.13.1)
       psych (>= 4.0.0)
@@ -83,20 +83,20 @@ GEM
       rubocop (~> 1.62)
     rubocop-sorbet (0.10.0)
       rubocop (>= 1)
-    ruby-lsp (0.23.15)
+    ruby-lsp (0.23.17)
       language_server-protocol (~> 3.17.0)
       prism (>= 1.2, < 2.0)
       rbs (>= 3, < 4)
       sorbet-runtime (>= 0.5.10782)
     ruby-progressbar (1.13.0)
-    sorbet (0.5.12043)
-      sorbet-static (= 0.5.12043)
-    sorbet-runtime (0.5.12043)
-    sorbet-static (0.5.12043-universal-darwin)
-    sorbet-static (0.5.12043-x86_64-linux)
-    sorbet-static-and-runtime (0.5.12043)
-      sorbet (= 0.5.12043)
-      sorbet-runtime (= 0.5.12043)
+    sorbet (0.5.12048)
+      sorbet-static (= 0.5.12048)
+    sorbet-runtime (0.5.12048)
+    sorbet-static (0.5.12048-universal-darwin)
+    sorbet-static (0.5.12048-x86_64-linux)
+    sorbet-static-and-runtime (0.5.12048)
+      sorbet (= 0.5.12048)
+      sorbet-runtime (= 0.5.12048)
     spoom (1.6.1)
       erubi (>= 1.10.0)
       prism (>= 0.28.0)

lib/ruby_lsp/ruby_lsp_rspec/addon.rb

@@ -8,12 +8,17 @@
 require_relative "document_symbol"
 require_relative "definition"
 require_relative "indexing_enhancement"
+require_relative "test_discovery"
+require_relative "spec_style_patch"
 
 module RubyLsp
   module RSpec
     class Addon < ::RubyLsp::Addon
       extend T::Sig
 
+      FORMATTER_PATH = T.let(File.expand_path("rspec_formatter.rb", __dir__), String)
+      FORMATTER_NAME = T.let("RubyLsp::RSpec::RSpecFormatter", String)
+
       sig { returns(T::Boolean) }
       attr_reader :debug
 
@@ -30,12 +35,18 @@ def activate(global_state, message_queue)
 
         settings = global_state.settings_for_addon(name)
         @rspec_command = rspec_command(settings)
+        @workspace_path = T.let(global_state.workspace_path, T.nilable(String))
         @debug = settings&.dig(:debug) || false
       end
 
       sig { override.void }
       def deactivate; end
 
+      sig { override.returns(String) }
+      def name
+        "ruby-lsp-rspec"
+      end
+
       sig { override.returns(String) }
       def version
         VERSION
@@ -55,6 +66,68 @@ def create_code_lens_listener(response_builder, uri, dispatcher)
         CodeLens.new(response_builder, uri, dispatcher, T.must(@rspec_command), debug: debug)
       end
 
+      # Creates a new Discover Tests listener. This method is invoked on every DiscoverTests request
+      sig do
+        override.params(
+          response_builder: ResponseBuilders::TestCollection,
+          dispatcher: Prism::Dispatcher,
+          uri: URI::Generic,
+        ).void
+      end
+      def create_discover_tests_listener(response_builder, dispatcher, uri)
+        return unless uri.to_standardized_path&.end_with?("_spec.rb")
+
+        TestDiscovery.new(response_builder, dispatcher, uri, T.must(@workspace_path))
+      end
+
+      # Resolves the minimal set of commands required to execute the requested tests
+      sig do
+        override.params(
+          items: T::Array[T::Hash[Symbol, T.untyped]],
+        ).returns(T::Array[String])
+      end
+      def resolve_test_commands(items)
+        commands = []
+        queue = items.dup
+
+        full_files = []
+
+        until queue.empty?
+          item = T.must(queue.shift)
+          tags = Set.new(item[:tags])
+          next unless tags.include?("framework:rspec")
+
+          children = item[:children]
+          uri = URI(item[:uri])
+          path = uri.full_path
+          next unless path
+
+          if tags.include?("test_dir")
+            if children.empty?
+              full_files.concat(Dir.glob(
+                "#{path}/**/*_spec.rb",
+                File::Constants::FNM_EXTGLOB | File::Constants::FNM_PATHNAME,
+              ))
+            end
+          elsif tags.include?("test_file")
+            full_files << path if children.empty?
+          elsif tags.include?("test_group")
+            start_line = item.dig(:range, :start, :line)
+            commands << "#{@rspec_command} -r #{FORMATTER_PATH} -f #{FORMATTER_NAME} #{path}:#{start_line + 1}"
+          else
+            full_files << "#{path}:#{item.dig(:range, :start, :line) + 1}"
+          end
+
+          queue.concat(children)
+        end
+
+        unless full_files.empty?
+          commands << "#{@rspec_command} -r #{FORMATTER_PATH} -f #{FORMATTER_NAME} #{full_files.join(" ")}"
+        end
+
+        commands
+      end
+
       sig do
         override.params(
           response_builder: ResponseBuilders::DocumentSymbol,
@@ -67,10 +140,7 @@ def create_document_symbol_listener(response_builder, dispatcher)
 
       sig do
         override.params(
-          response_builder: ResponseBuilders::CollectionResponseBuilder[T.any(
-            Interface::Location,
-            Interface::LocationLink,
-          )],
+          response_builder: ResponseBuilders::CollectionResponseBuilder[T.any(Interface::Location, Interface::LocationLink)],
           uri: URI::Generic,
           node_context: NodeContext,
           dispatcher: Prism::Dispatcher,
@@ -82,10 +152,7 @@ def create_definition_listener(response_builder, uri, node_context, dispatcher)
         Definition.new(response_builder, uri, node_context, T.must(@index), dispatcher)
       end
 
-      sig { override.returns(String) }
-      def name
-        "Ruby LSP RSpec"
-      end
+      private
 
       sig { params(settings: T.nilable(T::Hash[Symbol, T.untyped])).returns(String) }
       def rspec_command(settings)

lib/ruby_lsp/ruby_lsp_rspec/rspec_formatter.rb

@@ -0,0 +1,65 @@
+# typed: true
+# frozen_string_literal: true
+
+require "rspec/core/formatters"
+require "ruby_lsp/test_reporters/lsp_reporter"
+
+module RubyLsp
+  module RSpec
+    class RSpecFormatter
+      ::RSpec::Core::Formatters.register(
+        self,
+        :example_passed,
+        :example_pending,
+        :example_failed,
+        :example_started,
+        :stop,
+      )
+
+      def initialize(output)
+        @output = output
+      end
+
+      def example_started(notification)
+        example = notification.example
+        uri = uri_for(example)
+        id = generate_id(example)
+        RubyLsp::LspReporter.instance.start_test(id: id, uri: uri)
+      end
+
+      def example_passed(notification)
+        example = notification.example
+        uri = uri_for(example)
+        id = generate_id(example)
+        RubyLsp::LspReporter.instance.record_pass(id: id, uri: uri)
+      end
+
+      def example_failed(notification)
+        example = notification.example
+        uri = uri_for(example)
+        id = generate_id(example)
+        RubyLsp::LspReporter.instance.record_fail(id: id, message: notification.exception.message, uri: uri)
+      end
+
+      def example_pending(notification)
+        example = notification.example
+        uri = uri_for(example)
+        id = generate_id(example)
+        RubyLsp::LspReporter.instance.record_skip(id: id, uri: uri)
+      end
+
+      def stop(notification)
+        RubyLsp::LspReporter.instance.shutdown
+      end
+
+      def uri_for(example)
+        absolute_path = File.expand_path(example.file_path)
+        URI::Generic.from_path(path: absolute_path)
+      end
+
+      def generate_id(example)
+        [example, *example.example_group.parent_groups].reverse.map(&:location).join("::")
+      end
+    end
+  end
+end

lib/ruby_lsp/ruby_lsp_rspec/spec_style_patch.rb

@@ -0,0 +1,16 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RubyLsp
+  module Listeners
+    # Patching this listener so it doesn't generate test items for RSpec tests
+    class SpecStyle
+      extend T::Sig
+
+      sig { params(response_builder: ResponseBuilders::TestCollection, global_state: GlobalState, dispatcher: Prism::Dispatcher, uri: URI::Generic).void }
+      def initialize(response_builder, global_state, dispatcher, uri)
+        super
+      end
+    end
+  end
+end