Add IProjectSnapshot.ContainsDocument to test document paths cheaply #10975
Conversation
This file contains 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
There's a fair amount of code in Razor that uses `IProjectSnapshot.GetDocument(...)` to test for the presence of a document with a given file path in a project. However, `GetDocument` has the side effect of creating a document snapshot which ultimately may be thrown away. This change adds an `IProjectSnapshot.ContainsDocument(...)` method that tests for the presence of a document by file path and returns true or false without creating a new document snapshot. In addition, I've cleaned up the `IProjectSnapshot` implementations a bit.
DustinCampbell
commented
Oct 7, 2024
| @@ -38,13 +34,6 @@ public bool TryCreate( | |||
| return false; | |||
| } | |||
|
|
|||
| if (documentSnapshot is null) | |||
There was a problem hiding this comment.
ℹ️ This condition can never be true because of the call to TryResolveDocument(...) above.
davidwengier
approved these changes
Oct 7, 2024
src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/ProjectSystem/ProjectSnapshot.cs
Show resolved
Hide resolved
src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/ProjectSystem/ProjectSnapshot.cs
Outdated
Show resolved
Hide resolved
ryzngard
approved these changes
Oct 7, 2024
| @@ -37,6 +37,8 @@ internal interface IProjectSnapshot | |||
| ProjectWorkspaceState ProjectWorkspaceState { get; } | |||
|
|
|||
| RazorProjectEngine GetProjectEngine(); | |||
|
|
|||
| bool ContainsDocument(string filePath); | |||
| IDocumentSnapshot? GetDocument(string filePath); | |||
There was a problem hiding this comment.
💭 should we get rid of GetDocument entirely?
There was a problem hiding this comment.
I thought about that, but it requires a much larger change. This PR doesn't address most of the existing GetDocument(...) call-sites. Also, I think the API is probably still useful. I'd rather make it non-nullable and throw at some point -- sort of like TryGetProject and GetLoadedProject on IProjectSnapshotManager.
This was referenced Oct 15, 2024
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.
There's a fair amount of code in Razor that uses
IProjectSnapshot.GetDocument(...)to test for the presence of a document with a given file path in a project. However,GetDocumenthas the side effect of creating a document snapshot which ultimately may be thrown away.This change adds an
IProjectSnapshot.ContainsDocument(...)method that tests for the presence of a document by file path and returns true or false without creating a new document snapshot. In addition, I've cleaned up theIProjectSnapshotimplementations a bit.