Merge pull request #94 from NeedleInAJayStack/fix/JSONResultOrdering

Fixes Encoded JSON Result Ordering

Author: NeedleInAJayStack

README.md

@@ -14,6 +14,12 @@ Looking for help? Find resources [from the community](http://graphql.org/communi
 
 This repo only contains the core GraphQL implementation. For a better experience when creating your GraphQL schema use [Graphiti](https://github.com/GraphQLSwift/Graphiti).
 
+## Encoding Results
+
+If you encode a `GraphQLResult` with an ordinary `JSONEncoder`, there are no guarantees that the field order will match the query, 
+violating the [GraphQL spec](https://spec.graphql.org/June2018/#sec-Serialized-Map-Ordering). To preserve this order, `GraphQLResult`
+should be encoded using the `GraphQLJSONEncoder` provided by this package.
+
 ## Contributing
 
 Most of this repo mirrors the structure of the canonical GraphQL implementation written in Javascript/Typescript. If there is any feature missing, looking at the original code and "translating" it to Swift works, most of the time. For example:

Sources/GraphQL/GraphQL.swift

@@ -1,4 +1,3 @@
-import Foundation
 import NIO
 
 public struct GraphQLResult : Equatable, Codable, CustomStringConvertible {
@@ -34,7 +33,7 @@ public struct GraphQLResult : Equatable, Codable, CustomStringConvertible {
     }
 
     public var description: String {
-        let data = try! JSONEncoder().encode(self)
+        let data = try! GraphQLJSONEncoder().encode(self)
         return String(data: data, encoding: .utf8)!
     }
 }