Merge branch 'master' of https://github.com/firebase/firebase-android-sdk into rpf-storage-flows

Author: thatfiredev

build.gradle

@@ -17,6 +17,8 @@ import com.google.firebase.gradle.MultiProjectReleasePlugin
 
 buildscript {
     ext.kotlinVersion = '1.7.10'
+    ext.coroutinesVersion = '1.6.4'
+
     repositories {
         google()
         mavenCentral()

buildSrc/src/main/java/com/google/firebase/gradle/bomgenerator/BomGeneratorTask.java

@@ -54,6 +54,7 @@ public class BomGeneratorTask extends DefaultTask {
           "com.google.firebase:firebase-analytics-ktx",
           "com.google.firebase:firebase-appcheck-debug",
           "com.google.firebase:firebase-appcheck-debug-testing",
+          "com.google.firebase:firebase-appcheck-ktx",
           "com.google.firebase:firebase-appcheck-playintegrity",
           "com.google.firebase:firebase-appcheck-safetynet",
           "com.google.firebase:firebase-appcheck",

buildSrc/src/main/java/com/google/firebase/gradle/plugins/DackkaGenerationTask.kt

@@ -3,6 +3,7 @@ package com.google.firebase.gradle.plugins
 import java.io.File
 import javax.inject.Inject
 import org.gradle.api.DefaultTask
+import org.gradle.api.file.FileCollection
 import org.gradle.api.provider.ListProperty
 import org.gradle.api.provider.Property
 import org.gradle.api.provider.SetProperty
@@ -38,7 +39,7 @@ abstract class GenerateDocumentationTaskExtension : DefaultTask() {
     abstract val dackkaJarFile: Property<File>
 
     @get:[InputFiles Classpath]
-    abstract val dependencies: ListProperty<File>
+    abstract val dependencies: Property<FileCollection>
 
     @get:InputFiles
     @get:PathSensitive(PathSensitivity.RELATIVE)

buildSrc/src/main/java/com/google/firebase/gradle/plugins/DackkaPlugin.kt

@@ -120,10 +120,11 @@ abstract class DackkaPlugin : Plugin<Project> {
         project.afterEvaluate {
             if (shouldWePublish(project)) {
                 val generateDocumentation = registerGenerateDackkaDocumentationTask(project)
-                val outputDirectory = generateDocumentation.flatMap { it.outputDirectory }
-                val firesiteTransform = registerFiresiteTransformTask(project, outputDirectory)
-                val copyJavaDocToCommonDirectory = registerCopyJavaDocToCommonDirectoryTask(project, outputDirectory)
-                val copyKotlinDocToCommonDirectory = registerCopyKotlinDocToCommonDirectoryTask(project, outputDirectory)
+                val dackkaFilesDirectory = generateDocumentation.flatMap { it.outputDirectory }
+                val firesiteTransform = registerFiresiteTransformTask(project, dackkaFilesDirectory)
+                val transformedFilesDirectory = firesiteTransform.flatMap { it.outputDirectory }
+                val copyJavaDocToCommonDirectory = registerCopyJavaDocToCommonDirectoryTask(project, transformedFilesDirectory)
+                val copyKotlinDocToCommonDirectory = registerCopyKotlinDocToCommonDirectoryTask(project, transformedFilesDirectory)
 
                 project.tasks.register("kotlindoc") {
                     group = "documentation"
@@ -168,6 +169,7 @@ abstract class DackkaPlugin : Plugin<Project> {
                     val classpath = compileConfiguration.getJars() + project.javadocConfig.getJars() + project.files(bootClasspath)
 
                     val sourcesForJava = sourceSets.flatMap {
+                        // TODO(b/246984444): Investigate why kotlinDirectories includes javaDirectories
                         it.javaDirectories.map { it.absoluteFile }
                     }
 
@@ -177,13 +179,12 @@ abstract class DackkaPlugin : Plugin<Project> {
                     }
 
                     docsTask.configure {
-                        clientName.set(project.firebaseConfigValue { artifactId })
-                        // this will become useful with the agp upgrade, as they're separate in 7.x+
-                        val sourcesForKotlin = emptyList<File>()
+                        if (!isKotlin) dependsOn(docStubs)
+
+                        val sourcesForKotlin = emptyList<File>() + projectSpecificSources(project)
                         val packageLists = fetchPackageLists(project)
 
-                        if (!isKotlin) dependsOn(docStubs)
-                        val excludedFiles = if (!isKotlin) projectSpecificSuppressedFiles(project) else emptyList()
+                        val excludedFiles = projectSpecificSuppressedFiles(project)
                         val fixedJavaSources = if (!isKotlin) listOf(project.docStubs) else sourcesForJava
 
                         javaSources.set(fixedJavaSources)
@@ -206,11 +207,20 @@ abstract class DackkaPlugin : Plugin<Project> {
             include("**/package-list")
         }.toList()
 
+    // TODO(b/243534168): Remove when fixed
+    private fun projectSpecificSources(project: Project) =
+        when (project.name) {
+            "firebase-common" -> {
+                project.project(":firebase-firestore").files("src/main/java/com/google/firebase").toList()
+            }
+            else -> emptyList()
+        }
+
     // TODO(b/243534168): Remove when fixed
     private fun projectSpecificSuppressedFiles(project: Project): List<File> =
         when (project.name) {
             "firebase-common" -> {
-                project.files("${project.docStubs}/com/google/firebase/firestore").toList()
+                project.project(":firebase-firestore").files("src/main/java/com/google/firebase/firestore").toList()
             }
             "firebase-firestore" -> {
                 project.files("${project.docStubs}/com/google/firebase/Timestamp.java").toList()
@@ -226,14 +236,15 @@ abstract class DackkaPlugin : Plugin<Project> {
 
         dackkaJarFile.set(dackkaFile)
         outputDirectory.set(dackkaOutputDirectory)
+        clientName.set(project.firebaseConfigValue { artifactId })
     }
 
-    // TODO(b/243833009): Make task cacheable
-    private fun registerFiresiteTransformTask(project: Project, outputDirectory: Provider<File>) =
+    private fun registerFiresiteTransformTask(project: Project, dackkaFilesDirectory: Provider<File>) =
         project.tasks.register<FiresiteTransformTask>("firesiteTransform") {
             mustRunAfter("generateDackkaDocumentation")
 
-            dackkaFiles.set(outputDirectory)
+            dackkaFiles.set(dackkaFilesDirectory)
+            outputDirectory.set(project.file("${project.buildDir}/dackkaTransformedFiles"))
         }
 
     // TODO(b/246593212): Migrate doc files to single directory
@@ -277,5 +288,7 @@ abstract class DackkaPlugin : Plugin<Project> {
             group = "cleanup"
 
             delete("${project.buildDir}/dackkaDocumentation")
+            delete("${project.buildDir}/dackkaTransformedFiles")
+            delete("${project.rootProject.buildDir}/firebase-kotlindoc")
         }
 }

buildSrc/src/main/java/com/google/firebase/gradle/plugins/FiresiteTransformTask.kt

@@ -3,7 +3,11 @@ package com.google.firebase.gradle.plugins
 import java.io.File
 import org.gradle.api.DefaultTask
 import org.gradle.api.provider.Property
+import org.gradle.api.tasks.CacheableTask
 import org.gradle.api.tasks.InputDirectory
+import org.gradle.api.tasks.OutputDirectory
+import org.gradle.api.tasks.PathSensitive
+import org.gradle.api.tasks.PathSensitivity
 import org.gradle.api.tasks.TaskAction
 
 /**
@@ -21,10 +25,15 @@ import org.gradle.api.tasks.TaskAction
  *  **Please note:**
  *  This task is idempotent- meaning it can safely be ran multiple times on the same set of files.
  */
+@CacheableTask
 abstract class FiresiteTransformTask : DefaultTask() {
     @get:InputDirectory
+    @get:PathSensitive(PathSensitivity.RELATIVE)
     abstract val dackkaFiles: Property<File>
 
+    @get:OutputDirectory
+    abstract val outputDirectory: Property<File>
+
     @TaskAction
     fun build() {
         val namesOfFilesWeDoNotNeed = listOf(
@@ -33,14 +42,18 @@ abstract class FiresiteTransformTask : DefaultTask() {
             "packages.html",
             "package-list"
         )
+        val rootDirectory = dackkaFiles.get()
+        val targetDirectory = outputDirectory.get()
+        targetDirectory.deleteRecursively()
+
+        rootDirectory.walkTopDown().forEach {
+            if (it.name !in namesOfFilesWeDoNotNeed) {
+                val relativePath = it.toRelativeString(rootDirectory)
+                val newFile = it.copyTo(File("${targetDirectory.path}/$relativePath"), true)
 
-        dackkaFiles.get().walkTopDown().forEach {
-            if (it.name in namesOfFilesWeDoNotNeed) {
-                it.delete()
-            } else {
                 when (it.extension) {
-                    "html" -> it.fixHTMLFile()
-                    "yaml" -> it.fixYamlFile()
+                    "html" -> newFile.fixHTMLFile()
+                    "yaml" -> newFile.fixYamlFile()
                 }
             }
         }

buildSrc/src/main/java/com/google/firebase/gradle/plugins/Metalava.kt

@@ -23,6 +23,7 @@ import org.gradle.api.artifacts.Configuration
 import org.gradle.api.file.FileCollection
 import org.gradle.api.provider.Property
 import org.gradle.api.provider.SetProperty
+import org.gradle.api.tasks.Classpath
 import org.gradle.api.tasks.Input
 import org.gradle.api.tasks.InputFile
 import org.gradle.api.tasks.InputFiles
@@ -68,7 +69,7 @@ abstract class GenerateStubsTask : DefaultTask() {
     @get:InputFiles
     abstract val sources: SetProperty<File>
 
-    @get:InputFiles
+    @get:[InputFiles Classpath]
     lateinit var classPath: FileCollection
 
     @get:OutputDirectory

buildSrc/src/main/java/com/google/firebase/gradle/plugins/ProjectUtils.kt

@@ -17,6 +17,7 @@ import org.gradle.api.Project
 import org.gradle.api.Task
 import org.gradle.api.artifacts.Configuration
 import org.gradle.api.attributes.Attribute
+import org.gradle.api.provider.Provider
 
 fun Project.isAndroid(): Boolean =
         listOf("com.android.application", "com.android.library", "com.android.test")
@@ -50,8 +51,7 @@ val Project.dackkaConfig: Configuration
  */
 fun Configuration.getJars() = incoming.artifactView {
     attributes {
-        // TODO(b/241795594): replace value with android-class instead of jar after agp upgrade
-        attribute(Attribute.of("artifactType", String::class.java), "jar")
+        attribute(Attribute.of("artifactType", String::class.java), "android-classes")
     }
 }.artifacts.artifactFiles
 
@@ -63,6 +63,14 @@ fun <T : Task, R : Task> T.dependsOnAndMustRunAfter(otherTask: R) {
     dependsOn(otherTask)
 }
 
+/**
+ * Utility method to call [Task.mustRunAfter] and [Task.dependsOn] on the specified task
+ */
+fun <T : Task, R : Task> T.dependsOnAndMustRunAfter(otherTask: Provider<R>) {
+    mustRunAfter(otherTask)
+    dependsOn(otherTask)
+}
+
 /**
  * Utility method to call [Task.mustRunAfter] and [Task.dependsOn] on the specified task name
  */