Fix relative uplevels of Symlinked Workspace (Issue #798) #1244
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add feature flag - Minor refactor: consolidate settings usage - Update documentation - Adjust tests to pass
Pull Request Test Coverage Report for Build 15374238988Warning: This coverage report may be inaccurate.This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
Details
💛 - Coveralls |
connectdotz
reviewed
Jun 29, 2025
| @@ -372,6 +372,12 @@ | |||
| "type": "boolean", | |||
| "default": null, | |||
| "scope": "resource" | |||
| }, | |||
| "jest.trimSymlinks": { | |||
| "markdownDescription": "Enable to show test relative to workspace in case of symlinked workspace (or any directory above it). Use if your tests look like in [this image](https://private-user-images.githubusercontent.com/84509513/438940965-b7532345-0332-4265-a108-cac1703de39f.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NDU5NTQ4MzcsIm5iZiI6MTc0NTk1NDUzNywicGF0aCI6Ii84NDUwOTUxMy80Mzg5NDA5NjUtYjc1MzIzNDUtMDMzMi00MjY1LWExMDgtY2FjMTcwM2RlMzlmLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNTA0MjklMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjUwNDI5VDE5MjIxN1omWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTcwZjEzMWIzZmFkOTBiODllMTU3NjYzMzBhOWIwMGI3MWMwMjI4YzBiYjhlZTA2NzYzOTM4N2NmNGMzMDkxNjUmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.bWHlErbUnTuXEP2_LPGUbJu509UdNl22Ee73q2f1FXU)", | |||
There was a problem hiding this comment.
I wasn't able to access this image link. Can you add this image file to the ./images folder and reference it from there.
| // In case the workspace root (or one of its ancestors) is a symlink, the relative path is going to resolve | ||
| // up-levels (../) until the first common ancestor with the link, resulting in many nodes we can hide from the user. | ||
| // In order to hide them, we get the workspaceRoot's "realpath" and use it instead. | ||
| uri = vscode.Uri.file(realpathSync(uri!.fsPath)); |
There was a problem hiding this comment.
To be safe, maybe let's wrap it inside a try/catch block and fall back to the original uri...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
TL;DR
Solves the issue reported in #798
Examples of the fix can be found in my comment
Some explanation
While the issue might initially seem rooted in Jest—which reports test results based on the tests’ real paths—it actually makes sense from Jest’s own perspective. Therefore, I implemented the logic in this extension to handle cases where a workspace (or one of its parent directories) is linked, and to hide such links from the Tests Explorer view.
Tests made: