DYN-6602 Make Dynamo TSpline nodes OOTB and hide experiment toggle under feature flag (#14923)

QilongTang · web-flow · commit 3a7924f4bf30 · 2024-02-10T00:50:44.000+08:00
* first commit

* Add feature flag based list initial value manipulation

* Comments

* Updates

* Update

* Add event based TSplineNodes show/hide

* regressions
diff --git a/src/DynamoCore/Configuration/PreferenceSettings.cs b/src/DynamoCore/Configuration/PreferenceSettings.cs
@@ -1141,6 +1141,9 @@ internal static string GetDefaultPythonEngine()
             return defaultPythonEngine;
         }
 
+        /// <summary>
+        /// Initialize namespaces to exclude from Library based on conditions
+        /// </summary>
         internal void InitializeNamespacesToExcludeFromLibrary()
         {
             if (!NamespacesToExcludeFromLibrarySpecified)
@@ -1152,6 +1155,21 @@ internal void InitializeNamespacesToExcludeFromLibrary()
             }
         }
 
+        /// <summary>
+        /// Update namespaces to exclude from Library based on feature flags
+        /// </summary>
+        internal void UpdateNamespacesToExcludeFromLibrary()
+        {
+            // When the experiment toggle is disabled by feature flag, include the TSpline namespace from the library OOTB.
+            if (!DynamoModel.FeatureFlags?.CheckFeatureFlag("IsTSplineNodesExperimentToggleVisible", false) ?? false)
+            {
+                NamespacesToExcludeFromLibrary.Remove(
+                    "ProtoGeometry.dll:Autodesk.DesignScript.Geometry.TSpline"
+                );
+                return;
+            }
+        }
+
         //migrate old path token to new path token
         private static void MigrateStdLibTokenToBuiltInToken(PreferenceSettings settings)
         {
diff --git a/src/DynamoCore/Models/DynamoModel.cs b/src/DynamoCore/Models/DynamoModel.cs
@@ -36,6 +36,7 @@
 using Dynamo.Selection;
 using Dynamo.Utilities;
 using DynamoServices;
+using DynamoUtilities;
 using Greg;
 using Lucene.Net.Documents;
 using Lucene.Net.Index;
@@ -718,7 +719,7 @@ protected DynamoModel(IStartConfiguration config)
                     {
                         //this will kill the CLI process after cacheing the flags in Dynamo process.
                         using (FeatureFlags =
-                                new DynamoUtilities.DynamoFeatureFlagsManager(
+                                new DynamoFeatureFlagsManager(
                                 AnalyticsService.GetUserIDForSession(),
                                 mainThreadSyncContext,
                                 IsTestMode))
@@ -730,6 +731,7 @@ protected DynamoModel(IStartConfiguration config)
                     }
                     catch (Exception e) { Logger.LogError($"could not start feature flags manager {e}"); };
                 });
+                DynamoFeatureFlagsManager.FlagsRetrieved += HandleFeatureFlags;
             }
 
             // TBD: Do we need settings migrator for service mode? If we config the docker correctly, this could be skipped I think
@@ -977,6 +979,15 @@ protected DynamoModel(IStartConfiguration config)
             DynamoReady(new ReadyParams(this));
         }
 
+        /// <summary>
+        /// When feature flags received, handle them and make changes 
+        /// </summary>
+        private void HandleFeatureFlags()
+        {
+            PreferenceSettings.UpdateNamespacesToExcludeFromLibrary();
+            return;
+        }
+
         private void HandleAnalytics()
         {
             if (IsTestMode)
@@ -1369,6 +1380,7 @@ public void Dispose()
             LibraryServices.LibraryLoaded -= LibraryLoaded;
 
             EngineController.VMLibrariesReset -= ReloadDummyNodes;
+            DynamoFeatureFlagsManager.FlagsRetrieved -= HandleFeatureFlags;
 
             Logger.Dispose();
 
diff --git a/src/DynamoCoreWpf/ViewModels/Menu/PreferencesViewModel.cs b/src/DynamoCoreWpf/ViewModels/Menu/PreferencesViewModel.cs
@@ -1121,6 +1121,17 @@ public bool NodeAutocompleteMachineLearningIsBeta
             }
         }
 
+        /// <summary>
+        /// Controls if the TSpline nodes experiment toggle is visible from feature flag
+        /// </summary>
+        public bool IsTSplineNodesExperimentToggleVisible
+        {
+            get
+            {
+                return DynamoModel.FeatureFlags?.CheckFeatureFlag("IsTSplineNodesExperimentToggleVisible", false) ?? false;
+            }
+        }
+
         /// <summary>
         /// Contains the numbers of result of the ML recommendation
         /// </summary>
diff --git a/src/DynamoCoreWpf/Views/Menu/PreferencesView.xaml b/src/DynamoCoreWpf/Views/Menu/PreferencesView.xaml
@@ -1023,7 +1023,10 @@
                                         <RowDefinition Height="Auto"/>
                                     </Grid.RowDefinitions>
 
-                                    <StackPanel Orientation="Horizontal" Margin="0,12,0,0" Grid.Row="0">
+                                    <StackPanel Orientation="Horizontal"
+                                                Margin="0,12,0,0"
+                                                Grid.Row="0"
+                                                Visibility="{Binding IsTSplineNodesExperimentToggleVisible, Converter={StaticResource BooleanToVisibilityConverter}}">
                                         <ToggleButton Name="EnableTSplineToggle"
                                                       Width="{StaticResource ToggleButtonWidth}"
                                                       Height="{StaticResource ToggleButtonHeight}"
diff --git a/test/DynamoCoreWpfTests/NodeAutoCompleteSearchTests.cs b/test/DynamoCoreWpfTests/NodeAutoCompleteSearchTests.cs
@@ -166,7 +166,7 @@ public void NodeSuggestions_CanAutoCompleteOnCustomNodesOutPort_WithSpaceInPortN
 
             // Results will be nodes that accept Line as parameter.
             searchViewModel.PopulateAutoCompleteCandidates();
-            Assert.AreEqual(44, searchViewModel.FilteredResults.Count());
+            Assert.AreEqual(58, searchViewModel.FilteredResults.Count());
         }
         [Test]
         public void NodeSuggestions_CanAutoCompleteOnCustomNodesOutPort_WithWhiteSpaceStartingPortName()
@@ -186,7 +186,7 @@ public void NodeSuggestions_CanAutoCompleteOnCustomNodesOutPort_WithWhiteSpaceSt
 
             // Results will be nodes that accept Line as parameter.
             searchViewModel.PopulateAutoCompleteCandidates();
-            Assert.AreEqual(44, searchViewModel.FilteredResults.Count());
+            Assert.AreEqual(58, searchViewModel.FilteredResults.Count());
         }
 
         [Test]
@@ -316,7 +316,7 @@ public void NodeSuggestions_OutputPortBuiltInNode_AreCorrect()
 
             // Get the output port type for the node. 
             var outPorts = nodeView.ViewModel.OutPorts;
-            Assert.AreEqual(1, outPorts.Count());
+            Assert.AreEqual(1, outPorts.Count);
 
             var port = outPorts[0].PortModel;
             var type = port.GetOutPortType();
@@ -326,7 +326,7 @@ public void NodeSuggestions_OutputPortBuiltInNode_AreCorrect()
             var searchViewModel = ViewModel.CurrentSpaceViewModel.NodeAutoCompleteSearchViewModel;
             searchViewModel.PortViewModel = outPorts[0];
             var suggestions = searchViewModel.GetMatchingSearchElements();
-            Assert.AreEqual(44, suggestions.Count());
+            Assert.AreEqual(58, suggestions.Count());
         }
 
         [Test]

Original file line number	Diff line number	Diff line change
`@@ -1141,6 +1141,9 @@ internal static string GetDefaultPythonEngine()`
`1141`	`1141`	`return defaultPythonEngine;`
`1142`	`1142`	`}`
`1143`	`1143`
	`1144`	`+ /// <summary>`
	`1145`	`+ /// Initialize namespaces to exclude from Library based on conditions`
	`1146`	`+ /// </summary>`
`1144`	`1147`	`internal void InitializeNamespacesToExcludeFromLibrary()`
`1145`	`1148`	`{`
`1146`	`1149`	`if (!NamespacesToExcludeFromLibrarySpecified)`
`@@ -1152,6 +1155,21 @@ internal void InitializeNamespacesToExcludeFromLibrary()`
`1152`	`1155`	`}`
`1153`	`1156`	`}`
`1154`	`1157`
	`1158`	`+ /// <summary>`
	`1159`	`+ /// Update namespaces to exclude from Library based on feature flags`
	`1160`	`+ /// </summary>`
	`1161`	`+ internal void UpdateNamespacesToExcludeFromLibrary()`
	`1162`	`+ {`
	`1163`	`+ // When the experiment toggle is disabled by feature flag, include the TSpline namespace from the library OOTB.`
	`1164`	`+ if (!DynamoModel.FeatureFlags?.CheckFeatureFlag("IsTSplineNodesExperimentToggleVisible", false) ?? false)`
	`1165`	`+ {`
	`1166`	`+ NamespacesToExcludeFromLibrary.Remove(`
	`1167`	`+ "ProtoGeometry.dll:Autodesk.DesignScript.Geometry.TSpline"`
	`1168`	`+ );`
	`1169`	`+ return;`
	`1170`	`+ }`
	`1171`	`+ }`
	`1172`	`+`
`1155`	`1173`	`//migrate old path token to new path token`
`1156`	`1174`	`private static void MigrateStdLibTokenToBuiltInToken(PreferenceSettings settings)`
`1157`	`1175`	`{`