Merge branch 'main' into releases/m168.mergeback

VinayGuthal · web-flow · commit 4feee4936529 · 2025-08-15T13:37:27.000-04:00
diff --git a/.github/workflows/ai-nightlies.yml b/.github/workflows/ai-nightlies.yml
@@ -0,0 +1,66 @@
+name: Firebase AI Nightlies
+
+on:
+  schedule:
+    - cron: 2 7 * * *  # Runs automatically once a day
+  workflow_dispatch:   # Allow triggering the workflow manually
+
+jobs:
+  nightlies:
+    name: "Nightlies"
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          fetch-depth: 2
+          submodules: true
+
+      - name: Enable KVM
+        run: |
+          echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules
+          sudo udevadm control --reload-rules
+          sudo udevadm trigger --name-match=kvm
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@3a4f6e1af504cf6a31855fa899c6aa5355ba6c12 # v4.7.0
+        with:
+          java-version: 17
+          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@71f986410dfbc7added4569d411d040a91dc6935 # v2.1.8
+        with:
+          credentials_json: ${{ secrets.GCP_SERVICE_ACCOUNT }}
+
+      - uses: google-github-actions/setup-gcloud@77e7a554d41e2ee56fc945c52dfd3f33d12def9a # v2.1.4
+
+      - name: Run tests
+        uses: reactivecircus/android-emulator-runner@62dbb605bba737720e10b196cb4220d374026a6d #v2.33.0
+        env:
+          FIREBASE_CI: 1
+          FTL_RESULTS_BUCKET: android-ci
+          FTL_RESULTS_DIR: ${{ 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 }}
+        with:
+          api-level: 31
+          arch: x86_64
+          ram-size: 4096M
+          heap-size: 4096M
+          script: |
+            adb logcat -v time > logcat.txt &
+            ./gradlew firebase-ai:connectedCheck withErrorProne -PtargetBackend="prod"
+
+      - name: Upload logs
+        if: failure()
+        uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
+        with:
+          name: logcat.txt
+          path: logcat.txt
+          retention-days: 7
+          if-no-files-found: ignore
diff --git a/firebase-ai/CHANGELOG.md b/firebase-ai/CHANGELOG.md
@@ -1,7 +1,9 @@
 # Unreleased
-
+* [changed] Added better description for requests which fail due to the Gemini API not being
+  configured.
 
 # 17.1.0
+=======
 * [feature] added support for Imagen Editing, including inpainting, outpainting, control, style 
   transfer, and subject references (#7075)
 * [feature] **Preview:** Added support for bidirectional streaming in Gemini Developer Api
diff --git a/firebase-ai/firebase-ai.gradle.kts b/firebase-ai/firebase-ai.gradle.kts
@@ -21,6 +21,7 @@ import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 plugins {
   id("firebase-library")
   id("kotlin-android")
+  id("copy-google-services")
   alias(libs.plugins.kotlinx.serialization)
 }
 
diff --git a/firebase-ai/src/androidTest/kotlin/com/google/firebase/ai/AIModels.kt b/firebase-ai/src/androidTest/kotlin/com/google/firebase/ai/AIModels.kt
@@ -17,7 +17,6 @@ package com.google.firebase.ai
 
 import androidx.test.platform.app.InstrumentationRegistry
 import com.google.firebase.FirebaseApp
-import com.google.firebase.FirebaseOptions
 import com.google.firebase.ai.type.GenerativeBackend
 
 class AIModels {
@@ -48,15 +47,7 @@ class AIModels {
 
     fun setup() {
       val context = InstrumentationRegistry.getInstrumentation().context
-      app =
-        FirebaseApp.initializeApp(
-          context,
-          FirebaseOptions.Builder()
-            .setApiKey(API_KEY)
-            .setApplicationId(APP_ID)
-            .setProjectId(PROJECT_ID)
-            .build()
-        )
+      app = FirebaseApp.initializeApp(context)
       flash2Model =
         FirebaseAI.getInstance(app!!, GenerativeBackend.vertexAI())
           .generativeModel(
diff --git a/firebase-ai/src/androidTest/kotlin/com/google/firebase/ai/ImagenTests.kt b/firebase-ai/src/androidTest/kotlin/com/google/firebase/ai/ImagenTests.kt
@@ -22,10 +22,13 @@ import com.google.firebase.ai.type.ImagenEditingConfig
 import com.google.firebase.ai.type.ImagenRawImage
 import com.google.firebase.ai.type.PublicPreviewAPI
 import kotlinx.coroutines.runBlocking
+import org.junit.Ignore
 import org.junit.Test
 
 @OptIn(PublicPreviewAPI::class)
 class ImagenTests {
+
+  @Ignore("Currently not supported by backend model")
   @Test
   fun testGenerateAndEditImage() {
     val imageGenerationModel = FirebaseAI.getInstance(app()).imagenModel("imagen-3.0-generate-002")
diff --git a/firebase-ai/src/main/kotlin/com/google/firebase/ai/common/APIController.kt b/firebase-ai/src/main/kotlin/com/google/firebase/ai/common/APIController.kt
@@ -334,6 +334,9 @@ private suspend fun validateResponse(response: HttpResponse) {
   if (message.contains("The prompt could not be submitted")) {
     throw PromptBlockedException(message)
   }
+  if (message.contains("genai config not found")) {
+    throw APINotConfiguredException()
+  }
   getServiceDisabledErrorDetailsOrNull(error)?.let {
     val errorMessage =
       if (it.metadata?.get("service") == "firebasevertexai.googleapis.com") {
diff --git a/firebase-ai/src/main/kotlin/com/google/firebase/ai/common/Exceptions.kt b/firebase-ai/src/main/kotlin/com/google/firebase/ai/common/Exceptions.kt
@@ -89,6 +89,16 @@ internal constructor(
 internal class UnsupportedUserLocationException(cause: Throwable? = null) :
   FirebaseCommonAIException("User location is not supported for the API use.", cause)
 
+/**
+ * The user's project does not have the Gemini Developer API enabled in the Firebase Console.
+ *
+ * See the Firebase documentation for the
+ * [steps](https://firebase.google.com/docs/ai-logic/faq-and-troubleshooting?api=dev#error-genai-config-not-found)
+ * to enable the Gemini Developer API.
+ */
+internal class APINotConfiguredException(cause: Throwable? = null) :
+  FirebaseCommonAIException("Gemini Developer API not enabled in Firebase console.", cause)
+
 /**
  * Some form of state occurred that shouldn't have.
  *
diff --git a/firebase-ai/src/main/kotlin/com/google/firebase/ai/type/Exceptions.kt b/firebase-ai/src/main/kotlin/com/google/firebase/ai/type/Exceptions.kt
@@ -61,6 +61,8 @@ internal constructor(message: String, cause: Throwable? = null) : RuntimeExcepti
               ContentBlockedException(cause.message ?: "", cause.cause)
             is com.google.firebase.ai.common.QuotaExceededException ->
               QuotaExceededException(cause.message ?: "", cause.cause)
+            is com.google.firebase.ai.common.APINotConfiguredException ->
+              APINotConfiguredException(cause.cause)
             else -> UnknownException(cause.message ?: "", cause)
           }
         is TimeoutCancellationException ->
@@ -149,6 +151,16 @@ internal constructor(message: String, cause: Throwable? = null) :
 public class UnsupportedUserLocationException internal constructor(cause: Throwable? = null) :
   FirebaseAIException("User location is not supported for the API use.", cause)
 
+/**
+ * The user's project does not have the Gemini Developer API enabled in the Firebase Console.
+ *
+ * See the Firebase documentation for the
+ * [steps](https://firebase.google.com/docs/ai-logic/faq-and-troubleshooting?api=dev#error-genai-config-not-found)
+ * to enable the Gemini Developer API.
+ */
+internal class APINotConfiguredException internal constructor(cause: Throwable? = null) :
+  FirebaseAIException("Gemini Developer API not enabled in Firebase console.", cause)
+
 /**
  * Some form of state occurred that shouldn't have.
  *
diff --git a/firebase-ai/src/main/kotlin/com/google/firebase/ai/type/ImagenControlType.kt b/firebase-ai/src/main/kotlin/com/google/firebase/ai/type/ImagenControlType.kt
@@ -19,18 +19,26 @@ package com.google.firebase.ai.type
 public class ImagenControlType internal constructor(internal val value: String) {
   public companion object {
 
-    /** Use edge detection to ensure the new image follow the same outlines */
+    /**
+     * Use edge detection to ensure the new image follows the same outlines as the reference image.
+     */
     @JvmField public val CANNY: ImagenControlType = ImagenControlType("CONTROL_TYPE_CANNY")
 
-    /** Use enhanced edge detection to ensure the new image follow similar outlines */
+    /**
+     * Use enhanced edge detection to ensure the new image follows the same outlines as the
+     * reference image.
+     */
     @JvmField public val SCRIBBLE: ImagenControlType = ImagenControlType("CONTROL_TYPE_SCRIBBLE")
 
-    /** Use face mesh control to ensure that the new image has the same facial expressions */
+    /**
+     * Use face mesh control to ensure that the new image has the same facial expressions as the
+     * reference image.
+     */
     @JvmField public val FACE_MESH: ImagenControlType = ImagenControlType("CONTROL_TYPE_FACE_MESH")
 
     /**
      * Use color superpixels to ensure that the new image is similar in shape and color to the
-     * original
+     * reference image.
      */
     @JvmField
     public val COLOR_SUPERPIXEL: ImagenControlType =
diff --git a/firebase-ai/src/main/kotlin/com/google/firebase/ai/type/ImagenEditMode.kt b/firebase-ai/src/main/kotlin/com/google/firebase/ai/type/ImagenEditMode.kt
@@ -25,7 +25,7 @@ public class ImagenEditMode private constructor(internal val value: String) {
     /** Removes an element from an image */
     @JvmField
     public val INPAINT_REMOVAL: ImagenEditMode = ImagenEditMode("EDIT_MODE_INPAINT_REMOVAL")
-    /** Extend the borders of an image outwards */
+    /** Extends the borders of an image outwards */
     @JvmField public val OUTPAINT: ImagenEditMode = ImagenEditMode("EDIT_MODE_OUTPAINT")
   }
 }
diff --git a/firebase-ai/src/main/kotlin/com/google/firebase/ai/type/ImagenReferenceImage.kt b/firebase-ai/src/main/kotlin/com/google/firebase/ai/type/ImagenReferenceImage.kt
@@ -80,10 +80,11 @@ internal constructor(
  * @param referenceId the reference ID for this image, to be referenced in the prompt
  * @param enableComputation requests that the reference image be generated serverside instead of
  * provided
- * @param superpixelRegionSize if type is COLOR_SUPERPIXEL and [enableComputation] is true, this
- * will control the size of each superpixel region in pixels for the generated referenced image
- * @param superpixelRuler if type is COLOR_SUPERPIXEL and [enableComputation] is true, this will
- * control the superpixel smoothness factor for the generated referenced image
+ * @param superpixelRegionSize if type is [ImagenControlType.COLOR_SUPERPIXEL] and
+ * [enableComputation] is true, this will control the size of each superpixel region in pixels for
+ * the generated referenced image
+ * @param superpixelRuler if type is [ImagenControlType.COLOR_SUPERPIXEL] and [enableComputation] is
+ * true, this will control the superpixel smoothness factor for the generated referenced image
  */
 @PublicPreviewAPI
 public class ImagenControlReference(
@@ -102,9 +103,8 @@ public class ImagenControlReference(
   ) {}
 
 /**
- * Represents a reference image for Imagen editing which will mask of a region to be edited. This
- * image (generated or provided) should contain only black and white pixels, with black representing
- * parts of the image which should not change.
+ * Represents a mask for Imagen editing. This image (generated or provided) should contain only
+ * black and white pixels, with black representing parts of the image which should not change.
  */
 @PublicPreviewAPI
 public abstract class ImagenMaskReference
@@ -113,17 +113,16 @@ internal constructor(maskConfig: ImagenMaskConfig, image: ImagenInlineImage? = n
 
   public companion object {
     /**
-     * Generates these two reference images in order:
+     * Generates two reference images of [ImagenRawImage] and [ImagenRawMask]. These images are
+     * generated in this order:
      * * One [ImagenRawImage] containing the original image, padded out to the new dimensions with
      * black pixels, with the original image placed at the given placement
      * * One [ImagenRawMask] of the same dimensions containing white everywhere except at the
-     * placement original image.
-     *
-     * This is the format expected by Imagen for outpainting requests.
+     * placement original image. This is the format expected by Imagen for outpainting requests.
      *
      * @param image the original image
-     * @param newDimensions the new dimensions for outpainting. This *must* be more than the
-     * original image.
+     * @param newDimensions the new dimensions for outpainting. These new dimensions *must* be more
+     * than the original image.
      * @param newPosition the placement of the original image within the new outpainted image.
      */
     @JvmOverloads
@@ -190,8 +189,8 @@ internal constructor(maskConfig: ImagenMaskConfig, image: ImagenInlineImage? = n
 /**
  * A generated mask image which will auto-detect and mask out the background. The background will be
  * white, and the foreground black
- * @param dilation the amount to dilate the mask, this can help smooth the borders of an edit and
- * make it seem more convincing. For example, 0.05 would dilate the mask 5%.
+ * @param dilation the amount to dilate the mask. This can help smooth the borders of an edit and
+ * make it seem more convincing. For example, `0.05` will dilate the mask 5%.
  */
 @PublicPreviewAPI
 public class ImagenBackgroundMask(dilation: Double? = null) :
@@ -200,21 +199,20 @@ public class ImagenBackgroundMask(dilation: Double? = null) :
 /**
  * A generated mask image which will auto-detect and mask out the foreground. The background will be
  * black, and the foreground white
- * @param dilation the amount to dilate the mask, this can help smooth the borders of an edit and
- * make it seem more convincing. For example, 0.05 would dilate the mask 5%.
+ * @param dilation the amount to dilate the mask. This can help smooth the borders of an edit and
+ * make it seem more convincing. For example, `0.05` will dilate the mask 5%.
  */
 @PublicPreviewAPI
 public class ImagenForegroundMask(dilation: Double? = null) :
   ImagenMaskReference(maskConfig = ImagenMaskConfig(ImagenMaskMode.FOREGROUND, dilation)) {}
 
 /**
- * Represents a reference image for Imagen editing which will mask of a region to be edited. This
- * image should contain only black and white pixels, with black representing parts of the image
- * which should not change.
+ * Represents a mask for Imagen editing. This image should contain only black and white pixels, with
+ * black representing parts of the image which should not change.
  *
  * @param mask the mask image
- * @param dilation the amount to dilate the mask, this can help smooth the borders of an edit and
- * make it seem more convincing. For example, 0.05 would dilate the mask 5%.
+ * @param dilation the amount to dilate the mask. This can help smooth the borders of an edit and
+ * make it seem more convincing. For example, `0.05` will dilate the mask 5%.
  */
 @PublicPreviewAPI
 public class ImagenRawMask(mask: ImagenInlineImage, dilation: Double? = null) :
@@ -226,11 +224,11 @@ public class ImagenRawMask(mask: ImagenInlineImage, dilation: Double? = null) :
 /**
  * Represents a generated mask for Imagen editing which masks out certain objects using object
  * detection.
- * @param classes the list of segmentation IDs for objects to detect and mask out. See
- * [here](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/imagen-api-edit#segment-ids)
- * for a list of segmentation IDs
- * @param dilation the amount to dilate the mask, this can help smooth the borders of an edit and
- * make it seem more convincing. For example, 0.05 would dilate the mask 5%.
+ * @param classes the list of segmentation IDs for objects to detect and mask out. Find a
+ * [list of segmentation IDs](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/imagen-api-edit#segment-ids)
+ * in the Vertex AI documentation.
+ * @param dilation the amount to dilate the mask. This can help smooth the borders of an edit and
+ * make it seem more convincing. For example, `0.05` will dilate the mask 5%.
  */
 @PublicPreviewAPI
 public class ImagenSemanticMask(classes: List<Int>, dilation: Double? = null) :
diff --git a/firebase-dataconnect/src/main/kotlin/com/google/firebase/dataconnect/generated/GeneratedConnector.kt b/firebase-dataconnect/src/main/kotlin/com/google/firebase/dataconnect/generated/GeneratedConnector.kt
@@ -28,13 +28,11 @@ import com.google.firebase.dataconnect.FirebaseDataConnect
  * All methods and properties of [GeneratedConnector] are thread-safe and may be safely called
  * and/or accessed concurrently from multiple threads and/or coroutines.
  *
- * ### Stable for Inheritance (after graduating to "Generally Available")
+ * ### Stable for Inheritance
  *
  * The [GeneratedConnector] interface _is_ stable for inheritance in third-party libraries, as new
  * methods will not be added to this interface and contracts of the existing methods will not be
- * changed. Note, however, that this interface is still subject to changes, up to and including
- * outright deletion, until the Firebase Data Connect product graduates from "alpha" and/or "beta"
- * to "Generally Available" status.
+ * changed, except possibly during major version number changes.
  */
 public interface GeneratedConnector<T : GeneratedConnector<T>> {
 
diff --git a/firebase-dataconnect/src/main/kotlin/com/google/firebase/dataconnect/generated/GeneratedMutation.kt b/firebase-dataconnect/src/main/kotlin/com/google/firebase/dataconnect/generated/GeneratedMutation.kt
@@ -30,13 +30,11 @@ import kotlinx.serialization.SerializationStrategy
  * All methods and properties of [GeneratedMutation] are thread-safe and may be safely called and/or
  * accessed concurrently from multiple threads and/or coroutines.
  *
- * ### Stable for Inheritance (after graduating to "Generally Available")
+ * ### Stable for Inheritance
  *
  * The [GeneratedMutation] interface _is_ stable for inheritance in third-party libraries, as new
  * methods will not be added to this interface and contracts of the existing methods will not be
- * changed. Note, however, that this interface is still subject to changes, up to and including
- * outright deletion, until the Firebase Data Connect product graduates from "alpha" and/or "beta"
- * to "Generally Available" status.
+ * changed, except possibly during major version number changes.
  */
 public interface GeneratedMutation<Connector : GeneratedConnector<Connector>, Data, Variables> :
   GeneratedOperation<Connector, Data, Variables> {
diff --git a/firebase-dataconnect/src/main/kotlin/com/google/firebase/dataconnect/generated/GeneratedOperation.kt b/firebase-dataconnect/src/main/kotlin/com/google/firebase/dataconnect/generated/GeneratedOperation.kt
@@ -31,13 +31,11 @@ import kotlinx.serialization.SerializationStrategy
  * All methods and properties of [GeneratedOperation] are thread-safe and may be safely called
  * and/or accessed concurrently from multiple threads and/or coroutines.
  *
- * ### Stable for Inheritance (after graduating to "Generally Available")
+ * ### Stable for Inheritance
  *
  * The [GeneratedOperation] interface _is_ stable for inheritance in third-party libraries, as new
  * methods will not be added to this interface and contracts of the existing methods will not be
- * changed. Note, however, that this interface is still subject to changes, up to and including
- * outright deletion, until the Firebase Data Connect product graduates from "alpha" and/or "beta"
- * to "Generally Available" status.
+ * changed, except possibly during major version number changes.
  */
 public interface GeneratedOperation<Connector : GeneratedConnector<Connector>, Data, Variables> {
 
diff --git a/firebase-dataconnect/src/main/kotlin/com/google/firebase/dataconnect/generated/GeneratedQuery.kt b/firebase-dataconnect/src/main/kotlin/com/google/firebase/dataconnect/generated/GeneratedQuery.kt
@@ -30,13 +30,11 @@ import kotlinx.serialization.SerializationStrategy
  * All methods and properties of [GeneratedQuery] are thread-safe and may be safely called and/or
  * accessed concurrently from multiple threads and/or coroutines.
  *
- * ### Stable for Inheritance (after graduating to "Generally Available")
+ * ### Stable for Inheritance
  *
  * The [GeneratedQuery] interface _is_ stable for inheritance in third-party libraries, as new
  * methods will not be added to this interface and contracts of the existing methods will not be
- * changed. Note, however, that this interface is still subject to changes, up to and including
- * outright deletion, until the Firebase Data Connect product graduates from "alpha" and/or "beta"
- * to "Generally Available" status.
+ * changed, except possibly during major version number changes.
  */
 public interface GeneratedQuery<Connector : GeneratedConnector<Connector>, Data, Variables> :
   GeneratedOperation<Connector, Data, Variables> {
diff --git a/firebase-dataconnect/src/test/kotlin/com/google/firebase/dataconnect/util/AlphanumericStringUtilUnitTest.kt b/firebase-dataconnect/src/test/kotlin/com/google/firebase/dataconnect/util/AlphanumericStringUtilUnitTest.kt

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@ import org.jetbrains.kotlin.gradle.tasks.KotlinCompile`
`21`	`21`	`plugins {`
`22`	`22`	`id("firebase-library")`
`23`	`23`	`id("kotlin-android")`
	`24`	`+ id("copy-google-services")`
`24`	`25`	`alias(libs.plugins.kotlinx.serialization)`
`25`	`26`	`}`
`26`	`27`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ public class ImagenEditMode private constructor(internal val value: String) {`
`25`	`25`	`/** Removes an element from an image */`
`26`	`26`	`@JvmField`
`27`	`27`	`public val INPAINT_REMOVAL: ImagenEditMode = ImagenEditMode("EDIT_MODE_INPAINT_REMOVAL")`
`28`		`- /** Extend the borders of an image outwards */`
	`28`	`+ /** Extends the borders of an image outwards */`
`29`	`29`	`@JvmField public val OUTPAINT: ImagenEditMode = ImagenEditMode("EDIT_MODE_OUTPAINT")`
`30`	`30`	`}`
`31`	`31`	`}`