[tests] Add dictionary sorting to request's parameters

* There is a need to compare two User Update Requests, with limitations of comparing Objc dictionaries to Swift dictionaries, and the Mock Client not knowing about product-specific OneSignalRequest implementations like OSRequestUpdateUser.
* So, we can do comparison via their parameters payload.
* Add logic to stringify the params in alphabetical order to allow streamlined comparison

Author: nan-li

iOS_SDK/OneSignalSDK/OneSignal.xcodeproj/project.pbxproj

@@ -155,6 +155,7 @@
 		3CE8CC5B29143F4B000DB0D3 /* NSDateFormatter+OneSignal.m in Sources */ = {isa = PBXBuildFile; fileRef = DE98772A2591655800DE07D5 /* NSDateFormatter+OneSignal.m */; };
 		3CE9227A289FA88B001B1062 /* OSIdentityModelStoreListener.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3CE92279289FA88B001B1062 /* OSIdentityModelStoreListener.swift */; };
 		3CEE90A72BFE6ABD00B0FB5B /* SupportedProperty.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3CEE90A62BFE6ABD00B0FB5B /* SupportedProperty.swift */; };
+		3CEE90A92C000BD500B0FB5B /* OneSignalRequest+UnitTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3CEE90A82C000BD500B0FB5B /* OneSignalRequest+UnitTests.swift */; };
 		3CEE93422B7C4174008440BD /* OneSignalUserMocks.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 3CC063DD2B6D7F2A002BB07F /* OneSignalUserMocks.framework */; };
 		3CEE93432B7C4174008440BD /* OneSignalUserMocks.framework in Embed Frameworks */ = {isa = PBXBuildFile; fileRef = 3CC063DD2B6D7F2A002BB07F /* OneSignalUserMocks.framework */; settings = {ATTRIBUTES = (CodeSignOnCopy, RemoveHeadersOnCopy, ); }; };
 		3CEE93462B7C73AB008440BD /* OneSignalCoreMocks.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 3CC0639A2B6D7A8C002BB07F /* OneSignalCoreMocks.framework */; };
@@ -1189,6 +1190,7 @@
 		3CE8CC572911B2B2000DB0D3 /* SystemConfiguration.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = SystemConfiguration.framework; path = Platforms/MacOSX.platform/Developer/SDKs/MacOSX12.3.sdk/System/Library/Frameworks/SystemConfiguration.framework; sourceTree = DEVELOPER_DIR; };
 		3CE92279289FA88B001B1062 /* OSIdentityModelStoreListener.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OSIdentityModelStoreListener.swift; sourceTree = "<group>"; };
 		3CEE90A62BFE6ABD00B0FB5B /* SupportedProperty.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SupportedProperty.swift; sourceTree = "<group>"; };
+		3CEE90A82C000BD500B0FB5B /* OneSignalRequest+UnitTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "OneSignalRequest+UnitTests.swift"; sourceTree = "<group>"; };
 		3CF8629D28A183F900776CA4 /* OSIdentityModel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OSIdentityModel.swift; sourceTree = "<group>"; };
 		3CF8629F28A1964F00776CA4 /* OSPropertiesModel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OSPropertiesModel.swift; sourceTree = "<group>"; };
 		3CF862A128A197D200776CA4 /* OSPropertiesModelStoreListener.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OSPropertiesModelStoreListener.swift; sourceTree = "<group>"; };
@@ -1912,6 +1914,7 @@
 			isa = PBXGroup;
 			children = (
 				3C8706752BDEED75000D8CD2 /* NSDictionary+UnitTests.swift */,
+				3CEE90A82C000BD500B0FB5B /* OneSignalRequest+UnitTests.swift */,
 			);
 			path = Extensions;
 			sourceTree = "<group>";
@@ -3760,6 +3763,7 @@
 				4710EA552B8FD04400435356 /* MockOSDispatchQueue.swift in Sources */,
 				3CC063B22B6D7AD8002BB07F /* MockOneSignalClient.swift in Sources */,
 				3C8706762BDEED75000D8CD2 /* NSDictionary+UnitTests.swift in Sources */,
+				3CEE90A92C000BD500B0FB5B /* OneSignalRequest+UnitTests.swift in Sources */,
 				3CC063B42B6D7BA2002BB07F /* OneSignalCoreMocks.swift in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;

iOS_SDK/OneSignalSDK/OneSignalCoreMocks/Extensions/NSDictionary+UnitTests.swift

@@ -70,4 +70,28 @@ extension NSDictionary {
         guard y is AnyHashable else { return false }
         return (x as! AnyHashable) == (y as! AnyHashable)
     }
+
+    /**
+     Returns a string representation of a dictionary in alphabetical order by key.
+     If there are dictionaries within this dictionary, those will also be stringified in alphabetical order by key.
+     This method is motivated by the need to compare two requests whose payloads may be unordered dictionaries.
+     */
+    public func toSortedString() -> String {
+        guard let dict = self as? [String: Any] else {
+            return "[:]"
+        }
+        var result = "["
+        let sortedKeys = Array(dict.keys).sorted(by: <)
+        for key in sortedKeys {
+            if let value = dict[key] as? NSDictionary {
+                result += " \(key): \(value.toSortedString()),"
+            } else {
+                result += " \(key): \(String(describing: dict[key])),"
+            }
+        }
+        // drop the last comma within a dictionary's items
+        result = String(result.dropLast())
+        result += "]"
+        return result
+    }
 }

iOS_SDK/OneSignalSDK/OneSignalCoreMocks/Extensions/OneSignalRequest+UnitTests.swift

@@ -0,0 +1,11 @@
+import OneSignalCore
+
+extension OneSignalRequest {
+    /// Returns alphabetically ordered string representation of request's parameters
+    public func stringifyParams() -> String {
+        guard let dict = self.parameters as? NSDictionary else {
+            return "[:]"
+        }
+        return dict.toSortedString()
+    }
+}

iOS_SDK/OneSignalSDK/OneSignalCoreMocks/MockOneSignalClient.swift

@@ -101,6 +101,21 @@ public class MockOneSignalClient: NSObject, IOneSignalClient {
         }
     }
 
+    /// Helper method to stringify the name of a request for identification and comparison
+    private func stringify(_ request: OneSignalRequest) -> String {
+        var stringified = request.description
+
+        switch request.description {
+        case let str where str.contains("OSRequestUpdateProperties"):
+            // Return an ordered representation of the request parameters
+            stringified = "<OSRequestUpdateProperties with parameters: \(request.stringifyParams())>"
+        default:
+            break
+        }
+
+        return stringified
+    }
+
     func finishExecutingRequest(_ request: OneSignalRequest, onSuccess successBlock: OSResultSuccessBlock, onFailure failureBlock: OSFailureBlock) {
 
         // TODO: This entire method needs to contained within the equivalent of @synchronized ❗️
@@ -110,18 +125,19 @@ public class MockOneSignalClient: NSObject, IOneSignalClient {
 
         self.didCompleteRequest(request)
 
+        let stringifiedRequest = stringify(request)
         // Switch between types of requests with mock responses
         if request.isKind(of: OSRequestGetIosParams.self) {
             // send a mock remote params response
             successBlock(["mockTodo": "responseTodo"])
         }
-        if (mockResponses[String(describing: request)]) != nil {
-            successBlock(mockResponses[String(describing: request)])
-        } else if (mockFailureResponses[String(describing: request)]) != nil {
-            failureBlock(mockFailureResponses[String(describing: request)])
+        if (mockResponses[stringifiedRequest]) != nil {
+            successBlock(mockResponses[stringifiedRequest])
+        } else if (mockFailureResponses[stringifiedRequest]) != nil {
+            failureBlock(mockFailureResponses[stringifiedRequest])
         } else {
             allRequestsHandled = false
-            print("🧪 cannot find a mock response for request: \(request)")
+            print("🧪 cannot find a mock response for request: \(stringifiedRequest)")
         }
     }