Trigger for UI Loading events during analytics logging

BHoM_UI/Global/DocumentListener.cs

@@ -55,6 +55,8 @@ public static void OnDocumentBeginOpening(string documentName)
 
             m_OpeningTimes[documentName] = DateTime.Now.Ticks;
             Debug.WriteLine($"DocumentBeginOpening at {DateTime.Now.ToString("HH:mm:ss.ffffzzz")}");
+
+            BH.Engine.UI.Compute.SetDocumentOpeningState(true);
         }
 
         /*************************************/
@@ -76,6 +78,8 @@ public static void OnDocumentEndOpening(string documentName)
                 m_VersioningFormThead = new Thread(ShowForm);
                 m_VersioningFormThead.Start(events);
             }
+
+            BH.Engine.UI.Compute.SetDocumentOpeningState(false);
         }
 
         /*************************************/
@@ -90,6 +94,8 @@ public static void OnDocumentClosing(string documentName)
 
             if (!string.IsNullOrEmpty(documentName) && m_OpeningTimes.ContainsKey(documentName))
                 m_OpeningTimes.Remove(documentName);
+
+            BH.Engine.UI.Compute.SetDocumentOpeningState(false);
         }
 
 
@@ -212,7 +218,6 @@ private static Label GetCell(string text)
         private static Dictionary<string, long> m_OpeningTimes = new Dictionary<string, long>();
         private static Thread m_VersioningFormThead = null;
 
-
         /*************************************/
     }
 

UI_Engine/Compute/LogUsage.cs

@@ -55,7 +55,11 @@ public static void LogUsage(string uiName, string uiVersion, Guid componentId, s
                 SelectedItem = selectedItem,
                 FileID = fileId,
             };
-            TriggerUsageLog(args);
+
+            if (m_documentOpening)
+                TriggerUIOpening(args);
+            else
+                TriggerUsageLog(args);
 
             // If a projectID event is available, save the project code for this file
             var allEvents = BH.Engine.Base.Query.AllEvents();            
@@ -141,7 +145,6 @@ private static void RemoveDeprecatedLogs(string logFolder)
                     }
                 }
             }
-
         }
 
         /*************************************/
@@ -169,8 +172,8 @@ public static string BHoMVersion()
 
         private static void TriggerUsageLog(TriggerLogUsageArgs e)
         {
-            if (m_UsageLogTriggered != null)
-                m_UsageLogTriggered.Invoke(null, e);
+            if (m_UsageLogTriggered != null && !Compute.m_documentOpening)
+                m_UsageLogTriggered.Invoke(null, e); //Force the data to be set if the set project ID component is being run during the script load
         }
 
         /*************************************/
@@ -181,6 +184,14 @@ private static void TriggerUIClose()
                 m_UIClosed.Invoke(null, null);
         }
 
+        /*************************************/
+
+        private static void TriggerUIOpening(TriggerLogUsageArgs e)
+        {
+            if (m_UIOpening != null)
+                m_UIOpening.Invoke(null, e);
+        }
+
         /*************************************/
         /**** Static Fields               ****/
         /*************************************/
@@ -195,6 +206,7 @@ private static void TriggerUIClose()
 
         public static event EventHandler m_UsageLogTriggered;
         public static event EventHandler m_UIClosed;
+        public static event EventHandler m_UIOpening;
 
         /*************************************/
     }

UI_Engine/Objects/DocumentLoading.cs

@@ -0,0 +1,40 @@
+/*
+ * This file is part of the Buildings and Habitats object Model (BHoM)
+ * Copyright (c) 2015 - 2022, the respective contributors. All rights reserved.
+ *
+ * Each contributor holds copyright over their respective contributions.
+ * The project versioning (Git) records all such contribution source information.
+ *                                           
+ *                                                                              
+ * The BHoM is free software: you can redistribute it and/or modify         
+ * it under the terms of the GNU Lesser General Public License as published by  
+ * the Free Software Foundation, either version 3.0 of the License, or          
+ * (at your option) any later version.                                          
+ *                                                                              
+ * The BHoM is distributed in the hope that it will be useful,              
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of               
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the                 
+ * GNU Lesser General Public License for more details.                          
+ *                                                                            
+ * You should have received a copy of the GNU Lesser General Public License     
+ * along with this code. If not, see <https://www.gnu.org/licenses/lgpl-3.0.html>.      
+ */
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace BH.Engine.UI
+{
+    public static partial class Compute
+    {
+        private static bool m_documentOpening = false;
+
+        public static void SetDocumentOpeningState(bool state)
+        {
+            m_documentOpening = state;
+        }
+    }
+}

UI_Engine/UI_Engine.csproj

@@ -91,6 +91,7 @@
     <Compile Include="Create\OutputAccessor.cs" />
     <Compile Include="Create\InputAccessor.cs" />
     <Compile Include="Create\ParamInfo.cs" />
+    <Compile Include="Objects\DocumentLoading.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="Query\MatchWith.cs" />
     <Compile Include="Query\Changes.cs" />