Merge pull request #130 from graphql-python/feat-list-generic-reference-field

feat: support list of GenericReferenceField

Author: abawchen

graphene_mongo/converter.py

@@ -103,6 +103,12 @@ def convert_file_to_field(field, registry=None):
 @convert_mongoengine_field.register(mongoengine.EmbeddedDocumentListField)
 def convert_field_to_list(field, registry=None):
     base_type = convert_mongoengine_field(field.field, registry=registry)
+    if isinstance(base_type, graphene.Field):
+        return graphene.List(
+            base_type._type,
+            description=get_field_description(field, registry),
+            required=field.required
+        )
     if isinstance(base_type, (graphene.Dynamic)):
         base_type = base_type.get_type()
         if base_type is None:

graphene_mongo/fields.py

@@ -67,6 +67,8 @@ def args(self, args):
     def _field_args(self, items):
         def is_filterable(k):
             """
+            Remove complex columns from input args at this moment.
+
             Args:
                 k (str): field name.
             Returns:
@@ -90,6 +92,10 @@ def is_filterable(k):
                 (FileFieldType, PointFieldType, MultiPolygonFieldType, graphene.Union),
             ):
                 return False
+            if isinstance(converted, (graphene.List)) \
+                    and issubclass(getattr(converted, '_of_type', None), graphene.Union):
+                return False
+
             return True
 
         def get_filter_type(_type):

graphene_mongo/tests/models.py

@@ -88,6 +88,9 @@ class Reporter(mongoengine.Document):
     generic_embedded_document = mongoengine.GenericEmbeddedDocumentField(
         choices=[EmbeddedArticle, EmbeddedFoo]
     )
+    generic_references = mongoengine.ListField(
+        mongoengine.GenericReferenceField(choices=[Article, Editor])
+    )
 
 
 class Player(mongoengine.Document):

graphene_mongo/tests/setup.py

@@ -67,6 +67,7 @@ def fixtures():
         last_name="Iverson",
         email="[email protected]",
         awards=["2010-mvp"],
+        generic_references=[article1]
     )
     reporter1.articles = [article1, article2]
     embedded_article1 = EmbeddedArticle(headline="Real", editor=editor1)

graphene_mongo/tests/test_converter.py

@@ -207,6 +207,27 @@ class Meta:
     assert dynamic_field._of_type == A
 
 
+def test_should_list_of_generic_reference_covert_list():
+    class A(MongoengineObjectType):
+        class Meta:
+            model = Article
+
+    class E(MongoengineObjectType):
+        class Meta:
+            model = Editor
+
+    class R(MongoengineObjectType):
+        class Meta:
+            model = Reporter
+
+    generic_references_field = convert_mongoengine_field(
+        Reporter._fields["generic_references"], registry.get_global_registry()
+    )
+    assert isinstance(generic_references_field, graphene.List)
+    field = generic_references_field.get_type()
+    assert field._of_type._meta.types == (A, E)
+
+
 def test_should_list_of_embedded_convert_list():
     class E(MongoengineObjectType):
         class Meta:

graphene_mongo/tests/test_relay_query.py

@@ -425,7 +425,13 @@ class Query(graphene.ObjectType):
                     node {
                         id,
                         firstName,
-                        awards
+                        awards,
+                        genericReferences {
+                            __typename
+                            ... on ArticleNode {
+                                headline
+                            }
+                        }
                     }
                 }
             }
@@ -439,6 +445,12 @@ class Query(graphene.ObjectType):
                         "id": "UmVwb3J0ZXJOb2RlOjE=",
                         "firstName": "Allen",
                         "awards": ["2010-mvp"],
+                        "genericReferences": [
+                            {
+                                "__typename": "ArticleNode",
+                                "headline": "Hello"
+                            }
+                        ]
                     }
                 }
             ]

graphene_mongo/tests/test_types.py

@@ -66,6 +66,7 @@ def test_objecttype_registered():
             "awards",
             "generic_reference",
             "generic_embedded_document",
+            "generic_references",
         ]
     )