feat: Add optional context to logEvent request

BREAKING CHANGE: The logEvent SDK handler now includes an optional context.

Author: talipatpace

docs/index.md

@@ -23,6 +23,7 @@ This framework combines multipe functionalities provided by PACE i.e. authorizin
         + [20.x.x -> 21.x.x](#from-20xx-to-21xx)
         + [21.x.x -> 22.x.x](#from-21xx-to-22xx)
         + [22.x.x -> 23.x.x](#from-22xx-to-23xx)
+        + [23.x.x -> 24.x.x](#from-23xx-to-24xx)
 
 ## Documentation
 The full documentation and instructions on how to integrate PACE Cloud SDK can be found [here](https://docs.pace.cloud/en/integrating/mobile-app)
@@ -182,6 +183,9 @@ The `GasStations` properties `paymentMethods`, `amenities`, `foods`, `loyaltyPro
   - If you use the `appDrawer` modifier in your custom `AppDrawer` UI, you need to move the `onClick` function to its content, e.g. to the `AppDrawerContent`.
   - You can use the newly introduced `AppDrawerColumn` as a wrapper around your content so that the swipe gestures are handled for you.
 
+### From 23.x.x to 24.x.x
+- The `logEvent` SDK handler now includes an optional `context`. This context is to be used to provide a context in which the event is logged and must not be forwarded to the analytics backend.
+
 ## SDK API Docs
 
 Here is a complete list of all our SDK API documentations:

library/src/main/java/cloud/pace/sdk/appkit/app/webview/AppWebViewModel.kt

@@ -640,7 +640,7 @@ class AppWebViewModelImpl(
             LogEventResult(LogEventResult.Failure(LogEventResult.Failure.StatusCode.InternalServerError, LogEventError("An error occurred")))
 
         ) {
-            appModel.logEvent(logEventRequest.key, logEventRequest.parameters ?: emptyMap())
+            appModel.logEvent(logEventRequest.key, logEventRequest.parameters ?: emptyMap(), logEventRequest.context)
             LogEventResult(LogEventResult.Success())
         }
     }

library/src/main/java/cloud/pace/sdk/appkit/communication/AppCallback.kt

@@ -132,8 +132,9 @@ interface AppCallback {
      *
      * @param key The event key
      * @param parameters Optional parameters to be logged
+     * @param context Optional context in which the event is logged. These must not be logged.
      */
-    fun logEvent(key: String, parameters: Map<String, Any>)
+    fun logEvent(key: String, parameters: Map<String, Any>, context: Map<String, Any>?)
 
     /**
      * Is called when the app requests a configuration.
@@ -232,7 +233,7 @@ abstract class AppCallbackImpl : AppCallback, CloudSDKKoinComponent {
     }
 
     override fun setUserProperty(key: String, value: String, update: Boolean) {}
-    override fun logEvent(key: String, parameters: Map<String, Any>) {}
+    override fun logEvent(key: String, parameters: Map<String, Any>, context: Map<String, Any>?) {}
     override fun getConfig(key: String, config: (String?) -> Unit) {
         config(null)
     }

library/src/main/java/cloud/pace/sdk/appkit/communication/AppModel.kt

@@ -66,7 +66,7 @@ interface AppModel {
     fun onFileDataReceived(fileData: ByteArray)
     fun onShareTextReceived(text: String, title: String)
     fun setUserProperty(key: String, value: String, update: Boolean)
-    fun logEvent(key: String, parameters: Map<String, Any>)
+    fun logEvent(key: String, parameters: Map<String, Any>, context: Map<String, Any>?)
     fun getConfig(key: String, config: (String?) -> Unit)
     fun isAppRedirectAllowed(app: String, isAllowed: (Boolean) -> Unit)
     fun isSignedIn(isSignedIn: (Boolean) -> Unit)
@@ -340,9 +340,9 @@ class AppModelImpl(
         }
     }
 
-    override fun logEvent(key: String, parameters: Map<String, Any>) {
+    override fun logEvent(key: String, parameters: Map<String, Any>, context: Map<String, Any>?) {
         coroutineScope.launch {
-            callback?.logEvent(key, parameters)
+            callback?.logEvent(key, parameters, context)
         }
     }
 

library/src/main/java/cloud/pace/sdk/appkit/communication/generated/model/request/LogEventRequest.kt

@@ -14,5 +14,9 @@ public data class LogEventRequest(
     /**
      * Dictionary of additional event parameters
      */
-    public val parameters: Map<String, Any>?
+    public val parameters: Map<String, Any>?,
+    /**
+     * Provide additional context for the SDK which will not be logged
+     */
+    public val context: Map<String, Any>?
 )

library/src/test/java/cloud/pace/sdk/appkit/AppWebViewModelTest.kt

@@ -328,9 +328,9 @@ class AppWebViewModelTest {
         val key = "foo"
         val parameters = mapOf("string" to "value", "number" to 1.0, "boolean" to true, "list" to listOf("element1", 3.0, false))
 
-        val result = viewModel.logEvent(5000, LogEventRequest(key, parameters))
+        val result = viewModel.logEvent(5000, LogEventRequest(key, parameters, null))
 
-        verify(appCallback, times(1)).logEvent(key, parameters)
+        verify(appCallback, times(1)).logEvent(key, parameters, null)
         assertEquals(204, result.status)
         assertNull(result.body)
     }