GoTestResolver: Limit scope of indexing to the package level instead of entire workspace/module

[mnoah1]

Is your feature request related to a problem? Please describe.
When working in a large monorepo, the test explorer indexes indefinitely as it attempts to discover every test in the monorepo. Even after the tests in the currently open package are displayed, it continues to spin and slowly populate other packages which may not be relevant to the user's current work.

Describe the solution you'd like
Adjust the resolve method in GoTestResolver. Add a new configuration setting that optionally skips the step of finding all packages in the workspace, so tests will only get added if part of the user's active package.

Describe alternatives you've considered
Potentially more complex logic that lets a user configure the projects that are relevant to them to be included in indexing.

Additional context
Below is the block of code in goTest/resolve that could go behind a conditional. I can contribute this change if you're good with it.

if (kind === 'module' || kind === 'workspace') {
    await walkPackages(this.workspace.fs, item.uri, async (uri) => {
        await this.getPackage(uri);
    });
}

[hyangah]

Thanks for the FR @mnoah1

There is a separate feature request #1739 and I think that matches what you described as an alternative - except that the FR and the [cl/351172](https://go-review.git.corp.google.com/c/vscode-go/+/351172 proposed by @firelizzard18 discusses only on exclude option. If the feature #1739 is implemented, do you still think this is useful?

Often times, users work on multiple packages. I am worried that kicking the resolver every time as users navigate/open/close files in different packages can be more complex than it looks.

[mnoah1]

Hi @hyangah - I think in the case of a large repo, the exclude option would not be ideal since for most users that work on only a few projects, they'll end up needing to set most of the repo to be excluded which will become tedious to maintain. If we could just avoid walking the entire workspace when looking for more packages to add, it should be relatively close to the current behavior with new packages updating in the list based on users opening files, and staying there if the user leaves to go to another package. So effectively it would build up a list of the user's current working packages.

[mnoah1]

Hi @hyangah - any thoughts on this? I have a solution on my fork that seems to work as needed, should I try submitting it as a PR?

[mnoah1]

@hyangah - Just wanted to bump this.

[greenstatic]

I would like this feature as well. In monorepos you sometimes/often have different projects in different languages. In my case I have C++, Node.js and Python projects in my monorepo. Currently the go test explorer is completely useless for me and I have it disabled using "go.testExplorer.enable": false in my settings.json file because if it is enabled, it takes 5+ minutes to load the test explorer UI.

gopls directoryFilters are also not respected by GoTestResolver thus having a separate Go setting field where you could specify not to walk the directories of non-Go projects (e.g. C++, Node.js, Python, etc.) makes sense since they will generally never contain Go code.

I can help work on a setting to enable this, but would like to hear from you guys if this is something that would be accepted in a PR.

[mnoah1]

I have a working version of this in a fork, I can add what I have so far into a PR as well. It adds a setting, indexEntireWorkspace - if set to false, the test explorer won't walk all packages and will only look for tests in the same package as a currently open _test.go file.

[greenstatic]

@mnoah1 does that mean that you need to open up a _test.go file for the GoTestResolver to detect it? If so, that isn't convenient for running all tests in multiple packages. Or am I missing something?

I think a better approach would be to simply have a list of excluded directories that thewalk function would exclude from the directories it searches.

If you would have a project layout like so:

/my_cpp_project/
/my_nodejs_project/
/my_python_project/
/my_go_project1/
/my_go_project2/
/my_misc_project/python_tests/
/my_misc_project/go_utility/

The settings.json configuration would look something like :

"go.testExplorer.walk.exclude": [
        "my_cpp_project",
        "my_nodejs_project",
        "my_python_project",
    ]

And walk would be allowed to search just the directories my_go_project1 and my_go_project2 and my_misc_project.