Merge branch 'master' into auto_transform

Author: VinayGuthal

.github/workflows/version-check.yml

@@ -0,0 +1,17 @@
+name: Version Check
+
+on:
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - 'releases/**'
+
+jobs:
+  version-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3.5.3
+
+      - name: Build
+        run: |
+          ./gradlew gmavenVersionCheck

README.md

@@ -225,30 +225,21 @@ strategy](https://docs.gradle.org/current/dsl/org.gradle.api.artifacts.Resolutio
 
 ### Commands
 
-The simplest way to publish a project and all its associated dependencies is to
-just publish all projects. The following command builds SNAPSHOT dependencies of
-all projects. All pom level dependencies within the published artifacts will
-also point to SNAPSHOT versions that are co-published.
+For more advanced use cases where developers wish to make changes to a project,
+but have transitive dependencies point to publicly released versions, individual
+projects may be published as follows.
 
 ```bash
-./gradlew publishAllToLocal
+# e.g. to publish Firestore and Functions
+./gradlew -PprojectsToPublish="firebase-firestore,firebase-functions" \
+    publishReleasingLibrariesToMavenLocal
 ```
 
 Developers may take a dependency on these locally published versions by adding
 the `mavenLocal()` repository to your [repositories
 block](https://docs.gradle.org/current/userguide/declaring_repositories.html) in
 your app module's build.gradle.
 
-For more advanced use cases where developers wish to make changes to a project,
-but have transitive dependencies point to publicly released versions, individual
-projects may be published as follows.
-
-```bash
-# e.g. to publish Firestore and Functions
-./gradlew -PprojectsToPublish=":firebase-firestore,:firebase-functions" \
-    publishProjectsToMavenLocal
-```
-
 ### Code Formatting
 
 #### Java

buildSrc/README.md

@@ -1,5 +1,8 @@
 ## Build Source
 
+> [!NOTE]
+> Eventually, this will be merged with our [contributor documentation](https://firebase.github.io/firebase-android-sdk/).
+
 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

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

@@ -173,18 +173,6 @@ public String generateVersionUpdate() {
             "Firebase Functions KTX",
             "functions-ktx-dependency",
             "com.google.firebase:firebase-functions-ktx"));
-    outputBuilder.append(
-        generateVersionVariable(
-            depsByArtifactId,
-            "Firebase Dynamic Links",
-            "fdl-dependency",
-            "com.google.firebase:firebase-dynamic-links"));
-    outputBuilder.append(
-        generateVersionVariable(
-            depsByArtifactId,
-            "Firebase Dynamic Links KTX",
-            "fdl-ktx-dependency",
-            "com.google.firebase:firebase-dynamic-links-ktx"));
     outputBuilder.append(
         generateVersionVariable(
             depsByArtifactId,

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

@@ -56,11 +56,17 @@ class FirebaseJavaLibraryPlugin : BaseFirebaseLibraryPlugin() {
     setupStaticAnalysis(project, firebaseLibrary)
     setupApiInformationAnalysis(project)
     getIsPomValidTask(project, firebaseLibrary)
-    getSemverTaskJar(project, firebaseLibrary)
+    setupVersionCheckTasks(project, firebaseLibrary)
     configurePublishing(project, firebaseLibrary)
   }
 
-  private fun getSemverTaskJar(project: Project, firebaseLibrary: FirebaseLibraryExtension) {
+  private fun setupVersionCheckTasks(project: Project, firebaseLibrary: FirebaseLibraryExtension) {
+    project.tasks.register<GmavenVersionChecker>("gmavenVersionCheck") {
+      groupId.value(firebaseLibrary.groupId.get())
+      artifactId.value(firebaseLibrary.artifactId.get())
+      version.value(firebaseLibrary.version)
+      latestReleasedVersion.value(firebaseLibrary.latestReleasedVersion.orElseGet { "" })
+    }
     project.mkdir("semver")
     project.tasks.register<GmavenCopier>("copyPreviousArtifacts") {
       dependsOn("jar")

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

@@ -27,7 +27,6 @@ import java.io.File
 import org.gradle.api.JavaVersion
 import org.gradle.api.Project
 import org.gradle.api.attributes.Attribute
-import org.gradle.api.publish.tasks.GenerateModuleMetadata
 import org.gradle.api.tasks.Copy
 import org.gradle.kotlin.dsl.apply
 import org.gradle.kotlin.dsl.create
@@ -85,6 +84,7 @@ class FirebaseLibraryPlugin : BaseFirebaseLibraryPlugin() {
     android.testServer(FirebaseTestServer(project, firebaseLibrary.testLab, android))
     setupStaticAnalysis(project, firebaseLibrary)
     getIsPomValidTask(project, firebaseLibrary)
+<<<<<<< HEAD
     getSemverTaskAar(project, firebaseLibrary)
     getPackageTransform(project, firebaseLibrary)
     configurePublishing(project, firebaseLibrary, android)
@@ -99,7 +99,20 @@ class FirebaseLibraryPlugin : BaseFirebaseLibraryPlugin() {
   }
 
   private fun getSemverTaskAar(project: Project, firebaseLibrary: FirebaseLibraryExtension) {
+=======
+    setupVersionCheckTasks(project, firebaseLibrary)
+    configurePublishing(project, firebaseLibrary, android)
+  }
+
+  private fun setupVersionCheckTasks(project: Project, firebaseLibrary: FirebaseLibraryExtension) {
+    project.tasks.register<GmavenVersionChecker>("gmavenVersionCheck") {
+      groupId.value(firebaseLibrary.groupId.get())
+      artifactId.value(firebaseLibrary.artifactId.get())
+      version.value(firebaseLibrary.version)
+      latestReleasedVersion.value(firebaseLibrary.latestReleasedVersion.orElseGet { "" })
+    }
     project.mkdir("semver")
+    project.mkdir("semver/previous-version")
     project.tasks.register<GmavenCopier>("copyPreviousArtifacts") {
       dependsOn("bundleReleaseAar")
       project.file("semver/previous.aar").delete()
@@ -120,7 +133,10 @@ class FirebaseLibraryPlugin : BaseFirebaseLibraryPlugin() {
 
     project.tasks.register<Copy>("extractPreviousClasses") {
       dependsOn("copyPreviousArtifacts")
-      if (project.file("semver/previous.aar").exists()) {
+      if (
+        GmavenHelper(firebaseLibrary.groupId.get(), firebaseLibrary.artifactId.get())
+          .isPresentInGmaven()
+      ) {
         from(project.zipTree("semver/previous.aar"))
         into(project.file("semver/previous-version"))
       }
@@ -130,15 +146,15 @@ class FirebaseLibraryPlugin : BaseFirebaseLibraryPlugin() {
 
     val previousJarFile = project.file("semver/previous-version/classes.jar").absolutePath
     project.tasks.register<ApiDiffer>("semverCheck") {
+      dependsOn("extractCurrentClasses")
+      dependsOn("extractPreviousClasses")
       currentJar.value(currentJarFile)
       previousJar.value(previousJarFile)
       version.value(firebaseLibrary.version)
       previousVersionString.value(
         GmavenHelper(firebaseLibrary.groupId.get(), firebaseLibrary.artifactId.get())
           .getLatestReleasedVersion()
       )
-      dependsOn("extractCurrentClasses")
-      dependsOn("extractPreviousClasses")
     }
   }
 
@@ -178,7 +194,6 @@ class FirebaseLibraryPlugin : BaseFirebaseLibraryPlugin() {
     android: LibraryExtension
   ) {
     android.publishing.singleVariant("release") { withSourcesJar() }
-    project.tasks.withType<GenerateModuleMetadata> { isEnabled = false }
 
     configurePublishing(project, firebaseLibrary)
   }

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

@@ -15,6 +15,7 @@
 package com.google.firebase.gradle.plugins
 
 import java.io.FileNotFoundException
+import java.net.HttpURLConnection
 import java.net.URL
 import javax.xml.parsers.DocumentBuilder
 import javax.xml.parsers.DocumentBuilderFactory
@@ -30,24 +31,52 @@ class GmavenHelper(val groupId: String, val artifactId: String) {
     return "${GMAVEN_ROOT}/${groupIdAsPath}/${artifactId}/${version}/${pomFileName}"
   }
 
+  fun isPresentInGmaven(): Boolean {
+    val groupIdAsPath = groupId.replace(".", "/")
+    val u = URL("${GMAVEN_ROOT}/${groupIdAsPath}/${artifactId}/maven-metadata.xml")
+    val huc: HttpURLConnection = u.openConnection() as HttpURLConnection
+    huc.setRequestMethod("GET") // OR  huc.setRequestMethod ("HEAD");
+    huc.connect()
+    val code: Int = huc.getResponseCode()
+    return code == HttpURLConnection.HTTP_OK
+  }
+
   fun getArtifactForVersion(version: String, isJar: Boolean): String {
     val fileName =
       if (isJar == true) "${artifactId}-${version}.jar" else "${artifactId}-${version}.aar"
     val groupIdAsPath = groupId.replace(".", "/")
     return "${GMAVEN_ROOT}/${groupIdAsPath}/${artifactId}/${version}/${fileName}"
   }
 
+  fun hasReleasedVersion(version: String): Boolean {
+    val doc: Document? = getMavenMetadata()
+    if (doc != null) {
+      val versions = doc.getElementsByTagName("version")
+      for (i in 0..versions.length - 1) {
+        if (versions.item(i).textContent == version) {
+          return true
+        }
+      }
+    }
+    return false
+  }
+
   fun getLatestReleasedVersion(): String {
+    val doc: Document? = getMavenMetadata()
+    return doc?.getElementsByTagName("latest")?.item(0)?.getTextContent() ?: ""
+  }
+
+  fun getMavenMetadata(): Document? {
+    val groupIdAsPath = groupId.replace(".", "/")
+    val mavenMetadataUrl = "${GMAVEN_ROOT}/${groupIdAsPath}/${artifactId}/maven-metadata.xml"
+    val factory: DocumentBuilderFactory = DocumentBuilderFactory.newInstance()
+    val builder: DocumentBuilder = factory.newDocumentBuilder()
     try {
-      val groupIdAsPath = groupId.replace(".", "/")
-      val mavenMetadataUrl = "${GMAVEN_ROOT}/${groupIdAsPath}/${artifactId}/maven-metadata.xml"
-      val factory: DocumentBuilderFactory = DocumentBuilderFactory.newInstance()
-      val builder: DocumentBuilder = factory.newDocumentBuilder()
       val doc: Document = builder.parse(URL(mavenMetadataUrl).openStream())
       doc.documentElement.normalize()
-      return doc.getElementsByTagName("latest").item(0).getTextContent()
+      return doc
     } catch (e: FileNotFoundException) {
-      return ""
+      return null
     }
   }
 }

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

@@ -0,0 +1,78 @@
+// Copyright 2023 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.firebase.gradle.plugins
+
+import org.gradle.api.DefaultTask
+import org.gradle.api.GradleException
+import org.gradle.api.provider.Property
+import org.gradle.api.tasks.Input
+import org.gradle.api.tasks.TaskAction
+
+abstract class GmavenVersionChecker : DefaultTask() {
+
+  @get:Input abstract val groupId: Property<String>
+
+  @get:Input abstract val artifactId: Property<String>
+
+  @get:Input abstract val latestReleasedVersion: Property<String>
+
+  @get:Input abstract val version: Property<String>
+
+  @TaskAction
+  fun run() {
+    val mavenHelper = GmavenHelper(groupId.get(), artifactId.get())
+    val latestMavenVersion = mavenHelper.getLatestReleasedVersion()
+    val info =
+      "\n  latestReleasedVersion in gradle.properties should match the latest release on GMaven (${latestMavenVersion})" +
+        "\n  version in gradle.properties should be a version bump above this, following SemVer, and should not be released on GMaven"
+    // Either the Maven metadata does not exist, or the library hasn't been released
+    if (latestMavenVersion.isEmpty()) {
+      return
+    }
+    // TODO(b/285892320): Remove condition when bug fixed
+    if (artifactId.get() == "protolite-well-known-types") {
+      return
+    }
+    if (version.get() == latestReleasedVersion.get()) {
+      throw GradleException(
+        "version and latestReleasedVersion from gradle.properties are the same (${version.get()})" +
+          info
+      )
+    }
+    if (latestMavenVersion == version.get()) {
+      throw GradleException(
+        "version from gradle.properties (${version.get()}) is already the latest release on GMaven" +
+          info
+      )
+    } else if (mavenHelper.hasReleasedVersion(version.get())) {
+      throw GradleException(
+        "version from gradle.properties (${version.get()}) has already been released on GMaven" +
+          info
+      )
+    }
+    if (latestMavenVersion != latestReleasedVersion.get()) {
+      if (mavenHelper.hasReleasedVersion(latestReleasedVersion.get())) {
+        throw GradleException(
+          "latestReleasedVersion from gradle.properties (${latestReleasedVersion.get()}) has been released but is not the latest release on GMaven (${latestMavenVersion})"
+        )
+      } else {
+        throw GradleException(
+          "latestReleasedVersion from gradle.properties (${latestReleasedVersion.get()}) has not been released on GMaven" +
+            info
+        )
+      }
+    }
+  }
+}

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

@@ -191,9 +191,9 @@ abstract class PublishingPlugin : Plugin<Project> {
     allFirebaseLibraries: List<FirebaseLibraryExtension>
   ): ReleaseMetadata? {
     val projectsToPublish = project.provideProperty<String>("projectsToPublish").orNull
-    val releaseName = project.provideProperty<String>("releaseName").orNull
+    val releaseName = project.provideProperty<String>("releaseName").orNull ?: "NO_NAME"
 
-    if (projectsToPublish == null || releaseName == null) return null
+    if (projectsToPublish == null) return null
 
     val projectNames = projectsToPublish.split(",")
     val librariesToRelease =
@@ -450,7 +450,6 @@ abstract class PublishingPlugin : Plugin<Project> {
     project.tasks.register(SEMVER_CHECK_TASK) {
       for (releasingProject in releasingProjects) {
         val semverCheckTask = releasingProject.tasks.named("semverCheck")
-
         dependsOn(semverCheckTask)
       }
     }

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

@@ -36,16 +36,14 @@ abstract class GmavenCopier : DefaultTask() {
   @TaskAction
   fun run() {
     val mavenHelper = GmavenHelper(groupId.get(), artifactId.get())
+    if (!mavenHelper.isPresentInGmaven()) {
+      return
+    }
     val gMavenPath =
       mavenHelper.getArtifactForVersion(
         mavenHelper.getLatestReleasedVersion(),
         !aarAndroidFile.get()
       )
-    try {
-      URL(gMavenPath).openStream().use { Files.copy(it, Paths.get(filePath.get())) }
-    } catch (_: java.io.FileNotFoundException) {
-      // Gmaven Artifact doesn't exist.
-      return
-    }
+    URL(gMavenPath).openStream().use { Files.copy(it, Paths.get(filePath.get())) }
   }
 }