FIAM Programmatic triggers (#3081)

christibbs · web-flow · commit 93ebe6f9bf08 · 2019-05-28T13:42:06.000-04:00
* 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

* Add FIRIAMDisplayExecutor logic to display an in-app message programmatically.

* Add a public method on FIRInAppMessaging that triggers a message to be shown via the display executor

* Add button to test app that programmatically triggers a message

* Add unit tests for display executor programmatic trigger flow

* 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

* Run styles.sh, address some comments about logging

* Reuse analytic trigger method to show programmatic messages. Fix issue with overriding accessibility of card message params
diff --git a/Firebase/InAppMessaging/FIRInAppMessaging.m b/Firebase/InAppMessaging/FIRInAppMessaging.m
@@ -141,4 +141,9 @@ - (void)setMessageDisplayComponent:(id<FIRInAppMessagingDisplay>)messageDisplayC
       messageDisplayComponent;
 }
 
+- (void)triggerEvent:(NSString *)eventName {
+  [[FIRIAMRuntimeManager getSDKRuntimeInstance].displayExecutor
+      checkAndDisplayNextContextualMessageForAnalyticsEvent:eventName];
+}
+
 @end
diff --git a/Firebase/InAppMessaging/Public/FIRInAppMessaging.h b/Firebase/InAppMessaging/Public/FIRInAppMessaging.h
@@ -77,6 +77,11 @@ NS_SWIFT_NAME(InAppMessaging)
  */
 @property(nonatomic) id<FIRInAppMessagingDisplay> messageDisplayComponent;
 
+/**
+ * Directly requests an in-app message with the given trigger to be shown.
+ */
+- (void)triggerEvent:(NSString *)eventName;
+
 /**
  * This delegate should be set on the app side to receive message lifecycle events in app runtime.
  */
diff --git a/Firebase/InAppMessaging/RenderingObjects/FIRInAppMessagingRenderingDataClasses.m b/Firebase/InAppMessaging/RenderingObjects/FIRInAppMessagingRenderingDataClasses.m
@@ -38,6 +38,22 @@ - (instancetype)initWithMessageID:(NSString *)messageID
 
 @implementation FIRInAppMessagingCardDisplay
 
+- (void)setBody:(NSString *_Nullable)body {
+  _body = body;
+}
+
+- (void)setLandscapeImageData:(FIRInAppMessagingImageData *_Nullable)landscapeImageData {
+  _landscapeImageData = landscapeImageData;
+}
+
+- (void)setSecondaryActionButton:(FIRInAppMessagingActionButton *_Nullable)secondaryActionButton {
+  _secondaryActionButton = secondaryActionButton;
+}
+
+- (void)setSecondaryActionURL:(NSURL *_Nullable)secondaryActionURL {
+  _secondaryActionURL = secondaryActionURL;
+}
+
 - (instancetype)initWithMessageID:(NSString *)messageID
                      campaignName:(NSString *)campaignName
               renderAsTestMessage:(BOOL)renderAsTestMessage
diff --git a/Firebase/InAppMessaging/RenderingObjects/FIRInAppMessagingRenderingPrivate.h b/Firebase/InAppMessaging/RenderingObjects/FIRInAppMessagingRenderingPrivate.h
@@ -18,10 +18,10 @@ NS_ASSUME_NONNULL_BEGIN
 
 @interface FIRInAppMessagingCardDisplay (Private)
 
-@property(nonatomic, nullable, copy, readwrite) NSString *body;
-@property(nonatomic, nullable, copy, readwrite) FIRInAppMessagingImageData *landscapeImageData;
-@property(nonatomic, nullable, readwrite) FIRInAppMessagingActionButton *secondaryActionButton;
-@property(nonatomic, nullable, readwrite) NSURL *secondaryActionURL;
+- (void)setBody:(NSString *_Nullable)body;
+- (void)setLandscapeImageData:(FIRInAppMessagingImageData *_Nullable)landscapeImageData;
+- (void)setSecondaryActionButton:(FIRInAppMessagingActionButton *_Nullable)secondaryActionButton;
+- (void)setSecondaryActionURL:(NSURL *_Nullable)secondaryActionURL;
 
 - (instancetype)initWithMessageID:(NSString *)messageID
                      campaignName:(NSString *)campaignName
diff --git a/InAppMessaging/Example/App/InAppMessaging-Example-iOS/AutoDisplayFlowViewController.m b/InAppMessaging/Example/App/InAppMessaging-Example-iOS/AutoDisplayFlowViewController.m
@@ -42,6 +42,7 @@ @interface AutoDisplayFlowViewController ()
 @property(weak, nonatomic) IBOutlet UITextField *autoDisplayIntervalText;
 @property(weak, nonatomic) IBOutlet UITextField *autoFetchIntervalText;
 @property(weak, nonatomic) IBOutlet UITextField *eventNameText;
+@property(weak, nonatomic) IBOutlet UITextField *programmaticTriggerNameText;
 @property(nonatomic) FIRIAMRuntimeManager *sdkRuntime;
 @property(weak, nonatomic) IBOutlet UIButton *disableEnableSDKBtn;
 @property(weak, nonatomic) IBOutlet UIButton *changeDataCollectionBtn;
@@ -77,6 +78,12 @@ - (IBAction)triggerAnalyticEventTapped:(id)sender {
   [FIRAnalytics logEventWithName:self.eventNameText.text parameters:@{}];
 }
 
+- (IBAction)triggerProgrammaticallyTapped:(id)sender {
+  NSLog(@"Trigger event %@ programmatically", self.eventNameText.text);
+
+  [[FIRInAppMessaging inAppMessaging] triggerEvent:self.programmaticTriggerNameText.text];
+}
+
 - (void)touchesBegan:(NSSet *)touches withEvent:(UIEvent *)event {
   UITouch *touch = [touches anyObject];
   if (![touch.view isMemberOfClass:[UITextField class]]) {
diff --git a/InAppMessaging/Example/App/InAppMessaging-Example-iOS/Base.lproj/Main.storyboard b/InAppMessaging/Example/App/InAppMessaging-Example-iOS/Base.lproj/Main.storyboard
@@ -1,13 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="14113" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" colorMatched="YES" initialViewController="Ebq-cZ-Ywc">
+<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="14490.70" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" colorMatched="YES" initialViewController="Ebq-cZ-Ywc">
     <device id="retina4_7" orientation="portrait">
         <adaptation id="fullscreen"/>
     </device>
     <dependencies>
         <deployment identifier="iOS"/>
-        <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="14088"/>
-        <capability name="Constraints to layout margins" minToolsVersion="6.0"/>
-        <capability name="Constraints with non-1.0 multipliers" minToolsVersion="5.1"/>
+        <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="14490.49"/>
         <capability name="documents saved in the Xcode 8 format" minToolsVersion="8.0"/>
     </dependencies>
     <scenes>
@@ -24,13 +22,13 @@
                         <autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/>
                         <subviews>
                             <containerView opaque="NO" contentMode="scaleToFill" translatesAutoresizingMaskIntoConstraints="NO" id="Nbf-aL-D4Q">
-                                <rect key="frame" x="0.0" y="320.5" width="375" height="287.5"/>
+                                <rect key="frame" x="0.0" y="370.5" width="375" height="237.5"/>
                                 <connections>
                                     <segue destination="PsL-F0-NPD" kind="embed" identifier="message-table-segue" id="Ruf-dB-QUH"/>
                                 </connections>
                             </containerView>
                             <label opaque="NO" userInteractionEnabled="NO" contentMode="left" horizontalHuggingPriority="251" verticalHuggingPriority="251" text="Messages To Display" textAlignment="center" lineBreakMode="tailTruncation" baselineAdjustment="alignBaselines" adjustsFontSizeToFit="NO" translatesAutoresizingMaskIntoConstraints="NO" id="2lf-ei-PaY">
-                                <rect key="frame" x="0.0" y="292" width="375" height="20.5"/>
+                                <rect key="frame" x="0.0" y="342" width="375" height="20.5"/>
                                 <fontDescription key="fontDescription" type="system" pointSize="17"/>
                                 <nil key="textColor"/>
                                 <nil key="highlightedColor"/>
@@ -49,14 +47,6 @@
                                     <constraint firstAttribute="height" constant="2" id="qn7-el-C36"/>
                                 </constraints>
                             </view>
-                            <button opaque="NO" contentMode="scaleToFill" horizontalHuggingPriority="251" contentHorizontalAlignment="center" contentVerticalAlignment="center" buttonType="roundedRect" lineBreakMode="middleTruncation" translatesAutoresizingMaskIntoConstraints="NO" id="TWl-ic-ODQ">
-                                <rect key="frame" x="14" y="247" width="138" height="30"/>
-                                <fontDescription key="fontDescription" type="system" pointSize="13"/>
-                                <state key="normal" title="Trigger analytics event"/>
-                                <connections>
-                                    <action selector="triggerAnalyticEventTapped:" destination="pEd-Cp-eSk" eventType="touchUpInside" id="IEI-K3-ihJ"/>
-                                </connections>
-                            </button>
                             <view contentMode="scaleToFill" translatesAutoresizingMaskIntoConstraints="NO" id="3kb-Du-qxH" userLabel="Top Half View">
                                 <rect key="frame" x="0.0" y="40" width="375" height="190"/>
                                 <subviews>
@@ -97,7 +87,7 @@
                                         <nil key="highlightedColor"/>
                                     </label>
                                     <button opaque="NO" contentMode="scaleToFill" contentHorizontalAlignment="center" contentVerticalAlignment="center" buttonType="roundedRect" lineBreakMode="middleTruncation" translatesAutoresizingMaskIntoConstraints="NO" id="ZUt-bH-BSp">
-                                        <rect key="frame" x="10" y="90" width="355" height="28"/>
+                                        <rect key="frame" x="10" y="89.5" width="355" height="28"/>
                                         <fontDescription key="fontDescription" type="system" pointSize="13"/>
                                         <state key="normal" title="Apply Displa/Fetch Frequency Change"/>
                                         <connections>
@@ -171,19 +161,44 @@
                                     <constraint firstItem="Erp-ss-RqT" firstAttribute="leading" secondItem="3kb-Du-qxH" secondAttribute="leading" constant="10" id="yst-Bp-eIN"/>
                                 </constraints>
                             </view>
+                            <button opaque="NO" contentMode="scaleToFill" horizontalHuggingPriority="251" contentHorizontalAlignment="center" contentVerticalAlignment="center" buttonType="roundedRect" lineBreakMode="middleTruncation" translatesAutoresizingMaskIntoConstraints="NO" id="TWl-ic-ODQ">
+                                <rect key="frame" x="14" y="247" width="138" height="30"/>
+                                <fontDescription key="fontDescription" type="system" pointSize="13"/>
+                                <state key="normal" title="Trigger analytics event"/>
+                                <connections>
+                                    <action selector="triggerAnalyticEventTapped:" destination="pEd-Cp-eSk" eventType="touchUpInside" id="IEI-K3-ihJ"/>
+                                </connections>
+                            </button>
                             <textField opaque="NO" contentMode="scaleToFill" contentHorizontalAlignment="left" contentVerticalAlignment="center" text="test_event" borderStyle="roundedRect" textAlignment="natural" minimumFontSize="17" translatesAutoresizingMaskIntoConstraints="NO" id="M0T-f0-qfn">
                                 <rect key="frame" x="182" y="247" width="173" height="30"/>
                                 <nil key="textColor"/>
                                 <fontDescription key="fontDescription" type="system" pointSize="13"/>
                                 <textInputTraits key="textInputTraits"/>
                             </textField>
+                            <button opaque="NO" contentMode="scaleToFill" horizontalHuggingPriority="251" contentHorizontalAlignment="center" contentVerticalAlignment="center" buttonType="roundedRect" lineBreakMode="middleTruncation" translatesAutoresizingMaskIntoConstraints="NO" id="PA9-qD-Z5X">
+                                <rect key="frame" x="14" y="287" width="152" height="30"/>
+                                <fontDescription key="fontDescription" type="system" pointSize="13"/>
+                                <state key="normal" title="Trigger programmatically"/>
+                                <connections>
+                                    <action selector="triggerAnalyticEventTapped:" destination="pEd-Cp-eSk" eventType="touchUpInside" id="74T-tl-wdH"/>
+                                    <action selector="triggerProgrammaticallyTapped:" destination="pEd-Cp-eSk" eventType="touchUpInside" id="jPY-TA-aJN"/>
+                                </connections>
+                            </button>
+                            <textField opaque="NO" contentMode="scaleToFill" contentHorizontalAlignment="left" contentVerticalAlignment="center" text="test_trigger" borderStyle="roundedRect" textAlignment="natural" minimumFontSize="17" translatesAutoresizingMaskIntoConstraints="NO" id="Qzz-aW-vHr">
+                                <rect key="frame" x="196" y="287" width="159" height="30"/>
+                                <nil key="textColor"/>
+                                <fontDescription key="fontDescription" type="system" pointSize="13"/>
+                                <textInputTraits key="textInputTraits"/>
+                            </textField>
                         </subviews>
                         <color key="backgroundColor" white="1" alpha="1" colorSpace="calibratedWhite"/>
                         <constraints>
                             <constraint firstItem="2lf-ei-PaY" firstAttribute="leading" secondItem="27y-ro-ncL" secondAttribute="leading" id="0g2-Zm-MAm"/>
                             <constraint firstItem="FB6-Ej-jmi" firstAttribute="top" secondItem="3kb-Du-qxH" secondAttribute="bottom" constant="5" id="19L-XJ-rNE"/>
                             <constraint firstAttribute="trailing" secondItem="2lf-ei-PaY" secondAttribute="trailing" id="2sG-IE-v1C"/>
+                            <constraint firstItem="PA9-qD-Z5X" firstAttribute="top" secondItem="TWl-ic-ODQ" secondAttribute="bottom" constant="10" id="3d8-nF-Yf8"/>
                             <constraint firstAttribute="trailing" secondItem="Nbf-aL-D4Q" secondAttribute="trailing" id="3nJ-jP-296"/>
+                            <constraint firstAttribute="trailing" secondItem="Qzz-aW-vHr" secondAttribute="trailing" constant="20" id="56F-2K-y7M"/>
                             <constraint firstItem="M0T-f0-qfn" firstAttribute="bottom" secondItem="TWl-ic-ODQ" secondAttribute="bottom" id="68L-bx-rfi"/>
                             <constraint firstItem="QzN-45-brV" firstAttribute="leading" secondItem="Nbf-aL-D4Q" secondAttribute="leading" id="68c-cK-w0l"/>
                             <constraint firstItem="QzN-45-brV" firstAttribute="top" secondItem="Nbf-aL-D4Q" secondAttribute="bottom" constant="10" id="CCo-W9-Nwb"/>
@@ -195,13 +210,17 @@
                             <constraint firstItem="3kb-Du-qxH" firstAttribute="centerX" secondItem="27y-ro-ncL" secondAttribute="centerX" id="Um3-SX-kub"/>
                             <constraint firstItem="TWl-ic-ODQ" firstAttribute="top" secondItem="FB6-Ej-jmi" secondAttribute="bottom" constant="10" id="YYp-3Y-QXH"/>
                             <constraint firstItem="FB6-Ej-jmi" firstAttribute="width" secondItem="27y-ro-ncL" secondAttribute="width" id="aGR-qE-35f"/>
+                            <constraint firstItem="Qzz-aW-vHr" firstAttribute="top" secondItem="PA9-qD-Z5X" secondAttribute="top" id="btv-LV-CyU"/>
                             <constraint firstAttribute="trailing" secondItem="M0T-f0-qfn" secondAttribute="trailing" constant="20" id="cHW-QJ-D5z"/>
+                            <constraint firstItem="PA9-qD-Z5X" firstAttribute="leading" secondItem="TWl-ic-ODQ" secondAttribute="leading" id="f4g-bo-YSa"/>
+                            <constraint firstItem="Qzz-aW-vHr" firstAttribute="leading" secondItem="PA9-qD-Z5X" secondAttribute="trailing" constant="30" id="gAn-fn-Xoj"/>
                             <constraint firstItem="M0T-f0-qfn" firstAttribute="top" secondItem="TWl-ic-ODQ" secondAttribute="top" id="hHq-ch-Cw9"/>
                             <constraint firstItem="fcu-KV-0co" firstAttribute="top" secondItem="Nbf-aL-D4Q" secondAttribute="bottom" constant="10" id="iF9-YE-7Bh"/>
                             <constraint firstItem="M0T-f0-qfn" firstAttribute="leading" secondItem="TWl-ic-ODQ" secondAttribute="trailing" constant="30" id="oK4-kd-ngD"/>
                             <constraint firstItem="QzN-45-brV" firstAttribute="trailing" secondItem="Nbf-aL-D4Q" secondAttribute="trailing" id="ore-FG-3Z5"/>
+                            <constraint firstItem="Qzz-aW-vHr" firstAttribute="bottom" secondItem="PA9-qD-Z5X" secondAttribute="bottom" id="qZw-4h-RVV"/>
                             <constraint firstItem="Nbf-aL-D4Q" firstAttribute="leading" secondItem="27y-ro-ncL" secondAttribute="leading" id="rHM-kR-Ebu"/>
-                            <constraint firstItem="2lf-ei-PaY" firstAttribute="top" secondItem="FB6-Ej-jmi" secondAttribute="bottom" constant="55" id="xhl-Hf-WDB"/>
+                            <constraint firstItem="2lf-ei-PaY" firstAttribute="top" secondItem="FB6-Ej-jmi" secondAttribute="bottom" constant="105" id="xhl-Hf-WDB"/>
                             <constraint firstItem="TWl-ic-ODQ" firstAttribute="leading" secondItem="27y-ro-ncL" secondAttribute="leading" constant="14" id="zTT-qI-tld"/>
                         </constraints>
                     </view>
@@ -212,11 +231,12 @@
                         <outlet property="changeDataCollectionBtn" destination="KCx-gs-cUi" id="MWc-Kk-IWX"/>
                         <outlet property="disableEnableSDKBtn" destination="nUy-hl-LzV" id="Sm9-9g-Uc5"/>
                         <outlet property="eventNameText" destination="M0T-f0-qfn" id="PJw-AR-bWa"/>
+                        <outlet property="programmaticTriggerNameText" destination="Qzz-aW-vHr" id="FaS-3C-yYa"/>
                     </connections>
                 </viewController>
                 <placeholder placeholderIdentifier="IBFirstResponder" id="1YW-qT-fHJ" userLabel="First Responder" sceneMemberID="firstResponder"/>
             </objects>
-            <point key="canvasLocation" x="339.13043478260875" y="1420.108695652174"/>
+            <point key="canvasLocation" x="338.39999999999998" y="1419.9400299850076"/>
         </scene>
         <!--Viewing Logs-->
         <scene sceneID="1fw-sb-9xA">
@@ -327,7 +347,7 @@
             <objects>
                 <tableViewController id="PsL-F0-NPD" customClass="AutoDisplayMesagesTableVC" sceneMemberID="viewController">
                     <tableView key="view" clipsSubviews="YES" contentMode="scaleToFill" alwaysBounceVertical="YES" dataMode="prototypes" style="plain" separatorStyle="default" rowHeight="44" sectionHeaderHeight="28" sectionFooterHeight="28" id="qfr-gm-4ZH">
-                        <rect key="frame" x="0.0" y="0.0" width="375" height="287.5"/>
+                        <rect key="frame" x="0.0" y="0.0" width="375" height="237.5"/>
                         <autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/>
                         <color key="backgroundColor" white="1" alpha="1" colorSpace="calibratedWhite"/>
                         <prototypes>

Original file line number	Diff line number	Diff line change
`@@ -141,4 +141,9 @@ - (void)setMessageDisplayComponent:(id<FIRInAppMessagingDisplay>)messageDisplayC`
`141`	`141`	`messageDisplayComponent;`
`142`	`142`	`}`
`143`	`143`
	`144`	`+- (void)triggerEvent:(NSString *)eventName {`
	`145`	`+ [[FIRIAMRuntimeManager getSDKRuntimeInstance].displayExecutor`
	`146`	`+ checkAndDisplayNextContextualMessageForAnalyticsEvent:eventName];`
	`147`	`+}`
	`148`	`+`
`144`	`149`	`@end`