com.amanotes.gdk 0.2.9 → 0.2.11

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [0.2.11 - 2023-06-29]
+### SetLogCondition with EventParam
+### Rename Migrated -> HasMigrated
+### Fix StopShowAd
+
+## [0.2.10 - 2023-06-23]
+### Extra package: Project Panel
+### Remote config: Allow user to enable / disable automatic default valuye updating (in play mode)
+### Fix ad routine
+### Expose analytics migration flag
+
 ## [0.2.9 - 2023-06-15]
 ### Show total init time
 ### Show adapter version + status at init time

package/Extra/AmaGDKProject.unitypackage.meta

@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 26e42be832082494fb3eb94a4d9cd300
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/AmaGDK.Ads.cs

@@ -110,6 +110,9 @@ namespace Amanotes.Core
             public bool enableRewarded = true;
             public bool enableBanner = true;
             public bool autoMute = true;
+            
+            [Header("EDITOR")]
+            [Range(0f, 1f)] public float rewardAdShowSuccessRate = 1;
         }
 
         public partial class Ads
@@ -119,9 +122,10 @@ namespace Amanotes.Core
 
             internal static AdAdapterConfig _adConfig;
             internal static IAdAdapter _adapter;
-            public static AdListener Events = new AdListener();
             internal static float _savedVolume = -1;
-            internal static AdsData localData = new AdsData().LoadJsonFromFile();
+            
+            public static readonly AdListener Events = new AdListener();
+            internal static readonly AdsData localData = new AdsData().LoadJsonFromFile();
         }
 
         public partial class Ads // Public
@@ -139,13 +143,33 @@ namespace Amanotes.Core
             public static bool showingBanner => _showingBanner;
             public static bool showingAd => context != null;
 
-            public static IAdCallback ShowInterstitial(string placementName = null, Dictionary<string, object> userData = null)
+            private static bool ClearPrevContext()
             {
-                if (context != null)
+                if (context == null) return true;
+                float duration = Time.realtimeSinceStartup - context.showCallAt;
+                bool willSkip = duration < Mathf.Max(5f, _adConfig.adShowTimeoutInSecs);
+                if (willSkip)
                 {
-                    LogWarning("Context != null, might some ad be showing???");
-                    context = null;
+                    LogWarning($"[AD] ShowRequest IGNORED as another ad is showing (elapsedTime: {duration:n2}s):\n" + JsonUtility.ToJson(context, true));
+                    return false;
                 }
+                
+                LogWarning($"[AD] FORCE STOPPED the previous ad, as it seems to hang (elapsedTime: {duration:n2}s):\n" + JsonUtility.ToJson(context, true));
+                // possibly hang: force stop
+                if (context.adType == AdType.Interstitial)
+                {
+                    _adapter.interstitial.StopShowAd();
+                } else
+                {
+                    _adapter.rewardVideo.StopShowAd();
+                }
+                context = null;
+                return true;
+            }
+
+            public static IAdCallback ShowInterstitial(string placementName = null, Dictionary<string, object> userData = null)
+            {
+                if (!ClearPrevContext()) return null;
 
                 context = new ShowAdContext(AdType.Interstitial, placementName, userData);
                 _adapter.interstitial.StartShowAd();
@@ -154,18 +178,14 @@ namespace Amanotes.Core
 
             public static IAdCallback ShowRewardedVideo(string placementName = null, Dictionary<string, object> userData = null)
             {
-                if (context != null)
-                {
-                    LogWarning("Context != null, might some ad be showing???");
-                    context = null;
-                }
-
+                if (!ClearPrevContext()) return null;
+                
                 context = new ShowAdContext(AdType.VideoReward, placementName, userData);
                 _adapter.rewardVideo.StartShowAd();
                 return context;
             }
 
-            private static bool _showingBanner = false;
+            private static bool _showingBanner;
             public static void ShowBanner()
             {
                 if (_showingBanner) return;
@@ -227,16 +247,16 @@ namespace Amanotes.Core.Internal
     [Flags]
     public enum AdCallback
     {
-        None,
-        Open,
-        Reward,
-        Click,
-        Cancel,
-        Close,
-        Success,
-        Fail
+        None = 0,
+        Open = 1,
+        Reward = 2,
+        Click = 4,
+        Cancel = 8,
+        Close = 16,
+        Success = 32,
+        Fail = 64
     }
-
+    
     public enum BannerPosition
     {
         TOP = 1,
@@ -278,11 +298,10 @@ namespace Amanotes.Core.Internal
             showFinishAt = 0;
         }
 
-        public bool hasError => (adCallback & (AdCallback.Fail | AdCallback.Cancel)) != 0;
-        public bool potentiallyCompleted => (adCallback & (AdCallback.Close | AdCallback.Reward | AdCallback.Cancel)) != 0;
+        public bool hasFailedOrCancelled => (adCallback & (AdCallback.Fail | AdCallback.Cancel)) != 0;
+        public bool potentiallyCompleted => (adCallback & (AdCallback.Close | AdCallback.Fail | AdCallback.Reward | AdCallback.Cancel)) != 0;
         public bool hasReward => (adCallback & AdCallback.Reward) != 0;
         public bool hasClosed => (adCallback & AdCallback.Close) != 0;
-        public bool hasCancel => (adCallback & AdCallback.Cancel) != 0;
         public bool hasClicked => (adCallback & AdCallback.Click) != 0;
     }
 
@@ -303,18 +322,19 @@ namespace Amanotes.Core.Internal
                 return;
             }
 
+            Log("StartLoadAd");
             _loadRoutine = _instance.StartCoroutine(LoadAdRoutine());
         }
-
+        
         public void StopLoadAd()
         {
+            Log("StopLoadAd");
             if (_loadState == LoadAdsState.Requesting)
             {
                 _loadState = LoadAdsState.None;
             }
-
+            
             if (_loadRoutine == null) return;
-
             _instance.StopCoroutine(_loadRoutine);
             _loadRoutine = null;
         }
@@ -338,7 +358,7 @@ namespace Amanotes.Core.Internal
                 _isRequesting = true;
                 RequestAd();
 
-                var timeout = Ads._adConfig.adLoadTimeoutInSecs;
+                int timeout = Ads._adConfig.adLoadTimeoutInSecs;
                 var counter = 0;
 
                 while (counter < timeout || timeout == 0)
@@ -383,9 +403,10 @@ namespace Amanotes.Core.Internal
         {
             if (_showState != ShowAdsState.None)
             {
-                LogWarning("StartShowAd() --> Invalid _showState: " + _showState);
+                LogWarning("[Ad] StartShowAd() --> Invalid _showState: " + _showState);
             }
-
+            
+            Log($"[Ad] {adType} StartShowAd");
             _showState = ShowAdsState.ShowCalled;
             if (_showAdRoutine != null) _instance.StopCoroutine(_showAdRoutine);
             _showAdRoutine = _instance.StartCoroutine(ShowAdRoutine());
@@ -393,7 +414,13 @@ namespace Amanotes.Core.Internal
 
         public void StopShowAd()
         {
+            Log($"[Ad] {adType} StopShowAd");
             _showState = ShowAdsState.None;
+            if (_loadState == LoadAdsState.Ready && !isAdReady)
+            {
+                _loadState = LoadAdsState.None;
+                StartLoadAd();
+            }
             RestoreVolume();
             if (_showAdRoutine == null) return;
             _instance.StopCoroutine(_showAdRoutine);
@@ -407,20 +434,21 @@ namespace Amanotes.Core.Internal
             {
                 if (_loadState == LoadAdsState.Ready)
                 {
-                    LogWarning("Inconsistent state report: isAdReady == false while _loadState == Ready");
+                    LogWarning("[Ad] Inconsistent state report: isAdReady == false while _loadState == Ready");
                     _loadState = LoadAdsState.None;
                 }
 
                 if (Ads._adConfig.checkInternet && !hasInternet)
                 {
                     _showState = ShowAdsState.ShowFail;
+                    ShowAdRoutineCompleted(false);
                     yield break;
                 }
 
                 if (_loadState != LoadAdsState.Requesting) StartLoadAd();
                 _showState = ShowAdsState.WaitForAd;
 
-                var timeout = Ads._adConfig.adShowTimeoutInSecs;
+                int timeout = Ads._adConfig.adShowTimeoutInSecs;
                 var counter = 0;
 
                 while (counter < timeout || timeout == 0)
@@ -433,12 +461,12 @@ namespace Amanotes.Core.Internal
                 if (!isAdReady)
                 {
                     Ads.Events.OnShowTimeout?.Invoke();
-                    _showState = ShowAdsState.ShowFail;
                     ShowAdRoutineCompleted(false);
                     yield break;
                 }
             }
-
+            
+            _showState = ShowAdsState.Showing;
             // Ad should be ready here!
             ShowAd();
             if (Ads._adConfig.autoMute && AudioListener.volume > 0 && Ads._savedVolume == -1)
@@ -446,9 +474,8 @@ namespace Amanotes.Core.Internal
                 Ads._savedVolume = AudioListener.volume;
                 AudioListener.volume = 0;
             }
-
-            var context = Ads.context;
-
+            
+            ShowAdContext context = Ads.context;
             while (!context.potentiallyCompleted)
             {
                 yield return wait1Sec;
@@ -456,51 +483,52 @@ namespace Amanotes.Core.Internal
 
             if (adType == AdType.Interstitial)
             {
-                _showState = context.hasError ? ShowAdsState.ShowFail : ShowAdsState.ShowSuccess;
-                ShowAdRoutineCompleted(_showState == ShowAdsState.ShowSuccess);
+                ShowAdRoutineCompleted(!context.hasFailedOrCancelled);
                 yield break;
             }
 
-            if (context.hasCancel)
+            if (context.hasFailedOrCancelled)
             {
+                Log($"[Ad] {adType} Waiting for [close]");
                 yield return wait1Sec; // wait for close (1s)
-                _showState = ShowAdsState.ShowFail;
                 ShowAdRoutineCompleted(false);
                 yield break;
             }
 
             if (context.hasClosed)
             {
-                while (!context.hasCancel && !context.hasReward)
+                while (!context.hasFailedOrCancelled && !context.hasReward)
                 {
+                    Log($"[Ad] {adType} Waiting for [cancel] or [reward]");
                     yield return wait1Sec;
                 }
 
-                _showState = context.hasCancel ? ShowAdsState.ShowFail : ShowAdsState.ShowSuccess;
-                ShowAdRoutineCompleted(_showState == ShowAdsState.ShowSuccess);
+                ShowAdRoutineCompleted(!context.hasFailedOrCancelled);
                 yield break;
             }
 
             while (!context.hasClosed)
             {
+                Log($"[Ad] {adType} Waiting for [close]");
                 yield return wait1Sec;
             }
 
-            _showState = ShowAdsState.ShowSuccess;
             ShowAdRoutineCompleted(true);
-
-            Ads.context = null;
-            _showState = ShowAdsState.None;
         }
 
         private void ShowAdRoutineCompleted(bool isSuccess)
         {
-            StartLoadAd();
+            if (_loadState == LoadAdsState.Ready)
+            {
+                _loadState = isAdReady ? LoadAdsState.Ready : LoadAdsState.None;
+                if (_loadState == LoadAdsState.None) StartLoadAd();
+            }
+            
+            _showState = isSuccess ? ShowAdsState.ShowSuccess : ShowAdsState.ShowFail;
             Ads.context.showFinishAt = Time.realtimeSinceStartup;
 
             var localData = Ads.localData;
             var stat = _isInterstitial ? localData.interstitial : localData.reward;
-
             if (isSuccess)
             {
                 stat.success++;
@@ -515,6 +543,10 @@ namespace Amanotes.Core.Internal
 
             localData.Save();
             RestoreVolume();
+            
+            Log($"[Ad] {adType} ShowAdRoutineCompleted: {isSuccess}\n{JsonUtility.ToJson(Ads.context)}");
+            Ads.context = null;
+            _showState = ShowAdsState.None;
         }
 
         private void RestoreVolume()
@@ -528,6 +560,8 @@ namespace Amanotes.Core.Internal
         // Default implementation
         protected void OnAdClosed()
         {
+            Log($"[Ad] {adType} OnAdClosed");
+            
             if (Ads.context != null)
             {
                 Ads.context.adCallback |= AdCallback.Close;
@@ -546,6 +580,8 @@ namespace Amanotes.Core.Internal
 
         protected void OnAdClicked()
         {
+            Log($"[Ad] {adType} OnAdClicked");
+            
             if (Ads.context != null)
             {
                 Ads.context.adCallback |= AdCallback.Click;
@@ -565,6 +601,8 @@ namespace Amanotes.Core.Internal
 
         protected void OnAdShowFailed()
         {
+            Log($"[Ad] {adType} OnAdShowFailed");
+            
             if (Ads.context != null)
             {
                 Ads.context.adCallback |= AdCallback.Fail;
@@ -584,6 +622,8 @@ namespace Amanotes.Core.Internal
 
         protected void OnAdShowSucceeded()
         {
+            Log($"[Ad] {adType} OnAdShowSucceeded");
+            
             if (Ads.context != null)
             {
                 Ads.context.adCallback |= AdCallback.Success;
@@ -601,6 +641,8 @@ namespace Amanotes.Core.Internal
 
         protected void OnAdOpen()
         {
+            Log($"[Ad] {adType} OnAdOpen");
+                
             if (Ads.context != null)
             {
                 Ads.context.adCallback |= AdCallback.Open;
@@ -619,6 +661,8 @@ namespace Amanotes.Core.Internal
 
         protected void OnAdReward()
         {
+            Log($"[Ad] {adType} OnAdReward");
+            
             if (Ads.context != null)
             {
                 Ads.context.adCallback |= AdCallback.Reward;
@@ -635,6 +679,8 @@ namespace Amanotes.Core.Internal
 
         protected void OnAdLoadSuccess()
         {
+            Log($"[Ad] {adType} OnAdLoadSuccess");
+            
             if (!_isRequesting)
             {
                 LogWarning("Something wrong? OnAdReady called when no ad is loading!");
@@ -647,6 +693,8 @@ namespace Amanotes.Core.Internal
 
         protected void OnAdLoadFailed(string error)
         {
+            Log($"[Ad] {adType} OnAdLoadFailed: {error}");
+            
             if (_isInterstitial)
                 Ads.Events.OnInterstitialLoadFailed?.Invoke(error);
         }

package/Runtime/AmaGDK.Analytics.cs

@@ -29,11 +29,13 @@ namespace Amanotes.Core
         //PUBLIC APIS
         public static partial class Analytics
         {
+            public static bool HasMigrated => localData.migrationLog.count > 0;
+
             public interface IEventParamsBuilder { }            
 
             public class EventParams : IEventParamsBuilder
             {
-                public string eventName;
+                public readonly string eventName;
                 public Dictionary<string, object> parameters = new Dictionary<string, object>();
                 public string funnelSignature;
                 public bool accumulated;
@@ -43,6 +45,8 @@ namespace Amanotes.Core
                 public HashSet<string> ignoreAdapterIds = new HashSet<string>();
                 public HashSet<string> allowAdapterIds = new HashSet<string>();
 
+                public EventDetail EventDetail => localData.GetEventDetail(eventName, true);
+
                 public EventParams(string eventName)
                 {
                     this.eventName = eventName;
@@ -124,7 +128,7 @@ namespace Amanotes.Core
                 return eventDetail != null ? (withinSession ? eventDetail.countInSession : eventDetail.totalCount) : 0;
             }
 
-            public static void SetLogEventCondition(Predicate<EventDetail> condition)
+            public static void SetLogEventCondition(Predicate<EventParams> condition)
             {
                 if (logEventHook != null) LogWarning("LogEventCondition has already set! Please make sure to call it once.");
                 logEventHook = condition;
@@ -279,7 +283,7 @@ namespace Amanotes.Core
             }
 
             internal static readonly Dictionary<string, EventConfig> sendAtCount = new Dictionary<string, EventConfig>();
-            internal static Predicate<EventDetail> logEventHook = null;
+            internal static Predicate<EventParams> logEventHook = null;
             internal static readonly Queue<EventParams> eventQueue = new Queue<EventParams>();
             internal static readonly List<AdapterContext> listAdapters = new List<AdapterContext>();
             internal static readonly AnalyticsData localData = new AnalyticsData().LoadJsonFromFile();
@@ -315,7 +319,7 @@ namespace Amanotes.Core
                     string eventNameToSend = GetEventNameToSend(eventData.eventName, countInSession, totalCount);
                     if (Config.common.normalizeEventName) NormalizeEventName(ref eventNameToSend);
 
-					if (showAnalyticsLog) Debug.Log($"AmaGDK v{AmaGDK.VERSION} | Event <{eventNameToSend}> (in session: {countInSession}, total: {totalCount})\n{JsonUtils.DictionaryToJson(eventData.parameters, true)}");
+					if (showAnalyticsLog) Debug.Log($"AmaGDK | Event <{eventNameToSend}> (in session: {countInSession}, total: {totalCount})\n{JsonUtils.DictionaryToJson(eventData.parameters, true)}");
 
                     var inUseAdapterIDs = new List<string>();
                     foreach (AdapterContext m in listAdapters)
@@ -404,7 +408,7 @@ namespace Amanotes.Core
                 if (logEventHook != null)
                 {
                     EventDetail eventDetail = localData.GetEventDetail(eventData.eventName, true);
-                    return logEventHook(eventDetail);
+                    return logEventHook(eventData);
                 }
 
                 return true;

package/Runtime/AmaGDK.RemoteConfig.cs

@@ -3,10 +3,13 @@ using System.Collections.Generic;
 using System.IO;
 using System.Text;
 using UnityEngine;
-
 using Amanotes.Core.Internal;
 using static Amanotes.Core.Internal.Logging;
 
+#if UNITY_EDITOR
+using UnityEditor;
+#endif
+
 namespace Amanotes.Core
 {
     public partial class AmaGDK //Remote Config
@@ -112,6 +115,7 @@ namespace Amanotes.Core
             };
 
             internal static IRemoteConfig adapter;
+            internal static RemoteConfigConfig adapterConfig;
             internal static Action<bool> onAdapterInitCompleteCallback;
 
             internal static void NextState(bool result = true)
@@ -140,6 +144,8 @@ namespace Amanotes.Core
                     NextState(false);
                     return;
                 }
+                
+                adapterConfig = (adapter as AdapterContext)?.GetAdapterConfig<RemoteConfigConfig>();
                 adapter.ResolveDependencies(NextState);
             }
 
@@ -171,12 +177,29 @@ namespace Amanotes.Core
             {
                 _state = FetchState.SaveCache;
                 StringBuilder sb = new StringBuilder();
+
+                
+                bool needUpdateDefault = Application.isEditor && adapterConfig.autoUpdateDefaultValue;
+                List<KeyValue> list = needUpdateDefault ? new List<KeyValue>() : null;
+                
                 foreach (var c in dictConfig)
                 {
                     sb.AppendLine($"{c.Key}\t{Encode(c.Value)}");
+                    if (!needUpdateDefault) continue;
+                    list.Add(new KeyValue() { key = c.Key, value = c.Value });
                 }
-
-                var filePath = FileUtils.GetPath(fileName);
+                
+                #if UNITY_EDITOR
+                if (needUpdateDefault)
+                {
+                    list.Sort((item1, item2) => string.Compare(item1.key, item2.key, StringComparison.Ordinal));
+                    adapterConfig.defaultValue = list.ToArray();
+                    EditorUtility.SetDirty(_config);
+                    Log($"[RemoteConfig] Updated default remote config!");
+                }
+                #endif
+                
+                string filePath = FileUtils.GetPath(fileName);
                 FileUtils.Save(filePath, sb.ToString());
                 Log($"[RemoteConfig] Saved remote config to {filePath}");
                 NextState();
@@ -301,6 +324,7 @@ namespace Amanotes.Core.Internal
     [Serializable]
     public class RemoteConfigConfig
     {
+        public bool autoUpdateDefaultValue;
         public KeyValue[] defaultValue;
         public float firstFetchTimeOutInSeconds = 10;
         public float defaultTimeOutInSeconds = 3;

package/Runtime/AmaGDK.Utils.cs

@@ -8,6 +8,20 @@ using static Amanotes.Core.Internal.Logging;
 
 namespace Amanotes.Core.Internal
 {
+    public class Utils
+    {
+        public static void DelayCall(float seconds, Action action)
+        {
+            AmaGDK._instance.StartCoroutine(DelayCallRoutine(seconds, action));
+        }
+
+        private static IEnumerator DelayCallRoutine(float seconds, Action callback)
+        {
+            yield return new WaitForSeconds(seconds);
+            callback();
+        }
+    }
+    
     internal class FileUtils
     {
 

package/Runtime/AmaGDK.cs

@@ -10,7 +10,7 @@ namespace Amanotes.Core
 {
     public partial class AmaGDK : MonoBehaviour
     {
-        public const string VERSION = "0.2.9";
+        public const string VERSION = "0.2.11";
 
         internal static AmaGDK _instance;
         internal static Status _status = Status.None;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "com.amanotes.gdk",
-    "version": "0.2.9",
+    "version": "0.2.11",
     "displayName": "AmaGDK",
     "description": "Amanotes Game Development Kit",
     "unity": "2020.3",