Merge branch 'master' of https://github.com/firebase/firebase-android-sdk into rpf-add-coroutines-common-ktx

� Conflicts:
�	build.gradle

Author: thatfiredev

.github/workflows/changelog.yml

@@ -0,0 +1,29 @@
+name: Changelog
+
+on:
+  pull_request
+
+concurrency:
+    group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
+    cancel-in-progress: true
+
+jobs:
+  danger:
+    runs-on: ubuntu-22.04
+    env:
+      BUNDLE_GEMFILE: ./ci/danger/Gemfile
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 100
+        submodules: true
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '2.7'
+    - name: Setup Bundler
+      run: ./ci/danger/setup_bundler.sh
+    - name: Danger CHANGELOG verifier
+      env:
+        DANGER_GITHUB_API_TOKEN: ${{ secrets.GOOGLE_OSS_BOT_TOKEN }}
+      run:
+        '[ ! -z $DANGER_GITHUB_API_TOKEN ] && bundle exec danger --dangerfile=./ci/danger/Dangerfile || echo "Skipping Danger for External Contributor"'

appcheck/firebase-appcheck-debug-testing/gradle.properties

@@ -1 +1,2 @@
-version=16.0.1
+version=16.0.2
+latestReleasedVersion=16.0.1

appcheck/firebase-appcheck-debug/gradle.properties

@@ -1 +1,2 @@
-version=16.0.1
+version=16.0.2
+latestReleasedVersion=16.0.1

appcheck/firebase-appcheck-interop/gradle.properties

@@ -1,2 +1,2 @@
-version=16.0.1
-latestReleasedVersion=16.0.0
+version=16.0.2
+latestReleasedVersion=16.0.1

appcheck/firebase-appcheck-playintegrity/gradle.properties

@@ -1 +1,2 @@
-version=16.0.1
+version=16.0.2
+latestReleasedVersion=16.0.1

appcheck/firebase-appcheck-safetynet/gradle.properties

@@ -1 +1 @@
-version=16.0.1
+version=16.0.2

appcheck/firebase-appcheck/gradle.properties

@@ -1 +1,2 @@
-version=16.0.1
+version=16.0.2
+latestReleasedVersion=16.0.1

build.gradle

@@ -16,7 +16,7 @@ import com.google.firebase.gradle.plugins.license.LicenseResolverPlugin
 import com.google.firebase.gradle.MultiProjectReleasePlugin
 
 buildscript {
-    ext.kotlinVersion = '1.4.32'
+    ext.kotlinVersion = '1.7.10'
     // Please update $coroutinesVersion alongside $kotlinVersion
     // A map of versions can be found here: https://kotlinlang.org/docs/releases.html
     ext.coroutinesVersion = '1.5.2'
@@ -41,8 +41,6 @@ buildscript {
         classpath 'net.ltgt.gradle:gradle-errorprone-plugin:1.3.0'
         classpath 'gradle.plugin.com.github.sherter.google-java-format:google-java-format-gradle-plugin:0.9'
         classpath 'com.google.gms:google-services:4.3.3'
-        classpath 'digital.wup:android-maven-publish:3.6.3'
-        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlinVersion"
         classpath 'org.jlleitschuh.gradle:ktlint-gradle:9.2.1'
     }
 }

buildSrc/README.md

@@ -0,0 +1,11 @@
+## Build Source
+
+This file will be more organized as time progresses. Because a lot of our
+plugins and systems require a moderate amount of cognitive overhead to understand,
+I thought it best to provide documentation for such systems. You can find the
+currently documented systems below:
+
+[Dackka Plugin](src/main/java/com/google/firebase/gradle/plugins/DackkaPlugin.kt)
+
+
+* Note that this file currently only serves as a table of contents until sufficient documentation has been created.

buildSrc/build.gradle.kts

@@ -43,8 +43,7 @@ dependencies {
 
     implementation("com.google.auto.value:auto-value-annotations:1.8.1")
     annotationProcessor("com.google.auto.value:auto-value:1.6.5")
-    implementation("digital.wup:android-maven-publish:3.6.3")
-    implementation(kotlin("gradle-plugin", "1.4.32"))
+    implementation(kotlin("gradle-plugin", "1.7.10"))
     implementation("org.json:json:20210307")
 
     implementation("org.eclipse.aether:aether-api:1.0.0.v20140518")
@@ -57,8 +56,8 @@ dependencies {
     implementation("org.apache.maven:maven-aether-provider:3.1.0")
 
     implementation("com.google.code.gson:gson:2.8.9")
-    implementation("org.jetbrains.dokka:dokka-android-gradle-plugin:0.9.17-g013-9b8280a")
-    implementation("com.android.tools.build:gradle:3.4.3")
+    implementation("com.android.tools.build:gradle:7.2.2")
+    implementation("com.android.tools.build:builder-test-api:7.2.2")
     implementation("gradle.plugin.com.github.sherter.google-java-format:google-java-format-gradle-plugin:0.9")
 
     testImplementation("junit:junit:4.13.2")
@@ -72,10 +71,6 @@ gradlePlugin {
             id = "LicenseResolverPlugin"
             implementationClass = "com.google.firebase.gradle.plugins.license.LicenseResolverPlugin"
         }
-        register("dackkaPlugin") {
-            id = "DackkaPlugin"
-            implementationClass = "com.google.firebase.gradle.plugins.DackkaPlugin"
-        }
         register("multiProjectReleasePlugin") {
             id = "MultiProjectReleasePlugin"
             implementationClass = "com.google.firebase.gradle.MultiProjectReleasePlugin"
@@ -88,12 +83,10 @@ gradlePlugin {
             id = "firebase-library"
             implementationClass = "com.google.firebase.gradle.plugins.FirebaseLibraryPlugin"
         }
-
         register("firebaseJavaLibraryPlugin") {
             id = "firebase-java-library"
             implementationClass = "com.google.firebase.gradle.plugins.FirebaseJavaLibraryPlugin"
         }
-
         register("firebaseVendorPlugin") {
             id = "firebase-vendor"
             implementationClass = "com.google.firebase.gradle.plugins.VendorPlugin"

buildSrc/settings.gradle.kts

@@ -6,17 +6,20 @@ import org.gradle.api.DefaultTask
 import org.gradle.api.provider.ListProperty
 import org.gradle.api.provider.Property
 import org.gradle.api.provider.SetProperty
+import org.gradle.api.tasks.CacheableTask
+import org.gradle.api.tasks.Classpath
 import org.gradle.api.tasks.Input
 import org.gradle.api.tasks.InputFile
 import org.gradle.api.tasks.InputFiles
 import org.gradle.api.tasks.OutputDirectory
+import org.gradle.api.tasks.PathSensitive
+import org.gradle.api.tasks.PathSensitivity
 import org.gradle.api.tasks.TaskAction
 import org.gradle.process.ExecOperations
 import org.gradle.workers.WorkAction
 import org.gradle.workers.WorkParameters
 import org.gradle.workers.WorkerExecutor
 import org.json.JSONObject
-
 /**
  * Extension class for [GenerateDocumentationTask].
  *
@@ -29,26 +32,51 @@ import org.json.JSONObject
  * @property suppressedFiles a list of files to exclude from documentation
  * @property outputDirectory where to store the generated files
  */
+@CacheableTask
 abstract class GenerateDocumentationTaskExtension : DefaultTask() {
-    @get:InputFile
+    @get:[InputFile Classpath]
     abstract val dackkaJarFile: Property<File>
 
-    @get:Input
+    @get:[InputFiles Classpath]
     abstract val dependencies: ListProperty<File>
 
     @get:InputFiles
+    @get:PathSensitive(PathSensitivity.RELATIVE)
     abstract val kotlinSources: ListProperty<File>
 
     @get:InputFiles
+    @get:PathSensitive(PathSensitivity.RELATIVE)
     abstract val javaSources: ListProperty<File>
 
     @get:InputFiles
+    @get:PathSensitive(PathSensitivity.RELATIVE)
     abstract val suppressedFiles: ListProperty<File>
 
+    @get:InputFiles
+    @get:PathSensitive(PathSensitivity.RELATIVE)
+    abstract val packageListFiles: ListProperty<File>
+
+    @get:Input
+    abstract val clientName: Property<String>
+
     @get:OutputDirectory
     abstract val outputDirectory: Property<File>
 }
 
+/**
+ * Wrapper data class for External package-lists in Dokka
+ *
+ * This class allows us to map package-lists in a type-safe way, versus inline straight to
+ * a map. This extra step could be removed- but it could also catch bugs in the future.
+ *
+ * @property packageList the prepared package-list file to map against
+ * @property externalLink the url to map with when generating the docs
+ */
+data class ExternalDocumentationLink(
+    val packageList: File,
+    val externalLink: String
+)
+
 /**
  * Task to run Dackka on a project.
  *
@@ -64,18 +92,10 @@ abstract class GenerateDocumentationTask @Inject constructor(
     @TaskAction
     fun build() {
         val configFile = saveToJsonFile(constructArguments())
-        launchDackka(configFile, workerExecutor)
+        launchDackka(clientName, configFile, workerExecutor)
     }
 
     private fun constructArguments(): JSONObject {
-        // TODO(b/243675474): Move these to a task input for caching purposes
-        val linksMap = mapOf(
-            "android" to "https://developer.android.com/reference/kotlin/",
-            "google" to "https://developer.android.com/reference/",
-            "firebase" to "https://firebase.google.com/docs/reference/kotlin/",
-            "coroutines" to "https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/"
-        )
-
         val jsonMap = mapOf(
             "moduleName" to "",
             "outputDir" to outputDirectory.get().path,
@@ -90,9 +110,9 @@ abstract class GenerateDocumentationTask @Inject constructor(
                 "documentedVisibilities" to listOf("PUBLIC", "PROTECTED"),
                 "skipEmptyPackages" to "true",
                 "suppressedFiles" to suppressedFiles.get().map { it.path },
-                "externalDocumentationLinks" to linksMap.map { (name, url) -> mapOf(
-                    "url" to url,
-                    "packageListUrl" to "file://${project.rootDir.absolutePath}/kotlindoc/package-lists/$name/package-list"
+                "externalDocumentationLinks" to createExternalLinks(packageListFiles).map { mapOf(
+                    "url" to it.externalLink,
+                    "packageListUrl" to it.packageList.toURI()
                 ) }
             )),
             "offlineMode" to "true",
@@ -102,6 +122,20 @@ abstract class GenerateDocumentationTask @Inject constructor(
         return JSONObject(jsonMap)
     }
 
+    private fun createExternalLinks(packageLists: ListProperty<File>): List<ExternalDocumentationLink> {
+        val linksMap = mapOf(
+            "android" to "https://developer.android.com/reference/kotlin/",
+            "google" to "https://developers.google.com/android/reference/",
+            "firebase" to "https://firebase.google.com/docs/reference/kotlin/",
+            "coroutines" to "https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/"
+        )
+
+        return packageLists.get().map {
+            val externalLink = linksMap[it.parentFile.nameWithoutExtension] ?: throw RuntimeException("Unexpected package-list found: ${it.name}")
+            ExternalDocumentationLink(it, externalLink)
+        }
+    }
+
     private fun saveToJsonFile(jsonObject: JSONObject): File {
         val outputFile = File.createTempFile("dackkaArgs", ".json")
 
@@ -111,13 +145,13 @@ abstract class GenerateDocumentationTask @Inject constructor(
         return outputFile
     }
 
-    private fun launchDackka(argsFile: File, workerExecutor: WorkerExecutor) {
+    private fun launchDackka(clientName: Property<String>, argsFile: File, workerExecutor: WorkerExecutor) {
         val workQueue = workerExecutor.noIsolation()
 
         workQueue.submit(DackkaWorkAction::class.java) {
             args.set(listOf(argsFile.path, "-loggingLevel", "WARN"))
             classpath.set(setOf(dackkaJarFile.get()))
-            projectName.set(project.name)
+            projectName.set(clientName)
         }
     }
 }