[graphql-pydantic-converter] Fix rendering issue when payload is Boolean only (#84)

Co-authored-by: Jozef Volak <[email protected]>

Author: Jozefiel

utils/graphql-pydantic-converter/CHANGELOG.md

@@ -19,3 +19,6 @@
 
 # 1.2.0
 - Allow to populate by name
+
+# 1.2.1
+- Fix rendering issue when payload is bool

utils/graphql-pydantic-converter/graphql_pydantic_converter/graphql_types.py

@@ -167,7 +167,7 @@ class Mutation(GraphqlSchemaType):
     payload: Payload | bool
     _name: str
     _operation: str = 'mutation'
-    _query = Template('$operation $operation_name$variable_def { $projects$aggregations { $payload } }')
+    _query = Template('$operation $operation_name$variable_def { $projects$aggregations $payload }')
 
     def dict_to_custom_string(self, value: Any) -> str:
         match value:
@@ -206,7 +206,7 @@ def _inline_variables(self, payload: str) -> QueryForm:
 
         arguments = ', '.join(variables)
 
-        return QueryForm(f'mutation {{ {self._name} ({arguments}) {{ {payload} }} }}')
+        return QueryForm(f'mutation {{ {self._name} ({arguments}) {payload} }}')
 
     def _extracted_variables(self, payload: str) -> QueryForm:
         input_dict: dict[str, Any] = self.model_dump(exclude={'_name', 'payload'}, exclude_none=True, by_alias=True)
@@ -251,18 +251,18 @@ def _extracted_variables(self, payload: str) -> QueryForm:
     def render(self, form: typing.Literal['inline', 'extracted'] = 'extracted') -> QueryForm:
         payload: str = ''
         if isinstance(self.payload, Payload):
-            payload = self.payload.render()
+            payload = f'{{ {self.payload.render()} }}'
         if form == 'inline':
             return self._inline_variables(payload)
         else:
             return self._extracted_variables(payload)
 
 
 class Query(GraphqlSchemaType):
-    payload: Payload
+    payload: Payload | bool
     _name: str
     _operation: str = 'query'
-    _query = Template('$operation $operation_name$variable_def { $projects$aggregations { $payload } }')
+    _query = Template('$operation $operation_name$variable_def { $projects$aggregations $payload }')
 
     def parse_inputs(self, value: Any) -> str:
         match value:
@@ -334,7 +334,7 @@ def _inline_variables(self,  payload: str) -> QueryForm:
         if arguments:
             arguments = f' ( {arguments} )'
 
-        return QueryForm(f'{{ {self._name}{arguments} {{ {payload} }} }}')
+        return QueryForm(f'{{ {self._name}{arguments} {payload} }}')
 
     def _extracted_variables(self, payload: str) -> QueryForm:
         input_dict: dict[str, Any] = self.model_dump(exclude={'_name', 'payload'}, exclude_none=True, by_alias=True)
@@ -377,7 +377,11 @@ def _extracted_variables(self, payload: str) -> QueryForm:
         )
 
     def render(self, form: typing.Literal['inline', 'extracted'] = 'extracted') -> QueryForm:
-        payload: str = self.dict_to_custom_string(self.payload.model_dump(exclude_none=True, by_alias=True))
+
+        payload: str = ''
+        if isinstance(self.payload, Payload):
+            payload = f'{{ {self.dict_to_custom_string(self.payload.model_dump(exclude_none=True, by_alias=True))} }}'
+
         if form == 'inline':
             return self._inline_variables(payload)
         else:

utils/graphql-pydantic-converter/pyproject.toml

@@ -19,7 +19,7 @@ packages = [{ include = "graphql_pydantic_converter" }]
 name = "graphql-pydantic-converter"
 description = "Convert pydantic schema to pydantic datamodel and build request from it"
 authors = ["Jozef Volak <[email protected]>"]
-version = '1.2.0'
+version = '1.2.1'
 readme = ["README.md", "CHANGELOG.md"]
 keywords = ["graphql", "pydantic"]
 license = "Apache 2.0"

utils/graphql-pydantic-converter/tests/render_models.py

@@ -155,3 +155,15 @@ class CreateScheduleMutation(Mutation):
     _name: str = PrivateAttr('createSchedule')
     input: CreateScheduleInput = Field(json_schema_extra={'type': 'CreateScheduleInput!'})
     payload: Schedule
+
+
+class DeleteScheduleMutation(Mutation):
+    _name: str = PrivateAttr('deleteSchedule')
+    name: String = Field(json_schema_extra={'type': 'String!'})
+    payload: Boolean
+
+
+class DeleteScheduleQuery(Query):
+    _name: str = PrivateAttr('deleteScheduleQuery')
+    name: String = Field(json_schema_extra={'type': 'String!'})
+    payload: Boolean

utils/graphql-pydantic-converter/tests/test_graphql_generator.py

@@ -34,6 +34,8 @@
 from .render_models import SearchPoolsByTagsQuery
 from .render_models import TagAnd
 from .render_models import TagOr
+from .render_models import DeleteScheduleMutation
+from .render_models import DeleteScheduleQuery
 
 
 class TestTaskGenerator:
@@ -95,6 +97,34 @@ def test_render_mutation(self) -> None:
         ).render(form='inline')
         assert reference == mutation.query
 
+        reference = 'mutation deleteSchedule($name: String!) { deleteSchedule(name: $name)  }'
+        mutation = DeleteScheduleMutation(
+            payload=True,
+            name="ScheduledWF"
+        ).render()
+        assert reference == mutation.query
+
+        reference = 'mutation { deleteSchedule ( name: "ScheduledWF")  }'
+        mutation = DeleteScheduleMutation(
+            payload=True,
+            name="ScheduledWF"
+        ).render(form='inline')
+        assert reference == mutation.query
+
+        reference = 'query deleteScheduleQuery($name: String!) { deleteScheduleQuery(name: $name)  }'
+        mutation = DeleteScheduleQuery(
+            payload=True,
+            name="ScheduledWF"
+        ).render()
+        assert reference == mutation.query
+
+        reference = '{ deleteScheduleQuery ( name: "ScheduledWF" )  }'
+        mutation = DeleteScheduleQuery(
+            payload=True,
+            name="ScheduledWF"
+        ).render(form='inline')
+        assert reference == mutation.query
+
     def test_render_input(self) -> None:
         class DeviceSize(ENUM):
             SMALL = 'SMALL'
@@ -498,3 +528,4 @@ def test_extracted_render(self) -> None:
 
         assert reference_mutation == mutation_str.query
         assert reference_variable == mutation_str.variable
+