Merge pull request #413 from GitLiveApp/update-jvm-target

Add jvm target using the firebase-java-sdk

Author: nbransby

README.md

@@ -1,10 +1,14 @@
 <h1 align="left">Firebase Kotlin SDK <img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/gitliveapp/firebase-kotlin-sdk?style=flat-square"> <a href="https://git.live"><img src="https://img.shields.io/badge/collaborate-on%20gitlive-blueviolet?style=flat-square"></a></h1>
 <img align="left" width="75px" src="https://avatars2.githubusercontent.com/u/42865805?s=200&v=4"> 
   <b>Built and maintained with 🧡 by <a href="https://git.live">GitLive</a></b><br/>
-  <i>Real-time code collaboration inside any IDE</i><br/>
+  <i>Development teams merge faster with GitLive</i><br/>
 <br/>
 <br/>
-The Firebase Kotlin SDK is a Kotlin-first SDK for Firebase. It's API is similar to the <a href="https://firebase.github.io/firebase-android-sdk/reference/kotlin/firebase-ktx/">Firebase Android SDK Kotlin Extensions</a> but also supports multiplatform projects, enabling you to use Firebase directly from your common source targeting <strong>iOS</strong>, <strong>Android</strong> or <strong>JS</strong>.
+The Firebase Kotlin SDK is a Kotlin-first SDK for Firebase. It's API is similar to the 
+<a href="https://firebase.github.io/firebase-android-sdk/reference/kotlin/firebase-ktx/">Firebase Android SDK Kotlin Extensions</a> 
+but also supports multiplatform projects, enabling you to use Firebase directly from your common source targeting 
+<strong>iOS</strong>, <strong>Android</strong>, <strong>Desktop</strong> or <strong>Web</strong>, enabling the use of 
+Firebase as a backend for<a href="https://www.jetbrains.com/lp/compose-multiplatform/">Compose Multiplatform</a>, for example.
 
 ## Available libraries
 
@@ -23,9 +27,6 @@ The following libraries are available for the various Firebase products.
 | [Performance](https://firebase.google.com/docs/perf-mon)                        | [`dev.gitlive:firebase-perf:1.8.2`](https://search.maven.org/artifact/dev.gitlive/firebase-perf/1.8.2/pom)                   | [![1%](https://img.shields.io/badge/-1%25-orange?style=flat-square)](/firebase-perf/src/commonMain/kotlin/dev/gitlive/firebase/perf/performance.kt)                      |
 | [Crashlytics](https://firebase.google.com/docs/crashlytics)                     | [`dev.gitlive:firebase-crashlytics:1.8.2`](https://search.maven.org/artifact/dev.gitlive/firebase-crashlytics/1.8.2/pom)     | [![80%](https://img.shields.io/badge/-1%25-orange?style=flat-square)](/firebase-crashlytics/src/commonMain/kotlin/dev/gitlive/firebase/crashlytics/crashlytics.kt)       |
 
-
-
-
 Is the Firebase library or API you need missing? [Create an issue](https://github.com/GitLiveApp/firebase-kotlin-sdk/issues/new?labels=API+coverage&template=increase-api-coverage.md&title=Add+%5Bclass+name%5D.%5Bfunction+name%5D+to+%5Blibrary+name%5D+for+%5Bplatform+names%5D) to request additional API coverage or be awesome and [submit a PR](https://github.com/GitLiveApp/firebase-kotlin-sdk/fork)
 
 ## Kotlin-first design
@@ -205,6 +206,8 @@ In cases where it makes sense, such as Firebase Functions HTTPS Callable, operat
 
 The Firebase Kotlin SDK provides a common API to access Firebase for projects targeting *iOS*, *Android* and *JS* meaning you can use Firebase directly in your common code. Under the hood, the SDK achieves this by binding to the respective official Firebase SDK for each supported platform.
 
+It uses the <a href="https://github.com/GitLiveApp/firebase-java-sdk">Firebase Java SDK</a> to support the JVM target.
+
 ### Accessing the underlying Firebase SDK
 
 In some cases you might want to access the underlying official Firebase SDK in platform specific code, for example when the common API is missing the functionality you need. For this purpose each class in the SDK has `android`, `ios` and `js` properties which holds the  equivalent object of the underlying official Firebase SDK. 
@@ -217,25 +220,6 @@ These properties are only accessible from the equivalent target's source set. Fo
           .build()
 ```
 
-### NPM modules
-
-If you are building a Kotlin multiplatform library which will be consumed from JS code you may need to include the SDK in your `package.json`, you can do it as follows:
-
-```json
-"dependencies": {
-  "@gitlive/firebase-auth": "1.8.2",
-  "@gitlive/firebase-config": "1.8.2",
-  "@gitlive/firebase-database": "1.8.2",
-  "@gitlive/firebase-firestore": "1.8.2",
-  "@gitlive/firebase-functions": "1.8.2",
-  "@gitlive/firebase-installations": "1.8.2",
-  "@gitlive/firebase-messaging": "1.8.2",
-  "@gitlive/firebase-storage": "1.8.2"
-  "@gitlive/firebase-perf": "1.8.2"
-  "@gitlive/firebase-crashlytics": "1.8.2"
-}
-```
-
 ## Contributing
 If you'd like to contribute to this project then you can fork this repository. 
 You can build and test the project locally.

build.gradle.kts

@@ -1,4 +1,3 @@
-import org.apache.tools.ant.taskdefs.condition.Os
 import org.gradle.api.tasks.testing.logging.TestExceptionFormat
 import org.gradle.api.tasks.testing.logging.TestLogEvent
 
@@ -63,7 +62,7 @@ subprojects {
     }
 
     tasks.withType<Sign>().configureEach {
-        onlyIf { !project.gradle.startParameter.taskNames.contains("publishToMavenLocal") }
+        onlyIf { !project.gradle.startParameter.taskNames.any { "MavenLocal" in it } }
     }
 
     val skipPublishing = project.name == "test-utils" // skip publishing for test utils
@@ -103,68 +102,9 @@ subprojects {
                     .replace("firebase-app\": \"([^\"]+)".toRegex(), "firebase-app\": \"${project.property("firebase-app.version")}")
             )
         }
-
-        val copyReadMe by registering(Copy::class) {
-            from(rootProject.file("README.md"))
-            into(file("$buildDir/node_module"))
-        }
-
-        val copyPackageJson by registering(Copy::class) {
-            from(file("package.json"))
-            into(file("$buildDir/node_module"))
-        }
-
-        val unzipJar by registering(Copy::class) {
-            val zipFile = File("$buildDir/libs", "${project.name}-js-${project.version}.jar")
-            from(this.project.zipTree(zipFile))
-            into("$buildDir/classes/kotlin/js/main/")
-        }
-
-        val copyJS by registering {
-            mustRunAfter("unzipJar", "copyPackageJson")
-            doLast {
-                val from = File("$buildDir/classes/kotlin/js/main/${rootProject.name}-${project.name}.js")
-                val into = File("$buildDir/node_module/${project.name}.js")
-                into.createNewFile()
-                into.writeText(
-                    from.readText()
-                        .replace("require('firebase-kotlin-sdk-", "require('@gitlive/")
-//                        .replace("require('kotlinx-serialization-kotlinx-serialization-runtime')", "require('@gitlive/kotlinx-serialization-runtime')")
-                )
-            }
-        }
-
-        val copySourceMap by registering(Copy::class) {
-            from(file("$buildDir/classes/kotlin/js/main/${project.name}.js.map"))
-            into(file("$buildDir/node_module"))
-        }
-
-        val prepareForNpmPublish by registering {
-            dependsOn(
-                unzipJar,
-                copyPackageJson,
-                copySourceMap,
-                copyReadMe,
-                copyJS
-            )
-        }
-
-        val publishToNpm by creating(Exec::class) {
-            workingDir("$buildDir/node_module")
-            isIgnoreExitValue = true
-            if(Os.isFamily(Os.FAMILY_WINDOWS)) {
-                commandLine("cmd", "/c", "npm publish")
-            } else {
-                commandLine("npm", "publish")
-            }
-        }
     }
 
     afterEvaluate  {
-        // create the projects node_modules if they don't exist
-        if(!File("$buildDir/node_module").exists()) {
-            mkdir("$buildDir/node_module")
-        }
 
         dependencies {
             "commonMainImplementation"("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.4")
@@ -175,7 +115,13 @@ subprojects {
             "commonTestImplementation"("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.4")
             "commonTestImplementation"("org.jetbrains.kotlinx:kotlinx-coroutines-test:1.6.4")
             if (this@afterEvaluate.name != "firebase-crashlytics") {
+                "jvmMainApi"("dev.gitlive:firebase-java-sdk:0.1.1")
+                "jvmMainApi"("org.jetbrains.kotlinx:kotlinx-coroutines-play-services:1.6.0") {
+                    exclude("com.google.android.gms")
+                }
                 "jsTestImplementation"(kotlin("test-js"))
+                "jvmTestImplementation"(kotlin("test-junit"))
+                "jvmTestImplementation"("junit:junit:4.13.2")
             }
             "androidAndroidTestImplementation"(kotlin("test-junit"))
             "androidAndroidTestImplementation"("junit:junit:4.13.2")

firebase-app/build.gradle.kts

@@ -50,6 +50,13 @@ kotlin {
         publishAllLibraryVariants()
     }
 
+    jvm {
+        val main by compilations.getting {
+            kotlinOptions {
+                jvmTarget = "17"
+            }
+        }
+    }
 
     if (supportIosTarget) {
         ios()
@@ -106,6 +113,10 @@ kotlin {
             }
         }
 
+        val jvmMain by getting {
+            kotlin.srcDir("src/androidMain/kotlin")
+        }
+
         if (supportIosTarget) {
             val iosMain by getting
             val iosSimulatorArm64Main by getting

firebase-app/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitlive/firebase-app",
-  "version": "1.8.2",
+  "version": "1.9.2",
   "description": "Wrapper around firebase for usage in Kotlin Multiplatform projects",
   "main": "firebase-app.js",
   "scripts": {
@@ -23,7 +23,7 @@
   },
   "homepage": "https://github.com/GitLiveApp/firebase-kotlin-sdk",
   "dependencies": {
-    "@gitlive/firebase-common": "1.8.2",
+    "@gitlive/firebase-common": "1.9.2",
     "firebase": "9.19.1",
     "kotlin": "1.8.20",
     "kotlinx-coroutines-core": "1.6.4"

firebase-app/src/jvmTest/kotlin/dev/gitlive/firebase/firebase.kt

@@ -0,0 +1,10 @@
+/*
+ * Copyright (c) 2020 GitLive Ltd.  Use of this source code is governed by the Apache 2.0 license.
+ */
+
+@file:JvmName("tests")
+package dev.gitlive.firebase
+
+actual val context: Any = Unit
+
+actual fun runTest(test: suspend () -> Unit) = kotlinx.coroutines.test.runTest { test() }

firebase-auth/build.gradle.kts

@@ -35,7 +35,7 @@ android {
         getByName("main") {
             manifest.srcFile("src/androidMain/AndroidManifest.xml")
         }
-        getByName("androidTest"){
+        getByName("androidTest") {
             java.srcDir(file("src/androidAndroidTest/kotlin"))
             manifest.srcFile("src/androidAndroidTest/AndroidManifest.xml")
         }
@@ -109,6 +109,14 @@ kotlin {
         }
     }
 
+    jvm {
+        val main by compilations.getting {
+            kotlinOptions {
+                jvmTarget = "17"
+            }
+        }
+    }
+
     sourceSets {
         all {
             languageSettings.apply {
@@ -132,6 +140,10 @@ kotlin {
             }
         }
 
+        val jvmMain by getting {
+            kotlin.srcDir("src/androidMain/kotlin")
+        }
+
         if (supportIosTarget) {
             val iosMain by getting
             val iosSimulatorArm64Main by getting

firebase-auth/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitlive/firebase-auth",
-  "version": "1.8.2",
+  "version": "1.9.2",
   "description": "Wrapper around firebase for usage in Kotlin Multiplatform projects",
   "main": "firebase-auth.js",
   "scripts": {
@@ -23,7 +23,7 @@
   },
   "homepage": "https://github.com/GitLiveApp/firebase-kotlin-sdk",
   "dependencies": {
-    "@gitlive/firebase-app": "1.8.2",
+    "@gitlive/firebase-app": "1.9.2",
     "firebase": "9.19.1",
     "kotlin": "1.8.20",
     "kotlinx-coroutines-core": "1.6.4"

firebase-auth/src/jvmTest/kotlin/dev/gitlive/firebase/auth/auth.kt

@@ -0,0 +1,13 @@
+/*
+ * Copyright (c) 2020 GitLive Ltd.  Use of this source code is governed by the Apache 2.0 license.
+ */
+
+@file:JvmName("tests")
+package dev.gitlive.firebase.auth
+
+
+actual val emulatorHost: String = "10.0.2.2"
+
+actual val context: Any = Unit
+
+actual fun runTest(test: suspend () -> Unit) = kotlinx.coroutines.test.runTest { test() }

firebase-common/build.gradle.kts

@@ -23,7 +23,10 @@ android {
         getByName("main") {
             manifest.srcFile("src/androidMain/AndroidManifest.xml")
         }
-        getByName("androidTest").java.srcDir(file("src/androidAndroidTest/kotlin"))
+        getByName("androidTest") {
+            java.srcDir(file("src/androidAndroidTest/kotlin"))
+            manifest.srcFile("src/androidAndroidTest/AndroidManifest.xml")
+        }
     }
     testOptions {
         unitTests.apply {
@@ -46,6 +49,19 @@ kotlin {
         publishAllLibraryVariants()
     }
 
+    jvm {
+        val main by compilations.getting {
+            kotlinOptions {
+                jvmTarget = "17"
+            }
+        }
+        val test by compilations.getting {
+            kotlinOptions {
+                jvmTarget = "17"
+            }
+        }
+    }
+
     val supportIosTarget = project.property("skipIosTarget") != "true"
 
     if (supportIosTarget) {
@@ -116,6 +132,17 @@ kotlin {
                 api(npm("firebase", "9.4.1"))
             }
         }
+
+        val jvmMain by getting {
+            kotlin.srcDir("src/androidMain/kotlin")
+        }
+
+        val jvmTest by getting {
+            dependencies {
+                implementation(kotlin("test-junit"))
+            }
+            kotlin.srcDir("src/androidAndroidTest/kotlin")
+        }
     }
 }
 

firebase-common/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitlive/firebase-common",
-  "version": "1.8.2",
+  "version": "1.9.2",
   "description": "Wrapper around firebase for usage in Kotlin Multiplatform projects",
   "main": "firebase-common.js",
   "scripts": {