com.amanotes.gdk 0.1.18 → 0.1.20

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [0.1.20 - 2023-04-20]
+### Refactor Adapter architure to support reading adapter config from Core
+### Add session stat for Analytics module
+### Unit test for Json parser and Analytics module
+
+## [0.1.19 - 2023-04-11]
+### Move AmaGDKTest out of AmaGDKCore
+
 ## [0.1.18 - 2023-03-27]
 ### Fix AmaGDK's autoInit saving issue
 

package/{Tests/TestScene00.unity.meta → Packages/AmaGDKTest.unitypackage.meta}

@@ -1,5 +1,5 @@
 fileFormatVersion: 2
-guid: d0b6ac2d48f974ba48ae61cbae556c4b
+guid: 4e129ed8b608d4cfcabb2a4e8c558f14
 DefaultImporter:
   externalObjects: {}
   userData: 

package/Runtime/AmaGDK.Adapters.cs

@@ -1,26 +1,23 @@
 using System;
 using System.Collections.Generic;
 
-using ConfigAsset = Amanotes.Core.Internal.ConfigAsset;
-using Status = Amanotes.Core.Internal.Status;
 using static Amanotes.Core.Internal.Logging;
-using static Amanotes.Core.Internal.Messsage;
 using System.Linq;
 
 namespace Amanotes.Core.Internal
 {
-
-    [Serializable] public class AdapterInfo
+    public abstract class AdapterContext
     {
-        public string id;
-        public string version;
+        public string adapterId;
+        public string adapterVersion;
         public int initOrder;
+
+        // Status support
         public Status status = Status.None;
-        public IAdapter adapter;
-        
-        public bool IsReady { get { return status == Status.Ready; }}
-        
-        public void Init(){
+        public bool IsReady { get { return status == Status.Ready; } }
+
+        public void Init()
+        {
             if (status != Status.None)
             {
                 LogWarning($"Invalid status: {status}");
@@ -28,62 +25,46 @@ namespace Amanotes.Core.Internal
             }
 
             status = Status.Initialize;
-            adapter.Init((success) =>
+            Init((success) =>
             {
                 status = success ? Status.Ready : Status.Failed;
             });
         }
 
-        public T GetAdapterApi<T>(){ return (T)adapter; }
-    }
-    
-    public interface IAdapter 
-    {
-        void Init(Action<bool> onCompleted);
+        protected virtual void Init(Action<bool> onCompleted) { }
+        public T GetAdapterApi<T>() { return (T)(object)this; }
+        public abstract T GetAdapterConfig<T>() where T : class;
     }
 
-    // public static class AdapterExtension
-    // {
-    //     public static string GetId<T>(this T adapter) where T: IAdapter {
-    //         return Adapter.GetId(typeof(T));
-    //     }
-    // } 
-
     public static class Adapter
     {
-        internal static readonly List<AdapterInfo> listAdapters = new List<AdapterInfo>();
-        
-        public static string GetId(Type adapterType) {
+        internal static readonly List<AdapterContext> listAdapters = new List<AdapterContext>();
+
+        public static string GetId(Type adapterType)
+        {
             return adapterType.Name.Replace("Adapter", string.Empty);
         }
 
-        public static void Register<T>(string version) where T : IAdapter, new()
+        public static void Register<T>(Func<ConfigAsset, T> createFunc) where T : AdapterContext
         {
-            var typeT = typeof(T);
-            var id = GetId(typeT);
-            
             if (AmaGDK._status != Status.None)
             {
                 LogWarningOnce($"RegisterAdapter - Invalid status: {AmaGDK._status}");
                 return;
             }
 
-            var orderConfig = AmaGDK.Config.initOrder.FirstOrDefault(item => item.id == id);
-            listAdapters.Add(new AdapterInfo()
-            {
-                id = id,
-                version = version,
-                initOrder = (orderConfig != null) ? orderConfig.order : 0,
-                adapter = new T()
-            });
+            var adapter = createFunc(AmaGDK.Config);
+            var orderConfig = AmaGDK.Config.initOrder.FirstOrDefault(item => item.id == adapter.adapterId);
+            if (orderConfig != null) adapter.initOrder = orderConfig.order;
+            listAdapters.Add(adapter);
         }
-
-        public static AdapterInfo Find<T>()
+        
+        public static AdapterContext Find<T>()
         {
             for (var i = 0; i < listAdapters.Count; i++)
             {
                 var item = listAdapters[i];
-                var itemType = item.adapter.GetType();
+                var itemType = item.GetType();
                 if (!typeof(T).IsAssignableFrom(itemType)) continue;
                 return item;
             }
@@ -91,13 +72,13 @@ namespace Amanotes.Core.Internal
             return default;
         }
 
-        public static List<AdapterInfo> FindAll<T>()
+        public static List<AdapterContext> FindAll<T>()
         {
-            var result = new List<AdapterInfo>();
+            var result = new List<AdapterContext>();
             for (var i = 0; i < listAdapters.Count; i++)
             {
                 var item = listAdapters[i];
-                var itemType = item.adapter.GetType();
+                var itemType = item.GetType();
                 if (!typeof(T).IsAssignableFrom(itemType)) continue;
                 result.Add(item);
             }

package/Runtime/AmaGDK.Analytics.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using UnityEngine;
+using System.Text;
 
 using Amanotes.Core.Internal;
 using static Amanotes.Core.Internal.Logging;
@@ -10,7 +11,7 @@ using EventParams = Amanotes.Core.AmaGDK.Analytics.EventParams;
 namespace Amanotes.Core
 {
     [Serializable]
-    public class AnalyticsAdapterBaseConfig
+    public class AnalyticsAdapterConfig
     {
         public bool SendEventByDefault;
 
@@ -75,7 +76,7 @@ namespace Amanotes.Core
                     if (!sendAtCount.TryGetValue(eventName, out var sendAtCountConfig)) return false;
 
                     int accumulatedCount = GetAccumulatedCount(eventName, sendAtCountConfig.withinSession);
-                    return sendAtCountConfig.listCount == null ? false : !sendAtCountConfig.listCount.Contains(accumulatedCount);
+                    return sendAtCountConfig.listCount != null && !sendAtCountConfig.listCount.Contains(accumulatedCount);
                 }
             }
 
@@ -230,8 +231,11 @@ namespace Amanotes.Core
             {
                 foreach (var adapterID in adapterIDs)
                 {
-                    var adapter = listAdapters.Find(a => a.id == adapterID)?.GetAdapterApi<IAnalyticAdapter>();
-                    adapter?.OnlyAllowEvents(eventNames);
+                    var adapter = listAdapters.Find(a => a.adapterId == adapterID);
+                    if (adapter == null) continue;
+
+                    var config = adapter.GetAdapterConfig<AnalyticsAdapterConfig>();
+                    config.AlwaysSend = eventNames;
                 }
             }
 
@@ -239,8 +243,11 @@ namespace Amanotes.Core
             {
                 foreach (var adapterID in adapterIDs)
                 {                    
-                    var adapter = listAdapters.Find(a => a.id == adapterID)?.GetAdapterApi<IAnalyticAdapter>();
-                    adapter?.OnlyBanEvents(eventNames);
+                    var adapter = listAdapters.Find(a => a.adapterId == adapterID);
+                    if (adapter == null) continue;
+
+                    var config = adapter.GetAdapterConfig<AnalyticsAdapterConfig>();
+                    config.NeverSend = eventNames;
                 }
             }
 
@@ -280,8 +287,9 @@ namespace Amanotes.Core
             internal static readonly Dictionary<string, EventConfig> sendAtCount = new Dictionary<string, EventConfig>();
             internal static Predicate<EventDetail> logEventHook = null;
             internal static readonly Queue<EventParams> eventQueue = new Queue<EventParams>();
-            internal static readonly List<AdapterInfo> listAdapters = new List<AdapterInfo>();
+            internal static readonly List<AdapterContext> listAdapters = new List<AdapterContext>();
             internal static readonly AnalyticsData localData = new AnalyticsData().LoadJsonFromFile();
+            internal static readonly SessionStat sessionStat = new SessionStat();
 
             internal static void Init()
             {
@@ -296,6 +304,7 @@ namespace Amanotes.Core
             {
                 if (eventQueue.Count <= 0) return;
                 bool showAnalyticsLog = Config.common.showAnalyticsLog;
+                sessionStat.ClearLastFrameEventInfo();
 
                 while (eventQueue.Count > 0)
                 {
@@ -313,14 +322,36 @@ namespace Amanotes.Core
                     var eventNameToSend = GetEventNameToSend(eventData.eventName, countInSession, totalCount);
                     NormalizeEventName(ref eventNameToSend);
 
-                    if (showAnalyticsLog) Debug.Log($"[AmaGDK] Event <{eventNameToSend}> (in session: {countInSession}, total: {totalCount})");
+					if (showAnalyticsLog) Debug.Log($"[AmaGDK] Event <{eventNameToSend}> (in session: {countInSession}, total: {totalCount})\n" +
+                                                    $"Params:\n{JsonUtils.DictionaryToJson(eventData.parameters, true)}");
+
+                    var inUseAdapterIDs = new List<string>();
                     foreach (var m in listAdapters)
                     {                        
-                        m.GetAdapterApi<IAnalyticAdapter>().LogEvent(eventNameToSend, eventData);
+                        var api = m.GetAdapterApi<IAnalyticAdapter>();
+                        var config = m.GetAdapterConfig<AnalyticsAdapterConfig>();
+
+                        if (eventData.overrideConfig)
+                        {
+                            // IMPORTANT NOTE:
+                            //
+                            // Once set overrideConfig, we should skip the adapter config completely!!!
+                            //
+                            if (eventData.IsAdapterForbidden(m.adapterId)) continue;
+                        }
+                        else // Do not remove else
+                        {
+                            if (config.IsForbidden(eventData.eventName)) continue;
+                        }
+
+                        api.LogEvent(eventNameToSend, eventData.parameters);
+                        inUseAdapterIDs.Add(m.adapterId);
                     }
+                    sessionStat.Add(eventNameToSend, eventData, inUseAdapterIDs);
                 }
 
                 localData.SaveIfDirty();
+                sessionStat.Save();
             }
 
             internal static string GetEventNameToSend(string eventName, int countInSession, int totalCount)
@@ -331,11 +362,17 @@ namespace Amanotes.Core
                 return $"{eventName}_{(config.withinSession ? countInSession : totalCount).ToString(config.numberFormat)}";
             }
 
-            internal static bool NormalizeEventName(ref string eventName)
+            internal static void NormalizeEventName(ref string eventName)
             {
                 var sb = tmpWarningSB;
                 sb.Clear();
 
+                if (string.IsNullOrEmpty(eventName))
+                {
+                    sb.AppendLine($" - EventName should not be empty");
+                    return;
+                }                    
+
                 var normalizedEventName = eventName.Trim()
                     .Replace(' ', '_')
                     .Replace('-', '_');
@@ -355,7 +392,6 @@ namespace Amanotes.Core
                 if (!char.IsLetter(eventName[0])) sb.AppendLine($" - EventName must start with a letter: <{eventName}> ");
                 if (eventName.Length > 40) sb.AppendLine($" - EventName is too long ({eventName.Length} > 40): <{eventName}> ");
                 if (sb.Length > 0) LogWarningOnce(sb.ToString(), $"NormalizeEventName<{eventName}>");
-                return true;
             }
 
             internal static bool ShouldSendEvent(EventParams eventData)
@@ -395,6 +431,26 @@ namespace Amanotes.Core
                 public int totalCount;
             }
 
+            [Serializable]
+            internal class EventStat
+            {
+                public string eventNameToSend;
+                public List<string> adapters;
+                public string parameters;                
+
+                public EventStat(string eventNameToSend, EventParams eventParams, List<string> adapterIDs)
+                {
+                    this.eventNameToSend = eventNameToSend;
+                    parameters = JsonUtils.DictionaryToJson(eventParams.parameters, false);
+                    adapters = adapterIDs;
+                }
+
+                public string ToTsv()
+                {
+                    return $"{eventNameToSend}\t{string.Join(",", adapters)}\t{parameters}";
+                }
+            }
+
             [Flags]
             internal enum IntegrityFlag
             {
@@ -414,10 +470,12 @@ namespace Amanotes.Core
 
                 public Dictionary<string, object> ToDictionary()
                 {
-                    var result = new Dictionary<string, object>();
-                    result.Add("device_id", deviceId);
-                    result.Add("app_version", appVersion);
-                    result.Add("amagdk_version", amaGDKVersion);
+                    var result = new Dictionary<string, object>
+                    {
+                        { "device_id", deviceId },
+                        { "app_version", appVersion },
+                        { "amagdk_version", amaGDKVersion }
+                    };
                     return result;
                 }
             }
@@ -425,14 +483,16 @@ namespace Amanotes.Core
             [Serializable]
             internal class AnalyticsData : IJsonFile
             {
-                [NonSerialized] internal bool _dirty = false;
+                [NonSerialized] internal bool _dirty = false;                
 
                 public List<string> funnelSignatures = new List<string>();
                 public List<EventDetail> eventDetails = new List<EventDetail>();
-                public MigrationLog migrationLog = new MigrationLog();
+                public MigrationLog migrationLog = new MigrationLog();                
 
                 internal EventDetail GetEventDetail(string eventName, bool autoNew = false)
                 {
+                    if (string.IsNullOrEmpty(eventName)) return null;
+
                     var result = eventDetails.Find(e => e.eventName == eventName);
                     if (result != null) return result;
                     if (autoNew == false) return null;
@@ -497,8 +557,47 @@ namespace Amanotes.Core
 
                     _dirty = true;
                     SaveIfDirty();
+                }                
+            }
+
+            internal class SessionStat
+            {                
+                public List<EventStat> lastFrameEventStats = new List<EventStat>();
+
+                const string TSV_HEADER_ROW = "EventName\tAdapters\tParameters";
+                string fileName = nameof(SessionStat) + DateTime.Now.ToString("_yyMMdd_HHmmss") + ".tsv";
+                bool isFirstSave = true;
+                StringBuilder contents = new StringBuilder();
+
+                internal void Add(string eventNameToSend, EventParams eventParams, List<string> adapterIDs)
+                {
+                    var eventStat = new EventStat(eventNameToSend, eventParams, adapterIDs);                    
+                    lastFrameEventStats.Add(eventStat);
+                }
+
+                internal void ClearLastFrameEventInfo()
+                {
+                    lastFrameEventStats.Clear();                    
                 }
-            }            
+
+                internal void Save()
+                {
+                    if (!Config.common.enableEventStat || lastFrameEventStats.Count == 0) return;
+
+                    contents.Clear();
+                    if (isFirstSave)
+                    {
+                        contents = contents.AppendLine(TSV_HEADER_ROW);
+                        isFirstSave = false;
+                    }
+                    foreach (var stat in lastFrameEventStats)
+                    {
+                        contents.AppendLine(stat.ToTsv());
+                    }                    
+                    
+                    FileUtils.SaveAppend(fileName, contents.ToString());
+                }                
+            }
         }
     }
 
@@ -512,6 +611,7 @@ namespace Amanotes.Core
             data.funnelSignature = string.IsNullOrEmpty(signature) ? data.eventName : signature;
             return ap;
         }
+
         public static IEventParamsBuilder SetAsAccumulated(this IEventParamsBuilder ap, bool withinSession = false)
         {
             if (ap == null) return null;
@@ -647,18 +747,15 @@ namespace Amanotes.Core.Internal
         public bool showAnalyticsLog = true;
         public bool normalizeEventName = true;
         public bool checkMigrationIntegrity = true;
+        public bool enableEventStat;
     }
 
     public interface IAnalyticAdapter
     {
-        void LogEvent(string eventNameToSend, EventParams eventData);
+        void LogEvent(string eventNameToSend, Dictionary<string, object> parameters);
 
         void SetUserId(string userId);
 
         void SetUserProperty(string key, string value);
-
-        void OnlyAllowEvents(List<string> eventNames);
-
-        void OnlyBanEvents(List<string> eventNames);
     }
 }

package/Runtime/AmaGDK.Config.cs

@@ -48,7 +48,7 @@ namespace Amanotes.Core.Internal {
             initOrder.Clear();
 
             var counter = 0;
-            foreach (var adapter in GetAllAdapters<IAdapter>())
+            foreach (var adapter in GetAllAdapters<AdapterContext>())
             {
                 var id = adapter.Name.Replace("Adapter", string.Empty);
                 initOrder.Add(new InitOrder(){ id = id, order = counter++ });

package/Runtime/AmaGDK.Internal.cs

@@ -1,9 +1,9 @@
-using System.Linq;
 using System.Text;
 using System.Collections.Generic;
 
 using UnityEngine;
 using UnityObject = UnityEngine.Object;
+using static Amanotes.Core.AmaGDK.Analytics;
 
 #if UNITY_EDITOR
 using UnityEditor;
@@ -123,8 +123,16 @@ namespace Amanotes.Core.Internal
             AmaGDK._status = Status.None;
             AmaGDK._allowInit = false;
 
-            // TODO: Destroy adapters?
-            Adapter.listAdapters.Clear();
+            // TODO: Destroy adapters? - Don't do this. An adapter registers just 1 time. Clear adapters cause Analytics test fail.
+            //Adapter.listAdapters.Clear();
+        }
+
+        public static void ClearAnalyticsData()
+        {
+            AnalyticsData analyticsData = AmaGDK.Analytics.localData;
+            analyticsData.funnelSignatures.Clear();
+            analyticsData.eventDetails.Clear();
+            analyticsData.migrationLog = new AmaGDK.Analytics.MigrationLog();
         }
     }
 }

package/Runtime/AmaGDK.UserProfile.cs

@@ -1,6 +1,6 @@
 using System;
+using Amanotes.Core.Internal;
 using UnityEngine;
-using static Amanotes.Core.Internal.Logging;
 using FileUtils = Amanotes.Core.Internal.FileUtils;
 
 namespace Amanotes.Core
@@ -10,19 +10,11 @@ namespace Amanotes.Core
         public static readonly UserProfile User = new UserProfile().Load();
 
         [Serializable]
-        public class UserProfile
+        public partial class UserProfile: IJsonFile
         {
+            [NonSerialized] internal bool _dirty = false;
             const string FILE_NAME = nameof(UserProfile);
 
-            public string amaId;
-            public string amaDeviceId;
-            public string gaId;
-            public string androidId;
-            public string idfa;
-            public string idfv;
-            public string appsFlyerId;
-            public string firebaseUserPseudoId;
-
             public void Save()
             {
                 FileUtils.Save(FILE_NAME, JsonUtility.ToJson(this));
@@ -36,6 +28,13 @@ namespace Amanotes.Core
                 JsonUtility.FromJsonOverwrite(json, this);
                 return this;
             }
+
+            internal void SaveIfDirty()
+            {
+                if (!_dirty) return;
+                _dirty = false;
+                this.SaveJsonToFile();
+            }
         }
     }
 }