Merge branch 'master' into feature/MOB-10951-add-mobile-framework-infi

sumeruchat · sumeruchat · commit 04aecf8e93bc · 2025-01-15T16:12:47.000Z
* master: [MOB-10605] prepares version 6.5.9 release (#885) [MOB-9446] Enhance push notification state tracking in SDKs (#881) [MOB-9233] Fix tests for json only in app messages (#883)
diff --git a/.github/workflows/build-and-test.yml b/.github/workflows/build-and-test.yml
@@ -4,7 +4,7 @@ on: pull_request
 
 jobs:
   run-tests-job:
-    runs-on: macos-latest
+    runs-on: macos-14
 
     steps:
       - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
diff --git a/.github/workflows/e2e.yml b/.github/workflows/e2e.yml
@@ -4,7 +4,7 @@ on: pull_request
 
 jobs:
   run-e2e-job:
-    runs-on: macos-latest
+    runs-on: macos-14
 
     steps:
       - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,14 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 - Added `mobileFrameworkInfo` configuration option to `IterableConfig` to identify the mobile framework (Flutter, React Native, or Native) being used with the SDK.
 
+## [6.5.9]
+### Added
+- Support for JSON-only in-app messages, JSON-only messages are now handled by the onNewInApp handler and consumed after retrieval
+- Enhanced notification state tracking to align with system notification permissions changes
+
+### Changed
+- reorganized files and updated documentation url in podspec
+
 ## [6.5.8]
 ### Fixed
 - Fixed incorrect tracking of pushOpen for push notifications with Wake App enabled. Tracking now happens only when users tap to open the app.
diff --git a/Iterable-iOS-AppExtensions.podspec b/Iterable-iOS-AppExtensions.podspec
@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
   s.name         = "Iterable-iOS-AppExtensions"
   s.module_name  = "IterableAppExtensions"
-  s.version      = "6.5.8"
+  s.version      = "6.5.9"
   s.summary      = "App Extensions for Iterable SDK"
 
   s.description  = <<-DESC
diff --git a/Iterable-iOS-SDK.podspec b/Iterable-iOS-SDK.podspec
@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
   s.name         = "Iterable-iOS-SDK"
   s.module_name  = "IterableSDK"
-  s.version      = "6.5.8"
+  s.version      = "6.5.9"
   s.summary      = "Iterable's official SDK for iOS"
 
   s.description  = <<-DESC
diff --git a/swift-sdk.xcodeproj/project.pbxproj b/swift-sdk.xcodeproj/project.pbxproj
@@ -11,6 +11,7 @@
 		00B6FACE210E88ED007535CF /* prod-1.mobileprovision in Resources */ = {isa = PBXBuildFile; fileRef = 00B6FACD210E874D007535CF /* prod-1.mobileprovision */; };
 		00B6FAD1210E8D90007535CF /* dev-1.mobileprovision in Resources */ = {isa = PBXBuildFile; fileRef = 00B6FAD0210E8D90007535CF /* dev-1.mobileprovision */; };
 		00CB31B621096129004ACDEC /* TestUtils.swift in Sources */ = {isa = PBXBuildFile; fileRef = 00CB31B4210960C4004ACDEC /* TestUtils.swift */; };
+		092D01942D3038F600E3066A /* NotificationObserverTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 092D01932D3038F600E3066A /* NotificationObserverTests.swift */; };
 		1CBFFE1A2A97AEEF00ED57EE /* EmbeddedManagerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1CBFFE162A97AEEE00ED57EE /* EmbeddedManagerTests.swift */; };
 		1CBFFE1B2A97AEEF00ED57EE /* EmbeddedMessagingProcessorTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1CBFFE172A97AEEE00ED57EE /* EmbeddedMessagingProcessorTests.swift */; };
 		1CBFFE1C2A97AEEF00ED57EE /* EmbeddedSessionManagerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1CBFFE182A97AEEE00ED57EE /* EmbeddedSessionManagerTests.swift */; };
@@ -544,6 +545,7 @@
 		00B6FACD210E874D007535CF /* prod-1.mobileprovision */ = {isa = PBXFileReference; lastKnownFileType = file; path = "prod-1.mobileprovision"; sourceTree = "<group>"; };
 		00B6FAD0210E8D90007535CF /* dev-1.mobileprovision */ = {isa = PBXFileReference; lastKnownFileType = file; path = "dev-1.mobileprovision"; sourceTree = "<group>"; };
 		00CB31B4210960C4004ACDEC /* TestUtils.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TestUtils.swift; sourceTree = "<group>"; };
+		092D01932D3038F600E3066A /* NotificationObserverTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = NotificationObserverTests.swift; sourceTree = "<group>"; };
 		1CBFFE162A97AEEE00ED57EE /* EmbeddedManagerTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = EmbeddedManagerTests.swift; sourceTree = "<group>"; };
 		1CBFFE172A97AEEE00ED57EE /* EmbeddedMessagingProcessorTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = EmbeddedMessagingProcessorTests.swift; sourceTree = "<group>"; };
 		1CBFFE182A97AEEE00ED57EE /* EmbeddedSessionManagerTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = EmbeddedSessionManagerTests.swift; sourceTree = "<group>"; };
@@ -938,6 +940,7 @@
 		552A0AA9280E249C00A80963 /* notification-tests */ = {
 			isa = PBXGroup;
 			children = (
+				092D01932D3038F600E3066A /* NotificationObserverTests.swift */,
 				55B37FC32297135F0042F13A /* NotificationMetadataTests.swift */,
 				AC2C667F20D31B1F00D46CC9 /* NotificationResponseTests.swift */,
 			);
@@ -2190,6 +2193,7 @@
 				5588DFD128C0465E000697D7 /* MockAPNSTypeChecker.swift in Sources */,
 				00B6FACC210E8484007535CF /* APNSTypeCheckerTests.swift in Sources */,
 				AC8F35A2239806B500302994 /* InboxViewControllerViewModelTests.swift in Sources */,
+				092D01942D3038F600E3066A /* NotificationObserverTests.swift in Sources */,
 				AC995F9A2166EEB50099A184 /* CommonMocks.swift in Sources */,
 				5588DFE128C046B7000697D7 /* MockLocalStorage.swift in Sources */,
 				1CBFFE1B2A97AEEF00ED57EE /* EmbeddedMessagingProcessorTests.swift in Sources */,
diff --git a/swift-sdk/Core/Constants.swift b/swift-sdk/Core/Constants.swift
@@ -57,7 +57,9 @@ enum Const {
         static let deviceId = "itbl_device_id"
         static let sdkVersion = "itbl_sdk_version"
         static let offlineMode = "itbl_offline_mode"
-        
+        static let isNotificationsEnabled = "itbl_isNotificationsEnabled"
+        static let hasStoredNotificationSetting = "itbl_hasStoredNotificationSetting"
+
         static let attributionInfoExpiration = 24
     }
     
diff --git a/swift-sdk/Internal/InternalIterableAPI.swift b/swift-sdk/Internal/InternalIterableAPI.swift
@@ -176,7 +176,7 @@ final class InternalIterableAPI: NSObject, PushTrackerProtocol, AuthProvider {
     
     // MARK: - API Request Calls
     
-    func register(token: Data,
+    func register(token: String,
                   onSuccess: OnSuccessHandler? = nil,
                   onFailure: OnFailureHandler? = nil) {
         guard let appName = pushIntegrationName else {
@@ -187,15 +187,15 @@ final class InternalIterableAPI: NSObject, PushTrackerProtocol, AuthProvider {
             return
         }
         
-        hexToken = token.hexString()
+        hexToken = token
         
         let frameworkType = IterableAPIMobileFrameworkDetector.frameworkType()
         let mobileFrameworkInfo = config.mobileFrameworkInfo ?? IterableAPIMobileFrameworkInfo(
             frameworkType: frameworkType,
             iterableSdkVersion: frameworkType == .native ? localStorage.sdkVersion : nil
         )
         
-        let registerTokenInfo = RegisterTokenInfo(hexToken: token.hexString(),
+        let registerTokenInfo = RegisterTokenInfo(hexToken: token,
                                                   appName: appName,
                                                   pushServicePlatform: config.pushPlatform,
                                                   apnsType: dependencyContainer.apnsTypeChecker.apnsType,
@@ -216,6 +216,12 @@ final class InternalIterableAPI: NSObject, PushTrackerProtocol, AuthProvider {
         )
     }
     
+    func register(token: Data,
+                  onSuccess: OnSuccessHandler? = nil,
+                  onFailure: OnFailureHandler? = nil) {
+        register(token: token.hexString(), onSuccess: onSuccess, onFailure: onFailure)
+    }
+    
     @discardableResult
     func disableDeviceForCurrentUser(withOnSuccess onSuccess: OnSuccessHandler? = nil,
                                      onFailure: OnFailureHandler? = nil) -> Pending<SendRequestValue, SendRequestError> {
@@ -224,12 +230,18 @@ final class InternalIterableAPI: NSObject, PushTrackerProtocol, AuthProvider {
             onFailure?(errorMessage, nil)
             return SendRequestError.createErroredFuture(reason: errorMessage)
         }
+        
         guard userId != nil || email != nil else {
             let errorMessage = "either userId or email must be present"
             onFailure?(errorMessage, nil)
             return SendRequestError.createErroredFuture(reason: errorMessage)
         }
         
+        // We need to call register token here so that we can trigger the device registration
+        // with the updated notification settings
+        
+        register(token: hexToken)
+        
         return requestHandler.disableDeviceForCurrentUser(hexToken: hexToken, withOnSuccess: onSuccess, onFailure: onFailure)
     }
     
@@ -508,6 +520,8 @@ final class InternalIterableAPI: NSObject, PushTrackerProtocol, AuthProvider {
     private var _userId: String?
     private var _successCallback: OnSuccessHandler? = nil
     private var _failureCallback: OnFailureHandler? = nil
+    
+    private let notificationCenter: NotificationCenterProtocol
 
     
     /// the hex representation of this device token
@@ -674,6 +688,7 @@ final class InternalIterableAPI: NSObject, PushTrackerProtocol, AuthProvider {
         localStorage = dependencyContainer.localStorage
         inAppDisplayer = dependencyContainer.inAppDisplayer
         urlOpener = dependencyContainer.urlOpener
+        notificationCenter = dependencyContainer.notificationCenter
         deepLinkManager = DeepLinkManager(redirectNetworkSessionProvider: dependencyContainer)
     }
     
@@ -706,10 +721,44 @@ final class InternalIterableAPI: NSObject, PushTrackerProtocol, AuthProvider {
         requestHandler.start()
         
         checkRemoteConfiguration()
+        
+        addForegroundObservers()
                 
         return inAppManager.start()
     }
     
+    private func addForegroundObservers() {
+        notificationCenter.addObserver(self,
+                                     selector: #selector(onAppDidBecomeActiveNotification(notification:)),
+                                     name: UIApplication.didBecomeActiveNotification,
+                                     object: nil)
+    }
+    
+    @objc private func onAppDidBecomeActiveNotification(notification: Notification) {
+        guard config.autoPushRegistration else { return }
+        
+        notificationStateProvider.isNotificationsEnabled { [weak self] systemEnabled in
+            guard let self = self else { return }
+            
+            let storedEnabled = self.localStorage.isNotificationsEnabled
+            let hasStoredPermission = self.localStorage.hasStoredNotificationSetting
+            
+            if self.isEitherUserIdOrEmailSet() {
+                if hasStoredPermission && (storedEnabled != systemEnabled) {
+                    if !systemEnabled {
+                        self.disableDeviceForCurrentUser()
+                    } else {
+                        self.notificationStateProvider.registerForRemoteNotifications()
+                    }
+                }
+                
+                // Always store the current state
+                self.localStorage.isNotificationsEnabled = systemEnabled
+                self.localStorage.hasStoredNotificationSetting = true
+            }
+        }
+    }
+    
     private func handle(launchOptions: [UIApplication.LaunchOptionsKey: Any]?) {
         guard let launchOptions = launchOptions else {
             return
@@ -780,6 +829,7 @@ final class InternalIterableAPI: NSObject, PushTrackerProtocol, AuthProvider {
     
     deinit {
         ITBInfo()
+        notificationCenter.removeObserver(self)
         requestHandler.stop()
     }
 }
diff --git a/swift-sdk/Internal/IterableUserDefaults.swift b/swift-sdk/Internal/IterableUserDefaults.swift
@@ -64,12 +64,28 @@ class IterableUserDefaults {
     
     var offlineMode: Bool {
         get {
-            return bool(withKey: .offlineMode)
+            bool(withKey: .offlineMode)
         } set {
             save(bool: newValue, withKey: .offlineMode)
         }
     }
     
+    var isNotificationsEnabled: Bool {
+        get {
+            bool(withKey: .isNotificationsEnabled)
+        } set {
+            save(bool: newValue, withKey: .isNotificationsEnabled)
+        }
+    }
+    
+    var hasStoredNotificationSetting: Bool {
+        get {
+            bool(withKey: .hasStoredNotificationSetting)
+        } set {
+            save(bool: newValue, withKey: .hasStoredNotificationSetting)
+        }
+    }
+    
     func getAttributionInfo(currentDate: Date) -> IterableAttributionInfo? {
         (try? codable(withKey: .attributionInfo, currentDate: currentDate)) ?? nil
     }
@@ -196,6 +212,8 @@ class IterableUserDefaults {
         static let deviceId = UserDefaultsKey(value: Const.UserDefault.deviceId)
         static let sdkVersion = UserDefaultsKey(value: Const.UserDefault.sdkVersion)
         static let offlineMode = UserDefaultsKey(value: Const.UserDefault.offlineMode)
+        static let isNotificationsEnabled = UserDefaultsKey(value: Const.UserDefault.isNotificationsEnabled)
+        static let hasStoredNotificationSetting = UserDefaultsKey(value: Const.UserDefault.hasStoredNotificationSetting)
     }
     
     private struct Envelope: Codable {
diff --git a/swift-sdk/Internal/Utilities/LocalStorage.swift b/swift-sdk/Internal/Utilities/LocalStorage.swift
@@ -67,6 +67,22 @@ struct LocalStorage: LocalStorageProtocol {
         }
     }
     
+    var isNotificationsEnabled: Bool {
+        get {
+            iterableUserDefaults.isNotificationsEnabled
+        } set {
+            iterableUserDefaults.isNotificationsEnabled = newValue
+        }
+    }
+    
+    var hasStoredNotificationSetting: Bool {
+        get {
+            iterableUserDefaults.hasStoredNotificationSetting
+        } set {
+            iterableUserDefaults.hasStoredNotificationSetting = newValue
+        }
+    }
+    
     func getAttributionInfo(currentDate: Date) -> IterableAttributionInfo? {
         iterableUserDefaults.getAttributionInfo(currentDate: currentDate)
     }
diff --git a/swift-sdk/Internal/Utilities/LocalStorageProtocol.swift b/swift-sdk/Internal/Utilities/LocalStorageProtocol.swift
@@ -19,6 +19,10 @@ protocol LocalStorageProtocol {
     
     var offlineMode: Bool { get set }
     
+    var isNotificationsEnabled: Bool { get set }
+    
+    var hasStoredNotificationSetting: Bool { get set }
+    
     func getAttributionInfo(currentDate: Date) -> IterableAttributionInfo?
     
     func save(attributionInfo: IterableAttributionInfo?, withExpiration expiration: Date?)
diff --git a/swift-sdk/SDK/IterableAPI.swift b/swift-sdk/SDK/IterableAPI.swift
@@ -7,7 +7,7 @@ import UIKit
 
 @objcMembers public final class IterableAPI: NSObject {
     /// The current SDK version
-    public static let sdkVersion = "6.5.8"
+    public static let sdkVersion = "6.5.9"
     
     /// The email of the logged in user that this IterableAPI is using
     public static var email: String? {
diff --git a/tests/common/MockLocalStorage.swift b/tests/common/MockLocalStorage.swift
@@ -21,6 +21,10 @@ class MockLocalStorage: LocalStorageProtocol {
     
     var offlineMode: Bool = false
     
+    var isNotificationsEnabled: Bool = false
+    
+    var hasStoredNotificationSetting: Bool = false
+    
     func getAttributionInfo(currentDate: Date) -> IterableAttributionInfo? {
         guard !MockLocalStorage.isExpired(expiration: attributionInfoExpiration, currentDate: currentDate) else {
             return nil
diff --git a/tests/unit-tests/AutoRegistrationTests.swift b/tests/unit-tests/AutoRegistrationTests.swift
@@ -20,6 +20,7 @@ class AutoRegistrationTests: XCTestCase {
     
     func testCallDisableAndEnable() {
         let expectation1 = expectation(description: "call register device API")
+        expectation1.expectedFulfillmentCount = 2
         let expectation2 = expectation(description: "call registerForRemoteNotifications twice")
         expectation2.expectedFulfillmentCount = 2
         let expectation3 = expectation(description: "call disable on user1@example.com")
diff --git a/tests/unit-tests/InAppTests.swift b/tests/unit-tests/InAppTests.swift
@@ -1445,7 +1445,7 @@ class InAppTests: XCTestCase {
         [
             {
                 "saveToInbox": false,
-                "jsonOnly": 1,
+                "jsonOnly": true,
                 "customPayload": {"key": "value"},
                 "content": {
                     "html": "<meta name=\\"viewport\\" content=\\"width=device-width\\">",
@@ -1496,7 +1496,7 @@ class InAppTests: XCTestCase {
         [
             {
                 "saveToInbox": false,
-                "jsonOnly": 1,
+                "jsonOnly": true,
                 "messageType": "Mobile",
                 "typeOfContent": "Static",
                 "customPayload": {
@@ -1579,7 +1579,7 @@ class InAppTests: XCTestCase {
         [
             {
                 "saveToInbox": false,
-                "jsonOnly": 1,
+                "jsonOnly": true,
                 "messageType": "Mobile",
                 "typeOfContent": "Static",
                 "customPayload": {"key": "immediate"},
@@ -1598,7 +1598,7 @@ class InAppTests: XCTestCase {
             },
             {
                 "saveToInbox": false,
-                "jsonOnly": 1,
+                "jsonOnly": true,
                 "messageType": "Mobile",
                 "typeOfContent": "Static",
                 "customPayload": {"key": "never"},
@@ -1640,7 +1640,7 @@ class InAppTests: XCTestCase {
         [
             {
                 "saveToInbox": false,
-                "jsonOnly": 1,
+                "jsonOnly": true,
                 "messageType": "Mobile",
                 "typeOfContent": "Static",
                 "content": {
@@ -1694,7 +1694,7 @@ class InAppTests: XCTestCase {
         [
             {
                 "saveToInbox": false,
-                "jsonOnly": 1,
+                "jsonOnly": true,
                 "messageType": "Mobile",
                 "typeOfContent": "Static",
                 "customPayload": {},
@@ -1748,7 +1748,7 @@ class InAppTests: XCTestCase {
         [
             {
                 "saveToInbox": true,
-                "jsonOnly": 1,
+                "jsonOnly": true,
                 "messageType": "Mobile",
                 "typeOfContent": "Static",
                 "customPayload": {"key": "value"},
@@ -1805,7 +1805,7 @@ class InAppTests: XCTestCase {
         [
             {
                 "saveToInbox": false,
-                "jsonOnly": 1,
+                "jsonOnly": true,
                 "messageType": "Mobile",
                 "typeOfContent": "Static",
                 "customPayload": {
diff --git a/tests/unit-tests/Mocks.swift b/tests/unit-tests/Mocks.swift
diff --git a/tests/unit-tests/NotificationObserverTests.swift b/tests/unit-tests/NotificationObserverTests.swift

Original file line number	Diff line number	Diff line change
`@@ -1445,7 +1445,7 @@ class InAppTests: XCTestCase {`
`1445`	`1445`	`[`
`1446`	`1446`	`{`
`1447`	`1447`	`"saveToInbox": false,`
`1448`		`- "jsonOnly": 1,`
	`1448`	`+ "jsonOnly": true,`
`1449`	`1449`	`"customPayload": {"key": "value"},`
`1450`	`1450`	`"content": {`
`1451`	`1451`	`"html": "<meta name=\\"viewport\\" content=\\"width=device-width\\">",`
`@@ -1496,7 +1496,7 @@ class InAppTests: XCTestCase {`
`1496`	`1496`	`[`
`1497`	`1497`	`{`
`1498`	`1498`	`"saveToInbox": false,`
`1499`		`- "jsonOnly": 1,`
	`1499`	`+ "jsonOnly": true,`
`1500`	`1500`	`"messageType": "Mobile",`
`1501`	`1501`	`"typeOfContent": "Static",`
`1502`	`1502`	`"customPayload": {`
`@@ -1579,7 +1579,7 @@ class InAppTests: XCTestCase {`
`1579`	`1579`	`[`
`1580`	`1580`	`{`
`1581`	`1581`	`"saveToInbox": false,`
`1582`		`- "jsonOnly": 1,`
	`1582`	`+ "jsonOnly": true,`
`1583`	`1583`	`"messageType": "Mobile",`
`1584`	`1584`	`"typeOfContent": "Static",`
`1585`	`1585`	`"customPayload": {"key": "immediate"},`
`@@ -1598,7 +1598,7 @@ class InAppTests: XCTestCase {`
`1598`	`1598`	`},`
`1599`	`1599`	`{`
`1600`	`1600`	`"saveToInbox": false,`
`1601`		`- "jsonOnly": 1,`
	`1601`	`+ "jsonOnly": true,`
`1602`	`1602`	`"messageType": "Mobile",`
`1603`	`1603`	`"typeOfContent": "Static",`
`1604`	`1604`	`"customPayload": {"key": "never"},`
`@@ -1640,7 +1640,7 @@ class InAppTests: XCTestCase {`
`1640`	`1640`	`[`
`1641`	`1641`	`{`
`1642`	`1642`	`"saveToInbox": false,`
`1643`		`- "jsonOnly": 1,`
	`1643`	`+ "jsonOnly": true,`
`1644`	`1644`	`"messageType": "Mobile",`
`1645`	`1645`	`"typeOfContent": "Static",`
`1646`	`1646`	`"content": {`
`@@ -1694,7 +1694,7 @@ class InAppTests: XCTestCase {`
`1694`	`1694`	`[`
`1695`	`1695`	`{`
`1696`	`1696`	`"saveToInbox": false,`
`1697`		`- "jsonOnly": 1,`
	`1697`	`+ "jsonOnly": true,`
`1698`	`1698`	`"messageType": "Mobile",`
`1699`	`1699`	`"typeOfContent": "Static",`
`1700`	`1700`	`"customPayload": {},`
`@@ -1748,7 +1748,7 @@ class InAppTests: XCTestCase {`
`1748`	`1748`	`[`
`1749`	`1749`	`{`
`1750`	`1750`	`"saveToInbox": true,`
`1751`		`- "jsonOnly": 1,`
	`1751`	`+ "jsonOnly": true,`
`1752`	`1752`	`"messageType": "Mobile",`
`1753`	`1753`	`"typeOfContent": "Static",`
`1754`	`1754`	`"customPayload": {"key": "value"},`
`@@ -1805,7 +1805,7 @@ class InAppTests: XCTestCase {`
`1805`	`1805`	`[`
`1806`	`1806`	`{`
`1807`	`1807`	`"saveToInbox": false,`
`1808`		`- "jsonOnly": 1,`
	`1808`	`+ "jsonOnly": true,`
`1809`	`1809`	`"messageType": "Mobile",`
`1810`	`1810`	`"typeOfContent": "Static",`
`1811`	`1811`	`"customPayload": {`