Add discover tests custom request #3180

vinistock · 2025-02-11T20:15:21Z

Motivation

Add a new custom request to discover tests in a specific document. This request will instantiate all listeners and collect all of the discovered groups and examples as test items for the editor.

Implementation

Created the new request
Implement a listener dedicated to the test style syntax only (spec will be a separate listener)
Ensured to use ancestor linearization to determine the test framework

Automated Tests

Added tests.

vinistock · 2025-02-11T20:21:34Z

How to use the Graphite Merge Queue

Add the label graphite-merge to this PR to add it to the merge queue.

You must have a Graphite account in order to use the merge queue. Sign up using this link.

_{An organization admin has enabled the Graphite Merge Queue in this repository.} _{Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.}

This stack of pull requests is managed by Graphite. Learn more about stacking.

lib/ruby_indexer/lib/ruby_indexer/index.rb

graphite-app · 2025-02-13T19:32:55Z

Merge activity

Feb 13, 2:32 PM EST: A user added this pull request to the Graphite merge queue.
Feb 13, 2:42 PM EST: The Graphite merge queue couldn't merge this PR because it was not satisfying all requirements (Failed CI: 'Ruby 3.2 on macos-latest').

### Motivation Closes #3171 Add a new custom request to discover tests in a specific document. This request will instantiate all listeners and collect all of the discovered groups and examples as test items for the editor. ### Implementation - Created the new request - Implement a listener dedicated to the test style syntax only (spec will be a separate listener) - Ensured to use ancestor linearization to determine the test framework ### Automated Tests Added tests.

* Add discover tests custom request (#3180) ### Motivation Closes #3171 Add a new custom request to discover tests in a specific document. This request will instantiate all listeners and collect all of the discovered groups and examples as test items for the editor. ### Implementation - Created the new request - Implement a listener dedicated to the test style syntax only (spec will be a separate listener) - Ensured to use ancestor linearization to determine the test framework ### Automated Tests Added tests. * Resolve test items with server request (#3186) ### Motivation Closes #3173 Start firing our new custom request to discover which tests are available in a given file. ### Implementation We fire the request and then recursively add test items to their respective collections. If a document is saved, we check to see if we created a test item for it and then we clear its children (the tests defined inside of the file) and re-trigger the request. I chose to use on save because on change would put a lot of pressure on the server. ### Automated Tests Added tests. --------- Co-authored-by: vinistock <[email protected]>

andyw8

I had started reviewing before it was merged but there's nothing critcal.

andyw8 · 2025-02-13T19:42:35Z

lib/ruby_lsp/listeners/test_style.rb

+
+      sig { params(node: Prism::ClassNode).void }
+      def on_class_node_enter(node)
+        @visibility_stack << :public


Any reason to use symbols here rather than VisibilityScope?

It's what we were using before in the original implementation in code lens. I think the bigger refactor here is realizing that many listeners need to keep track of scopes, so maybe we can implement our own Prism::Dispatcher subclass that automatically tracks this, so that we don't need to duplicate the logic in multiple places.

lib/ruby_lsp/listeners/test_style.rb

andyw8 · 2025-02-13T19:57:46Z

lib/ruby_lsp/listeners/test_style.rb

+      end
+      def initialize(response_builder, global_state, dispatcher, uri)
+        @response_builder = response_builder
+        @global_state = global_state


Looks like ivar is unused?

test/requests/discover_tests_test.rb

vinistock added enhancement New feature or request server This pull request should be included in the server gem's release notes labels Feb 11, 2025

vinistock mentioned this pull request Feb 11, 2025

Add test items collection builder #3169

Merged

vinistock force-pushed the 01-31-add_discover_tests_custom_request branch from b31b6f4 to 86b8fe1 Compare February 11, 2025 20:21

vinistock self-assigned this Feb 11, 2025

vinistock marked this pull request as ready for review February 11, 2025 20:24

vinistock requested a review from a team as a code owner February 11, 2025 20:24

vinistock requested review from andyw8 and alexcrocha February 11, 2025 20:24

st0012 reviewed Feb 11, 2025

View reviewed changes

lib/ruby_indexer/lib/ruby_indexer/index.rb Outdated Show resolved Hide resolved

vinistock force-pushed the 01-31-add_discover_tests_custom_request branch from 86b8fe1 to 1290c28 Compare February 11, 2025 21:16

vinistock force-pushed the 01-31-add_test_items_collection_builder branch from dfcc5be to b80e1d8 Compare February 11, 2025 21:16

This was referenced Feb 11, 2025

Accept nil name for actual nesting #3182

Merged

Accept module/class node's constant path for constant name #3183

Merged

vinistock requested a review from st0012 February 11, 2025 21:20

vinistock force-pushed the 01-31-add_discover_tests_custom_request branch from 1290c28 to 7676523 Compare February 12, 2025 14:24

vinistock force-pushed the 01-31-add_test_items_collection_builder branch from b80e1d8 to 90ea02f Compare February 12, 2025 14:24

vinistock mentioned this pull request Feb 12, 2025

Resolve test items with server request #3186

Merged

vinistock force-pushed the 01-31-add_test_items_collection_builder branch 2 times, most recently from e9cbf36 to debbee7 Compare February 12, 2025 16:54

vinistock force-pushed the 01-31-add_discover_tests_custom_request branch 2 times, most recently from 1170bf3 to 4760446 Compare February 12, 2025 18:48

vinistock force-pushed the 01-31-add_test_items_collection_builder branch from debbee7 to 675fbff Compare February 12, 2025 18:48

vinistock force-pushed the 01-31-add_discover_tests_custom_request branch from 4760446 to 8f68f57 Compare February 12, 2025 21:32

vinistock mentioned this pull request Feb 12, 2025

Ensure we index non test files under test directories #3188

Open

st0012 approved these changes Feb 12, 2025

View reviewed changes

vinistock force-pushed the 01-31-add_discover_tests_custom_request branch from 8f68f57 to 8dcf69e Compare February 13, 2025 14:25

vinistock force-pushed the 01-31-add_test_items_collection_builder branch from 675fbff to aff14cb Compare February 13, 2025 14:25

vinistock force-pushed the 01-31-add_discover_tests_custom_request branch from 8dcf69e to f4582ce Compare February 13, 2025 15:42

vinistock force-pushed the 01-31-add_test_items_collection_builder branch 2 times, most recently from 3c2c02a to f5093ce Compare February 13, 2025 17:48

vinistock force-pushed the 01-31-add_discover_tests_custom_request branch from f4582ce to dcd90c6 Compare February 13, 2025 17:48

vinistock changed the base branch from 01-31-add_test_items_collection_builder to graphite-base/3180 February 13, 2025 18:23

vinistock force-pushed the graphite-base/3180 branch from f5093ce to 44a38fa Compare February 13, 2025 18:55

vinistock force-pushed the 01-31-add_discover_tests_custom_request branch from dcd90c6 to 4e5dceb Compare February 13, 2025 18:55

vinistock changed the base branch from graphite-base/3180 to main February 13, 2025 18:55

graphite-app bot force-pushed the 01-31-add_discover_tests_custom_request branch from 4e5dceb to 7d66850 Compare February 13, 2025 19:33

vinistock merged commit 7db4a9f into main Feb 13, 2025
41 of 42 checks passed

vinistock deleted the 01-31-add_discover_tests_custom_request branch February 13, 2025 20:00

andyw8 approved these changes Feb 13, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add discover tests custom request #3180

Add discover tests custom request #3180

vinistock commented Feb 11, 2025 •

edited

Loading

vinistock commented Feb 11, 2025 •

edited

Loading

graphite-app bot commented Feb 13, 2025 •

edited

Loading

andyw8 left a comment

andyw8 Feb 13, 2025

vinistock Feb 13, 2025

andyw8 Feb 13, 2025

Add discover tests custom request #3180

Add discover tests custom request #3180

Conversation

vinistock commented Feb 11, 2025 • edited Loading

Motivation

Implementation

Automated Tests

vinistock commented Feb 11, 2025 • edited Loading

How to use the Graphite Merge Queue

graphite-app bot commented Feb 13, 2025 • edited Loading

Merge activity

andyw8 left a comment

Choose a reason for hiding this comment

andyw8 Feb 13, 2025

Choose a reason for hiding this comment

vinistock Feb 13, 2025

Choose a reason for hiding this comment

andyw8 Feb 13, 2025

Choose a reason for hiding this comment

vinistock commented Feb 11, 2025 •

edited

Loading

vinistock commented Feb 11, 2025 •

edited

Loading

graphite-app bot commented Feb 13, 2025 •

edited

Loading