feat: allow any dimension value for ParseAnalytics (#341)

cbaker6 · web-flow · commit c8252bcda8ea · 2022-02-07T02:18:27.000-05:00
* feat: allow any dimension value for ParseAnalytics

* nit changelog

* nits

* Update .codecov.yml

* coverage

* more coverage

* improve
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,9 +2,15 @@
 
 ### main
 
-[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/4.0.1...main)
+[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/4.1.0...main)
 * _Contributing to this repo? Add info about your change here to be included in the next release_
 
+### 4.1.0
+[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/4.0.1...4.1.0)
+
+__Improvements__
+- Let the OS and developer decide if app tracking authorization is required when using ParseAnalytics. ParseAnalytics can now take any Codable value in its' dimensions instead of just strings. Added a new property "date" to ParseAnalytics. The "at" property will be deprecated in ParseSwift 5.0.0, so developers should switch to "date". ParseAnalytics can now be properly decoded after encoding with a JSONEncoder. This is useful if ParseAnalytics need to be stored locally and sent to the server later ([#341](https://github.com/parse-community/Parse-Swift/pull/341)), thanks to [Corey Baker](https://github.com/cbaker6).
+
 ### 4.0.1
 [Full Changelog](https://github.com/parse-community/Parse-Swift/compare/4.0.0...4.0.1)
 
@@ -21,7 +27,7 @@ __New features__
 - Add DocC for SDK documentation ([#209](https://github.com/parse-community/Parse-Swift/pull/214)), thanks to [Corey Baker](https://github.com/cbaker6).
 
 __Improvements__
-- (Breaking Change) Make ParseRelation conform to Codable and add methods to make decoded stored ParseRelations "usable". ParseObjects can now contain properties of ParseRelation<Self>. In addition, ParseRelations can now be made from ParseObject pointers. For ParseRole, the computed properties: users and roles, are now optional. The queryRoles property has been changed to queryRoles() to improve the handling of thrown errors ([#328](https://github.com/parse-community/Parse-Swift/pull/328)), thanks to @cbaker6.
+- (Breaking Change) Make ParseRelation conform to Codable and add methods to make decoded stored ParseRelations "usable". ParseObjects can now contain properties of ParseRelation<Self>. In addition, ParseRelations can now be made from ParseObject pointers. For ParseRole, the computed properties: users and roles, are now optional. The queryRoles property has been changed to queryRoles() to improve the handling of thrown errors ([#328](https://github.com/parse-community/Parse-Swift/pull/328)), thanks to [Corey Baker](https://github.com/cbaker6).
 - (Breaking Change) Change the following method parameter names: isUsingMongoDB -> usingMongoDB, isIgnoreCustomObjectIdConfig -> ignoringCustomObjectIdConfig, isUsingEQ -> usingEqComparator ([#321](https://github.com/parse-community/Parse-Swift/pull/321)), thanks to [Corey Baker](https://github.com/cbaker6).
 - (Breaking Change) Change the following method parameter names: isUsingMongoDB -> usingMongoDB, isIgnoreCustomObjectIdConfig -> ignoringCustomObjectIdConfig, isUsingEQ -> usingEqComparator ([#321](https://github.com/parse-community/Parse-Swift/pull/321)), thanks to [Corey Baker](https://github.com/cbaker6).
 - (Breaking Change) Change the following method parameter names: isUsingTransactions -> usingTransactions, isAllowingCustomObjectIds -> allowingCustomObjectIds, isUsingEqualQueryConstraint -> usingEqualQueryConstraint, isMigratingFromObjcSDK -> migratingFromObjcSDK, isDeletingKeychainIfNeeded -> deletingKeychainIfNeeded ([#323](https://github.com/parse-community/Parse-Swift/pull/323)), thanks to [Corey Baker](https://github.com/cbaker6).
diff --git a/ParseSwift.xcodeproj/project.pbxproj b/ParseSwift.xcodeproj/project.pbxproj
diff --git a/Sources/ParseSwift/Coding/ParseEncoder.swift b/Sources/ParseSwift/Coding/ParseEncoder.swift
@@ -191,7 +191,7 @@ public struct ParseEncoder {
 }
 
 // MARK: _ParseEncoder
-private class _ParseEncoder: JSONEncoder, Encoder {
+internal class _ParseEncoder: JSONEncoder, Encoder {
     var codingPath: [CodingKey]
     let dictionary: NSMutableDictionary
     let skippedKeys: Set<String>
diff --git a/Sources/ParseSwift/LiveQuery/ParseLiveQuery+async.swift b/Sources/ParseSwift/LiveQuery/ParseLiveQuery+async.swift
@@ -10,7 +10,7 @@
 import Foundation
 
 extension ParseLiveQuery {
-    // MARK: Async/Await
+    // MARK: Connection - Async/Await
 
     /**
      Manually establish a connection to the `ParseLiveQuery` Server.
diff --git a/Sources/ParseSwift/LiveQuery/ParseLiveQuery+combine.swift b/Sources/ParseSwift/LiveQuery/ParseLiveQuery+combine.swift
@@ -11,7 +11,7 @@ import Foundation
 import Combine
 
 extension ParseLiveQuery {
-    // MARK: Combine
+    // MARK: Connection - Combine
 
     /**
      Manually establish a connection to the `ParseLiveQuery` Server. Publishes when established.
diff --git a/Sources/ParseSwift/LiveQuery/ParseLiveQuery.swift b/Sources/ParseSwift/LiveQuery/ParseLiveQuery.swift
@@ -223,7 +223,6 @@ Not attempting to open ParseLiveQuery socket anymore
     }
 }
 
-// MARK: Helpers
 extension ParseLiveQuery {
 
     /// Current LiveQuery client.
diff --git a/Sources/ParseSwift/Objects/ParseRole.swift b/Sources/ParseSwift/Objects/ParseRole.swift
@@ -98,11 +98,11 @@ public extension ParseRole {
     }
 
     static func == (lhs: Self, rhs: Self) -> Bool {
-        lhs.name == rhs.name && lhs.className == rhs.className
+        lhs.debugDescription == rhs.debugDescription
     }
 
     func hash(into hasher: inout Hasher) {
-        hasher.combine("\(self.className)_\(String(describing: self.name))")
+        hasher.combine(self.debugDescription)
     }
 }
 
diff --git a/Sources/ParseSwift/ParseConstants.swift b/Sources/ParseSwift/ParseConstants.swift
@@ -10,7 +10,7 @@ import Foundation
 
 enum ParseConstants {
     static let sdk = "swift"
-    static let version = "4.0.1"
+    static let version = "4.1.0"
     static let fileManagementDirectory = "parse/"
     static let fileManagementPrivateDocumentsDirectory = "Private Documents/"
     static let fileManagementLibraryDirectory = "Library/"
diff --git a/Sources/ParseSwift/Types/ParseACL.swift b/Sources/ParseSwift/Types/ParseACL.swift
@@ -32,7 +32,10 @@ public struct ParseACL: ParseType,
         case write
 
         public init(from decoder: Decoder) throws {
-            self = Access(rawValue: try decoder.singleValueContainer().decode(String.self))!
+            guard let decoded = Access(rawValue: try decoder.singleValueContainer().decode(String.self)) else {
+                throw ParseError(code: .unknownError, message: "Not able to decode ParseACL Access")
+            }
+            self = decoded
         }
 
         public func encode(to encoder: Encoder) throws {
diff --git a/Sources/ParseSwift/Types/ParseAnalytics+async.swift b/Sources/ParseSwift/Types/ParseAnalytics+async.swift
@@ -96,19 +96,19 @@ public extension ParseAnalytics {
      - parameter at: Explicitly set the time associated with a given event. If not provided the
      server time will be used.
      - parameter options: A set of header options sent to the server. Defaults to an empty set.
-     - warning: This method makes a copy of the current `ParseAnalytics` and then mutates
-     it. You will not have access to the mutated analytic after calling this method.
      - throws: An error of type `ParseError`.
     */
-    func track(dimensions: [String: String]?,
-               at date: Date? = nil,
-               options: API.Options = []) async throws {
-        let _: Void = try await withCheckedThrowingContinuation { continuation in
-            var analytic = self
-            analytic.track(dimensions: dimensions,
-                           at: date,
-                           options: options,
-                           completion: continuation.resume)
+    mutating func track(dimensions: [String: String]?,
+                        at date: Date? = nil,
+                        options: API.Options = []) async throws {
+        let result = try await withCheckedThrowingContinuation { continuation in
+            self.track(dimensions: dimensions,
+                       at: date,
+                       options: options,
+                       completion: continuation.resume)
+        }
+        if case let .failure(error) = result {
+            throw error
         }
     }
 }
diff --git a/Sources/ParseSwift/Types/ParseAnalytics.swift b/Sources/ParseSwift/Types/ParseAnalytics.swift
@@ -11,32 +11,46 @@ import Foundation
 import UIKit
 #endif
 
-#if canImport(AppTrackingTransparency)
-import AppTrackingTransparency
-#endif
-
 /**
-  `ParseAnalytics` provides an interface to Parse's logging and analytics
- backend.
- 
- - warning: For iOS 14.0, macOS 11.0, macCatalyst 14.0, tvOS 14.0, you
- will need to request tracking authorization for ParseAnalytics to work.
- See Apple's [documentation](https://developer.apple.com/documentation/apptrackingtransparency) for more for details.
+ `ParseAnalytics` provides an interface to Parse's logging and analytics backend.
  */
 public struct ParseAnalytics: ParseType, Hashable {
 
     /// The name of the custom event to report to Parse as having happened.
-    public let name: String
+    public var name: String
 
     /// Explicitly set the time associated with a given event. If not provided the server
     /// time will be used.
-    public var at: Date? // swiftlint:disable:this identifier_name
+    /// - warning: This will be deprecated in ParseSwift 5.0.0 in favor of `date`.
+    public var at: Date? { // swiftlint:disable:this identifier_name
+        get {
+            date
+        }
+        set {
+            date = newValue
+        }
+    }
+
+    /// Explicitly set the time associated with a given event. If not provided the server
+    /// time will be used.
+    public var date: Date?
 
     /// The dictionary of information by which to segment this event.
-    public var dimensions: [String: String]?
+    public var dimensions: [String: Codable]? {
+        get {
+            convertToString(dimensionsAnyCodable)
+        }
+        set {
+            dimensionsAnyCodable = convertToAnyCodable(newValue)
+        }
+    }
+
+    var dimensionsAnyCodable: [String: AnyCodable]?
 
     enum CodingKeys: String, CodingKey {
-        case at, dimensions // swiftlint:disable:this identifier_name
+        case date = "at"
+        case dimensions
+        case name
     }
 
     /**
@@ -47,13 +61,55 @@ public struct ParseAnalytics: ParseType, Hashable {
      time will be used. Defaults to `nil`.
      */
     public init (name: String,
-                 dimensions: [String: String]? = nil,
-                 at: Date? = nil) { // swiftlint:disable:this identifier_name
+                 dimensions: [String: Codable]? = nil,
+                 at date: Date? = nil) {
         self.name = name
-        self.dimensions = dimensions
-        self.at = at
+        self.dimensionsAnyCodable = convertToAnyCodable(dimensions)
+        self.date = date
+    }
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encodeIfPresent(date, forKey: .date)
+        try container.encodeIfPresent(dimensionsAnyCodable, forKey: .dimensions)
+        if !(encoder is _ParseEncoder) {
+            try container.encode(name, forKey: .name)
+        }
+    }
+
+    public static func == (lhs: Self, rhs: Self) -> Bool {
+        lhs.debugDescription == rhs.debugDescription
+    }
+
+    public func hash(into hasher: inout Hasher) {
+        hasher.combine(self.debugDescription)
+    }
+
+    // MARK: Helpers
+    func convertToAnyCodable(_ dimensions: [String: Codable]?) -> [String: AnyCodable]? {
+        guard let dimensions = dimensions else {
+            return nil
+        }
+        var convertedDimensions = [String: AnyCodable]()
+        for (key, value) in dimensions {
+            convertedDimensions[key] = AnyCodable(value)
+        }
+        return convertedDimensions
+    }
+
+    func convertToString(_ dimensions: [String: AnyCodable]?) -> [String: String]? {
+        guard let dimensions = dimensions else {
+            return nil
+        }
+        var convertedDimensions = [String: String]()
+        for (key, value) in dimensions {
+            convertedDimensions[key] = "\(value.value)"
+        }
+        return convertedDimensions
     }
 
+    // MARK: Intents
+
     #if os(iOS)
     /**
      Tracks *asynchronously* this application being launched. If this happened as the result of the
@@ -79,22 +135,6 @@ public struct ParseAnalytics: ParseType, Hashable {
                                       completion: @escaping (Result<Void, ParseError>) -> Void) {
         var options = options
         options.insert(.cachePolicy(.reloadIgnoringLocalCacheData))
-        #if canImport(AppTrackingTransparency)
-        if #available(macOS 11.0, iOS 14.0, macCatalyst 14.0, tvOS 14.0, *) {
-            if !ParseSwift.configuration.isTestingSDK {
-                let status = ATTrackingManager.trackingAuthorizationStatus
-                if status != .authorized {
-                    callbackQueue.async {
-                        let error = ParseError(code: .unknownError,
-                                               // swiftlint:disable:next line_length
-                                               message: "App tracking not authorized. Please request permission from user.")
-                        completion(.failure(error))
-                    }
-                    return
-                }
-            }
-        }
-        #endif
         var userInfo: [String: String]?
         if let remoteOptions = launchOptions?[.remoteNotification] as? [String: String] {
             userInfo = remoteOptions
@@ -118,7 +158,7 @@ public struct ParseAnalytics: ParseType, Hashable {
      Tracks *asynchronously* this application being launched with additional dimensions.
      
      - parameter dimensions: The dictionary of information by which to segment this
-     event and can be empty or `nil`.
+     event. Can be empty or `nil`.
      - parameter at: Explicitly set the time associated with a given event. If not provided the
      server time will be used.
      - parameter options: A set of header options sent to the server. Defaults to an empty set.
@@ -135,22 +175,6 @@ public struct ParseAnalytics: ParseType, Hashable {
                                       completion: @escaping (Result<Void, ParseError>) -> Void) {
         var options = options
         options.insert(.cachePolicy(.reloadIgnoringLocalCacheData))
-        #if canImport(AppTrackingTransparency)
-        if #available(macOS 11.0, iOS 14.0, macCatalyst 14.0, tvOS 14.0, *) {
-            if !ParseSwift.configuration.isTestingSDK {
-                let status = ATTrackingManager.trackingAuthorizationStatus
-                if status != .authorized {
-                    callbackQueue.async {
-                        let error = ParseError(code: .unknownError,
-                                               // swiftlint:disable:next line_length
-                                               message: "App tracking not authorized. Please request permission from user.")
-                        completion(.failure(error))
-                    }
-                    return
-                }
-            }
-        }
-        #endif
         let appOppened = ParseAnalytics(name: "AppOpened",
                                         dimensions: dimensions,
                                         at: date)
@@ -180,22 +204,6 @@ public struct ParseAnalytics: ParseType, Hashable {
                       completion: @escaping (Result<Void, ParseError>) -> Void) {
         var options = options
         options.insert(.cachePolicy(.reloadIgnoringLocalCacheData))
-        #if canImport(AppTrackingTransparency)
-        if #available(macOS 11.0, iOS 14.0, macCatalyst 14.0, tvOS 14.0, *) {
-            if !ParseSwift.configuration.isTestingSDK {
-                let status = ATTrackingManager.trackingAuthorizationStatus
-                if status != .authorized {
-                    callbackQueue.async {
-                        let error = ParseError(code: .unknownError,
-                                               // swiftlint:disable:next line_length
-                                               message: "App tracking not authorized. Please request permission from user.")
-                        completion(.failure(error))
-                    }
-                    return
-                }
-            }
-        }
-        #endif
         self.saveCommand().executeAsync(options: options,
                                         callbackQueue: callbackQueue) { result in
             switch result {
@@ -211,7 +219,7 @@ public struct ParseAnalytics: ParseType, Hashable {
      Tracks *asynchronously* the occurrence of a custom event with additional dimensions.
      
      - parameter dimensions: The dictionary of information by which to segment this
-     event and can be empty or `nil`.
+     event. Can be empty or `nil`.
      - parameter at: Explicitly set the time associated with a given event. If not provided the
      server time will be used.
      - parameter options: A set of header options sent to the server. Defaults to an empty set.
@@ -228,24 +236,8 @@ public struct ParseAnalytics: ParseType, Hashable {
                                completion: @escaping (Result<Void, ParseError>) -> Void) {
         var options = options
         options.insert(.cachePolicy(.reloadIgnoringLocalCacheData))
-        #if canImport(AppTrackingTransparency)
-        if #available(macOS 11.0, iOS 14.0, macCatalyst 14.0, tvOS 14.0, *) {
-            if !ParseSwift.configuration.isTestingSDK {
-                let status = ATTrackingManager.trackingAuthorizationStatus
-                if status != .authorized {
-                    callbackQueue.async {
-                        let error = ParseError(code: .unknownError,
-                                               // swiftlint:disable:next line_length
-                                               message: "App tracking not authorized. Please request permission from user.")
-                        completion(.failure(error))
-                    }
-                    return
-                }
-            }
-        }
-        #endif
-        self.dimensions = dimensions
-        self.at = date
+        self.dimensionsAnyCodable = convertToAnyCodable(dimensions)
+        self.date = date
         self.saveCommand().executeAsync(options: options,
                                         callbackQueue: callbackQueue) { result in
             switch result {
diff --git a/Tests/ParseSwiftTests/ParseACLTests.swift b/Tests/ParseSwiftTests/ParseACLTests.swift
@@ -215,6 +215,22 @@ class ParseACLTests: XCTestCase {
         }
     }
 
+    func testCodingAccess() throws {
+        let access = ParseACL.Access.read
+        let encoded = try ParseCoding.jsonEncoder().encode(access)
+        let decoded = try ParseCoding.jsonDecoder().decode(ParseACL.Access.self, from: encoded)
+        XCTAssertEqual(access, decoded)
+        let access2 = ParseACL.Access.write
+        let encoded2 = try ParseCoding.jsonEncoder().encode(access2)
+        let decoded2 = try ParseCoding.jsonDecoder().decode(ParseACL.Access.self, from: encoded2)
+        XCTAssertEqual(access2, decoded2)
+        guard let data = "hello".data(using: .utf8) else {
+            XCTFail("Should have unwrapped")
+            return
+        }
+        XCTAssertThrowsError(try ParseCoding.jsonDecoder().decode(ParseACL.Access.self, from: data))
+    }
+
     func testDebugString() {
         var acl = ParseACL()
         acl.setReadAccess(objectId: "a", value: false)
diff --git a/Tests/ParseSwiftTests/ParseAnalyticsAsyncTests.swift b/Tests/ParseSwiftTests/ParseAnalyticsAsyncTests.swift
diff --git a/Tests/ParseSwiftTests/ParseAnalyticsCombineTests.swift b/Tests/ParseSwiftTests/ParseAnalyticsCombineTests.swift
diff --git a/Tests/ParseSwiftTests/ParseAnalyticsTests.swift b/Tests/ParseSwiftTests/ParseAnalyticsTests.swift

Original file line number	Diff line number	Diff line change
`@@ -191,7 +191,7 @@ public struct ParseEncoder {`
`191`	`191`	`}`
`192`	`192`
`193`	`193`	`// MARK: _ParseEncoder`
`194`		`-private class _ParseEncoder: JSONEncoder, Encoder {`
	`194`	`+internal class _ParseEncoder: JSONEncoder, Encoder {`
`195`	`195`	`var codingPath: [CodingKey]`
`196`	`196`	`let dictionary: NSMutableDictionary`
`197`	`197`	`let skippedKeys: Set<String>`
Original file line number	Diff line number	Diff line change
`@@ -223,7 +223,6 @@ Not attempting to open ParseLiveQuery socket anymore`
`223`	`223`	`}`
`224`	`224`	`}`
`225`	`225`
`226`		`-// MARK: Helpers`
`227`	`226`	`extension ParseLiveQuery {`
`228`	`227`
`229`	`228`	`/// Current LiveQuery client.`
Original file line number	Diff line number	Diff line change
`@@ -98,11 +98,11 @@ public extension ParseRole {`
`98`	`98`	`}`
`99`	`99`
`100`	`100`	`static func == (lhs: Self, rhs: Self) -> Bool {`
`101`		`- lhs.name == rhs.name && lhs.className == rhs.className`
	`101`	`+ lhs.debugDescription == rhs.debugDescription`
`102`	`102`	`}`
`103`	`103`
`104`	`104`	`func hash(into hasher: inout Hasher) {`
`105`		`- hasher.combine("\(self.className)_\(String(describing: self.name))")`
	`105`	`+ hasher.combine(self.debugDescription)`
`106`	`106`	`}`
`107`	`107`	`}`
`108`	`108`