Feature/database improvements (#36)

* Database improvements

* Invalid meta file info

* Updated for 3.0.2

* Version update

* Store temporary json in memory

Co-authored-by: jasoncdavis0 <[email protected]>

Author: konraddysput

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Backtrace Unity Release Notes
 
+## Version 3.0.2
+- `BacktraceDatabase` now provides a new `Send` method. This method will try to send all objects from the database respecting the client side deduplication and retry setting. This can be used as an alternative to the `Flush` method which will try to send all objects from the database ignoring any client side deduplication and retry settings.
+- `BacktraceClient` has been optimized to only serialize data as needed.
+- `BacktraceDatabase` `AutoSend` function has been optimized for performance improvements.
+- `BacktraceClient` by default will generate configuration file with client rate limit equal to 50.
+- Fixed invalid meta file.
+
 ## Version 3.0.1
 - The `BacktraceDatabase` class will now create database directory before final database validation. Previously, when directory didn't exist, BacktraceDatabase was disabled.
 - The `BacktraceDatabase` field now allows users to pass interpolated string in Database options. Developer can use `${Application.dataPath}` or `${Application.persistentDataPath}` to set path to database. 

Editor/BacktraceConfigurationLabels.cs.meta

@@ -337,6 +337,7 @@ private void SendReport(BacktraceReport report, Action<BacktraceResult> sendCall
         private IEnumerator CollectDataAndSend(BacktraceReport report, Action<BacktraceResult> sendCallback = null)
         {
             BacktraceData data = SetupBacktraceData(report);
+            yield return new WaitForEndOfFrame();
             if (BeforeSend != null)
             {
                 data = BeforeSend.Invoke(data);
@@ -346,6 +347,11 @@ private IEnumerator CollectDataAndSend(BacktraceReport report, Action<BacktraceR
                 }
             }
             BacktraceDatabaseRecord record = null;
+
+            // avoid serializing data twice
+            // if record is here we should try to send json data that are available in record
+            // otherwise we can still use BacktraceData.ToJson().
+            string json = string.Empty;
             if (Database != null)
             {
                 yield return new WaitForEndOfFrame();
@@ -359,11 +365,21 @@ record = Database.Add(data);
                     {
                         yield break;
                     }
+                    json = record.BacktraceDataJson();
                 }
-
+            }
+            if (string.IsNullOrEmpty(json))
+            {
+                json = data.ToJson();
+            }
+            //backward compatibility 
+            if (RequestHandler != null)
+            {
+                yield return RequestHandler.Invoke(BacktraceApi.ServerUrl, data);
+                yield break;
             }
 
-            StartCoroutine(BacktraceApi.Send(data, (BacktraceResult result) =>
+            StartCoroutine(BacktraceApi.Send(json, data.Attachments, data.Deduplication, (BacktraceResult result) =>
             {
                 if (record != null)
                 {

Runtime/BacktraceClient.cs

@@ -106,7 +106,7 @@ public DeduplicationStrategy DeduplicationStrategy
         /// </summary>
         public void Reload()
         {
-
+            
             // validate configuration
             if (Configuration == null)
             {
@@ -169,6 +169,11 @@ private void Update()
                 return;
             }
             LastFrameTime = Time.time;
+            if (!DatabaseSettings.AutoSendMode)
+            {
+                return;
+            }
+
             if (Time.time - _lastConnection > DatabaseSettings.RetryInterval)
             {
                 _lastConnection = Time.time;
@@ -189,15 +194,15 @@ private void Start()
             {
                 return;
             }
-            if (DatabaseSettings.AutoSendMode)
-            {
-                _lastConnection = Time.time;
-            }
             // load reports from hard drive
             LoadReports();
             // remove orphaned files
             RemoveOrphaned();
-            SendData(BacktraceDatabaseContext.FirstOrDefault());
+            if (DatabaseSettings.AutoSendMode)
+            {
+                _lastConnection = Time.time;
+                SendData(BacktraceDatabaseContext.FirstOrDefault());
+            }
         }
 
         /// <summary>
@@ -238,7 +243,7 @@ public void Clear()
         /// <summary>
         /// Add new report to BacktraceDatabase
         /// </summary>
-        public BacktraceDatabaseRecord Add(BacktraceData data)
+        public BacktraceDatabaseRecord Add(BacktraceData data, bool @lock = true)
         {
             if (data == null || !Enable)
             {
@@ -251,7 +256,12 @@ public BacktraceDatabaseRecord Add(BacktraceData data)
             {
                 return null;
             }
-            return BacktraceDatabaseContext.Add(data);
+            var record = BacktraceDatabaseContext.Add(data);
+            if(!@lock)
+            {
+                record.Dispose();
+            }
+            return record;
         }
 
         /// <summary>
@@ -310,6 +320,19 @@ public void Flush()
             FlushRecord(BacktraceDatabaseContext.FirstOrDefault());
         }
 
+        /// <summary>
+        /// Try to send all data from database
+        /// </summary>
+        public void Send()
+        {
+            if(!Enable || !BacktraceDatabaseContext.Any())
+            {
+                return;
+            }
+
+            SendData(BacktraceDatabaseContext.FirstOrDefault());
+        }
+
         private void FlushRecord(BacktraceDatabaseRecord record)
         {
             if (record == null)
@@ -408,7 +431,7 @@ protected virtual bool InitializeDatabasePaths()
             {
                 return false;
             }
-            
+
             var databaseDirExists = Directory.Exists(DatabasePath);
 
             // handle situation when Backtrace plugin should create database directory

Runtime/BacktraceDatabase.cs

@@ -10,6 +10,10 @@ namespace Backtrace.Unity.Interfaces
     /// </summary>
     public interface IBacktraceApi
     {
+        /// <summary>
+        /// Server url
+        /// </summary>
+        string ServerUrl { get; }
         /// <summary>
         /// Send a Backtrace report to Backtrace API
         /// </summary>

Runtime/Interfaces/IBacktraceAPI.cs

@@ -80,7 +80,8 @@ public interface IBacktraceDatabase
         /// Add Backtrace data to database
         /// </summary>
         /// <param name="data">Backtrace data</param>
+        /// <param name="lock">Lock report - default true</param>
         /// <returns>Backtrace record</returns>
-        BacktraceDatabaseRecord Add(BacktraceData data);
+        BacktraceDatabaseRecord Add(BacktraceData data, bool @lock = true);
     }
 }

Runtime/Interfaces/IBacktraceDatabase.cs

@@ -23,8 +23,8 @@ public class BacktraceConfiguration : ScriptableObject
         /// <summary>
         /// Maximum number reports per minute
         /// </summary>
-        [Tooltip("Reports per minute: Limits the number of reports the client will send per minutes. If set to 0, there is no limit. If set to a higher value and the value is reached, the client will not send any reports until the next minute.")]
-        public int ReportPerMin;
+        [Tooltip("Reports per minute: Limits the number of reports the client will send per minutes. If set to 0, there is no limit. If set to a higher value and the value is reached, the client will not send any reports until the next minute. Default: 50")]
+        public int ReportPerMin = 50;
 
         /// <summary>
         /// Determine if client should catch unhandled exceptions

Runtime/Model/BacktraceConfiguration.cs

@@ -45,7 +45,7 @@ public class BacktraceData
         /// <summary>
         /// Version of the C# library
         /// </summary>
-        public const string AgentVersion = "3.0.1";
+        public const string AgentVersion = "3.0.2";
 
         /// <summary>
         /// Application thread details

Runtime/Model/BacktraceData.cs

@@ -15,7 +15,7 @@ public class BacktraceDatabaseConfiguration : BacktraceClientConfiguration
         public string DatabasePath;
 
         /// <summary>
-        /// Resend report when http client throw exception
+        /// When toggled on, the database will send automatically reports to Backtrace server based on the Retry Settings below. When toggled off, the developer will need to use the Flush method to attempt to send and clear. Recommend that this is toggled on.
         /// </summary>
         public bool AutoSendMode = true;
 

Runtime/Model/BacktraceDatabaseConfiguration.cs

@@ -58,6 +58,8 @@ public class BacktraceDatabaseRecord : IDisposable
         /// </summary>
         public List<string> Attachments { get; private set; }
 
+        private string _diagnosticDataJson;
+
         public bool Duplicated
         {
             get
@@ -84,6 +86,11 @@ public int Count
 
         public string BacktraceDataJson()
         {
+            if (!string.IsNullOrEmpty(_diagnosticDataJson))
+            {
+                return _diagnosticDataJson;
+            }
+
             if (Record != null)
             {
                 return Record.ToJson();
@@ -166,8 +173,8 @@ public bool Save()
         {
             try
             {
-                var diagnosticDataJson = Record.ToJson();
-                DiagnosticDataPath = Save(diagnosticDataJson, string.Format("{0}-attachment", Id));
+                _diagnosticDataJson = Record.ToJson();
+                DiagnosticDataPath = Save(_diagnosticDataJson, string.Format("{0}-attachment", Id));
 
                 if (Attachments != null && Attachments.Any())
                 {
@@ -342,6 +349,7 @@ protected virtual void Dispose(bool disposing)
             {
                 Locked = false;
                 Record = null;
+                _diagnosticDataJson = string.Empty;
             }
         }