[SIW] Add support to search in outside workspace content

[DucNgn]

What it does

Fixes #6867

• search-in-workspace now supports searching in files that are opened in an editor but are not in the workspace root.
• Group those files under a root node folder Other files in Search view.
• Note: This PR is a work based on search-in-workspace: Perform workspace search in dirty file content #8579

How to test

• Open a file that is not in the workspace root directory.
• Search for content that should be found in that file.
• Expected behavior: The search result comes from that file is displayed under Other files node in Search view.
• Other files node is only displayed when there's multi-root in the search result tree (including the Other files node)

Review checklist

• as an author, I have thoroughly tested my changes and carefully followed the review guidelines

Reminder for reviewers

• as a reviewer, I agree to behave in accordance with the review guidelines

Signed-off-by: DukeNgn [email protected]

[paul-marechal]

Code LGTM with few nitpicks, feature wise I noticed that it shows the Other files root node even when there is no matches for workspaces. The expected behavior in this case is to not show this Other files node, and only display it if there's others roots to display.

[DucNgn]

@marechal-p Thanks for the review. I tried to address the use case you mentioned but unfortunately, I don't see an approach that is available with our current implementation.

One approach is to get the number of root folder node in resultTree and set visible based on it.

https://github.com/DukeNgn/theia/blob/430dc7d2b8c010a878406796259dea55aa76d23f/packages/search-in-workspace/src/browser/search-in-workspace-result-tree-widget.tsx#L526

However, because visible is readonly, it needs to be determined before any call of appendToResultTree() to make all the root folder node appear in search view (when other files presents). But the resultTree is not updated until we create root folder node in the search tree, hence we have no way to find out the visibility prior to creating the tree.

With my current approach in this PR, I believe the main functionality is not being affected. The only thing that is a bit off is the UX for a specific use-case (Other files is displayed when no matches in the workspace).

[DucNgn]

I just rebased against master. Other than that, nothing has changed since the previous review. The PR is ready to be merged in my opinion.

About the mentioned use-case (no ws results are found, other files is still being displayed), I and @vince-fugnitto discussed offline. And we think that:

• Our current implementation in siw does not allow such behavior.
• The behavior in this PR is maybe even better since it makes a clear distinction that the results are from outside workspace files.

[paul-marechal]

LGTM, works well.

[vince-fugnitto]

There is currently a bug which can be reproduced as follows:

1. start the application with a single-root workspace
2. open a file outside the workspace
3. perform a search which does not yield results in the external file
4. the search tree is incorrectly rendered with a root node of the workspace

[DucNgn]

I fixed the bug and tested again 👍

[vince-fugnitto]

The latest changes work well for me 👍