com.amanotes.gdk 0.2.45 → 0.2.47

package/Runtime/AmaGDK.Analytics.cs

@@ -1,29 +1,15 @@
 using System;
 using System.Collections.Generic;
 using System.Text;
+using System.Text.RegularExpressions;
 using Amanotes.Core.Internal;
 using UnityEngine;
+using UnityEngine.Profiling;
 using static Amanotes.Core.AmaGDK.Analytics;
 using static Amanotes.Core.Internal.Logging;
 
 namespace Amanotes.Core
 {
-    [Serializable]
-    public class AnalyticsAdapterConfig
-    {
-        public bool SendEventByDefault;
-
-        public List<string> NeverSend;
-        public List<string> AlwaysSend;
-
-        public bool IsForbidden(string eventName)
-        {
-            return SendEventByDefault
-                ? NeverSend.Contains(eventName)
-                : !AlwaysSend.Contains(eventName);
-        }
-    }
-
     partial class AmaGDK
     {
         //PUBLIC APIS
@@ -85,6 +71,11 @@ namespace Amanotes.Core
             public static IEventParamsBuilder LogEvent(string eventName)
             {
                 NormalizeEventName(ref eventName, true);
+                if (localData.GetEventDetail(eventName) == null && localData.eventDetails.Count >= 500)
+                {
+                    LogWarning($" - You have reported 500 types of events. New event <{eventName}> will be ignored.");
+                    return null;
+                }
                 var result = new EventParams(eventName);
                 eventQueue.Enqueue(result);
                 return result;
@@ -146,41 +137,45 @@ namespace Amanotes.Core
 
             private static IntegrityFlag MergeData(List<string> funnelEvents, Dictionary<string, int> eventCountMap, bool sumEventCount)
             {
+                Profiler.BeginSample("AmaGDK.Analytics.MergeData()");
                 var flag = IntegrityFlag.Ok;
 
-                foreach (string e in funnelEvents)
-                {
-                    if (localData.funnelSignatures.Contains(e)) continue;
-
-                    flag |= IntegrityFlag.NewFunnel;
-                    localData.AddFunnelSignature(e);
-                }
-
-                foreach (KeyValuePair<string, int> e in eventCountMap)
-                {
-                    EventDetail eventDetail = localData.GetEventDetail(e.Key);
-                    if (eventDetail == null)
+                if (funnelEvents != null)
+                    foreach (string e in funnelEvents)
                     {
-                        localData.eventDetails.Add(new EventDetail
-                        {
-                            eventName = e.Key,
-                            totalCount = e.Value
-                        });
-                        flag |= IntegrityFlag.NewEvent;
-                        continue;
-                    }
+                        if (localData.funnelSignatures.Contains(e)) continue;
 
-                    if (eventDetail.totalCount != e.Value)
-                    {
-                        flag |= IntegrityFlag.DifferentCount;
+                        flag |= IntegrityFlag.NewFunnel;
+                        localData.AddFunnelSignature(e);
                     }
 
-                    if (sumEventCount)
+                if (eventCountMap != null)
+                    foreach (KeyValuePair<string, int> e in eventCountMap)
                     {
-                        eventDetail.totalCount += e.Value;
-                    }
-                }
+                        EventDetail eventDetail = localData.GetEventDetail(e.Key);
+                        if (eventDetail == null)
+                        {
+                            localData.eventDetails.Add(new EventDetail
+                            {
+                                eventName = e.Key,
+                                totalCount = e.Value
+                            });
+                            flag |= IntegrityFlag.NewEvent;
+                            continue;
+                        }
+
+                        if (eventDetail.totalCount != e.Value)
+                        {
+                            flag |= IntegrityFlag.DifferentCount;
+                        }
 
+                        if (sumEventCount)
+                        {
+                            eventDetail.totalCount += e.Value;
+                        }
+                    }
+                
+                Profiler.EndSample();
                 return flag;
             }
 
@@ -197,7 +192,7 @@ namespace Amanotes.Core
                 }
 
                 //Integrity check
-                if (!Config.common.checkMigrationIntegrity) return;
+                if (!Config.analytics.checkMigrationIntegrity) return;
 
                 // False: DO NOT UPDATE EXISTED COUNT VALUE BECAUSE WE DON'T HAVE
                 // ENOUGH INFORMATION TO DECIDE WHICH ONE IS MORE ACCURATE
@@ -211,11 +206,9 @@ namespace Amanotes.Core
             {
                 foreach (string adapterID in adapterIDs)
                 {
-                    AdapterContext adapter = listAdapters.Find(a => a.adapterId == adapterID);
+                    AnalyticsAdapter adapter = listAdapters.Find(a => a.adapterId == adapterID);
                     if (adapter == null) continue;
-
-                    var config = adapter.GetAdapterConfig<AnalyticsAdapterConfig>();
-                    config.AlwaysSend = eventNames;
+                    adapter.AlwaysSend = eventNames;
                 }
             }
 
@@ -223,11 +216,9 @@ namespace Amanotes.Core
             {
                 foreach (string adapterID in adapterIDs)
                 {
-                    AdapterContext adapter = listAdapters.Find(a => a.adapterId == adapterID);
+                    AnalyticsAdapter adapter = listAdapters.Find(a => a.adapterId == adapterID);
                     if (adapter == null) continue;
-
-                    var config = adapter.GetAdapterConfig<AnalyticsAdapterConfig>();
-                    config.NeverSend = eventNames;
+                    adapter.NeverSend = eventNames;
                 }
             }
         }
@@ -244,33 +235,78 @@ namespace Amanotes.Core
             }
 
             internal static readonly Dictionary<string, EventConfig> sendAtCount = new Dictionary<string, EventConfig>();
-            internal static Predicate<EventParams> logEventHook = null;
+            internal static Predicate<EventParams> logEventHook;
             internal static readonly Queue<EventParams> eventQueue = new Queue<EventParams>();
             internal static readonly Queue<Action> actionQueue = new Queue<Action>();
-            internal static readonly List<AdapterContext> listAdapters = new List<AdapterContext>();
+            internal static readonly List<AnalyticsAdapter> listAdapters = new List<AnalyticsAdapter>();
             internal static readonly AnalyticsData localData = new AnalyticsData().LoadJsonFromFile();
             internal static readonly SessionStat sessionStat = new SessionStat();
-            internal static AdapterContext primaryAdapter;
-
-            internal static void Init()
+            internal static AnalyticsAdapter primaryAdapter;
+            internal static readonly HashSet<string> blackListPrefixes = new HashSet<string>() {
+                "firebase_", "google_", "ga_"
+            };
+            internal static readonly HashSet<string> blackListEvents = new HashSet<string>()
+            {
+                "ad_activeview",
+                "ad_click",
+                "ad_exposure",
+                "ad_query",
+                "ad_reward",
+                "adunit_exposure",
+                "app_background",
+                "app_clear_data",
+                "app_exception",
+                "app_remove",
+                "app_store_refund",
+                "app_store_subscription_cancel",
+                "app_store_subscription_convert",
+                "app_store_subscription_renew",
+                "app_update",
+                "app_upgrade",
+                "dynamic_link_app_open",
+                "dynamic_link_app_update",
+                "dynamic_link_first_open",
+                "error",
+                "first_open",
+                "first_visit",
+                "in_app_purchase",
+                "notification_dismiss",
+                "notification_foreground",
+                "notification_open",
+                "notification_receive",
+                "os_update",
+                "session_start",
+                "session_start_with_rollout",
+                "user_engagement"
+            };
+
+            internal static void InitModule()
             {
                 listAdapters.Clear();
-                listAdapters.AddRange(Adapter.FindAll<IAnalyticAdapter>());
+                listAdapters.AddRange(Adapter2.GetAllAdapter<AnalyticsAdapter>());
                 if (listAdapters.Count != 0)
                     primaryAdapter = listAdapters.Find(a => a.adapterId == AdapterID.FIREBASE_ANALYTICS) ?? listAdapters[0];
+            }
 
+            internal static void StartModule()
+            {
+                // All adapters should be ready now!
+                
+                // TODO: Refactor Resolve Early Calls
                 onFrameUpdate -= ProcessEventQueue;
                 onFrameUpdate += ProcessEventQueue;
                 
                 onFrameUpdate -= ProcessActionQueue;
                 onFrameUpdate += ProcessActionQueue;
             }
-
+    
             internal static void ProcessEventQueue()
             {
                 if (eventQueue.Count <= 0) return;
-                SDKConfig common = Config.common;
-                bool showAnalyticsLog = common.showAnalyticsLog;
+
+                Profiler.BeginSample("AmaGDK.Analytics.ProcessEventQueue()");
+                AnalyticsConfig config = Config.analytics;
+                bool showAnalyticsLog = config.showAnalyticsLog;
                 sessionStat.ClearLastFrameEventInfo();
 
                 while (eventQueue.Count > 0)
@@ -279,27 +315,25 @@ namespace Amanotes.Core
                     if (!ShouldSendEvent(eventData)) continue;
                     
                     var (countInSession, totalCount) = localData.IncreaseCounter(eventData);
-                    if (eventData.accumulated)
+                    if (eventData.accumulated || eventData.parameters.ContainsKey("accumulated_count"))
                     {
-                        eventData.AddParam("accumulated_count", eventData.withinSession ? countInSession : totalCount);
+                        UpdateAccumulatedCount(eventData, countInSession, totalCount);
                     }
 
                     eventData.AddParam("ama_device_id", User.AmaDeviceId);
-
+                    
                     string eventNameToSend = GetEventNameToSend(eventData.eventName, countInSession, totalCount);
-                    if (common.normalizeEventName) NormalizeEventName(ref eventNameToSend);
+                    if (config.normalizeEventName) NormalizeEventName(ref eventNameToSend);
 
                     if (showAnalyticsLog) Debug.Log($"AmaGDK | [Analytics] Event <{eventNameToSend}> (in session: {countInSession}, total: {totalCount})\n{JsonUtils.DictionaryToJson(eventData.parameters, true)}");
                     
-                    common.quality.CheckEventQuality(eventData.eventName, eventData.parameters);
+                    config.quality.CheckEventQuality(eventData.eventName, eventData.parameters);
 
                     var inUseAdapterIDs = new List<string>();
-                    foreach (AdapterContext m in listAdapters)
+                    foreach (AnalyticsAdapter m in listAdapters)
                     {
                         if (IsAdapterForbidden(m, eventData)) continue;
-                        
-                        var api = m.GetAdapterApi<IAnalyticAdapter>();
-                        api.LogEvent(eventNameToSend, eventData.parameters);
+                        m.LogEvent(eventNameToSend, eventData.parameters);
                         inUseAdapterIDs.Add(m.adapterId);
                     }
                     sessionStat.Add(eventNameToSend, eventData, inUseAdapterIDs);
@@ -307,24 +341,45 @@ namespace Amanotes.Core
 
                 localData.SaveIfDirty();
                 sessionStat.Save();
+				Profiler.EndSample();
             }
 
-            internal static bool IsAdapterForbidden(AdapterContext adapterContext, EventParams eventData)
+            internal static void UpdateAccumulatedCount(EventParams eventData, int countInSession, int totalCount)
             {
-                if (adapterContext == null) return false;
-                var config = adapterContext.GetAdapterConfig<AnalyticsAdapterConfig>();
+                var ACCUMULATED_COUNT = "accumulated_count";
+                var countByGDK = eventData.withinSession ? countInSession : totalCount;
 
+                if (!eventData.parameters.ContainsKey(ACCUMULATED_COUNT))
+                {
+                    eventData.AddParam(ACCUMULATED_COUNT, countByGDK);
+                    return;
+                }
+
+                int.TryParse(eventData.parameters[ACCUMULATED_COUNT].ToString(), out int oriAccCount);
+                if (oriAccCount == countByGDK)
+                {
+                    eventData.AddParam(ACCUMULATED_COUNT, countByGDK);
+                }
+                else
+                {
+                    LogWarning($"[Analytics] event <{eventData.eventName}> has difference in accumulated count. Original count: {oriAccCount}. AmaGDK count: {countByGDK}");
+                }
+            }
+
+            internal static bool IsAdapterForbidden(AnalyticsAdapter adapter, EventParams eventData)
+            {
+                if (adapter == null) return false;
                 if (eventData.overrideConfig)
                 {
                     // IMPORTANT NOTE:
                     //
                     // Once set overrideConfig, we should skip the adapter config completely!!!
                     //
-                    if (eventData.IsAdapterForbidden(adapterContext.adapterId)) return true;
+                    if (eventData.IsAdapterForbidden(adapter.adapterId)) return true;
                 }
                 else // Do not remove else
                 {
-                    if (config.IsForbidden(eventData.eventName)) return true;
+                    if (adapter.IsForbidden(eventData.eventName)) return true;
                 }
 
                 return false;
@@ -338,36 +393,70 @@ namespace Amanotes.Core
                 return $"{eventName}_{(config.withinSession ? countInSession : totalCount).ToString(config.numberFormat)}";
             }
 
+            //https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.Event
             internal static void NormalizeEventName(ref string eventName, bool dryRun = false)
             {
-                StringBuilder sb = tmpWarningSB;
-                sb.Clear();
-
-                if (string.IsNullOrEmpty(eventName))
+                Profiler.BeginSample("AmaGDK.Analytics.NormalizeEventName()");
                 {
-                    sb.AppendLine(" - EventName should not be empty");
-                    return;
+                    StringBuilder sb = tmpWarningSB;
+                    sb.Clear();
+                    NormalizeKeyString(ref eventName, sb, dryRun);
+                    if (blackListEvents.Contains(eventName))
+                        sb.AppendLine($" - EventName <{eventName}> is reserved and should not be used");
+                    if (sb.Length > 0 && dryRun) LogWarningOnce($"Warning for event name <{eventName}>:\n{sb}", $"NormalizeEventName<{eventName}>");    
                 }
+                Profiler.EndSample();
+            }
 
-                string normalizedEventName = eventName.Trim()
-                    .Replace(' ', '_')
-                    .Replace('-', '_');
-
-                if (eventName != normalizedEventName)
+            internal static void NormalizeKeyString(ref string key, StringBuilder warningLog, bool dryRun = false)
+            {
+                Profiler.BeginSample("AmaGDK.Analytics.NormalizeEventName()");
                 {
-                    if (!dryRun)
+                    if (string.IsNullOrWhiteSpace(key))
                     {
-                        eventName = normalizedEventName;
+                        LogWarning($" - Name should not be empty");
+                        Profiler.EndSample();
+                        return;
                     }
-                    else
+                    
+                    string normalizedString = key.Trim()
+                        .Replace(' ', '_')
+                        .Replace('-', '_');
+
+                    if (key != normalizedString)
+                    {
+                        if (!dryRun)
+                        {
+                            key = normalizedString;
+                        } else
+                        {
+                            warningLog.AppendLine($" - Malformed name (should not contains <space> or <dash>): <{key}>");
+                        }
+                    }
+
+                    var r = new Regex("^[a-zA-Z0-9_]*$");
+                    if (!r.IsMatch(normalizedString))
+                    {
+                        warningLog.AppendLine($" - Name may only contain alphanumeric characters and underscores");
+                    }
+
+                    if (!char.IsLetter(key[0]))
                     {
-                        sb.AppendLine($" - Malformed eventName (should not contains <space> or <dash>: <{eventName}>");
+                        warningLog.AppendLine($" - Name must start with a letter: <{key}> ");
+                    }
+
+                    foreach (var prefix in blackListPrefixes)
+                    {
+                        if (!normalizedString.StartsWith(prefix)) continue;
+                        warningLog.AppendLine($" - <{key}> starts with reserved prefix <{prefix}>");
+                    }
+
+                    if (key.Length > 40)
+                    {
+                        warningLog.AppendLine($" - Name is too long ({key.Length} > 40): <{key}> ");
                     }
                 }
-                
-                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 && dryRun) LogWarningOnce(sb.ToString(), $"NormalizeEventName<{eventName}>");
+                Profiler.EndSample();
             }
 
             internal static bool ShouldSendEvent(EventParams eventData)
@@ -387,7 +476,7 @@ namespace Amanotes.Core
                 //Check the rule to log event
                 if (logEventHook != null)
                 {
-                    EventDetail eventDetail = localData.GetEventDetail(eventData.eventName, true);
+                    // localData.GetEventDetail(eventData.eventName, true);
                     return logEventHook(eventData);
                 }
 
@@ -407,17 +496,17 @@ namespace Amanotes.Core
             
             internal static void InternalSetUserId(string userId)
             {
-                foreach (AdapterContext s in listAdapters)
+                foreach (AnalyticsAdapter s in listAdapters)
                 {
-                    s.GetAdapterApi<IAnalyticAdapter>().SetUserId(userId);
+                    s.SetUserId(userId);
                 }
             }
 
             internal static void InternalSetUserProperty(string key, string value)
             {
-                foreach (AdapterContext s in listAdapters)
+                foreach (AnalyticsAdapter s in listAdapters)
                 {
-                    s.GetAdapterApi<IAnalyticAdapter>().SetUserProperty(key, value);
+                    s.SetUserProperty(key, value);
                 }
             }
         }
@@ -486,7 +575,6 @@ namespace Amanotes.Core
             [Serializable]
             internal class AnalyticsData : IJsonFile
             {
-
                 public List<string> funnelSignatures = new List<string>();
                 public List<EventDetail> eventDetails = new List<EventDetail>();
                 public MigrationLog migrationLog = new MigrationLog();
@@ -561,7 +649,6 @@ namespace Amanotes.Core
 
             internal class SessionStat
             {
-
                 private const string TSV_HEADER_ROW = "EventName\tAdapters\tParameters";
                 private readonly string fileName = nameof(SessionStat) + DateTime.Now.ToString("_yyMMdd_HHmmss") + ".tsv";
                 private StringBuilder contents = new StringBuilder();
@@ -581,7 +668,7 @@ namespace Amanotes.Core
 
                 internal void Save()
                 {
-                    if (!Config.common.enableEventStat || lastFrameEventStats.Count == 0) return;
+                    if (!Config.analytics.enableEventStat || lastFrameEventStats.Count == 0) return;
 
                     contents.Clear();
                     if (isFirstSave)
@@ -607,7 +694,7 @@ namespace Amanotes.Core
             if (ap == null) return null;
 
             var data = ap as EventParams;
-            data.funnelSignature = string.IsNullOrEmpty(signature) ? data.eventName : signature;
+            data!.funnelSignature = string.IsNullOrEmpty(signature) ? data.eventName : signature;
             return ap;
         }
 
@@ -616,7 +703,7 @@ namespace Amanotes.Core
             if (ap == null) return null;
 
             var data = ap as EventParams;
-            data.accumulated = true;
+            data!.accumulated = true;
             data.withinSession = withinSession;
             return ap;
         }
@@ -631,7 +718,7 @@ namespace Amanotes.Core
             }
 
             var eventData = ap as EventParams;
-            if (eventData.overrideConfig)
+            if (eventData!.overrideConfig)
             {
                 LogWarning("Except() can only be set once!");
                 return ap;
@@ -655,7 +742,7 @@ namespace Amanotes.Core
             }
 
             var eventData = ap as EventParams;
-            if (eventData.overrideConfig)
+            if (eventData!.overrideConfig)
             {
                 LogWarning("OnlyTo() can only be set once!");
                 return ap;
@@ -674,14 +761,22 @@ namespace Amanotes.Core
             if (ap == null) return null;
             if (!IsValidKeyValue(ap, key, value)) return ap;
 
-            Dictionary<string, object> parameters = (ap as EventParams)?.parameters;
-            if (parameters != null && parameters.ContainsKey(key))
+            var eventParams = ap as EventParams;
+            Dictionary<string, object> parameters = eventParams?.parameters;
+            if (parameters == null) 
+                return ap;
+            if (parameters.ContainsKey(key))
             {
-                LogWarning($"Duplicated key: {key}!");
+                LogWarning($"Duplicated key: {key}. Event name: {eventParams.eventName}!");
+                return ap;
+            }
+            if (parameters.Count >= 25)
+            {
+                LogWarning($"Exceeded key: {key}. Event name: {eventParams.eventName}!");
                 return ap;
             }
             
-            parameters?.Add(key, value);
+            parameters.Add(key, value);
             return ap;
         }
 
@@ -707,7 +802,7 @@ namespace Amanotes.Core
             if (ap == null) return null;
             if (parameters.Length == 0)
             {
-                LogWarning($"Param tuple is null. Event name: {(ap as EventParams).eventName}!");
+                LogWarning($"Param tuple is null. Event name: {(ap as EventParams)?.eventName}!");
                 return ap;
             }
 
@@ -719,9 +814,16 @@ namespace Amanotes.Core
             return ap;
         }
 
+        //https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.Param
         private static bool IsValidKeyValue(IEventParamsBuilder ap, string key, object value)
         {
             string eventName = (ap as EventParams)?.eventName;
+            
+            StringBuilder sb = tmpWarningSB;
+            sb.Clear();
+            NormalizeKeyString(ref key, sb);
+            if (sb.Length > 0) LogWarningOnce($"Warning for event <{eventName}>, param <{key}>:\n{sb}", $"NormalizeParamKey<{eventName}>");
+            
             if (string.IsNullOrWhiteSpace(key))
             {
                 LogWarning($"Param key is empty. Event name: {eventName}!");
@@ -740,10 +842,20 @@ namespace Amanotes.Core
 
 namespace Amanotes.Core.Internal
 {
+    [Serializable] public class AnalyticsConfig
+    {
+        // [Header("-----     MODULE CONFIG      -----")]
+        public bool showAnalyticsLog = true;
+        public bool normalizeEventName = true;
+        public bool checkMigrationIntegrity = true;
+        public bool enableEventStat;
+        public AnalyticQualityConfig quality;
+    }
+    
     [Serializable]
     public class AnalyticQualityConfig
     {
-        public bool enable = false;
+        public bool enable;
         public AnalyticQualityAsset qualityAsset;
         
         public void CheckEventQuality(string eventName, Dictionary<string, object> parameters)
@@ -754,24 +866,32 @@ namespace Amanotes.Core.Internal
             }
         }
     }
-
-    public partial class SDKConfig
+    
+    public partial class ConfigAsset
     {
-        public bool showAnalyticsLog = true;
-        public bool normalizeEventName = true;
-        public bool checkMigrationIntegrity = true;
-        public bool enableEventStat;
-        public AnalyticQualityConfig quality;
+        [SerializeField] public AnalyticsConfig analytics;
     }
-
-    public interface IAnalyticAdapter
+    
+    public abstract class AnalyticsAdapter : Adapter2
     {
-        void LogEvent(string eventNameToSend, Dictionary<string, object> parameters);
+        public bool SendEventByDefault;
+
+        public List<string> NeverSend;
+        public List<string> AlwaysSend;
+
+        public bool IsForbidden(string eventName)
+        {
+            return SendEventByDefault
+                ? NeverSend.Contains(eventName)
+                : !AlwaysSend.Contains(eventName);
+        }
+        
+        public abstract void LogEvent(string eventNameToSend, Dictionary<string, object> parameters);
 
-        void SetUserId(string userId);
+        public abstract void SetUserId(string userId);
 
-        void SetUserProperty(string key, string value);
+        public abstract void SetUserProperty(string key, string value);
 
-        void GetAppInstanceID(Action<string> appId);
+        public abstract void GetAppInstanceID(Action<string> appId);
     }
 }

package/Runtime/AmaGDK.Config.cs

@@ -2,6 +2,7 @@ using System;
 using System.Collections.Generic;
 using System.Reflection;
 using UnityEngine;
+
 #if UNITY_EDITOR
 using UnityEditor;
 #endif
@@ -51,7 +52,7 @@ namespace Amanotes.Core.Internal
             initOrder.Clear();
 
             var counter = 0;
-            foreach (Type adapter in GetAllAdapters<AdapterContext>())
+            foreach (Type adapter in GetAllAdapters<Adapter2>())
             {
                 string id = adapter.Name.Replace("Adapter", string.Empty);
                 initOrder.Add(new InitOrder(){ id = id, order = counter++ });