DYN-6052 Add node info event and API under DynamoServices package for ProtoCore

src/DynamoCore/Graph/Nodes/NodeModel.cs

@@ -8,7 +8,6 @@
 using System.Runtime.Serialization;
 using System.Xml;
 using Autodesk.DesignScript.Runtime;
-using DesignScript.Builtin;
 using Dynamo.Configuration;
 using Dynamo.Engine;
 using Dynamo.Engine.CodeGeneration;

src/DynamoCore/Models/DynamoModel.cs

@@ -1006,6 +1006,7 @@ protected DynamoModel(IStartConfiguration config)
 #endif
 
             LogWarningMessageEvents.LogWarningMessage += LogWarningMessage;
+            LogInfoMessageEvents.LogInfoMessage += LogInfoMessage;
 
             StartBackupFilesTimer();
 
@@ -1371,6 +1372,7 @@ public void Dispose()
 #endif
 
             LogWarningMessageEvents.LogWarningMessage -= LogWarningMessage;
+            LogInfoMessageEvents.LogInfoMessage -= LogInfoMessage;
             foreach (var ws in _workspaces)
             {
                 ws.Dispose();
@@ -1792,6 +1794,16 @@ private void LogWarningMessage(LogWarningMessageEventArgs args)
             EngineController.LiveRunnerRuntimeCore.RuntimeStatus.LogWarning(WarningID.Default, args.message);
         }
 
+        /// <summary>
+        /// This info message is displayed on the node associated with the FFI dll
+        /// </summary>
+        /// <param name="args"></param>
+        private void LogInfoMessage(LogInfoMessageEventArgs args)
+        {
+            Validity.Assert(EngineController.LiveRunnerRuntimeCore != null);
+            EngineController.LiveRunnerRuntimeCore.RuntimeStatus.LogInfo(InfoID.Default, args.message);
+        }
+
         #endregion
 
         #region engine management

src/Engine/ProtoCore/RuntimeStatus.cs

@@ -52,13 +52,31 @@ public struct WarningEntry
             public int AstID;
             public string Filename;
         }
+
+        public enum InfoID
+        {
+            Default
+        }
+
+        public struct InfoEntry
+        {
+            public Runtime.InfoID ID;
+            public string Message;
+            public int Line;
+            public int Column;
+            public int ExpressionID;
+            public Guid GraphNodeGuid;
+            public int AstID;
+            public string Filename;
+        }
     }
 
     public class RuntimeStatus
     {
         private readonly DynamoLock rwl = new DynamoLock();
         private ProtoCore.RuntimeCore runtimeCore;
         private List<Runtime.WarningEntry> warnings;
+        private List<Runtime.InfoEntry> infos;
 
         public IOutputStream MessageHandler
         {
@@ -83,6 +101,17 @@ public List<Runtime.WarningEntry> Warnings
             }
         }
 
+        public List<Runtime.InfoEntry> Infos
+        {
+            get
+            {
+                using (rwl.CreateReadLock())
+                {
+                    return infos.ToList();
+                }
+            }
+        }
+
         public int WarningCount
         {
             get
@@ -196,11 +225,81 @@ public void LogWarning(Runtime.WarningID ID, string message, string filename, in
             }
         }
 
+        public void LogInfo(Runtime.InfoID ID, string message, string filename, int line, int col)
+        {
+            filename = filename ?? string.Empty;
+
+            if (!runtimeCore.Options.IsDeltaExecution && (string.IsNullOrEmpty(filename) ||
+                line == Constants.kInvalidIndex ||
+                col == Constants.kInvalidIndex))
+            {
+                AuditCodeLocation(ref filename, ref line, ref col);
+            }
+
+            var warningMsg = string.Format(Resources.kConsoleWarningMessage,
+                                           message, filename, line, col);
+
+#if DEBUG
+            if (runtimeCore.Options.Verbose)
+            {
+                System.Console.WriteLine(warningMsg);
+            }
+#endif
+
+            if (WebMessageHandler != null)
+            {
+                var outputMessage = new OutputMessage(warningMsg);
+                WebMessageHandler.Write(outputMessage);
+            }
+
+            if (MessageHandler != null)
+            {
+                var outputMessage = new OutputMessage(OutputMessage.MessageType.Info,
+                                                      message.Trim(), filename, line, col);
+                MessageHandler.Write(outputMessage);
+            }
+
+            AssociativeGraph.GraphNode executingGraphNode = null;
+            var executive = runtimeCore.CurrentExecutive.CurrentDSASMExec;
+            if (executive != null)
+            {
+                executingGraphNode = executive.Properties.executingGraphNode;
+                // In delta execution mode, it means the warning is from some
+                // internal graph node. 
+                if (executingGraphNode != null && executingGraphNode.guid.Equals(System.Guid.Empty))
+                {
+                    executingGraphNode = runtimeCore.DSExecutable.ExecutingGraphnode;
+                }
+            }
+
+            var entry = new Runtime.InfoEntry
+            {
+                ID = ID,
+                Message = message,
+                Column = col,
+                Line = line,
+                ExpressionID = runtimeCore.RuntimeExpressionUID,
+                GraphNodeGuid = executingGraphNode == null ? Guid.Empty : executingGraphNode.guid,
+                AstID = executingGraphNode == null ? Constants.kInvalidIndex : executingGraphNode.OriginalAstID,
+                Filename = filename
+            };
+
+            using (rwl.CreateWriteLock())
+            {
+                infos.Add(entry);
+            }
+        }
+
         public void LogWarning(Runtime.WarningID ID, string message)
         {
             LogWarning(ID, message, string.Empty, Constants.kInvalidIndex, Constants.kInvalidIndex);
         }
 
+        public void LogInfo(Runtime.InfoID ID, string message)
+        {
+            LogInfo(ID, message, string.Empty, Constants.kInvalidIndex, Constants.kInvalidIndex);
+        }
+
         private void AuditCodeLocation(ref string filePath, ref int line, ref int column)
         {
             // We don't attempt to change line and column numbers if 

src/NodeServices/MessageEvents.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 
 namespace DynamoServices
 {
@@ -12,6 +12,19 @@ public LogWarningMessageEventArgs(string msg)
         }
     }
 
+    /// <summary>
+    /// EventArgs for LogInfoMessageEventHandler
+    /// </summary>
+    public class LogInfoMessageEventArgs : EventArgs
+    {
+        public string message { get; internal set; }
+
+        public LogInfoMessageEventArgs(string msg)
+        {
+            message = msg;
+        }
+    }
+
     public delegate void LogWarningMessageEventHandler(LogWarningMessageEventArgs args);
 
     public static class LogWarningMessageEvents
@@ -24,6 +37,18 @@ public static void OnLogWarningMessage(string message)
         }
     }
 
+    public delegate void LogInfoMessageEventHandler(LogInfoMessageEventArgs args);
+
+    public static class LogInfoMessageEvents
+    {
+        public static event LogInfoMessageEventHandler LogInfoMessage;
+        public static void OnLogInfoMessage(string message)
+        {
+            if (LogInfoMessage != null)
+                LogInfoMessage(new LogInfoMessageEventArgs(message));
+        }
+    }
+
     internal static class LoadLibraryEvents
     {
         /// <summary>