Fix GraphQL query sent by sdk with hierarchical nodes

Author: LucasG0

infrahub_sdk/node.py

@@ -1275,6 +1275,14 @@ async def generate_query_data_node(
 
             if rel_schema and rel_schema.cardinality == "one":
                 rel_data = RelatedNode._generate_query_data(peer_data=peer_data)
+                # Nodes involved in a hierarchy are required to inherit from a common ancestor node, and graphql
+                # tries to resolve attributes in this ancestor instead of actual node. To avoid
+                # invalid queries issues when attribute is missing in the common ancestor, we use a fragment
+                # to explicit actual node kind we are querying.
+                if rel_schema.kind == RelationshipKind.HIERARCHY:
+                    data_node = rel_data["node"]
+                    rel_data["node"] = {}
+                    rel_data["node"][f"...on {rel_schema.peer}"] = data_node
             elif rel_schema and rel_schema.cardinality == "many":
                 rel_data = RelationshipManager._generate_query_data(peer_data=peer_data)
 
@@ -1764,6 +1772,14 @@ def generate_query_data_node(
 
             if rel_schema and rel_schema.cardinality == "one":
                 rel_data = RelatedNodeSync._generate_query_data(peer_data=peer_data)
+                # Nodes involved in a hierarchy are required to inherit from a common ancestor node, and graphql
+                # tries to resolve attributes in this ancestor instead of actual node. To avoid
+                # invalid queries issues when attribute is missing in the common ancestor, we use a fragment
+                # to explicit actual node kind we are querying.
+                if rel_schema.kind == RelationshipKind.HIERARCHY:
+                    data_node = rel_data["node"]
+                    rel_data["node"] = {}
+                    rel_data["node"][f"...on {rel_schema.peer}"] = data_node
             elif rel_schema and rel_schema.cardinality == "many":
                 rel_data = RelationshipManagerSync._generate_query_data(peer_data=peer_data)
 

tests/integration/conftest.py

@@ -499,6 +499,69 @@ async def ipam_schema() -> SchemaRoot:
     return SCHEMA
 
 
+@pytest.fixture(scope="module")
+async def hierarchical_schema() -> dict:
+    schema = {
+        "version": "1.0",
+        "generics": [
+            {
+                "name": "Generic",
+                "namespace": "Location",
+                "description": "Generic hierarchical location",
+                "label": "Location",
+                "hierarchical": True,
+                "human_friendly_id": ["name__value"],
+                "include_in_menu": True,
+                "attributes": [
+                    {
+                        "name": "name",
+                        "kind": "Text",
+                        "unique": True,
+                        "order_weight": 900
+                    },
+                ]
+            }
+        ],
+        "nodes": [
+            {
+                "name": "Country",
+                "namespace": "Location",
+                "description": "A country within a continent.",
+                "inherit_from": ["LocationGeneric"],
+                "generate_profile": False,
+                "default_filter": "name__value",
+                "order_by": ["name__value"],
+                "display_labels": ["name__value"],
+                "children": "LocationSite",
+                "attributes": [
+                    {
+                        "name": "shortname",
+                        "kind": "Text"
+                    }
+                ]
+            },
+            {
+                "name": "Site",
+                "namespace": "Location",
+                "description": "A site within a country.",
+                "inherit_from": ["LocationGeneric"],
+                "default_filter": "name__value",
+                "order_by": ["name__value"],
+                "display_labels": ["name__value"],
+                "children": "",
+                "parent": "LocationCountry",
+                "attributes": [
+                    {
+                        "name": "shortname",
+                        "kind": "Text"
+                    }
+                ]
+            }
+        ]
+    }
+    return schema
+
+
 class BusRecorder(InfrahubMessageBus):
     def __init__(self, component_type: Optional[ComponentType] = None):
         self.messages: list[InfrahubMessage] = []

tests/integration/test_infrahub_client.py

@@ -293,3 +293,28 @@ async def test_create_branch(self, client: InfrahubClient, db: InfrahubDatabase,
     async def test_create_branch_async(self, client: InfrahubClient, db: InfrahubDatabase, init_db_base, base_dataset):
         task_id = await client.branch.create(branch_name="new-branch-2", wait_until_completion=False)
         assert isinstance(task_id, str)
+
+    # See issue #148.
+    async def test_hierarchical(self, client: InfrahubClient, db: InfrahubDatabase, init_db_base, base_dataset, hierarchical_schema):
+
+        await client.schema.load(schemas=[hierarchical_schema])
+
+        location_country = await client.create(kind="LocationCountry",
+                                            name="country_name",
+                                            shortname="country_shortname")
+        await location_country.save()
+
+        location_site = await client.create(kind="LocationSite",
+                                            name="site_name",
+                                            shortname="site_shortname",
+                                            parent=location_country)
+        await location_site.save()
+
+        nodes = await client.all(kind="LocationSite", prefetch_relationships=True, populate_store=True)
+        assert len(nodes) == 1
+        site_node = nodes[0]
+        assert site_node.name.value == "site_name"
+        assert site_node.shortname.value == "site_shortname"
+        country_node = site_node.parent.get()
+        assert country_node.name.value == "country_name"
+        assert country_node.shortname.value == "country_shortname"

tests/integration/test_infrahub_client_sync.py

@@ -295,3 +295,29 @@ def test_create_branch(self, client: InfrahubClientSync, db: InfrahubDatabase, i
     def test_create_branch_async(self, client: InfrahubClientSync, db: InfrahubDatabase, init_db_base, base_dataset):
         task_id = client.branch.create(branch_name="new-branch-2", wait_until_completion=False)
         assert isinstance(task_id, str)
+
+
+    # See issue #148.
+    def test_hierarchical(self, client: InfrahubClientSync, db: InfrahubDatabase, init_db_base, base_dataset, hierarchical_schema):
+
+        client.schema.load(schemas=[hierarchical_schema])
+
+        location_country = client.create(kind="LocationCountry",
+                                            name="country_name",
+                                            shortname="country_shortname")
+        location_country.save()
+
+        location_site = client.create(kind="LocationSite",
+                                            name="site_name",
+                                            shortname="site_shortname",
+                                            parent=location_country)
+        location_site.save()
+
+        nodes = client.all(kind="LocationSite", prefetch_relationships=True, populate_store=True)
+        assert len(nodes) == 1
+        site_node = nodes[0]
+        assert site_node.name.value == "site_name"
+        assert site_node.shortname.value == "site_shortname"
+        country_node = site_node.parent.get()
+        assert country_node.name.value == "country_name"
+        assert country_node.shortname.value == "country_shortname"