Allow users to disable test related code lenses (#3632)

Author: vinistock

lib/ruby_lsp/global_state.rb

@@ -62,6 +62,10 @@ def initialize
           implicitRescue: false,
           implicitHashValue: false,
         }),
+        codeLens: RequestConfig.new({
+          enableAll: false,
+          enableTestCodeLens: true,
+        }),
       } #: Hash[Symbol, RequestConfig]
     end
 

lib/ruby_lsp/requests/code_lens.rb

@@ -27,18 +27,22 @@ def initialize(global_state, document, dispatcher)
         @document = document
         @test_builder = ResponseBuilders::TestCollection.new #: ResponseBuilders::TestCollection
         uri = document.uri
+        code_lens_config = global_state.feature_configuration(:codeLens)
+        test_lenses_enabled = !code_lens_config || code_lens_config.enabled?(:enableTestCodeLens)
 
         if global_state.enabled_feature?(:fullTestDiscovery)
-          Listeners::TestStyle.new(@test_builder, global_state, dispatcher, uri)
-          Listeners::SpecStyle.new(@test_builder, global_state, dispatcher, uri)
+          if test_lenses_enabled
+            Listeners::TestStyle.new(@test_builder, global_state, dispatcher, uri)
+            Listeners::SpecStyle.new(@test_builder, global_state, dispatcher, uri)
+          end
         else
           Listeners::CodeLens.new(@response_builder, global_state, uri, dispatcher)
         end
 
         Addon.addons.each do |addon|
           addon.create_code_lens_listener(@response_builder, uri, dispatcher)
 
-          if global_state.enabled_feature?(:fullTestDiscovery)
+          if global_state.enabled_feature?(:fullTestDiscovery) && test_lenses_enabled
             addon.create_discover_tests_listener(@test_builder, dispatcher, uri)
           end
         end

test/requests/discover_tests_test.rb

@@ -216,6 +216,49 @@ class TestCase; end
       end
     end
 
+    def test_does_not_collect_code_lenses_when_disabled
+      source = <<~RUBY
+        module Foo
+          class MyTest < Test::Unit::TestCase
+            def test_something; end
+
+            def test_something_else; end
+          end
+        end
+      RUBY
+
+      with_server(source) do |server, uri|
+        server.global_state.index.index_single(URI("/other_file.rb"), <<~RUBY)
+          module Test
+            module Unit
+              class TestCase; end
+            end
+          end
+        RUBY
+
+        state = server.global_state
+        state.stubs(:enabled_feature?).returns(true)
+        state.apply_options({
+          initializationOptions: {
+            featuresConfiguration: {
+              codeLens: {
+                enableTestCodeLens: false,
+              },
+            },
+          },
+        })
+
+        server.process_message(id: 1, method: "textDocument/codeLens", params: {
+          textDocument: { uri: uri },
+        })
+
+        # Discard the indexing log message
+        server.pop_response
+        items = get_response(server)
+        assert_empty(items)
+      end
+    end
+
     def test_ignores_minitest_tests_that_extend_active_support_declarative
       source = <<~RUBY
         class MyTest < ActiveSupport::TestCase

vscode/package.json

@@ -342,6 +342,20 @@
                   "type": "boolean"
                 }
               }
+            },
+            "codeLens": {
+              "description": "Customize code lens features",
+              "type": "object",
+              "properties": {
+                "enableAll": {
+                  "type": "boolean"
+                },
+                "enableTestCodeLens": {
+                  "description": "Enable the run, run in terminal, debug code and other test related code lenses",
+                  "type": "boolean",
+                  "default": true
+                }
+              }
             }
           }
         },