Merge pull request #426 from mindbox-cloud/release/2.8.3

AndreyEmtsov · web-flow · commit 0ac87e4653e1 · 2024-01-19T15:36:30.000+07:00
Release/2.8.3
diff --git a/gradle.properties b/gradle.properties
@@ -21,4 +21,4 @@ android.enableJetifier=true
 kotlin.code.style=official
 
 # SDK version property
-SDK_VERSION_NAME=2.8.2
+SDK_VERSION_NAME=2.8.3
diff --git a/mindbox-firebase/src/main/java/cloud/mindbox/mindbox_firebase/MindboxFirebase.kt b/mindbox-firebase/src/main/java/cloud/mindbox/mindbox_firebase/MindboxFirebase.kt
@@ -4,7 +4,10 @@ import cloud.mindbox.mobile_sdk.logger.MindboxLogger
 import cloud.mindbox.mobile_sdk.pushes.MindboxPushService
 import cloud.mindbox.mobile_sdk.pushes.PushServiceHandler
 import cloud.mindbox.mobile_sdk.utils.ExceptionHandler
-
+/**
+ * An object to use when choosing push provider in Mindbox.initPushServices or Mindbox.init.
+ * Represents FCM
+ * */
 object MindboxFirebase : MindboxPushService {
 
     override val tag: String = "FCM"
diff --git a/mindbox-huawei/src/main/java/cloud/mindbox/mindbox_huawei/MindboxHuawei.kt b/mindbox-huawei/src/main/java/cloud/mindbox/mindbox_huawei/MindboxHuawei.kt
@@ -4,7 +4,10 @@ import cloud.mindbox.mobile_sdk.logger.MindboxLogger
 import cloud.mindbox.mobile_sdk.pushes.MindboxPushService
 import cloud.mindbox.mobile_sdk.pushes.PushServiceHandler
 import cloud.mindbox.mobile_sdk.utils.ExceptionHandler
-
+/**
+ * An object to use when choosing push provider in Mindbox.initPushServices or Mindbox.init.
+ * Represents HCM
+ * */
 object MindboxHuawei : MindboxPushService {
 
     override val tag: String = "HCM"
diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/Extensions.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/Extensions.kt
@@ -18,11 +18,14 @@ import androidx.annotation.IdRes
 import cloud.mindbox.mobile_sdk.inapp.domain.models.InAppType
 import cloud.mindbox.mobile_sdk.logger.MindboxLoggerImpl
 import cloud.mindbox.mobile_sdk.utils.LoggingExceptionHandler
+import com.android.volley.VolleyError
+import com.android.volley.toolbox.HttpHeaderParser
 import org.threeten.bp.Instant
 import org.threeten.bp.LocalDateTime
 import org.threeten.bp.ZoneOffset
 import org.threeten.bp.ZonedDateTime
 import org.threeten.bp.format.DateTimeFormatter
+import java.nio.charset.Charset
 import java.util.Queue
 import kotlin.math.roundToInt
 
@@ -182,4 +185,17 @@ internal fun PackageManager.getPackageInfoCompat(context: Context, flags: Int):
     } else {
         getPackageInfo(context.packageName, flags)
     }
+}
+
+internal fun VolleyError.getErrorResponseBodyData(): String {
+    return this.networkResponse?.data
+        ?.takeIf { it.isNotEmpty() }
+        ?.toString(
+            Charset.forName(
+                HttpHeaderParser.parseCharset(
+                    this.networkResponse?.headers ?: emptyMap()
+                )
+            )
+        )
+        ?: ""
 }
diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/InitializeMindboxException.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/InitializeMindboxException.kt
@@ -1,3 +1,5 @@
 package cloud.mindbox.mobile_sdk
-
+/**
+ * An error thrown during initialization in case validation of initialization fails
+ * */
 class InitializeMindboxException(message: String) : Exception(message)
diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/Mindbox.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/Mindbox.kt
@@ -346,6 +346,9 @@ object Mindbox : MindboxLog {
      * Creates and deliveries event of "Push delivered". Recommended call this method from
      * background thread.
      *
+     * Use this method only if you have custom push handling you don't use [Mindbox.handleRemoteMessage].
+     * You must not call it otherwise.
+     *
      * @param context used to initialize the main tools
      * @param uniqKey - unique identifier of push notification
      */
diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/abtests/CustomerAbMixer.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/abtests/CustomerAbMixer.kt
@@ -1,5 +1,5 @@
 package cloud.mindbox.mobile_sdk.abtests
 
-interface CustomerAbMixer {
+internal interface CustomerAbMixer {
     fun stringModulusHash(identifier: String, salt: String): Int
 }
diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/di/Modules.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/di/Modules.kt
diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/inapp/data/validators/JsonValidator.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/inapp/data/validators/JsonValidator.kt
@@ -1,11 +1,14 @@
 package cloud.mindbox.mobile_sdk.inapp.data.validators
 
+import com.google.gson.JsonParser
 
 internal class JsonValidator : Validator<String?> {
 
     override fun isValid(item: String?): Boolean {
         if (item.isNullOrBlank()) return false
-        val jsonRegex = "^\\s*(\\{.*\\}|\\[.*])\\s*$"
-        return item.trim().matches(jsonRegex.toRegex())
+
+        return runCatching {
+            JsonParser.parseString(item).let { it.isJsonObject || it.isJsonArray }
+        }.getOrElse { false }
     }
 }
diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/inapp/domain/InAppChoosingManagerImpl.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/inapp/domain/InAppChoosingManagerImpl.kt
@@ -1,22 +1,29 @@
 package cloud.mindbox.mobile_sdk.inapp.domain
 
+import cloud.mindbox.mobile_sdk.getErrorResponseBodyData
 import cloud.mindbox.mobile_sdk.inapp.domain.interfaces.InAppContentFetcher
 import cloud.mindbox.mobile_sdk.inapp.domain.interfaces.managers.InAppChoosingManager
 import cloud.mindbox.mobile_sdk.inapp.domain.interfaces.repositories.InAppGeoRepository
 import cloud.mindbox.mobile_sdk.inapp.domain.interfaces.repositories.InAppSegmentationRepository
 import cloud.mindbox.mobile_sdk.inapp.domain.models.*
 import cloud.mindbox.mobile_sdk.logger.MindboxLoggerImpl
 import cloud.mindbox.mobile_sdk.logger.mindboxLogD
+import cloud.mindbox.mobile_sdk.logger.mindboxLogI
+import cloud.mindbox.mobile_sdk.logger.mindboxLogW
 import cloud.mindbox.mobile_sdk.models.InAppEventType
+import com.android.volley.VolleyError
 import kotlinx.coroutines.*
 
 internal class InAppChoosingManagerImpl(
     private val inAppGeoRepository: InAppGeoRepository,
     private val inAppSegmentationRepository: InAppSegmentationRepository,
     private val inAppContentFetcher: InAppContentFetcher
-) :
-    InAppChoosingManager {
+) : InAppChoosingManager {
 
+    companion object {
+        private const val RESPONSE_STATUS_CUSTOMER_SEGMENTS_REQUIRE_CUSTOMER =
+            "CheckCustomerSegments requires customer"
+    }
     override suspend fun chooseInAppToShow(
         inApps: List<InApp>,
         triggerEvent: InAppEventType,
@@ -66,11 +73,7 @@ internal class InAppChoosingManagerImpl(
                                 inAppSegmentationRepository.setCustomerSegmentationStatus(
                                     CustomerSegmentationFetchStatus.SEGMENTATION_FETCH_ERROR
                                 )
-                                MindboxLoggerImpl.e(
-                                    this,
-                                    "Error fetching customer segmentations",
-                                    throwable
-                                )
+                                handleCustomerSegmentationErrorLog(throwable)
                             }
 
                             else -> {
@@ -124,6 +127,19 @@ internal class InAppChoosingManagerImpl(
         )
     }
 
+    private fun handleCustomerSegmentationErrorLog(error: CustomerSegmentationError) {
+        val volleyError = error.cause as? VolleyError
+        volleyError?.let { error ->
+            if ((error.networkResponse?.statusCode == 400) && (error.getErrorResponseBodyData()
+                    .contains(RESPONSE_STATUS_CUSTOMER_SEGMENTS_REQUIRE_CUSTOMER))
+            ) {
+                mindboxLogI("Cannot check customer segment. It's a new customer")
+                return
+            }
+        }
+        mindboxLogW("Error fetching customer segmentations", error)
+    }
+
     private class TargetingDataWrapper(
         override val triggerEventName: String,
         override val operationBody: String? = null,
diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/inapp/domain/models/InAppDataError.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/inapp/domain/models/InAppDataError.kt
@@ -11,4 +11,4 @@ internal class GeoError(volleyError: VolleyError) : Exception(volleyError)
 internal class ProductSegmentationError(volleyError: VolleyError) :
     Exception(volleyError)
 
-internal class InAppContentFetchingError(error: GlideException?) : Exception(error)
+internal class InAppContentFetchingError(error: GlideException?) : Exception(error)
diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/logger/MindboxLoggerImpl.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/logger/MindboxLoggerImpl.kt
@@ -8,7 +8,9 @@ import cloud.mindbox.mobile_sdk.monitoring.domain.interfaces.MonitoringRepositor
 import com.android.volley.VolleyLog
 import kotlinx.coroutines.*
 import org.threeten.bp.Instant
-
+/**
+ * An interface for internal sdk work only. Do not implement or use it.
+ * */
 interface MindboxLogger {
 
     fun i(parent: Any, message: String)
diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/managers/GatewayManager.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/managers/GatewayManager.kt
@@ -16,7 +16,6 @@ import com.android.volley.DefaultRetryPolicy
 import com.android.volley.DefaultRetryPolicy.DEFAULT_BACKOFF_MULT
 import com.android.volley.Request
 import com.android.volley.VolleyError
-import com.android.volley.toolbox.StringRequest
 import com.google.gson.Gson
 import kotlinx.coroutines.*
 import org.json.JSONException
@@ -409,17 +408,18 @@ internal class GatewayManager(private val mindboxServiceGenerator: MindboxServic
         }
     }
 
-
     suspend fun fetchMobileConfig(configuration: Configuration): String {
         return suspendCoroutine { continuation ->
             mindboxServiceGenerator.addToRequestQueue(
-                StringRequest(
-                    Request.Method.GET,
-                    getConfigUrl(configuration),
-                    { response ->
-                        continuation.resume(response)
+                MindboxRequest(
+                    methodType = Request.Method.GET,
+                    fullUrl = getConfigUrl(configuration),
+                    configuration = configuration,
+                    jsonRequest = null,
+                    listener = { response ->
+                        continuation.resume(response.toString())
                     },
-                    { error ->
+                    errorsListener = { error ->
                         continuation.resumeWithException(error)
                     },
                 )
diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/models/MindboxError.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/models/MindboxError.kt
@@ -2,7 +2,10 @@ package cloud.mindbox.mobile_sdk.models
 
 import com.google.gson.Gson
 import com.google.gson.annotations.JsonAdapter
-
+/**
+ * A class for representing Mindbox error.
+ * Used in operations.
+ * */
 sealed class MindboxError(open val statusCode: Int?) {
 
     companion object {
diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/models/MindboxErrorAdapter.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/models/MindboxErrorAdapter.kt
@@ -8,7 +8,7 @@ import com.google.gson.stream.JsonReader
 import com.google.gson.stream.JsonToken
 import com.google.gson.stream.JsonWriter
 
-class MindboxErrorAdapter : TypeAdapter<MindboxError?>() {
+internal class MindboxErrorAdapter : TypeAdapter<MindboxError?>() {
 
     private val gson by lazy { Gson() }
 
diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/models/Requests.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/models/Requests.kt
@@ -2,7 +2,9 @@ package cloud.mindbox.mobile_sdk.models
 
 import android.os.Build
 import cloud.mindbox.mobile_sdk.BuildConfig
-import cloud.mindbox.mobile_sdk.logger.MindboxLoggerImpl
+import cloud.mindbox.mobile_sdk.getErrorResponseBodyData
+import cloud.mindbox.mobile_sdk.logger.mindboxLogI
+import cloud.mindbox.mobile_sdk.logger.mindboxLogW
 import cloud.mindbox.mobile_sdk.utils.LoggingExceptionHandler
 import com.android.volley.NetworkResponse
 import com.android.volley.ParseError
@@ -108,25 +110,16 @@ internal data class MindboxRequest(
     //Logging error responses
     override fun parseNetworkError(volleyError: VolleyError): VolleyError {
         LoggingExceptionHandler.runCatching {
-            MindboxLoggerImpl.e(
-                this,
-                "<--- Error ${volleyError.networkResponse?.statusCode} $fullUrl TimeMls:${volleyError.networkTimeMs}; ",
-            )
             try {
-                volleyError.networkResponse?.allHeaders?.joinToString (
+                val json = volleyError.getErrorResponseBodyData()
+
+                logResponseResult(volleyError, json)
+
+                volleyError.networkResponse?.allHeaders?.joinToString(
                     separator = System.getProperty("line.separator") ?: "\n"
                 ) { header ->
                     "${header.name}: ${header.value}"
-                }?.let { MindboxLoggerImpl.d(this, it) }
-
-                val json = String(
-                    volleyError.networkResponse?.data ?: ByteArray(0),
-                    Charset.forName(
-                        HttpHeaderParser.parseCharset(
-                            volleyError.networkResponse?.headers ?: emptyMap()
-                        )
-                    )
-                )
+                }?.let { mindboxLogI(it) }
 
                 logBodyResponse(json)
             } catch (e: Exception) {
@@ -142,32 +135,47 @@ internal data class MindboxRequest(
 
     private fun logResponse(response: NetworkResponse?) {
         LoggingExceptionHandler.runCatching {
-            MindboxLoggerImpl.d(this, "<--- ${response?.statusCode} $fullUrl")
+            mindboxLogI("<--- ${response?.statusCode} $fullUrl")
 
-            response?.allHeaders?.joinToString (
+            response?.allHeaders?.joinToString(
                 separator = System.getProperty("line.separator") ?: "\n"
             ) { header ->
                 "${header.name}: ${header.value}"
-            }?.let { MindboxLoggerImpl.d(this, it) }
+            }?.let { mindboxLogI(it) }
         }
     }
 
     private fun logBodyResponse(json: String?) {
         LoggingExceptionHandler.runCatching {
-            MindboxLoggerImpl.d(this, "$json")
+            mindboxLogI("$json")
         }
     }
 
     private fun logError(e: Exception) {
         LoggingExceptionHandler.runCatching {
-            MindboxLoggerImpl.d(this, e.message ?: "Empty message")
-            MindboxLoggerImpl.d(this, e.stackTraceToString())
+            mindboxLogW(e.message ?: "Empty message")
+            mindboxLogW(e.stackTraceToString())
         }
     }
 
     private fun logEndResponse() {
         LoggingExceptionHandler.runCatching {
-            MindboxLoggerImpl.d(this, "<--- End of response")
+            mindboxLogI("<--- End of response")
+        }
+    }
+
+    private fun logResponseResult(volleyError: VolleyError?, json: String?) {
+        LoggingExceptionHandler.runCatching {
+            val logMessage = buildString {
+                append("<--- ")
+                append(if (json?.contains("\"status\": \"Success\"") == true) "Success" else "Error")
+                append(" ${volleyError?.networkResponse?.statusCode} $fullUrl TimeMls:${volleyError?.networkTimeMs}; ")
+            }
+            if (json?.contains("{\"status\": \"Success\"}") == true) {
+                mindboxLogI(logMessage)
+            } else {
+                mindboxLogW(logMessage)
+            }
         }
     }
 
diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/models/ValidationMessage.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/models/ValidationMessage.kt
@@ -1,7 +1,9 @@
 package cloud.mindbox.mobile_sdk.models
 
 import com.google.gson.annotations.SerializedName
-
+/**
+ * A class to hold validation message if validation error occurs
+ * */
 data class ValidationMessage(
     @SerializedName("message") val message: String? = null,
     @SerializedName("location") val location: String? = null,
diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/network/MindboxServiceGenerator.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/network/MindboxServiceGenerator.kt
@@ -7,7 +7,6 @@ import cloud.mindbox.mobile_sdk.models.MindboxRequest
 import cloud.mindbox.mobile_sdk.utils.LoggingExceptionHandler
 import com.android.volley.RequestQueue
 import com.android.volley.VolleyLog
-import com.android.volley.toolbox.StringRequest
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.suspendCancellableCoroutine
 
@@ -29,11 +28,6 @@ internal class MindboxServiceGenerator(private val requestQueue: RequestQueue) {
             }
         }
 
-    internal fun addToRequestQueue(request: StringRequest) {
-        requestQueue.add(request)
-        // TODO change StringRequest to MindboxRequest or log here
-    }
-
     internal fun addToRequestQueue(request: MindboxRequest) = LoggingExceptionHandler.runCatching {
         requestQueue.let { requestQueue ->
             requestQueue.add(request)
diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/pushes/MindboxPushService.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/pushes/MindboxPushService.kt
@@ -2,7 +2,9 @@ package cloud.mindbox.mobile_sdk.pushes
 
 import cloud.mindbox.mobile_sdk.logger.MindboxLogger
 import cloud.mindbox.mobile_sdk.utils.ExceptionHandler
-
+/**
+ * An interface for internal sdk work only. Do not implement it
+ * */
 interface MindboxPushService {
 
     val tag: String
diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/pushes/PushAction.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/pushes/PushAction.kt
@@ -1,7 +1,11 @@
 package cloud.mindbox.mobile_sdk.pushes
 
 import com.google.gson.annotations.SerializedName
-
+/**
+ * A class representing mindbox push action in [RemoteMessage]
+ *  * You can use it as a model to store data from mindbox
+ *  * with your custom push notification implementation.
+ * */
 data class PushAction(
     @SerializedName("uniqueKey") val uniqueKey: String?,
     @SerializedName("text") val text: String?,
diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/pushes/PushServiceHandler.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/pushes/PushServiceHandler.kt
diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/pushes/RemoteMessage.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/pushes/RemoteMessage.kt
diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/utils/ExceptionHandler.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/utils/ExceptionHandler.kt
diff --git a/sdk/src/test/java/cloud/mindbox/mobile_sdk/ExtensionsTest.kt b/sdk/src/test/java/cloud/mindbox/mobile_sdk/ExtensionsTest.kt
diff --git a/sdk/src/test/java/cloud/mindbox/mobile_sdk/inapp/data/validators/JsonValidatorTest.kt b/sdk/src/test/java/cloud/mindbox/mobile_sdk/inapp/data/validators/JsonValidatorTest.kt
diff --git a/sdk/src/test/java/cloud/mindbox/mobile_sdk/inapp/data/validators/XmlValidatorTest.kt b/sdk/src/test/java/cloud/mindbox/mobile_sdk/inapp/data/validators/XmlValidatorTest.kt

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`package cloud.mindbox.mobile_sdk.abtests`
`2`	`2`
`3`		`-interface CustomerAbMixer {`
	`3`	`+internal interface CustomerAbMixer {`
`4`	`4`	`fun stringModulusHash(identifier: String, salt: String): Int`
`5`	`5`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,11 +1,14 @@`
`1`	`1`	`package cloud.mindbox.mobile_sdk.inapp.data.validators`
`2`	`2`
	`3`	`+import com.google.gson.JsonParser`
`3`	`4`
`4`	`5`	`internal class JsonValidator : Validator<String?> {`
`5`	`6`
`6`	`7`	`override fun isValid(item: String?): Boolean {`
`7`	`8`	`if (item.isNullOrBlank()) return false`
`8`		`- val jsonRegex = "^\\s(\\{.\\}\|\\[.])\\s$"`
`9`		`- return item.trim().matches(jsonRegex.toRegex())`
	`9`	`+`
	`10`	`+ return runCatching {`
	`11`	`+ JsonParser.parseString(item).let { it.isJsonObject \|\| it.isJsonArray }`
	`12`	`+ }.getOrElse { false }`
`10`	`13`	`}`
`11`	`14`	`}`