refactor: badge arithmetic [5] #93

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

eligutovsky wants to merge 52 commits into feat/key-value-storage-migration from refactor/notification-service-extension-2

CHANGELOG.md

-Original file line number
+Diff line change
@@ -1,5 +1,31 @@
     # Changelog
+    ## 6.0.0
+    - Add Preference Center feature. The new functionality is available through the following methods:
+        - `OptimovePreferenceCenter.getInstance().setCustomerPreferencesAsync()`
+        - `OptimovePreferenceCenter.getInstance().getPreferencesAsync()`
+    Breaking changes:
+    - iOS 13 required for using Preference Center
+    - removed `OptimoveConfigBuilder.setCredentials` unintentionally public method
+    ## 5.9.0
+    - Remove `SetUserAgent` event
+    ## 5.8.0
+    - Add a new public API `Optimove.shared.urlOpened(url: url)` to allow easily forwarding urls to Optimove instead of relying on AppDeletegate's `application(_:continue:restorationHandler:)`
+    - Fix deeplink decoding issue
+    - Fix immediate initialization of the SDK
+    ## 5.7.0
+    - Add Privacy Manifest
+    - Fix explicit `self` for `weak self` captures to allow pre 5.8 Swift compilation
+    - Remove web to app banner code
     ## 5.6.0
     - Support the delayed configuration for SDK. Add new public APIs:
@@ Expand Down @@

Optimove.xcodeproj/project.pbxproj

-Original file line number
+Diff line change
@@ Expand Up / @@ -7,13 +7,15 @@ @@
     	objects = {
     /* Begin PBXFileReference section */
+F3A2BA358CB00791552 /* PrivacyInfo.xcprivacy */ = {isa = PBXFileReference; lastKnownFileType = text.xml; path = PrivacyInfo.xcprivacy; sourceTree = "<group>"; };
     		FE31495485A751448C7DF822 /* SDK */ = {isa = PBXFileReference; lastKnownFileType = folder; name = SDK; path = .; sourceTree = SOURCE_ROOT; };
     /* End PBXFileReference section */
     /* Begin PBXGroup section */
 FF4DF40AC6AAC3B8661208C = {
     			isa = PBXGroup;
     			children = (
+F3A2BA358CB00791552 /* PrivacyInfo.xcprivacy */,
 BB5B51B953402330D6DC400 /* Packages */,
     			);
     			sourceTree = "<group>";
@@ Expand Down @@

Optimove.xcodeproj/xcshareddata/xcschemes/UnitTests.xcscheme

-Original file line number
+Diff line change
@@ Expand Up / @@ -11,15 +11,6 @@ @@
           selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
           selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
           shouldUseLaunchSchemeArgsEnv = "YES">
-          <MacroExpansion>
-             <BuildableReference
-                BuildableIdentifier = "primary"
-                BlueprintIdentifier = "7013308FB86B06E91BDD05C2"
-                BuildableName = "libOptimoveCore.a"
-                BlueprintName = "OptimoveCore"
-                ReferencedContainer = "container:Optimove.xcodeproj">
-             </BuildableReference>
-          </MacroExpansion>
           <Testables>
              <TestableReference
                 skipped = "NO">
@@ Expand Down Expand Up / @@ -67,7 +58,7 @@ @@
              <BuildableReference
                 BuildableIdentifier = "primary"
                 BlueprintIdentifier = "7013308FB86B06E91BDD05C2"
-                BuildableName = "libOptimoveCore.a"
+                BuildableName = "OptimoveCore.framework"
                 BlueprintName = "OptimoveCore"
                 ReferencedContainer = "container:Optimove.xcodeproj">
              </BuildableReference>
@@ Expand Down @@

OptimoveCore.podspec

-Original file line number
+Diff line change
@@ -1,6 +1,6 @@
     Pod::Spec.new do |s|
       s.name             = 'OptimoveCore'
-      s.version          = '5.6.0'
+      s.version          = '6.0.0'
       s.summary          = 'Official Optimove SDK for iOS. Core framework.'
       s.description      = 'The core framework is used to share code-base between other Optimove frameworks.'
       s.homepage         = 'https://github.com/optimove-tech/Optimove-SDK-iOS'
@@ Expand Down @@

OptimoveCore/Sources/Classes/Constants/SDKVersion.swift

-Original file line number
+Diff line change
@@ -1,3 +1,3 @@
     //  Copyright © 2019 Optimove. All rights reserved.
-    public let SDKVersion = "5.6.0"
+    public let SDKVersion = "6.0.0"

OptimoveCore/Sources/Classes/OptimobileHelper.swift

-Original file line number
+Diff line change
@@ Expand Up / @@ -42,31 +42,14 @@ public struct OptimobileHelper { @@
             return installId()
         }
-        // FIXME: Use PushNotifcation
-        public func getBadgeFromUserInfo(userInfo: [AnyHashable: Any]) -> NSNumber? {
-            let custom = userInfo["custom"] as? [AnyHashable: Any]
-            let aps = userInfo["aps"] as? [AnyHashable: Any]
-            if custom == nil || aps == nil {
-                return nil
-            }
-            let incrementBy: NSNumber? = custom!["badge_inc"] as? NSNumber
-            let badge: NSNumber? = aps!["badge"] as? NSNumber
-            if badge == nil {
-                return nil
-            }
-            var newBadge: NSNumber? = badge
-            if let incrementBy = incrementBy, let currentVal: NSNumber = storage[.badgeCount] {
-                newBadge = NSNumber(value: currentVal.intValue + incrementBy.intValue)
-                if newBadge!.intValue < 0 {
-                    newBadge = 0
-                }
+        public func getBadge(notification: PushNotification) -> Int? {
+            if let incrementBy = notification.badgeIncrement,
+               let current: Int = storage[.badgeCount]
+            {
+                let badge = current + incrementBy
+                return badge < 0 ? 0 : badge
             }
-            return newBadge
+            return notification.aps.badge
         }
     }

OptimoveCore/Sources/Classes/PushNotification.swift

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -76,7 +76,7 @@ public struct PushNotification: Decodable {
  
        public let aps: Aps

        public let attachment: PushNotification.Attachment?

        /// Optimove badge

        public let badge: Int?

        public let badgeIncrement: Int?

        public let buttons: [PushNotification.Button]?

        public let deeplink: PushNotification.Data?

        public let message: PushNotification.Data

    @@ -86,7 +86,7 @@ public struct PushNotification: Decodable {
  
            case a

            case aps

            case attachments

            case badge = "badge_inc"

            case badgeIncrement = "badge_inc"

            case buttons = "k.buttons"

            case custom

            case deeplink = "k.deepLink"

    @@ -106,7 +106,7 @@ public struct PushNotification: Decodable {
  
            self.attachment = try container.decodeIfPresent(Attachment.self, forKey: .attachments)

            let custom = try container.nestedContainer(keyedBy: CodingKeys.self, forKey: .custom)

            self.badge = try custom.decodeIfPresent(Int.self, forKey: .badge)

            self.badgeIncrement = try custom.decodeIfPresent(Int.self, forKey: .badgeIncrement)

            self.url = try custom.decodeIfPresent(URL.self, forKey: .u)

            let a = try custom.nestedContainer(keyedBy: CodingKeys.self, forKey: .a)

OptimoveCore/Sources/Classes/Storage/KeyValueStorage.swift

-Original file line number
+Diff line change
@@ Expand Up / @@ -11,7 +11,6 @@ public enum StorageKey: String, CaseIterable { @@
         case tenantToken
         case visitorID
         case version
-        case userAgent
         case deviceResolutionWidth
         case deviceResolutionHeight
         case advertisingIdentifier
@@ Expand Down Expand Up / @@ -58,7 +57,6 @@ public protocol StorageValue { @@
         var tenantToken: String? { get set }
         var visitorID: String? { get set }
         var version: String? { get set }
-        var userAgent: String? { get set }
         var deviceResolutionWidth: Float? { get set }
         var deviceResolutionHeight: Float? { get set }
         var advertisingIdentifier: String? { get set }
@@ Expand All / @@ -77,7 +75,6 @@ public protocol StorageValue { @@
         func getTenantToken() throws -> String
         func getVisitorID() throws -> String
         func getVersion() throws -> String
-        func getUserAgent() throws -> String
         func getDeviceResolutionWidth() throws -> Float
         func getDeviceResolutionHeight() throws -> Float
         /// Called when a migration is finished for the version.
@@ Expand Down @@

OptimoveCore/Tests/Sources/PushNotificationTests.swift

-Original file line number
+Diff line change
@@ Expand Up @@
             fileName = "notification-badge.json"
             let decoder = JSONDecoder()
             let notification = try decoder.decode(PushNotification.self, from: data)
-            XCTAssertEqual(notification.badge, 42)
+            XCTAssertEqual(notification.badgeIncrement, 42)
         }
         func test_decode_buttons() throws {
@@ Expand Down @@

OptimoveNotificationServiceExtension.podspec

-Original file line number
+Diff line change
@@ -1,6 +1,6 @@
     Pod::Spec.new do |s|
       s.name             = 'OptimoveNotificationServiceExtension'
-      s.version          = '5.6.0'
+      s.version          = '6.0.0'
       s.summary          = 'Official Optimove SDK for iOS. Notification service extension framework.'
       s.description      = 'The notification service extension is used for handling additional content in push notifications.'
       s.homepage         = 'https://github.com/optimove-tech/Optimove-SDK-iOS'
@@ Expand All / @@ -12,5 +12,8 @@ Pod::Spec.new do |s| @@
       s.swift_version = '5'
       base_dir = "OptimoveNotificationServiceExtension/"
       s.source_files = base_dir + 'Sources/**/*', 'OptimobileShared/**/*'
+      s.resource_bundles = {
+        'OptimoveNotificationServiceExtension' => ['OptimoveNotificationServiceExtension/PrivacyInfo.xcprivacy']
+      }
       s.frameworks = 'Foundation', 'UserNotifications', 'UIKit'
     end

OptimoveNotificationServiceExtension/PrivacyInfo.xcprivacy

-Original file line number
+Diff line change
@@ -0,0 +1,23 @@
+    <?xml version="1.0" encoding="UTF-8"?>
+    <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+    <plist version="1.0">
+    <dict>
+    	<key>NSPrivacyCollectedDataTypes</key>
+    	<array/>
+    	<key>NSPrivacyAccessedAPITypes</key>
+    	<array>
+    		<dict>
+    			<key>NSPrivacyAccessedAPIType</key>
+    			<string>NSPrivacyAccessedAPICategoryUserDefaults</string>
+    			<key>NSPrivacyAccessedAPITypeReasons</key>
+    			<array>
+    				<string>1C8F.1</string>
+    			</array>
+    		</dict>
+    	</array>
+    	<key>NSPrivacyTracking</key>
+    	<false/>
+    	<key>NSPrivacyTrackingDomains</key>
+    	<array/>
+    </dict>
+    </plist>

OptimoveNotificationServiceExtension/Sources/OptimoveNotificationService.swift

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -37,7 +37,7 @@ public enum OptimoveNotificationService {
  
            let data = try JSONSerialization.data(withJSONObject: userInfo)

            let notification = try JSONDecoder().decode(PushNotification.self, from: data)

            if bestAttemptContent.categoryIdentifier.isEmpty {

                bestAttemptContent.categoryIdentifier = await buildCategory(notification: notification)

                bestAttemptContent.categoryIdentifier = await registerCategory(notification: notification)

            }

            if let storage = try? UserDefaults.optimoveAppGroup() {

                let mediaHelper = MediaHelper(storage: storage)

    @@ -48,9 +48,9 @@ public enum OptimoveNotificationService {
  
                    bestAttemptContent.attachments = [attachment]

                }

                let optimobileHelper = OptimobileHelper(storage: storage)

                if let badge = maybeSetBadge(userInfo: userInfo, optimobileHelper: optimobileHelper) {

                if let badge = optimobileHelper.getBadge(notification: notification) {

                    storage.set(value: badge, key: .badgeCount)

                    bestAttemptContent.badge = badge

                    bestAttemptContent.badge = NSNumber(integerLiteral: badge)

                }

                let pendingNoticationHelper = PendingNotificationHelper(storage: storage)

                pendingNoticationHelper.add(

    @@ -94,7 +94,7 @@ public enum OptimoveNotificationService {
  
            }

        }

        static func buildCategory(notification: PushNotification) async -> String {

        static func registerCategory(notification: PushNotification) async -> String {

            let categoryIdentifier = CategoryManager.getCategoryId(messageId: notification.message.id)

            let category = UNNotificationCategory(

                identifier: categoryIdentifier,

    @@ -130,20 +130,4 @@ public enum OptimoveNotificationService {
  
                url: tempURL

            )

        }

        static func maybeSetBadge(

            userInfo: [AnyHashable: Any],

            optimobileHelper: OptimobileHelper

        ) -> NSNumber? {

            let aps = userInfo["aps"] as! [AnyHashable: Any]

            if let contentAvailable = aps["content-available"] as? Int, contentAvailable == 1 {

                return nil

            }

            let newBadge: NSNumber? = optimobileHelper.getBadgeFromUserInfo(userInfo: userInfo)

            if newBadge == nil {

                return nil

            }

            return newBadge

        }

    }

OptimoveSDK.podspec

-Original file line number
+Diff line change
@@ -1,6 +1,6 @@
     Pod::Spec.new do |s|
       s.name             = 'OptimoveSDK'
-      s.version          = '5.6.0'
+      s.version          = '6.0.0'
       s.summary          = 'Official Optimove SDK for iOS.'
       s.description      = 'The Optimove SDK framework is used for reporting events and receive push notifications.'
       s.homepage         = 'https://github.com/optimove-tech/Optimove-SDK-iOS'
@@ Expand All / @@ -14,6 +14,9 @@ Pod::Spec.new do |s| @@
       s.swift_version = '5'
       base_dir = "OptimoveSDK/"
       s.source_files = base_dir + 'Sources/Classes/**/*', 'OptimobileShared/**/*'
+      s.resource_bundles = {
+        'OptimoveSDK' => ['OptimoveSDK/PrivacyInfo.xcprivacy']
+      }
       s.dependency 'OptimoveCore', s.version.to_s
       s.frameworks = 'Foundation', 'UIKit', 'SystemConfiguration', 'UserNotifications', 'CoreData'
     end

OptimoveSDK/PrivacyInfo.xcprivacy

-Original file line number
+Diff line change
@@ -0,0 +1,50 @@
+    <?xml version="1.0" encoding="UTF-8"?>
+    <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+    <plist version="1.0">
+    <dict>
+    	<key>NSPrivacyCollectedDataTypes</key>
+    	<array>
+    		<dict>
+    			<key>NSPrivacyCollectedDataType</key>
+    			<string>NSPrivacyCollectedDataTypeProductInteraction</string>
+    			<key>NSPrivacyCollectedDataTypeLinked</key>
+    			<true/>
+    			<key>NSPrivacyCollectedDataTypeTracking</key>
+    			<false/>
+    			<key>NSPrivacyCollectedDataTypePurposes</key>
+    			<array>
+    				<string>NSPrivacyCollectedDataTypePurposeAnalytics</string>
+    				<string>NSPrivacyCollectedDataTypePurposeProductPersonalization</string>
+    			</array>
+    		</dict>
+    		<dict>
+    			<key>NSPrivacyCollectedDataType</key>
+    			<string>NSPrivacyCollectedDataTypeUserID</string>
+    			<key>NSPrivacyCollectedDataTypeLinked</key>
+    			<true/>
+    			<key>NSPrivacyCollectedDataTypeTracking</key>
+    			<false/>
+    			<key>NSPrivacyCollectedDataTypePurposes</key>
+    			<array>
+    				<string>NSPrivacyCollectedDataTypePurposeAnalytics</string>
+    				<string>NSPrivacyCollectedDataTypePurposeProductPersonalization</string>
+    			</array>
+    		</dict>
+    	</array>
+    	<key>NSPrivacyAccessedAPITypes</key>
+    	<array>
+    		<dict>
+    			<key>NSPrivacyAccessedAPIType</key>
+    			<string>NSPrivacyAccessedAPICategoryUserDefaults</string>
+    			<key>NSPrivacyAccessedAPITypeReasons</key>
+    			<array>
+    				<string>1C8F.1</string>
+    			</array>
+    		</dict>
+    	</array>
+    	<key>NSPrivacyTracking</key>
+    	<false/>
+    	<key>NSPrivacyTrackingDomains</key>
+    	<array/>
+    </dict>
+    </plist>

OptimoveSDK/Sources/Classes/Constants/OptimoveKeys.swift

-Original file line number
+Diff line change
@@ Expand Up / @@ -23,7 +23,6 @@ enum OptimoveKeys { @@
             case userId = "user_id"
             case realtimeUserId = "userId"
             case realtimeupdatedVisitorId = "updatedVisitorId"
-            case setUserAgent = "user_agent_header_event"
             case email
         }
     }

OptimoveSDK/Sources/Classes/DI/Assembly.swift

-Original file line number
+Diff line change
@@ Expand Up / @@ -33,7 +33,8 @@ final class Assembly { @@
         private func migrate() {
             let migrations: [MigrationWork] = [
                 MigrationWork_3_3_0(),
-                MigrationWork_5_7_0(),
+                MigrationWork_6_0_0(),
+                MigrationWork_5_9_0()
             ]
             migrations
                 .filter { $0.isAllowToMiragte(SDKVersion) }
@@ Expand Down @@

OptimoveSDK/Sources/Classes/Events/CoreEvents/SetUserAgent.swift

This file was deleted.

OptimoveSDK/Sources/Classes/Extensions/Bundle+AppVersion.swift

-Original file line number
+Diff line change
@@ Expand Up / @@ -6,4 +6,8 @@ extension Bundle { @@
         var appVersion: String {
             return Bundle.main.infoDictionary?["CFBundleShortVersionString"] as? String ?? "undefined"
         }
+        var buildVersion: String {
+            return Bundle.main.infoDictionary?["CFBundleVersion"] as? String ?? "undefined"
+        }
     }

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: badge arithmetic [5] #93

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

refactor: badge arithmetic [5] #93

Are you sure you want to change the base?

Uh oh!

refactor: badge arithmetic [5] #93

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!