Merge pull request dotnet#62488 from MariaSolOs/contained-language-buffer

jasonmalinowski · web-flow · commit 570c1b5334c3 · 2022-07-14T15:22:31.000-07:00
Use secondary buffer in contained language file paths
diff --git a/src/VisualStudio/Core/Def/ExternalAccess/VSTypeScript/Api/VSTypeScriptContainedLanguageWrapper.cs b/src/VisualStudio/Core/Def/ExternalAccess/VSTypeScript/Api/VSTypeScriptContainedLanguageWrapper.cs
@@ -2,8 +2,6 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
-#pragma warning disable CS0618 // Type or member is obsolete
-
 using System;
 using Microsoft.CodeAnalysis;
 using Microsoft.VisualStudio.ComponentModelHost;
@@ -18,47 +16,40 @@ internal struct VSTypeScriptContainedLanguageWrapper
     {
         private readonly ContainedLanguage _underlyingObject;
 
-        [Obsolete("Remove once TypeScript has stopped using this.", error: true)]
+        [Obsolete("Use the constructor that omits the IVsHierarchy and uint parameters instead.", error: true)]
         public VSTypeScriptContainedLanguageWrapper(
             IVsTextBufferCoordinator bufferCoordinator,
             IComponentModel componentModel,
-            AbstractProject project,
+            VSTypeScriptVisualStudioProjectWrapper project,
             IVsHierarchy hierarchy,
             uint itemid,
-            Guid languageServiceGuid)
+            Guid languageServiceGuid) : this(bufferCoordinator, componentModel, project, languageServiceGuid)
         {
-            var workspace = componentModel.GetService<VisualStudioWorkspace>();
-            var filePath = ContainedLanguage.GetFilePathFromHierarchyAndItemId(hierarchy, itemid);
-
-            _underlyingObject = new ContainedLanguage(
-                bufferCoordinator,
-                componentModel,
-                workspace,
-                project.Id,
-                project.VisualStudioProject,
-                filePath,
-                languageServiceGuid,
-                vbHelperFormattingRule: null);
         }
 
+        [Obsolete("Use the constructor that omits the IVsHierarchy and uint parameters instead.", error: true)]
         public VSTypeScriptContainedLanguageWrapper(
             IVsTextBufferCoordinator bufferCoordinator,
             IComponentModel componentModel,
-            VSTypeScriptVisualStudioProjectWrapper project,
+            Workspace workspace,
             IVsHierarchy hierarchy,
             uint itemid,
-            Guid languageServiceGuid)
+            Guid languageServiceGuid) : this(bufferCoordinator, componentModel, workspace, languageServiceGuid)
         {
-            var workspace = componentModel.GetService<VisualStudioWorkspace>();
-            var filePath = ContainedLanguage.GetFilePathFromHierarchyAndItemId(hierarchy, itemid);
+        }
 
+        public VSTypeScriptContainedLanguageWrapper(
+            IVsTextBufferCoordinator bufferCoordinator,
+            IComponentModel componentModel,
+            VSTypeScriptVisualStudioProjectWrapper project,
+            Guid languageServiceGuid)
+        {
             _underlyingObject = new ContainedLanguage(
                 bufferCoordinator,
                 componentModel,
-                workspace,
+                componentModel.GetService<VisualStudioWorkspace>(),
                 project.Project.Id,
                 project.Project,
-                filePath,
                 languageServiceGuid,
                 vbHelperFormattingRule: null);
         }
@@ -67,28 +58,25 @@ public VSTypeScriptContainedLanguageWrapper(
             IVsTextBufferCoordinator bufferCoordinator,
             IComponentModel componentModel,
             Workspace workspace,
-            IVsHierarchy hierarchy,
-            uint itemid,
             Guid languageServiceGuid)
         {
-            var filePath = ContainedLanguage.GetFilePathFromHierarchyAndItemId(hierarchy, itemid);
-            var projectId = ProjectId.CreateNewId($"Project for {filePath}");
-            workspace.OnProjectAdded(ProjectInfo.Create(projectId, VersionStamp.Default, filePath, string.Empty, InternalLanguageNames.TypeScript));
+            var projectId = ProjectId.CreateNewId();
 
             _underlyingObject = new ContainedLanguage(
                 bufferCoordinator,
                 componentModel,
                 workspace,
                 projectId,
                 null,
-                filePath,
                 languageServiceGuid,
                 vbHelperFormattingRule: null);
+
+            var filePath = _underlyingObject.GetFilePathFromBuffers();
+            workspace.OnProjectAdded(ProjectInfo.Create(projectId, VersionStamp.Default, filePath, string.Empty, InternalLanguageNames.TypeScript));
         }
 
         public bool IsDefault => _underlyingObject == null;
 
-        public void DisconnectHost()
-            => _underlyingObject.SetHost(null);
+        public void DisconnectHost() => _underlyingObject.SetHost(null);
     }
 }
diff --git a/src/VisualStudio/Core/Def/LanguageService/AbstractLanguageService`2.cs b/src/VisualStudio/Core/Def/LanguageService/AbstractLanguageService`2.cs
@@ -281,15 +281,12 @@ protected virtual IVsContainedLanguage CreateContainedLanguage(
             IVsTextBufferCoordinator bufferCoordinator, VisualStudioProject project,
             IVsHierarchy hierarchy, uint itemid)
         {
-            var filePath = ContainedLanguage.GetFilePathFromHierarchyAndItemId(hierarchy, itemid);
-
             return new ContainedLanguage(
                 bufferCoordinator,
                 this.Package.ComponentModel,
                 this.Workspace,
                 project.Id,
                 project,
-                filePath,
                 this.LanguageServiceId);
         }
     }
diff --git a/src/VisualStudio/Core/Def/Venus/ContainedLanguage.cs b/src/VisualStudio/Core/Def/Venus/ContainedLanguage.cs
@@ -3,7 +3,6 @@
 // See the LICENSE file in the project root for more information.
 
 using System;
-using System.Diagnostics;
 using System.Runtime.InteropServices;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.Diagnostics;
@@ -15,7 +14,6 @@
 using Microsoft.VisualStudio.ComponentModelHost;
 using Microsoft.VisualStudio.Editor;
 using Microsoft.VisualStudio.LanguageServices.Implementation.ProjectSystem;
-using Microsoft.VisualStudio.Shell.Interop;
 using Microsoft.VisualStudio.Text;
 using Microsoft.VisualStudio.Text.Tagging;
 using Microsoft.VisualStudio.TextManager.Interop;
@@ -61,35 +59,18 @@ internal partial class ContainedLanguage
         /// </summary>
         public ITextBuffer DataBuffer { get; }
 
-        // Set when a TextViewFIlter is set.  We hold onto this to keep our TagSource objects alive even if Venus
+        // Set when a TextViewFilter is set.  We hold onto this to keep our TagSource objects alive even if Venus
         // disconnects the subject buffer from the view temporarily (which they do frequently).  Otherwise, we have to
         // re-compute all of the tag data when they re-connect it, and this causes issues like classification
         // flickering.
         private readonly ITagAggregator<ITag> _bufferTagAggregator;
 
-        public static string GetFilePathFromHierarchyAndItemId(IVsHierarchy hierarchy, uint itemid)
-        {
-            if (!ErrorHandler.Succeeded(((IVsProject)hierarchy).GetMkDocument(itemid, out var filePath)))
-            {
-                // we couldn't look up the document moniker from an hierarchy for an itemid.
-                // Since we only use this moniker as a key, we could fall back to something else, like the document name.
-                Debug.Assert(false, "Could not get the document moniker for an item from its hierarchy.");
-                if (!hierarchy.TryGetItemName(itemid, out filePath!))
-                {
-                    FatalError.ReportAndPropagate(new InvalidOperationException("Failed to get document moniker for a contained document"));
-                }
-            }
-
-            return filePath;
-        }
-
         internal ContainedLanguage(
             IVsTextBufferCoordinator bufferCoordinator,
             IComponentModel componentModel,
             Workspace workspace,
             ProjectId projectId,
             VisualStudioProject? project,
-            string filePath,
             Guid languageServiceGuid,
             AbstractFormattingRule? vbHelperFormattingRule = null)
         {
@@ -115,13 +96,16 @@ internal ContainedLanguage(
             var bufferTagAggregatorFactory = ComponentModel.GetService<IBufferTagAggregatorFactoryService>();
             _bufferTagAggregator = bufferTagAggregatorFactory.CreateTagAggregator<ITag>(SubjectBuffer);
 
+            var filePath = GetFilePathFromBuffers();
             DocumentId documentId;
 
             if (this.Project != null)
             {
                 documentId = this.Project.AddSourceTextContainer(
-                    SubjectBuffer.AsTextContainer(), filePath,
-                    sourceCodeKind: SourceCodeKind.Regular, folders: default,
+                    SubjectBuffer.AsTextContainer(),
+                    filePath,
+                    sourceCodeKind: SourceCodeKind.Regular,
+                    folders: default,
                     designTimeOnly: true,
                     documentServiceProvider: new ContainedDocument.DocumentServiceProvider(DataBuffer));
             }
@@ -135,14 +119,14 @@ internal ContainedLanguage(
             }
 
             this.ContainedDocument = new ContainedDocument(
-                componentModel.GetService<IThreadingContext>(),
+                ComponentModel.GetService<IThreadingContext>(),
                 documentId,
                 subjectBuffer: SubjectBuffer,
                 dataBuffer: DataBuffer,
-                bufferCoordinator,
+                BufferCoordinator,
                 Workspace,
-                project,
-                componentModel,
+                Project,
+                ComponentModel,
                 vbHelperFormattingRule);
 
             // TODO: Can contained documents be linked or shared?
@@ -179,5 +163,24 @@ private void OnDataBufferChanged(object sender, TextContentChangedEventArgs e)
             // when primary buffer has changed to update diagnostic positions.
             _diagnosticAnalyzerService.Reanalyze(this.Workspace, documentIds: SpecializedCollections.SingletonEnumerable(this.ContainedDocument.Id));
         }
+
+        public string GetFilePathFromBuffers()
+        {
+            var textDocumentFactoryService = ComponentModel.GetService<ITextDocumentFactoryService>();
+
+            // Try to get the file path from the secondary buffer
+            if (!textDocumentFactoryService.TryGetTextDocument(SubjectBuffer, out var document))
+            {
+                // Fallback to the primary buffer
+                textDocumentFactoryService.TryGetTextDocument(DataBuffer, out document);
+            }
+
+            if (document == null)
+            {
+                FatalError.ReportAndPropagate(new InvalidOperationException("Failed to get an ITextDocument for a contained document"));
+            }
+
+            return document?.FilePath ?? string.Empty;
+        }
     }
 }
diff --git a/src/VisualStudio/LiveShare/Impl/Client/Razor/CSharpLspContainedLanguageProvider.cs b/src/VisualStudio/LiveShare/Impl/Client/Razor/CSharpLspContainedLanguageProvider.cs
@@ -47,7 +47,6 @@ public IVsContainedLanguage GetLanguage(string filePath, IVsTextBufferCoordinato
                 _razorProjectFactory.Workspace,
                 projectId,
                 project: null,
-                filePath,
                 Guids.CSharpLanguageServiceId);
         }
     }
diff --git a/src/VisualStudio/VisualBasic/Impl/LanguageService/VisualBasicLanguageService.vb b/src/VisualStudio/VisualBasic/Impl/LanguageService/VisualBasicLanguageService.vb
@@ -82,8 +82,6 @@ Namespace Microsoft.VisualStudio.LanguageServices.VisualBasic
                 bufferCoordinator,
                 Me.Package.ComponentModel,
                 project,
-                hierarchy,
-                itemid,
                 Me.LanguageServiceId)
         End Function
     End Class
diff --git a/src/VisualStudio/VisualBasic/Impl/Venus/VisualBasicContainedLanguage.vb b/src/VisualStudio/VisualBasic/Impl/Venus/VisualBasicContainedLanguage.vb
@@ -23,20 +23,32 @@ Namespace Microsoft.VisualStudio.LanguageServices.VisualBasic.Venus
         Inherits ContainedLanguage
         Implements IVsContainedLanguageStaticEventBinding
 
+        <Obsolete("Use the constructor that omits the IVsHierarchy and UInteger parameters instead.", True)>
         Public Sub New(bufferCoordinator As IVsTextBufferCoordinator,
                 componentModel As IComponentModel,
                 project As VisualStudioProject,
                 hierarchy As IVsHierarchy,
                 itemid As UInteger,
                 languageServiceGuid As Guid)
 
+            Me.New(
+                bufferCoordinator,
+                componentModel,
+                project,
+                languageServiceGuid)
+        End Sub
+
+        Public Sub New(bufferCoordinator As IVsTextBufferCoordinator,
+                componentModel As IComponentModel,
+                project As VisualStudioProject,
+                languageServiceGuid As Guid)
+
             MyBase.New(
                 bufferCoordinator,
                 componentModel,
                 componentModel.GetService(Of VisualStudioWorkspace)(),
                 project.Id,
                 project,
-                ContainedLanguage.GetFilePathFromHierarchyAndItemId(hierarchy, itemid),
                 languageServiceGuid,
                 VisualBasicHelperFormattingRule.Instance)
         End Sub

Original file line number	Diff line number	Diff line change
`@@ -281,15 +281,12 @@ protected virtual IVsContainedLanguage CreateContainedLanguage(`
`281`	`281`	`IVsTextBufferCoordinator bufferCoordinator, VisualStudioProject project,`
`282`	`282`	`IVsHierarchy hierarchy, uint itemid)`
`283`	`283`	`{`
`284`		`- var filePath = ContainedLanguage.GetFilePathFromHierarchyAndItemId(hierarchy, itemid);`
`285`		`-`
`286`	`284`	`return new ContainedLanguage(`
`287`	`285`	`bufferCoordinator,`
`288`	`286`	`this.Package.ComponentModel,`
`289`	`287`	`this.Workspace,`
`290`	`288`	`project.Id,`
`291`	`289`	`project,`
`292`		`- filePath,`
`293`	`290`	`this.LanguageServiceId);`
`294`	`291`	`}`
`295`	`292`	`}`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,6 @@ public IVsContainedLanguage GetLanguage(string filePath, IVsTextBufferCoordinato`
`47`	`47`	`_razorProjectFactory.Workspace,`
`48`	`48`	`projectId,`
`49`	`49`	`project: null,`
`50`		`- filePath,`
`51`	`50`	`Guids.CSharpLanguageServiceId);`
`52`	`51`	`}`
`53`	`52`	`}`