Fix for regression in multi-output node preview (DynamoDS#11266)

* fix for multi-output node preview regression

* update tests

* add test

* revert unwanted changes

* update test

src/DynamoCoreWpf/ViewModels/Preview/WatchViewModel.cs

@@ -62,7 +62,7 @@ public ObservableCollection<WatchViewModel> Children
         }
 
         /// <summary>
-        /// The string lable visibile in the watch.
+        /// The string label visible in the watch.
         /// </summary>
         public string NodeLabel
         {

src/DynamoCoreWpf/Views/Preview/PreviewControl.xaml.cs

@@ -11,6 +11,7 @@
 using System.Windows.Threading;
 using Dynamo.Configuration;
 using Dynamo.Controls;
+using Dynamo.Graph.Nodes.ZeroTouch;
 using Dynamo.Interfaces;
 using Dynamo.Models;
 using Dynamo.Scheduler;
@@ -368,8 +369,17 @@ private void RefreshExpandedDisplay(Action refreshDisplay)
             RunOnSchedulerSync(
                 () =>
                 {
-                    var preferredDictionaryOrdering = 
-                    nodeViewModel.NodeModel.OutPorts.Select(p => p.Name).Where(n => !String.IsNullOrEmpty(n));
+                    IEnumerable<string> preferredDictionaryOrdering;
+                    if (nodeViewModel.NodeModel is DSFunction dsFunction)
+                    {
+                        preferredDictionaryOrdering = dsFunction.Controller.ReturnKeys;
+                    }
+                    else
+                    {
+                        preferredDictionaryOrdering =
+                            nodeViewModel.NodeModel.OutPorts.Select(p => p.Name).Where(n => !string.IsNullOrEmpty(n));
+                    }
+
                     newViewModel = nodeViewModel.DynamoViewModel.WatchHandler.GenerateWatchViewModelForData(
                         nodeViewModel.NodeModel.CachedValue, preferredDictionaryOrdering,
                         null, nodeViewModel.NodeModel.AstIdentifierForPreview.Name, false);

src/Libraries/CoreNodes/List.cs

@@ -444,7 +444,7 @@ public static IDictionary Deconstruct(IList list)
         /// <returns name="sortedList">type: var[]..[]</returns>
         /// <returns name="sortedKeys">type: var[]..[]</returns>
         /// <search>sort;key</search>
-        [MultiReturn(new[] { "sorted list", "sorted keys" })]
+        [MultiReturn("sortedList", "sortedKeys")]
         [IsVisibleInDynamoLibrary(true)]
         public static IDictionary SortByKey(IList list, IList keys)
         {
@@ -484,8 +484,8 @@ public static IDictionary SortByKey(IList list, IList keys)
 
             return new Dictionary<object, object>
             {
-                { "sorted list", sortedList },
-                { "sorted keys", sortedKeys }
+                { "sortedList", sortedList },
+                { "sortedKeys", sortedKeys }
             };
         }
 

test/DynamoCoreWpfTests/PreviewBubbleTests.cs

@@ -32,6 +32,7 @@ protected override void GetLibrariesToPreload(List<string> libraries)
         {
             libraries.Add("DesignScriptBuiltin.dll");
             libraries.Add("DSCoreNodes.dll");
+            libraries.Add("FFITarget.dll");
             base.GetLibrariesToPreload(libraries);
         }
 
@@ -354,6 +355,30 @@ public void PreviewBubble_ShowExpandedPreviewOnPinIconHover()
             Assert.IsTrue(previewBubble.IsExpanded, "Expanded preview bubble should be shown");
         }
 
+        [Test]
+        public void PreviewBubble_ShowExpandedPreview_MultiReturnNode()
+        {
+            Open(@"core\multireturnnode_preview.dyn");
+            var nodeView = NodeViewWithGuid("587d7494-e764-41fb-8b5d-a4229f7294ee");
+
+            var previewBubble = nodeView.PreviewControl;
+            previewBubble.RaiseEvent(new RoutedEventArgs(FrameworkElement.LoadedEvent));
+            previewBubble.bubbleTools.RaiseEvent(new RoutedEventArgs(FrameworkElement.LoadedEvent));
+
+            // open preview bubble
+            RaiseMouseEnterOnNode(nodeView);
+            Assert.IsTrue(previewBubble.IsCondensed, "Compact preview bubble should be shown");
+            Assert.AreEqual(Visibility.Collapsed, previewBubble.bubbleTools.Visibility, "Pin icon should not be shown");
+
+            // hover preview bubble to see pin icon
+            RaiseMouseEnterOnNode(previewBubble);
+            Assert.AreEqual(Visibility.Visible, previewBubble.bubbleTools.Visibility, "Pin icon should be shown");
+
+            // expand preview bubble
+            RaiseMouseEnterOnNode(previewBubble.bubbleTools);
+            Assert.IsTrue(previewBubble.IsExpanded, "Expanded preview bubble should be shown");
+        }
+
         [Test]
         public void PreviewBubble_ShownForColorRange()
         {

test/Engine/FFITarget/FFITarget.csproj

@@ -25,6 +25,7 @@
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
     <Prefer32Bit>false</Prefer32Bit>
+    <DocumentationFile>..\..\..\bin\AnyCPU\Debug\en-US\FFITarget.xml</DocumentationFile>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <DebugType>pdbonly</DebugType>

test/Engine/FFITarget/ProtoFFITests.cs

@@ -423,6 +423,14 @@ public int TestInternalClass(object y)
             return x.GetValue();
         }
 
+        /// <summary>
+        /// Return nested dictionary.
+        /// </summary>
+        /// <returns name="col">column</returns>
+        /// <returns name="dict">dictionary</returns>
+        /// <returns name="num">number</returns>
+        /// <returns name="wt">weight</returns>
+        /// <returns name="ok">okay</returns>
         [MultiReturn("color", "dict", "nums", "weight", "ok")]
         public Dictionary<string, object> ReturnNestedDictionary()
         {

test/Libraries/CoreNodesTests/ListTests.cs

@@ -1097,8 +1097,8 @@ public static void SortByKey1()
             var result = List.SortByKey(list, keys);
             var expected = new Dictionary<string, object>
             {
-                { "sorted list", new object[] { "item2", "item1" } },
-                { "sorted keys", new object[] { "key1", "key2" } }
+                { "sortedList", new object[] { "item2", "item1" } },
+                { "sortedKeys", new object[] { "key1", "key2" } }
             };
 
             Assert.AreEqual(expected, result);
@@ -1142,8 +1142,8 @@ public static void SortByKey4()
             var result = List.SortByKey(list, keys);
             var expected = new Dictionary<string, object>
             {
-                { "sorted list", new object[] { "Neal", "Matt", "Ian", "Zack", "Colin" } },
-                { "sorted keys", new object[] { "Burnham", "Jezyk", "Keough", "Kron", "McCrone" } }
+                { "sortedList", new object[] { "Neal", "Matt", "Ian", "Zack", "Colin" } },
+                { "sortedKeys", new object[] { "Burnham", "Jezyk", "Keough", "Kron", "McCrone" } }
             };
 
             Assert.AreEqual(expected, result);
@@ -1165,8 +1165,8 @@ public static void SortByKey5()
             var result = List.SortByKey(list, keys);
             var expected = new Dictionary<string, object>
             {
-                { "sorted list", new object[] { "Zack", "Ian", "Anna", "Neal" } },
-                { "sorted keys", new object[] { -3, 1.6, 5, "abc" } }
+                { "sortedList", new object[] { "Zack", "Ian", "Anna", "Neal" } },
+                { "sortedKeys", new object[] { -3, 1.6, 5, "abc" } }
             };
 
             Assert.AreEqual(expected, result);
@@ -1182,8 +1182,8 @@ public static void SortByKey6()
             var result = List.SortByKey(list, keys);
             var expected = new Dictionary<string, object>
             {
-                { "sorted list", new object[] { 2, 3, 1 }},
-                { "sorted keys", new object[] { 1.20, 1.2001, 1.21 } }
+                { "sortedList", new object[] { 2, 3, 1 }},
+                { "sortedKeys", new object[] { 1.20, 1.2001, 1.21 } }
             };
 
             Assert.AreEqual(expected, result);

test/core/multireturnnode_preview.dyn

@@ -0,0 +1,157 @@
+{
+  "Uuid": "cdab5b52-304f-4b23-8a5e-4a93ebdcafb9",
+  "IsCustomNode": false,
+  "Description": null,
+  "Name": "multireturnnode_preview",
+  "ElementResolver": {
+    "ResolutionMap": {}
+  },
+  "Inputs": [],
+  "Outputs": [],
+  "Nodes": [
+    {
+      "ConcreteType": "Dynamo.Graph.Nodes.ZeroTouch.DSFunction, DynamoCore",
+      "NodeType": "FunctionNode",
+      "FunctionSignature": "FFITarget.TestData.ReturnNestedDictionary",
+      "Id": "587d7494e76441fb8b5da4229f7294ee",
+      "Inputs": [
+        {
+          "Id": "0e6050e8916a454eab7cf2d87861cb07",
+          "Name": "testData",
+          "Description": "FFITarget.TestData",
+          "UsingDefaultValue": false,
+          "Level": 2,
+          "UseLevels": false,
+          "KeepListStructure": false
+        }
+      ],
+      "Outputs": [
+        {
+          "Id": "fddbb030b56041bf88ee3b0f0b44c493",
+          "Name": "col",
+          "Description": "column",
+          "UsingDefaultValue": false,
+          "Level": 2,
+          "UseLevels": false,
+          "KeepListStructure": false
+        },
+        {
+          "Id": "0f381b0e745e4604856705582cf0231c",
+          "Name": "dict",
+          "Description": "dictionary",
+          "UsingDefaultValue": false,
+          "Level": 2,
+          "UseLevels": false,
+          "KeepListStructure": false
+        },
+        {
+          "Id": "421f2476bb444d8ba1330c9fd8d6e4fd",
+          "Name": "num",
+          "Description": "number",
+          "UsingDefaultValue": false,
+          "Level": 2,
+          "UseLevels": false,
+          "KeepListStructure": false
+        },
+        {
+          "Id": "fc3fbe47234a4e0f8d4fa4385e301419",
+          "Name": "wt",
+          "Description": "weight",
+          "UsingDefaultValue": false,
+          "Level": 2,
+          "UseLevels": false,
+          "KeepListStructure": false
+        },
+        {
+          "Id": "8d8682c503d84a0f8da77833247df6a8",
+          "Name": "ok",
+          "Description": "okay",
+          "UsingDefaultValue": false,
+          "Level": 2,
+          "UseLevels": false,
+          "KeepListStructure": false
+        }
+      ],
+      "Replication": "Auto",
+      "Description": "Return nested dictionary.\n\nTestData.ReturnNestedDictionary ( ): var[]..[]"
+    },
+    {
+      "ConcreteType": "Dynamo.Graph.Nodes.ZeroTouch.DSFunction, DynamoCore",
+      "NodeType": "FunctionNode",
+      "FunctionSignature": "FFITarget.TestData.TestData",
+      "Id": "e64dd6ca741c4a09b722c7fb231cf474",
+      "Inputs": [],
+      "Outputs": [
+        {
+          "Id": "1404145039bf4ffbb2f648eecdce0928",
+          "Name": "TestData",
+          "Description": "TestData",
+          "UsingDefaultValue": false,
+          "Level": 2,
+          "UseLevels": false,
+          "KeepListStructure": false
+        }
+      ],
+      "Replication": "Auto",
+      "Description": "TestData.TestData ( ): TestData"
+    }
+  ],
+  "Connectors": [
+    {
+      "Start": "1404145039bf4ffbb2f648eecdce0928",
+      "End": "0e6050e8916a454eab7cf2d87861cb07",
+      "Id": "e9da6bf89a1f4ff98b09a22a57585115"
+    }
+  ],
+  "Dependencies": [],
+  "NodeLibraryDependencies": [],
+  "Bindings": [],
+  "View": {
+    "Dynamo": {
+      "ScaleFactor": 1.0,
+      "HasRunWithoutCrash": true,
+      "IsVisibleInDynamoLibrary": true,
+      "Version": "2.10.0.3246",
+      "RunType": "Automatic",
+      "RunPeriod": "1000"
+    },
+    "Camera": {
+      "Name": "Background Preview",
+      "EyeX": -17.0,
+      "EyeY": 24.0,
+      "EyeZ": 50.0,
+      "LookX": 12.0,
+      "LookY": -13.0,
+      "LookZ": -58.0,
+      "UpX": 0.0,
+      "UpY": 1.0,
+      "UpZ": 0.0
+    },
+    "NodeViews": [
+      {
+        "ShowGeometry": true,
+        "Name": "TestData.ReturnNestedDictionary",
+        "Id": "587d7494e76441fb8b5da4229f7294ee",
+        "IsSetAsInput": false,
+        "IsSetAsOutput": false,
+        "Excluded": false,
+        "X": 587.591972524768,
+        "Y": 366.80443744047426
+      },
+      {
+        "ShowGeometry": true,
+        "Name": "TestData.TestData",
+        "Id": "e64dd6ca741c4a09b722c7fb231cf474",
+        "IsSetAsInput": false,
+        "IsSetAsOutput": false,
+        "Excluded": false,
+        "X": 396.92609744922186,
+        "Y": 383.40302487798539
+      }
+    ],
+    "Annotations": [],
+    "X": -201.66090832590237,
+    "Y": -282.42730312803474,
+    "Zoom": 1.2374114765500794
+  }
+}