Fix exception on saving many tab groups

appveyor.yml

@@ -0,0 +1,15 @@
+image: Visual Studio 2019
+
+install:
+- ps: (new-object Net.WebClient).DownloadString("https://raw.github.com/madskristensen/ExtensionScripts/master/AppVeyor/vsix.ps1") | iex
+
+before_build:
+  - ps: Vsix-IncrementVsixVersion | Vsix-UpdateBuildVersion
+  - ps: Vsix-TokenReplacement src\SaveAllTheTabs\source.extension.cs 'Version = "([0-9\\.]+)"' 'Version = "{version}"'
+
+build_script:
+  - nuget restore src\SaveAllTheTabs\SaveAllTheTabs.csproj -SolutionDirectory src -Verbosity quiet
+  - msbuild src\SaveAllTheTabs.sln /p:configuration=Release /p:DeployExtension=false /p:ZipPackageCompressionLevel=normal /v:m
+
+after_test:
+  - ps: Vsix-PushArtifacts | Vsix-PublishToGallery

src/SaveAllTheTabs/Commands/PackageCommands.cs

@@ -58,6 +58,7 @@ public static void Initialize(SaveAllTheTabsPackage package)
         /// <param name="package">Owner package, not null.</param>
         private PackageCommands(SaveAllTheTabsPackage package)
         {
+            ThreadHelper.ThrowIfNotOnUIThread();
             if (package == null)
             {
                 throw new ArgumentNullException(nameof(package));
@@ -74,6 +75,7 @@ private PackageCommands(SaveAllTheTabsPackage package)
 
         private void SetupCommands(OleMenuCommandService commandService)
         {
+            ThreadHelper.ThrowIfNotOnUIThread();
             var guid = typeof(CommandIds).GUID;
 
             var commandId = new CommandID(guid, (int)CommandIds.SaveTabs);
@@ -114,6 +116,7 @@ private void SetupCommands(OleMenuCommandService commandService)
 
         private void CommandOnBeforeQueryStatus(object sender, EventArgs eventArgs)
         {
+            ThreadHelper.ThrowIfNotOnUIThread();
             var command = sender as OleMenuCommand;
             if (command == null)
             {
@@ -138,6 +141,7 @@ private void ExecuteSaveTabsCommand(object sender, EventArgs e)
 
         private void ExecuteSavedTabsWindowCommand(object sender, EventArgs e)
         {
+            ThreadHelper.ThrowIfNotOnUIThread();
             // Get the instance number 0 of this tool window. This window is single instance so this instance
             // is actually the only one.
             // The last flag is set to true so that if the tool window does not exists it will be created.

src/SaveAllTheTabs/Commands/RestoreTabsListCommands.cs

@@ -25,6 +25,7 @@ public RestoreTabsListCommands(SaveAllTheTabsPackage package)
 
         public void SetupCommands(OleMenuCommandService commandService)
         {
+            ThreadHelper.ThrowIfNotOnUIThread();
             if (Package.DocumentManager == null)
             {
                 return;

src/SaveAllTheTabs/Commands/SavedTabsWindowCommands.cs

@@ -81,6 +81,7 @@ private void SetupCommands(OleMenuCommandService commandService)
 
         private void SaveToCommandOnBeforeQueryStatus(object sender, EventArgs eventArgs)
         {
+            ThreadHelper.ThrowIfNotOnUIThread();
             var command = sender as OleMenuCommand;
             if (command == null)
             {
@@ -93,6 +94,7 @@ private void SaveToCommandOnBeforeQueryStatus(object sender, EventArgs eventArgs
 
         private void CloseCommandOnBeforeQueryStatus(object sender, EventArgs eventArgs)
         {
+            ThreadHelper.ThrowIfNotOnUIThread();
             var command = sender as OleMenuCommand;
             if (command == null)
             {

src/SaveAllTheTabs/DocumentManager.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections;
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
 using System.Collections.Specialized;
@@ -8,8 +9,12 @@
 using System.Linq;
 using System.Reactive.Disposables;
 using System.Reactive.Linq;
+using System.Text;
+using System.Windows.Forms;
+using Microsoft;
 using Microsoft.VisualStudio;
 using Microsoft.VisualStudio.Settings;
+using Microsoft.VisualStudio.Shell;
 using Microsoft.VisualStudio.Shell.Interop;
 using Microsoft.VisualStudio.Shell.Settings;
 using Newtonsoft.Json;
@@ -67,28 +72,39 @@ internal class DocumentManager : IDocumentManager
 
         private const string StorageCollectionPath = "SaveAllTheTabs";
         private const string SavedTabsStoragePropertyFormat = "SavedTabs.{0}";
+        private const string ProjectGroupsKeyPlaceholder = StorageCollectionPath + "\\{0}\\groups";
 
         private SaveAllTheTabsPackage Package { get; }
         private IServiceProvider ServiceProvider => Package;
         private IVsUIShellDocumentWindowMgr DocumentWindowMgr { get; }
-        private string SolutionName => Package.Environment.Solution?.FullName;
+        private string SolutionName
+        {
+            get
+            {
+                ThreadHelper.ThrowIfNotOnUIThread();
+                return Package.Environment.Solution?.FullName;
+            }
+        }
 
         public ObservableCollection<DocumentGroup> Groups { get; private set; }
 
         public DocumentManager(SaveAllTheTabsPackage package)
         {
+            ThreadHelper.ThrowIfNotOnUIThread();
             Package = package;
 
             package.SolutionChanged += (sender, args) => LoadGroups();
             LoadGroups();
 
             DocumentWindowMgr = ServiceProvider.GetService(typeof(IVsUIShellDocumentWindowMgr)) as IVsUIShellDocumentWindowMgr;
+            Assumes.Present(DocumentWindowMgr);
         }
 
         private IDisposable _changeSubscription;
 
         private void LoadGroups()
         {
+            ThreadHelper.ThrowIfNotOnUIThread();
             _changeSubscription?.Dispose();
 
             // Load presets for the current solution
@@ -121,6 +137,7 @@ private void LoadGroups()
 
         public void SaveGroup(string name, int? slot = null)
         {
+            ThreadHelper.ThrowIfNotOnUIThread();
             if (DocumentWindowMgr == null)
             {
                 Debug.Assert(false, "IVsUIShellDocumentWindowMgr", String.Empty, 0);
@@ -212,11 +229,13 @@ private void TrySetSlot(DocumentGroup group, int? slot)
 
         public void RestoreGroup(int slot)
         {
+            ThreadHelper.ThrowIfNotOnUIThread();
             RestoreGroup(Groups.FindBySlot(slot));
         }
 
         public void RestoreGroup(DocumentGroup group)
         {
+            ThreadHelper.ThrowIfNotOnUIThread();
             if (group == null)
             {
                 return;
@@ -228,13 +247,15 @@ public void RestoreGroup(DocumentGroup group)
                 SaveUndoGroup();
             }
 
-            Package.Environment.Documents.CloseAll();
+            if (windows.Any())
+                windows.CloseAll();
 
             OpenGroup(group);
         }
 
         public void OpenGroup(int slot)
         {
+            ThreadHelper.ThrowIfNotOnUIThread();
             OpenGroup(Groups.FindBySlot(slot));
         }
 
@@ -247,6 +268,7 @@ public void OpenGroup(DocumentGroup group)
 
             using (var stream = new VsOleStream())
             {
+                ThreadHelper.ThrowIfNotOnUIThread();
                 stream.Write(group.Positions, 0, group.Positions.Length);
                 stream.Seek(0, SeekOrigin.Begin);
 
@@ -265,6 +287,7 @@ public void CloseGroup(DocumentGroup group)
                 return;
             }
 
+            ThreadHelper.ThrowIfNotOnUIThread();
             var documents = from d in Package.Environment.GetDocuments()
                             where @group.Files.Contains(d.FullName)
                             select d;
@@ -333,6 +356,7 @@ public void RemoveGroup(DocumentGroup group, bool confirm = true)
 
         private void SaveUndoGroup()
         {
+            ThreadHelper.ThrowIfNotOnUIThread();
             SaveGroup(UndoGroupName);
         }
 
@@ -362,16 +386,19 @@ private void SaveUndoGroup(DocumentGroup group)
 
         public void SaveStashGroup()
         {
+            ThreadHelper.ThrowIfNotOnUIThread();
             SaveGroup(StashGroupName);
         }
 
         public void OpenStashGroup()
         {
+            ThreadHelper.ThrowIfNotOnUIThread();
             OpenGroup(Groups.FindByName(StashGroupName));
         }
 
         public void RestoreStashGroup()
         {
+            ThreadHelper.ThrowIfNotOnUIThread();
             RestoreGroup(Groups.FindByName(StashGroupName));
         }
 
@@ -401,31 +428,49 @@ public void RestoreStashGroup()
 
         private List<DocumentGroup> LoadGroupsForSolution()
         {
+            ThreadHelper.ThrowIfNotOnUIThread();
             var solution = SolutionName;
-            if (!string.IsNullOrWhiteSpace(solution))
-            {
-                try
-                {
-                    var settingsMgr = new ShellSettingsManager(ServiceProvider);
-                    var store = settingsMgr.GetReadOnlySettingsStore(SettingsScope.UserSettings);
+            List<DocumentGroup> groups = new List<DocumentGroup>();
+            if (string.IsNullOrWhiteSpace(solution)) {
+                return groups;
+            }
+
+            try {
+                var settingsMgr = new ShellSettingsManager(ServiceProvider);
+                var store = settingsMgr.GetReadOnlySettingsStore(SettingsScope.UserSettings);
+
+                string projectKeyHash = GetHashString(solution);
+                string projectGroupsKey = string.Format(ProjectGroupsKeyPlaceholder, projectKeyHash);
 
+                if (!store.CollectionExists(projectGroupsKey))
+                {
+                    // try load tabs from older versions
                     var propertyName = String.Format(SavedTabsStoragePropertyFormat, solution);
                     if (store.PropertyExists(StorageCollectionPath, propertyName))
                     {
                         var tabs = store.GetString(StorageCollectionPath, propertyName);
-                        return JsonConvert.DeserializeObject<List<DocumentGroup>>(tabs);
+                        groups = JsonConvert.DeserializeObject<List<DocumentGroup>>(tabs);
                     }
+
+                    return groups;
                 }
-                catch (Exception ex)
+
+                var groupProperties = store.GetPropertyNamesAndValues(projectGroupsKey);
+                foreach (var groupProperty in groupProperties)
                 {
-                    Debug.Assert(false, nameof(LoadGroupsForSolution), ex.ToString());
+                    DocumentGroup group = JsonConvert.DeserializeObject<DocumentGroup>(groupProperty.Value.ToString());
+                    groups.Add(group);
                 }
+            } catch (Exception ex) {
+                Debug.Assert(false, nameof(LoadGroupsForSolution), ex.ToString());
+            }
+
+            return groups;
             }
-            return new List<DocumentGroup>();
-        }
 
         private void SaveGroupsForSolution(IList<DocumentGroup> groups = null)
         {
+            ThreadHelper.ThrowIfNotOnUIThread();
             var solution = SolutionName;
             if (string.IsNullOrWhiteSpace(solution))
             {
@@ -440,20 +485,36 @@ private void SaveGroupsForSolution(IList<DocumentGroup> groups = null)
             var settingsMgr = new ShellSettingsManager(ServiceProvider);
             var store = settingsMgr.GetWritableSettingsStore(SettingsScope.UserSettings);
 
-            if (!store.CollectionExists(StorageCollectionPath))
+            string projectKeyHash = GetHashString(solution);
+            string projectGroupsKey = string.Format(ProjectGroupsKeyPlaceholder, projectKeyHash);
+
+            if (store.CollectionExists(projectGroupsKey))
             {
-                store.CreateCollection(StorageCollectionPath);
+                store.DeleteProperty(StorageCollectionPath, projectGroupsKey);
             }
+            store.CreateCollection(projectGroupsKey);
 
-            var propertyName = String.Format(SavedTabsStoragePropertyFormat, solution);
-            if (!groups.Any())
+            foreach (DocumentGroup group in groups)
             {
-                store.DeleteProperty(StorageCollectionPath, propertyName);
-                return;
+                var serializedGroup = JsonConvert.SerializeObject(group);
+                store.SetString(projectGroupsKey, group.Name, serializedGroup);
             }
+        }
 
-            var tabs = JsonConvert.SerializeObject(groups);
-            store.SetString(StorageCollectionPath, propertyName, tabs);
+        private static string GetHashString(string source)
+        {
+            using (System.Security.Cryptography.MD5 md5 = System.Security.Cryptography.MD5.Create())
+            {
+                byte[] inputBytes = System.Text.Encoding.ASCII.GetBytes(source);
+                byte[] hashBytes = md5.ComputeHash(inputBytes);
+                // Convert the byte array to hexadecimal string
+                StringBuilder sb = new StringBuilder();
+                for (int i = 0; i < hashBytes.Length; i++)
+                {
+                    sb.Append(hashBytes [i].ToString("X2"));
+                }
+                return sb.ToString();
+            }
         }
 
         public static bool IsStashGroup(string name)