Merge branch 'main' into ep/vertex-serializable

Author: emilypgoogle

firebase-dynamic-links/CHANGELOG.md

@@ -2,7 +2,8 @@
 
 
 # 22.1.0
-* [changed] Added deprecation annotations to the public API. See https://firebase.google.com/support/dynamic-links-faq for further context.
+* [deprecated] `firebase-dynamic-links` is deprecated. For information about timelines and alternatives,
+  see the [irebase-dynamic-links deprecation FAQ](/support/dynamic-links-faq).
 
 
 ## Kotlin

firebase-vertexai/README.md

@@ -1,9 +1,5 @@
 # Firebase Vertex AI SDK
 
-**Preview**: Vertex AI for Firebase is in Public Preview, which means that the product is
-not subject to any SLA or deprecation policy and could change in backwards-incompatible
-ways.
-
 For developer documentation, please visit https://firebase.google.com/docs/vertex-ai.
 This README is for contributors building and running tests for the SDK.
 

firebase-vertexai/src/test/java/com/google/firebase/vertexai/UnarySnapshotTests.kt

@@ -33,6 +33,8 @@ import com.google.firebase.vertexai.type.UnsupportedUserLocationException
 import com.google.firebase.vertexai.util.goldenUnaryFile
 import com.google.firebase.vertexai.util.shouldNotBeNullOrEmpty
 import io.kotest.assertions.throwables.shouldThrow
+import io.kotest.inspectors.forAtLeastOne
+import io.kotest.matchers.collections.shouldContain
 import io.kotest.matchers.collections.shouldNotBeEmpty
 import io.kotest.matchers.nulls.shouldNotBeNull
 import io.kotest.matchers.should
@@ -42,6 +44,7 @@ import io.kotest.matchers.string.shouldContain
 import io.kotest.matchers.string.shouldNotBeEmpty
 import io.kotest.matchers.types.shouldBeInstanceOf
 import io.ktor.http.HttpStatusCode
+import java.util.Calendar
 import kotlin.time.Duration.Companion.seconds
 import kotlinx.coroutines.withTimeout
 import kotlinx.serialization.json.JsonPrimitive
@@ -213,6 +216,11 @@ internal class UnarySnapshotTests {
       withTimeout(testTimeout) {
         val exception = shouldThrow<ResponseStoppedException> { model.generateContent("prompt") }
         exception.response.candidates.first().finishReason shouldBe FinishReason.SAFETY
+        exception.response.candidates.first().safetyRatings.forAtLeastOne {
+          it.category shouldBe HarmCategory.HARASSMENT
+          it.probability shouldBe HarmProbability.LOW
+          it.severity shouldBe HarmSeverity.LOW
+        }
       }
     }
 
@@ -233,6 +241,10 @@ internal class UnarySnapshotTests {
 
         response.candidates.isEmpty() shouldBe false
         response.candidates.first().citationMetadata?.citations?.size shouldBe 3
+        response.candidates.first().citationMetadata?.citations?.forAtLeastOne {
+          it.publicationDate?.get(Calendar.YEAR) shouldBe 2019
+          it.publicationDate?.get(Calendar.DAY_OF_MONTH) shouldBe 10
+        }
       }
     }
 

firebase-vertexai/update_responses.sh

@@ -17,7 +17,7 @@
 # This script replaces mock response files for Vertex AI unit tests with a fresh
 # clone of the shared repository of Vertex AI test data.
 
-RESPONSES_VERSION='v3.*' # The major version of mock responses to use
+RESPONSES_VERSION='v5.*' # The major version of mock responses to use
 REPO_NAME="vertexai-sdk-test-data"
 REPO_LINK="https://github.com/FirebaseExtended/$REPO_NAME.git"
 

plugins/build.gradle.kts

@@ -66,11 +66,18 @@ dependencies {
   implementation("com.google.code.gson:gson:2.8.9")
   implementation(libs.android.gradlePlugin.gradle)
   implementation(libs.android.gradlePlugin.builder.test.api)
+  implementation("io.github.pdvrieze.xmlutil:serialization-jvm:0.90.3") {
+    exclude("org.jetbrains.kotlinx", "kotlinx-serialization-json")
+    exclude("org.jetbrains.kotlinx", "kotlinx-serialization-core")
+  }
 
+  testImplementation(gradleTestKit())
   testImplementation(libs.bundles.kotest)
+  testImplementation(libs.mockk)
   testImplementation(libs.junit)
   testImplementation(libs.truth)
   testImplementation("commons-io:commons-io:2.15.1")
+  testImplementation(kotlin("test"))
 }
 
 gradlePlugin {

plugins/src/main/java/com/google/firebase/gradle/plugins/BaseFirebaseLibraryPlugin.kt

@@ -18,6 +18,7 @@ package com.google.firebase.gradle.plugins
 
 import com.android.build.gradle.LibraryExtension
 import com.google.firebase.gradle.plugins.ci.Coverage
+import com.google.firebase.gradle.plugins.services.GMavenService
 import java.io.File
 import java.nio.file.Paths
 import org.gradle.api.Plugin
@@ -52,6 +53,7 @@ import org.w3c.dom.Element
 abstract class BaseFirebaseLibraryPlugin : Plugin<Project> {
   protected fun setupDefaults(project: Project, library: FirebaseLibraryExtension) {
     with(library) {
+      project.gradle.sharedServices.registerIfAbsent<GMavenService, _>("gmaven")
       previewMode.convention("")
       publishJavadoc.convention(true)
       artifactId.convention(project.name)

plugins/src/main/java/com/google/firebase/gradle/plugins/GradleExtensions.kt

@@ -30,8 +30,11 @@ import org.gradle.api.attributes.Attribute
 import org.gradle.api.attributes.AttributeContainer
 import org.gradle.api.plugins.PluginManager
 import org.gradle.api.provider.Provider
+import org.gradle.api.services.BuildService
+import org.gradle.api.services.BuildServiceParameters
+import org.gradle.api.services.BuildServiceRegistry
+import org.gradle.api.services.BuildServiceSpec
 import org.gradle.kotlin.dsl.apply
-import org.gradle.kotlin.dsl.provideDelegate
 import org.gradle.workers.WorkAction
 import org.gradle.workers.WorkParameters
 import org.gradle.workers.WorkQueue
@@ -244,3 +247,19 @@ fun LibraryAndroidComponentsExtension.onReleaseVariants(
 ) {
   onVariants(selector().withBuildType("release"), callback)
 }
+
+/**
+ * Register a build service under the specified [name], if it hasn't been registered already.
+ *
+ * ```
+ * project.gradle.sharedServices.registerIfAbsent<GMavenService, _>("gmaven")
+ * ```
+ *
+ * @param T The build service class to register
+ * @param P The parameters class for the build service to register
+ * @param name The name to register the build service under
+ * @param config An optional configuration block to setup the build service with
+ */
+inline fun <reified T : BuildService<P>, reified P : BuildServiceParameters> BuildServiceRegistry
+  .registerIfAbsent(name: String, noinline config: BuildServiceSpec<P>.() -> Unit = {}) =
+  registerIfAbsent(name, T::class.java, config)

plugins/src/main/java/com/google/firebase/gradle/plugins/KotlinExtensions.kt

@@ -17,7 +17,9 @@
 package com.google.firebase.gradle.plugins
 
 import java.io.File
+import java.io.InputStream
 import org.w3c.dom.Element
+import org.w3c.dom.Node
 import org.w3c.dom.NodeList
 
 /** Replaces all matching substrings with an empty string (nothing) */
@@ -124,6 +126,13 @@ fun Element.findOrCreate(tag: String): Element =
 fun Element.findElementsByTag(tag: String) =
   getElementsByTagName(tag).children().mapNotNull { it as? Element }
 
+/**
+ * Returns the text of an attribute, if it exists.
+ *
+ * @param name The name of the attribute to get the text for
+ */
+fun Node.textByAttributeOrNull(name: String) = attributes?.getNamedItem(name)?.textContent
+
 /**
  * Yields the items of this [NodeList] as a [Sequence].
  *
@@ -267,6 +276,19 @@ infix fun <T> List<T>.diff(other: List<T>): List<Pair<T?, T?>> {
  */
 fun <T> List<T>.coerceToSize(targetSize: Int) = List(targetSize) { getOrNull(it) }
 
+/**
+ * Writes the [InputStream] to this file.
+ *
+ * While this method _does_ close the generated output stream, it's the callers responsibility to
+ * close the passed [stream].
+ *
+ * @return This [File] instance for chaining.
+ */
+fun File.writeStream(stream: InputStream): File {
+  outputStream().use { stream.copyTo(it) }
+  return this
+}
+
 /**
  * The [path][File.path] represented as a qualified unix path.
  *

plugins/src/main/java/com/google/firebase/gradle/plugins/ModuleVersion.kt

@@ -57,7 +57,7 @@ enum class PreReleaseVersionType {
  * Where `Type` is a case insensitive string of any [PreReleaseVersionType], and `Build` is a two
  * digit number (single digits should have a leading zero).
  *
- * Note that `build` will always be present as starting at one by defalt. That is, the following
+ * Note that `build` will always be present as starting at one by default. That is, the following
  * transform occurs:
  * ```
  * "12.13.1-beta" // 12.13.1-beta01
@@ -92,7 +92,7 @@ data class PreReleaseVersion(val type: PreReleaseVersionType, val build: Int = 1
      */
     fun fromStringsOrNull(type: String, build: String): PreReleaseVersion? =
       runCatching {
-          val preType = PreReleaseVersionType.valueOf(type.toUpperCase())
+          val preType = PreReleaseVersionType.valueOf(type.uppercase())
           val buildNumber = build.takeUnless { it.isBlank() }?.toInt() ?: 1
 
           PreReleaseVersion(preType, buildNumber)
@@ -115,7 +115,7 @@ data class PreReleaseVersion(val type: PreReleaseVersionType, val build: Int = 1
    * PreReleaseVersion(RC, 12).toString() // "rc12"
    * ```
    */
-  override fun toString() = "${type.name.toLowerCase()}${build.toString().padStart(2, '0')}"
+  override fun toString() = "${type.name.lowercase()}${build.toString().padStart(2, '0')}"
 }
 
 /**
@@ -140,7 +140,7 @@ data class ModuleVersion(
 ) : Comparable<ModuleVersion> {
 
   /** Formatted as `MAJOR.MINOR.PATCH-PRE` */
-  override fun toString() = "$major.$minor.$patch${pre?.let { "-${it.toString()}" } ?: ""}"
+  override fun toString() = "$major.$minor.$patch${pre?.let { "-$it" } ?: ""}"
 
   override fun compareTo(other: ModuleVersion) =
     compareValuesBy(
@@ -149,7 +149,7 @@ data class ModuleVersion(
       { it.major },
       { it.minor },
       { it.patch },
-      { it.pre == null }, // a version with no prerelease version takes precedence
+      { it.pre == null }, // a version with no pre-release version takes precedence
       { it.pre },
     )
 
@@ -176,7 +176,7 @@ data class ModuleVersion(
      * ```
      */
     val VERSION_REGEX =
-      "(?<major>\\d+)\\.(?<minor>\\d+)\\.(?<patch>\\d+)(?:\\-\\b)?(?<pre>\\w\\D+)?(?<build>\\B\\d+)?"
+      "(?<major>\\d+)\\.(?<minor>\\d+)\\.(?<patch>\\d+)(?:-\\b)?(?<pre>\\w\\D+)?(?<build>\\B\\d+)?"
         .toRegex()
 
     /**
@@ -209,6 +209,29 @@ data class ModuleVersion(
           }
         }
         .getOrNull()
+
+    /**
+     * Parse a [ModuleVersion] from a string.
+     *
+     * You should use [fromStringOrNull] when you don't know the `artifactId` of the corresponding
+     * artifact, if you don't need to throw on failure, or if you need to throw a more specific
+     * message.
+     *
+     * This method exists to cover the common ground of getting [ModuleVersion] representations of
+     * artifacts.
+     *
+     * @param artifactId The artifact that this version belongs to. Will be used in the error
+     *   message on failure.
+     * @param version The version to parse into a [ModuleVersion].
+     * @return A [ModuleVersion] created from the string.
+     * @throws IllegalArgumentException If the string doesn't represent a valid semver version.
+     * @see fromStringOrNull
+     */
+    fun fromString(artifactId: String, version: String): ModuleVersion =
+      fromStringOrNull(version)
+        ?: throw IllegalArgumentException(
+          "Invalid module version found for '${artifactId}': $version"
+        )
   }
 
   /**