refactor(audience-sample): centralise log payload JSON keys in SampleAppUi.LogPayloadKeys

The sample-app builds Dictionary<string, object> echo payloads for
each RunAndLog "Ok" row (Track outcomes, Identify / Alias outcomes,
OnError rows, Init config echo). Each key was inline at the
construction site, so a rename (e.g. "publishableKey" to "key")
would touch six call sites today and grow as the demo expands.

Adds a LogPayloadKeys sub-class to SampleAppUi with eighteen
constants covering the existing payload schema (Event, Overload,
Effects, Id, Accepted, From, To, Code, Message, Consent, Debug,
FlushIntervalSeconds, FlushSize, PackageVersion,
ShutdownFlushTimeoutMs, PublishableKey, PersistentDataPath) plus a
nested OverloadValues for the "typed" / "string" enum-like values
written under LogPayloadKeys.Overload.

Migrates AudienceSample.cs to reference the constants. UXML element
names (in the existing SampleAppUi sub-classes) are unchanged.

Per the user's "everything random goes in a constant" stance.

Follow-up to SDK-272 (centralisation of duplicated literals).

Author: ImmutableJeffrey

examples/audience/Assets/SampleApp/Scripts/AudienceSample.cs

@@ -130,17 +130,17 @@ private void OnSendCatalogueEvent(EventSpec spec, Dictionary<string, VisualEleme
                     ImmutableAudience.Track(typed);
                     return Json.Serialize(new Dictionary<string, object>
                     {
-                        ["event"] = spec.Name,
-                        ["overload"] = "typed",
+                        [SampleAppUi.LogPayloadKeys.Event] = spec.Name,
+                        [SampleAppUi.LogPayloadKeys.Overload] = SampleAppUi.LogPayloadKeys.OverloadValues.Typed,
                         [MessageFields.Properties] = typed.ToProperties(),
                     }, 2);
                 }
 
                 ImmutableAudience.Track(spec.Name, props.Count > 0 ? props : null);
                 return Json.Serialize(new Dictionary<string, object>
                 {
-                    ["event"] = spec.Name,
-                    ["overload"] = "string",
+                    [SampleAppUi.LogPayloadKeys.Event] = spec.Name,
+                    [SampleAppUi.LogPayloadKeys.Overload] = SampleAppUi.LogPayloadKeys.OverloadValues.String,
                     [MessageFields.Properties] = props,
                 }, 2);
             });
@@ -154,7 +154,7 @@ private void OnSendCustomEvent() => RunAndLog(SampleAppUi.LogLabels.Track, () =>
             var f = CaptureCustomEventForm();
             var props = string.IsNullOrEmpty(f.RawProps) ? null : JsonReader.DeserializeObject(f.RawProps);
             ImmutableAudience.Track(f.Name, props);
-            var echo = new Dictionary<string, object> { ["event"] = f.Name };
+            var echo = new Dictionary<string, object> { [SampleAppUi.LogPayloadKeys.Event] = f.Name };
             if (props != null) echo[MessageFields.Properties] = props;
             return Json.Serialize(echo, 2);
         });
@@ -171,14 +171,14 @@ private void OnSetConsent(ConsentLevel level) => RunAndLog(SampleAppUi.LogLabels
             if (!level.CanIdentify()) ResetIdentityMirror();
             var payload = new Dictionary<string, object>
             {
-                ["from"] = previous.ToLowercaseString(),
-                ["to"] = level.ToLowercaseString(),
+                [SampleAppUi.LogPayloadKeys.From] = previous.ToLowercaseString(),
+                [SampleAppUi.LogPayloadKeys.To] = level.ToLowercaseString(),
             };
             var effects = new List<string>();
             if (previous == ConsentLevel.None && level != ConsentLevel.None) effects.Add(SampleAppUi.Messages.QueueStartedSessionCreated);
             if (level == ConsentLevel.None) effects.Add(SampleAppUi.Messages.QueuePurgedAnonymousIdCleared);
             if (!level.CanIdentify() && previous.CanIdentify()) effects.Add(SampleAppUi.Messages.UserIdCleared);
-            if (effects.Count > 0) payload["effects"] = effects;
+            if (effects.Count > 0) payload[SampleAppUi.LogPayloadKeys.Effects] = effects;
             OnSdkStateChanged();
             return Json.Serialize(payload, 2);
         });
@@ -198,9 +198,9 @@ private void OnIdentify() => RunAndLog(SampleAppUi.LogLabels.Identify, () =>
             OnSdkStateChanged();
             var payload = new Dictionary<string, object>
             {
-                ["id"]                       = f.Id,
-                [MessageFields.IdentityType] = f.Type,
-                ["accepted"]                 = accepted,
+                [SampleAppUi.LogPayloadKeys.Id]       = f.Id,
+                [MessageFields.IdentityType]          = f.Type,
+                [SampleAppUi.LogPayloadKeys.Accepted] = accepted,
             };
             if (traits != null) payload[MessageFields.Traits] = traits;
             return Json.Serialize(payload, 2);
@@ -233,9 +233,9 @@ private void OnAlias() => RunAndLog(SampleAppUi.LogLabels.Alias, () =>
             }
             return Json.Serialize(new Dictionary<string, object>
             {
-                ["from"]     = new Dictionary<string, object> { ["id"] = f.FromId, [MessageFields.IdentityType] = f.FromType },
-                ["to"]       = new Dictionary<string, object> { ["id"] = f.ToId,   [MessageFields.IdentityType] = f.ToType },
-                ["accepted"] = accepted,
+                [SampleAppUi.LogPayloadKeys.From]     = new Dictionary<string, object> { [SampleAppUi.LogPayloadKeys.Id] = f.FromId, [MessageFields.IdentityType] = f.FromType },
+                [SampleAppUi.LogPayloadKeys.To]       = new Dictionary<string, object> { [SampleAppUi.LogPayloadKeys.Id] = f.ToId,   [MessageFields.IdentityType] = f.ToType },
+                [SampleAppUi.LogPayloadKeys.Accepted] = accepted,
             }, 2);
         });
 
@@ -246,8 +246,8 @@ private void OnAlias() => RunAndLog(SampleAppUi.LogLabels.Alias, () =>
         private void OnSdkError(AudienceError err) =>
             AppendLog(SampleAppUi.LogLabels.OnError, Json.Serialize(new Dictionary<string, object>
             {
-                ["code"] = err.Code.ToString(),
-                ["message"] = err.Message,
+                [SampleAppUi.LogPayloadKeys.Code] = err.Code.ToString(),
+                [SampleAppUi.LogPayloadKeys.Message] = err.Message,
             }, 2), LogLevel.Err, LogSource.Sdk);
 
         // SDK Log.Writer adapter. May fire from any thread; AppendLog handles
@@ -334,17 +334,17 @@ private static Dictionary<string, object> BuildConfigEcho(AudienceConfig config)
         {
             var echo = new Dictionary<string, object>
             {
-                ["consent"]                = config.Consent.ToString(),
-                ["debug"]                  = config.Debug,
-                ["flushIntervalSeconds"]   = config.FlushIntervalSeconds,
-                ["flushSize"]              = config.FlushSize,
-                ["packageVersion"]         = config.PackageVersion,
-                ["shutdownFlushTimeoutMs"] = config.ShutdownFlushTimeoutMs,
+                [SampleAppUi.LogPayloadKeys.Consent]                = config.Consent.ToString(),
+                [SampleAppUi.LogPayloadKeys.Debug]                  = config.Debug,
+                [SampleAppUi.LogPayloadKeys.FlushIntervalSeconds]   = config.FlushIntervalSeconds,
+                [SampleAppUi.LogPayloadKeys.FlushSize]              = config.FlushSize,
+                [SampleAppUi.LogPayloadKeys.PackageVersion]         = config.PackageVersion,
+                [SampleAppUi.LogPayloadKeys.ShutdownFlushTimeoutMs] = config.ShutdownFlushTimeoutMs,
             };
             if (!string.IsNullOrEmpty(config.PublishableKey))
-                echo["publishableKey"] = RedactPublishableKey(config.PublishableKey);
+                echo[SampleAppUi.LogPayloadKeys.PublishableKey] = RedactPublishableKey(config.PublishableKey);
             if (!string.IsNullOrEmpty(config.PersistentDataPath))
-                echo["persistentDataPath"] = config.PersistentDataPath;
+                echo[SampleAppUi.LogPayloadKeys.PersistentDataPath] = config.PersistentDataPath;
             return echo;
         }
 

examples/audience/Assets/SampleApp/Scripts/SampleAppUi.cs

@@ -301,5 +301,42 @@ internal static class Consent
             internal const string Anonymous = "anonymous";
             internal const string Full = "full";
         }
+
+        // Log payload JSON keys used by RunAndLog "Ok" row dictionaries.
+
+        internal static class LogPayloadKeys
+        {
+            // Track outcomes
+            internal const string Event = "event";
+            internal const string Overload = "overload";
+            internal const string Effects = "effects";
+
+            // Identify / Alias outcomes
+            internal const string Id = "id";
+            internal const string Accepted = "accepted";
+            internal const string From = "from";
+            internal const string To = "to";
+
+            // OnError row payload
+            internal const string Code = "code";
+            internal const string Message = "message";
+
+            // Init config echo
+            internal const string Consent = "consent";
+            internal const string Debug = "debug";
+            internal const string FlushIntervalSeconds = "flushIntervalSeconds";
+            internal const string FlushSize = "flushSize";
+            internal const string PackageVersion = "packageVersion";
+            internal const string ShutdownFlushTimeoutMs = "shutdownFlushTimeoutMs";
+            internal const string PublishableKey = "publishableKey";
+            internal const string PersistentDataPath = "persistentDataPath";
+
+            // Track overload values.
+            internal static class OverloadValues
+            {
+                internal const string Typed = "typed";
+                internal const string String = "string";
+            }
+        }
     }
 }