Merge pull request #17 from graphql-python/feat-filter-by-global-id

Feature: Filter by global id

Author: abawchen

README.md

@@ -75,6 +75,7 @@ To learn more check out the following [examples](examples/):
 - [ ] Filtering & Paging
     - [x] Default filtering enabled with all model's attributes by equal comparison (requester: [git-albertomarin](https://github.com/git-albertomarin))
     - [x] Take first, or last n items (credit: [alexpantyukhin](https://github.com/alexpantyukhin))
+    - [x] Filter by global id (requester: [bwalsh](https://github.com/bwalsh))
     - [ ] Advanced filtering
 - [ ] Support more types
     - [x] Self-reference and list-of-self-reference relationship (requester: [mehdiym](https://github.com/mehdiym))

examples/flask_mongoengine/schema.py

@@ -29,7 +29,7 @@ class Meta:
 class Query(graphene.ObjectType):
     node = Node.Field()
     all_employees = MongoengineConnectionField(Employee)
-    all_role = MongoengineConnectionField(Role)
+    all_roles = MongoengineConnectionField(Role)
     role = graphene.Field(Role)
 
 schema = graphene.Schema(query=Query, types=[Department, Employee, Role])

graphene_mongo/fields.py

@@ -7,6 +7,7 @@
 from graphene.relay import ConnectionField
 from graphene.relay.connection import PageInfo
 from graphql_relay.connection.arrayconnection import connection_from_list_slice
+from graphql_relay.node.node import from_global_id
 from graphene.types.argument import to_arguments
 
 
@@ -86,9 +87,16 @@ def fields(self):
     @classmethod
     def get_query(cls, model, info, **args):
         objs = model.objects()
+
         if args:
             first = args.pop('first', None)
             last = args.pop('last', None)
+            id = args.pop('id', None)
+
+            if id is not None:
+                # https://github.com/graphql-python/graphene/issues/124
+                args['pk'] = from_global_id(id)[-1]
+
             objs = objs.filter(**args)
 
             if first is not None:
@@ -98,6 +106,7 @@ def get_query(cls, model, info, **args):
 
         return objs
 
+    # noqa
     @classmethod
     def merge_querysets(cls, default_queryset, queryset):
         return queryset & default_queryset

graphene_mongo/tests/fixtures.py

@@ -3,11 +3,11 @@
 
 def setup_fixtures():
     Editor.drop_collection()
-    editor1 = Editor(first_name='Penny', last_name='Hardaway')
+    editor1 = Editor(id='1', first_name='Penny', last_name='Hardaway')
     editor1.save()
-    editor2 = Editor(first_name='Grant', last_name='Hill')
+    editor2 = Editor(id='2', first_name='Grant', last_name='Hill')
     editor2.save()
-    editor3 = Editor(first_name='Dennis', last_name='Rodman')
+    editor3 = Editor(id='3', first_name='Dennis', last_name='Rodman')
     editor3.save()
 
     Article.drop_collection()

graphene_mongo/tests/models.py

@@ -13,6 +13,7 @@
 class Editor(Document):
 
     meta = {'collection': 'test_editor'}
+    id = StringField(primary_key=True)
     first_name = StringField(required=True)
     last_name = StringField(required=True)
 

graphene_mongo/tests/test_relay_query.py

@@ -104,6 +104,7 @@ class Query(graphene.ObjectType):
           allEditors {
             edges {
                 node {
+                    id,
                     firstName,
                     lastName
                 }
@@ -116,19 +117,22 @@ class Query(graphene.ObjectType):
             'edges': [
                 {
                     'node': {
+                        'id': 'RWRpdG9yTm9kZTox',
                         'firstName': 'Penny',
                         'lastName': 'Hardaway'
                     }
                 },
                 {
                     'node': {
+                        'id': 'RWRpdG9yTm9kZToy',
                         'firstName': 'Grant',
                         'lastName': 'Hill'
                     }
 
                 },
                 {
                     'node': {
+                        'id': 'RWRpdG9yTm9kZToz',
                         'firstName': 'Dennis',
                         'lastName': 'Rodman'
                     }
@@ -142,6 +146,45 @@ class Query(graphene.ObjectType):
     assert dict(result.data['allEditors']) == expected['allEditors']
 
 
+def test_should_filter_editors_by_id():
+
+    class Query(graphene.ObjectType):
+        node = Node.Field()
+        all_editors = MongoengineConnectionField(EditorNode)
+
+    query = '''
+        query EditorQuery {
+          allEditors(id: "RWRpdG9yTm9kZToy") {
+            edges {
+                node {
+                    id,
+                    firstName,
+                    lastName
+                }
+            }
+          }
+        }
+    '''
+    expected = {
+        'allEditors': {
+            'edges': [
+                {
+                    'node': {
+                        'id': 'RWRpdG9yTm9kZToy',
+                        'firstName': 'Grant',
+                        'lastName': 'Hill'
+                    }
+
+                }
+            ]
+        }
+    }
+    schema = graphene.Schema(query=Query)
+    result = schema.execute(query)
+    assert not result.errors
+    assert dict(result.data['allEditors']) == expected['allEditors']
+
+
 def test_should_mutate():
 
     class CreateArticle(graphene.Mutation):