Address cross-project contamination when restoring in VS (#801)

* Address cross-project contamination when restoring in VS

During the restore-on-save operation, we were using a cached instance of the "before" manifest, which was used to clean up file deltas.  A side effect of this was that we used the working folder for that cached manifest.

If the user makes changes to a second libman.json, then it cleans the delta between that file and the previous libman.json in its folder.  That typically would appear as deleting the files out of one project when making changes the libman.json file in a different project.

The fix is straightforward: cache the instance in a per-document form instead of a single stored value.

* Bring changelong up to date

Author: jimmylewis

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Upcoming Release
 Commit: TBD
+- Adds Intellisense completion for files in fileMappings
+- Adds fileMappings support for filesystem provider
+- Fixes LIB016 error when using fileMappings
+- Fixes issue where restore-on-save in one project in VS removes files restored in a separate project
 
 ## 3.0.71
 Commit: 33c04f70a4f55f1cddbaddad60fc78a282b298d3

src/LibraryManager.Vsix/Json/TextviewCreationListener.cs

@@ -29,10 +29,10 @@ namespace Microsoft.Web.LibraryManager.Vsix.Json
     [TextViewRole(PredefinedTextViewRoles.PrimaryDocument)]
     internal class TextviewCreationListener : IVsTextViewCreationListener
     {
-        private Manifest _manifest;
-        private Project _project;
         private ErrorListPropagator _errorList;
-        private string _manifestPath;
+
+        private readonly object _manifestPropertyKey = "LibManManifest";
+        private readonly object _manifestProjectPropertyKey = "LibManProject";
 
         [Import]
         public ITextDocumentFactoryService DocumentService { get; set; }
@@ -70,20 +70,24 @@ public void VsTextViewCreated(IVsTextView textViewAdapter)
             IDependencies dependencies = DependenciesFactory.FromConfigFile(doc.FilePath);
 #pragma warning disable VSTHRD002 // Avoid problematic synchronous waits
                                   // Justification: Manifest is free-threaded, don't need to use JTF here
-            _manifest = Manifest.FromFileAsync(doc.FilePath, dependencies, CancellationToken.None).Result;
+            Manifest manifest = Manifest.FromFileAsync(doc.FilePath, dependencies, CancellationToken.None).Result;
 #pragma warning restore VSTHRD002 // Avoid problematic synchronous waits
-            _manifestPath = doc.FilePath;
-            _project = VsHelpers.GetDTEProjectFromConfig(_manifestPath);
+            Project project = VsHelpers.GetDTEProjectFromConfig(doc.FilePath);
+
+            // Save these for later reference.  Must be document-specific to avoid cross-contamination.
+            // See https://github.com/aspnet/LibraryManager/issues/800
+            doc.TextBuffer.Properties[_manifestPropertyKey] = manifest;
+            doc.TextBuffer.Properties[_manifestProjectPropertyKey] = project;
 
             doc.FileActionOccurred += OnFileSaved;
             textView.Closed += OnViewClosed;
 
             _ = Task.Run(async () =>
             {
-                IEnumerable<OperationResult<LibraryInstallationGoalState>> results = await LibrariesValidator.GetManifestErrorsAsync(_manifest, dependencies, CancellationToken.None).ConfigureAwait(false);
+                IEnumerable<OperationResult<LibraryInstallationGoalState>> results = await LibrariesValidator.GetManifestErrorsAsync(manifest, dependencies, CancellationToken.None).ConfigureAwait(false);
                 if (!results.All(r => r.Success))
                 {
-                    AddErrorsToList(results);
+                    AddErrorsToList(results, project.Name, doc.FilePath);
                     Telemetry.LogErrors("Fail-ManifestFileOpenWithErrors", results);
                 }
             });
@@ -112,17 +116,19 @@ async Task DoRestoreOnSaveAsync()
 
                         if (!results.All(r => r.Success))
                         {
-                            AddErrorsToList(results);
+                            string projectName = (textDocument.TextBuffer.Properties[_manifestProjectPropertyKey] as Project)?.Name ?? string.Empty;
+                            AddErrorsToList(results, projectName, textDocument.FilePath);
                             Logger.LogErrorsSummary(results, OperationType.Restore);
                             Telemetry.LogErrors("Fail-ManifestFileSaveWithErrors", results);
                         }
                         else
                         {
-                            if (_manifest == null || await _manifest.RemoveUnwantedFilesAsync(newManifest, CancellationToken.None).ConfigureAwait(false))
+                            Manifest oldManifest = textDocument.TextBuffer.Properties[_manifestPropertyKey] as Manifest;
+                            if (oldManifest == null || await oldManifest.RemoveUnwantedFilesAsync(newManifest, CancellationToken.None).ConfigureAwait(false))
                             {
-                                _manifest = newManifest;
+                                textDocument.TextBuffer.Properties[_manifestPropertyKey] = newManifest;
 
-                                await LibraryCommandService.RestoreAsync(textDocument.FilePath, _manifest, CancellationToken.None).ConfigureAwait(false);
+                                await LibraryCommandService.RestoreAsync(textDocument.FilePath, newManifest, CancellationToken.None).ConfigureAwait(false);
                                 Telemetry.TrackUserTask("Invoke-RestoreOnSave");
                             }
                             else
@@ -170,9 +176,9 @@ private void OnViewClosed(object sender, EventArgs e)
             _errorList?.ClearErrors();
         }
 
-        private void AddErrorsToList(IEnumerable<OperationResult<LibraryInstallationGoalState>> errors)
+        private void AddErrorsToList(IEnumerable<OperationResult<LibraryInstallationGoalState>> errors, string projectName, string manifestPath)
         {
-            _errorList = new ErrorListPropagator(_project?.Name, _manifestPath);
+            _errorList = new ErrorListPropagator(projectName, manifestPath);
             _errorList.HandleErrors(errors);
         }
     }