Migrating formula node deserialization to code block nodes

src/DynamoCore/Engine/MigrateFormulaToDS.cs

@@ -0,0 +1,101 @@
+using System.Collections.Generic;
+using System.Globalization;
+using System.Linq;
+using System.Text.RegularExpressions;
+using ProtoCore;
+using ProtoCore.AST.AssociativeAST;
+using ProtoCore.SyntaxAnalysis;
+using ProtoCore.Utils;
+
+namespace Dynamo.Engine
+{
+    internal class MigrateFormulaToDS : AstReplacer
+    {
+        private static readonly TextInfo textInfo = CultureInfo.InvariantCulture.TextInfo;
+
+        /// <summary>
+        /// Regex to match "if(<condition>, <true>, <false>)" pattern in Formula node and extract the parts of the
+        /// "if" statement to construct the corresponding conditional AST in DS. This is because the DS parser does not
+        /// recognize this "if" syntax.
+        /// </summary>
+        private const string ifCond = @"(if\s*)\(\s*(.*?)\s*\)$";
+        private static readonly Regex ifRgx = new Regex(ifCond, RegexOptions.IgnoreCase);
+
+
+        internal string ConvertFormulaToDS(string formula)
+        {
+            CodeBlockNode cbn = null;
+            var match = ifRgx.Match(formula);
+
+            List<AssociativeNode> dsAst = new List<AssociativeNode>();
+            if (match.Success)
+            {
+                var cond = match.Groups[2].Value;
+                var expArray = $"[{cond}];";
+
+                try
+                {
+                    cbn = ParserUtils.Parse(expArray);
+                }
+                catch
+                {
+                    return formula;
+                }
+                var asts = MigrateFormulaToCodeBlockNode(cbn.Body).ToList();
+                var exprList = (asts[0] as BinaryExpressionNode).RightNode as ExprListNode;
+                var condAst = exprList.Exprs[0];
+                var trueAst = exprList.Exprs[1];
+                var falseAst = exprList.Exprs[2];
+
+                dsAst.Add(AstFactory.BuildConditionalNode(condAst, trueAst, falseAst));
+            }
+            else
+            {
+                cbn = ParserUtils.Parse(formula + ";");
+                dsAst.AddRange(MigrateFormulaToCodeBlockNode(cbn.Body));
+            }
+            var codegen = new CodeGenDS(dsAst);
+            return codegen.GenerateCode();
+        }
+
+        private IEnumerable<AssociativeNode> MigrateFormulaToCodeBlockNode(IEnumerable<AssociativeNode> nodes)
+        {
+            return nodes.Select(node => node.Accept(new MigrateFormulaToDS()));
+        }
+
+        public override AssociativeNode VisitFunctionCallNode(FunctionCallNode node)
+        {
+            node = base.VisitFunctionCallNode(node) as FunctionCallNode;
+            var funcName = textInfo.ToTitleCase(node.Function.Name);
+
+            if (funcName == "Sin" || funcName == "Cos" || funcName == "Tan")
+            {
+                funcName = $"DSCore.Math.{funcName}";
+                node.Function.Name = funcName;
+                (node.Function as IdentifierNode).Value = funcName;
+
+                var arg = node.FormalArguments.FirstOrDefault();
+
+                var newArg = AstFactory.BuildFunctionCall("DSCore.Math", "RadiansToDegrees", new List<AssociativeNode> { arg });
+                node.FormalArguments = new List<AssociativeNode> { newArg };
+            }
+            else if (funcName == "Asin" || funcName == "Acos" || funcName == "Atan")
+            {
+                funcName = $"DSCore.Math.{funcName}";
+                node.Function.Name = funcName;
+                (node.Function as IdentifierNode).Value = funcName;
+
+                node = AstFactory.BuildFunctionCall(
+                    "DSCore.Math", "DegreesToRadians", new List<AssociativeNode> { node }) as FunctionCallNode;
+            }
+            else if(funcName == "Exp" || funcName == "Log10" || funcName == "Pow" || funcName == "Sqrt" || funcName == "Abs"
+                || funcName == "Floor" || funcName == "Ceiling" || funcName == "Round")
+            {
+                funcName = $"DSCore.Math.{funcName}";
+                node.Function.Name = funcName;
+                (node.Function as IdentifierNode).Value = funcName;
+            }
+            return node;
+        }
+    }
+}

src/DynamoCore/Graph/Nodes/CodeBlockNode.cs

@@ -658,6 +658,21 @@ internal void ProcessCodeDirect(ProcessCodeDelegate handler, bool isCodeBlockNod
             OnNodeModified();
         }
 
+        internal void Warning(string p)
+        {
+            State = ElementState.MigratedFormula;
+            if (!Infos.Any(x => x.Message.Equals(p)))
+            {
+                var texts = p.Split(new[] { System.Environment.NewLine }, StringSplitOptions.None);
+                var infoList = new List<Info>();
+                foreach (var text in texts)
+                {
+                    infoList.Add(new Info(text, State));
+                }
+                Infos.AddRange(infoList);
+            }
+        }
+
         /// <summary>
         /// Undefine a function definition in a code block node if it has any.
         /// </summary>

src/DynamoCore/Graph/Nodes/NodeModel.cs

@@ -1841,7 +1841,7 @@ protected virtual void SetNodeStateBasedOnConnectionAndDefaults()
 
             if (State == ElementState.PersistentWarning) return;
 
-            if (Infos.Any(x => x.State == ElementState.PersistentWarning))
+            if (Infos.Any(x => x.State == ElementState.PersistentWarning || x.State == ElementState.MigratedFormula))
             {
                 State = ElementState.PersistentWarning;
                 return;
@@ -2921,7 +2921,8 @@ public enum ElementState
         PersistentWarning,
         Error,
         AstBuildBroken,
-        Info
+        Info,
+        MigratedFormula
     };
 
     /// <summary>

src/DynamoCore/Graph/Workspaces/SerializationConverters.cs

@@ -1,8 +1,11 @@
 using System;
 using System.Collections.Generic;
 using System.Diagnostics;
+using System.Globalization;
 using System.Linq;
 using System.Reflection;
+using System.Runtime.InteropServices.WindowsRuntime;
+using System.Text.RegularExpressions;
 using Dynamo.Configuration;
 using Dynamo.Core;
 using Dynamo.Engine;
@@ -21,11 +24,14 @@
 using Dynamo.Properties;
 using Dynamo.Scheduler;
 using Dynamo.Utilities;
+using DynamoServices;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 using Newtonsoft.Json.Serialization;
 using ProtoCore;
+using ProtoCore.AST.AssociativeAST;
 using ProtoCore.Namespace;
+using ProtoCore.Utils;
 using Type = System.Type;
 
 namespace Dynamo.Graph.Workspaces
@@ -46,6 +52,39 @@ public class NodeReadConverter : JsonConverter
         // Map of all loaded assemblies including LoadFrom context assemblies
         private Dictionary<string, List<Assembly>> loadedAssemblies;
 
+        private CodeBlockNodeModel DeserializeAsCBN(string code, JObject obj, Guid guid)
+        {
+            var codeBlockNode = new CodeBlockNodeModel(code, guid, 0.0, 0.0, libraryServices, ElementResolver);
+
+            // If the code block node is in an error state read the extra port data
+            // and initialize the input and output ports
+            if (codeBlockNode.IsInErrorState)
+            {
+                List<string> inPortNames = new List<string>();
+                var inputs = obj["Inputs"];
+                foreach (var input in inputs)
+                {
+                    inPortNames.Add(input["Name"].ToString());
+                }
+
+                // NOTE: This could be done in a simpler way, but is being implemented
+                //       in this manner to allow for possible future port line number
+                //       information being available in the file
+                List<int> outPortLineIndexes = new List<int>();
+                var outputs = obj["Outputs"];
+                int outputLineIndex = 0;
+                foreach (var output in outputs)
+                {
+                    outPortLineIndexes.Add(outputLineIndex++);
+                }
+
+                codeBlockNode.SetErrorStatePortData(inPortNames, outPortLineIndexes);
+            }
+            return codeBlockNode;
+        }
+
+
+
         [Obsolete("This constructor will be removed in Dynamo 3.0, please use new NodeReadConverter constructor with additional parameters to support node migration.")]
         public NodeReadConverter(CustomNodeManager manager, LibraryServices libraryServices, bool isTestMode = false)
         {
@@ -111,7 +150,7 @@ public override object ReadJson(JsonReader reader, Type objectType, object exist
             {
                type = Type.GetType(obj["$type"].Value<string>());
                typeName = obj["$type"].Value<string>().Split(',').FirstOrDefault();
-
+                
                 if (typeName.Equals("Dynamo.Graph.Nodes.ZeroTouch.DSFunction"))
                 {
                     // If it is a zero touch node, then get the whole function name including the namespace.
@@ -165,7 +204,7 @@ public override object ReadJson(JsonReader reader, Type objectType, object exist
 
             // If the id is not a guid, makes a guid based on the id of the node
             var guid = GuidUtility.tryParseOrCreateGuid(obj["Id"].Value<string>());
-
+            
             var replication = obj["Replication"].Value<string>();
 
             var inPorts = obj["Inputs"].ToArray().Select(t => t.ToObject<PortModel>()).ToArray();
@@ -176,10 +215,29 @@ public override object ReadJson(JsonReader reader, Type objectType, object exist
 
             bool remapPorts = true;
 
-            // If type is still null at this point return a dummy node
             if (type == null)
             {
-                node = CreateDummyNode(obj, typeName, assemblyName, functionName, inPorts, outPorts);
+                if (typeName == "CoreNodeModels.Formula")
+                {
+                    var code = obj["Formula"].Value<string>();
+                    var formulaConverter = new MigrateFormulaToDS();
+                    var convertedCode = formulaConverter.ConvertFormulaToDS(code);
+
+                    node = DeserializeAsCBN(convertedCode + ";", obj, guid);
+                    if (code == convertedCode)
+                    {
+                        (node as CodeBlockNodeModel).Warning(Resources.FormulaDSConversionFailure);
+                    }
+                    else
+                    {
+                        (node as CodeBlockNodeModel).Warning(Resources.FormulaMigrated);
+                    }
+                }
+                else
+                {
+                    // If type is still null at this point return a dummy node
+                    node = CreateDummyNode(obj, typeName, assemblyName, functionName, inPorts, outPorts);
+                }
             }
             // Attempt to create a valid node using the type
             else if (type == typeof(Function))
@@ -201,33 +259,7 @@ public override object ReadJson(JsonReader reader, Type objectType, object exist
             else if (type == typeof(CodeBlockNodeModel))
             {
                 var code = obj["Code"].Value<string>();
-                CodeBlockNodeModel codeBlockNode = new CodeBlockNodeModel(code, guid, 0.0, 0.0, libraryServices, ElementResolver);
-                node = codeBlockNode;
-
-                // If the code block node is in an error state read the extra port data
-                // and initialize the input and output ports
-                if (node.IsInErrorState)
-                {
-                    List<string> inPortNames = new List<string>();
-                    var inputs = obj["Inputs"];
-                    foreach (var input in inputs)
-                    {
-                        inPortNames.Add(input["Name"].ToString());
-                    }
-
-                    // NOTE: This could be done in a simpler way, but is being implemented
-                    //       in this manner to allow for possible future port line number
-                    //       information being available in the file
-                    List<int> outPortLineIndexes = new List<int>();
-                    var outputs = obj["Outputs"];
-                    int outputLineIndex = 0;
-                    foreach (var output in outputs)
-                    {
-                        outPortLineIndexes.Add(outputLineIndex++);
-                    }
-
-                    codeBlockNode.SetErrorStatePortData(inPortNames, outPortLineIndexes);
-                }
+                node = DeserializeAsCBN(code, obj, guid);
             }
             else if (typeof(DSFunctionBase).IsAssignableFrom(type))
             {
@@ -261,10 +293,6 @@ public override object ReadJson(JsonReader reader, Type objectType, object exist
                 var functionId = Guid.Parse(obj["FunctionSignature"].Value<string>());
                 node = manager.CreateCustomNodeInstance(functionId);
             }
-            else if (type.ToString() == "CoreNodeModels.Formula")
-            {
-                node = (NodeModel)obj.ToObject(type);
-            }
             else
             {
                 node = (NodeModel)obj.ToObject(type);

src/DynamoCore/Properties/Resources.en-US.resx

@@ -902,4 +902,10 @@ This package likely contains an assembly that is blocked. You will need to load
   <data name="DynamoLanguages_noxlate" xml:space="preserve">
     <value>English,Čeština,Deutsch,Español,Français,Italiano,日本語,한국어,Polski,Português (Brasil),Русский,简体中文,繁體中文</value>
   </data>
+  <data name="FormulaDSConversionFailure" xml:space="preserve">
+    <value>Formula failed to convert to DesignScript code. Please edit the formula manually to use it in a CodeBlock node.</value>
+  </data>
+  <data name="FormulaMigrated" xml:space="preserve">
+    <value>Formula node has been deprecated. It has been automatically migrated to a CodeBlock node.</value>
+  </data>
 </root>

src/DynamoCore/Properties/Resources.resx

@@ -905,4 +905,10 @@ This package likely contains an assembly that is blocked. You will need to load
   <data name="DynamoLanguages_noxlate" xml:space="preserve">
     <value>English,Čeština,Deutsch,Español,Français,Italiano,日本語,한국어,Polski,Português (Brasil),Русский,简体中文,繁體中文</value>
   </data>
+  <data name="FormulaDSConversionFailure" xml:space="preserve">
+    <value>Formula failed to convert to DesignScript code. Please edit the formula manually to use it in a CodeBlock node.</value>
+  </data>
+  <data name="FormulaMigrated" xml:space="preserve">
+    <value>Formula node has been deprecated. It has been automatically migrated to a CodeBlock node.</value>
+  </data>
 </root>

src/Libraries/CoreNodeModels/CoreNodeModels.csproj

@@ -24,11 +24,6 @@
     <None Remove="CoreNodeModelsImages.resources" />
   </ItemGroup>
   <ItemGroup Condition=" '$(TargetFramework)' == 'net48' ">
-    <PackageReference Include="ncalc" Version="1.3.8">
-      <GeneratePathProperty>true</GeneratePathProperty>
-      <!--Exclude copying the runtime dlls because we will handle it in the BinaryCompatibilityOps target -->
-      <ExcludeAssets>runtime</ExcludeAssets>
-    </PackageReference>
       <Reference Include="System.Web" />
       <Reference Include="System.Windows" />
       <Reference Include="System.Xaml" />
@@ -96,9 +91,6 @@
       <LastGenOutput>Resources.en-US.Designer.cs</LastGenOutput>
     </EmbeddedResource>
   </ItemGroup>
-  <Target Name="BinaryCompatibilityOps" BeforeTargets="Build" Condition=" '$(TargetFramework)' == 'net48' ">
-    <Copy SourceFiles="$(PkgNCalc)\lib\NCalc.dll" DestinationFolder="$(OutputPath)" />
-  </Target>
   <Target Name="GenerateFiles" AfterTargets="ResolveSateliteResDeps" Condition=" '$(OS)' != 'Unix' ">
     <!-- Get assembly -->
     <GetAssemblyIdentity AssemblyFiles="$(OutDir)$(TargetName).dll">