Merge pull request #29 from pier-digital/f/fix-null-conversion

Set empty strings to null in metadata fields

pyproject.toml

@@ -1,8 +1,8 @@
 [tool.poetry]
 name = "retrack"
-version = "2.5.0"
+version = "2.5.1"
 description = "A business rules engine"
-authors = ["Gabriel Guarisa <[email protected]>", "Nathalia Trotte <[email protected]>"]
+authors = ["Gabriel Guarisa <[email protected]>"]
 license = "MIT"
 readme = "README.md"
 repository = "https://github.com/pier-digital/retrack"

retrack/nodes/base.py

@@ -44,6 +44,17 @@ def cast_int_to_str(v: typing.Any, info: pydantic.ValidationInfo) -> str:
 ]
 
 
+def cast_empty_string_to_none(v: str, info: pydantic.ValidationInfo) -> typing.Any:
+    if v == "":
+        return None
+    return v
+
+
+OptionalCastedToNoneStringType = typing.Annotated[
+    typing.Optional[str], pydantic.BeforeValidator(cast_empty_string_to_none)
+]
+
+
 class OutputConnectionItemModel(pydantic.BaseModel):
     node: CastedToStringType
     input_: str = pydantic.Field(alias="input")

retrack/nodes/inputs.py

@@ -7,6 +7,7 @@
     InputConnectionModel,
     NodeKind,
     OutputConnectionModel,
+    OptionalCastedToNoneStringType,
 )
 
 ################################################
@@ -16,7 +17,7 @@
 
 class InputMetadataModel(pydantic.BaseModel):
     name: str
-    default: typing.Optional[str] = None
+    default: OptionalCastedToNoneStringType = None
 
 
 ################################################

retrack/nodes/outputs.py

@@ -3,7 +3,12 @@
 import pandas as pd
 import pydantic
 
-from retrack.nodes.base import BaseNode, InputConnectionModel, NodeKind
+from retrack.nodes.base import (
+    BaseNode,
+    InputConnectionModel,
+    NodeKind,
+    OptionalCastedToNoneStringType,
+)
 from retrack.utils import constants
 
 ################################################
@@ -12,7 +17,7 @@
 
 
 class OutputMetadataModel(pydantic.BaseModel):
-    message: typing.Optional[str] = None
+    message: OptionalCastedToNoneStringType = None
 
 
 ################################################

tests/conftest.py

@@ -1,7 +1,7 @@
 import pytest
 
 
-@pytest.fixture
+@pytest.fixture(scope="function")
 def valid_input_dict_before_validation() -> dict:
     return {
         "id": 1,

tests/test_nodes/test_input.py

@@ -7,3 +7,10 @@ def test_input_node(
     input_node = Input(**valid_input_dict_before_validation)
 
     assert input_node.model_dump(by_alias=True) == valid_input_dict_after_validation
+
+
+def test_input_with_empty_string_as_default(valid_input_dict_before_validation):
+    valid_input_dict_before_validation["data"]["default"] = ""
+    input_node = Input(**valid_input_dict_before_validation)
+
+    assert input_node.data.default is None