Fix Int type redefinition error by renaming the scalar type (#1156)

* Fix Int type redefinition error by renaming the scalar type

- add unit test for testing the scalar type.

* bumpversion to 4.6.1

* Add unit test to check that default graphql int type errors

* rename scalar type back to Int and remove Int from graphql reserved types

Author: tjeerddie

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 4.6.0
+current_version = 4.6.1
 commit = False
 tag = False
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(rc(?P<build>\d+))?

orchestrator/__init__.py

@@ -13,7 +13,7 @@
 
 """This is the orchestrator workflow engine."""
 
-__version__ = "4.6.0"
+__version__ = "4.6.1"
 
 
 from structlog import get_logger

orchestrator/graphql/schema.py

@@ -63,7 +63,12 @@
 from orchestrator.graphql.schemas.subscription import SubscriptionInterface
 from orchestrator.graphql.schemas.version import VersionType
 from orchestrator.graphql.schemas.workflow import Workflow
-from orchestrator.graphql.types import SCALAR_OVERRIDES, OrchestratorContext, ScalarOverrideType, StrawberryModelType
+from orchestrator.graphql.types import (
+    SCALAR_OVERRIDES,
+    OrchestratorContext,
+    ScalarOverrideType,
+    StrawberryModelType,
+)
 from orchestrator.services.process_broadcast_thread import ProcessDataBroadcastThread
 from orchestrator.settings import app_settings
 

orchestrator/graphql/types.py

@@ -17,7 +17,7 @@
 from typing import Any, NewType, TypeVar
 
 import strawberry
-from graphql import GraphQLError
+from graphql import GraphQLError, GraphQLNamedType
 from strawberry.dataloader import DataLoader
 from strawberry.experimental.pydantic.conversion_types import StrawberryTypeFromPydantic
 from strawberry.scalars import JSON
@@ -122,6 +122,9 @@ class GraphqlFilter:
     parse_value=lambda v: v,
 )
 
+# TODO: Remove Hack to prevent the error: `Redefinition of reserved type 'Int'`
+if hasattr(GraphQLNamedType, "reserved_types"):
+    GraphQLNamedType.reserved_types.pop("Int", None)
 IntType = strawberry.scalar(
     NewType("Int", int),
     description="An arbitrary precision integer",

test/unit_tests/graphql/test_scalars.py

@@ -0,0 +1,66 @@
+from decimal import Decimal
+from typing import Any
+
+import pytest
+import strawberry
+
+from orchestrator.graphql.types import SCALAR_OVERRIDES
+
+BIG_INT_VALUE = 2**40  # 1,099,511,627,776
+DECIMAL_VALUE = Decimal("1234567890.123456789")
+
+
+@strawberry.type
+class ScalarsTest:
+    big_int: int
+    decimal_value: Decimal
+
+
+@strawberry.type
+class Query:
+    @strawberry.field
+    def scalars(self) -> ScalarsTest:
+        """Return test values for large int and decimal."""
+        return ScalarsTest(big_int=BIG_INT_VALUE, decimal_value=DECIMAL_VALUE)
+
+
+schema = strawberry.Schema(query=Query)
+schema_with_overrides = strawberry.Schema(query=Query, scalar_overrides=SCALAR_OVERRIDES)
+
+
+def test_big_int_and_decimal_handling() -> None:
+    """Verify that large integers and Decimal values serialize correctly."""
+    query = """
+    query {
+        scalars {
+            bigInt
+            decimalValue
+        }
+    }
+    """
+
+    result: Any = schema_with_overrides.execute_sync(query)
+    assert result.errors is None, f"GraphQL errors occurred: {result.errors}"
+
+    data = result.data["scalars"]
+
+    assert data["bigInt"] == BIG_INT_VALUE
+    decimal_serialized = str(data["decimalValue"])
+    assert decimal_serialized.startswith(str(DECIMAL_VALUE))
+
+
+@pytest.mark.xfail(reason="Graphql now supports non 32-bit signed integers", strict=False)
+def test_big_int_and_decimal_handling_fails_without_scalar_overrides() -> None:
+    """Verify that large integers and Decimal values serialize correctly."""
+    query = """
+    query {
+        scalars {
+            bigInt
+            decimalValue
+        }
+    }
+    """
+
+    # with pytest.raises(GraphQLError, match="Int cannot represent non 32-bit signed integer"):
+    result = schema.execute_sync(query)
+    assert any("Int cannot represent non 32-bit signed integer" in err.message for err in result.errors or [])