Merge pull request #575 from kyasu1/serialize-by-ordered-dict

Preserve the serialization order for mutations

Author: dillonkearns

elm.json

@@ -23,6 +23,7 @@
         "elm/json": "1.1.1 <= v < 2.0.0",
         "elm/url": "1.0.0 <= v < 2.0.0",
         "elm-community/list-extra": "8.0.0 <= v < 9.0.0",
+        "j-maas/elm-ordered-containers": "1.0.0 <= v < 2.0.0",
         "lukewestby/elm-string-interpolate": "1.0.4 <= v < 2.0.0"
     },
     "test-dependencies": {

ete_tests/elm.json

@@ -16,6 +16,7 @@
             "elm/json": "1.1.2",
             "elm/url": "1.0.0",
             "elm-community/list-extra": "8.0.0",
+            "j-maas/elm-ordered-containers": "1.0.0",
             "krisajenkins/remotedata": "6.0.1",
             "lukewestby/elm-string-interpolate": "1.0.4"
         },

examples/complex/elm.json

@@ -17,6 +17,7 @@
             "elm/time": "1.0.0",
             "elm/url": "1.0.0",
             "elm-community/list-extra": "8.0.0",
+            "j-maas/elm-ordered-containers": "1.0.0",
             "krisajenkins/remotedata": "6.0.1",
             "lukewestby/elm-string-interpolate": "1.0.4",
             "mdgriffith/elm-ui": "1.1.0",

examples/elm.json

@@ -16,6 +16,7 @@
             "elm/time": "1.0.0",
             "elm/url": "1.0.0",
             "elm-community/list-extra": "8.0.0",
+            "j-maas/elm-ordered-containers": "1.0.0",
             "krisajenkins/remotedata": "6.0.1",
             "lukewestby/elm-string-interpolate": "1.0.4",
             "mdgriffith/elm-ui": "1.1.0",

examples/subscription/elm.json

@@ -17,6 +17,7 @@
             "elm/time": "1.0.0",
             "elm/url": "1.0.0",
             "elm-community/list-extra": "8.0.0",
+            "j-maas/elm-ordered-containers": "1.0.0",
             "krisajenkins/remotedata": "6.0.1",
             "lukewestby/elm-string-interpolate": "1.0.4",
             "mdgriffith/elm-ui": "1.1.0",

src/Graphql/Document/Field.elm

@@ -1,11 +1,14 @@
 module Graphql.Document.Field exposing (hashedAliasName, serializeChildren)
 
-import Dict exposing (Dict)
 import Graphql.Document.Argument as Argument
 import Graphql.Document.Hash exposing (hashString)
 import Graphql.Document.Indent as Indent
-import Graphql.Internal.Builder.Argument exposing (Argument)
 import Graphql.RawField exposing (RawField(..))
+import OrderedDict as Dict
+
+
+type alias Dict comparable v =
+    Dict.OrderedDict comparable v
 
 
 hashedAliasName : RawField -> String
@@ -126,29 +129,11 @@ serializeChildren indentationLevel children =
 
 mergedFields : List RawField -> List RawField
 mergedFields children =
-    let
-        mergeThing : MergedFields
-        mergeThing =
-            mergeFields children
-    in
-    (mergeThing.leaves |> Dict.values |> List.map leafToField)
-        ++ (mergeThing.composites |> Dict.values |> List.map compositeToField)
+    Dict.values (mergeFields children)
 
 
 type alias MergedFields =
-    { leaves : Dict String ( { typeString : String, fieldName : String }, List Argument )
-    , composites : Dict String ( { name : String, args : List Argument }, List RawField )
-    }
-
-
-leafToField : ( { typeString : String, fieldName : String }, List Argument ) -> RawField
-leafToField ( record, arguments ) =
-    Leaf record arguments
-
-
-compositeToField : ( { name : String, args : List Argument }, List RawField ) -> RawField
-compositeToField ( record, children ) =
-    Composite record.name record.args children
+    Dict String RawField
 
 
 {-| Fields will have collisions if there is more than one with the same field name or field alias.
@@ -160,36 +145,33 @@ mergeFields : List RawField -> MergedFields
 mergeFields rawFields =
     rawFields
         |> List.foldl
-            (\field { leaves, composites } ->
+            (\field mergedSoFar ->
                 case field of
-                    Composite fieldName args children ->
-                        { leaves = leaves
-                        , composites =
-                            composites
-                                |> Dict.update (hashedAliasName field)
-                                    (\maybeChildrenSoFar ->
-                                        maybeChildrenSoFar
-                                            |> Maybe.withDefault ( { name = fieldName, args = args }, [] )
-                                            |> Tuple.mapSecond ((++) children)
-                                            |> Just
-                                    )
-                        }
-
-                    Leaf info args ->
-                        { leaves =
-                            leaves
-                                |> Dict.update (hashedAliasName field)
-                                    (\maybeChildrenSoFar ->
-                                        maybeChildrenSoFar
-                                            |> Maybe.withDefault ( info, args )
-                                            |> Just
-                                    )
-                        , composites = composites
-                        }
+                    Composite _ _ newChildren ->
+                        mergedSoFar
+                            |> Dict.update (hashedAliasName field)
+                                (\maybeChildrenSoFar ->
+                                    case maybeChildrenSoFar of
+                                        Nothing ->
+                                            Just field
+
+                                        Just (Composite existingFieldName existingArgs existingChildren) ->
+                                            Composite existingFieldName existingArgs (existingChildren ++ newChildren) |> Just
+
+                                        _ ->
+                                            Just field
+                                )
+
+                    Leaf _ _ ->
+                        mergedSoFar
+                            |> Dict.update (hashedAliasName field)
+                                (\maybeChildrenSoFar ->
+                                    maybeChildrenSoFar
+                                        |> Maybe.withDefault field
+                                        |> Just
+                                )
             )
-            { leaves = Dict.empty
-            , composites = Dict.empty
-            }
+            Dict.empty
 
 
 nonemptyChildren : List RawField -> List RawField

tests/DocumentTests.elm

@@ -178,8 +178,8 @@ all =
                         |> Expect.equal """query {
   me {
     firstName0: firstName
-    lastName0: lastName
     middleName0: middleName
+    lastName0: lastName
   }
 }"""
             , test "different arguments are not merged" <|
@@ -198,12 +198,12 @@ all =
                         ]
                         |> Graphql.Document.serializeQuery
                         |> Expect.equal """query {
-  me1529416052: me(id: 456) {
-    lastName0: lastName
-  }
   me3003759287: me(id: 123) {
     firstName0: firstName
   }
+  me1529416052: me(id: 456) {
+    lastName0: lastName
+  }
 }"""
             , test "identical leaves are de-duped" <|
                 \() ->