feat(audience): remove sandbox routing, add TestMode (SDK-352, SDK-353)

nattb8 · claude · nattb8 · commit 886a718fc2d0 · 2026-05-14T10:35:03.000+12:00
- Remove `TestKeyPrefix`, `SandboxBaseUrl`, and key-prefix-based URL routing
  from Constants; all keys now resolve to production by default.
- Remove `WarnIfKeyEnvironmentMismatch` and the associated log messages.
- Simplify `BaseUrl`/`MessagesUrl`/`ConsentUrl`/`DataUrl` signatures to drop
  the unused `publishableKey` parameter.
- Add `TestMode` boolean to `AudienceConfig` (default `false`). When `true`,
  all outbound events carry `test: true` so the backend can filter them.
- Delete `PublishableKeyPrefixTests` (tested removed sandbox logic).
- Update `ConstantsTests`, `HttpTransportTests`, `ConsentSyncTests`,
  `MessageBuilderTests`, and `AudienceConfigTests` to match.

Co-Authored-By: Claude Sonnet 4.6 &lt;noreply@anthropic.com&gt;
diff --git a/src/Packages/Audience/Runtime/AudienceConfig.cs b/src/Packages/Audience/Runtime/AudienceConfig.cs
@@ -21,12 +21,19 @@ public class AudienceConfig
         /// Override the default API base URL.
         /// </summary>
         /// <remarks>
-        /// When null, publishable keys starting with <c>pk_imapik-test-</c>
-        /// resolve to Sandbox. All other keys resolve to Production. Set
-        /// explicitly to target a different backend.
+        /// When null, all events are sent to the production backend. Set
+        /// explicitly to target a different backend (e.g. an internal dev
+        /// environment).
         /// </remarks>
         public string? BaseUrl { get; set; }
 
+        /// <summary>
+        /// Enables test mode. When <c>true</c>, all events are tagged with
+        /// <c>test: true</c> so the backend can filter them from production
+        /// analytics. Default <c>false</c>.
+        /// </summary>
+        public bool TestMode { get; set; } = false;
+
         /// <summary>
         /// Initial consent level.
         /// </summary>
diff --git a/src/Packages/Audience/Runtime/Core/Constants.cs b/src/Packages/Audience/Runtime/Core/Constants.cs
@@ -4,8 +4,6 @@ namespace Immutable.Audience
 {
     internal static class Constants
     {
-        internal const string TestKeyPrefix = "pk_imapik-test-";
-        internal const string SandboxBaseUrl = "https://api.sandbox.immutable.com";
         internal const string ProductionBaseUrl = "https://api.immutable.com";
 
         internal const string MessagesPath = "/v1/audience/messages";
@@ -26,21 +24,17 @@ internal static class Constants
 
         internal const string PublishableKeyHeader = "x-immutable-publishable-key";
 
-        internal static string MessagesUrl(string? publishableKey, string? baseUrlOverride = null) =>
-            BaseUrl(publishableKey, baseUrlOverride) + MessagesPath;
-        internal static string ConsentUrl(string? publishableKey, string? baseUrlOverride = null) =>
-            BaseUrl(publishableKey, baseUrlOverride) + ConsentPath;
-        internal static string DataUrl(string? publishableKey, string? baseUrlOverride = null) =>
-            BaseUrl(publishableKey, baseUrlOverride) + DataPath;
+        internal static string MessagesUrl(string? baseUrlOverride = null) =>
+            BaseUrl(baseUrlOverride) + MessagesPath;
+        internal static string ConsentUrl(string? baseUrlOverride = null) =>
+            BaseUrl(baseUrlOverride) + ConsentPath;
+        internal static string DataUrl(string? baseUrlOverride = null) =>
+            BaseUrl(baseUrlOverride) + DataPath;
 
-        // Override wins when non-empty; otherwise test keys map to Sandbox
-        // and every other key maps to Production. Matches @imtbl/audience.
-        internal static string BaseUrl(string? publishableKey, string? baseUrlOverride = null)
+        internal static string BaseUrl(string? baseUrlOverride = null)
         {
             if (!string.IsNullOrEmpty(baseUrlOverride)) return baseUrlOverride!;
-            return publishableKey != null && publishableKey.StartsWith(TestKeyPrefix)
-                ? SandboxBaseUrl
-                : ProductionBaseUrl;
+            return ProductionBaseUrl;
         }
     }
 
diff --git a/src/Packages/Audience/Runtime/Events/MessageBuilder.cs b/src/Packages/Audience/Runtime/Events/MessageBuilder.cs
@@ -12,9 +12,10 @@ internal static Dictionary<string, object> Track(
             string? anonymousId,
             string? userId,
             string packageVersion,
-            Dictionary<string, object>? properties = null)
+            Dictionary<string, object>? properties = null,
+            bool testMode = false)
         {
-            var msg = BuildBase(MessageTypes.Track, packageVersion);
+            var msg = BuildBase(MessageTypes.Track, packageVersion, testMode);
             msg["eventName"] = Truncate(eventName, Constants.MaxFieldLength);
 
             if (!string.IsNullOrEmpty(anonymousId))
@@ -37,9 +38,10 @@ internal static Dictionary<string, object> Identify(
             string? userId,
             string identityType,
             string packageVersion,
-            Dictionary<string, object>? traits = null)
+            Dictionary<string, object>? traits = null,
+            bool testMode = false)
         {
-            var msg = BuildBase(MessageTypes.Identify, packageVersion);
+            var msg = BuildBase(MessageTypes.Identify, packageVersion, testMode);
 
             if (!string.IsNullOrEmpty(anonymousId))
                 msg["anonymousId"] = Truncate(anonymousId, Constants.MaxFieldLength);
@@ -63,19 +65,20 @@ internal static Dictionary<string, object> Alias(
             string fromType,
             string toId,
             string toType,
-            string packageVersion)
+            string packageVersion,
+            bool testMode = false)
         {
-            var msg = BuildBase(MessageTypes.Alias, packageVersion);
+            var msg = BuildBase(MessageTypes.Alias, packageVersion, testMode);
             msg["fromId"] = Truncate(fromId, Constants.MaxFieldLength);
             msg["fromType"] = Truncate(fromType, Constants.MaxFieldLength);
             msg["toId"] = Truncate(toId, Constants.MaxFieldLength);
             msg["toType"] = Truncate(toType, Constants.MaxFieldLength);
             return msg;
         }
 
-        private static Dictionary<string, object> BuildBase(string type, string packageVersion)
+        private static Dictionary<string, object> BuildBase(string type, string packageVersion, bool testMode)
         {
-            return new Dictionary<string, object>
+            var msg = new Dictionary<string, object>
             {
                 [MessageFields.Type] = type,
                 ["messageId"] = Guid.NewGuid().ToString(),
@@ -87,6 +90,9 @@ private static Dictionary<string, object> BuildBase(string type, string packageV
                 },
                 ["surface"] = Constants.Surface
             };
+            if (testMode)
+                msg["test"] = true;
+            return msg;
         }
 
         private static string Truncate(string s, int maxLen)
diff --git a/src/Packages/Audience/Runtime/ImmutableAudience.cs b/src/Packages/Audience/Runtime/ImmutableAudience.cs
@@ -195,8 +195,6 @@ public static void Init(AudienceConfig config)
                     return;
                 }
 
-                WarnIfKeyEnvironmentMismatch(config.PublishableKey, config.BaseUrl);
-
                 _config = config;
                 Log.Enabled = config.Debug;
                 // Persisted consent overrides the config default (prior downgrade survives restart).
@@ -332,7 +330,7 @@ public static void Track(IEvent evt)
             var anonymousId = Identity.GetOrCreate(config.PersistentDataPath!, state.Level);
             // ToProperties returns a fresh dict per call, so no snapshot needed.
             var userId = state.Level == ConsentLevel.Full ? state.UserId : null;
-            var msg = MessageBuilder.Track(eventName, anonymousId, userId, config.PackageVersion, properties);
+            var msg = MessageBuilder.Track(eventName, anonymousId, userId, config.PackageVersion, properties, config.TestMode);
             EnqueueTrack(msg);
         }
 
@@ -359,7 +357,7 @@ public static void Track(string eventName, Dictionary<string, object>? propertie
             var anonymousId = Identity.GetOrCreate(config.PersistentDataPath!, state.Level);
             var userId = state.Level == ConsentLevel.Full ? state.UserId : null;
             var msg = MessageBuilder.Track(eventName, anonymousId, userId, config.PackageVersion,
-                SnapshotCallerDict(properties));
+                SnapshotCallerDict(properties), config.TestMode);
             EnqueueTrack(msg);
         }
 
@@ -405,7 +403,7 @@ public static void Identify(string userId, IdentityType identityType, Dictionary
 
             var anonymousId = Identity.GetOrCreate(config.PersistentDataPath!, level);
             var msg = MessageBuilder.Identify(anonymousId, userId, identityType.ToLowercaseString(),
-                config.PackageVersion, SnapshotCallerDict(traits));
+                config.PackageVersion, SnapshotCallerDict(traits), config.TestMode);
             EnqueueIdentity(msg);
         }
 
@@ -436,7 +434,7 @@ public static void Alias(string fromId, IdentityType fromType, string toId, Iden
             if (config == null) return;
 
             var msg = MessageBuilder.Alias(fromId, fromType.ToLowercaseString(), toId, toType.ToLowercaseString(),
-                config.PackageVersion);
+                config.PackageVersion, config.TestMode);
             EnqueueIdentity(msg);
         }
 
@@ -511,7 +509,7 @@ public static Task DeleteData(string? userId = null)
                 query = "anonymousId=" + Uri.EscapeDataString(anonymousId);
             }
 
-            var url = Constants.DataUrl(config.PublishableKey, config.BaseUrl) + "?" + query;
+            var url = Constants.DataUrl(config.BaseUrl) + "?" + query;
             var onError = config.OnError;
             var publishableKey = config.PublishableKey;
             var cancellationToken = _shutdownCancellationSource?.Token ?? CancellationToken.None;
@@ -675,7 +673,7 @@ private static void SyncConsentToBackend(AudienceConfig config, ConsentLevel lev
             var client = _controlClient;
             if (client == null) return;
 
-            var url = Constants.ConsentUrl(config.PublishableKey, config.BaseUrl);
+            var url = Constants.ConsentUrl(config.BaseUrl);
             var publishableKey = config.PublishableKey;
             var onError = config.OnError;
             var cancellationToken = _shutdownCancellationSource?.Token ?? CancellationToken.None;
@@ -985,25 +983,6 @@ internal static void ResetState()
         private static Dictionary<string, object>? SnapshotCallerDict(Dictionary<string, object>? src) =>
             src != null ? new Dictionary<string, object>(src) : null;
 
-        // Only the exact production/sandbox swap is flagged; custom dev/staging
-        // URLs are intentional and left alone.
-        private static void WarnIfKeyEnvironmentMismatch(string publishableKey, string? baseUrlOverride)
-        {
-            if (string.IsNullOrEmpty(baseUrlOverride)) return;
-
-            var trimmed = baseUrlOverride!.TrimEnd('/');
-            var isTestKey = publishableKey.StartsWith(Constants.TestKeyPrefix);
-
-            if (isTestKey && trimmed == Constants.ProductionBaseUrl)
-            {
-                Log.Warn(AudienceLogs.TestKeyAgainstProduction);
-            }
-            else if (!isTestKey && trimmed == Constants.SandboxBaseUrl)
-            {
-                Log.Warn(AudienceLogs.NonTestKeyAgainstSandbox);
-            }
-        }
-
         // Checks the current consent inside the drain lock. If consent has
         // since dropped to None the message is discarded. If it dropped to
         // Anonymous the userId is stripped.
diff --git a/src/Packages/Audience/Runtime/Transport/HttpTransport.cs b/src/Packages/Audience/Runtime/Transport/HttpTransport.cs
@@ -41,7 +41,7 @@ internal HttpTransport(
         {
             _store = store ?? throw new ArgumentNullException(nameof(store));
             _publishableKey = publishableKey ?? throw new ArgumentNullException(nameof(publishableKey));
-            _url = Constants.MessagesUrl(publishableKey, baseUrlOverride);
+            _url = Constants.MessagesUrl(baseUrlOverride);
             _onError = onError;
             // disposeHandler: false so the consumer can reuse their handler
             // across Init/Shutdown cycles (matches _controlClient's policy).
diff --git a/src/Packages/Audience/Runtime/Utility/Log.cs b/src/Packages/Audience/Runtime/Utility/Log.cs
@@ -51,16 +51,6 @@ internal static class AudienceLogs
             "Init called more than once. Ignoring; original config retained. " +
             "Call Shutdown() first if reconfiguring is intended.";
 
-        internal static readonly string TestKeyAgainstProduction =
-            $"Publishable key has the test prefix ({Constants.TestKeyPrefix}) but BaseUrl points to production. " +
-            "The backend will reject events with 401. Either remove the BaseUrl override (test keys " +
-            "default to sandbox) or use a non-test publishable key.";
-
-        internal static readonly string NonTestKeyAgainstSandbox =
-            "Publishable key is not a test key but BaseUrl points to sandbox. " +
-            "The backend will reject events with 401. Either remove the BaseUrl override (non-test " +
-            $"keys default to production) or use a test publishable key ({Constants.TestKeyPrefix}).";
-
         // ---- Track ----
 
         internal const string TrackIEventNull =
diff --git a/src/Packages/Audience/Tests/Runtime/AudienceConfigTests.cs b/src/Packages/Audience/Tests/Runtime/AudienceConfigTests.cs
@@ -37,5 +37,19 @@ public void SKAdNetworkIds_RoundTrips()
             var config = new AudienceConfig { SKAdNetworkIds = ids };
             Assert.AreSame(ids, config.SKAdNetworkIds);
         }
+
+        [Test]
+        public void TestMode_DefaultsToFalse()
+        {
+            var config = new AudienceConfig();
+            Assert.IsFalse(config.TestMode);
+        }
+
+        [Test]
+        public void TestMode_RoundTrips()
+        {
+            var config = new AudienceConfig { TestMode = true };
+            Assert.IsTrue(config.TestMode);
+        }
     }
 }
diff --git a/src/Packages/Audience/Tests/Runtime/ConsentSyncTests.cs b/src/Packages/Audience/Tests/Runtime/ConsentSyncTests.cs
@@ -42,7 +42,7 @@ public void SetConsent_FiresPut_WithExpectedBodyShape()
             var put = WaitForPut(handler);
             var body = JsonReader.DeserializeObject(put.Body);
 
-            Assert.AreEqual(Constants.ConsentUrl("pk_imapik-test-key1"), put.Url);
+            Assert.AreEqual(Constants.ConsentUrl(), put.Url);
             Assert.AreEqual("full", body["status"]);
             Assert.AreEqual(Constants.ConsentSource, body["source"]);
             Assert.IsTrue(body.ContainsKey("anonymousId"));
diff --git a/src/Packages/Audience/Tests/Runtime/ConstantsTests.cs b/src/Packages/Audience/Tests/Runtime/ConstantsTests.cs
@@ -11,43 +11,22 @@ internal class ConstantsTests
         // -----------------------------------------------------------------
 
         [Test]
-        public void BaseUrl_TestKey_ResolvesToSandbox()
+        public void BaseUrl_NoOverride_ResolvesToProduction()
         {
-            Assert.AreEqual(Constants.SandboxBaseUrl,
-                Constants.BaseUrl("pk_imapik-test-abc"));
+            Assert.AreEqual(Constants.ProductionBaseUrl, Constants.BaseUrl());
         }
 
         [Test]
-        public void BaseUrl_NonTestKey_ResolvesToProduction()
+        public void BaseUrl_Override_WinsOverDefault()
         {
-            Assert.AreEqual(Constants.ProductionBaseUrl,
-                Constants.BaseUrl("pk_imapik-prod-abc"));
-        }
-
-        [Test]
-        public void BaseUrl_NullKey_ResolvesToProduction()
-        {
-            Assert.AreEqual(Constants.ProductionBaseUrl,
-                Constants.BaseUrl(null));
-        }
-
-        [Test]
-        public void BaseUrl_Override_WinsOverKeyPrefix()
-        {
-            // Override wins even for a test-prefixed key that would
-            // otherwise derive to Sandbox.
             const string custom = "https://api.dev.immutable.com";
-            Assert.AreEqual(custom,
-                Constants.BaseUrl("pk_imapik-test-abc", custom));
+            Assert.AreEqual(custom, Constants.BaseUrl(custom));
         }
 
         [Test]
-        public void BaseUrl_EmptyOverride_FallsBackToKeyDerivation()
+        public void BaseUrl_EmptyOverride_FallsBackToProduction()
         {
-            // Empty-string override is treated as "no override" so the
-            // key-prefix fallback still kicks in.
-            Assert.AreEqual(Constants.SandboxBaseUrl,
-                Constants.BaseUrl("pk_imapik-test-abc", ""));
+            Assert.AreEqual(Constants.ProductionBaseUrl, Constants.BaseUrl(""));
         }
 
         // -----------------------------------------------------------------
diff --git a/src/Packages/Audience/Tests/Runtime/Events/MessageBuilderTests.cs b/src/Packages/Audience/Tests/Runtime/Events/MessageBuilderTests.cs
@@ -156,6 +156,35 @@ public void AllMessages_Context_LibraryAndLibraryVersionAreNonEmptyStrings()
             }
         }
 
+        [Test]
+        public void Track_TestModeTrue_IncludesTestFlag()
+        {
+            var result = MessageBuilder.Track("evt", null, null, PackageVersion, testMode: true);
+            Assert.IsTrue(result.ContainsKey("test"), "test field must be present when testMode is true");
+            Assert.AreEqual(true, result["test"]);
+        }
+
+        [Test]
+        public void Track_TestModeFalse_ExcludesTestFlag()
+        {
+            var result = MessageBuilder.Track("evt", null, null, PackageVersion, testMode: false);
+            Assert.IsFalse(result.ContainsKey("test"), "test field must not be present when testMode is false");
+        }
+
+        [Test]
+        public void AllMessages_TestModeTrue_AllIncludeTestFlag()
+        {
+            var track = MessageBuilder.Track("evt", null, null, PackageVersion, testMode: true);
+            var identify = MessageBuilder.Identify(null, "u1", "steam", PackageVersion, testMode: true);
+            var alias = MessageBuilder.Alias("f", "t1", "t", "t2", PackageVersion, testMode: true);
+
+            foreach (var msg in new[] { track, identify, alias })
+            {
+                Assert.IsTrue(msg.ContainsKey("test"), $"{msg["type"]} must include test field in test mode");
+                Assert.AreEqual(true, msg["test"]);
+            }
+        }
+
         private static IEnumerable<Dictionary<string, object>> EveryMessageType()
         {
             yield return MessageBuilder.Track("evt", null, null, PackageVersion);
diff --git a/src/Packages/Audience/Tests/Runtime/PublishableKeyPrefixTests.cs b/src/Packages/Audience/Tests/Runtime/PublishableKeyPrefixTests.cs
diff --git a/src/Packages/Audience/Tests/Runtime/Transport/HttpTransportTests.cs b/src/Packages/Audience/Tests/Runtime/Transport/HttpTransportTests.cs

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ internal HttpTransport(`
`41`	`41`	`{`
`42`	`42`	`_store = store ?? throw new ArgumentNullException(nameof(store));`
`43`	`43`	`_publishableKey = publishableKey ?? throw new ArgumentNullException(nameof(publishableKey));`
`44`		`- _url = Constants.MessagesUrl(publishableKey, baseUrlOverride);`
	`44`	`+ _url = Constants.MessagesUrl(baseUrlOverride);`
`45`	`45`	`_onError = onError;`
`46`	`46`	`// disposeHandler: false so the consumer can reuse their handler`
`47`	`47`	`// across Init/Shutdown cycles (matches _controlClient's policy).`