Play App - Push SDK Setup

.gitignore

@@ -26,3 +26,4 @@ xcuserdata
 /vendor
 
 .vscode
+settings.local.json

Application/Sources/Application/AppDelegate.m

@@ -23,6 +23,7 @@
 
 @import AirshipCore;
 @import AppCenter;
+@import UserNotifications;
 @import AppCenterCrashes;
 @import AVFoundation;
 @import CarPlay;
@@ -38,7 +39,7 @@
 
 static void *s_kvoContext = &s_kvoContext;
 
-@interface AppDelegate() <SRGAnalyticsTrackerDataSource>
+@interface AppDelegate() <SRGAnalyticsTrackerDataSource, UNUserNotificationCenterDelegate>
 
 @end
 
@@ -99,6 +100,7 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
                                                name:SRGLetterboxPlaybackDidContinueAutomaticallyNotification
                                              object:nil];
 
+    [UNUserNotificationCenter currentNotificationCenter].delegate = self;
     [PushService.sharedService setupWithLaunchingWithOptions:launchOptions];
     [PushService.sharedService updateApplicationBadge];
 
@@ -324,6 +326,64 @@ - (void)productViewControllerDidFinish:(SKStoreProductViewController *)viewContr
     }];
 }
 
+#pragma mark Push registration
+
+- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken
+{
+    if ([UAirship isFlying]) {
+        [UAAppIntegration application:application didRegisterForRemoteNotificationsWithDeviceToken:deviceToken];
+    }
+    [PushService.sharedService registerDeviceToken:deviceToken];
+}
+
+- (void)application:(UIApplication *)application didFailToRegisterForRemoteNotificationsWithError:(NSError *)error
+{
+    if ([UAirship isFlying]) {
+        [UAAppIntegration application:application didFailToRegisterForRemoteNotificationsWithError:error];
+    }
+}
+
+- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler
+{
+    // Normal push (com.urbanairship) or silent push (_)
+    NSPredicate *airshipPredicate = [NSPredicate predicateWithBlock:^BOOL(id key, NSDictionary *bindings) {
+        return [key isKindOfClass:NSString.class] && ([key hasPrefix:@"com.urbanairship"] || [key isEqualToString:@"_"]);
+    }];
+    BOOL isAirshipPayload = [[userInfo.allKeys filteredArrayUsingPredicate:airshipPredicate] count] > 0;
+    if (isAirshipPayload) {
+        if ([UAirship isFlying]) {
+            [UAAppIntegration application:application didReceiveRemoteNotification:userInfo fetchCompletionHandler:completionHandler];
+        }
+    } else {
+        completionHandler(UIBackgroundFetchResultNewData);
+    }
+}
+
+#pragma mark UNUserNotificationCenterDelegate protocol
+
+- (void)userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void (^)(void))completionHandler
+{
+    [PushService.sharedService handleNotificationResponse:response];
+    if ([UAirship isFlying]) {
+        [UAAppIntegration userNotificationCenter:center
+                  didReceiveNotificationResponse:response
+                           withCompletionHandler:completionHandler];
+    } else {
+        completionHandler();
+    }
+}
+
+- (void)userNotificationCenter:(UNUserNotificationCenter *)center willPresentNotification:(UNNotification *)notification withCompletionHandler:(void (^)(UNNotificationPresentationOptions))completionHandler
+{
+    if ([UAirship isFlying]) {
+        [UAAppIntegration userNotificationCenter:center
+                         willPresentNotification:notification
+                           withCompletionHandler:completionHandler];
+    } else {
+        completionHandler(UNNotificationPresentationOptionNone);
+    }
+}
+
 #pragma mark Notifications
 
 - (void)playbackDidContinueAutomatically:(NSNotification *)notification

Application/Sources/Configuration/ApplicationConfiguration.h

@@ -47,6 +47,8 @@ OBJC_EXPORT NSString * const ApplicationConfigurationDidChangeNotification;
 @property (nonatomic, readonly, nullable) NSURL *identityWebsiteURL;
 @property (nonatomic, readonly, nullable) NSURL *userDataServiceURL;
 
+@property (nonatomic, readonly, nullable) NSURL *pushServiceURL;
+
 @property (nonatomic, readonly) NSURL *whatsNewURL;
 @property (nonatomic, readonly, nullable) NSURL *supportFormURL;
 @property (nonatomic, readonly, nullable) NSURL *faqURL;

Application/Sources/Configuration/ApplicationConfiguration.m

@@ -131,6 +131,7 @@ @interface ApplicationConfiguration ()
 @property (nonatomic) NSURL *identityWebserviceURL;
 @property (nonatomic) NSURL *identityWebsiteURL;
 @property (nonatomic) NSURL *userDataServiceURL;
+@property (nonatomic) NSURL *pushServiceURL;
 
 @property (nonatomic) NSURL *whatsNewURL;
 @property (nonatomic) NSURL *supportFormURL;
@@ -483,7 +484,15 @@ - (BOOL)synchronizeWithFirebaseConfiguration:(PlayFirebaseConfiguration *)fireba
 
     NSString *userDataServiceURLString = [firebaseConfiguration stringForKey:@"userDataServiceURL"];
     self.userDataServiceURL = userDataServiceURLString ? [NSURL URLWithString:userDataServiceURLString] : nil;
-
+
+#if defined(DEBUG) || defined(NIGHTLY)
+    self.pushServiceURL = [NSURL URLWithString:@"https://api.dev.srf.ch/push"];
+#elif defined(BETA)
+    self.pushServiceURL = [NSURL URLWithString:@"https://api.int.srf.ch/push"];
+#else
+    self.pushServiceURL = [NSURL URLWithString:@"https://api.srf.ch/push"];
+#endif
+
     NSString *faqURLString = [firebaseConfiguration stringForKey:@"faqURL"];
     self.faqURL = faqURLString ? [NSURL URLWithString:faqURLString] : nil;
 

Application/Sources/Favorites/Favorites.h

@@ -64,8 +64,13 @@ OBJC_EXPORT void FavoritesUpdatePushService(void);
 #endif
 
 /**
- *  Return `YES` iff the user has subscribed to the specified show.
+ *  Return `YES` if the user has subscribed to the specified show.
  */
 OBJC_EXPORT BOOL FavoritesIsSubscribedToShow(SRGShow * _Nonnull show);
 
+/**
+ *  Return `YES` if the user has subscribed to the show with the specified URN.
+ */
+OBJC_EXPORT BOOL FavoritesIsSubscribedToShowURN(NSString * _Nonnull URN);
+
 NS_ASSUME_NONNULL_END

Application/Sources/Favorites/Favorites.m

@@ -106,15 +106,20 @@ BOOL FavoritesToggleSubscriptionForShow(SRGShow *show)
     if (! FavoritesContainsShow(show)) {
         FavoritesToggleShow(show);
     }
-
-    if (! [PushService.sharedService toggleSubscriptionForShow:show]) {
+
+    // Subscriptions can only be changed when notifications are enabled; this may prompt the user.
+    if (! [PushService.sharedService requestSubscriptionAuthorization]) {
         return NO;
     }
-    
-    BOOL subscribed = [PushService.sharedService isSubscribedToShowURN:show.URN];
+
+    BOOL newSubscribed = ! FavoritesIsSubscribedToShowURN(show.URN);
     NSString *path = [[[PlayFavoritesPath stringByAppendingPathComponent:show.URN] stringByAppendingPathComponent:PlayNotificationsPath] stringByAppendingPathComponent:PlayNewOnDemandPath];
-    [SRGUserData.currentUserData.preferences setNumber:@(subscribed) atPath:path inDomain:PlayPreferencesDomain];
-
+
+    // Update SRGUserData before invoking the push service: syncTagsToPushSDK reads back the subscription state from here.
+    [SRGUserData.currentUserData.preferences setNumber:@(newSubscribed) atPath:path inDomain:PlayPreferencesDomain];
+
+    [PushService.sharedService toggleSubscriptionForShow:show];
+
     return YES;
 }
 
@@ -141,8 +146,6 @@ void FavoritesUpdatePushService(void)
         NSSet<NSString *> *toUnsubscribeURNs = [subscribedPushServiceURNs setByRemovingObjectsIn:subscribedURNs];
         [PushService.sharedService unsubscribeFromShowURNs:toUnsubscribeURNs];
     }
-
-    NSCAssert([subscribedURNs isEqualToSet:PushService.sharedService.subscribedShowURNs], @"Subscribed favorite shows have to be equal to Push Service subscribed shows");
 }
 
 #endif

Application/Sources/Helpers/PushService+Private.h

@@ -34,11 +34,15 @@ NS_ASSUME_NONNULL_BEGIN
 @interface PushService (Helpers)
 
 /**
- *  Toggle subscription for the specified show and notifified with a banner. Return `YES` if toggled. If notifications
- *  are not enabled an alert is presented to ask the user to enable push notifications instead. The toggle action is
- *  ignored and the method returns `NO`.
+ *  Return `YES` if show subscriptions can be changed. If notifications are not enabled the system permission prompt
+ *  or an alert directing the user to Settings is presented, and the method returns `NO`.
  */
-- (BOOL)toggleSubscriptionForShow:(SRGShow *)show;
+- (BOOL)requestSubscriptionAuthorization;
+
+/**
+ *  Toggle subscription for the specified show. Callers must ensure `-requestSubscriptionAuthorization` returns `YES` first.
+ */
+- (void)toggleSubscriptionForShow:(SRGShow *)show;
 
 @end
 

Application/Sources/Helpers/PushService.h

@@ -61,6 +61,16 @@ OBJC_EXPORT NSString * const PushServiceEnabledKey;
  */
 @property (nonatomic, readonly, copy, nullable) NSString *airshipIdentifier;
 
+/**
+ *  Register the device token with PushSDK. Call from `application:didRegisterForRemoteNotificationsWithDeviceToken:`.
+ */
+- (void)registerDeviceToken:(NSData *)deviceToken;
+
+/**
+ *  Handle a notification response. Call from `userNotificationCenter:didReceiveNotificationResponse:withCompletionHandler:`.
+ */
+- (void)handleNotificationResponse:(UNNotificationResponse *)notificationResponse;
+
 /**
  *  Attempt to present the system alert to enable push notifications. Returns `YES` iff presented.
  */