Skip custom logging logic when app is shutting down (#96)

* Skip custom logging logic when app is shutting down * Remove unused statements from TDKLogger * added/moved to appIsQuitting in main tdk instance * added appIsQuitting to base service * don't attempt event transmission on app quit (only persist - will be sent on next launch) * lifted analytics flush frequency settings to config * remove connect settings from packager --------- Co-authored-by: Yuri Visser <[email protected]>
TreasureProject · Aug 22, 2024 · 82eedd1 · 82eedd1
1 parent c3b157f
commit 82eedd1
Show file tree

Hide file tree

Showing 9 changed files with 33 additions and 16 deletions.
diff --git a/Assets/Treasure/TDK-Private/Editor/TDKPackagerCore.cs b/Assets/Treasure/TDK-Private/Editor/TDKPackagerCore.cs
@@ -40,7 +40,6 @@ public static void ExportPackage()
                 "Assets/Treasure/TDK/Runtime/Utils",
 
                 // Resources
-                "Assets/Treasure/TDK/Resources/TDKConnectSettings.asset",
                 "Assets/Treasure/TDK/Resources/TDKConnectThemeData.asset",
 
                 "Assets/package.json",

diff --git a/Assets/Treasure/TDK-Private/Editor/TDKPackagerFull.cs b/Assets/Treasure/TDK-Private/Editor/TDKPackagerFull.cs
@@ -28,7 +28,6 @@ public static void ExportPackage()
                 "Assets/Treasure/TDK/ConnectInternal",
                 "Assets/Treasure/TDK/ConnectPrefabs",
                 "Assets/Treasure/TDK/Editor",
-                "Assets/Treasure/TDK/Resources/TDKConnectSettings.asset",
                 "Assets/Treasure/TDK/Resources/TDKConnectThemeData.asset",
                 "Assets/Treasure/TDK/Runtime",
 

diff --git a/Assets/Treasure/TDK/Runtime/Infrastructure/TDKBaseService.cs b/Assets/Treasure/TDK/Runtime/Infrastructure/TDKBaseService.cs
@@ -6,6 +6,8 @@ namespace Treasure
     // why do we need empty game objects for services? it could be independent from unity
     public class TDKBaseService : MonoBehaviour
     {
+        protected bool appIsQuitting = false;
+
         public virtual void Awake()
         {
             DontDestroyOnLoad(this);

diff --git a/Assets/Treasure/TDK/Runtime/Infrastructure/TDKLogger.cs b/Assets/Treasure/TDK/Runtime/Infrastructure/TDKLogger.cs
@@ -1,7 +1,5 @@
 using UnityEngine;
 using System;
-using System.Collections;
-using System.Diagnostics;
 
 namespace Treasure
 {
@@ -36,6 +34,10 @@ public static void Log(string message)
         }
 
         private static void LogByLevel(TDKConfig.LoggerLevelValue loggerLevelValue, string message) {
+            if (TDK.Instance.appIsQuitting) {
+                Debug.Log($"[{loggerLevelValue}] {message}");
+                return;
+            }
             if (TDK.Instance.AppConfig.LoggerLevel > loggerLevelValue) {
                 return;
             }
@@ -44,13 +46,13 @@ private static void LogByLevel(TDKConfig.LoggerLevelValue loggerLevelValue, stri
             switch (loggerLevelValue)
             {
                 case TDKConfig.LoggerLevelValue.ERROR:
-                    UnityEngine.Debug.LogError(message);
+                    Debug.LogError(message);
                     break;
                 case TDKConfig.LoggerLevelValue.WARNING:
-                    UnityEngine.Debug.LogWarning(message);
+                    Debug.LogWarning(message);
                     break;
                 default:
-                    UnityEngine.Debug.Log(message);
+                    Debug.Log(message);
                     break;
             }
             #else
@@ -61,7 +63,7 @@ private static void LogByLevel(TDKConfig.LoggerLevelValue loggerLevelValue, stri
         private static void LogMessageInternal(string message)
         {
             try {
-                UnityEngine.Debug.Log(string.Format("[{0}] {1}", Time.realtimeSinceStartup, message));
+                Debug.Log(string.Format("[{0}] {1}", Time.realtimeSinceStartup, message));
             } catch {
                 // no-op
             }

diff --git a/Assets/Treasure/TDK/Runtime/Services/Treasure/Analytics/AnalyticsConstants.cs b/Assets/Treasure/TDK/Runtime/Services/Treasure/Analytics/AnalyticsConstants.cs
@@ -5,8 +5,6 @@ public static class AnalyticsConstants
         // event cache values
         public const int MAX_CACHE_EVENT_COUNT = 10;
         public const int MAX_CACHE_SIZE_KB = 64;
-        public const int MEMORY_CACHE_FLUSH_TIME_SECONDS = 10;
-        public const int DISK_CACHE_FLUSH_TIME_SECONDS = 60;
 
         // persistent store values
         public const string PERSISTENT_DIRECTORY_NAME = "AnalyticsStore";

diff --git a/Assets/Treasure/TDK/Runtime/Services/Treasure/Analytics/TDKAnalyticsService.Cache.cs b/Assets/Treasure/TDK/Runtime/Services/Treasure/Analytics/TDKAnalyticsService.Cache.cs
@@ -72,7 +72,7 @@ private async Task StartBackgroundDiskCacheFlush() {
                         break;
                     }
                 }
-                await Task.Delay(TimeSpan.FromSeconds(AnalyticsConstants.DISK_CACHE_FLUSH_TIME_SECONDS));
+                await Task.Delay(TimeSpan.FromSeconds(TDK.Instance.AppConfig.AnalyticsDiscFlushFrequencySeconds));
             }
         }
 
@@ -89,8 +89,8 @@ private async void TerminateCacheFlushing()
         private void ResetFlushTimer()
         {
             _flushCacheTimer?.Change(
-                TimeSpan.FromSeconds(AnalyticsConstants.MEMORY_CACHE_FLUSH_TIME_SECONDS),
-                TimeSpan.FromSeconds(AnalyticsConstants.MEMORY_CACHE_FLUSH_TIME_SECONDS)
+                TimeSpan.FromSeconds(TDK.Instance.AppConfig.AnalyticsMemoryFlushFrequencySeconds),
+                TimeSpan.FromSeconds(TDK.Instance.AppConfig.AnalyticsMemoryFlushFrequencySeconds)
             );
         }
 
@@ -105,8 +105,13 @@ private async Task FlushMemoryCache()
 
             if(memoryCacheCopy.Count > 0)
             {
-                // Send the batch of events for io
-                var success = await SendEventBatch(memoryCacheCopy);
+                var success = false;
+
+                if(!appIsQuitting)
+                {
+                    // Send the batch of events for io
+                    success = await SendEventBatch(memoryCacheCopy);
+                }
 
                 // If the request failed, persist the payload to disk in a separate task
                 if(!success)

diff --git a/Assets/Treasure/TDK/Runtime/Services/Treasure/Analytics/TDKAnalyticsService.cs b/Assets/Treasure/TDK/Runtime/Services/Treasure/Analytics/TDKAnalyticsService.cs
@@ -28,6 +28,7 @@ public override void Awake()
 #if !UNITY_WEBGL
         void OnApplicationQuit()
         {
+            appIsQuitting = true;
             TerminateCacheFlushing();
         }
 #endif

diff --git a/Assets/Treasure/TDK/Runtime/TDK.cs b/Assets/Treasure/TDK/Runtime/TDK.cs
@@ -17,11 +17,17 @@ public partial class TDK : MonoBehaviour
 
         public TDKConfig AppConfig { get; private set; }
 
+        internal bool appIsQuitting = false;
+
         void OnApplicationPause(bool isPaused)
         {
             Analytics?.OnApplicationPause_Analytics(isPaused);
         }
 
+        void OnApplicationQuit() {
+            appIsQuitting = true;
+        }
+
         public static TDK Instance
         {
             get

diff --git a/Assets/Treasure/TDK/Runtime/TDKConfig.cs b/Assets/Treasure/TDK/Runtime/TDKConfig.cs
@@ -53,6 +53,8 @@ public class AnalyticsConfig
         {
             public string _devApiUrl = "https://darkmatter.spellcaster.lol/ingress";
             public string _prodApiUrl = "https://darkmatter.treasure.lol/ingress";
+            public int _memoryFlushFrequencySeconds = 10;
+            public int _diskFlushFrequencySeconds = 30;
         }
 
         public enum Env { DEV, PROD }
@@ -95,7 +97,8 @@ public Env Environment
         public int SessionMinDurationLeftSec => _connect._sessionMinDurationLeftSec;
 
         public string AnalyticsApiUrl => Environment == Env.DEV ? _analytics._devApiUrl : _analytics._prodApiUrl;
-
+        public int AnalyticsMemoryFlushFrequencySeconds => _analytics._memoryFlushFrequencySeconds;
+        public int AnalyticsDiscFlushFrequencySeconds => _analytics._diskFlushFrequencySeconds;
 
         public LoggerLevelValue LoggerLevel
         {
@@ -249,6 +252,8 @@ public class SerializedAnalyticsConfig
         {
             public string devApiUrl;
             public string prodApiUrl;
+            public int memoryFlushFrequencySeconds;
+            public int diskFlushFrequencySeconds;
         }
 
         [Serializable]