Support card template display in FIAM iOS SDK (#2947)

* Add card scene to storyboard, use IBDesignable rounded corners view

* Use IBdesignable rounded corners view for modal message

* Add card message type

* Parse card message type, add new fields for secondary actions and landscape URLs to view model classes

* Display a really basic card message

* Naive landscape image loading (needs error handling)

* Quick bug fix

* Wire up Display to show cards

* Wire up Display to show cards

* Fix tablet width

* Pick right image for orientation

* Remove placeholder image sizing constraints at build time

* Add more test functionality

* Better image sizes

* Size message image out

* Switch to body text view rather than body label

* Make the body text view scrollable. Set correct text color on button.

* Hook up buttons and text color

* Include action URL in messageClicked callback

* Fix action URL

* Update pod specs

* Update message clicked delegate to pass an action object, not just the actionURL

* Change podspec versions back, hook up background color

* Don't animate scroll to top on scroll view

* Fix text scrolling bug

* Fix portrait and landscape fetching code. Fix background color bug

* Flesh out FIRIAMMessageContentDataWithImageURLTests

* Fix up FIRIAMFetchFlowTests

* Fix up FIRIAMMessageClientCacheTests

* Fix up FIRIAMMessageDisplayForTesting

* Fix fetching in FIRIAMMessageContentDataWithImageURL

* Tests for message parsing

* Fix up view controllers for banner, modal, image only. Add a view controller for testing card

* Add required vertical compression resistance for primary and secondary action button

* Add UI tests for card view controller

* Add back deprecated messageClicked: method, call it if the newer method isn't implemented. Make all display delegate methods optional.

* Run scripts/styles.sh

* Documentation cleanup

* Fix style in FIRIAMMessageContentDataWithImageURLTests.m

* Add missing copyright notices

* Bump versions of both FIAM SDKS

* Remove default.profraw

* Address some logging punctuation nits. Cancel landscape image load if portrait image load fails.

* Add missing error flow in image fetch. A few comment nits.

* Shorten up init method for CardDisplayMessage

* Documentation updates

* Deintegrate cocoa pods

* Include landscape image data in test image load class

* Fix Swift naming for InAppMessagingAction in UItests

* Remove card message initializer from public API, place into a private header

* Mark some properties on the card object as readonly that should've been already, Find a way to initialize a card message in the UI tests.

* Bump dependency on InAppMessaging given changes

* Bump versions in podspecs for both SDKs

* Make all view model properties for message subclasses readonly

* Revert changes to other message subclasses

* Make card view model properties readonly

* Run styles.sh

Author: christibbs

Firebase/InAppMessaging/Data/FIRIAMFetchResponseParser.m

@@ -178,12 +178,16 @@ - (FIRIAMMessageDefinition *)convertToMessageDefinitionWithMessageDict:(NSDictio
 
     NSDictionary *content = (NSDictionary *)contentNode;
     FIRIAMRenderingMode mode;
-    UIColor *viewCardBackgroundColor, *btnBgColor, *btnTxtColor, *titleTextColor;
+    UIColor *viewCardBackgroundColor, *btnBgColor, *btnTxtColor, *secondaryBtnTxtColor,
+        *titleTextColor;
     viewCardBackgroundColor = btnBgColor = btnTxtColor = titleTextColor = nil;
 
-    NSString *title, *body, *imageURLStr, *actionURLStr, *actionButtonText;
-    title = body = imageURLStr = actionButtonText = actionURLStr = nil;
+    NSString *title, *body, *imageURLStr, *landscapeImageURLStr, *actionURLStr,
+        *secondaryActionURLStr, *actionButtonText, *secondaryActionButtonText;
+    title = body = imageURLStr = landscapeImageURLStr = actionButtonText =
+        secondaryActionButtonText = actionURLStr = secondaryActionURLStr = nil;
 
+    // TODO: Refactor this giant if-else block into separate parsing methods per message type.
     if ([content[@"banner"] isKindOfClass:[NSDictionary class]]) {
       NSDictionary *bannerNode = (NSDictionary *)contentNode[@"banner"];
       mode = FIRIAMRenderAsBannerView;
@@ -227,6 +231,30 @@ - (FIRIAMMessageDefinition *)convertToMessageDefinitionWithMessageDict:(NSDictio
         return nil;
       }
       actionURLStr = imageOnlyNode[@"action"][@"actionUrl"];
+    } else if ([content[@"card"] isKindOfClass:[NSDictionary class]]) {
+      mode = FIRIAMRenderAsCardView;
+      NSDictionary *cardNode = (NSDictionary *)contentNode[@"card"];
+      title = cardNode[@"title"][@"text"];
+      titleTextColor = [UIColor firiam_colorWithHexString:cardNode[@"title"][@"hexColor"]];
+
+      body = cardNode[@"body"][@"text"];
+
+      imageURLStr = cardNode[@"portraitImageUrl"];
+      landscapeImageURLStr = cardNode[@"landscapeImageUrl"];
+
+      viewCardBackgroundColor = [UIColor firiam_colorWithHexString:cardNode[@"backgroundHexColor"]];
+
+      actionButtonText = cardNode[@"primaryActionButton"][@"text"][@"text"];
+      btnTxtColor = [UIColor
+          firiam_colorWithHexString:cardNode[@"primaryActionButton"][@"text"][@"hexColor"]];
+
+      secondaryActionButtonText = cardNode[@"secondaryActionButton"][@"text"][@"text"];
+      secondaryBtnTxtColor = [UIColor
+          firiam_colorWithHexString:cardNode[@"secondaryActionButton"][@"text"][@"hexColor"]];
+
+      actionURLStr = cardNode[@"primaryAction"][@"actionUrl"];
+      secondaryActionURLStr = cardNode[@"secondaryAction"][@"actionUrl"];
+
     } else {
       // Unknown message type
       FIRLogWarning(kFIRLoggerInAppMessaging, @"I-IAM900003",
@@ -241,7 +269,11 @@ - (FIRIAMMessageDefinition *)convertToMessageDefinitionWithMessageDict:(NSDictio
     }
 
     NSURL *imageURL = (imageURLStr.length == 0) ? nil : [NSURL URLWithString:imageURLStr];
+    NSURL *landscapeImageURL =
+        (landscapeImageURLStr.length == 0) ? nil : [NSURL URLWithString:landscapeImageURLStr];
     NSURL *actionURL = (actionURLStr.length == 0) ? nil : [NSURL URLWithString:actionURLStr];
+    NSURL *secondaryActionURL =
+        (secondaryActionURLStr.length == 0) ? nil : [NSURL URLWithString:secondaryActionURLStr];
     FIRIAMRenderingEffectSetting *renderEffect =
         [FIRIAMRenderingEffectSetting getDefaultRenderingEffectSetting];
     renderEffect.viewMode = mode;
@@ -258,6 +290,10 @@ - (FIRIAMMessageDefinition *)convertToMessageDefinitionWithMessageDict:(NSDictio
       renderEffect.btnTextColor = btnTxtColor;
     }
 
+    if (secondaryBtnTxtColor) {
+      renderEffect.secondaryActionBtnTextColor = secondaryBtnTxtColor;
+    }
+
     if (titleTextColor) {
       renderEffect.textColor = titleTextColor;
     }
@@ -284,8 +320,11 @@ - (FIRIAMMessageDefinition *)convertToMessageDefinitionWithMessageDict:(NSDictio
         [[FIRIAMMessageContentDataWithImageURL alloc] initWithMessageTitle:title
                                                                messageBody:body
                                                           actionButtonText:actionButtonText
+                                                 secondaryActionButtonText:secondaryActionButtonText
                                                                  actionURL:actionURL
+                                                        secondaryActionURL:secondaryActionURL
                                                                   imageURL:imageURL
+                                                         landscapeImageURL:landscapeImageURL
                                                            usingURLSession:nil];
 
     FIRIAMMessageRenderData *renderData =

Firebase/InAppMessaging/Data/FIRIAMMessageContentData.h

@@ -24,16 +24,24 @@ NS_ASSUME_NONNULL_BEGIN
 @property(nonatomic, readonly, nonnull) NSString *titleText;
 @property(nonatomic, readonly, nonnull) NSString *bodyText;
 @property(nonatomic, readonly, nullable) NSString *actionButtonText;
+@property(nonatomic, readonly, nullable) NSString *secondaryActionButtonText;
 @property(nonatomic, readonly, nullable) NSURL *actionURL;
+@property(nonatomic, readonly, nullable) NSURL *secondaryActionURL;
 @property(nonatomic, readonly, nullable) NSURL *imageURL;
+@property(nonatomic, readonly, nullable) NSURL *landscapeImageURL;
 
-// Load image data and report the result in the callback block.
-// Expect these cases in the callback block
-// If error happens, error parameter will be non-nil.
-// If no error happens and imageData parameter is nil, it indicates the case that there
-// is no image assoicated with the message.
-// If error is nil and imageData is not nil, then the image data is loaded successfully
+// Load image data, which can potentially have two images (one for landscape display). If only
+// one image URL exists, that image is loaded and its data is passed in the callback block.
+//
+// If both standard and landscape URLs exist, then both images are fetched asynchronously. If the
+// standard image fails to load, an error will be returned in the callback block and both image data
+// slots will be empty.
+// If only the landscape image fails to load, the standard image will be returned in the callback
+// block and the error will be nil.
+// If no error happens and the imageData parameter is nil, it indicates the case that there is no
+// image associated with the message.
 - (void)loadImageDataWithBlock:(void (^)(NSData *_Nullable imageData,
+                                         NSData *_Nullable landscapeImageData,
                                          NSError *_Nullable error))block;
 
 // convert to a description string of the content

Firebase/InAppMessaging/Data/FIRIAMMessageContentDataWithImageURL.h

@@ -40,8 +40,11 @@ NS_ASSUME_NONNULL_BEGIN
 - (instancetype)initWithMessageTitle:(NSString *)title
                          messageBody:(NSString *)body
                     actionButtonText:(nullable NSString *)actionButtonText
+           secondaryActionButtonText:(nullable NSString *)secondaryActionButtonText
                            actionURL:(nullable NSURL *)actionURL
+                  secondaryActionURL:(nullable NSURL *)secondaryActionURL
                             imageURL:(nullable NSURL *)imageURL
+                   landscapeImageURL:(nullable NSURL *)landscapeImageURL
                      usingURLSession:(nullable NSURLSession *)URLSession;
 @end
 NS_ASSUME_NONNULL_END

Firebase/InAppMessaging/Data/FIRIAMMessageContentDataWithImageURL.m

@@ -28,24 +28,33 @@ @interface FIRIAMMessageContentDataWithImageURL ()
 @property(nonatomic, readwrite, nonnull, copy) NSString *titleText;
 @property(nonatomic, readwrite, nonnull, copy) NSString *bodyText;
 @property(nonatomic, copy, nullable) NSString *actionButtonText;
+@property(nonatomic, copy, nullable) NSString *secondaryActionButtonText;
 @property(nonatomic, copy, nullable) NSURL *actionURL;
+@property(nonatomic, copy, nullable) NSURL *secondaryActionURL;
 @property(nonatomic, nullable, copy) NSURL *imageURL;
+@property(nonatomic, nullable, copy) NSURL *landscapeImageURL;
 @property(readonly) NSURLSession *URLSession;
 @end
 
 @implementation FIRIAMMessageContentDataWithImageURL
 - (instancetype)initWithMessageTitle:(NSString *)title
                          messageBody:(NSString *)body
                     actionButtonText:(nullable NSString *)actionButtonText
+           secondaryActionButtonText:(nullable NSString *)secondaryActionButtonText
                            actionURL:(nullable NSURL *)actionURL
+                  secondaryActionURL:(nullable NSURL *)secondaryActionURL
                             imageURL:(nullable NSURL *)imageURL
+                   landscapeImageURL:(nullable NSURL *)landscapeImageURL
                      usingURLSession:(nullable NSURLSession *)URLSession {
   if (self = [super init]) {
     _titleText = title;
     _bodyText = body;
     _imageURL = imageURL;
+    _landscapeImageURL = landscapeImageURL;
     _actionButtonText = actionButtonText;
+    _secondaryActionButtonText = secondaryActionButtonText;
     _actionURL = actionURL;
+    _secondaryActionURL = secondaryActionURL;
 
     if (imageURL) {
       _URLSession = URLSession ? URLSession : [NSURLSession sharedSession];
@@ -74,65 +83,123 @@ - (nullable NSString *)getActionButtonText {
   return _actionButtonText;
 }
 
-- (void)loadImageDataWithBlock:(void (^)(NSData *_Nullable imageData,
+- (void)loadImageDataWithBlock:(void (^)(NSData *_Nullable standardImageData,
+                                         NSData *_Nullable landscapeImageData,
                                          NSError *_Nullable error))block {
   if (!block) {
     // no need for any further action if block is nil
     return;
   }
 
-  if (!_imageURL) {
+  if (!_imageURL && !_landscapeImageURL) {
     // no image data since image url is nil
-    block(nil, nil);
+    block(nil, nil, nil);
+  } else if (!_landscapeImageURL) {
+    // Only fetch standard image.
+    [self fetchImageFromURL:_imageURL
+                  withBlock:^(NSData *_Nullable imageData, NSError *_Nullable error) {
+                    block(imageData, nil, error);
+                  }];
+  } else if (!_imageURL) {
+    // Only fetch portrait image.
+    [self fetchImageFromURL:_landscapeImageURL
+                  withBlock:^(NSData *_Nullable imageData, NSError *_Nullable error) {
+                    block(nil, imageData, error);
+                  }];
   } else {
-    NSURLRequest *imageDataRequest = [NSURLRequest requestWithURL:_imageURL];
-    NSURLSessionDataTask *task = [_URLSession
-        dataTaskWithRequest:imageDataRequest
-          completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
-            if (error) {
-              FIRLogWarning(kFIRLoggerInAppMessaging, @"I-IAM000003",
-                            @"Error in fetching image: %@", error);
-              block(nil, error);
-            } else {
-              if ([response isKindOfClass:[NSHTTPURLResponse class]]) {
-                NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *)response;
-                if (httpResponse.statusCode == SuccessHTTPStatusCode) {
-                  if (httpResponse.MIMEType == nil || ![httpResponse.MIMEType hasPrefix:@"image"]) {
-                    NSString *errorDesc =
-                        [NSString stringWithFormat:@"None image MIME type %@"
-                                                    " detected for url %@",
-                                                   httpResponse.MIMEType, self.imageURL];
-                    FIRLogWarning(kFIRLoggerInAppMessaging, @"I-IAM000004", @"%@", errorDesc);
-
-                    NSError *error =
-                        [NSError errorWithDomain:kFirebaseInAppMessagingErrorDomain
-                                            code:FIRIAMSDKRuntimeErrorNonImageMimetypeFromImageURL
-                                        userInfo:@{NSLocalizedDescriptionKey : errorDesc}];
-                    block(nil, error);
-                  } else {
-                    block(data, nil);
-                  }
-                } else {
+    // Fetch both images separately, call completion when they're both fetched.
+    __block NSData *portrait = nil;
+    __block NSData *landscape = nil;
+    __block NSError *landscapeImageLoadError = nil;
+
+    [self fetchImageFromURL:_imageURL
+                  withBlock:^(NSData *_Nullable imageData, NSError *_Nullable error) {
+                    __weak FIRIAMMessageContentDataWithImageURL *weakSelf = self;
+
+                    // If the portrait image fails to load, we treat this as a failure.
+                    if (error) {
+                      // Cancel landscape image fetch.
+                      [weakSelf.URLSession invalidateAndCancel];
+
+                      block(nil, nil, error);
+                      return;
+                    }
+
+                    portrait = imageData;
+                    if (landscape || landscapeImageLoadError) {
+                      block(portrait, landscape, nil);
+                    }
+                  }];
+
+    [self fetchImageFromURL:_landscapeImageURL
+                  withBlock:^(NSData *_Nullable imageData, NSError *_Nullable error) {
+                    if (error) {
+                      landscapeImageLoadError = error;
+                    } else {
+                      landscape = imageData;
+                    }
+
+                    if (portrait) {
+                      block(portrait, landscape, nil);
+                    }
+                  }];
+  }
+}
+
+- (void)fetchImageFromURL:(NSURL *)imageURL
+                withBlock:(void (^)(NSData *_Nullable imageData, NSError *_Nullable error))block {
+  NSURLRequest *imageDataRequest = [NSURLRequest requestWithURL:imageURL];
+  NSURLSessionDataTask *task = [_URLSession
+      dataTaskWithRequest:imageDataRequest
+        completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
+          if (error) {
+            FIRLogWarning(kFIRLoggerInAppMessaging, @"I-IAM000003", @"Error in fetching image: %@",
+                          error);
+            block(nil, error);
+          } else {
+            if ([response isKindOfClass:[NSHTTPURLResponse class]]) {
+              NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *)response;
+              if (httpResponse.statusCode == SuccessHTTPStatusCode) {
+                if (httpResponse.MIMEType == nil || ![httpResponse.MIMEType hasPrefix:@"image"]) {
                   NSString *errorDesc =
-                      [NSString stringWithFormat:@"Failed HTTP request to crawl image %@: "
-                                                  "HTTP status code as %ld",
-                                                 self->_imageURL, (long)httpResponse.statusCode];
-                  FIRLogWarning(kFIRLoggerInAppMessaging, @"I-IAM000001", @"%@", errorDesc);
+                      [NSString stringWithFormat:@"No image MIME type %@"
+                                                  " detected for URL %@",
+                                                 httpResponse.MIMEType, self.imageURL];
+                  FIRLogWarning(kFIRLoggerInAppMessaging, @"I-IAM000004", @"%@", errorDesc);
+
                   NSError *error =
-                      [NSError errorWithDomain:NSURLErrorDomain
-                                          code:httpResponse.statusCode
+                      [NSError errorWithDomain:kFirebaseInAppMessagingErrorDomain
+                                          code:FIRIAMSDKRuntimeErrorNonImageMimetypeFromImageURL
                                       userInfo:@{NSLocalizedDescriptionKey : errorDesc}];
                   block(nil, error);
+                } else {
+                  block(data, nil);
                 }
               } else {
-                FIRLogWarning(kFIRLoggerInAppMessaging, @"I-IAM000002",
-                              @"Internal error: got a non http response from fetching image for "
-                              @"image url as %@",
-                              self->_imageURL);
+                NSString *errorDesc =
+                    [NSString stringWithFormat:@"Failed HTTP request to crawl image %@: "
+                                                "HTTP status code as %ld",
+                                               self->_imageURL, (long)httpResponse.statusCode];
+                FIRLogWarning(kFIRLoggerInAppMessaging, @"I-IAM000001", @"%@", errorDesc);
+                NSError *error = [NSError errorWithDomain:NSURLErrorDomain
+                                                     code:httpResponse.statusCode
+                                                 userInfo:@{NSLocalizedDescriptionKey : errorDesc}];
+                block(nil, error);
               }
+            } else {
+              NSString *errorDesc =
+                  [NSString stringWithFormat:@"Internal error: got a non HTTP response from "
+                                             @"fetching image for image URL as %@",
+                                             imageURL];
+              FIRLogWarning(kFIRLoggerInAppMessaging, @"I-IAM000002", @"%@", errorDesc);
+              NSError *error = [NSError errorWithDomain:NSURLErrorDomain
+                                                   code:FIRIAMSDKRuntimeErrorNonHTTPResponseForImage
+                                               userInfo:@{NSLocalizedDescriptionKey : errorDesc}];
+              block(nil, error);
             }
-          }];
-    [task resume];
-  }
+          }
+        }];
+  [task resume];
 }
+
 @end

Firebase/InAppMessaging/Data/FIRIAMRenderingEffectSetting.h

@@ -22,7 +22,8 @@ NS_ASSUME_NONNULL_BEGIN
 typedef NS_ENUM(NSInteger, FIRIAMRenderingMode) {
   FIRIAMRenderAsBannerView,
   FIRIAMRenderAsModalView,
-  FIRIAMRenderAsImageOnlyView
+  FIRIAMRenderAsImageOnlyView,
+  FIRIAMRenderAsCardView
 };
 
 /**
@@ -42,6 +43,9 @@ typedef NS_ENUM(NSInteger, FIRIAMRenderingMode) {
 // text color for action button
 @property(nonatomic, copy) UIColor *btnTextColor;
 
+// text color for secondary action button
+@property(nonatomic, copy) UIColor *secondaryActionBtnTextColor;
+
 // background color for action button
 @property(nonatomic, copy) UIColor *btnBGColor;