Merge branch 'master' into ehsann/update-or-query-tests

Author: ehsannas

.github/workflows/ci_tests.yml

@@ -130,6 +130,47 @@ jobs:
         run: |
           ./gradlew ${{matrix.module}}:deviceCheck withErrorProne -PtargetBackend="prod"
 
+  firestore_custom_integ_tests:
+    name: "Firestore Custom Instrumentation Tests Against Named DB"
+    runs-on: ubuntu-22.04
+    needs:
+      - determine_changed
+    # only run on post submit or PRs not originating from forks.
+    if: ((github.repository == 'Firebase/firebase-android-sdk' && github.event_name == 'push') || (github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository)) && contains(fromJSON(needs.determine_changed.outputs.modules), ':firebase-firestore')
+    strategy:
+      fail-fast: false
+
+    steps:
+      - uses: actions/[email protected]
+        with:
+          fetch-depth: 2
+          submodules: true
+
+      - name: Set up JDK 11
+        uses: actions/setup-java@v3
+        with:
+          java-version: 11
+          distribution: temurin
+          cache: gradle
+
+      - name: Add google-services.json
+        env:
+          INTEG_TESTS_GOOGLE_SERVICES: ${{ secrets.INTEG_TESTS_GOOGLE_SERVICES }}
+        run: |
+          echo $INTEG_TESTS_GOOGLE_SERVICES | base64 -d > google-services.json
+      - uses: google-github-actions/auth@v0
+        with:
+          credentials_json: ${{ secrets.GCP_SERVICE_ACCOUNT }}
+      - uses: google-github-actions/setup-gcloud@v0
+      - name: Firestore Named DB Integ Tests
+        env:
+          FIREBASE_CI: 1
+          FTL_RESULTS_BUCKET: android-ci
+          FTL_RESULTS_DIR: ${{ github.event_name == 'pull_request' && format('pr-logs/pull/{0}/{1}/{2}/{3}_{4}/artifacts/', github.repository, github.event.pull_request.number, github.job, github.run_id, github.run_attempt) || format('logs/{0}/{1}_{2}/artifacts/', github.workflow, github.run_id, github.run_attempt)}}
+          FIREBASE_APP_CHECK_DEBUG_SECRET: ${{ secrets.FIREBASE_APP_CHECK_DEBUG_SECRET }}
+        run: |
+          ./gradlew firebase-firestore:deviceCheck withErrorProne -PtargetBackend="prod" -PtargetDatabaseId="test-db"
+
   publish-test-results:
     name: "Publish Tests Results"
     needs:

.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/[email protected]
+
+      - name: Build
+        run: |
+          ./gradlew gmavenVersionCheck

README.md

@@ -65,7 +65,7 @@ https://firebase.google.com.
 * Import the firebase-android-sdk gradle project into Android Studio using the
   **Import project(Gradle, Eclipse ADT, etc.)** option.
 * `firebase-crashlytics-ndk` must be built with NDK 21. See
-  [firebase-crashlytics-ndk](firebase-crashlytics-ndk/README.md) for more 
+  [firebase-crashlytics-ndk](firebase-crashlytics-ndk/README.md) for more
   details.
 
 ## Testing
@@ -143,7 +143,7 @@ Integration tests can be executed on the command line by running
 ```
 
 This will execute tests on devices that are configured per project, if nothing is configured for the
-project, the tests will run on `model=Pixel2,version=27,locale=en,orientation=portrait`.
+project, the tests will run on `model=panther,version=33,locale=en,orientation=portrait`.
 
 Projects can be configured in the following way:
 
@@ -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

build.gradle

@@ -58,11 +58,11 @@ ext {
     protobufJavaUtilVersion = libs.versions.protobufjavautil.get()
 }
 
+apply plugin: com.google.firebase.gradle.plugins.PublishingPlugin
+
 apply plugin: com.google.firebase.gradle.plugins.ci.ContinuousIntegrationPlugin
 apply plugin: com.google.firebase.gradle.plugins.ci.SmokeTestsPlugin
 
-apply plugin: com.google.firebase.gradle.plugins.PublishingPlugin
-
 firebaseContinuousIntegration {
     ignorePaths = [
             /.*\.gitignore$/,

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/BaseFirebaseLibraryPlugin.kt

@@ -276,3 +276,18 @@ fun FirebaseLibraryExtension.resolveExternalAndroidLibraries() =
  */
 val FirebaseLibraryExtension.artifactName: String
   get() = "$mavenName:$version"
+
+/**
+ * Fetches the latest version for this SDK from GMaven.
+ *
+ * Uses [GmavenHelper] to make the request.
+ */
+val FirebaseLibraryExtension.latestVersion: ModuleVersion
+  get() {
+    val latestVersion = GmavenHelper(groupId.get(), artifactId.get()).getLatestReleasedVersion()
+
+    return ModuleVersion.fromStringOrNull(latestVersion)
+      ?: throw RuntimeException(
+        "Invalid format for ModuleVersion for module '$artifactName':\n $latestVersion"
+      )
+  }

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/FirebaseLibraryExtension.java

@@ -21,7 +21,6 @@
 import java.util.Collections;
 import java.util.Optional;
 import java.util.Set;
-import java.util.stream.Collectors;
 import javax.inject.Inject;
 import org.gradle.api.Action;
 import org.gradle.api.Project;
@@ -50,8 +49,7 @@ public class FirebaseLibraryExtension {
   public Property<String> groupId;
   public Property<String> artifactId;
 
-  private String libraryGroupName;
-  private LibraryGroupRegistrar libraryGroupRegistrar;
+  String libraryGroupName;
 
   private Action<MavenPom> customizePomAction =
       pom -> {
@@ -86,8 +84,7 @@ public FirebaseLibraryExtension(Project project, LibraryType type) {
       groupId.set(new DefaultProvider<>(() -> project.getGroup().toString()));
     }
     this.staticAnalysis = initializeStaticAnalysis(project);
-    this.libraryGroupRegistrar = LibraryGroupRegistrar.getInstance();
-    libraryGroupName = "";
+    libraryGroupName = this.artifactId.get();
   }
 
   private FirebaseStaticAnalysis initializeStaticAnalysis(Project project) {
@@ -115,18 +112,6 @@ public void testLab(Action<FirebaseTestLabExtension> action) {
    */
   public void libraryGroup(String libraryGroupName) {
     this.libraryGroupName = libraryGroupName;
-    libraryGroupRegistrar.registerLibrary(libraryGroupName, this);
-  }
-
-  public Set<Project> getProjectsToRelease() {
-    return getLibrariesToRelease().stream().map(l -> l.project).collect(Collectors.toSet());
-  }
-
-  public Set<FirebaseLibraryExtension> getLibrariesToRelease() {
-    return ImmutableSet.<FirebaseLibraryExtension>builder()
-        .addAll(libraryGroupRegistrar.getLibrariesForGroup(libraryGroupName))
-        .add(this)
-        .build();
   }
 
   /** Provides a hook to customize pom generation. */

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

@@ -85,12 +85,19 @@ class FirebaseLibraryPlugin : BaseFirebaseLibraryPlugin() {
     android.testServer(FirebaseTestServer(project, firebaseLibrary.testLab, android))
     setupStaticAnalysis(project, firebaseLibrary)
     getIsPomValidTask(project, firebaseLibrary)
-    getSemverTaskAar(project, firebaseLibrary)
+    setupVersionCheckTasks(project, firebaseLibrary)
     configurePublishing(project, firebaseLibrary, android)
   }
 
-  private fun getSemverTaskAar(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.mkdir("semver/previous-version")
     project.tasks.register<GmavenCopier>("copyPreviousArtifacts") {
       dependsOn("bundleReleaseAar")
       project.file("semver/previous.aar").delete()
@@ -111,7 +118,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"))
       }
@@ -121,15 +131,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")
     }
   }
 

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
     }
   }
 }