Add support for testing in-app messages in SwiftUI previews (#8351)

* Expose most of the initializers for message metadata classes for use in unit testing or SwiftUI previews

* Fix import in FIRIAMFetchFlowTests

* Simplify UI test app to use now public initializers (doesn't build)

* Update public header to use stripped down message initializers that only include parameters that effect layout

* Fix nullability for body text in in-app message initializers, add helper methods for generating mock messages

* Remove default image for image-only convenience initializer

* Make initializers non optional, document force unwraps

* Finalize helper methods, update test project to use the preview helpers

* Update UI tests to use new initializers

* Revert Cocoapods related project changes

* Add copyright notices to new files

* Change target version of DefaultUI test app back to 10.0

* Add unit tests for

* Fix color that wasn't available on tvOS

* Udpdate CHANGELOG

* Update UI test app to 13.2 to avoid [DVTiPhoneSimulator -primaryInstrumentsServer was called from the main thread

* Update to target 13.2

* Revert "Update to target 13.2"

This reverts commit 8189b64.

* Revert "Update UI test app to 13.2 to avoid [DVTiPhoneSimulator -primaryInstrumentsServer was called from the main thread"

This reverts commit 2371ff2.

* Remove unnecessary ABTExperimentPayload import. Fix nullability of ABTExperimentPayload param in initializers

* Revert iOS target in project.pbxproj file

* Revert removals of references to GoogleService-Info.plist

* Let Xcode handle spacing in project file

Author: christibbs

FirebaseInAppMessaging/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 2021-7 -- v.8.3.0
+- [added] Added support for unit testing with in-app message data objects (#8351).
+- [added] Added support for prototyping custom in-app message views in SwiftUI (#8351).
+
 # 2021-6 -- v.8.2.0
 - [fixed] Fixed missing constraints warnings in default UI storyboard (#8205).
 

FirebaseInAppMessaging/Sources/Flows/FIRIAMDisplayExecutor.m

@@ -471,24 +471,22 @@ - (void)checkAndDisplayNextContextualMessageForAnalyticsEvent:(NSString *)eventN
   }
 
   FIRInAppMessagingCardDisplay *cardMessage = [[FIRInAppMessagingCardDisplay alloc]
-        initWithMessageID:renderData.messageID
-             campaignName:renderData.name
-        experimentPayload:definition.experimentPayload
-      renderAsTestMessage:definition.isTestMessage
-              triggerType:triggerType
-                titleText:title
-                textColor:renderData.renderingEffectSettings.textColor
-        portraitImageData:portraitImageData
-          backgroundColor:renderData.renderingEffectSettings.displayBGColor
-      primaryActionButton:primaryActionButton
-         primaryActionURL:definition.renderData.contentData.actionURL
-                  appData:definition.appData];
-
-  cardMessage.body = body;
-  cardMessage.landscapeImageData = landscapeImageData;
-  cardMessage.secondaryActionButton = secondaryActionButton;
-  cardMessage.secondaryActionURL = definition.renderData.contentData.secondaryActionURL;
-
+          initWithMessageID:renderData.messageID
+               campaignName:renderData.name
+          experimentPayload:definition.experimentPayload
+        renderAsTestMessage:definition.isTestMessage
+                triggerType:triggerType
+                  titleText:title
+                   bodyText:body
+                  textColor:renderData.renderingEffectSettings.textColor
+          portraitImageData:portraitImageData
+         landscapeImageData:landscapeImageData
+            backgroundColor:renderData.renderingEffectSettings.displayBGColor
+        primaryActionButton:primaryActionButton
+      secondaryActionButton:secondaryActionButton
+           primaryActionURL:definition.renderData.contentData.actionURL
+         secondaryActionURL:definition.renderData.contentData.secondaryActionURL
+                    appData:definition.appData];
   return cardMessage;
 }
 

FirebaseInAppMessaging/Sources/Public/FirebaseInAppMessaging/FIRInAppMessagingRendering.h

@@ -64,6 +64,12 @@ NS_SWIFT_NAME(InAppMessagingActionButton)
 /// Unavailable.
 - (instancetype)init NS_UNAVAILABLE;
 
+/// Exposed for unit testing only, or for use in SwiftUI previews. Don't instantiate this in your
+/// app directly.
+- (instancetype)initWithButtonText:(NSString *)buttonText
+                   buttonTextColor:(UIColor *)textColor
+                   backgroundColor:(UIColor *)backgroundColor;
+
 @end
 
 /** Contain display data for an image for a fiam message.
@@ -84,6 +90,10 @@ NS_SWIFT_NAME(InAppMessagingImageData)
 /// Unavailable.
 - (instancetype)init NS_UNAVAILABLE;
 
+/// Exposed for unit testing only, or for use in SwiftUI previews. Don't instantiate this in your
+/// app directly.
+- (instancetype)initWithImageURL:(NSString *)imageURL imageData:(NSData *)imageData;
+
 @end
 
 /** Defines the metadata for the campaign to which a FIAM message belongs.
@@ -128,7 +138,8 @@ NS_SWIFT_NAME(InAppMessagingAction)
 /// Unavailable.
 - (instancetype)init NS_UNAVAILABLE;
 
-/// This class should only be initialized from a custom in-app message UI component implementation.
+/// This class should only be initialized from a custom in-app message UI component implementation
+/// or in unit testing.
 - (instancetype)initWithActionText:(nullable NSString *)actionText
                          actionURL:(nullable NSURL *)actionURL;
 
@@ -229,6 +240,21 @@ NS_SWIFT_NAME(InAppMessagingCardDisplay)
 /// Unavailable.
 - (instancetype)init NS_UNAVAILABLE;
 
+/// Exposed for unit testing only, or for use in SwiftUI previews. Don't instantiate this in your
+/// app directly.
+- (instancetype)initWithCampaignName:(NSString *)campaignName
+                           titleText:(NSString *)title
+                            bodyText:(nullable NSString *)bodyText
+                           textColor:(UIColor *)textColor
+                   portraitImageData:(FIRInAppMessagingImageData *)portraitImageData
+                  landscapeImageData:(nullable FIRInAppMessagingImageData *)landscapeImageData
+                     backgroundColor:(UIColor *)backgroundColor
+                 primaryActionButton:(FIRInAppMessagingActionButton *)primaryActionButton
+               secondaryActionButton:(nullable FIRInAppMessagingActionButton *)secondaryActionButton
+                    primaryActionURL:(nullable NSURL *)primaryActionURL
+                  secondaryActionURL:(nullable NSURL *)secondaryActionURL
+                             appData:(nullable NSDictionary *)appData;
+
 @end
 
 /** Class for defining a modal message for display.
@@ -274,6 +300,18 @@ NS_SWIFT_NAME(InAppMessagingModalDisplay)
 /// Unavailable.
 - (instancetype)init NS_UNAVAILABLE;
 
+/// Exposed for unit testing only, or for use in SwiftUI previews. Don't instantiate this in your
+/// app directly.
+- (instancetype)initWithCampaignName:(NSString *)campaignName
+                           titleText:(NSString *)title
+                            bodyText:(nullable NSString *)bodyText
+                           textColor:(UIColor *)textColor
+                     backgroundColor:(UIColor *)backgroundColor
+                           imageData:(nullable FIRInAppMessagingImageData *)imageData
+                        actionButton:(nullable FIRInAppMessagingActionButton *)actionButton
+                           actionURL:(nullable NSURL *)actionURL
+                             appData:(nullable NSDictionary *)appData;
+
 @end
 
 /** Class for defining a banner message for display.
@@ -314,6 +352,17 @@ NS_SWIFT_NAME(InAppMessagingBannerDisplay)
 /// Unavailable.
 - (instancetype)init NS_UNAVAILABLE;
 
+/// Exposed for unit testing only, or for use in SwiftUI previews. Don't instantiate this in your
+/// app directly.
+- (instancetype)initWithCampaignName:(NSString *)campaignName
+                           titleText:(NSString *)title
+                            bodyText:(nullable NSString *)bodyText
+                           textColor:(UIColor *)textColor
+                     backgroundColor:(UIColor *)backgroundColor
+                           imageData:(nullable FIRInAppMessagingImageData *)imageData
+                           actionURL:(nullable NSURL *)actionURL
+                             appData:(nullable NSDictionary *)appData;
+
 @end
 
 /** Class for defining a image-only message for display.
@@ -334,6 +383,13 @@ NS_SWIFT_NAME(InAppMessagingImageOnlyDisplay)
 /// Unavailable.
 - (instancetype)init NS_UNAVAILABLE;
 
+/// Exposed for unit testing only, or for use in SwiftUI previews. Don't instantiate this in your
+/// app directly.
+- (instancetype)initWithCampaignName:(NSString *)campaignName
+                           imageData:(FIRInAppMessagingImageData *)imageData
+                           actionURL:(nullable NSURL *)actionURL
+                             appData:(nullable NSDictionary *)appData;
+
 @end
 
 /// The way that an in-app message was dismissed.