fix: CusrorPaginator null encoding bug (#1161)

Author: joseph-sentry

graphql_api/helpers/connection.py

@@ -1,9 +1,10 @@
 import enum
+from base64 import b64decode
 from dataclasses import dataclass
 from functools import cached_property
 from typing import Any, Dict, List, Optional
 
-from cursor_pagination import CursorPage, CursorPaginator
+from cursor_pagination import CursorPage, CursorPaginator, InvalidCursor
 from django.db.models import QuerySet
 
 from codecov.commands.exceptions import ValidationError
@@ -181,6 +182,7 @@ def page_info(self) -> Dict[str, Any]:
 
 
 class DictCursorPaginator(CursorPaginator):
+    NULL_VALUE_REPR = "\x1f"
     """
     WARNING: DictCursorPaginator does not work for dict objects where a key contains the following string: "__"
     TODO: if instance is a dictionary and not an object, don't split the ordering
@@ -205,6 +207,17 @@ class DictCursorPaginator(CursorPaginator):
     if the dict access fails then it throws an exception, although it would be a different
     """
 
+    def decode_cursor(self, cursor):
+        try:
+            orderings = b64decode(cursor.encode("ascii")).decode("utf8")
+            orderings = orderings.split(self.delimiter)
+            return [
+                None if ordering == self.NULL_VALUE_REPR else ordering
+                for ordering in orderings
+            ]
+        except (TypeError, ValueError):
+            raise InvalidCursor(self.invalid_cursor_message)
+
     def position_from_instance(self, instance):
         position = []
         for order in self.ordering:
@@ -219,7 +232,7 @@ def position_from_instance(self, instance):
                     except (KeyError, TypeError):
                         raise attr_err from None
                 parts.pop(0)
-            position.append(str(attr))
+            position.append(self.NULL_VALUE_REPR if attr is None else str(attr))
         return position
 
 

graphql_api/helpers/tests/test_connection.py

@@ -155,3 +155,21 @@ def test_invalid_cursors(self):
 
         with self.assertRaises(ValidationError):
             queryset_to_connection_sync(data, first=3, after="invalid")
+
+    def test_dict_cursor_paginator_null_encoding(self):
+        from graphql_api.helpers.connection import DictCursorPaginator, field_order
+
+        repo_1 = RepositoryFactory(name="a", active=None)
+        repo_2 = RepositoryFactory(name="b", active=True)
+        repo_3 = RepositoryFactory(name="c", active=False)
+        r = Repository.objects.all()
+
+        ordering = tuple(
+            field_order(field, OrderingDirection.ASC) for field in ("active",)
+        )
+
+        paginator = DictCursorPaginator(r, ordering=ordering)
+
+        assert paginator.position_from_instance(repo_1) == ["\x1f"]
+        assert paginator.position_from_instance(repo_2) == ["True"]
+        assert paginator.position_from_instance(repo_3) == ["False"]