Merge remote-tracking branch 'origin/main' into feat/default-prefix

# Conflicts:
#	README.md
#	lib/src/test/java/com/telemetrydeck/sdk/TelemetryDeckTests.kt

Author: kkostov

.github/workflows/publish.yml

@@ -1,33 +1,33 @@
-name: Publish to Maven Central
-
-on:
-  push:
-    tags:
-      - "[0-9]+.[0-9]+.[0-9]+*"
-
-jobs:
-  publish:
-    name: Publish to Sonatype
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Configure JDK
-        uses: actions/setup-java@v4
-        with:
-          distribution: 'temurin'
-          java-version: '17'
-
-      - name: Setup Gradle
-        uses: gradle/actions/setup-gradle@v4
-
-      - name: Upload Artifacts
-        # gradle.properties must be set with SONATYPE_HOST=CENTRAL_PORTAL and RELEASE_SIGNING_ENABLED=true
-        run: ./gradlew publishAndReleaseToMavenCentral --no-configuration-cache
-        env:
-          ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.ORG_GRADLE_PROJECT_mavenCentralUsername }}
-          ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.ORG_GRADLE_PROJECT_mavenCentralPassword }}
-          ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.ORG_GRADLE_PROJECT_signingInMemoryKey }}
-          ORG_GRADLE_PROJECT_signingInMemoryKeyId: ${{ secrets.ORG_GRADLE_PROJECT_signingInMemoryKeyId }}
-          ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.ORG_GRADLE_PROJECT_signingInMemoryKeyPassword }}
+#name: Publish to Maven Central
+#
+#on:
+#  push:
+#    tags:
+#      - "[0-9]+.[0-9]+.[0-9]+*"
+#
+#jobs:
+#  publish:
+#    name: Publish to Sonatype
+#    runs-on: ubuntu-latest
+#    steps:
+#      - name: Checkout
+#        uses: actions/checkout@v4
+#
+#      - name: Configure JDK
+#        uses: actions/setup-java@v4
+#        with:
+#          distribution: 'temurin'
+#          java-version: '17'
+#
+#      - name: Setup Gradle
+#        uses: gradle/actions/setup-gradle@v4
+#
+#      - name: Upload Artifacts
+#        # gradle.properties must be set with SONATYPE_HOST=CENTRAL_PORTAL and RELEASE_SIGNING_ENABLED=true
+#        run: ./gradlew publishAndReleaseToMavenCentral --no-configuration-cache
+#        env:
+#          ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.ORG_GRADLE_PROJECT_mavenCentralUsername }}
+#          ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.ORG_GRADLE_PROJECT_mavenCentralPassword }}
+#          ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.ORG_GRADLE_PROJECT_signingInMemoryKey }}
+#          ORG_GRADLE_PROJECT_signingInMemoryKeyId: ${{ secrets.ORG_GRADLE_PROJECT_signingInMemoryKeyId }}
+#          ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.ORG_GRADLE_PROJECT_signingInMemoryKeyPassword }}

README.md

@@ -10,7 +10,7 @@ The Kotlin SDK for TelemetryDeck is available from Maven Central and can be used
 
 ```groovy
 dependencies {
-    implementation 'com.telemetrydeck:kotlin-sdk:4.0.2'
+    implementation 'com.telemetrydeck:kotlin-sdk:4.0.5'
 }
 ```
 
@@ -148,6 +148,21 @@ By default, Kotlin SDK for TelemetryDeck will include the following environment
 
 See [Custom Telemetry](#custom-telemetry) on how to implement your own parameter enrichment.
 
+## Default Parameters
+
+If there are parameters you would like to include with every outgoing signal, you can use `DefaultParameterProvider` instead of passing them with every call.
+
+```kotlin
+// create an instance of [DefaultParameterProvider] and pass the key value you wish to be appended to every signal
+val provider = DefaultParameterProvider(mapOf("key" to "value"))
+
+// add the provider when configuring an instance of TelemetryDeck
+
+val builder = TelemetryDeck.Builder()
+    .appID("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")
+    .addProvider(provider)
+```
+
 ## Default prefix
 
 If you find yourself prepending the same prefix for to your custom signals or parameters, 
@@ -167,7 +182,7 @@ val builder = TelemetryDeck.Builder()
 
 ## Custom Telemetry
 
-Another way to send signals is to register a custom `TelemetryDeckProvider`.
+Another way to send signals is to implement a custom `TelemetryDeckProvider`.
 A provider uses the TelemetryDeck client in order to queue or send signals based on environment or other triggers.
 
 

build.gradle.kts

@@ -2,6 +2,5 @@ plugins {
     alias(libs.plugins.androidLibrary) apply false
     alias(libs.plugins.kotlin.android) apply false
     alias(libs.plugins.kotlin.serialization) apply false
-    alias(libs.plugins.kotlin.compose) apply false
     alias(libs.plugins.vanniktech.publish) apply false
 }

gradle/libs.versions.toml

@@ -1,16 +1,16 @@
 [versions]
-agp = "8.7.3"
+agp = "8.8.0"
 kotlin = "2.0.20"
-coreKtx = "1.13.1"
+coreKtx = "1.15.0"
 junit = "4.13.2"
 junitVersion = "1.2.1"
 espressoCore = "3.6.1"
 lifecycleRuntimeKtx = "2.8.7"
-activityCompose = "1.9.3"
-composeBom = "2024.10.00"
+activityCompose = "1.10.0"
+composeBom = "2024.04.01"
 ktor = "3.0.2"
 kotlinx = "1.7.3"
-coroutines = "1.9.0"
+coroutines = "1.10.1"
 vanniktech-publish = "0.30.0"
 appcompat = "1.7.0"
 mockk = "1.13.13"
@@ -48,5 +48,4 @@ mockk-android = {group = "io.mockk", name = "mockk-android", version.ref = "mock
 androidLibrary = { id = "com.android.library", version.ref = "agp" }
 kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" }
 kotlin-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" }
-vanniktech-publish = { id = "com.vanniktech.maven.publish", version.ref = "vanniktech-publish" }
-kotlin-compose = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" }
+vanniktech-publish = { id = "com.vanniktech.maven.publish", version.ref = "vanniktech-publish" }

lib/build.gradle.kts

@@ -5,7 +5,6 @@ plugins {
     alias(libs.plugins.androidLibrary)
     alias(libs.plugins.kotlin.android)
     alias(libs.plugins.kotlin.serialization)
-    alias(libs.plugins.kotlin.compose)
     alias(libs.plugins.vanniktech.publish)
 }
 
@@ -44,7 +43,7 @@ android {
         jvmTarget = "11"
     }
     buildFeatures {
-        compose = true
+        compose = false
         buildConfig = true
     }
 
@@ -68,10 +67,6 @@ dependencies {
     implementation(libs.androidx.core.ktx)
     implementation(libs.androidx.lifecycle.runtime.ktx)
     implementation(libs.androidx.lifecycle.process)
-    // explicit dependency on compose seems to be required to use the compose compiler
-    // this is not used by the library atm
-    implementation(libs.androidx.activity.compose)
-    implementation(platform(libs.androidx.compose.bom))
     implementation(libs.androidx.appcompat)
     implementation(libs.ktor.client.core)
     implementation(libs.kotlinx.coroutines.core)
@@ -86,13 +81,15 @@ dependencies {
 
     testImplementation(libs.junit)
     testImplementation(libs.androidx.arch.core)
-
+    // As of Kotlin 2.0, the Compose Compiler and runtime are required in the classpath https://www.jetbrains.com/help/kotlin-multiplatform-dev/compose-compiler.html
+    testImplementation(libs.androidx.activity.compose)
+    testImplementation(platform(libs.androidx.compose.bom))
     androidTestImplementation(libs.androidx.junit)
     androidTestImplementation(libs.androidx.espresso.core)
     androidTestImplementation(platform(libs.androidx.compose.bom))
     androidTestImplementation(libs.androidx.ui.test.junit4)
-    debugImplementation(libs.androidx.ui.tooling)
-    debugImplementation(libs.androidx.ui.test.manifest)
+    androidTestImplementation(libs.androidx.ui.tooling)
+    androidTestImplementation(libs.androidx.ui.test.manifest)
 
     testImplementation(libs.mockk)
     testImplementation(libs.mockk.android)
@@ -101,7 +98,7 @@ dependencies {
 }
 
 mavenPublishing {
-    coordinates("com.telemetrydeck", "kotlin-sdk", "4.0.2")
+    coordinates("com.telemetrydeck", "kotlin-sdk", "4.0.5")
 
     pom {
         name = "TelemetryDeck SDK"

lib/src/main/java/com/telemetrydeck/sdk/providers/DefaultParameterProvider.kt

@@ -0,0 +1,38 @@
+package com.telemetrydeck.sdk.providers
+
+import android.app.Application
+import com.telemetrydeck.sdk.TelemetryDeckProvider
+import com.telemetrydeck.sdk.TelemetryDeckSignalProcessor
+
+
+/**
+ * [DefaultParameterProvider] is a [TelemetryDeckProvider] that adds default parameters
+ * to every telemetry signal. It ensures that signals are enriched with predefined data,
+ * unless the signal already contains a value for the same key.
+ *
+ * @property defaultParameters A map of key-value pairs representing the default parameters
+ *                            that will be added to each telemetry signal.
+ */
+class DefaultParameterProvider(val defaultParameters: Map<String, String>): TelemetryDeckProvider {
+    override fun register(ctx: Application?, client: TelemetryDeckSignalProcessor) {
+        // nothing to do
+    }
+
+    override fun stop() {
+        // nothing to do
+    }
+
+    override fun enrich(
+        signalType: String,
+        clientUser: String?,
+        additionalPayload: Map<String, String>
+    ): Map<String, String> {
+        val signalPayload = additionalPayload.toMutableMap()
+        for (item in defaultParameters) {
+            if (!signalPayload.containsKey(item.key)) {
+                signalPayload[item.key] = item.value
+            }
+        }
+        return signalPayload
+    }
+}

lib/src/main/java/com/telemetrydeck/sdk/providers/EnvironmentParameterProvider.kt

@@ -20,7 +20,7 @@ import com.telemetrydeck.sdk.params.SDK
  * - information about the device running the application, such as operating system, model name, or architecture.
  * - information about the TelemetryDeck SDK, such as its name or version number.
  */
-internal class EnvironmentParameterProvider : TelemetryDeckProvider, TelemetryProviderFallback {
+class EnvironmentParameterProvider : TelemetryDeckProvider, TelemetryProviderFallback {
     private var enabled: Boolean = true
     private var metadata = mutableMapOf<String, String>()
 
@@ -30,7 +30,7 @@ internal class EnvironmentParameterProvider : TelemetryDeckProvider, TelemetryPr
     private val platform: String = "Android"
     private val os: String = "Android"
     private val sdkName: String = "KotlinSDK"
-    private val sdkVersion: String = "4.0.2"
+    private val sdkVersion: String = "4.0.5"
 
     override fun fallbackRegister(ctx: Application?, client: TelemetryDeckSignalProcessor) {
         register(ctx, client)

lib/src/main/java/com/telemetrydeck/sdk/providers/PlatformContextProvider.kt

@@ -13,7 +13,7 @@ import com.telemetrydeck.sdk.platform.getLocaleName
 import com.telemetrydeck.sdk.platform.getTimeZone
 import java.lang.ref.WeakReference
 
-internal class PlatformContextProvider : TelemetryDeckProvider, TelemetryProviderFallback {
+class PlatformContextProvider : TelemetryDeckProvider, TelemetryProviderFallback {
     private var enabled: Boolean = true
     private var manager: WeakReference<TelemetryDeckSignalProcessor>? = null
     private var appContext: WeakReference<Application?>? = null

lib/src/main/java/com/telemetrydeck/sdk/providers/SessionActivityProvider.kt

@@ -15,7 +15,7 @@ import java.lang.ref.WeakReference
 /**
  * Emits signals for application and activity lifecycle events.
  */
-internal class SessionActivityProvider : TelemetryDeckProvider,
+class SessionActivityProvider : TelemetryDeckProvider,
     Application.ActivityLifecycleCallbacks, DefaultLifecycleObserver, TelemetryProviderFallback {
     private var manager: WeakReference<TelemetryDeckSignalProcessor>? = null
 

lib/src/main/java/com/telemetrydeck/sdk/providers/SessionAppProvider.kt

@@ -14,7 +14,7 @@ import java.lang.ref.WeakReference
 /**
  * Monitors the app lifecycle in order to broadcast the NewSessionBegan signal.
  */
-internal class SessionAppProvider : TelemetryDeckProvider, DefaultLifecycleObserver,
+class SessionAppProvider : TelemetryDeckProvider, DefaultLifecycleObserver,
     TelemetryProviderFallback {
     private var manager: WeakReference<TelemetryDeckSignalProcessor>? = null