Convert ResolveDocumentInAnyProject to Try* method

Author: DustinCampbell

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/DocumentContextFactory.cs

@@ -100,8 +100,7 @@ private bool TryResolveDocument(
     {
         if (projectContext is null)
         {
-            documentSnapshot = _snapshotResolver.ResolveDocumentInAnyProject(filePath);
-            return documentSnapshot is not null;
+            return _snapshotResolver.TryResolveDocumentInAnyProject(filePath, out documentSnapshot);
         }
 
         if (_projectManager.TryGetLoadedProject(projectContext.ToProjectKey(), out var project) &&

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/ProjectSystem/ISnapshotResolver.cs

@@ -2,6 +2,7 @@
 // Licensed under the MIT license. See License.txt in the project root for license information.
 
 using System.Collections.Immutable;
+using System.Diagnostics.CodeAnalysis;
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.CodeAnalysis.Razor.ProjectSystem;
@@ -23,5 +24,5 @@ internal interface ISnapshotResolver
     /// Finds a <see cref="IDocumentSnapshot"/> for the given document path that is contained within any project, and returns the first
     /// one found if it does. This method should be avoided where possible, and the overload that takes a <see cref="ProjectKey"/> should be used instead
     /// </summary>
-    IDocumentSnapshot? ResolveDocumentInAnyProject(string documentFilePath);
+    bool TryResolveDocumentInAnyProject(string documentFilePath, [NotNullWhen(true)] out IDocumentSnapshot? document);
 }

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/ProjectSystem/RazorProjectService.cs

@@ -111,9 +111,7 @@ public Task OpenDocumentAsync(string filePath, SourceText sourceText, int versio
                 // We are okay to use the non-project-key overload of TryResolveDocument here because we really are just checking if the document
                 // has been added to _any_ project. AddDocument will take care of adding to all of the necessary ones, and then below we ensure
                 // we process them all too
-                var document = _snapshotResolver.ResolveDocumentInAnyProject(textDocumentPath);
-
-                if (document is null)
+                if (!_snapshotResolver.TryResolveDocumentInAnyProject(textDocumentPath, out var document))
                 {
                     // Document hasn't been added. This usually occurs when VSCode trumps all other initialization
                     // processes and pre-initializes already open documents.

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/ProjectSystem/SnapshotResolver.cs

@@ -3,6 +3,7 @@
 
 using System;
 using System.Collections.Immutable;
+using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Linq;
 using System.Threading;
@@ -78,24 +79,20 @@ public IProjectSnapshot GetMiscellaneousProject()
         return _projectManager.GetLoadedProject(MiscellaneousHostProject.Key);
     }
 
-    public IDocumentSnapshot? ResolveDocumentInAnyProject(string documentFilePath)
+    public bool TryResolveDocumentInAnyProject(string documentFilePath, [NotNullWhen(true)] out IDocumentSnapshot? document)
     {
         _logger.LogTrace($"Looking for {documentFilePath}.");
 
-        if (documentFilePath is null)
-        {
-            throw new ArgumentNullException(nameof(documentFilePath));
-        }
-
         var normalizedDocumentPath = FilePathNormalizer.Normalize(documentFilePath);
         var potentialProjects = FindPotentialProjects(documentFilePath);
 
         foreach (var project in potentialProjects)
         {
-            if (project.GetDocument(normalizedDocumentPath) is { } document)
+            if (project.GetDocument(normalizedDocumentPath) is { } projectDocument)
             {
                 _logger.LogTrace($"Found {documentFilePath} in {project.FilePath}");
-                return document;
+                document = projectDocument;
+                return true;
             }
         }
 
@@ -105,11 +102,13 @@ public IProjectSnapshot GetMiscellaneousProject()
         if (miscellaneousProject.GetDocument(normalizedDocumentPath) is { } miscDocument)
         {
             _logger.LogTrace($"Found {documentFilePath} in miscellaneous project.");
-            return miscDocument;
+            document = miscDocument;
+            return true;
         }
 
         _logger.LogTrace($"{documentFilePath} not found in {string.Join(", ", _projectManager.GetProjects().SelectMany(p => p.DocumentFilePaths))}");
 
-        return null;
+        document = null;
+        return false;
     }
 }

src/Razor/test/Microsoft.AspNetCore.Razor.LanguageServer.Test/DocumentContextFactoryTest.cs

@@ -3,6 +3,7 @@
 
 using System;
 using System.Collections.Immutable;
+using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Threading;
 using System.Threading.Tasks;
@@ -217,9 +218,16 @@ public ImmutableArray<IProjectSnapshot> FindPotentialProjects(string documentFil
         public IProjectSnapshot GetMiscellaneousProject()
             => throw new NotImplementedException();
 
-        public IDocumentSnapshot? ResolveDocumentInAnyProject(string documentFilePath)
-            => documentFilePath == _documentSnapshot?.FilePath
-                ? _documentSnapshot
-                : null;
+        public bool TryResolveDocumentInAnyProject(string documentFilePath, [NotNullWhen(true)] out IDocumentSnapshot? document)
+        {
+            if (documentFilePath == _documentSnapshot?.FilePath)
+            {
+                document = _documentSnapshot;
+                return true;
+            }
+
+            document = null;
+            return false;
+        }
     }
 }

src/Razor/test/Microsoft.AspNetCore.Razor.LanguageServer.Test/SnapshotResolverTest.cs

@@ -24,10 +24,9 @@ public async Task TryResolveDocumentInAnyProject_AsksPotentialParentProjectForDo
         var snapshotResolver = await CreateSnapshotResolverAsync(normalizedFilePath);
 
         // Act
-        var document = snapshotResolver.ResolveDocumentInAnyProject(documentFilePath);
+        Assert.True(snapshotResolver.TryResolveDocumentInAnyProject(documentFilePath, out var document));
 
         // Assert
-        Assert.NotNull(document);
         Assert.Equal(normalizedFilePath, document.FilePath);
     }
 
@@ -52,10 +51,9 @@ await projectManager.UpdateAsync(updater =>
         });
 
         // Act
-        var document = snapshotResolver.ResolveDocumentInAnyProject(documentFilePath);
+        Assert.True(snapshotResolver.TryResolveDocumentInAnyProject(documentFilePath, out var document));
 
         // Assert
-        Assert.NotNull(document);
         Assert.Equal(normalizedFilePath, document.FilePath);
     }
 
@@ -69,7 +67,7 @@ public async Task TryResolveDocumentInAnyProject_AsksPotentialParentProjectForDo
         await snapshotResolver.InitializeAsync(DisposalToken);
 
         // Act
-        var document = snapshotResolver.ResolveDocumentInAnyProject(documentFilePath);
+        Assert.False(snapshotResolver.TryResolveDocumentInAnyProject(documentFilePath, out var document));
 
         // Assert
         Assert.Null(document);

src/Razor/test/Microsoft.AspNetCore.Razor.LanguageServer.Test/TestSnapshotResolver.cs

@@ -2,6 +2,7 @@
 // Licensed under the MIT license. See License.txt in the project root for license information.
 
 using System.Collections.Immutable;
+using System.Diagnostics.CodeAnalysis;
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Razor.LanguageServer.ProjectSystem;
@@ -38,6 +39,9 @@ public ImmutableArray<IProjectSnapshot> FindPotentialProjects(string documentFil
     public IProjectSnapshot GetMiscellaneousProject()
         => _miscProject;
 
-    public IDocumentSnapshot? ResolveDocumentInAnyProject(string documentFilePath)
-        => null;
+    public bool TryResolveDocumentInAnyProject(string documentFilePath, [NotNullWhen(true)] out IDocumentSnapshot? document)
+    {
+        document = null;
+        return false;
+    }
 }