Fix optional relationships preventing object template defaults from applying (#634)

* Initial plan

* Fix optional attributes not being set when using object templates

- Modified _generate_input_data() to skip adding None for optional relationships on new nodes
- For existing nodes, still include None to allow clearing relationships (preserves PR #515 behavior)
- Updated tests to reflect new behavior
- Added test to verify existing nodes still work correctly

Co-authored-by: minitriga <[email protected]>

* Add type annotations to test parameters and use BothClients fixture

- Added BothClients import to TYPE_CHECKING block
- Updated test_update_input_data_existing_node_with_optional_relationship to use clients fixture with proper type annotations
- Changed from client fixture to clients fixture (clients.standard and clients.sync)
- Added type annotation for client_type parameter

Co-authored-by: minitriga <[email protected]>

* Use __future__ annotations and add changelog for issue 630

- Added `from __future__ import annotations` to enable postponed evaluation
- Changed `clients: "BothClients"` to `clients: BothClients` without string quotes
- Moved GenericSchema, NodeSchemaAPI, and HTTPXMock imports to TYPE_CHECKING block
- Added changelog/630.fixed.md documenting the fix

Co-authored-by: minitriga <[email protected]>

* Fix linting: correct import path in TYPE_CHECKING block

Changed `from tests.unit.sdk.conftest import BothClients` to `from .conftest import BothClients` to fix ruff import sorting error after merge from stable branch.

Co-authored-by: minitriga <[email protected]>

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: minitriga <[email protected]>
Co-authored-by: Alex Gittings <[email protected]>

Author: Copilot

changelog/630.fixed.md

@@ -0,0 +1 @@
+Fixed SDK including explicit `null` values for uninitialized optional relationships when creating nodes with object templates, which prevented the backend from applying template defaults.

infrahub_sdk/node/node.py

@@ -210,7 +210,7 @@ def is_resource_pool(self) -> bool:
     def get_raw_graphql_data(self) -> dict | None:
         return self._data
 
-    def _generate_input_data(  # noqa: C901
+    def _generate_input_data(  # noqa: C901, PLR0915
         self,
         exclude_unmodified: bool = False,
         exclude_hfid: bool = False,
@@ -253,7 +253,10 @@ def _generate_input_data(  # noqa: C901
             rel: RelatedNodeBase | RelationshipManagerBase = getattr(self, item_name)
 
             if rel_schema.cardinality == RelationshipCardinality.ONE and rel_schema.optional and not rel.initialized:
-                data[item_name] = None
+                # Only include None for existing nodes to allow clearing relationships
+                # For new nodes, omit the field to allow object template defaults to be applied
+                if self._existing:
+                    data[item_name] = None
                 continue
 
             if rel is None or not rel.initialized:

tests/unit/sdk/test_node.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import inspect
 import ipaddress
 from typing import TYPE_CHECKING
@@ -16,11 +18,14 @@
 )
 from infrahub_sdk.node.constants import SAFE_VALUE
 from infrahub_sdk.node.related_node import RelatedNode, RelatedNodeSync
-from infrahub_sdk.schema import GenericSchema, NodeSchemaAPI
-from tests.unit.sdk.conftest import BothClients
 
 if TYPE_CHECKING:
+    from pytest_httpx import HTTPXMock
+
     from infrahub_sdk.client import InfrahubClient, InfrahubClientSync
+    from infrahub_sdk.schema import GenericSchema, NodeSchemaAPI
+
+    from .conftest import BothClients
 
 # type: ignore[attr-defined]
 
@@ -1366,7 +1371,6 @@ async def test_create_input_data(client, location_schema: NodeSchemaAPI, client_
             "name": {"value": "JFK1"},
             "description": {"value": "JFK Airport"},
             "type": {"value": "SITE"},
-            "primary_tag": None,
         }
     }
 
@@ -1394,6 +1398,38 @@ async def test_create_input_data_with_dropdown(client, location_schema_with_drop
             "description": {"value": "JFK Airport"},
             "type": {"value": "SITE"},
             "status": {"value": None},
+        }
+    }
+
+
+@pytest.mark.parametrize("client_type", client_types)
+async def test_update_input_data_existing_node_with_optional_relationship(
+    clients: BothClients, location_schema: NodeSchemaAPI, client_type: str
+) -> None:
+    """Validate that existing nodes include None for uninitialized optional relationships.
+
+    This ensures that we can explicitly clear optional relationships when updating existing nodes.
+    """
+    # Simulate an existing node by including an id
+    data = {
+        "id": "existing-node-id",
+        "name": {"value": "JFK1"},
+        "description": {"value": "JFK Airport"},
+        "type": {"value": "SITE"},
+    }
+
+    if client_type == "standard":
+        node = InfrahubNode(client=clients.standard, schema=location_schema, data=data)
+    else:
+        node = InfrahubNodeSync(client=clients.sync, schema=location_schema, data=data)
+
+    # For existing nodes, optional uninitialized relationships should include None
+    assert node._generate_input_data()["data"] == {
+        "data": {
+            "id": "existing-node-id",
+            "name": {"value": "JFK1"},
+            "description": {"value": "JFK Airport"},
+            "type": {"value": "SITE"},
             "primary_tag": None,
         }
     }
@@ -1642,7 +1678,7 @@ async def test_create_input_data_with_IPHost_attribute(client, ipaddress_schema,
         ip_address = InfrahubNodeSync(client=client, schema=ipaddress_schema, data=data)
 
     assert ip_address._generate_input_data()["data"] == {
-        "data": {"address": {"value": "1.1.1.1/24", "is_protected": True}, "interface": None}
+        "data": {"address": {"value": "1.1.1.1/24", "is_protected": True}}
     }
 
 
@@ -1656,7 +1692,7 @@ async def test_create_input_data_with_IPNetwork_attribute(client, ipnetwork_sche
         ip_network = InfrahubNodeSync(client=client, schema=ipnetwork_schema, data=data)
 
     assert ip_network._generate_input_data()["data"] == {
-        "data": {"network": {"value": "1.1.1.0/24", "is_protected": True}, "site": None}
+        "data": {"network": {"value": "1.1.1.0/24", "is_protected": True}}
     }