[FIAM] Remove FIR prefix from enums and prefer `NS_ERROR_ENUM` (#13089)

FirebaseInAppMessaging.podspec

@@ -89,7 +89,10 @@ See more product details at https://firebase.google.com/products/in-app-messagin
 
   s.test_spec 'unit' do |unit_tests|
       unit_tests.scheme = { :code_coverage => true }
-      unit_tests.source_files = 'FirebaseInAppMessaging/Tests/Unit/*.[mh]'
+      unit_tests.source_files = [
+        'FirebaseInAppMessaging/Tests/Unit/*.[mh]',
+        'FirebaseInAppMessaging/Swift/Tests/Unit/*.swift'
+      ]
       unit_tests.resources = 'FirebaseInAppMessaging/Tests/Unit/*.txt'
       unit_tests.requires_app_host = true
       unit_tests.dependency 'OCMock'

FirebaseInAppMessaging/CHANGELOG.md

@@ -3,6 +3,14 @@
   module has been removed. See
   https://firebase.google.com/docs/ios/swift-migration for migration
   instructions.
+- [changed] **Breaking Change**: The following Swift API have been renamed:
+  - `FIRInAppMessagingDismissType` → `InAppMessagingDismissType`
+  - `FIRInAppMessagingDisplayMessageType` → `InAppMessagingDisplayMessageType`
+  - `FIRInAppMessagingDisplayTriggerType` → `InAppMessagingDisplayTriggerType`
+  - `FIAMDisplayRenderErrorType` → `InAppMessagingDisplayRenderError`
+  Note that `InAppMessagingDisplayRenderError` is now a native Swift error and
+  can be directly caught (instead of catching an `NSError` and checking the
+  error code).
 
 # 10.27.0
 - [fixed] Fixed crash at app start that affected CocoaPods users using static

FirebaseInAppMessaging/Sources/Data/FIRIAMMessageContentDataWithImageURL.m

@@ -22,6 +22,7 @@
 #import "FirebaseInAppMessaging/Sources/FIRCore+InAppMessaging.h"
 #import "FirebaseInAppMessaging/Sources/Private/Data/FIRIAMMessageContentData.h"
 #import "FirebaseInAppMessaging/Sources/Private/Data/FIRIAMMessageContentDataWithImageURL.h"
+#import "FirebaseInAppMessaging/Sources/Public/FirebaseInAppMessaging/FIRInAppMessagingErrors.h"
 #import "FirebaseInAppMessaging/Sources/Runtime/FIRIAMSDKRuntimeErrorCodes.h"
 
 static NSInteger const SuccessHTTPStatusCode = 200;
@@ -170,7 +171,7 @@ static NSInteger const SuccessHTTPStatusCode = 200;
                   FIRLogWarning(kFIRLoggerInAppMessaging, @"I-IAM000004", @"%@", errorDesc);
 
                   NSError *error =
-                      [NSError errorWithDomain:kFirebaseInAppMessagingErrorDomain
+                      [NSError errorWithDomain:FIRInAppMessagingErrorDomain
                                           code:FIRIAMSDKRuntimeErrorNonImageMimetypeFromImageURL
                                       userInfo:@{NSLocalizedDescriptionKey : errorDesc}];
                   block(nil, error);

FirebaseInAppMessaging/Sources/FIRCore+InAppMessaging.h

@@ -23,9 +23,6 @@
 // this should eventually be in FIRLogger.h
 extern FIRLoggerService kFIRLoggerInAppMessaging;
 
-// this should eventually be in FIRError.h
-extern NSString *const kFirebaseInAppMessagingErrorDomain;
-
 // InAppMessaging doesn't provide any functionality to other components,
 // so it provides a private, empty protocol that it conforms to and use it for registration.
 

FirebaseInAppMessaging/Sources/FIRCore+InAppMessaging.m

@@ -20,7 +20,6 @@
 #import <Foundation/Foundation.h>
 #import "FirebaseInAppMessaging/Sources/FIRCore+InAppMessaging.h"
 
-NSString *const kFirebaseInAppMessagingErrorDomain = @"com.firebase.inappmessaging";
 FIRLoggerService kFIRLoggerInAppMessaging = @"[FirebaseInAppMessaging]";
 
 #endif  // TARGET_OS_IOS || TARGET_OS_TV || TARGET_OS_VISION

FirebaseInAppMessaging/Sources/FIRInAppMessagingErrors.m

@@ -0,0 +1,21 @@
+/*
+ * Copyright 2024 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 <Foundation/Foundation.h>
+
+#import "FirebaseInAppMessaging/Sources/Public/FirebaseInAppMessaging/FIRInAppMessagingErrors.h"
+
+NSErrorDomain const FIRInAppMessagingErrorDomain = @"com.firebase.inappmessaging";

FirebaseInAppMessaging/Sources/Flows/FIRIAMClientInfoFetcher.m

@@ -48,7 +48,7 @@
   if (!self.installations) {
     NSString *errorDesc = @"Couldn't generate Firebase Installation info";
     FIRLogDebug(kFIRLoggerInAppMessaging, @"I-IAM190010", @"%@", errorDesc);
-    NSError *error = [NSError errorWithDomain:kFirebaseInAppMessagingErrorDomain
+    NSError *error = [NSError errorWithDomain:FIRInAppMessagingErrorDomain
                                          code:FIRIAMSDKRuntimeErrorNoFirebaseInstallationsObject
                                      userInfo:@{NSLocalizedDescriptionKey : errorDesc}];
     completion(nil, nil, error);

FirebaseInAppMessaging/Sources/Flows/FIRIAMMsgFetcherUsingRestful.m

@@ -203,7 +203,7 @@ static NSInteger const SuccessHTTPStatusCode = 200;
                         @"Failed to recognize the fiam messages in the server response";
                     FIRLogWarning(kFIRLoggerInAppMessaging, @"I-IAM130011", @"%@", errorDesc);
                     NSError *error =
-                        [NSError errorWithDomain:kFirebaseInAppMessagingErrorDomain
+                        [NSError errorWithDomain:FIRInAppMessagingErrorDomain
                                             code:0
                                         userInfo:@{NSLocalizedDescriptionKey : errorDesc}];
                     completion(nil, nil, 0, error);
@@ -227,7 +227,7 @@ static NSInteger const SuccessHTTPStatusCode = 200;
               NSString *errorDesc = @"Got a non http response type from fetch endpoint";
               FIRLogWarning(kFIRLoggerInAppMessaging, @"I-IAM130005", @"%@", errorDesc);
 
-              NSError *error = [NSError errorWithDomain:kFirebaseInAppMessagingErrorDomain
+              NSError *error = [NSError errorWithDomain:FIRInAppMessagingErrorDomain
                                                    code:0
                                                userInfo:@{NSLocalizedDescriptionKey : errorDesc}];
               completion(nil, nil, 0, error);
@@ -240,7 +240,7 @@ static NSInteger const SuccessHTTPStatusCode = 200;
         @"Internal error: NSURLSessionDataTask failed to be created due to possibly "
          "incorrect parameters";
     FIRLogWarning(kFIRLoggerInAppMessaging, @"I-IAM130006", @"%@", errorDesc);
-    NSError *error = [NSError errorWithDomain:kFirebaseInAppMessagingErrorDomain
+    NSError *error = [NSError errorWithDomain:FIRInAppMessagingErrorDomain
                                          code:0
                                      userInfo:@{NSLocalizedDescriptionKey : errorDesc}];
     completion(nil, nil, 0, error);

FirebaseInAppMessaging/Sources/Public/FirebaseInAppMessaging/FIRInAppMessagingErrors.h

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2024 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 <Foundation/Foundation.h>
+
+/// Firebase In App Messaging error domain.
+FOUNDATION_EXTERN NSErrorDomain const FIRInAppMessagingErrorDomain NS_SWIFT_NAME(InAppMessagingErrorDomain);

FirebaseInAppMessaging/Sources/Public/FirebaseInAppMessaging/FIRInAppMessagingRendering.h

@@ -16,6 +16,8 @@
 
 #import <Foundation/Foundation.h>
 
+#import "FIRInAppMessagingErrors.h"
+
 @class UIColor;
 
 NS_ASSUME_NONNULL_BEGIN
@@ -31,7 +33,7 @@ typedef NS_ENUM(NSInteger, FIRInAppMessagingDisplayMessageType) {
   FIRInAppMessagingDisplayMessageTypeImageOnly,
   /// Card style.
   FIRInAppMessagingDisplayMessageTypeCard
-} API_UNAVAILABLE(macos, watchos);
+} NS_SWIFT_NAME(InAppMessagingDisplayMessageType) API_UNAVAILABLE(macos, watchos);
 
 /// Represents how an in-app message should be triggered to appear.  This enum is unavailable on
 /// macOS, macOS Catalyst, and watchOS.
@@ -40,7 +42,7 @@ typedef NS_ENUM(NSInteger, FIRInAppMessagingDisplayTriggerType) {
   FIRInAppMessagingDisplayTriggerTypeOnAppForeground,
   /// Triggered from an analytics event being fired.
   FIRInAppMessagingDisplayTriggerTypeOnAnalyticsEvent
-} API_UNAVAILABLE(macos, watchos);
+} NS_SWIFT_NAME(InAppMessagingDisplayTriggerType) API_UNAVAILABLE(macos, watchos);
 
 /** Contains the display information for an action button.  This class is unavailable on macOS,
  * macOS Catalyst, and watchOS.
@@ -436,16 +438,16 @@ typedef NS_ENUM(NSInteger, FIRInAppMessagingDismissType) {
   FIRInAppMessagingDismissTypeAuto,
   /// Dismiss method unknown.
   FIRInAppMessagingDismissUnspecified,
-} API_UNAVAILABLE(macos, watchos);
+} NS_SWIFT_NAME(InAppMessagingDismissType) API_UNAVAILABLE(macos, watchos);
 
 /// Error code for an in-app message that failed to display.
 /// This enum is unavailable on macOS, macOS Catalyst, and watchOS.
-typedef NS_ENUM(NSInteger, FIAMDisplayRenderErrorType) {
-  /// The image data for this in-app message is invalid.
-  FIAMDisplayRenderErrorTypeImageDataInvalid,
-  /// Unexpected error.
-  FIAMDisplayRenderErrorTypeUnspecifiedError,
-} API_UNAVAILABLE(macos, watchos);
+typedef NS_ERROR_ENUM(FIRInAppMessagingErrorDomain, FIAMDisplayRenderErrorType){
+    /// The image data for this in-app message is invalid.
+    FIAMDisplayRenderErrorTypeImageDataInvalid,
+    /// Unexpected error.
+    FIAMDisplayRenderErrorTypeUnspecifiedError,
+} NS_SWIFT_NAME(InAppMessagingDisplayRenderError) API_UNAVAILABLE(macos, watchos);
 
 /**
  * A protocol defining those callbacks to be triggered by the message display component

FirebaseInAppMessaging/Sources/Public/FirebaseInAppMessaging/FirebaseInAppMessaging.h

@@ -15,6 +15,7 @@
  */
 
 #import "FIRInAppMessaging.h"
+#import "FIRInAppMessagingErrors.h"
 #import "FIRInAppMessagingRendering.h"
 
 #if __has_include(<FirebaseInAppMessagingDisplay/FirebaseInAppMessagingDisplay.h>)

FirebaseInAppMessaging/Sources/Runtime/FIRInAppMessaging+Bootstrap.m

@@ -28,6 +28,7 @@
 #import "FirebaseInAppMessaging/Sources/Private/Runtime/FIRIAMRuntimeManager.h"
 #import "FirebaseInAppMessaging/Sources/Private/Runtime/FIRIAMSDKSettings.h"
 #import "FirebaseInAppMessaging/Sources/Private/Util/NSString+FIRInterlaceStrings.h"
+#import "FirebaseInAppMessaging/Sources/Public/FirebaseInAppMessaging/FIRInAppMessagingErrors.h"
 
 @implementation FIRInAppMessaging (Bootstrap)
 
@@ -57,7 +58,7 @@ static NSString *_fiamServerHostName = @"firebaseinappmessaging.googleapis.com";
 
   if (!options.GCMSenderID.length) {
     error =
-        [NSError errorWithDomain:kFirebaseInAppMessagingErrorDomain
+        [NSError errorWithDomain:FIRInAppMessagingErrorDomain
                             code:0
                         userInfo:@{
                           NSLocalizedDescriptionKey : @"Google Sender ID must not be nil or empty."
@@ -68,7 +69,7 @@ static NSString *_fiamServerHostName = @"firebaseinappmessaging.googleapis.com";
 
   if (!options.APIKey.length) {
     error = [NSError
-        errorWithDomain:kFirebaseInAppMessagingErrorDomain
+        errorWithDomain:FIRInAppMessagingErrorDomain
                    code:0
                userInfo:@{NSLocalizedDescriptionKey : @"API key must not be nil or empty."}];
 
@@ -77,7 +78,7 @@ static NSString *_fiamServerHostName = @"firebaseinappmessaging.googleapis.com";
 
   if (!options.googleAppID.length) {
     error =
-        [NSError errorWithDomain:kFirebaseInAppMessagingErrorDomain
+        [NSError errorWithDomain:FIRInAppMessagingErrorDomain
                             code:0
                         userInfo:@{NSLocalizedDescriptionKey : @"Google App ID must not be nil."}];
     [self exitAppWithFatalError:error];
@@ -130,7 +131,7 @@ static NSString *_fiamServerHostName = @"firebaseinappmessaging.googleapis.com";
 }
 
 + (void)exitAppWithFatalError:(NSError *)error {
-  [NSException raise:kFirebaseInAppMessagingErrorDomain
+  [NSException raise:FIRInAppMessagingErrorDomain
               format:@"Error happened %@", error.localizedDescription];
 }
 

FirebaseInAppMessaging/Swift/Source/CustomInAppMessageDisplayViewModifier.swift

@@ -205,7 +205,7 @@ class DelegateBridge: NSObject, InAppMessagingDisplay, InAppMessagingDisplayDele
   }
 
   func messageDismissed(_ inAppMessage: InAppMessagingDisplayMessage,
-                        dismissType: FIRInAppMessagingDismissType) {
+                        dismissType: InAppMessagingDismissType) {
     DispatchQueue.main.async {
       self.inAppMessageData = nil
     }

FirebaseInAppMessaging/Swift/Tests/Unit/FirebaseInAppMessaging_APIBuildTests.swift

@@ -18,9 +18,18 @@ import FirebaseInAppMessaging
 import SwiftUI
 
 final class FirebaseInAppMessaging_APIBuildTests: XCTestCase {
+  func throwError() throws {}
+
   func usage() throws {
     let inAppMessaging = FirebaseInAppMessaging.InAppMessaging.inAppMessaging()
 
+    let _: String = InAppMessagingErrorDomain
+
+    do {
+      try throwError() // Call a throwing method to suppress warnings.
+    } catch InAppMessagingDisplayRenderError.imageDataInvalid {
+    } catch InAppMessagingDisplayRenderError.unspecifiedError {}
+
     let _: Bool = inAppMessaging.messageDisplaySuppressed
     inAppMessaging.messageDisplaySuppressed = true
 
@@ -60,9 +69,8 @@ final class FirebaseInAppMessaging_APIBuildTests: XCTestCase {
     let _: UIColor = button.buttonTextColor
     let _: UIColor = button.buttonBackgroundColor
 
-    // TODO(ncooke3): This type should not have a `FIR` prefix.
-    _ = FirebaseInAppMessaging.FIRInAppMessagingDisplayMessageType.RawValue()
-    let messsageType: FirebaseInAppMessaging.FIRInAppMessagingDisplayMessageType! = nil
+    _ = FirebaseInAppMessaging.InAppMessagingDisplayMessageType.RawValue()
+    let messsageType: FirebaseInAppMessaging.InAppMessagingDisplayMessageType! = nil
     switch messsageType! {
     case .modal: break
     case .banner: break
@@ -71,18 +79,8 @@ final class FirebaseInAppMessaging_APIBuildTests: XCTestCase {
     @unknown default: break
     }
 
-    // TODO(ncooke3): This type should not have a `FIR` prefix.
-    _ = FirebaseInAppMessaging.FIAMDisplayRenderErrorType.RawValue()
-    let errorType: FirebaseInAppMessaging.FIAMDisplayRenderErrorType! = nil
-    switch errorType! {
-    case .imageDataInvalid: break
-    case .unspecifiedError: break
-    @unknown default: break
-    }
-
-    // TODO(ncooke3): This type should not have a `FIR` prefix.
-    _ = FirebaseInAppMessaging.FIRInAppMessagingDismissType.RawValue()
-    let dismissType: FirebaseInAppMessaging.FIRInAppMessagingDismissType! = nil
+    _ = FirebaseInAppMessaging.InAppMessagingDismissType.RawValue()
+    let dismissType: FirebaseInAppMessaging.InAppMessagingDismissType! = nil
     switch dismissType! {
     case .typeUserSwipe: break
     case .typeUserTapClose: break
@@ -91,9 +89,8 @@ final class FirebaseInAppMessaging_APIBuildTests: XCTestCase {
     @unknown default: break
     }
 
-    // TODO(ncooke3): This type should not have a `FIR` prefix.
-    _ = FirebaseInAppMessaging.FIRInAppMessagingDisplayTriggerType.RawValue()
-    let triggerType: FirebaseInAppMessaging.FIRInAppMessagingDisplayTriggerType! = nil
+    _ = FirebaseInAppMessaging.InAppMessagingDisplayTriggerType.RawValue()
+    let triggerType: FirebaseInAppMessaging.InAppMessagingDisplayTriggerType! = nil
     switch triggerType! {
     case .onAppForeground: break
     case .onAnalyticsEvent: break
@@ -167,8 +164,8 @@ final class FirebaseInAppMessaging_APIBuildTests: XCTestCase {
       triggerType: triggerType
     )
     let _: FirebaseInAppMessaging.InAppMessagingCampaignInfo = displayMessage.campaignInfo
-    let _: FirebaseInAppMessaging.FIRInAppMessagingDisplayMessageType = displayMessage.type
-    let _: FirebaseInAppMessaging.FIRInAppMessagingDisplayTriggerType = displayMessage.triggerType
+    let _: FirebaseInAppMessaging.InAppMessagingDisplayMessageType = displayMessage.type
+    let _: FirebaseInAppMessaging.InAppMessagingDisplayTriggerType = displayMessage.triggerType
     let _: [AnyHashable: Any]? = displayMessage.appData
 
     let imageOnlyDisplay = FirebaseInAppMessaging.InAppMessagingImageOnlyDisplay(

FirebaseInAppMessaging/Tests/Integration/DefaultUITestApp/FiamDisplaySwiftExample/BannerMessageViewController.swift

@@ -46,7 +46,7 @@ class BannerMessageViewController: CommonMessageTestVC {
   }
 
   override func messageDismissed(_ inAppMessage: InAppMessagingDisplayMessage,
-                                 dismissType: FIRInAppMessagingDismissType) {
+                                 dismissType: InAppMessagingDismissType) {
     super.messageDismissed(inAppMessage, dismissType: dismissType)
     verifyLabel.text = "message dismissed!"
   }

FirebaseInAppMessaging/Tests/Integration/DefaultUITestApp/FiamDisplaySwiftExample/CardMessageViewController.swift

@@ -50,7 +50,7 @@ class CardMessageViewController: CommonMessageTestVC {
   }
 
   override func messageDismissed(_ inAppMessage: InAppMessagingDisplayMessage,
-                                 dismissType: FIRInAppMessagingDismissType) {
+                                 dismissType: InAppMessagingDismissType) {
     super.messageDismissed(inAppMessage, dismissType: dismissType)
     verifyLabel.text = "message dismissed!"
   }

FirebaseInAppMessaging/Tests/Integration/DefaultUITestApp/FiamDisplaySwiftExample/CommonMessageTestVC.swift

@@ -37,7 +37,7 @@ class CommonMessageTestVC: UIViewController, InAppMessagingDisplayDelegate {
   }
 
   func messageDismissed(_ inAppMessage: InAppMessagingDisplayMessage,
-                        dismissType: FIRInAppMessagingDismissType) {
+                        dismissType: InAppMessagingDismissType) {
     print("message dismissed with type \(dismissType)")
     messageClosedDismiss = true
   }

FirebaseInAppMessaging/Tests/Integration/DefaultUITestApp/FiamDisplaySwiftExample/ImageOnlyMessageViewController.swift

@@ -35,7 +35,7 @@ class ImageOnlyMessageViewController: CommonMessageTestVC {
   }
 
   override func messageDismissed(_ inAppMessage: InAppMessagingDisplayMessage,
-                                 dismissType: FIRInAppMessagingDismissType) {
+                                 dismissType: InAppMessagingDismissType) {
     super.messageDismissed(inAppMessage, dismissType: dismissType)
     verifyLabel.text = "message dismissed!"
   }

FirebaseInAppMessaging/Tests/Integration/DefaultUITestApp/FiamDisplaySwiftExample/ModalMessageViewController.swift

@@ -48,7 +48,7 @@ class ModalMessageViewController: CommonMessageTestVC {
   }
 
   override func messageDismissed(_ inAppMessage: InAppMessagingDisplayMessage,
-                                 dismissType: FIRInAppMessagingDismissType) {
+                                 dismissType: InAppMessagingDismissType) {
     super.messageDismissed(inAppMessage, dismissType: dismissType)
     verifyLabel.text = "message dismissed!"
   }