improve node autocomplete results for custom node output ports (#14218)

mjkkirschner · web-flow · commit e7d76a68182e · 2023-08-07T09:05:46.000-04:00
* update tests
dont use type string, use name
dont use name with spaces, it will never be correct.

* add a new test

* comments

* review comments and new test
diff --git a/src/DynamoCoreWpf/ViewModels/Search/NodeAutoCompleteSearchViewModel.cs b/src/DynamoCoreWpf/ViewModels/Search/NodeAutoCompleteSearchViewModel.cs
@@ -18,6 +18,7 @@
 using Dynamo.Utilities;
 using Dynamo.Wpf.ViewModels;
 using Greg;
+using J2N.Text;
 using Lucene.Net.Documents;
 using Lucene.Net.QueryParsers.Classic;
 using Lucene.Net.Search;
@@ -760,6 +761,11 @@ internal IEnumerable<NodeSearchElement> GetMatchingSearchElements()
             else if (PortViewModel.PortModel.PortType == PortType.Output)
             {
                 portType = PortViewModel.PortModel.GetOutPortType();
+                //if the custom node output name contains spaces, try using the first word.
+                if (PortViewModel.PortModel.Owner is Graph.Nodes.CustomNodes.Function && portType.Any(char.IsWhiteSpace))
+                {
+                    portType = string.Concat(portType.TrimStart().TakeWhile(char.IsLetterOrDigit));
+                }
             }
 
             //List of input types that are skipped temporarily, and will display list of default suggestions instead.
@@ -784,7 +790,6 @@ internal IEnumerable<NodeSearchElement> GetMatchingSearchElements()
             var ast = parseResult?.CodeBlockNode.Children().FirstOrDefault() as IdentifierNode;
             //if parsing the type failed, revert to original string.
             portType = ast != null ? ast.datatype.Name : portType;
-
             //check if the input port return type is in the skipped input types list
             if (skippedInputTypes.Any(s => s == portType))
             {
@@ -824,7 +829,8 @@ internal IEnumerable<NodeSearchElement> GetMatchingSearchElements()
                 {
                     foreach (var inputParameter in ztSearchElement.Descriptor.Parameters.Select((value, index) => new { value, index }))
                     {
-                        if (inputParameter.value.Type.ToString() == portType || DerivesFrom(inputParameter.value.Type.ToString(), portType, core))
+                        var ZTparamName = inputParameter.value.Type.Name ?? inputParameter.value.Type.ToString();
+                        if (ZTparamName == portType || DerivesFrom(ZTparamName, portType, core))
                         {
                             ztSearchElement.AutoCompletionNodeElementInfo.PortToConnect = ztSearchElement.Descriptor.Type == FunctionType.InstanceMethod ? inputParameter.index + 1 : inputParameter.index;
                             elements.Add(ztSearchElement);
diff --git a/test/DynamoCoreWpfTests/NodeAutoCompleteSearchTests.cs b/test/DynamoCoreWpfTests/NodeAutoCompleteSearchTests.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using Dynamo;
 using Dynamo.Controls;
 using Dynamo.Graph.Nodes;
 using Dynamo.Models;
@@ -141,9 +142,50 @@ public void NodeSuggestions_CanAutoCompleteOnCustomNodesOutPort()
             // Set the suggestion to ObjectType
             searchViewModel.dynamoViewModel.PreferenceSettings.DefaultNodeAutocompleteSuggestion = NodeAutocompleteSuggestion.ObjectType;
 
-            // The initial list will fill the FilteredResults with a few options - all basic input types
+            // Results will be nodes that take color or color[] etc as params.
+            searchViewModel.PopulateAutoCompleteCandidates();
+            Assert.AreEqual(10, searchViewModel.FilteredResults.Count());
+        }
+
+        [Test]
+        public void NodeSuggestions_CanAutoCompleteOnCustomNodesOutPort_WithSpaceInPortName()
+        {
+            var outputNode = new Dynamo.Graph.Nodes.CustomNodes.Output();
+            outputNode.Symbol = "Line Nonsense";
+            var cnm = new Dynamo.Graph.Nodes.CustomNodes.Function(
+                new CustomNodeDefinition(Guid.NewGuid(), "mock", new List<NodeModel>() { outputNode })
+                , "mock", "mock", "mock");
+            var cnvm = new NodeViewModel(ViewModel.CurrentSpaceViewModel, cnm);
+
+            var searchViewModel = ViewModel.CurrentSpaceViewModel.NodeAutoCompleteSearchViewModel;
+            searchViewModel.PortViewModel = cnvm.OutPorts.First();
+
+            // Set the suggestion to ObjectType
+            searchViewModel.dynamoViewModel.PreferenceSettings.DefaultNodeAutocompleteSuggestion = NodeAutocompleteSuggestion.ObjectType;
+
+            // Results will be nodes that accept Line as parameter.
+            searchViewModel.PopulateAutoCompleteCandidates();
+            Assert.AreEqual(44, searchViewModel.FilteredResults.Count());
+        }
+        [Test]
+        public void NodeSuggestions_CanAutoCompleteOnCustomNodesOutPort_WithWhiteSpaceStartingPortName()
+        {
+            var outputNode = new Dynamo.Graph.Nodes.CustomNodes.Output();
+            outputNode.Symbol = "   Line Nonsense";
+            var cnm = new Dynamo.Graph.Nodes.CustomNodes.Function(
+                new CustomNodeDefinition(Guid.NewGuid(), "mock", new List<NodeModel>() { outputNode })
+                , "mock", "mock", "mock");
+            var cnvm = new NodeViewModel(ViewModel.CurrentSpaceViewModel, cnm);
+
+            var searchViewModel = ViewModel.CurrentSpaceViewModel.NodeAutoCompleteSearchViewModel;
+            searchViewModel.PortViewModel = cnvm.OutPorts.First();
+
+            // Set the suggestion to ObjectType
+            searchViewModel.dynamoViewModel.PreferenceSettings.DefaultNodeAutocompleteSuggestion = NodeAutocompleteSuggestion.ObjectType;
+
+            // Results will be nodes that accept Line as parameter.
             searchViewModel.PopulateAutoCompleteCandidates();
-            Assert.AreEqual(7, searchViewModel.FilteredResults.Count());
+            Assert.AreEqual(44, searchViewModel.FilteredResults.Count());
         }
 
         [Test]
@@ -282,7 +324,7 @@ public void NodeSuggestions_OutputPortBuiltInNode_AreCorrect()
             var searchViewModel = ViewModel.CurrentSpaceViewModel.NodeAutoCompleteSearchViewModel;
             searchViewModel.PortViewModel = outPorts[0];
             var suggestions = searchViewModel.GetMatchingSearchElements();
-            Assert.AreEqual(29, suggestions.Count());
+            Assert.AreEqual(44, suggestions.Count());
         }
 
         [Test]

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@`
`18`	`18`	`using Dynamo.Utilities;`
`19`	`19`	`using Dynamo.Wpf.ViewModels;`
`20`	`20`	`using Greg;`
	`21`	`+using J2N.Text;`
`21`	`22`	`using Lucene.Net.Documents;`
`22`	`23`	`using Lucene.Net.QueryParsers.Classic;`
`23`	`24`	`using Lucene.Net.Search;`
`@@ -760,6 +761,11 @@ internal IEnumerable<NodeSearchElement> GetMatchingSearchElements()`
`760`	`761`	`else if (PortViewModel.PortModel.PortType == PortType.Output)`
`761`	`762`	`{`
`762`	`763`	`portType = PortViewModel.PortModel.GetOutPortType();`
	`764`	`+ //if the custom node output name contains spaces, try using the first word.`
	`765`	`+ if (PortViewModel.PortModel.Owner is Graph.Nodes.CustomNodes.Function && portType.Any(char.IsWhiteSpace))`
	`766`	`+ {`
	`767`	`+ portType = string.Concat(portType.TrimStart().TakeWhile(char.IsLetterOrDigit));`
	`768`	`+ }`
`763`	`769`	`}`
`764`	`770`
`765`	`771`	`//List of input types that are skipped temporarily, and will display list of default suggestions instead.`
`@@ -784,7 +790,6 @@ internal IEnumerable<NodeSearchElement> GetMatchingSearchElements()`
`784`	`790`	`var ast = parseResult?.CodeBlockNode.Children().FirstOrDefault() as IdentifierNode;`
`785`	`791`	`//if parsing the type failed, revert to original string.`
`786`	`792`	`portType = ast != null ? ast.datatype.Name : portType;`
`787`		`-`
`788`	`793`	`//check if the input port return type is in the skipped input types list`
`789`	`794`	`if (skippedInputTypes.Any(s => s == portType))`
`790`	`795`	`{`
`@@ -824,7 +829,8 @@ internal IEnumerable<NodeSearchElement> GetMatchingSearchElements()`
`824`	`829`	`{`
`825`	`830`	`foreach (var inputParameter in ztSearchElement.Descriptor.Parameters.Select((value, index) => new { value, index }))`
`826`	`831`	`{`
`827`		`- if (inputParameter.value.Type.ToString() == portType \|\| DerivesFrom(inputParameter.value.Type.ToString(), portType, core))`
	`832`	`+ var ZTparamName = inputParameter.value.Type.Name ?? inputParameter.value.Type.ToString();`
	`833`	`+ if (ZTparamName == portType \|\| DerivesFrom(ZTparamName, portType, core))`
`828`	`834`	`{`
`829`	`835`	`ztSearchElement.AutoCompletionNodeElementInfo.PortToConnect = ztSearchElement.Descriptor.Type == FunctionType.InstanceMethod ? inputParameter.index + 1 : inputParameter.index;`
`830`	`836`	`elements.Add(ztSearchElement);`