TNT-39265 [ODD] Implement trace provider (#23)

* TNT-39265 [ODD] Implement trace provider
* Add Trace handler test

Author: XDex

Source/Adobe.Target.Client/Model/OnDevice/OnDeviceDecisioningRule.cs

@@ -11,6 +11,7 @@
 namespace Adobe.Target.Client.Model.OnDevice
 {
     using System.Collections.Generic;
+    using Adobe.Target.Client.Util;
     using Newtonsoft.Json;
     using Newtonsoft.Json.Linq;
 
@@ -39,6 +40,6 @@ internal OnDeviceDecisioningRule(string ruleKey, string activityId, IReadOnlyLis
 
         internal IReadOnlyDictionary<string, object> Meta { get; }
 
-        public override string ToString() => JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented);
+        public override string ToString() => SerializationUtils.Serialize(this);
     }
 }

Source/Adobe.Target.Client/Model/OnDevice/OnDeviceDecisioningRuleSet.cs

@@ -11,12 +11,16 @@
 namespace Adobe.Target.Client.Model.OnDevice
 {
     using System.Collections.Generic;
+    using Adobe.Target.Client.Util;
     using Newtonsoft.Json;
 
-    internal sealed class OnDeviceDecisioningRuleSet
+    /// <summary>
+    /// On-Device Decisioning Ruleset
+    /// </summary>
+    public sealed class OnDeviceDecisioningRuleSet
     {
         [JsonConstructor]
-        internal OnDeviceDecisioningRuleSet(string version, string globalMbox, bool geoTargetingEnabled, IReadOnlyList<string> remoteMboxes, IReadOnlyList<string> remoteViews, IReadOnlyList<string> localMboxes, IReadOnlyList<string> localViews, IReadOnlyList<string> responseTokens, OnDeviceDecisioningRules rules, IReadOnlyDictionary<string, object> meta)
+        internal OnDeviceDecisioningRuleSet(string version, string globalMbox, bool geoTargetingEnabled, IReadOnlyList<string> remoteMboxes, IReadOnlyList<string> remoteViews, IReadOnlyList<string> localMboxes, IReadOnlyList<string> localViews, IReadOnlyList<string> responseTokens, OnDeviceDecisioningRules rules, IDictionary<string, object> meta)
         {
             this.Version = version;
             this.GlobalMbox = globalMbox;
@@ -48,8 +52,12 @@ internal OnDeviceDecisioningRuleSet(string version, string globalMbox, bool geoT
 
         internal OnDeviceDecisioningRules Rules { get; }
 
-        internal IReadOnlyDictionary<string, object> Meta { get; }
+        internal IDictionary<string, object> Meta { get; }
 
-        public override string ToString() => JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented);
+        /// <summary>
+        /// Serializes ruleset to string
+        /// </summary>
+        /// <returns>Serialized ruleset</returns>
+        public override string ToString() => SerializationUtils.Serialize(this);
     }
 }

Source/Adobe.Target.Client/Model/OnDevice/OnDeviceDecisioningRules.cs

@@ -11,6 +11,7 @@
 namespace Adobe.Target.Client.Model.OnDevice
 {
     using System.Collections.Generic;
+    using Adobe.Target.Client.Util;
     using Newtonsoft.Json;
 
     internal sealed class OnDeviceDecisioningRules
@@ -26,6 +27,6 @@ internal OnDeviceDecisioningRules(IReadOnlyDictionary<string, IReadOnlyList<OnDe
 
         internal IReadOnlyDictionary<string, IReadOnlyList<OnDeviceDecisioningRule>> Views { get; }
 
-        public override string ToString() => JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented);
+        public override string ToString() => SerializationUtils.Serialize(this);
     }
 }

Source/Adobe.Target.Client/Model/TargetDeliveryResponse.cs

@@ -15,7 +15,6 @@ namespace Adobe.Target.Client.Model
     using Adobe.ExperienceCloud.Ecid;
     using Adobe.Target.Client.Util;
     using Adobe.Target.Delivery.Model;
-    using Newtonsoft.Json;
 
     /// <summary>
     /// Target Delivery Response
@@ -115,6 +114,6 @@ public Dictionary<string, TargetCookie> GetCookies()
         }
 
         /// <inheritdoc />
-        public override string ToString() => JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented);
+        public override string ToString() => SerializationUtils.Serialize(this);
     }
 }

Source/Adobe.Target.Client/OnDevice/DecisioningDetailsExecutor.cs

@@ -35,16 +35,18 @@ public void ExecuteDetails(
             IDictionary<string, object> localContext,
             string visitorId,
             ISet<string> responseTokens,
+            TraceHandler traceHandler,
             OnDeviceDecisioningRuleSet ruleSet,
             RequestDetailsUnion details,
             PrefetchResponse prefetchResponse,
             ExecuteResponse executeResponse,
             IList<Notification> notifications)
         {
+            traceHandler?.UpdateRequest(deliveryRequest, details, executeResponse != null);
             var rules = GetDetailsRules(details, ruleSet);
             if (rules == null)
             {
-                UnhandledResponse(details, prefetchResponse, executeResponse);
+                UnhandledResponse(details, prefetchResponse, executeResponse, traceHandler);
                 return;
             }
 
@@ -64,8 +66,8 @@ public void ExecuteDetails(
                     continue;
                 }
 
-                var consequence = this.ruleExecutor.ExecuteRule(localContext, details, visitorId, rule, responseTokens);
-                if (!HandleResult(consequence, rule, details, prefetchResponse, executeResponse, notifications, ruleSet.GlobalMbox))
+                var consequence = this.ruleExecutor.ExecuteRule(localContext, details, visitorId, rule, responseTokens, traceHandler);
+                if (!HandleResult(consequence, rule, details, prefetchResponse, executeResponse, notifications, traceHandler, ruleSet.GlobalMbox))
                 {
                     continue;
                 }
@@ -87,7 +89,7 @@ public void ExecuteDetails(
 
             if (!handledAtLeastOnce)
             {
-                UnhandledResponse(details, prefetchResponse, executeResponse);
+                UnhandledResponse(details, prefetchResponse, executeResponse, traceHandler);
             }
         }
 
@@ -98,6 +100,7 @@ private static bool HandleResult(
             PrefetchResponse prefetchResponse,
             ExecuteResponse executeResponse,
             IList<Notification> notifications,
+            TraceHandler traceHandler,
             string globalMbox = "target-global-mbox")
         {
             if (consequence == null || consequence.Count == 0)
@@ -117,27 +120,31 @@ private static bool HandleResult(
             if (executeResponse != null)
             {
                 var notification = CreateNotification(details, consequenceOptions, globalMbox);
+                traceHandler?.AddNotification(rule, notification);
                 notifications.Add(notification);
             }
 
             return details.Match(
-                _ => HandlePageLoad(prefetchResponse, executeResponse, consequenceOptions, consequenceMetrics),
-                mboxRequest => HandleMboxRequest(prefetchResponse, executeResponse, mboxRequest, consequenceOptions, consequenceMetrics),
-                _ => HandleViewRequest(prefetchResponse, consequenceName, consequenceOptions, consequenceMetrics));
+                _ => HandlePageLoad(prefetchResponse, executeResponse, consequenceOptions, consequenceMetrics, traceHandler),
+                mboxRequest => HandleMboxRequest(prefetchResponse, executeResponse, mboxRequest, consequenceOptions, consequenceMetrics, traceHandler),
+                _ => HandleViewRequest(prefetchResponse, consequenceName, consequenceOptions, consequenceMetrics, traceHandler));
         }
 
         private static bool HandleViewRequest(
             PrefetchResponse prefetchResponse,
             string consequenceName,
             List<Option> consequenceOptions,
-            List<Metric> consequenceMetrics)
+            List<Metric> consequenceMetrics,
+            TraceHandler traceHandler)
         {
             if (prefetchResponse == null)
             {
                 return false;
             }
 
             var responseView = new View(consequenceName, null, consequenceOptions, consequenceMetrics);
+            responseView.Trace = traceHandler?.CurrentTrace;
+
             var views = prefetchResponse.Views;
             if (views == null)
             {
@@ -172,7 +179,8 @@ private static bool HandleMboxRequest(
             ExecuteResponse executeResponse,
             MboxRequest mboxRequest,
             List<Option> consequenceOptions,
-            List<Metric> consequenceMetrics)
+            List<Metric> consequenceMetrics,
+            TraceHandler traceHandler)
         {
             if (prefetchResponse != null)
             {
@@ -199,6 +207,7 @@ private static bool HandleMboxRequest(
                             })
                         .Where(option => option.Type != null || option.Content != null)
                         .ToList(),
+                    Trace = traceHandler?.CurrentTrace,
                 };
             executeResponse.Mboxes ??= new List<MboxResponse>();
             executeResponse.Mboxes.Add(mboxResponse);
@@ -209,7 +218,8 @@ private static bool HandlePageLoad(
             PrefetchResponse prefetchResponse,
             ExecuteResponse executeResponse,
             IList<Option> consequenceOptions,
-            IList<Metric> consequenceMetrics)
+            IList<Metric> consequenceMetrics,
+            TraceHandler traceHandler)
         {
             PageLoadResponse pageLoad = null;
             if (prefetchResponse != null)
@@ -228,6 +238,8 @@ private static bool HandlePageLoad(
                 return false;
             }
 
+            pageLoad.Trace = traceHandler?.CurrentTrace;
+
             if (consequenceOptions != null)
             {
                 foreach (var option in consequenceOptions)
@@ -291,41 +303,58 @@ private static List<Metric> GetMetrics(object metricsObject)
             return metricsObject is not JArray metricsArray || metricsArray.Count == 0 ? null : metricsArray.ToObject<List<Metric>>();
         }
 
-        private static void UnhandledResponse(RequestDetailsUnion details, PrefetchResponse prefetchResponse, ExecuteResponse executeResponse)
+        private static void UnhandledResponse(
+            RequestDetailsUnion details,
+            PrefetchResponse prefetchResponse,
+            ExecuteResponse executeResponse,
+            TraceHandler traceHandler)
         {
             _ = details.Match<object>(
-                _ => UnhandledPageLoadResponse(prefetchResponse, executeResponse),
-                mboxRequest => UnhandledMboxResponse(prefetchResponse, executeResponse, mboxRequest),
-                _ => UnhandledViewResponse(prefetchResponse));
+                _ => UnhandledPageLoadResponse(prefetchResponse, executeResponse, traceHandler),
+                mboxRequest => UnhandledMboxResponse(prefetchResponse, executeResponse, mboxRequest, traceHandler),
+                _ => UnhandledViewResponse(prefetchResponse, traceHandler));
         }
 
-        private static object UnhandledViewResponse(PrefetchResponse prefetchResponse)
+        private static object UnhandledViewResponse(PrefetchResponse prefetchResponse, TraceHandler traceHandler)
         {
-            var view = new View();
+            var view = new View { Trace = traceHandler?.CurrentTrace };
             prefetchResponse.Views ??= new List<View>();
             prefetchResponse.Views.Add(view);
             return null;
         }
 
-        private static object UnhandledMboxResponse(PrefetchResponse prefetchResponse, ExecuteResponse executeResponse, MboxRequest mboxRequest)
+        private static object UnhandledMboxResponse(
+            PrefetchResponse prefetchResponse,
+            ExecuteResponse executeResponse,
+            MboxRequest mboxRequest,
+            TraceHandler traceHandler)
         {
             if (prefetchResponse != null)
             {
-                var prefetchMboxResponse = new PrefetchMboxResponse(mboxRequest.Index, mboxRequest.Name);
+                var prefetchMboxResponse = new PrefetchMboxResponse(mboxRequest.Index, mboxRequest.Name)
+                {
+                    Trace = traceHandler?.CurrentTrace,
+                };
                 prefetchResponse.Mboxes ??= new List<PrefetchMboxResponse>();
                 prefetchResponse.Mboxes.Add(prefetchMboxResponse);
                 return null;
             }
 
-            var response = new MboxResponse(mboxRequest.Index, mboxRequest.Name);
+            var response = new MboxResponse(mboxRequest.Index, mboxRequest.Name)
+            {
+                Trace = traceHandler?.CurrentTrace,
+            };
             executeResponse.Mboxes ??= new List<MboxResponse>();
             executeResponse.Mboxes.Add(response);
             return null;
         }
 
-        private static object UnhandledPageLoadResponse(PrefetchResponse prefetchResponse, ExecuteResponse executeResponse)
+        private static object UnhandledPageLoadResponse(
+            PrefetchResponse prefetchResponse,
+            ExecuteResponse executeResponse,
+            TraceHandler traceHandler)
         {
-            var response = new PageLoadResponse();
+            var response = new PageLoadResponse { Trace = traceHandler?.CurrentTrace };
             if (prefetchResponse != null)
             {
                 prefetchResponse.PageLoad = response;

Source/Adobe.Target.Client/OnDevice/DecisioningRuleExecutor.cs

@@ -42,12 +42,15 @@ public IDictionary<string, object> ExecuteRule(
             RequestDetailsUnion details,
             string visitorId,
             OnDeviceDecisioningRule rule,
-            ISet<string> responseTokens)
+            ISet<string> responseTokens,
+            TraceHandler traceHandler)
         {
             localContext.Remove(Allocation);
             localContext.Add(Allocation, this.ComputeAllocation(visitorId, rule));
 
             var matched = this.EvaluateRule(rule.Condition, localContext.ToExpandoObject());
+            traceHandler?.AddCampaign(rule, localContext, matched);
+
             if (!matched)
             {
                 return null;

Source/Adobe.Target.Client/OnDevice/IRuleLoader.cs

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2021 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+#nullable enable
+namespace Adobe.Target.Client.OnDevice
+{
+    using System;
+    using Adobe.Target.Client.Model.OnDevice;
+
+    /// <summary>
+    /// Rule Loader
+    /// </summary>
+    public interface IRuleLoader
+    {
+        /// <summary>
+        /// Artifact URL
+        /// </summary>
+        string ArtifactUrl { get; }
+
+        /// <summary>
+        /// Polling Interval
+        /// </summary>
+        int PollingInterval { get; }
+
+        /// <summary>
+        /// Fetch Count
+        /// </summary>
+        int FetchCount { get; }
+
+        /// <summary>
+        /// Last fetch datetime
+        /// </summary>
+        DateTimeOffset LastFetch { get; }
+
+        /// <summary>
+        /// Gets latest rules
+        /// </summary>
+        /// <returns>Last downloaded rules artifact</returns>
+        OnDeviceDecisioningRuleSet? GetLatestRules();
+    }
+}