Skip to content

Commit bf112f7

Browse files
nbransbynbransby
authored
Merge pull request #525 from deBasMan21/feat/Analytics
Add firebase analytics
2 parents ba3d156 + fb79f41 commit bf112f7

File tree

21 files changed

+957
-0
lines changed

21 files changed

+957
-0
lines changed

‎.github/workflows/publish.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ jobs:
2828
run: ./gradlew :updateVersions
2929
- name: Grant execute permission for gradlew
3030
run: chmod +x gradlew
31+
- name: Publish Firebase Analytics
32+
run: ./gradlew :firebase-analytics:publish
3133
- name: Publish Firebase App
3234
run: ./gradlew :firebase-app:publish
3335
- name: Publish Firebase Auth

‎build.gradle.kts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ val minSdkVersion by extra(23)
3636
tasks {
3737
register("updateVersions") {
3838
dependsOn(
39+
"firebase-analytics:updateVersion", "firebase-analytics:updateDependencyVersion",
3940
"firebase-app:updateVersion", "firebase-app:updateDependencyVersion",
4041
"firebase-auth:updateVersion", "firebase-auth:updateDependencyVersion",
4142
"firebase-common:updateVersion", "firebase-common:updateDependencyVersion",

‎firebase-analytics/build.gradle.kts‎

Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
1+
import org.jetbrains.kotlin.gradle.plugin.KotlinSourceSetTree
2+
3+
/*
4+
* Copyright (c) 2023 GitLive Ltd. Use of this source code is governed by the Apache 2.0 license.
5+
*/
6+
7+
version = project.property("firebase-analytics.version") as String
8+
9+
plugins {
10+
id("com.android.library")
11+
kotlin("native.cocoapods")
12+
kotlin("multiplatform")
13+
}
14+
15+
android {
16+
val minSdkVersion: Int by project
17+
val compileSdkVersion: Int by project
18+
19+
compileSdk = compileSdkVersion
20+
namespace = "dev.gitlive.firebase.analytics"
21+
22+
defaultConfig {
23+
minSdk = minSdkVersion
24+
testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
25+
}
26+
27+
compileOptions {
28+
sourceCompatibility = JavaVersion.VERSION_11
29+
targetCompatibility = JavaVersion.VERSION_11
30+
}
31+
32+
testOptions {
33+
unitTests.apply {
34+
isIncludeAndroidResources = true
35+
}
36+
}
37+
packaging {
38+
resources.pickFirsts.add("META-INF/kotlinx-serialization-core.kotlin_module")
39+
resources.pickFirsts.add("META-INF/AL2.0")
40+
resources.pickFirsts.add("META-INF/LGPL2.1")
41+
}
42+
lint {
43+
abortOnError = false
44+
}
45+
}
46+
47+
val supportIosTarget = project.property("skipIosTarget") != "true"
48+
49+
kotlin {
50+
51+
targets.configureEach {
52+
compilations.configureEach {
53+
kotlinOptions.freeCompilerArgs += "-Xexpect-actual-classes"
54+
}
55+
}
56+
57+
@Suppress("OPT_IN_USAGE")
58+
androidTarget {
59+
instrumentedTestVariant.sourceSetTree.set(KotlinSourceSetTree.test)
60+
unitTestVariant.sourceSetTree.set(KotlinSourceSetTree.test)
61+
publishAllLibraryVariants()
62+
compilations.configureEach {
63+
kotlinOptions {
64+
jvmTarget = "11"
65+
}
66+
}
67+
}
68+
69+
jvm {
70+
compilations.getByName("main") {
71+
kotlinOptions {
72+
jvmTarget = "17"
73+
}
74+
}
75+
compilations.getByName("test") {
76+
kotlinOptions {
77+
jvmTarget = "17"
78+
}
79+
}
80+
}
81+
82+
if (supportIosTarget) {
83+
iosArm64()
84+
iosX64()
85+
iosSimulatorArm64()
86+
cocoapods {
87+
ios.deploymentTarget = "12.0"
88+
framework {
89+
baseName = "FirebaseAnalytics"
90+
}
91+
noPodspec()
92+
pod("FirebaseAnalytics") {
93+
version = "10.25.0"
94+
extraOpts += listOf("-compiler-option", "-fmodules")
95+
}
96+
}
97+
}
98+
99+
js(IR) {
100+
useCommonJs()
101+
nodejs {
102+
testTask(
103+
Action {
104+
useKarma {
105+
useChromeHeadless()
106+
}
107+
}
108+
)
109+
}
110+
browser {
111+
testTask(
112+
Action {
113+
useKarma {
114+
useChromeHeadless()
115+
}
116+
}
117+
)
118+
}
119+
}
120+
121+
sourceSets {
122+
all {
123+
languageSettings.apply {
124+
val apiVersion: String by project
125+
val languageVersion: String by project
126+
this.apiVersion = apiVersion
127+
this.languageVersion = languageVersion
128+
progressiveMode = true
129+
if (name.lowercase().contains("ios")) {
130+
optIn("kotlinx.cinterop.ExperimentalForeignApi")
131+
}
132+
}
133+
}
134+
135+
getByName("commonMain") {
136+
dependencies {
137+
api(project(":firebase-app"))
138+
implementation(project(":firebase-common"))
139+
}
140+
}
141+
142+
getByName("commonTest") {
143+
dependencies {
144+
implementation(project(":test-utils"))
145+
}
146+
}
147+
148+
getByName("androidMain") {
149+
dependencies {
150+
api("com.google.firebase:firebase-analytics")
151+
}
152+
}
153+
}
154+
}
155+
156+
if (project.property("firebase-analytics.skipIosTests") == "true") {
157+
tasks.forEach {
158+
if (it.name.contains("ios", true) && it.name.contains("test", true)) { it.enabled = false }
159+
}
160+
}
161+
162+
if (project.property("firebase-analytics.skipJsTests") == "true") {
163+
tasks.forEach {
164+
if (it.name.contains("js", true) && it.name.contains("test", true)) { it.enabled = false }
165+
}
166+
}
167+
168+
signing {
169+
val signingKey: String? by project
170+
val signingPassword: String? by project
171+
useInMemoryPgpKeys(signingKey, signingPassword)
172+
sign(publishing.publications)
173+
}

‎firebase-analytics/firebase_analytics.podspec‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
Pod::Spec.new do |spec|
2+
spec.name = 'firebase_analytics'
3+
spec.version = '1.8.1'
4+
spec.homepage = ''
5+
spec.source = { :http=> ''}
6+
spec.authors = ''
7+
spec.license = ''
8+
spec.summary = ''
9+
spec.vendored_frameworks = 'build/cocoapods/framework/firebase_analytics.framework'
10+
spec.libraries = 'c++'
11+
12+
13+
14+
spec.pod_target_xcconfig = {
15+
'KOTLIN_PROJECT_PATH' => ':firebase-analytics',
16+
'PRODUCT_MODULE_NAME' => 'firebase_analytics',
17+
}
18+
19+
spec.script_phases = [
20+
{
21+
:name => 'Build firebase_analytics',
22+
:execution_position => :before_compile,
23+
:shell_path => '/bin/sh',
24+
:script => <<-SCRIPT
25+
if [ "YES" = "$OVERRIDE_KOTLIN_BUILD_IDE_SUPPORTED" ]; then
26+
echo "Skipping Gradle build task invocation due to OVERRIDE_KOTLIN_BUILD_IDE_SUPPORTED environment variable set to \"YES\""
27+
exit 0
28+
fi
29+
set -ev
30+
REPO_ROOT="$PODS_TARGET_SRCROOT"
31+
"$REPO_ROOT/../gradlew" -p "$REPO_ROOT" $KOTLIN_PROJECT_PATH:syncFramework \
32+
-Pkotlin.native.cocoapods.platform=$PLATFORM_NAME \
33+
-Pkotlin.native.cocoapods.archs="$ARCHS" \
34+
-Pkotlin.native.cocoapods.configuration="$CONFIGURATION"
35+
SCRIPT
36+
}
37+
]
38+
39+
end

‎firebase-analytics/package.json‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"name": "@gitlive/firebase-analytics",
3+
"version": "1.12.0",
4+
"description": "Wrapper around firebase for usage in Kotlin Multiplatform projects",
5+
"main": "firebase-analytics.js",
6+
"scripts": {
7+
"test": "echo \"Error: no test specified\" && exit 1"
8+
},
9+
"repository": {
10+
"type": "git",
11+
"url": "git+https://github.com/GitLiveApp/firebase-kotlin-sdk.git"
12+
},
13+
"keywords": [
14+
"kotlin",
15+
"multiplatform",
16+
"kotlin-js",
17+
"firebase"
18+
],
19+
"author": "dev.gitlive",
20+
"license": "Apache-2.0",
21+
"bugs": {
22+
"url": "https://github.com/GitLiveApp/firebase-kotlin-sdk/issues"
23+
},
24+
"homepage": "https://github.com/GitLiveApp/firebase-kotlin-sdk",
25+
"dependencies": {
26+
"@gitlive/firebase-app": "1.12.0",
27+
"firebase": "9.19.1",
28+
"kotlin": "1.6.10",
29+
"kotlinx-coroutines-core": "1.6.1-native-mt"
30+
}
31+
}

‎firebase-analytics/src/androidInstrumentedTest/AndroidManifest.xml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
2+
3+
<application android:usesCleartextTraffic="true" />
4+
</manifest>

‎firebase-analytics/src/androidInstrumentedTest/kotlin/dev/gitlive/firebase/analytics/analytics.kt‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
/*
2+
* Copyright (c) 2020 GitLive Ltd. Use of this source code is governed by the Apache 2.0 license.
3+
*/
4+
5+
@file:JvmName("tests")
6+
package dev.gitlive.firebase.analytics
7+
8+
import androidx.test.platform.app.InstrumentationRegistry
9+
10+
actual val emulatorHost: String = "10.0.2.2"
11+
12+
actual val context: Any = InstrumentationRegistry.getInstrumentation().targetContext
13+
14+
@Target(AnnotationTarget.CLASS, AnnotationTarget.FUNCTION)
15+
actual annotation class IgnoreForAndroidUnitTest

‎firebase-analytics/src/androidMain/kotlin/dev/gitlive/firebase/analytics/analytics.kt‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
@file:JvmName("analyticsAndroid")
2+
package dev.gitlive.firebase.analytics
3+
4+
import android.os.Bundle
5+
import android.os.IBinder
6+
import android.os.Parcelable
7+
import android.util.Size
8+
import android.util.SizeF
9+
import com.google.firebase.analytics.analytics
10+
import com.google.firebase.analytics.setConsent
11+
import dev.gitlive.firebase.Firebase
12+
import dev.gitlive.firebase.FirebaseApp
13+
import kotlinx.coroutines.tasks.await
14+
import java.io.Serializable
15+
16+
actual val Firebase.analytics: FirebaseAnalytics
17+
get() = FirebaseAnalytics(com.google.firebase.Firebase.analytics)
18+
19+
actual fun Firebase.analytics(app: FirebaseApp) =
20+
FirebaseAnalytics(com.google.firebase.Firebase.analytics)
21+
22+
actual class FirebaseAnalytics(val android: com.google.firebase.analytics.FirebaseAnalytics) {
23+
actual fun logEvent(name: String, parameters: Map<String, Any>?) {
24+
android.logEvent(name, parameters?.toBundle())
25+
}
26+
actual fun setUserProperty(name: String, value: String) {
27+
android.setUserProperty(name, value)
28+
}
29+
actual fun setUserId(id: String) {
30+
android.setUserId(id)
31+
}
32+
actual fun resetAnalyticsData() {
33+
android.resetAnalyticsData()
34+
}
35+
actual fun setDefaultEventParameters(parameters: Map<String, String>) {
36+
android.setDefaultEventParameters(parameters.toBundle())
37+
}
38+
39+
actual fun setAnalyticsCollectionEnabled(enabled: Boolean) {
40+
android.setAnalyticsCollectionEnabled(enabled)
41+
}
42+
43+
actual fun setSessionTimeoutInterval(sessionTimeoutInterval: Long) {
44+
android.setSessionTimeoutDuration(sessionTimeoutInterval)
45+
}
46+
47+
actual suspend fun getSessionId(): Long? = android.sessionId.await()
48+
49+
actual fun setConsent(consentSettings: Map<ConsentType, ConsentStatus>) {
50+
consentSettings.entries.associate {
51+
it.key to when (it.value) {
52+
ConsentStatus.GRANTED -> com.google.firebase.analytics.FirebaseAnalytics.ConsentStatus.GRANTED
53+
ConsentStatus.DENIED -> com.google.firebase.analytics.FirebaseAnalytics.ConsentStatus.DENIED
54+
}
55+
}.let { androidConsentSettings ->
56+
android.setConsent {
57+
androidConsentSettings.entries.forEach {
58+
when (it.key) {
59+
ConsentType.AD_PERSONALIZATION ->
60+
this.adPersonalization = it.value
61+
62+
ConsentType.AD_STORAGE ->
63+
this.adStorage = it.value
64+
65+
ConsentType.AD_USER_DATA ->
66+
this.adUserData = it.value
67+
68+
ConsentType.ANALYTICS_STORAGE ->
69+
this.analyticsStorage = it.value
70+
}
71+
}
72+
73+
}
74+
}
75+
}
76+
77+
actual enum class ConsentType {
78+
AD_PERSONALIZATION,
79+
AD_STORAGE,
80+
AD_USER_DATA,
81+
ANALYTICS_STORAGE
82+
}
83+
84+
actual enum class ConsentStatus {
85+
GRANTED,
86+
DENIED
87+
}
88+
}
89+
90+
actual class FirebaseAnalyticsException(message: String): Exception(message)
91+
92+
private fun Map<String, Any>.toBundle() = Bundle().apply {
93+
forEach { (key, value) ->
94+
when(value::class) {
95+
String::class -> putString(key, value as String)
96+
Int::class -> putInt(key, value as Int)
97+
Long::class -> putLong(key, value as Long)
98+
Double::class -> putDouble(key, value as Double)
99+
Boolean::class -> putBoolean(key, value as Boolean)
100+
}
101+
102+
}
103+
}

‎firebase-analytics/src/androidUnitTest/kotlin/dev/gitlive/firebase/analytics/analytics.kt‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
package dev.gitlive.firebase.analytics
2+
3+
import org.junit.Ignore
4+
5+
actual val emulatorHost: String = "10.0.2.2"
6+
7+
actual val context: Any = ""
8+
9+
actual typealias IgnoreForAndroidUnitTest = Ignore

0 commit comments

Comments
 (0)