WMSDK-410: change slidingExpiration contract

sergeysozinov · sozinov · commit 1cf7d8aeab8a · 2025-02-14T13:29:40.000+03:00
diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/inapp/data/mapper/InAppMapper.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/inapp/data/mapper/InAppMapper.kt
@@ -467,7 +467,7 @@ internal class InAppMapper {
     )
 
     fun mapToSlidingExpiration(slidingExpirationDtoBlank: SettingsDtoBlank.SlidingExpirationDtoBlank) = SlidingExpirationDto(
-        inappSession = slidingExpirationDtoBlank.inappSession
+        config = slidingExpirationDtoBlank.config
     )
 
     private fun getTargetingProductSegmentationsList(targeting: TreeTargeting): List<String> {
diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/inapp/data/repositories/MobileConfigRepositoryImpl.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/inapp/data/repositories/MobileConfigRepositoryImpl.kt
@@ -160,8 +160,8 @@ internal class MobileConfigRepositoryImpl(
             null
         }
 
-        val slidingExpiration = runCatching { getInAppSession(configBlank) }.getOrNull {
-            mindboxLogW("Unable to get InAppSession settings $it")
+        val slidingExpiration = runCatching { getConfigSession(configBlank) }.getOrNull {
+            mindboxLogW("Unable to get slidingExpiration settings $it")
         }
 
         return SettingsDto(operations, ttl, slidingExpiration)
@@ -179,15 +179,15 @@ internal class MobileConfigRepositoryImpl(
             null
         }
 
-    private fun getInAppSession(configBlank: InAppConfigResponseBlank?): SlidingExpirationDto? =
+    private fun getConfigSession(configBlank: InAppConfigResponseBlank?): SlidingExpirationDto? =
         try {
             configBlank?.settings?.slidingExpiration?.takeIf { slidingExpirationDtoBlank ->
                 slidingExpirationValidator.isValid(slidingExpirationDtoBlank)
             }?.let { slidingExpirationDtoBlank ->
                 inAppMapper.mapToSlidingExpiration(slidingExpirationDtoBlank)
             }
         } catch (e: Exception) {
-            mindboxLogE("Error parse inappsSession time", e)
+            mindboxLogE("Error parse config session time", e)
             null
         }
 
diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/inapp/data/validators/SlidingExpirationParametersValidator.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/inapp/data/validators/SlidingExpirationParametersValidator.kt
@@ -7,6 +7,6 @@ import cloud.mindbox.mobile_sdk.utils.loggingRunCatching
 internal class SlidingExpirationParametersValidator : Validator<SettingsDtoBlank.SlidingExpirationDtoBlank> {
     override fun isValid(item: SettingsDtoBlank.SlidingExpirationDtoBlank): Boolean =
         loggingRunCatching(false) {
-            item.inappSession.parseTimeSpanToMillis() > 0
+            item.config.parseTimeSpanToMillis() > 0
         }
 }
diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/managers/MobileConfigSettingsManagerImpl.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/managers/MobileConfigSettingsManagerImpl.kt
@@ -8,7 +8,7 @@ import kotlin.time.Duration.Companion.milliseconds
 
 internal class MobileConfigSettingsManagerImpl(private val sessionStorageManager: SessionStorageManager) : MobileConfigSettingsManager {
     override fun saveSessionTime(config: InAppConfigResponse) {
-        config.settings?.slidingExpiration?.inappSession?.parseTimeSpanToMillis()?.let { sessionTime ->
+        config.settings?.slidingExpiration?.config?.parseTimeSpanToMillis()?.let { sessionTime ->
             if (sessionTime > 0) {
                 sessionStorageManager.sessionTime = sessionTime.milliseconds
                 mindboxLogI("Session time set to ${sessionStorageManager.sessionTime.inWholeMilliseconds} ms")
diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/models/operation/response/InAppConfigResponse.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/models/operation/response/InAppConfigResponse.kt
@@ -35,8 +35,8 @@ internal data class SettingsDtoBlank(
     )
 
     internal data class SlidingExpirationDtoBlank(
-        @SerializedName("inappSession")
-        val inappSession: String
+        @SerializedName("config")
+        val config: String
     )
 }
 
@@ -60,8 +60,8 @@ internal data class TtlDto(
 )
 
 internal data class SlidingExpirationDto(
-    @SerializedName("inappSession")
-    val inappSession: String
+    @SerializedName("config")
+    val config: String
 )
 
 internal data class LogRequestDto(
diff --git a/sdk/src/test/java/cloud/mindbox/mobile_sdk/inapp/data/managers/serialization/SettingsMobileConfigSerializationManagerTest.kt b/sdk/src/test/java/cloud/mindbox/mobile_sdk/inapp/data/managers/serialization/SettingsMobileConfigSerializationManagerTest.kt
@@ -97,6 +97,8 @@ class SettingsMobileConfigSerializationManagerTest {
 
         assertNotNull(config.settings)
         assertEquals(3, config.settings!!.operations!!.size)
+        assertNotNull(config.settings.ttl?.inApps)
+        assertNotNull(config.settings.slidingExpiration?.config)
 
         assertNotNull(config.abtests)
         assertEquals(2, config.abtests!!.size)
@@ -114,6 +116,9 @@ class SettingsMobileConfigSerializationManagerTest {
 
         assertNotNull(config.ttl)
         assertNotNull(config.ttl?.inApps)
+
+        assertNotNull(config.slidingExpiration)
+        assertNotNull(config.slidingExpiration?.config)
     }
 
     // MARK: - Operations
@@ -441,4 +446,80 @@ class SettingsMobileConfigSerializationManagerTest {
             config.ttl?.inApps,
         )
     }
+
+    // MARK: - SlidingExpiration
+
+    @Test
+    fun settings_config_withSlidingExpirationError_shouldSetTtlToNull() {
+        val json = getJson("ConfigParsing/Settings/SlidingExpirationErrors/SettingsSlidingExpirationError.json")
+        val config = manager.deserializeSettings(json)!!
+
+        assertNotNull("Operations must be successfully parsed", config.operations)
+        assertNotNull(config.operations?.get("viewProduct"))
+        assertNotNull(config.operations?.get("viewCategory"))
+        assertNotNull(config.operations?.get("setCart"))
+
+        assertNotNull("TTL must be successfully parsed", config.ttl)
+        assertNotNull("TTL must be successfully parsed", config.ttl?.inApps)
+
+        assertNull("SlidingExpiration must be `null` if the key `slidingExpiration` is not found", config.slidingExpiration)
+        assertNull("Config session time must be `null`", config.slidingExpiration?.config)
+    }
+
+    @Test
+    fun settings_config_withSlidingExpirationTypeError_shouldSetTtlToNull() {
+        val json = getJson("ConfigParsing/Settings/SlidingExpirationErrors/SettingsSlidingExpirationTypeError.json")
+        val config = manager.deserializeSettings(json)!!
+
+        assertNotNull("Operations must be successfully parsed", config.operations)
+        assertNotNull(config.operations?.get("viewProduct"))
+        assertNotNull(config.operations?.get("viewCategory"))
+        assertNotNull(config.operations?.get("setCart"))
+
+        assertNotNull("TTL must be successfully parsed", config.ttl)
+        assertNotNull("TTL must be successfully parsed", config.ttl?.inApps)
+
+        assertNull(
+            "SlidingExpiration must be `null` if the type of `config` is not a `slidingExpiration`",
+            config.slidingExpiration,
+        )
+        assertNull("Config session time must be `null`", config.slidingExpiration?.config)
+    }
+
+    @Test
+    fun settings_config_withSlidingExpirationConfigError_shouldSetTtlToNull() {
+        val json = getJson("ConfigParsing/Settings/SlidingExpirationErrors/SettingsSlidingExpirationConfigsError.json")
+        val config = manager.deserializeSettings(json)!!
+
+        assertNotNull("Operations must be successfully parsed", config.operations)
+        assertNotNull(config.operations?.get("viewProduct"))
+        assertNotNull(config.operations?.get("viewCategory"))
+        assertNotNull(config.operations?.get("setCart"))
+
+        assertNotNull("TTL must be successfully parsed", config.ttl)
+        assertNotNull("TTL must be successfully parsed", config.ttl?.inApps)
+
+        assertNull("SlidingExpiration must be `null` if the key `config` is not found", config.slidingExpiration)
+        assertNull("Config session time must be `null`", config.slidingExpiration?.config)
+    }
+
+    @Test
+    fun settings_config_withSlidingExpirationConfigTypeError_shouldSetTtlToNull() {
+        val json = getJson("ConfigParsing/Settings/SlidingExpirationErrors/SettingsSlidingExpirationConfigTypeError.json")
+        val config = manager.deserializeSettings(json)!!
+
+        assertNotNull("Operations must be successfully parsed", config.operations)
+        assertNotNull(config.operations?.get("viewProduct"))
+        assertNotNull(config.operations?.get("viewCategory"))
+        assertNotNull(config.operations?.get("setCart"))
+
+        assertNotNull("TTL must be successfully parsed", config.ttl)
+        assertNotNull("TTL must be successfully parsed", config.ttl?.inApps)
+
+        assertNull("SlidingExpiration must be `null` if the key `config` is not a `String`", config.slidingExpiration)
+        assertNull(
+            "Config session time must be `null` if the key `config` is not a `String`",
+            config.slidingExpiration?.config,
+        )
+    }
 }
diff --git a/sdk/src/test/java/cloud/mindbox/mobile_sdk/models/SettingsStub.kt b/sdk/src/test/java/cloud/mindbox/mobile_sdk/models/SettingsStub.kt
@@ -14,7 +14,7 @@ internal class SettingsStub {
                     operations = emptyMap(),
                     ttl = null,
                     slidingExpiration = SlidingExpirationDto(
-                        inappSession = timeSpan
+                        config = timeSpan
                     )
                 ),
                 abtests = null
diff --git a/sdk/src/test/resources/ConfigParsing/Config/ConfigWithSettingsABTestsMonitoringInapps.json b/sdk/src/test/resources/ConfigParsing/Config/ConfigWithSettingsABTestsMonitoringInapps.json
@@ -324,7 +324,7 @@
       "inapps": "1.00:00:00"
     },
     "slidingExpiration": {
-      "inappSession": "1.00:00:00"
+      "config": "1.00:00:00"
     }
   },
   "abtests": [
diff --git a/sdk/src/test/resources/ConfigParsing/ConfigWithSettingsABTestsMonitoringInapps.json b/sdk/src/test/resources/ConfigParsing/ConfigWithSettingsABTestsMonitoringInapps.json
@@ -322,6 +322,9 @@
     },
     "ttl": {
       "inapps": "1.00:00:00"
+    },
+    "slidingExpiration": {
+      "config": "0.00:30:00"
     }
   },
   "abtests": [
diff --git a/sdk/src/test/resources/ConfigParsing/Settings/SettingsConfig.json b/sdk/src/test/resources/ConfigParsing/Settings/SettingsConfig.json
@@ -12,5 +12,8 @@
   },
   "ttl": {
     "inapps": "1.00:00:00"
+  },
+  "slidingExpiration": {
+    "config": "0.00:30:00"
   }
 }
diff --git a/sdk/src/test/resources/ConfigParsing/Settings/SlidingExpirationErrors/SettingsSlidingExpirationConfigTypeError.json b/sdk/src/test/resources/ConfigParsing/Settings/SlidingExpirationErrors/SettingsSlidingExpirationConfigTypeError.json
@@ -0,0 +1,19 @@
+{
+  "operations": {
+    "viewProduct": {
+      "systemName": "ViewProduct"
+    },
+    "viewCategory": {
+      "systemName": "ViewCategory"
+    },
+    "setCart": {
+      "systemName": "SetCart"
+    }
+  },
+  "ttl": {
+    "inapps": "1.00:00:00"
+  },
+  "slidingExpiration": {
+    "config": 1
+  }
+}
diff --git a/sdk/src/test/resources/ConfigParsing/Settings/SlidingExpirationErrors/SettingsSlidingExpirationConfigsError.json b/sdk/src/test/resources/ConfigParsing/Settings/SlidingExpirationErrors/SettingsSlidingExpirationConfigsError.json
@@ -0,0 +1,19 @@
+{
+  "operations": {
+    "viewProduct": {
+      "systemName": "ViewProduct"
+    },
+    "viewCategory": {
+      "systemName": "ViewCategory"
+    },
+    "setCart": {
+      "systemName": "SetCart"
+    }
+  },
+  "ttl": {
+    "inapps": "1.00:00:00"
+  },
+  "slidingExpiration": {
+    "configTest": "0.00:30:00"
+  }
+}
diff --git a/sdk/src/test/resources/ConfigParsing/Settings/SlidingExpirationErrors/SettingsSlidingExpirationError.json b/sdk/src/test/resources/ConfigParsing/Settings/SlidingExpirationErrors/SettingsSlidingExpirationError.json
@@ -0,0 +1,19 @@
+{
+  "operations": {
+    "viewProduct": {
+      "systemName": "ViewProduct"
+    },
+    "viewCategory": {
+      "systemName": "ViewCategory"
+    },
+    "setCart": {
+      "systemName": "SetCart"
+    }
+  },
+  "ttl": {
+    "inapps": "1.00:00:00"
+  },
+  "slidingExpirationTest": {
+    "config": "0.00:30:00"
+  }
+}
diff --git a/sdk/src/test/resources/ConfigParsing/Settings/SlidingExpirationErrors/SettingsSlidingExpirationTypeError.json b/sdk/src/test/resources/ConfigParsing/Settings/SlidingExpirationErrors/SettingsSlidingExpirationTypeError.json
@@ -0,0 +1,17 @@
+{
+  "operations": {
+    "viewProduct": {
+      "systemName": "ViewProduct"
+    },
+    "viewCategory": {
+      "systemName": "ViewCategory"
+    },
+    "setCart": {
+      "systemName": "SetCart"
+    }
+  },
+  "ttl": {
+    "inapps": "1.00:00:00"
+  },
+  "slidingExpirationTest" : "1.00:00:00"
+}

Original file line number	Diff line number	Diff line change
`@@ -467,7 +467,7 @@ internal class InAppMapper {`
`467`	`467`	`)`
`468`	`468`
`469`	`469`	`fun mapToSlidingExpiration(slidingExpirationDtoBlank: SettingsDtoBlank.SlidingExpirationDtoBlank) = SlidingExpirationDto(`
`470`		`- inappSession = slidingExpirationDtoBlank.inappSession`
	`470`	`+ config = slidingExpirationDtoBlank.config`
`471`	`471`	`)`
`472`	`472`
`473`	`473`	`private fun getTargetingProductSegmentationsList(targeting: TreeTargeting): List<String> {`
Original file line number	Diff line number	Diff line change
`@@ -160,8 +160,8 @@ internal class MobileConfigRepositoryImpl(`
`160`	`160`	`null`
`161`	`161`	`}`
`162`	`162`
`163`		`- val slidingExpiration = runCatching { getInAppSession(configBlank) }.getOrNull {`
`164`		`- mindboxLogW("Unable to get InAppSession settings $it")`
	`163`	`+ val slidingExpiration = runCatching { getConfigSession(configBlank) }.getOrNull {`
	`164`	`+ mindboxLogW("Unable to get slidingExpiration settings $it")`
`165`	`165`	`}`
`166`	`166`
`167`	`167`	`return SettingsDto(operations, ttl, slidingExpiration)`
`@@ -179,15 +179,15 @@ internal class MobileConfigRepositoryImpl(`
`179`	`179`	`null`
`180`	`180`	`}`
`181`	`181`
`182`		`- private fun getInAppSession(configBlank: InAppConfigResponseBlank?): SlidingExpirationDto? =`
	`182`	`+ private fun getConfigSession(configBlank: InAppConfigResponseBlank?): SlidingExpirationDto? =`
`183`	`183`	`try {`
`184`	`184`	`configBlank?.settings?.slidingExpiration?.takeIf { slidingExpirationDtoBlank ->`
`185`	`185`	`slidingExpirationValidator.isValid(slidingExpirationDtoBlank)`
`186`	`186`	`}?.let { slidingExpirationDtoBlank ->`
`187`	`187`	`inAppMapper.mapToSlidingExpiration(slidingExpirationDtoBlank)`
`188`	`188`	`}`
`189`	`189`	`} catch (e: Exception) {`
`190`		`- mindboxLogE("Error parse inappsSession time", e)`
	`190`	`+ mindboxLogE("Error parse config session time", e)`
`191`	`191`	`null`
`192`	`192`	`}`
`193`	`193`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,6 @@ import cloud.mindbox.mobile_sdk.utils.loggingRunCatching`
`7`	`7`	`internal class SlidingExpirationParametersValidator : Validator<SettingsDtoBlank.SlidingExpirationDtoBlank> {`
`8`	`8`	`override fun isValid(item: SettingsDtoBlank.SlidingExpirationDtoBlank): Boolean =`
`9`	`9`	`loggingRunCatching(false) {`
`10`		`- item.inappSession.parseTimeSpanToMillis() > 0`
	`10`	`+ item.config.parseTimeSpanToMillis() > 0`
`11`	`11`	`}`
`12`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,8 +35,8 @@ internal data class SettingsDtoBlank(`
`35`	`35`	`)`
`36`	`36`
`37`	`37`	`internal data class SlidingExpirationDtoBlank(`
`38`		`- @SerializedName("inappSession")`
`39`		`- val inappSession: String`
	`38`	`+ @SerializedName("config")`
	`39`	`+ val config: String`
`40`	`40`	`)`
`41`	`41`	`}`
`42`	`42`
`@@ -60,8 +60,8 @@ internal data class TtlDto(`
`60`	`60`	`)`
`61`	`61`
`62`	`62`	`internal data class SlidingExpirationDto(`
`63`		`- @SerializedName("inappSession")`
`64`		`- val inappSession: String`
	`63`	`+ @SerializedName("config")`
	`64`	`+ val config: String`
`65`	`65`	`)`
`66`	`66`
`67`	`67`	`internal data class LogRequestDto(`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ internal class SettingsStub {`
`14`	`14`	`operations = emptyMap(),`
`15`	`15`	`ttl = null,`
`16`	`16`	`slidingExpiration = SlidingExpirationDto(`
`17`		`- inappSession = timeSpan`
	`17`	`+ config = timeSpan`
`18`	`18`	`)`
`19`	`19`	`),`
`20`	`20`	`abtests = null`
Original file line number	Diff line number	Diff line change
`@@ -324,7 +324,7 @@`
`324`	`324`	`"inapps": "1.00:00:00"`
`325`	`325`	`},`
`326`	`326`	`"slidingExpiration": {`
`327`		`- "inappSession": "1.00:00:00"`
	`327`	`+ "config": "1.00:00:00"`
`328`	`328`	`}`
`329`	`329`	`},`
`330`	`330`	`"abtests": [`
Original file line number	Diff line number	Diff line change
`@@ -12,5 +12,8 @@`
`12`	`12`	`},`
`13`	`13`	`"ttl": {`
`14`	`14`	`"inapps": "1.00:00:00"`
	`15`	`+ },`
	`16`	`+ "slidingExpiration": {`
	`17`	`+ "config": "0.00:30:00"`
`15`	`18`	`}`
`16`	`19`	`}`