fix: always sort JSON encoded keys (#318)

* fix: always sort JSON encoded keys

* Enable more tests on Linux and Windows

* more query tests

* more tests

* disable tests for linux and windows

* Update CHANGELOG.md

Author: cbaker6

CHANGELOG.md

@@ -2,9 +2,15 @@
 
 ### main
 
-[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/3.1.0...main)
+[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/3.1.1...main)
 * _Contributing to this repo? Add info about your change here to be included in the next release_
 
+### 3.1.1
+[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/3.1.0...3.1.1)
+
+__Fixes__
+- Always sort keys when using the ParseEncoder as it can cause issues when trying to save ParseObject's that have children ([#318](https://github.com/parse-community/Parse-Swift/pull/318)), thanks to [Corey Baker](https://github.com/cbaker6).
+
 ### 3.1.0
 [Full Changelog](https://github.com/parse-community/Parse-Swift/compare/3.0.0...3.1.0)
 

Sources/ParseSwift/Coding/ParseCoding.swift

@@ -20,6 +20,7 @@ extension ParseCoding {
     static func jsonEncoder() -> JSONEncoder {
         let encoder = JSONEncoder()
         encoder.dateEncodingStrategy = parseDateEncodingStrategy
+        encoder.outputFormatting = .sortedKeys
         return encoder
     }
 

Sources/ParseSwift/Coding/ParseEncoder.swift

@@ -95,6 +95,7 @@ public struct ParseEncoder {
         let encoder = _ParseEncoder(codingPath: [], dictionary: NSMutableDictionary(), skippingKeys: SkipKeys.none.keys())
         if let dateEncodingStrategy = dateEncodingStrategy {
             encoder.dateEncodingStrategy = dateEncodingStrategy
+            encoder.outputFormatting = .sortedKeys
         }
         return try encoder.encodeObject(value,
                                         collectChildren: false,
@@ -114,6 +115,7 @@ public struct ParseEncoder {
         if let dateEncodingStrategy = dateEncodingStrategy {
             encoder.dateEncodingStrategy = dateEncodingStrategy
         }
+        encoder.outputFormatting = .sortedKeys
         return try encoder.encodeObject(value,
                                         collectChildren: false,
                                         uniquePointer: nil,
@@ -135,6 +137,7 @@ public struct ParseEncoder {
         if let dateEncodingStrategy = dateEncodingStrategy {
             encoder.dateEncodingStrategy = dateEncodingStrategy
         }
+        encoder.outputFormatting = .sortedKeys
         return try encoder.encodeObject(value,
                                         collectChildren: true,
                                         uniquePointer: try? value.toPointer(),
@@ -157,6 +160,7 @@ public struct ParseEncoder {
         if let dateEncodingStrategy = dateEncodingStrategy {
             encoder.dateEncodingStrategy = dateEncodingStrategy
         }
+        encoder.outputFormatting = .sortedKeys
         return try encoder.encodeObject(value,
                                         collectChildren: collectChildren,
                                         uniquePointer: nil,

Sources/ParseSwift/ParseConstants.swift

@@ -10,7 +10,7 @@ import Foundation
 
 enum ParseConstants {
     static let sdk = "swift"
-    static let version = "3.1.0"
+    static let version = "3.1.1"
     static let fileManagementDirectory = "parse/"
     static let fileManagementPrivateDocumentsDirectory = "Private Documents/"
     static let fileManagementLibraryDirectory = "Library/"

Tests/ParseSwiftTests/IOS13Tests.swift

@@ -90,7 +90,6 @@ class IOS13Tests: XCTestCase { // swiftlint:disable:this type_body_length
         wait(for: [expectation2], timeout: 20.0)
     }
 
-    #if !os(Linux) && !os(Android) && !os(Windows)
     func testSaveCommand() throws {
         let score = GameScore(points: 10)
         let className = score.className
@@ -101,7 +100,7 @@ class IOS13Tests: XCTestCase { // swiftlint:disable:this type_body_length
         XCTAssertEqual(command.method, API.Method.POST)
         XCTAssertNil(command.params)
 
-        let expected = "GameScore ({\"points\":10,\"player\":\"Jen\"})"
+        let expected = "GameScore ({\"player\":\"Jen\",\"points\":10})"
         let decoded = score.debugDescription
         XCTAssertEqual(decoded, expected)
     }
@@ -125,13 +124,12 @@ class IOS13Tests: XCTestCase { // swiftlint:disable:this type_body_length
             return
         }
 
-        let expected = "{\"points\":10,\"player\":\"Jen\"}"
+        let expected = "{\"player\":\"Jen\",\"points\":10}"
         let encoded = try ParseCoding.parseEncoder()
             .encode(body, collectChildren: false,
                     objectsSavedBeforeThisOne: nil,
                     filesSavedBeforeThisOne: nil).encoded
         let decoded = try XCTUnwrap(String(data: encoded, encoding: .utf8))
         XCTAssertEqual(decoded, expected)
     }
-    #endif
 }

Tests/ParseSwiftTests/ParseBytesTests.swift

@@ -39,7 +39,6 @@ class ParseBytesTests: XCTestCase {
         XCTAssertEqual(decoded, bytes)
     }
 
-    #if !os(Linux) && !os(Android) && !os(Windows)
     func testDebugString() {
         let bytes = ParseBytes(base64: "ZnJveW8=")
         let expected = "ParseBytes ({\"__type\":\"Bytes\",\"base64\":\"ZnJveW8=\"})"
@@ -63,5 +62,4 @@ class ParseBytesTests: XCTestCase {
         let bytes2 = ParseBytes(data: data)
         XCTAssertEqual(bytes2.description, expected)
     }
-    #endif
 }

Tests/ParseSwiftTests/ParseCloudTests.swift

@@ -99,7 +99,6 @@ class ParseCloudTests: XCTestCase { // swiftlint:disable:this type_body_length
         XCTAssertEqual(decoded, expected, "\"functionJobName\" key should be skipped by ParseEncoder")
     }
 
-    #if !os(Linux) && !os(Android) && !os(Windows)
     func testDebugString() {
         let cloud = Cloud2(functionJobName: "test", customKey: "parse")
         let expected = "{\"customKey\":\"parse\",\"functionJobName\":\"test\"}"
@@ -111,7 +110,6 @@ class ParseCloudTests: XCTestCase { // swiftlint:disable:this type_body_length
         let expected = "{\"customKey\":\"parse\",\"functionJobName\":\"test\"}"
         XCTAssertEqual(cloud.description, expected)
     }
-    #endif
 
     func testCallFunctionCommand() throws {
         let cloud = Cloud(functionJobName: "test")

Tests/ParseSwiftTests/ParseConfigTests.swift

@@ -146,7 +146,6 @@ class ParseConfigTests: XCTestCase { // swiftlint:disable:this type_body_length
         XCTAssertNil(command.body)
     }
 
-    #if !os(Linux) && !os(Android) && !os(Windows)
     func testDebugString() {
         var config = Config()
         config.welcomeMessage = "Hello"
@@ -160,7 +159,6 @@ class ParseConfigTests: XCTestCase { // swiftlint:disable:this type_body_length
         let expected = "{\"welcomeMessage\":\"Hello\"}"
         XCTAssertEqual(config.description, expected)
     }
-    #endif
 
     func testFetch() {
         userLogin()

Tests/ParseSwiftTests/ParseEncoderTests/TestParseEncoder.swift

@@ -62,14 +62,12 @@ class TestParseEncoder: XCTestCase {
     _testRoundTrip(of: address)
   }
 
-    #if !os(Linux) && !os(Android) && !os(Windows)
   func testEncodingTopLevelStructuredClass() {
     // Person is a class with multiple fields.
-    let expectedJSON = "{\"name\":\"Johnny Appleseed\",\"email\":\"[email protected]\"}".data(using: .utf8)!
+    let expectedJSON = "{\"email\":\"[email protected]\",\"name\":\"Johnny Appleseed\"}".data(using: .utf8)!
     let person = Person.testValue
     _testRoundTrip(of: person, expectedJSON: expectedJSON)
   }
-    #endif
 
   func testEncodingTopLevelStructuredSingleStruct() {
     // Numbers is a struct which encodes as an array through a single value container.
@@ -102,7 +100,7 @@ class TestParseEncoder: XCTestCase {
     _testRoundTrip(of: EnhancedBool.fileNotFound, expectedJSON: "null".data(using: .utf8)!)
   }
 
-    #if !os(Linux) && !os(Android) && !os(Windows)
+#if !os(Linux) && !os(Android) && !os(Windows)
   func testEncodingMultipleNestedContainersWithTheSameTopLevelKey() {
     struct Model: Codable, Equatable {
       let first: String
@@ -159,7 +157,6 @@ class TestParseEncoder: XCTestCase {
     }
   }
     #endif
-
     /*
   func testEncodingConflictedTypeNestedContainersWithTheSameTopLevelKey() throws {
     struct Model: Encodable, Equatable {
@@ -202,13 +199,11 @@ class TestParseEncoder: XCTestCase {
   }*/
 
   // MARK: - Output Formatting Tests
-    #if !os(Linux) && !os(Android) && !os(Windows)
   func testEncodingOutputFormattingDefault() {
-    let expectedJSON = "{\"name\":\"Johnny Appleseed\",\"email\":\"[email protected]\"}".data(using: .utf8)!
+    let expectedJSON = "{\"email\":\"[email protected]\",\"name\":\"Johnny Appleseed\"}".data(using: .utf8)!
     let person = Person.testValue
     _testRoundTrip(of: person, expectedJSON: expectedJSON)
   }
-    #endif
 /*
   func testEncodingOutputFormattingPrettyPrinted() {
     let expectedJSON = "{\n  \"name\" : \"Johnny Appleseed\",\n  \"email\" : \"[email protected]\"\n}".data(using: .utf8)!

Tests/ParseSwiftTests/ParseFileTests.swift

@@ -193,7 +193,6 @@ class ParseFileTests: XCTestCase { // swiftlint:disable:this type_body_length
         XCTAssertEqual(parseFile1, parseFile2, "no urls, but localIds shoud be the same")
     }
 
-    #if !os(Linux) && !os(Android) && !os(Windows)
     func testDebugString() throws {
         guard let sampleData = "Hello World".data(using: .utf8) else {
             throw ParseError(code: .unknownError, message: "Should have converted to data")
@@ -203,11 +202,10 @@ class ParseFileTests: XCTestCase { // swiftlint:disable:this type_body_length
                                   metadata: ["Testing": "123"],
                                   tags: ["Hey": "now"])
         XCTAssertEqual(parseFile.debugDescription,
-                       "ParseFile ({\"name\":\"sampleData.txt\",\"__type\":\"File\"})")
+                       "ParseFile ({\"__type\":\"File\",\"name\":\"sampleData.txt\"})")
         XCTAssertEqual(parseFile.description,
-                       "ParseFile ({\"name\":\"sampleData.txt\",\"__type\":\"File\"})")
+                       "ParseFile ({\"__type\":\"File\",\"name\":\"sampleData.txt\"})")
     }
-    #endif
 
     func testSave() throws {
         guard let sampleData = "Hello World".data(using: .utf8) else {