How to Avoid Common Push Notification Issues on iOS Devices Using iOS Swift version 8.x.x?

Problem

Common issues with Push notifications, including Push Campaign impressions not being tracked and images not rendering even though Push notifications are successfully delivered to device with Swift version 8.x.x. 

Solution

Perform the following steps:

1. Check for app_group_id in your project’s main target for each configuration:

   You can add the same app_group_id or different ones across configurations.

   info

   Information Issues may arise if your configurations use different Bundle Identifiers but share the same app_group_id. Specifically, the Notification Service Extension may fail if two apps with different Bundle Identifiers but the same app_group_id are installed on the same device. To avoid this, you can use the same app_group_id across multiple configurations, but be aware that you won't be able to test all apps simultaneously on a single device.

    

   

2. Check for app_group_id during SDK initialization:
   
   • If the SDK is initialized using info.plist, the APP_GROUP_ID key must be there inside the MoEngage key in your info.plist file.
   • If the SDK is initialized using sdkConfig, the APP_GROUP_ID must be in the sdkConfig variable inside the AppDelegate file.
   
   app_group_id in info.plist:
   

   app_group_id in sdkConfig variable:

   Swift

   var sdkConfig = MOSDKConfig.init(withAppID: "XXXXXXXXXXXXXXXX")
   sdkConfig.moeDataCenter = .data_center_0X
   sdkConfig.appGroupID = "group.com.XXXXXXXXXXXXXXXX"

    

   Objective-C

   MOSDKConfig* sdkConfig = [[MOSDKConfig alloc] initWithAppID: @"XXXXXXXXXXXXXXXX"];
   sdkConfig.moeDataCenter = MODataCenterData_center_0X;
   sdkConfig.appGroupID = @"group.com.XXXXXXXXXXXXXXXX";

3. Check for a Notification Service Extension Target:
   
   • Enable Push Notifications: In the extension target's Signing & Capabilities section, make sure to enable Push Notifications and add the AppGroupId.
   • Align the Minimum Deployment iOS Version: Ensure that the minimum deployment iOS version of the Notification Service Extension matches the iOS version of the main app.
4. Integrate the MORichNotification Framework into the Notification Service Extension target.
   Swift

   target 'MoEngageDemo' do
     use_frameworks!
     pod 'MoEngage-iOS-SDK'
   end
   
   target 'MoEngageNotificationService' do
     use_frameworks! #use use_frameworks only if included in main target as in above scenario
     pod 'MoEngageRichNotification'
   end

5. NotificationService.swift file looks like this:
   
   Swift

   import UserNotifications
   import MoEngageRichNotification
    
   class NotificationService: UNNotificationServiceExtension {
    
       var contentHandler: ((UNNotificationContent) - Void)?
       var bestAttemptContent: UNMutableNotificationContent?
    
       override func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) - Void) {	
         MORichNotification.setAppGroupID("group.com.XXXXXXXXXXXXXXXX")
         self.contentHandler = contentHandler
         bestAttemptContent = (request.content.mutableCopy() as? UNMutableNotificationContent)
         MORichNotification.handle(richNotificationRequest: request, withContentHandler: contentHandler)
       }
       
       override func serviceExtensionTimeWillExpire() {
           // Called just before the extension will be terminated by the system.
           // Use this as an opportunity to deliver your "best attempt" at modified content, otherwise the original push payload will be used.
           if let contentHandler = contentHandler, let bestAttemptContent =  bestAttemptContent {
               contentHandler(bestAttemptContent)
           }
       }
   }

    

6. Check Build Phases for the Main App Target: In the Build Phases section of the main app target, locate the Embed App Extensions / Embed Foundation Extensions section. Ensure that the Copy only when installing option is unchecked.
7. Ensure Consistent appGroupId Across Configurations: Verify that the appGroupId is consistent across all schemes and configurations (e.g. Debug/Release/QA/UAT) in the project. 
8. Align Build Configuration: When running or archiving the project, ensure that the Build Configuration for the Main Target and Notification Service Extension Target points to the same scheme/configuration.