referencesSearch and scope management

Hello,

I'm developing an IntelliJ plugin to support reference resolution and "find usages" functionality for DataTable rows in Gherkin files. The plugin aims to facilitate mapping between DataTable headers in Gherkin and fields in Java classes or records.

You can find the plugin source code here: GitHub Repository.

Problem Overview

I have successfully implemented the reference support using a ReferenceContributor. However, I'm encountering issues when trying to implement the "find usages" feature across all relevant scenarios.

I have opened a PR that attempts to add this feature: PR #5.

Expected Behavior of the QueryExecutor

The QueryExecutor is expected to:

1. Identify Fields in Annotated Classes: Apply to fields present in classes or records annotated with @DataTableWithHeader. (This part works as expected.)
2. Search Step Definitions in Java Methods: Search all Cucumber step definition methods (Java methods) that reference the class. (This part also works as expected.)
3. Search Gherkin Files: Search all steps in Gherkin files. (This is where the issue arises.)
4. Match DataTable Headers: Within those steps, identify DataTable headers that match the field name being searched, and return the reference. (This works, but is blocked by the issue described below.)

The Issue

When searching for references to a field in a class (but not a record), the QueryExecutor is invoked, but the effectiveSearchScope does not encompass all files in the project. As a result, Gherkin files (.feature) are excluded from the search scope, and references in these files are not found.

I have attached a screenshot (reference id 2024_08_22_28bk33zUZdEjgdnbiiXbYg) showing that the scope is limited to Groovy files. For some reason, when dealing with records, the QueryExecutor is correctly called with a scope that includes all files in the project, including Gherkin files. This issue only occurs with classes.

In a different project setup, the code works correctly for both classes and records, suggesting that the behavior might be context-dependent.

Workaround Attempted

Using queryParameters.scopeDeterminedByUser resolves the "find references" issue, but don't resolve the issue for the field renaming function.

I am unable to determine whether this issue stems from a problem in my QueryExecutor implementation or if it's related to IntelliJ configuration. Any insights or suggestions to resolve this inconsistency would be greatly appreciated.

Thank you for your help.

Thomas Deblock