find_dangerous_changes: sort fields inside 'defaultValue'

Replicates graphql/graphql-js@6609d39

Author: Cito

README.md

@@ -16,7 +16,7 @@ The current version 3.0.0b0 of GraphQL-core is up-to-date
 with GraphQL.js version 14.5.0.
 
 All parts of the API are covered by an extensive test suite
-of currently 1987 unit tests.
+of currently 1988 unit tests.
 
 
 ## Documentation

src/graphql/language/visitor.py

@@ -211,7 +211,7 @@ def visit(root: Node, visitor: Visitor, visitor_keys=None) -> Any:
     if not isinstance(root, Node):
         raise TypeError(f"Not an AST Node: {inspect(root)}")
     if not isinstance(visitor, Visitor):
-        raise TypeError(f"Not an AST Visitor class: {inspect(visitor)}")
+        raise TypeError(f"Not an AST Visitor: {inspect(visitor)}")
     if visitor_keys is None:
         visitor_keys = QUERY_DOCUMENT_KEYS
     stack: Any = None

src/graphql/utilities/find_breaking_changes.py

@@ -1,8 +1,9 @@
 from enum import Enum
+from operator import attrgetter
 from typing import Any, Dict, List, NamedTuple, Union, cast
 
 from ..error import INVALID
-from ..language import print_ast
+from ..language import print_ast, visit, Visitor
 from ..pyutils import inspect
 from ..type import (
     GraphQLEnumType,
@@ -399,6 +400,9 @@ def find_arg_changes(
                     )
                 )
             else:
+                # Since we are looking only for client's observable changes we should
+                # compare default values in the same representation as they are
+                # represented inside introspection.
                 old_value_str = stringify_value(old_arg.default_value, old_arg.type)
                 new_value_str = stringify_value(new_arg.default_value, new_arg.type)
 
@@ -532,7 +536,18 @@ def stringify_value(value: Any, type_: GraphQLInputType) -> str:
     ast = ast_from_value(value, type_)
     if ast is None:
         raise TypeError(f"Invalid value: {inspect(value)}")
-    return print_ast(ast)
+
+    # noinspection PyMethodMayBeStatic
+    class SortVisitor(Visitor):
+        def enter_object_value(self, object_node, *_args):
+            object_node.fields = sorted(
+                object_node.fields, key=attrgetter("name.value")
+            )
+            return object_node
+
+    sorted_ast = visit(ast, SortVisitor())
+
+    return print_ast(sorted_ast)
 
 
 class ListDiff(NamedTuple):

tests/utilities/test_find_breaking_changes.py

@@ -936,6 +936,41 @@ def should_ignore_changes_in_field_order_of_default_value():
 
         assert find_dangerous_changes(old_schema, new_schema) == []
 
+    def should_ignore_changes_in_field_definitions_order():
+        old_schema = build_schema(
+            """
+            input Input1 {
+              a: String
+              b: String
+              c: String
+            }
+
+            type Type1 {
+              field1(
+                arg1: Input1 = { a: "a", b: "b", c: "c" }
+              ): String
+            }
+            """
+        )
+
+        new_schema = build_schema(
+            """
+            input Input1 {
+              c: String
+              b: String
+              a: String
+            }
+
+            type Type1 {
+              field1(
+                arg1: Input1 = { a: "a", b: "b", c: "c" }
+              ): String
+            }
+            """
+        )
+
+        assert find_dangerous_changes(old_schema, new_schema) == []
+
     def should_detect_if_a_value_was_added_to_an_enum_type():
         old_schema = build_schema(
             """