Adding a new "IF" node that would simply return the truevalue or falsevalue based on the test condition. (#11481)

reddyashish · aparajit-pratap · web-flow · commit 218867e97172 · 2021-02-16T16:12:17.000-05:00
* attempt1 at creating partially applied function

* change implementation of If NodeModel node

* Move the functionality to a new if node that will be renamed.

* Update IfTest.cs

* Hiding the old If node and renaming to the new one to have the same  name.

* Throw a warning message when the old node is opened.

* add comments.

* Update the warning message and move it to the resources file.

* Fix failing test

Co-authored-by: Aparajit Pratap &lt;aparajit.pratap@autodesk.com&gt;
diff --git a/src/Libraries/CoreNodeModels/Logic/If.cs b/src/Libraries/CoreNodeModels/Logic/If.cs
@@ -1,5 +1,7 @@
-﻿using System.Collections.Generic;
+﻿using System;
+using System.Collections.Generic;
 using System.Linq;
+using Autodesk.DesignScript.Runtime;
 using CoreNodeModels.Properties;
 using Dynamo.Graph.Nodes;
 using Newtonsoft.Json;
@@ -14,6 +16,8 @@ namespace CoreNodeModels.Logic
     [OutPortTypes("Function")]
     [IsDesignScriptCompatible]
     [AlsoKnownAs("DSCoreNodesUI.Logic.If")]
+    [IsVisibleInDynamoLibrary(false)]
+    [Obsolete("This node will be removed in a future version of Dynamo. Please use the new 'If' node instead.")]
     public class If : NodeModel
     {
         [JsonConstructor]
@@ -32,13 +36,15 @@ public If()
 
         public override IEnumerable<AssociativeNode> BuildOutputAst(List<AssociativeNode> inputAstNodes)
         {
+            Warning(Resources.IFNodeWarningMessage, true);
+
             var lhs = GetAstIdentifierForOutputIndex(0);
             AssociativeNode rhs;
 
             if (IsPartiallyApplied)
             {
                 var connectedInputs = Enumerable.Range(0, InPorts.Count)
-                                            .Where(index=>InPorts[index].IsConnected)
+                                            .Where(index => InPorts[index].IsConnected)
                                             .Select(x => new IntNode(x) as AssociativeNode)
                                             .ToList();
                 var functionNode = new IdentifierNode(Constants.kInlineConditionalMethodName);
@@ -72,4 +78,52 @@ public override IEnumerable<AssociativeNode> BuildOutputAst(List<AssociativeNode
             };
         }
     }
+
+    [NodeName("If")]
+    [NodeCategory(BuiltinNodeCategories.LOGIC)]
+    [NodeDescription("ScopeIfDescription", typeof(Resources))]
+    [OutPortTypes("Function")]
+    [IsDesignScriptCompatible]
+    [AlsoKnownAs("DSCoreNodesUI.Logic.If")]
+    public class RefactoredIf : NodeModel
+    {
+        [JsonConstructor]
+        private RefactoredIf(IEnumerable<PortModel> inPorts, IEnumerable<PortModel> outPorts) : base(inPorts, outPorts) { }
+
+        public RefactoredIf()
+        {
+            InPorts.Add(new PortModel(PortType.Input, this, new PortData("test", Resources.PortDataTestBlockToolTip)));
+            InPorts.Add(new PortModel(PortType.Input, this, new PortData("true", Resources.PortDataTrueBlockToolTip)));
+            InPorts.Add(new PortModel(PortType.Input, this, new PortData("false", Resources.PortDataFalseBlockToolTip)));
+
+            OutPorts.Add(new PortModel(PortType.Output, this, new PortData("result", Resources.PortDataResultToolTip)));
+
+            RegisterAllPorts();
+        }
+
+        /// <summary>
+        /// This node will translate the following DS code into an AST output for the If NodeModel node. 
+        ///   result  = [trueValue, falseValue][boolCondition ? 0 : 1]
+        /// This node will just return the trueValue or the falseValue based on the input condition
+        /// and would be different to the conditional "If" node that was present before.
+        /// </summary>
+        /// <param name="inputAstNodes"> List of input AST nodes. </param>
+        /// <returns></returns>
+        public override IEnumerable<AssociativeNode> BuildOutputAst(List<AssociativeNode> inputAstNodes)
+        {
+            var lhs = GetAstIdentifierForOutputIndex(0);
+            AssociativeNode rhs;
+
+            var conditional = AstFactory.BuildConditionalNode(inputAstNodes[0], new IntNode(0), new IntNode(1));
+            var trueStmt = inputAstNodes[1];
+            var falseStmt = inputAstNodes[2];
+            var list = AstFactory.BuildExprList(new List<AssociativeNode> { trueStmt, falseStmt });
+            rhs = AstFactory.BuildIndexExpression(list, conditional);
+
+            return new[]
+            {
+                AstFactory.BuildAssignment(lhs, rhs)
+            };
+        }
+    }
 }
diff --git a/src/Libraries/CoreNodeModels/Properties/Resources.Designer.cs b/src/Libraries/CoreNodeModels/Properties/Resources.Designer.cs
diff --git a/src/Libraries/CoreNodeModels/Properties/Resources.en-US.resx b/src/Libraries/CoreNodeModels/Properties/Resources.en-US.resx
@@ -614,4 +614,7 @@ Default value: {0}</value>
   <data name="FilePathOutputDescription" xml:space="preserve">
     <value>File Path</value>
   </data>
+  <data name="IFNodeWarningMessage" xml:space="preserve">
+    <value>This node has been updated and will be removed in a future version of Dynamo. Existing behavior is retained, but a new version now supports Empty Lists, Null values and inputs of varying length. Please replace this node if you wish to use this improved behavior.</value>
+  </data>
 </root>
diff --git a/src/Libraries/CoreNodeModels/Properties/Resources.resx b/src/Libraries/CoreNodeModels/Properties/Resources.resx
@@ -614,4 +614,7 @@ Default value: {0}</value>
   <data name="FilePathOutputDescription" xml:space="preserve">
     <value>File Path</value>
   </data>
+  <data name="IFNodeWarningMessage" xml:space="preserve">
+    <value>This node has been updated and will be removed in a future version of Dynamo. Existing behavior is retained, but a new version now supports Empty Lists, Null values and inputs of varying length. Please replace this node if you wish to use this improved behavior.</value>
+  </data>
 </root>
diff --git a/test/DynamoCoreTests/Nodes/IfTest.cs b/test/DynamoCoreTests/Nodes/IfTest.cs
@@ -1,6 +1,8 @@
 ﻿using System.Collections.Generic;
 using System.IO;
+using CoreNodeModels.Input;
 using NUnit.Framework;
+using ProtoCore.AST.ImperativeAST;
 
 namespace Dynamo.Tests
 {
@@ -76,5 +78,24 @@ public void TestScopeIfForPreview()
             AssertPreviewValue("9fe8e82f-760d-43a6-90b2-5f9c252139d7", 42);
             AssertPreviewValue("23a03082-5807-4e44-9a3d-2d1eec4a914c", 42);
         }
+
+        [Test]
+        [Category("SmokeTest")]
+        public void TestNewIfForPreview()
+        {
+            string testFilePath = Path.Combine(testFolder, "testNewIf.dyn");
+            OpenModel(testFilePath);
+            BoolSelector boolSelectorNode = (BoolSelector) this.CurrentDynamoModel.CurrentWorkspace.NodeFromWorkspace("886a464b-9b2b-4e66-a033-c18d0753c2cf");
+
+            boolSelectorNode.Value = true;
+            AssertPreviewValue("886a464b-9b2b-4e66-a033-c18d0753c2cf", true);
+            AssertPreviewValue("904dcd03-94a3-4560-9cdf-8825e2ce63e6", new object[] { "a1", "b1", "c1" });
+            AssertPreviewValue("ceefb203-19b9-4eb3-b0e4-c355dcb84365", new object[] { 1, new object[] { 2 } });
+
+            boolSelectorNode.Value = false;
+            AssertPreviewValue("886a464b-9b2b-4e66-a033-c18d0753c2cf", false);
+            AssertPreviewValue("904dcd03-94a3-4560-9cdf-8825e2ce63e6", new object[] { new object[] { "a2" }, "b2" });
+            AssertPreviewValue("ceefb203-19b9-4eb3-b0e4-c355dcb84365", new object[] { });
+        }
     }
 }
diff --git a/test/core/logic/conditional/testNewIf.dyn b/test/core/logic/conditional/testNewIf.dyn
