diff --git a/MIGRATION.md b/MIGRATION.md
index 80ab4d1b8..f2dc511e2 100644
--- a/MIGRATION.md
+++ b/MIGRATION.md
@@ -1,5 +1,13 @@
# Migration guides
+## 5.x to 5.x
+
+### Public API changes
+
+- `RadarInitializeOptions.trackVerifiedAutoFailover` and `RadarInitializeOptions.Builder.trackVerifiedAutoFailover()` are removed. Failover is now always on for every request. Remove the option from your code. Kotlin and Java code that sets it no longer compiles.
+- The SDK no longer reads the value that older SDK versions saved for this option, so a saved `false` does not turn off failover.
+- Before 4.2.0, failover was off by default. If you upgrade from 4.1.x or earlier, or if you set the option to `false`, `Radar.trackVerified()` can now send requests to the secondary verified host, `api-verified.radar.com`. If your app limits which hosts it can reach or pins certificates (for example, in `network_security_config.xml`), allow this host.
+
## 4.3.x to 5.0.0
### Public API changes
diff --git a/example/src/main/res/xml/network_security_config.xml b/example/src/main/res/xml/network_security_config.xml
index a24bc20b7..66d084610 100644
--- a/example/src/main/res/xml/network_security_config.xml
+++ b/example/src/main/res/xml/network_security_config.xml
@@ -25,7 +25,7 @@
09MICn++JSUz2tk36fH+5qiuUAbbxx4JzrAHR3QHu/I=
-
+
api-verified.radar.com
diff --git a/sdk/ktlint-baseline.xml b/sdk/ktlint-baseline.xml
index 9b741f72e..ab8db3afe 100644
--- a/sdk/ktlint-baseline.xml
+++ b/sdk/ktlint-baseline.xml
@@ -94,12 +94,6 @@
-
-
-
-
-
-
diff --git a/sdk/src/main/java/io/radar/sdk/Radar.kt b/sdk/src/main/java/io/radar/sdk/Radar.kt
index 5845a4de6..55946f4e1 100644
--- a/sdk/src/main/java/io/radar/sdk/Radar.kt
+++ b/sdk/src/main/java/io/radar/sdk/Radar.kt
@@ -777,8 +777,6 @@ object Radar {
RadarSettings.setFraudEnabled(this.context, options.fraud)
- RadarSettings.setTrackVerifiedAutoFailover(this.context, options.trackVerifiedAutoFailover)
-
options.networkTimeout?.let { desiredTimeout ->
if (!desiredTimeout.isFinite() || desiredTimeout.isNegative()) {
this.logger.d("networkTimeout ignored: must be finite and non-negative | value = $desiredTimeout")
diff --git a/sdk/src/main/java/io/radar/sdk/RadarInitializeOptions.kt b/sdk/src/main/java/io/radar/sdk/RadarInitializeOptions.kt
index 5250f82e0..2147917a0 100644
--- a/sdk/src/main/java/io/radar/sdk/RadarInitializeOptions.kt
+++ b/sdk/src/main/java/io/radar/sdk/RadarInitializeOptions.kt
@@ -1,7 +1,7 @@
package io.radar.sdk
-import android.app.Notification
import android.app.Activity
+import android.app.Notification
import kotlin.time.Duration
/**
@@ -18,7 +18,6 @@ import kotlin.time.Duration
* @param[activity] An optional activity that overwrites the activity from context.
* @param[networkTimeout] Connect and base read timeout for Radar API requests.
* If set, the value is persisted. If null, a previously saved value or default (10 seconds) is used.
- * @param[trackVerifiedAutoFailover] A boolean indicating whether `trackVerified()` should retry against a secondary verified host if the primary returns a non-Radar response. Defaults to true.
* @param[ipChangeDebounceInterval] Minimum interval between deliveries of `RadarVerifiedReceiver.onIpChanged`. If set, the value is persisted. If null, a previously saved value or default (10 seconds) is used. Pass `Duration.ZERO` to disable throttling (deliver every detected change).
*
*/
@@ -33,8 +32,7 @@ data class RadarInitializeOptions(
val authToken: String? = null,
val activity: Activity? = null,
val networkTimeout: Duration? = null,
- val trackVerifiedAutoFailover: Boolean = true,
- val ipChangeDebounceInterval: Duration? = null,
+ val ipChangeDebounceInterval: Duration? = null
) {
class Builder {
private var radarReceiver: RadarReceiver? = null
@@ -47,7 +45,6 @@ data class RadarInitializeOptions(
private var authToken: String? = null
private var activity: Activity? = null
private var networkTimeout: Duration? = null
- private var trackVerifiedAutoFailover: Boolean = true
private var ipChangeDebounceInterval: Duration? = null
fun radarReceiver(radarReceiver: RadarReceiver) = apply { this.radarReceiver = radarReceiver }
@@ -60,7 +57,6 @@ data class RadarInitializeOptions(
fun authToken(authToken: String) = apply { this.authToken = authToken }
fun activity(activity: Activity) = apply { this.activity = activity }
fun networkTimeout(networkTimeout: Duration) = apply { this.networkTimeout = networkTimeout }
- fun trackVerifiedAutoFailover(trackVerifiedAutoFailover: Boolean) = apply { this.trackVerifiedAutoFailover = trackVerifiedAutoFailover }
fun ipChangeDebounceInterval(ipChangeDebounceInterval: Duration) = apply { this.ipChangeDebounceInterval = ipChangeDebounceInterval }
fun build() = RadarInitializeOptions(
@@ -74,8 +70,7 @@ data class RadarInitializeOptions(
authToken = authToken,
activity = activity,
networkTimeout = networkTimeout,
- trackVerifiedAutoFailover = trackVerifiedAutoFailover,
- ipChangeDebounceInterval = ipChangeDebounceInterval,
+ ipChangeDebounceInterval = ipChangeDebounceInterval
)
}
@@ -84,4 +79,3 @@ data class RadarInitializeOptions(
fun builder() = Builder()
}
}
-
diff --git a/sdk/src/main/java/io/radar/sdk/RadarSettings.kt b/sdk/src/main/java/io/radar/sdk/RadarSettings.kt
index 43b74078e..ae5af7f93 100644
--- a/sdk/src/main/java/io/radar/sdk/RadarSettings.kt
+++ b/sdk/src/main/java/io/radar/sdk/RadarSettings.kt
@@ -44,7 +44,6 @@ internal object RadarSettings {
private const val KEY_X_PLATFORM_SDK_VERSION = "x_platform_sdk_version"
private const val KEY_USER_TAGS = "user_tags"
private const val KEY_FRAUD_ENABLED = "fraudEnabled"
- private const val KEY_TRACK_VERIFIED_AUTO_FAILOVER = "track_verified_auto_failover"
private const val KEY_NETWORK_TIMEOUT_MS = "network_timeout_ms"
private const val KEY_IP_CHANGE_DEBOUNCE_INTERVAL_MS = "ip_change_debounce_interval_ms"
@@ -166,12 +165,6 @@ internal object RadarSettings {
getSharedPreferences(context).edit { putLong(KEY_IP_CHANGE_DEBOUNCE_INTERVAL_MS, intervalMs) }
}
- internal fun getTrackVerifiedAutoFailover(context: Context): Boolean = getSharedPreferences(context).getBoolean(KEY_TRACK_VERIFIED_AUTO_FAILOVER, true)
-
- internal fun setTrackVerifiedAutoFailover(context: Context, enabled: Boolean) {
- getSharedPreferences(context).edit { putBoolean(KEY_TRACK_VERIFIED_AUTO_FAILOVER, enabled) }
- }
-
internal fun getTracking(context: Context): Boolean = getSharedPreferences(context).getBoolean(KEY_TRACKING, false)
internal fun setTracking(context: Context, tracking: Boolean) {
diff --git a/sdk/src/main/java/io/radar/sdk/RadarVerificationManager.kt b/sdk/src/main/java/io/radar/sdk/RadarVerificationManager.kt
index ece301a79..5d9699831 100644
--- a/sdk/src/main/java/io/radar/sdk/RadarVerificationManager.kt
+++ b/sdk/src/main/java/io/radar/sdk/RadarVerificationManager.kt
@@ -56,7 +56,6 @@ internal class RadarVerificationManager(
val lastTokenBeacons = beacons
val usage = "trackVerified"
- val autoFailover = RadarSettings.getTrackVerifiedAutoFailover(context)
val trace = RadarTraceSpan.start("radar.track_verified") {
desiredAccuracy(desiredAccuracy)
@@ -258,48 +257,35 @@ internal class RadarVerificationManager(
}
}
- if (autoFailover) {
- Radar.apiClient.getConfig(
- usage = usage,
- verified = true,
- callback = object : RadarApiClient.RadarGetConfigApiCallback {
- override fun onComplete(status: Radar.RadarStatus, config: RadarConfig?) {
- config?.let {
- continueWithConfig(status, config, null)
- return
- }
-
- val secondary = RadarSettings.getDefaultVerifiedHostSecondary()
- logger.d("trackVerified: primary verified host returned non-Radar response, retrying on secondary=$secondary")
-
- trace.verifiedFailover(true)
- Radar.apiClient.getConfig(
- usage = usage,
- verified = true,
- verifiedHostOverride = secondary,
- callback = object : RadarApiClient.RadarGetConfigApiCallback {
- override fun onComplete(status: Radar.RadarStatus, config: RadarConfig?) {
- continueWithConfig(status, config, secondary)
- }
- },
- parentSpan = trace
- )
- }
- },
- parentSpan = trace
- )
- } else {
- Radar.apiClient.getConfig(
- usage = usage,
- verified = true,
- callback = object : RadarApiClient.RadarGetConfigApiCallback {
- override fun onComplete(status: Radar.RadarStatus, config: RadarConfig?) {
+ Radar.apiClient.getConfig(
+ usage = usage,
+ verified = true,
+ callback = object : RadarApiClient.RadarGetConfigApiCallback {
+ override fun onComplete(status: Radar.RadarStatus, config: RadarConfig?) {
+ config?.let {
continueWithConfig(status, config, null)
+ return
}
- },
- parentSpan = trace
- )
- }
+
+ val secondary = RadarSettings.getDefaultVerifiedHostSecondary()
+ logger.d("trackVerified: primary verified host returned non-Radar response, retrying on secondary=$secondary")
+
+ trace.verifiedFailover(true)
+ Radar.apiClient.getConfig(
+ usage = usage,
+ verified = true,
+ verifiedHostOverride = secondary,
+ callback = object : RadarApiClient.RadarGetConfigApiCallback {
+ override fun onComplete(status: Radar.RadarStatus, config: RadarConfig?) {
+ continueWithConfig(status, config, secondary)
+ }
+ },
+ parentSpan = trace
+ )
+ }
+ },
+ parentSpan = trace
+ )
}
private fun callTrackVerified(reason: String?) {
diff --git a/sdk/src/test/java/io/radar/sdk/RadarTest.kt b/sdk/src/test/java/io/radar/sdk/RadarTest.kt
index 32b4bc1a5..ee9748605 100644
--- a/sdk/src/test/java/io/radar/sdk/RadarTest.kt
+++ b/sdk/src/test/java/io/radar/sdk/RadarTest.kt
@@ -4745,6 +4745,11 @@ class RadarTest {
@Test
fun test_Radar_trackVerified_failover_tracesBothConfigRequests() {
+ // An older SDK saved trackVerifiedAutoFailover in shared preferences. A saved false
+ // value must not turn off failover.
+ context.getSharedPreferences("RadarSDK", Context.MODE_PRIVATE).edit()
+ .putBoolean("track_verified_auto_failover", false)
+ .commit()
Radar.traceManager!!.overrideSampledForTesting(true)
mockTrackVerifiedBeacons()
apiHelperMock.queueMockResponses(
diff --git a/sdk/src/test/java/io/radar/sdk/RadarVerifiedHostOverrideTest.kt b/sdk/src/test/java/io/radar/sdk/RadarVerifiedHostOverrideTest.kt
index cf065a356..3a2b16122 100644
--- a/sdk/src/test/java/io/radar/sdk/RadarVerifiedHostOverrideTest.kt
+++ b/sdk/src/test/java/io/radar/sdk/RadarVerifiedHostOverrideTest.kt
@@ -42,35 +42,6 @@ class RadarVerifiedHostOverrideTest {
apiHelperMock.lastUrl = null
}
- @Test
- fun `trackVerifiedAutoFailover defaults to true`() {
- assertTrue(RadarInitializeOptions().trackVerifiedAutoFailover)
- assertTrue(RadarInitializeOptions.builder().build().trackVerifiedAutoFailover)
- }
-
- @Test
- fun `trackVerifiedAutoFailover setting defaults to true before initialize`() {
- context.getSharedPreferences("RadarSDK", Context.MODE_PRIVATE).edit().clear().commit()
- assertTrue(RadarSettings.getTrackVerifiedAutoFailover(context))
- }
-
- @Test
- fun `trackVerifiedAutoFailover persists through initialize`() {
- Radar.initialize(
- context,
- publishableKey,
- RadarInitializeOptions(trackVerifiedAutoFailover = true)
- )
- assertTrue(RadarSettings.getTrackVerifiedAutoFailover(context))
-
- Radar.initialize(
- context,
- publishableKey,
- RadarInitializeOptions(trackVerifiedAutoFailover = false)
- )
- assertFalse(RadarSettings.getTrackVerifiedAutoFailover(context))
- }
-
@Test
fun `default verified host secondary is expected`() {
assertEquals("https://api-verified.radar.com", RadarSettings.getDefaultVerifiedHostSecondary())