add package states under dbg mode (#11698)

pinzart90 · web-flow · commit f656121e0ce3 · 2021-05-24T10:12:27.000-04:00
* add package states under dbg mode
diff --git a/src/DynamoCore/Configuration/DebugModes.cs b/src/DynamoCore/Configuration/DebugModes.cs
@@ -48,6 +48,7 @@ private static void RegisterDebugModes()
         {
             // Register app wide new debug modes here.
             AddDebugMode("DynamoPreferencesMenuDebugMode", "Enable/Disable the Preferences MenuItem in the Dynamo menu.", true);
+            AddDebugMode("DynamoPackageStates", "Enable/Disable package states in the InstalledPackages UI.", false);
         }
 
         internal static void LoadDebugModesStatusFromConfig(string configPath)
diff --git a/src/DynamoCore/Properties/Resources.Designer.cs b/src/DynamoCore/Properties/Resources.Designer.cs
diff --git a/src/DynamoCore/Properties/Resources.en-US.resx b/src/DynamoCore/Properties/Resources.en-US.resx
@@ -747,4 +747,32 @@ Parameter name: {0}</value>
   <data name="DuplicatedNewerPackage" xml:space="preserve">
     <value>A newer version of the package called {0} version {2} was found at {1} with version {3}. The newer version has been ignored.</value>
   </data>
+  <data name="PackageStatePendingUnload" xml:space="preserve">
+    <value>Scheduled to be unloaded</value>
+  </data>
+    <data name="PackageStateError" xml:space="preserve">
+    <value>Error</value>
+  </data>
+    <data name="PackageStateLoaded" xml:space="preserve">
+    <value>Loaded</value>
+  </data>
+  <data name="PackageStateUnloaded" xml:space="preserve">
+    <value>Unloaded</value>
+  </data>
+  <data name="PackageStatePendingUnloadTooltip" xml:space="preserve">
+    <value>Scheduled to be unloaded.
+This package will be unloaded after the next Dynamo restart.</value>
+  </data>
+    <data name="PackageStateErrorTooltip" xml:space="preserve">
+    <value>Unloaded.
+This package has not been loaded due to an unexpected error.</value>
+  </data>
+    <data name="PackageStateLoadedTooltip" xml:space="preserve">
+    <value>Loaded.
+This package is loaded and ready to be used.</value>
+  </data>
+    <data name="PackageStateUnloadedTooltip" xml:space="preserve">
+    <value>Unloaded.
+This package has not been loaded because another conflicting package was loaded before it.</value>
+  </data>
 </root>
diff --git a/src/DynamoCore/Properties/Resources.resx b/src/DynamoCore/Properties/Resources.resx
@@ -747,4 +747,32 @@ Parameter name: {0}</value>
   <data name="Autocomplete" xml:space="preserve">
     <value>Autocomplete</value>
   </data>
+    <data name="PackageStatePendingUnload" xml:space="preserve">
+    <value>Scheduled to be unloaded</value>
+  </data>
+    <data name="PackageStateError" xml:space="preserve">
+    <value>Error</value>
+  </data>
+    <data name="PackageStateLoaded" xml:space="preserve">
+    <value>Loaded</value>
+  </data>
+    <data name="PackageStateUnloaded" xml:space="preserve">
+    <value>Unloaded</value>
+  </data>
+  <data name="PackageStatePendingUnloadTooltip" xml:space="preserve">
+    <value>Scheduled to be unloaded.
+This package will be unloaded after the next Dynamo restart.</value>
+  </data>
+    <data name="PackageStateErrorTooltip" xml:space="preserve">
+    <value>Unloaded.
+This package has not been loaded due to an unexpected error.</value>
+  </data>
+    <data name="PackageStateLoadedTooltip" xml:space="preserve">
+    <value>Loaded.
+This package is loaded and ready to be used.</value>
+  </data>
+    <data name="PackageStateUnloadedTooltip" xml:space="preserve">
+    <value>Unloaded.
+This package has not been loaded because another conflicting package was loaded before it.</value>
+  </data>
 </root>
diff --git a/src/DynamoCoreWpf/ViewModels/PackageManager/PackageManagerClientViewModel.cs b/src/DynamoCoreWpf/ViewModels/PackageManager/PackageManagerClientViewModel.cs
@@ -9,6 +9,7 @@
 using System.Threading.Tasks;
 using System.Windows;
 using System.Windows.Input;
+using Dynamo.Configuration;
 using Dynamo.Core;
 using Dynamo.Graph.Nodes.CustomNodes;
 using Dynamo.Graph.Workspaces;
@@ -779,6 +780,13 @@ internal void SetPackageState(PackageDownloadHandle packageDownloadHandle, strin
             {
                 PackageManagerExtension.PackageLoader.LoadPackages(new List<Package> { dynPkg });
                 packageDownloadHandle.DownloadState = PackageDownloadHandle.State.Installed;
+
+                if (DebugModes.IsEnabled("DynamoPackageStates"))
+                {
+                    // Temporary location for setting the package state.
+                    // Should be moved somewhere with more visibility into possible errors.
+                    dynPkg.PackageState = Package.PackageStates.Loaded;
+                }
             }
             else
             {
diff --git a/src/DynamoCoreWpf/Views/PackageManager/InstalledPackagesView.xaml b/src/DynamoCoreWpf/Views/PackageManager/InstalledPackagesView.xaml
@@ -89,12 +89,30 @@
                                                    FontSize="11"
                                                    Foreground="#CCC"></TextBlock>
                                         <TextBlock Text="{x:Static p:Resources.InstalledPackageViewPendingInstallButton}"
-                                                   Visibility="{Binding Path=Model.MarkedForUninstall, Converter={StaticResource BooleanToVisibilityCollapsedConverter}}"
+                                                   Visibility="{Binding Path=Model.EnableOldMarkedForUnistallState, Converter={StaticResource BooleanToVisibilityCollapsedConverter}}"
                                                    FontSize="11"
                                                    FontStyle="Italic"
                                                    Foreground="Red"></TextBlock>
+                                        <Grid
+                                            Visibility="{Binding Path=Model.EnablePackageStates, Converter={StaticResource BooleanToVisibilityCollapsedConverter}}"
+                                            Height="18"
+                                            MaxWidth="150"
+                                            >
+                                            <Border Background="DimGray"
+                                                    HorizontalAlignment="Stretch"
+                                                    CornerRadius="5"
+                                                    ToolTip="{Binding Path=Model.PackageStateTooltip}"
+                                                    Margin="5,0,0,0"
+                                                    Padding="5,0,5,0">
+                                                <TextBlock Text="{Binding Path=Model.PackageStateText}"
+                                                        TextTrimming="CharacterEllipsis"
+                                                        FontSize="11"
+                                                        FontStyle="Italic"
+                                                        HorizontalAlignment="Center"
+                                                        Foreground="WhiteSmoke"/>
+                                            </Border>
+                                        </Grid>
                                     </StackPanel>
-
                                     <Button Name="MoreButton"
                                             HorizontalAlignment="Right"
                                             Content="⋮"
diff --git a/src/DynamoPackages/Package.cs b/src/DynamoPackages/Package.cs
@@ -15,6 +15,7 @@
 using Dynamo.Utilities;
 using Greg.Requests;
 using Newtonsoft.Json;
+using Dynamo.Configuration;// Used for DebugModes
 using String = System.String;
 
 namespace Dynamo.PackageManager
@@ -107,12 +108,71 @@ public bool TypesVisibleInManager
         public IEnumerable<string> HostDependencies { get { return hostDependencies; } set { hostDependencies = value; RaisePropertyChanged("HostDependencies"); } }
 
         private bool markedForUninstall;
+
         public bool MarkedForUninstall
         {
             get { return markedForUninstall; }
             internal set { markedForUninstall = value; RaisePropertyChanged("MarkedForUninstall"); }
         }
 
+        [Obsolete("This is a temporary property. Please do not use it")]
+        public bool EnableOldMarkedForUnistallState
+        {
+            get { return !DebugModes.IsEnabled("DynamoPackageStates") && MarkedForUninstall; }
+        }
+
+        [Obsolete("This is a temporary property. Please do not use it")]
+        public bool EnablePackageStates
+        {
+            get { return DebugModes.IsEnabled("DynamoPackageStates"); }
+        }
+
+        internal enum PackageStates
+        {
+            Loaded, Unloaded, PendingUnload, Error
+        }
+
+        internal PackageStates PackageState;
+
+        [Obsolete("This is a temporary property. Please do not use it")]
+        public string PackageStateTooltip
+        {
+            get
+            {
+                if (!DebugModes.IsEnabled("DynamoPackageStates"))
+                {
+                    return "DO NOT USE THIS";
+                }
+
+                switch (PackageState)
+                {
+                    case PackageStates.PendingUnload: return Resources.PackageStatePendingUnloadTooltip;
+                    case PackageStates.Unloaded: return Resources.PackageStateUnloadedTooltip;
+                    case PackageStates.Loaded: return Resources.PackageStateLoadedTooltip;
+                    case PackageStates.Error: return Resources.PackageStateErrorTooltip;
+                    default: return "Unkonwn package state";
+                }
+            }
+        }
+
+        [Obsolete("This is a temporary property. Please do not use it")]
+        public string PackageStateText { get {
+                if (!DebugModes.IsEnabled("DynamoPackageStates"))
+                {
+                    return "DO NOT USE THIS";
+                }
+
+                switch (PackageState)
+                {
+                    case PackageStates.PendingUnload: return Resources.PackageStatePendingUnload;
+                    case PackageStates.Unloaded: return Resources.PackageStateUnloaded;
+                    case PackageStates.Loaded: return Resources.PackageStateLoaded;
+                    case PackageStates.Error: return Resources.PackageStateError;
+                    default: return "Unkonwn package state";
+                }
+            }
+        }
+
         private string _group = "";
         public string Group { get { return _group; } set { _group = value; RaisePropertyChanged("Group"); } }
 
@@ -425,6 +485,10 @@ private bool IsWorkspaceFromPackageOpen(DynamoModel dynamoModel)
         internal void MarkForUninstall(IPreferences prefs)
         {
             MarkedForUninstall = true;
+            if (DebugModes.IsEnabled("DynamoPackageStates"))
+            {
+                PackageState = PackageStates.PendingUnload;
+            }
 
             if (!prefs.PackageDirectoriesToUninstall.Contains(RootDirectory))
             {
@@ -435,6 +499,12 @@ internal void MarkForUninstall(IPreferences prefs)
         internal void UnmarkForUninstall(IPreferences prefs)
         {
             MarkedForUninstall = false;
+            if (DebugModes.IsEnabled("DynamoPackageStates"))
+            {
+                // Should this be a "Loaded state" or something else ?
+                // Or maybe state should only be set when trying to Load the package...not here.
+                PackageState = PackageStates.Loaded;
+            }
             prefs.PackageDirectoriesToUninstall.RemoveAll(x => x.Equals(RootDirectory));
         }
 

Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,7 @@ private static void RegisterDebugModes()`
`48`	`48`	`{`
`49`	`49`	`// Register app wide new debug modes here.`
`50`	`50`	`AddDebugMode("DynamoPreferencesMenuDebugMode", "Enable/Disable the Preferences MenuItem in the Dynamo menu.", true);`
	`51`	`+ AddDebugMode("DynamoPackageStates", "Enable/Disable package states in the InstalledPackages UI.", false);`
`51`	`52`	`}`
`52`	`53`
`53`	`54`	`internal static void LoadDebugModesStatusFromConfig(string configPath)`