v1.0.2

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.0.2
+
+* Added feature to customize HTTP requests
+
 ## 1.0.1
 * PianoConsents has been moved to the piano_consents package
 * Added feature to specify property type via forceType argument

README.md

@@ -42,7 +42,9 @@ Initialize PianoAnalytics with your site and collect domain in your application
       storageLifetimeVisitor: 395,
       visitorStorageMode: VisitorStorageMode.fixed,
       ignoreLimitedAdvertisingTracking: true,
-      visitorId: "WEB-192203AJ"
+      visitorId: "WEB-192203AJ",
+      headers: {"X-Request-Id": "123456789"},
+      query: {"request_id": "123456789"}
     );
 
     @override
@@ -59,6 +61,18 @@ Initialize PianoAnalytics with your site and collect domain in your application
   }
   ```
 
+### Set HTTP parameters
+
+Headers:
+```dart
+await _pianoAnalytics.setHeader(key: "X-User-Id", value: "WEB-192203AJ")
+```
+
+Query string parameters:
+```dart
+await _pianoAnalytics.setQuery(key: "user_id", value: "WEB-192203AJ")
+```
+
 ### Send events
   ```dart
   await _pianoAnalytics.sendEvents(events: [

android/.gitignore

@@ -8,3 +8,5 @@ gradle
 /build
 /captures
 .cxx
+
+property*

android/build.gradle

@@ -1,15 +1,15 @@
 group = "io.piano.flutter.piano_analytics"
-version = "1.0.1"
+version = "1.0.2"
 
 buildscript {
-    ext.kotlin_version = "1.9.0"
+    ext.kotlin_version = "2.1.0"
     repositories {
         google()
         mavenCentral()
     }
 
     dependencies {
-        classpath("com.android.tools.build:gradle:7.3.0")
+        classpath("com.android.tools.build:gradle:8.7.3")
         classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version")
     }
 }
@@ -25,7 +25,7 @@ apply plugin: "com.android.library"
 apply plugin: "kotlin-android"
 
 dependencies {
-    api("io.piano.android:analytics:3.4.1")
+    api("io.piano.android:analytics:3.5.0")
 }
 
 android {
@@ -36,12 +36,12 @@ android {
     compileSdk = 34
 
     compileOptions {
-        sourceCompatibility = JavaVersion.VERSION_1_8
-        targetCompatibility = JavaVersion.VERSION_1_8
+        sourceCompatibility = JavaVersion.VERSION_11
+        targetCompatibility = JavaVersion.VERSION_11
     }
 
     kotlinOptions {
-        jvmTarget = JavaVersion.VERSION_1_8
+        jvmTarget = JavaVersion.VERSION_11
     }
 
     sourceSets {

android/src/main/kotlin/io/piano/flutter/piano_analytics/PianoAnalyticsPlugin.kt

@@ -11,6 +11,7 @@ import io.flutter.plugin.common.MethodChannel.Result
 import io.flutter.plugin.common.StandardMessageCodec
 import io.flutter.plugin.common.StandardMethodCodec
 import io.piano.android.analytics.Configuration
+import io.piano.android.analytics.CustomHttpDataProvider
 import io.piano.android.analytics.PianoAnalytics
 import io.piano.android.analytics.model.Event
 import io.piano.android.analytics.model.PrivacyMode
@@ -37,7 +38,18 @@ private class Codec : StandardMessageCodec() {
     }
 }
 
-class PianoAnalyticsPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
+class HttpDataProvider : CustomHttpDataProvider {
+
+    val headers = mutableMapOf<String, String>()
+    var parameters = mutableMapOf<String, String>()
+
+    override fun headers() = headers
+    override fun parameters() = parameters
+}
+
+class PianoAnalyticsPlugin(
+    private val httpDataProvider: HttpDataProvider = HttpDataProvider()
+) : FlutterPlugin, MethodCallHandler, ActivityAware {
 
     private lateinit var channel: MethodChannel
     private lateinit var visitorIDType: VisitorIDType
@@ -78,6 +90,8 @@ class PianoAnalyticsPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
             val methodResult: Any? = when (call.method) {
                 // Main
                 "init" -> handleInit(call)
+                "setHeader" -> handleSetHeader(call)
+                "setQuery" -> handleSetQuery(call)
                 "send" -> handleSend(call)
                 // User
                 "getUser" -> handleGetUser()
@@ -103,6 +117,12 @@ class PianoAnalyticsPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
 
     private fun handleInit(call: MethodCall) {
         visitorIDType = getVisitorIDType(call.arg("visitorIDType"))
+        call.argument<Map<String, String>>("headers")?.let {
+            httpDataProvider.headers.putAll(it)
+        }
+        call.argument<Map<String, String>>("query")?.let {
+            httpDataProvider.parameters.putAll(it)
+        }
         val pianoAnalytics = PianoAnalytics.init(
             context = context.get() ?: error("Activity not attached"),
             configuration = Configuration.Builder(
@@ -113,9 +133,10 @@ class PianoAnalyticsPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
                     ?: Configuration.DEFAULT_VISITOR_STORAGE_LIFETIME,
                 visitorStorageMode = getVisitorStorageMode(call.argument("visitorStorageMode")),
                 ignoreLimitedAdTracking = call.argument<Boolean>("ignoreLimitedAdvertisingTracking")
-                    ?: false
+                    ?: false,
             ).build(),
-            pianoConsents = getPianoConsents()
+            pianoConsents = getPianoConsents(),
+            customHttpDataProvider = httpDataProvider
         )
 
         if (visitorIDType == VisitorIDType.CUSTOM) {
@@ -125,6 +146,24 @@ class PianoAnalyticsPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
         }
     }
 
+    private fun handleSetHeader(call: MethodCall) {
+        val value = call.argument<String>("value")
+        if (value != null) {
+            httpDataProvider.headers[call.arg("key")] = value
+        } else {
+            httpDataProvider.headers.remove(call.arg("key"))
+        }
+    }
+
+    private fun handleSetQuery(call: MethodCall) {
+        val value = call.argument<String>("value")
+        if (value != null) {
+            httpDataProvider.parameters[call.arg("key")] = value
+        } else {
+            httpDataProvider.parameters.remove(call.arg("key"))
+        }
+    }
+
     private fun handleSend(call: MethodCall) {
         val events = call.arg<List<Map<String, Any>>>("events").map {
             val name = it["name"] as? String ?: error("Undefined event name")

android/src/test/kotlin/io/piano/flutter/piano_analytics/PianoAnalyticsPluginTest.kt

@@ -20,6 +20,7 @@ import java.util.Date
 import kotlin.test.BeforeTest
 import kotlin.test.Test
 import kotlin.test.assertEquals
+import kotlin.test.assertNull
 
 internal class PianoAnalyticsPluginTest : BasePluginTest() {
 
@@ -31,25 +32,30 @@ internal class PianoAnalyticsPluginTest : BasePluginTest() {
     @Test
     fun `Check init`() {
         val pianoAnalytics: PianoAnalytics = mockk()
-        every { PianoAnalytics.Companion.init(any(), any(), any(), any()) } returns pianoAnalytics
+        every { PianoAnalytics.Companion.init(any(), any(), any(), any(), any()) } returns pianoAnalytics
 
         val customVisitorIdSlot = slot<String>()
         every { pianoAnalytics.customVisitorId = capture(customVisitorIdSlot) } answers {}
 
+        val httpDataProvider = HttpDataProvider()
         call(
-            "init", mapOf(
+            "init",
+            mapOf(
                 "site" to 123456789,
                 "collectDomain" to "xxxxxxx.pa-cd.com",
                 "visitorIDType" to "CUSTOM",
                 "visitorStorageLifetime" to 395,
                 "visitorStorageMode" to "fixed",
                 "ignoreLimitedAdvertisingTracking" to true,
-                "visitorId" to "WEB-192203AJ"
-            )
-        )
+                "visitorId" to "WEB-192203AJ",
+                "headers" to mapOf("X-Request-ID" to "123456789"),
+                "query" to mapOf("request_id" to "123456789")
+            ),
+            null
+        ) { PianoAnalyticsPlugin(httpDataProvider) }
 
         val slot = slot<Configuration>()
-        verify { PianoAnalytics.init(any(), capture(slot), any(), any()) }
+        verify { PianoAnalytics.init(any(), capture(slot), any(), any(), any()) }
 
         val configuration = slot.captured
         assertEquals(123456789, configuration.site)
@@ -58,7 +64,8 @@ internal class PianoAnalyticsPluginTest : BasePluginTest() {
         assertEquals(395, configuration.visitorStorageLifetime)
         assertEquals(VisitorStorageMode.FIXED, configuration.visitorStorageMode)
         assertEquals(true, configuration.ignoreLimitedAdTracking)
-        assertEquals("WEB-192203AJ", customVisitorIdSlot.captured)
+        assertEquals("123456789", httpDataProvider.headers["X-Request-ID"])
+        assertEquals("123456789", httpDataProvider.parameters["request_id"])
     }
 
     @Test
@@ -155,6 +162,56 @@ internal class PianoAnalyticsPluginTest : BasePluginTest() {
         )
     }
 
+    @Test
+    fun `Check setHeader`() {
+        val  httpDataProvider = HttpDataProvider()
+        call(
+            "setHeader",
+            mapOf(
+                "key" to "X-User-Id",
+                "value" to "WEB-192203AJ"
+            ),
+            null
+        ) { PianoAnalyticsPlugin(httpDataProvider) }
+
+        assertEquals("WEB-192203AJ", httpDataProvider.headers["X-User-Id"])
+
+        call(
+            "setHeader",
+            mapOf(
+                "key" to "X-User-Id"
+            ),
+            null
+        ) { PianoAnalyticsPlugin(httpDataProvider) }
+
+        assertNull(httpDataProvider.headers["X-User-Id"])
+    }
+
+    @Test
+    fun `Check setQuery`() {
+        val  httpDataProvider = HttpDataProvider()
+        call(
+            "setQuery",
+            mapOf(
+                "key" to "user_id",
+                "value" to "WEB-192203AJ"
+            ),
+            null
+        ) { PianoAnalyticsPlugin(httpDataProvider) }
+
+        assertEquals("WEB-192203AJ", httpDataProvider.parameters["user_id"])
+
+        call(
+            "setQuery",
+            mapOf(
+                "key" to "user_id"
+            ),
+            null
+        ) { PianoAnalyticsPlugin(httpDataProvider) }
+
+        assertNull(httpDataProvider.parameters["user_id"])
+    }
+
     @Test
     fun `Check getUser`() {
         val pianoAnalytics: PianoAnalytics = mockk()
@@ -210,7 +267,7 @@ internal class PianoAnalyticsPluginTest : BasePluginTest() {
 
     @Test
     fun `Check getVisitorId`() {
-        every { PianoAnalytics.Companion.init(any(), any(), any(), any()) } returns mockk()
+        every { PianoAnalytics.Companion.init(any(), any(), any(), any(), any()) } returns mockk()
 
         val pianoAnalytics: PianoAnalytics = mockk()
         every { PianoAnalytics.Companion.getInstance() } returns pianoAnalytics

example/.gitignore

@@ -5,9 +5,11 @@
 *.swp
 .DS_Store
 .atom/
+.build/
 .buildlog/
 .history
 .svn/
+.swiftpm/
 migrate_working_dir/
 
 # IntelliJ related

example/android/.gitignore

@@ -12,3 +12,6 @@ GeneratedPluginRegistrant.java
 key.properties
 **/*.keystore
 **/*.jks
+
+app/property*
+app/.cxx

example/android/app/build.gradle

@@ -26,11 +26,15 @@ if (flutterVersionName == null) {
 android {
     namespace = "io.piano.piano_analytics_example"
     compileSdk = flutter.compileSdkVersion
-    ndkVersion = flutter.ndkVersion
+
 
     compileOptions {
-        sourceCompatibility = JavaVersion.VERSION_1_8
-        targetCompatibility = JavaVersion.VERSION_1_8
+        sourceCompatibility = JavaVersion.VERSION_11
+        targetCompatibility = JavaVersion.VERSION_11
+    }
+
+    kotlinOptions {
+        jvmTarget = JavaVersion.VERSION_11
     }
 
     defaultConfig {
@@ -55,4 +59,4 @@ android {
 
 flutter {
     source = "../.."
-}
+}

example/android/build.gradle

@@ -7,7 +7,7 @@ allprojects {
 
 rootProject.layout.buildDirectory = "../build"
 subprojects {
-    project.layout.buildDirectory = "${rootProject.buildDir}/${project.name}"
+    project.layout.buildDirectory = "${rootProject.layout.buildDirectory.get()}/${project.name}"
 }
 subprojects {
     project.evaluationDependsOn(":app")

example/android/settings.gradle

@@ -18,8 +18,8 @@ pluginManagement {
 
 plugins {
     id "dev.flutter.flutter-plugin-loader" version "1.0.0"
-    id "com.android.application" version '7.4.2' apply false
-    id "org.jetbrains.kotlin.android" version "1.9.0" apply false
+    id "com.android.application" version '8.7.3' apply false
+    id "org.jetbrains.kotlin.android" version "2.1.0" apply false
 }
 
 include ":app"

example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme

@@ -59,6 +59,7 @@
       ignoresPersistentStateOnLaunch = "NO"
       debugDocumentVersioning = "YES"
       debugServiceExtension = "internal"
+      enableGPUValidationMode = "1"
       allowLocationSimulation = "YES">
       <BuildableProductRunnable
          runnableDebuggingMode = "0">