Support in-app messaging on tvOS apps (#7160)

* Unlock tvOS for in-app messaging. Podspec needs refactoring

* Remove trailing whitespace

* Remove trailing whitespace

* Fix whitespace

* Add tvOS tests to GHA

* Add TARGET_OS_TV to endifs. Get rid of another pre iOS10 URL open check

* Fix yml for GHA

* Don't build default UI sample app on tvOS

* Better logging for nil message display component in tvOS

* Silence archiving deprecation warnings

* Lower tvOS support target

Author: christibbs

.github/workflows/inappmessaging.yml

@@ -66,13 +66,14 @@ jobs:
           '--use-static-frameworks',
           '--use-libraries'
         ]
+        platform: [ios, tvos]
     needs: pod_lib_lint
     steps:
     - uses: actions/checkout@v2
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: PodLibLint InAppMessaging Cron
-      run: scripts/third_party/travis/retry.sh scripts/pod_lib_lint.rb FirebaseInAppMessaging.podspec --platforms=ios ${{ matrix.flags }}
+      run: scripts/third_party/travis/retry.sh scripts/pod_lib_lint.rb FirebaseInAppMessaging.podspec --platforms=${{ matrix.platform }} ${{ matrix.flags }}
 
   quickstart:
     # Don't run on private repo unless it is a PR.

FIRInAppMessageDisplayStoryboardTV.storyboard

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<document type="com.apple.InterfaceBuilder.AppleTV.Storyboard" version="3.0" toolsVersion="13142" targetRuntime="AppleTV" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" useSafeAreas="YES" colorMatched="YES">
+    <dependencies>
+        <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="12042"/>
+    </dependencies>
+    <scenes/>
+</document>

FirebaseInAppMessaging.podspec

@@ -18,23 +18,59 @@ See more product details at https://firebase.google.com/products/in-app-messagin
   }
   s.social_media_url = 'https://twitter.com/Firebase'
   s.ios.deployment_target = '10.0'
+  s.tvos.deployment_target = '13.0'
 
   s.cocoapods_version = '>= 1.4.0'
   s.prefix_header_file = false
 
   base_dir = "FirebaseInAppMessaging/"
-  s.source_files = [
-    base_dir + "Sources/**/*.[cmh]",
+  s.ios.source_files = [
+    base_dir + "Sources/*.[cmh]",
+	base_dir + "Sources/Analytics/**/*.[cmh]",
+	base_dir + "Sources/Data/**/*.[cmh]",
+	base_dir + "Sources/DefaultUI/**/*.[cmh]",
+	base_dir + "Sources/DisplayTrigger/**/*.[cmh]",
+	base_dir + "Sources/Flows/**/*.[cmh]",
+	base_dir + "Sources/Private/**/*.[cmh]",
+	base_dir + "Sources/Public/**/*.[cmh]",
+	base_dir + "Sources/RenderingObjects/**/*.[cmh]",
+	base_dir + "Sources/Runtime/**/*.[cmh]",
+	base_dir + "Sources/Util/**/*.[cmh]",
     'Interop/Analytics/Public/*.h',
     'FirebaseABTesting/Sources/Private/*.h',
     'FirebaseCore/Sources/Private/*.h',
     'FirebaseInstallations/Source/Library/Private/*.h',
   ]
+
+  s.tvos.source_files = [
+    base_dir + "Sources/*.[cmh]",
+	base_dir + "Sources/Analytics/**/*.[cmh]",
+	base_dir + "Sources/Data/**/*.[cmh]",
+	base_dir + "Sources/DisplayTrigger/**/*.[cmh]",
+	base_dir + "Sources/Flows/**/*.[cmh]",
+	base_dir + "Sources/Private/**/*.[cmh]",
+	base_dir + "Sources/Public/**/*.[cmh]",
+	base_dir + "Sources/RenderingObjects/**/*.[cmh]",
+	base_dir + "Sources/Runtime/**/*.[cmh]",
+	base_dir + "Sources/Util/**/*.[cmh]",
+    'Interop/Analytics/Public/*.h',
+    'FirebaseABTesting/Sources/Private/*.h',
+    'FirebaseCore/Sources/Private/*.h',
+    'FirebaseInstallations/Source/Library/Private/*.h',
+  ]
+
   s.public_header_files = base_dir + 'Sources/Public/FirebaseInAppMessaging/*.h'
 
-  s.resource_bundles = {
+  s.ios.resource_bundles = {
     'InAppMessagingDisplayResources' => [
-       base_dir + 'Resources/*.storyboard',
+       base_dir + 'Resources/FIRInAppMessageDisplayStoryboard.storyboard',
+       base_dir + 'Resources/*.png'
+     ]
+  }
+
+  s.tvos.resource_bundles = {
+    'InAppMessagingDisplayResources' => [
+       base_dir + 'Resources/FIRInAppMessageDisplayStoryboardTV.storyboard',
        base_dir + 'Resources/*.png'
      ]
   }
@@ -58,5 +94,4 @@ See more product details at https://firebase.google.com/products/in-app-messagin
       unit_tests.requires_app_host = true
       unit_tests.dependency 'OCMock'
    end
-
-end
+end

FirebaseInAppMessaging/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 2021-01 -- v7.4.0
+- [added] Added support for custom in-app messages in tvOS (#7160).
+
 # 2020-12 -- v7.3.0
 - [fixed] Fixed default display bug in apps that don't use `UISceneDelegate` (#6803).
 

FirebaseInAppMessaging/Sources/Analytics/FIRIAMAnalyticsEventLoggerImpl.m

@@ -15,7 +15,7 @@
  */
 
 #import <TargetConditionals.h>
-#if TARGET_OS_IOS
+#if TARGET_OS_IOS || TARGET_OS_TV
 
 #import "FirebaseInAppMessaging/Sources/Analytics/FIRIAMAnalyticsEventLoggerImpl.h"
 
@@ -172,4 +172,4 @@ - (void)logAnalyticsEventForType:(FIRIAMAnalyticsLogEventType)eventType
 }
 @end
 
-#endif  // TARGET_OS_IOS
+#endif  // TARGET_OS_IOS || TARGET_OS_TV

FirebaseInAppMessaging/Sources/Analytics/FIRIAMClearcutHttpRequestSender.m

@@ -15,7 +15,7 @@
  */
 
 #import <TargetConditionals.h>
-#if TARGET_OS_IOS
+#if TARGET_OS_IOS || TARGET_OS_TV
 
 #import "FirebaseCore/Sources/Private/FirebaseCoreInternal.h"
 
@@ -204,4 +204,4 @@ - (void)sendClearcutHttpRequestForLogs:(NSArray<FIRIAMClearcutLogRecord *> *)log
 }
 @end
 
-#endif  // TARGET_OS_IOS
+#endif  // TARGET_OS_IOS || TARGET_OS_TV

FirebaseInAppMessaging/Sources/Analytics/FIRIAMClearcutLogStorage.m

@@ -15,7 +15,7 @@
  */
 
 #import <TargetConditionals.h>
-#if TARGET_OS_IOS
+#if TARGET_OS_IOS || TARGET_OS_TV
 
 #import <UIKit/UIKit.h>
 
@@ -166,7 +166,10 @@ - (void)loadFromCachePath:(NSString *)cacheFilePath {
   NSString *filePath = cacheFilePath == nil ? [self.class determineCacheFilePath] : cacheFilePath;
 
   NSTimeInterval start = [self.timeFetcher currentTimestampInSeconds];
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
   id fetchedClearcutRetryRecords = [NSKeyedUnarchiver unarchiveObjectWithFile:filePath];
+#pragma clang diagnostic pop
   if (fetchedClearcutRetryRecords) {
     @synchronized(self) {
       self.records = (NSMutableArray<FIRIAMClearcutLogRecord *> *)fetchedClearcutRetryRecords;
@@ -180,7 +183,10 @@ - (void)loadFromCachePath:(NSString *)cacheFilePath {
 - (BOOL)saveIntoCacheWithPath:(NSString *)cacheFilePath {
   NSString *filePath = cacheFilePath == nil ? [self.class determineCacheFilePath] : cacheFilePath;
   @synchronized(self) {
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
     BOOL saveResult = [NSKeyedArchiver archiveRootObject:self.records toFile:filePath];
+#pragma clang diagnostic pop
     FIRLogDebug(kFIRLoggerInAppMessaging, @"I-IAM230003",
                 @"Saving %d clearcut log records into file is %@", (int)self.records.count,
                 saveResult ? @"successful" : @"failure");
@@ -190,4 +196,4 @@ - (BOOL)saveIntoCacheWithPath:(NSString *)cacheFilePath {
 }
 @end
 
-#endif  // TARGET_OS_IOS
+#endif  // TARGET_OS_IOS || TARGET_OS_TV

FirebaseInAppMessaging/Sources/Analytics/FIRIAMClearcutLogger.m

@@ -15,7 +15,7 @@
  */
 
 #import <TargetConditionals.h>
-#if TARGET_OS_IOS
+#if TARGET_OS_IOS || TARGET_OS_TV
 
 #import "FirebaseCore/Sources/Private/FirebaseCoreInternal.h"
 
@@ -214,4 +214,4 @@ - (void)logAnalyticsEventForType:(FIRIAMAnalyticsLogEventType)eventType
 }
 @end
 
-#endif  // TARGET_OS_IOS
+#endif  // TARGET_OS_IOS || TARGET_OS_TV

FirebaseInAppMessaging/Sources/Analytics/FIRIAMClearcutUploader.m

@@ -15,7 +15,7 @@
  */
 
 #import <TargetConditionals.h>
-#if TARGET_OS_IOS
+#if TARGET_OS_IOS || TARGET_OS_TV
 
 #import <UIKit/UIKit.h>
 #import "FirebaseCore/Sources/Private/FirebaseCoreInternal.h"
@@ -245,4 +245,4 @@ - (void)scheduleNextSend {
 
 @end
 
-#endif  // TARGET_OS_IOS
+#endif  // TARGET_OS_IOS || TARGET_OS_TV

FirebaseInAppMessaging/Sources/Data/FIRIAMFetchResponseParser.m

@@ -15,7 +15,7 @@
  */
 
 #import <TargetConditionals.h>
-#if TARGET_OS_IOS
+#if TARGET_OS_IOS || TARGET_OS_TV
 
 #import "FirebaseCore/Sources/Private/FirebaseCoreInternal.h"
 
@@ -376,4 +376,4 @@ - (FIRIAMMessageDefinition *)convertToMessageDefinitionWithMessageDict:(NSDictio
 }
 @end
 
-#endif  // TARGET_OS_IOS
+#endif  // TARGET_OS_IOS || TARGET_OS_TV

FirebaseInAppMessaging/Sources/Data/FIRIAMMessageContentDataWithImageURL.m

@@ -15,7 +15,7 @@
  */
 
 #import <TargetConditionals.h>
-#if TARGET_OS_IOS
+#if TARGET_OS_IOS || TARGET_OS_TV
 
 #import "FirebaseCore/Sources/Private/FirebaseCoreInternal.h"
 
@@ -206,4 +206,4 @@ - (void)fetchImageFromURL:(NSURL *)imageURL
 
 @end
 
-#endif  // TARGET_OS_IOS
+#endif  // TARGET_OS_IOS || TARGET_OS_TV

FirebaseInAppMessaging/Sources/Data/FIRIAMMessageDefinition.m

@@ -15,7 +15,7 @@
  */
 
 #import <TargetConditionals.h>
-#if TARGET_OS_IOS
+#if TARGET_OS_IOS || TARGET_OS_TV
 
 #import "FirebaseInAppMessaging/Sources/Private/Data/FIRIAMMessageDefinition.h"
 
@@ -108,4 +108,4 @@ - (BOOL)messageHasStarted {
 }
 @end
 
-#endif  // TARGET_OS_IOS
+#endif  // TARGET_OS_IOS || TARGET_OS_TV

FirebaseInAppMessaging/Sources/Data/FIRIAMRenderingEffectSetting.m

@@ -15,7 +15,7 @@
  */
 
 #import <TargetConditionals.h>
-#if TARGET_OS_IOS
+#if TARGET_OS_IOS || TARGET_OS_TV
 
 #import "FirebaseInAppMessaging/Sources/Private/Data/FIRIAMRenderingEffectSetting.h"
 
@@ -34,4 +34,4 @@ + (instancetype)getDefaultRenderingEffectSetting {
 }
 @end
 
-#endif  // TARGET_OS_IOS
+#endif  // TARGET_OS_IOS || TARGET_OS_TV

FirebaseInAppMessaging/Sources/DisplayTrigger/FIRIAMDisplayTriggerDefinition.m

@@ -15,7 +15,7 @@
  */
 
 #import <TargetConditionals.h>
-#if TARGET_OS_IOS
+#if TARGET_OS_IOS || TARGET_OS_TV
 
 #import "FirebaseInAppMessaging/Sources/Private/DisplayTrigger/FIRIAMDisplayTriggerDefinition.h"
 
@@ -43,4 +43,4 @@ - (instancetype)initWithFirebaseAnalyticEvent:(NSString *)title {
 }
 @end
 
-#endif  // TARGET_OS_IOS
+#endif  // TARGET_OS_IOS || TARGET_OS_TV

FirebaseInAppMessaging/Sources/FIRCore+InAppMessaging.m

@@ -15,12 +15,12 @@
  */
 
 #import <TargetConditionals.h>
-#if TARGET_OS_IOS
+#if TARGET_OS_IOS || TARGET_OS_TV
 
 #import <Foundation/Foundation.h>
 #import "FirebaseInAppMessaging/Sources/FIRCore+InAppMessaging.h"
 
 NSString *const kFirebaseInAppMessagingErrorDomain = @"com.firebase.inappmessaging";
 FIRLoggerService kFIRLoggerInAppMessaging = @"[Firebase/InAppMessaging]";
 
-#endif  // TARGET_OS_IOS
+#endif  // TARGET_OS_IOS || TARGET_OS_TV

FirebaseInAppMessaging/Sources/FIRInAppMessaging.m

@@ -15,7 +15,7 @@
  */
 
 #import <TargetConditionals.h>
-#if TARGET_OS_IOS
+#if TARGET_OS_IOS || TARGET_OS_TV
 
 #import "FirebaseInAppMessaging/Sources/Public/FirebaseInAppMessaging/FIRInAppMessaging.h"
 
@@ -145,4 +145,4 @@ - (void)triggerEvent:(NSString *)eventName {
 
 @end
 
-#endif  // TARGET_OS_IOS
+#endif  // TARGET_OS_IOS || TARGET_OS_TV

FirebaseInAppMessaging/Sources/Flows/FIRIAMActivityLogger.m

@@ -15,7 +15,7 @@
  */
 
 #import <TargetConditionals.h>
-#if TARGET_OS_IOS
+#if TARGET_OS_IOS || TARGET_OS_TV
 
 #import <UIKit/UIKit.h>
 
@@ -150,9 +150,10 @@ + (NSString *)determineCacheFilePath {
 
 - (void)loadFromCachePath:(NSString *)cacheFilePath {
   NSString *filePath = cacheFilePath == nil ? [self.class determineCacheFilePath] : cacheFilePath;
-
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
   id fetchedActivityRecords = [NSKeyedUnarchiver unarchiveObjectWithFile:filePath];
-
+#pragma clang diagnostic pop
   if (fetchedActivityRecords) {
     @synchronized(self) {
       self.activityRecords = (NSMutableArray<FIRIAMActivityRecord *> *)fetchedActivityRecords;
@@ -164,7 +165,10 @@ - (void)loadFromCachePath:(NSString *)cacheFilePath {
 - (BOOL)saveIntoCacheWithPath:(NSString *)cacheFilePath {
   NSString *filePath = cacheFilePath == nil ? [self.class determineCacheFilePath] : cacheFilePath;
   @synchronized(self) {
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
     BOOL result = [NSKeyedArchiver archiveRootObject:self.activityRecords toFile:filePath];
+#pragma clang diagnostic pop
     if (result) {
       self.isDirty = NO;
     }
@@ -224,4 +228,4 @@ - (void)addLogRecord:(FIRIAMActivityRecord *)newRecord {
 }
 @end
 
-#endif  // TARGET_OS_IOS
+#endif  // TARGET_OS_IOS || TARGET_OS_TV

FirebaseInAppMessaging/Sources/Flows/FIRIAMBookKeeper.m

@@ -15,7 +15,7 @@
  */
 
 #import <TargetConditionals.h>
-#if TARGET_OS_IOS
+#if TARGET_OS_IOS || TARGET_OS_TV
 
 #import "FirebaseCore/Sources/Private/FirebaseCoreInternal.h"
 
@@ -262,4 +262,4 @@ - (void)cleanupFetchRecords {
 }
 @end
 
-#endif  // TARGET_OS_IOS
+#endif  // TARGET_OS_IOS || TARGET_OS_TV

FirebaseInAppMessaging/Sources/Flows/FIRIAMClientInfoFetcher.m

@@ -15,7 +15,7 @@
  */
 
 #import <TargetConditionals.h>
-#if TARGET_OS_IOS
+#if TARGET_OS_IOS || TARGET_OS_TV
 
 #import "FirebaseCore/Sources/Private/FirebaseCoreInternal.h"
 #import "FirebaseInstallations/Source/Library/Private/FirebaseInstallationsInternal.h"
@@ -133,4 +133,4 @@ - (NSString *)getIAMSDKVersion {
 }
 @end
 
-#endif  // TARGET_OS_IOS
+#endif  // TARGET_OS_IOS || TARGET_OS_TV

FirebaseInAppMessaging/Sources/Flows/FIRIAMDisplayCheckOnAnalyticEventsFlow.m

@@ -15,7 +15,7 @@
  */
 
 #import <TargetConditionals.h>
-#if TARGET_OS_IOS
+#if TARGET_OS_IOS || TARGET_OS_TV
 
 #import "FirebaseCore/Sources/Private/FirebaseCoreInternal.h"
 #import "Interop/Analytics/Public/FIRAnalyticsInterop.h"
@@ -68,4 +68,4 @@ - (void)stop {
 
 @end
 
-#endif  // TARGET_OS_IOS
+#endif  // TARGET_OS_IOS || TARGET_OS_TV