Merge branch 'master' into v3

Author: jkimbo

.github/workflows/tests.yml

@@ -8,7 +8,7 @@ jobs:
     strategy:
       max-parallel: 4
       matrix:
-        django: ["2.2", "3.0"]
+        django: ["2.2", "3.0", "3.1"]
         python-version: ["3.6", "3.7", "3.8"]
 
     steps:

docs/settings.rst

@@ -186,3 +186,24 @@ Default: ``None``
    GRAPHENE = {
       'SUBSCRIPTION_PATH': "/ws/graphql"
    }
+
+
+``GRAPHIQL_HEADER_EDITOR_ENABLED``
+---------------------
+
+GraphiQL starting from version 1.0.0 allows setting custom headers in similar fashion to query variables.
+
+Set to ``False`` if you want to disable GraphiQL headers editor tab for some reason.
+
+This setting is passed to ``headerEditorEnabled`` GraphiQL options, for details refer to GraphiQLDocs_.
+
+.. _GraphiQLDocs: https://github.com/graphql/graphiql/tree/main/packages/graphiql#options
+
+
+Default: ``True``
+
+.. code:: python
+
+   GRAPHENE = {
+      'GRAPHIQL_HEADER_EDITOR_ENABLED': True,
+   }

graphene_django/compat.py

@@ -8,8 +8,14 @@ class MissingType(object):
     from django.contrib.postgres.fields import (
         ArrayField,
         HStoreField,
-        JSONField,
+        JSONField as PGJSONField,
         RangeField,
     )
 except ImportError:
-    ArrayField, HStoreField, JSONField, RangeField = (MissingType,) * 4
+    ArrayField, HStoreField, PGJSONField, RangeField = (MissingType,) * 4
+
+try:
+    # JSONField is only available from Django 3.1
+    from django.db.models import JSONField
+except ImportError:
+    JSONField = MissingType

graphene_django/converter.py

@@ -26,9 +26,10 @@
 from graphql import GraphQLError, assert_valid_name
 from graphql.pyutils import register_description
 
-from .compat import ArrayField, HStoreField, JSONField, RangeField
-from .fields import DjangoConnectionField, DjangoListField
+from .compat import ArrayField, HStoreField, JSONField, PGJSONField, RangeField
+from .fields import DjangoListField, DjangoConnectionField
 from .settings import graphene_settings
+from .utils import import_single_dispatch
 from .utils.str_converters import to_const
 
 
@@ -296,8 +297,9 @@ def convert_postgres_array_to_list(field, registry=None):
 
 
 @convert_django_field.register(HStoreField)
+@convert_django_field.register(PGJSONField)
 @convert_django_field.register(JSONField)
-def convert_postgres_field_to_string(field, registry=None):
+def convert_pg_and_json_field_to_string(field, registry=None):
     return JSONString(
         description=get_django_field_description(field), required=not field.null
     )

graphene_django/settings.py

@@ -40,6 +40,10 @@
     "DJANGO_CHOICE_FIELD_ENUM_CUSTOM_NAME": None,
     # Use a separate path for handling subscriptions.
     "SUBSCRIPTION_PATH": None,
+    # By default GraphiQL headers editor tab is enabled, set to False to hide it
+    # This sets headerEditorEnabled GraphiQL option, for details go to
+    # https://github.com/graphql/graphiql/tree/main/packages/graphiql#options
+    "GRAPHIQL_HEADER_EDITOR_ENABLED": True,
 }
 
 if settings.DEBUG:

graphene_django/static/graphene_django/graphiql.js

@@ -61,13 +61,15 @@
   var fetchURL = locationQuery(otherParams);
 
   // Defines a GraphQL fetcher using the fetch API.
-  function httpClient(graphQLParams) {
-    var headers = {
-      Accept: "application/json",
-      "Content-Type": "application/json",
-    };
+  function httpClient(graphQLParams, opts) {
+    if (typeof opts === 'undefined') {
+      opts = {};
+    }
+    var headers = opts.headers || {};
+    headers['Accept'] = headers['Accept'] || 'application/json';
+    headers['Content-Type'] = headers['Content-Type'] || 'application/json';
     if (csrftoken) {
-      headers["X-CSRFToken"] = csrftoken;
+      headers['X-CSRFToken'] = csrftoken
     }
     return fetch(fetchURL, {
       method: "post",
@@ -108,7 +110,7 @@
   var activeSubscription = null;
 
   // Define a GraphQL fetcher that can intelligently route queries based on the operation type.
-  function graphQLFetcher(graphQLParams) {
+  function graphQLFetcher(graphQLParams, opts) {
     var operationType = getOperationType(graphQLParams);
 
     // If we're about to execute a new operation, and we have an active subscription,
@@ -126,7 +128,7 @@
         },
       };
     } else {
-      return httpClient(graphQLParams);
+      return httpClient(graphQLParams, opts);
     }
   }
 
@@ -173,6 +175,7 @@
     onEditQuery: onEditQuery,
     onEditVariables: onEditVariables,
     onEditOperationName: onEditOperationName,
+    headerEditorEnabled: GRAPHENE_SETTINGS.graphiqlHeaderEditorEnabled,
     query: parameters.query,
   };
   if (parameters.variables) {

graphene_django/templates/graphene/graphiql.html

@@ -45,6 +45,7 @@
     {% if subscription_path %}
       subscriptionPath: "{{subscription_path}}",
     {% endif %}
+      graphiqlHeaderEditorEnabled: {{ graphiql_header_editor_enabled|yesno:"true,false" }},
     };
   </script>
   <script src="{% static 'graphene_django/graphiql.js' %}"></script>

graphene_django/tests/test_converter.py

@@ -11,7 +11,14 @@
 from graphene.types.datetime import Date, DateTime, Time
 from graphene.types.json import JSONString
 
-from ..compat import ArrayField, HStoreField, JSONField, MissingType, RangeField
+from ..compat import (
+    ArrayField,
+    HStoreField,
+    JSONField,
+    PGJSONField,
+    MissingType,
+    RangeField,
+)
 from ..converter import (
     convert_django_field,
     convert_django_field_with_choices,
@@ -352,8 +359,13 @@ def test_should_postgres_hstore_convert_string():
     assert_conversion(HStoreField, JSONString)
 
 
-@pytest.mark.skipif(JSONField is MissingType, reason="JSONField should exist")
+@pytest.mark.skipif(PGJSONField is MissingType, reason="PGJSONField should exist")
 def test_should_postgres_json_convert_string():
+    assert_conversion(PGJSONField, JSONString)
+
+
+@pytest.mark.skipif(JSONField is MissingType, reason="JSONField should exist")
+def test_should_json_convert_string():
     assert_conversion(JSONField, JSONString)
 
 

graphene_django/tests/test_types.py

@@ -9,6 +9,7 @@
 from graphene.relay import Node
 
 from .. import registry
+from ..filter import DjangoFilterConnectionField
 from ..types import DjangoObjectType, DjangoObjectTypeOptions
 from .models import Article as ArticleModel
 from .models import Reporter as ReporterModel
@@ -662,3 +663,28 @@ class Query(ObjectType):
             }
             """
         )
+
+
+@with_local_registry
+def test_django_objecttype_name_connection_propagation():
+    class Reporter(DjangoObjectType):
+        class Meta:
+            model = ReporterModel
+            name = "CustomReporterName"
+            filter_fields = ["email"]
+            interfaces = (Node,)
+
+    class Query(ObjectType):
+        reporter = Node.Field(Reporter)
+        reporters = DjangoFilterConnectionField(Reporter)
+
+    assert Reporter._meta.name == "CustomReporterName"
+    schema = str(Schema(query=Query))
+
+    assert "type CustomReporterName implements Node {" in schema
+    assert "type CustomReporterNameConnection {" in schema
+    assert "type CustomReporterNameEdge {" in schema
+
+    assert "type Reporter implements Node {" not in schema
+    assert "type ReporterConnection {" not in schema
+    assert "type ReporterEdge {" not in schema

graphene_django/types.py

@@ -246,7 +246,7 @@ def __init_subclass_with_meta__(
                 connection_class = Connection
 
             connection = connection_class.create_type(
-                "{}Connection".format(cls.__name__), node=cls
+                "{}Connection".format(options.get("name") or cls.__name__), node=cls
             )
 
         if connection is not None: