Merge branch 'main' into mc/messaging

Author: morganchen12

Crashlytics/UnitTests/FIRCLSUtilityTests.m

@@ -77,56 +77,60 @@ - (void)testHexToStringWithNonPrintableCharacters {
   XCTAssertEqualObjects([NSString stringWithUTF8String:string], @"52d04e1f", @"");
 }
 
-- (void)testRedactUUIDWithExpectedPattern {
-  const char* readonly = "CoreSimulator 704.12.1 - Device: iPhone SE (2nd generation) "
-                         "(45D62CC2-CFB5-4E33-AB61-B0684627F1B6) - Runtime: iOS 13.4 (17E8260) - "
-                         "DeviceType: iPhone SE (2nd generation)";
-  size_t len = strlen(readonly);
-  char message[len];
-  strcpy(message, readonly);
-
-  FIRCLSRedactUUID(message);
-
-  NSString* actual = [NSString stringWithUTF8String:message];
-  NSString* expected = @"CoreSimulator 704.12.1 - Device: iPhone SE (2nd generation) "
-                       @"(********-****-****-****-************) - Runtime: iOS 13.4 (17E8260) - "
-                       @"DeviceType: iPhone SE (2nd generation)";
-
-  XCTAssertEqualObjects(actual, expected);
-}
-
-- (void)testRedactUUIDWithMalformedPattern {
-  const char* readonly = "CoreSimulator 704.12.1 - Device: iPhone SE (2nd generation) "
-                         "(45D62CC2-CFB5-4E33-AB61-B0684627F1B6";
-  size_t len = strlen(readonly);
-  char message[len];
-  strcpy(message, readonly);
-
-  FIRCLSRedactUUID(message);
-
-  NSString* actual = [NSString stringWithUTF8String:message];
-  NSString* expected = @"CoreSimulator 704.12.1 - Device: iPhone SE (2nd generation) "
-                       @"(45D62CC2-CFB5-4E33-AB61-B0684627F1B6";
-
-  XCTAssertEqualObjects(actual, expected);
-}
-
-- (void)testRedactUUIDWithoutUUID {
-  const char* readonly = "Fatal error: file /Users/test/src/foo/bar/ViewController.swift, line 25";
-  size_t len = strlen(readonly);
-  char message[len];
-  strcpy(message, readonly);
-
-  FIRCLSRedactUUID(message);
-
-  NSString* actual = [NSString stringWithUTF8String:message];
-  NSString* expected = @"Fatal error: file /Users/test/src/foo/bar/ViewController.swift, line 25";
-
-  XCTAssertEqualObjects(actual, expected);
-}
-
-- (void)testRedactUUIDWithNull {
-  char* message = NULL;
-  XCTAssertNoThrow(FIRCLSRedactUUID(message));
+- (void)testRedactUUID {
+  // Define a local struct to hold the test data
+  struct TestCase {
+    const char *name;      // Name of the test case
+    const char *readonly;  // Input string
+    const char *expected;  // Expected output string
+  };
+
+  // Initialize an array of test cases
+  struct TestCase tests[] = {
+      {.name = "Test with valid UUID",
+       .readonly = "CoreSimulator 704.12.1 - Device: iPhone SE (2nd generation) "
+                   "(45D62CC2-CFB5-4E33-AB61-B0684627F1B6) - Runtime: iOS 13.4 (17E8260) - "
+                   "DeviceType: iPhone SE (2nd generation)",
+       .expected = "CoreSimulator 704.12.1 - Device: iPhone SE (2nd generation) "
+                   "(********-****-****-****-************) - Runtime: iOS 13.4 (17E8260) - "
+                   "DeviceType: iPhone SE (2nd generation)"},
+      {.name = "Test with no UUID",
+       .readonly = "Example with no UUID",
+       .expected = "Example with no UUID"},
+      {.name = "Test with only UUID",
+       .readonly = "(12345678-1234-1234-1234-123456789012)",
+       .expected = "(********-****-****-****-************)"},
+      {.name = "Test with malformed UUID pattern",
+       .readonly = "CoreSimulator 704.12.1 - Device: iPhone SE (2nd generation) "
+                   "(45D62CC2-CFB5-4E33-AB61-B0684627F1B6",
+       .expected = "CoreSimulator 704.12.1 - Device: iPhone SE (2nd generation) "
+                   "(45D62CC2-CFB5-4E33-AB61-B0684627F1B6"},
+      {.name = "Test with other error string",
+       .readonly = "Fatal error: file "
+                   "/Users/test/src/foo/bar/ViewController.swift, line 25",
+       .expected = "Fatal error: file "
+                   "/Users/test/src/foo/bar/ViewController.swift, line 25"},
+      {.name = "Test with NULL input", .readonly = NULL, .expected = NULL}};
+
+  // Loop over the array of test cases
+  for (size_t i = 0; i < sizeof(tests) / sizeof(tests[0]); i++) {
+    if (tests[i].readonly == NULL) {
+      XCTAssertNoThrow(FIRCLSRedactUUID(NULL));
+      continue;
+    }
+
+    // copy the message because the function modifies the input
+    // and the input is const
+    char message[256];
+    snprintf(message, sizeof(message), "%s", tests[i].readonly);
+
+    // Redact the UUID
+    FIRCLSRedactUUID(message);
+
+    // Compare the result with the expected output
+    NSString *actual = [NSString stringWithUTF8String:message];
+    NSString *expected = [NSString stringWithUTF8String:tests[i].expected];
+    XCTAssertEqualObjects(actual, expected, @"Test named: '%s' failed", tests[i].name);
+  }
 }
 @end

FirebaseAnalytics.podspec

@@ -13,7 +13,7 @@ Pod::Spec.new do |s|
     s.authors          = 'Google, Inc.'
 
     s.source           = {
-        :http => 'https://dl.google.com/firebase/ios/analytics/f4ae251137d1f29b/FirebaseAnalytics-11.10.0.tar.gz'
+        :http => 'https://dl.google.com/firebase/ios/analytics/9b3638b3f6db3f4f/FirebaseAnalytics-11.11.0.tar.gz'
     }
 
     s.cocoapods_version = '>= 1.12.0'

FirebaseAuth/Sources/Swift/Auth/Auth.swift

@@ -2348,7 +2348,7 @@ extension Auth: AuthInterop {
 
   /// The configuration object comprising of parameters needed to make a request to Firebase
   ///   Auth's backend.
-  var requestConfiguration: AuthRequestConfiguration
+  let requestConfiguration: AuthRequestConfiguration
 
   let backend: AuthBackend
 

FirebaseVertexAI/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 11.11.0
+- [added] Emits a warning when attempting to use an incompatible model with
+  `GenerativeModel` or `ImagenModel`. (#14610)
+
 # 11.10.0
 - [feature] The Vertex AI SDK no longer requires `@preconcurrency` when imported in Swift 6.
 - [feature] The Vertex AI Sample App now includes an image generation example.
@@ -7,12 +11,12 @@
   are required. (#14558)
 
 # 11.9.0
-- [feature] **Public Preview**: Added support for generating images using the
-  Imagen 3 model.
+- [feature] **Public Preview**: Added support for
+  [generating images](https://firebase.google.com/docs/vertex-ai/generate-images-imagen?platform=ios)
+  using the Imagen 3 models.
   <br /><br />
-  Note: This feature is in Public Preview, which means that the it is not
-  subject to any SLA or deprecation policy and could change in
-  backwards-incompatible ways.
+  Note: This feature is in Public Preview, which means that it is not subject to
+  any SLA or deprecation policy and could change in backwards-incompatible ways.
 - [feature] Added support for modality-based token count. (#14406)
 
 # 11.6.0

FirebaseVertexAI/Sources/GenerativeModel.swift

@@ -20,6 +20,9 @@ import Foundation
 /// content based on various input types.
 @available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
 public final class GenerativeModel: Sendable {
+  /// Model name prefix to identify Gemini models.
+  static let geminiModelNamePrefix = "gemini-"
+
   /// The resource name of the model in the backend; has the format "models/model-name".
   let modelResourceName: String
 
@@ -50,7 +53,8 @@ public final class GenerativeModel: Sendable {
   /// Initializes a new remote model with the given parameters.
   ///
   /// - Parameters:
-  ///   - name: The name of the model to use, for example `"gemini-1.0-pro"`.
+  ///   - modelResourceName: The resource name of the model to use, for example
+  ///     `"projects/{project-id}/locations/{location-id}/publishers/google/models/{model-name}"`.
   ///   - firebaseInfo: Firebase data used by the SDK, including project ID and API key.
   ///   - apiConfig: Configuration for the backend API used by this model.
   ///   - generationConfig: The content generation parameters your model should use.
@@ -61,7 +65,7 @@ public final class GenerativeModel: Sendable {
   ///     only text content is supported.
   ///   - requestOptions: Configuration parameters for sending requests to the backend.
   ///   - urlSession: The `URLSession` to use for requests; defaults to `URLSession.shared`.
-  init(name: String,
+  init(modelResourceName: String,
        firebaseInfo: FirebaseInfo,
        apiConfig: APIConfig,
        generationConfig: GenerationConfig? = nil,
@@ -71,7 +75,7 @@ public final class GenerativeModel: Sendable {
        systemInstruction: ModelContent? = nil,
        requestOptions: RequestOptions,
        urlSession: URLSession = .shared) {
-    modelResourceName = name
+    self.modelResourceName = modelResourceName
     self.apiConfig = apiConfig
     generativeAIService = GenerativeAIService(
       firebaseInfo: firebaseInfo,
@@ -98,7 +102,7 @@ public final class GenerativeModel: Sendable {
       `\(VertexLog.enableArgumentKey)` as a launch argument in Xcode.
       """)
     }
-    VertexLog.debug(code: .generativeModelInitialized, "Model \(name) initialized.")
+    VertexLog.debug(code: .generativeModelInitialized, "Model \(modelResourceName) initialized.")
   }
 
   /// Generates content from String and/or image inputs, given to the model as a prompt, that are

FirebaseVertexAI/Sources/Types/Public/Imagen/ImagenModel.swift

@@ -28,6 +28,9 @@ import Foundation
 /// could change in backwards-incompatible ways.
 @available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
 public final class ImagenModel {
+  /// Model name prefix to identify Imagen models.
+  static let imagenModelNamePrefix = "imagen-"
+
   /// The resource name of the model in the backend; has the format "models/model-name".
   let modelResourceName: String
 
@@ -44,14 +47,14 @@ public final class ImagenModel {
   /// Configuration parameters for sending requests to the backend.
   let requestOptions: RequestOptions
 
-  init(name: String,
+  init(modelResourceName: String,
        firebaseInfo: FirebaseInfo,
        apiConfig: APIConfig,
        generationConfig: ImagenGenerationConfig?,
        safetySettings: ImagenSafetySettings?,
        requestOptions: RequestOptions,
        urlSession: URLSession = .shared) {
-    modelResourceName = name
+    self.modelResourceName = modelResourceName
     self.apiConfig = apiConfig
     generativeAIService = GenerativeAIService(
       firebaseInfo: firebaseInfo,

FirebaseVertexAI/Sources/VertexAI.swift

@@ -70,8 +70,15 @@ public class VertexAI {
                               systemInstruction: ModelContent? = nil,
                               requestOptions: RequestOptions = RequestOptions())
     -> GenerativeModel {
+    if !modelName.starts(with: GenerativeModel.geminiModelNamePrefix) {
+      VertexLog.warning(code: .unsupportedGeminiModel, """
+      Unsupported Gemini model "\(modelName)"; see \
+      https://firebase.google.com/docs/vertex-ai/models for a list supported Gemini model names.
+      """)
+    }
+
     return GenerativeModel(
-      name: modelResourceName(modelName: modelName),
+      modelResourceName: modelResourceName(modelName: modelName),
       firebaseInfo: firebaseInfo,
       apiConfig: apiConfig,
       generationConfig: generationConfig,
@@ -102,8 +109,15 @@ public class VertexAI {
   public func imagenModel(modelName: String, generationConfig: ImagenGenerationConfig? = nil,
                           safetySettings: ImagenSafetySettings? = nil,
                           requestOptions: RequestOptions = RequestOptions()) -> ImagenModel {
+    if !modelName.starts(with: ImagenModel.imagenModelNamePrefix) {
+      VertexLog.warning(code: .unsupportedImagenModel, """
+      Unsupported Imagen model "\(modelName)"; see \
+      https://firebase.google.com/docs/vertex-ai/models for a list supported Imagen model names.
+      """)
+    }
+
     return ImagenModel(
-      name: modelResourceName(modelName: modelName),
+      modelResourceName: modelResourceName(modelName: modelName),
       firebaseInfo: firebaseInfo,
       apiConfig: apiConfig,
       generationConfig: generationConfig,

FirebaseVertexAI/Sources/VertexLog.swift

@@ -33,8 +33,10 @@ enum VertexLog {
 
     // Generative Model Configuration
     case generativeModelInitialized = 1000
+    case unsupportedGeminiModel = 1001
 
     // Imagen Model Configuration
+    case unsupportedImagenModel = 1200
     case imagenInvalidJPEGCompressionQuality = 1201
 
     // Network Errors

FirebaseVertexAI/Tests/TestApp/Sources/FirebaseAppUtils.swift

@@ -0,0 +1,37 @@
+// Copyright 2025 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.
+
+import FirebaseCore
+
+extension FirebaseApp {
+  /// Configures a Firebase app with the specified name and Google Service Info plist file name.
+  ///
+  /// - Parameters:
+  ///   - appName: The Firebase app's name; see ``FirebaseAppNames`` for app names with special
+  ///     meanings in the TestApp.
+  ///   - plistName: The file name of the Google Service Info plist, excluding the file extension;
+  ///     for the default app this is typically called `GoogleService-Info` but any file name may be
+  ///     used for other apps.
+  static func configure(appName: String, plistName: String) {
+    assert(!plistName.hasSuffix(".plist"), "The .plist file extension must be omitted.")
+    guard let plistPath =
+      Bundle.main.path(forResource: plistName, ofType: "plist") else {
+      fatalError("The file '\(plistName).plist' was not found.")
+    }
+    guard let options = FirebaseOptions(contentsOfFile: plistPath) else {
+      fatalError("Failed to parse options from '\(plistName).plist'.")
+    }
+    FirebaseApp.configure(name: appName, options: options)
+  }
+}

FirebaseVertexAI/Tests/TestApp/Sources/TestApp.swift

@@ -24,15 +24,15 @@ struct TestApp: App {
     // Configure default Firebase App
     FirebaseApp.configure()
 
+    // Configure a Firebase App that is the same as the default app but without App Check.
+    // This is used for tests that should fail when App Check is not configured.
+    FirebaseApp.configure(
+      appName: FirebaseAppNames.appCheckNotConfigured,
+      plistName: "GoogleService-Info"
+    )
+
     // Configure a Firebase App without a billing account (i.e., the "Spark" plan).
-    guard let plistPath =
-      Bundle.main.path(forResource: "GoogleService-Info-Spark", ofType: "plist") else {
-      fatalError("The file 'GoogleService-Info-Spark.plist' was not found.")
-    }
-    guard let options = FirebaseOptions(contentsOfFile: plistPath) else {
-      fatalError("Failed to parse options from 'GoogleService-Info-Spark.plist'.")
-    }
-    FirebaseApp.configure(name: FirebaseAppNames.spark, options: options)
+    FirebaseApp.configure(appName: FirebaseAppNames.spark, plistName: "GoogleService-Info-Spark")
   }
 
   var body: some Scene {