feat!: add a default global ID encoder, add a id_field on the query type (#1227)

BREAKING CHANGE: the global ID function takes only a str with the GID, the query type uses the id_field arg to determine which kwarg to pass to the decoder

Author: pkucmus

ariadne/contrib/relay/__init__.py

@@ -8,6 +8,7 @@
     RelayQueryType,
 )
 from ariadne.contrib.relay.types import ConnectionResolver, GlobalIDTuple
+from ariadne.contrib.relay.utils import decode_global_id, encode_global_id
 
 __all__ = [
     "ConnectionArguments",
@@ -17,4 +18,6 @@
     "RelayQueryType",
     "ConnectionResolver",
     "GlobalIDTuple",
+    "decode_global_id",
+    "encode_global_id",
 ]

ariadne/contrib/relay/connection.py

@@ -1,6 +1,4 @@
-from typing import Sequence
-
-from typing_extensions import Any
+from typing import Sequence, Any
 
 from ariadne.contrib.relay.arguments import ConnectionArgumentsUnion
 
@@ -12,14 +10,19 @@ def __init__(
         total: int,
         has_next_page: bool,
         has_previous_page: bool,
+        id_field: str = "id",
     ) -> None:
         self.edges = edges
         self.total = total
         self.has_next_page = has_next_page
         self.has_previous_page = has_previous_page
+        self.id_field = id_field
+
+    def get_cursor(self, obj):
+        return obj[self.id_field]
 
-    def get_cursor(self, node):
-        return node["id"]
+    def get_node(self, obj):
+        return obj
 
     def get_page_info(
         self, connection_arguments: ConnectionArgumentsUnion
@@ -32,4 +35,7 @@ def get_page_info(
         }
 
     def get_edges(self):
-        return [{"node": node, "cursor": self.get_cursor(node)} for node in self.edges]
+        return [
+            {"node": self.get_node(obj), "cursor": self.get_cursor(obj)}
+            for obj in self.edges
+        ]

ariadne/contrib/relay/objects.py

@@ -1,4 +1,3 @@
-from base64 import b64decode
 from inspect import iscoroutinefunction
 from typing import Optional, Tuple, cast
 
@@ -14,17 +13,13 @@
 from ariadne.contrib.relay.types import (
     ConnectionResolver,
     GlobalIDDecoder,
-    GlobalIDTuple,
 )
+from ariadne.contrib.relay.utils import decode_global_id
 from ariadne.types import Resolver
 from ariadne.utils import type_get_extension
 from ariadne.utils import type_set_extension
 
 
-def decode_global_id(kwargs) -> GlobalIDTuple:
-    return GlobalIDTuple(*b64decode(kwargs["id"]).decode().split(":"))
-
-
 class RelayObjectType(ObjectType):
     _node_resolver: Optional[Resolver] = None
 
@@ -93,6 +88,7 @@ def bind_to_schema(self, schema: GraphQLSchema) -> None:
 
 
 class RelayNodeInterfaceType(InterfaceType):
+
     def __init__(
         self,
         type_resolver: Optional[Resolver] = None,
@@ -105,13 +101,15 @@ def __init__(
         self,
         node: Optional[RelayNodeInterfaceType] = None,
         global_id_decoder: GlobalIDDecoder = decode_global_id,
+        id_field: str = "id",
     ) -> None:
         super().__init__("Query")
         if node is None:
             node = RelayNodeInterfaceType()
         self.node = node
         self.set_field("node", self.resolve_node)
         self.global_id_decoder = global_id_decoder
+        self.id_field = id_field
 
     @property
     def bindables(self) -> Tuple["RelayQueryType", "RelayNodeInterfaceType"]:
@@ -127,7 +125,7 @@ def get_node_resolver(self, type_name, schema: GraphQLSchema) -> Resolver:
         return resolver
 
     def resolve_node(self, obj, info, *args, **kwargs):
-        type_name, _ = self.global_id_decoder(kwargs)
+        type_name, _ = self.global_id_decoder(kwargs[self.id_field])
 
         resolver = self.get_node_resolver(type_name, info.schema)
 

ariadne/contrib/relay/types.py

@@ -1,10 +1,11 @@
 from collections import namedtuple
-from typing import Any, Callable, Dict
+from typing import Callable
 
 from typing_extensions import TypeVar
 
 from ariadne.contrib.relay.connection import RelayConnection
 
 ConnectionResolver = TypeVar("ConnectionResolver", bound=Callable[..., RelayConnection])
 GlobalIDTuple = namedtuple("GlobalIDTuple", ["type", "id"])
-GlobalIDDecoder = Callable[[Dict[str, Any]], GlobalIDTuple]
+GlobalIDDecoder = Callable[[str], GlobalIDTuple]
+GlobalIDEncoder = Callable[[str, str], str]

ariadne/contrib/relay/utils.py

@@ -0,0 +1,13 @@
+from base64 import b64decode, b64encode
+
+from ariadne.contrib.relay.types import (
+    GlobalIDTuple,
+)
+
+
+def decode_global_id(gid: str) -> GlobalIDTuple:
+    return GlobalIDTuple(*b64decode(gid).decode().split(":"))
+
+
+def encode_global_id(type_name: str, _id: str) -> str:
+    return b64encode(f"{type_name}:{_id}".encode()).decode()

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "ariadne"
-version = "0.25.1"
+version = "0.25.2"
 description = "Ariadne is a Python library for implementing GraphQL servers."
 authors = [{ name = "Mirumee Software", email = "[email protected]" }]
 readme = "README.md"

tests/relay/conftest.py

@@ -58,7 +58,7 @@ def relay_type_defs():
 
 @pytest.fixture
 def global_id_decoder():
-    return lambda kwargs: GlobalIDTuple(*b64decode(kwargs["bid"]).decode().split(":"))
+    return lambda gid: GlobalIDTuple(*b64decode(gid).decode().split(":"))
 
 
 @pytest.fixture
@@ -71,6 +71,7 @@ def relay_query(factions, relay_node_interface, global_id_decoder):
     query = RelayQueryType(
         node=relay_node_interface,
         global_id_decoder=global_id_decoder,
+        id_field="bid",
     )
     query.set_field("rebels", lambda *_: factions[0])
     query.set_field("empire", lambda *_: factions[1])

tests/relay/test_objects.py

@@ -1,4 +1,5 @@
 import pytest
+
 from graphql import extend_schema
 from graphql import graphql_sync
 from graphql import parse
@@ -15,9 +16,6 @@
     RelayQueryType,
     decode_global_id,
 )
-from ariadne.contrib.relay.types import (
-    GlobalIDTuple,
-)
 
 
 @pytest.fixture
@@ -31,10 +29,6 @@ def friends_connection():
     )
 
 
-def test_decode_global_id():
-    assert decode_global_id({"id": "VXNlcjox"}) == GlobalIDTuple("User", "1")
-
-
 def test_default_id_decoder():
     query = RelayQueryType()
     assert query.global_id_decoder is decode_global_id

tests/relay/test_utils.py

@@ -0,0 +1,13 @@
+from ariadne.contrib.relay import (
+    GlobalIDTuple,
+    decode_global_id,
+    encode_global_id,
+)
+
+
+def test_decode_global_id():
+    assert decode_global_id("VXNlcjox") == GlobalIDTuple("User", "1")
+
+
+def test_encode_global_id():
+    assert encode_global_id("User", "1") == "VXNlcjox"