Order of retrieved nodes can be disabled

Author: LucasG0

changelog/+nodes-order.added.md

@@ -0,0 +1 @@
+`client.all` and `client.filters` now support `order` parameter allowing to disable order of retrieve nodes in order to enhance performances

infrahub_sdk/client.py

@@ -51,7 +51,7 @@
 from .schema import InfrahubSchema, InfrahubSchemaSync, NodeSchemaAPI
 from .store import NodeStore, NodeStoreSync
 from .timestamp import Timestamp
-from .types import AsyncRequester, HTTPMethod, SyncRequester
+from .types import AsyncRequester, HTTPMethod, Order, SyncRequester
 from .utils import decode_json, get_user_permissions, is_valid_uuid
 
 if TYPE_CHECKING:
@@ -576,6 +576,7 @@ async def all(
         prefetch_relationships: bool = ...,
         property: bool = ...,
         parallel: bool = ...,
+        order: Order | None = ...,
     ) -> list[SchemaType]: ...
 
     @overload
@@ -594,6 +595,7 @@ async def all(
         prefetch_relationships: bool = ...,
         property: bool = ...,
         parallel: bool = ...,
+        order: Order | None = ...,
     ) -> list[InfrahubNode]: ...
 
     async def all(
@@ -611,6 +613,7 @@ async def all(
         prefetch_relationships: bool = False,
         property: bool = False,
         parallel: bool = False,
+        order: Order | None = None,
     ) -> list[InfrahubNode] | list[SchemaType]:
         """Retrieve all nodes of a given kind
 
@@ -627,6 +630,7 @@ async def all(
             fragment (bool, optional): Flag to use GraphQL fragments for generic schemas.
             prefetch_relationships (bool, optional): Flag to indicate whether to prefetch related node data.
             parallel (bool, optional): Whether to use parallel processing for the query.
+            order (Order, optional): Ordering related options. Setting `disable=True` enhances performances.
 
         Returns:
             list[InfrahubNode]: List of Nodes
@@ -645,6 +649,7 @@ async def all(
             prefetch_relationships=prefetch_relationships,
             property=property,
             parallel=parallel,
+            order=order,
         )
 
     @overload
@@ -664,6 +669,7 @@ async def filters(
         partial_match: bool = ...,
         property: bool = ...,
         parallel: bool = ...,
+        order: Order | None = ...,
         **kwargs: Any,
     ) -> list[SchemaType]: ...
 
@@ -684,6 +690,7 @@ async def filters(
         partial_match: bool = ...,
         property: bool = ...,
         parallel: bool = ...,
+        order: Order | None = ...,
         **kwargs: Any,
     ) -> list[InfrahubNode]: ...
 
@@ -703,6 +710,7 @@ async def filters(
         partial_match: bool = False,
         property: bool = False,
         parallel: bool = False,
+        order: Order | None = None,
         **kwargs: Any,
     ) -> list[InfrahubNode] | list[SchemaType]:
         """Retrieve nodes of a given kind based on provided filters.
@@ -721,6 +729,7 @@ async def filters(
             prefetch_relationships (bool, optional): Flag to indicate whether to prefetch related node data.
             partial_match (bool, optional): Allow partial match of filter criteria for the query.
             parallel (bool, optional): Whether to use parallel processing for the query.
+            order (Order, optional): Ordering related options. Setting `disable=True` enhances performances.
             **kwargs (Any): Additional filter criteria for the query.
 
         Returns:
@@ -747,6 +756,7 @@ async def process_page(page_offset: int, page_number: int) -> tuple[dict, Proces
                 prefetch_relationships=prefetch_relationships,
                 partial_match=partial_match,
                 property=property,
+                order=order,
             )
             query = Query(query=query_data)
             response = await self.execute_graphql(
@@ -1670,6 +1680,7 @@ def all(
         prefetch_relationships: bool = ...,
         property: bool = ...,
         parallel: bool = ...,
+        order: Order | None = ...,
     ) -> list[SchemaTypeSync]: ...
 
     @overload
@@ -1688,6 +1699,7 @@ def all(
         prefetch_relationships: bool = ...,
         property: bool = ...,
         parallel: bool = ...,
+        order: Order | None = ...,
     ) -> list[InfrahubNodeSync]: ...
 
     def all(
@@ -1705,6 +1717,7 @@ def all(
         prefetch_relationships: bool = False,
         property: bool = False,
         parallel: bool = False,
+        order: Order | None = None,
     ) -> list[InfrahubNodeSync] | list[SchemaTypeSync]:
         """Retrieve all nodes of a given kind
 
@@ -1721,6 +1734,7 @@ def all(
             fragment (bool, optional): Flag to use GraphQL fragments for generic schemas.
             prefetch_relationships (bool, optional): Flag to indicate whether to prefetch related node data.
             parallel (bool, optional): Whether to use parallel processing for the query.
+            order (Order, optional): Ordering related options. Setting `disable=True` enhances performances.
 
         Returns:
             list[InfrahubNodeSync]: List of Nodes
@@ -1739,6 +1753,7 @@ def all(
             prefetch_relationships=prefetch_relationships,
             property=property,
             parallel=parallel,
+            order=order,
         )
 
     def _process_nodes_and_relationships(
@@ -1793,6 +1808,7 @@ def filters(
         partial_match: bool = ...,
         property: bool = ...,
         parallel: bool = ...,
+        order: Order | None = ...,
         **kwargs: Any,
     ) -> list[SchemaTypeSync]: ...
 
@@ -1813,6 +1829,7 @@ def filters(
         partial_match: bool = ...,
         property: bool = ...,
         parallel: bool = ...,
+        order: Order | None = ...,
         **kwargs: Any,
     ) -> list[InfrahubNodeSync]: ...
 
@@ -1832,6 +1849,7 @@ def filters(
         partial_match: bool = False,
         property: bool = False,
         parallel: bool = False,
+        order: Order | None = None,
         **kwargs: Any,
     ) -> list[InfrahubNodeSync] | list[SchemaTypeSync]:
         """Retrieve nodes of a given kind based on provided filters.
@@ -1850,6 +1868,7 @@ def filters(
             prefetch_relationships (bool, optional): Flag to indicate whether to prefetch related node data.
             partial_match (bool, optional): Allow partial match of filter criteria for the query.
             parallel (bool, optional): Whether to use parallel processing for the query.
+            order (Order, optional): Ordering related options. Setting `disable=True` enhances performances.
             **kwargs (Any): Additional filter criteria for the query.
 
         Returns:
@@ -1875,6 +1894,7 @@ def process_page(page_offset: int, page_number: int) -> tuple[dict, ProcessRelat
                 prefetch_relationships=prefetch_relationships,
                 partial_match=partial_match,
                 property=property,
+                order=order,
             )
             query = Query(query=query_data)
             response = self.execute_graphql(

infrahub_sdk/graphql.py

@@ -2,6 +2,8 @@
 
 from typing import Any
 
+from pydantic import BaseModel
+
 VARIABLE_TYPE_MAPPING = ((str, "String!"), (int, "Int!"), (float, "Float!"), (bool, "Boolean!"))
 
 
@@ -15,6 +17,9 @@ def convert_to_graphql_as_string(value: str | bool | list) -> str:
     if isinstance(value, list):
         values_as_string = [convert_to_graphql_as_string(item) for item in value]
         return "[" + ", ".join(values_as_string) + "]"
+    if isinstance(value, BaseModel):
+        data = value.model_dump()
+        return "{ " + ", ".join(f"{key}: {convert_to_graphql_as_string(val)}" for key, val in data.items()) + " }"
 
     return str(value)
 

infrahub_sdk/node.py

@@ -23,6 +23,7 @@
 
     from .client import InfrahubClient, InfrahubClientSync
     from .schema import AttributeSchemaAPI, MainSchemaTypesAPI, RelationshipSchemaAPI
+    from .types import Order
 
 # pylint: disable=too-many-lines
 
@@ -977,6 +978,7 @@ def generate_query_data_init(
         include: list[str] | None = None,
         exclude: list[str] | None = None,
         partial_match: bool = False,
+        order: Order | None = None,
     ) -> dict[str, Any | dict]:
         data: dict[str, Any] = {
             "count": None,
@@ -985,6 +987,9 @@ def generate_query_data_init(
 
         data["@filters"] = filters or {}
 
+        if order:
+            data["@filters"]["order"] = order
+
         if offset:
             data["@filters"]["offset"] = offset
 
@@ -1176,9 +1181,16 @@ async def generate_query_data(
         prefetch_relationships: bool = False,
         partial_match: bool = False,
         property: bool = False,
+        order: Order | None = None,
     ) -> dict[str, Any | dict]:
         data = self.generate_query_data_init(
-            filters=filters, offset=offset, limit=limit, include=include, exclude=exclude, partial_match=partial_match
+            filters=filters,
+            offset=offset,
+            limit=limit,
+            include=include,
+            exclude=exclude,
+            partial_match=partial_match,
+            order=order,
         )
         data["edges"]["node"].update(
             await self.generate_query_data_node(
@@ -1682,9 +1694,16 @@ def generate_query_data(
         prefetch_relationships: bool = False,
         partial_match: bool = False,
         property: bool = False,
+        order: Order | None = None,
     ) -> dict[str, Any | dict]:
         data = self.generate_query_data_init(
-            filters=filters, offset=offset, limit=limit, include=include, exclude=exclude, partial_match=partial_match
+            filters=filters,
+            offset=offset,
+            limit=limit,
+            include=include,
+            exclude=exclude,
+            partial_match=partial_match,
+            order=order,
         )
         data["edges"]["node"].update(
             self.generate_query_data_node(

infrahub_sdk/schema/main.py

@@ -264,6 +264,7 @@ class BaseSchema(BaseModel):
     icon: str | None = None
     uniqueness_constraints: list[list[str]] | None = None
     documentation: str | None = None
+    order_by: list[str] | None = None
 
     @property
     def kind(self) -> str:

infrahub_sdk/testing/schemas/animal.py

@@ -81,6 +81,7 @@ def schema_cat(self) -> NodeSchema:
             include_in_menu=True,
             inherit_from=[TESTING_ANIMAL],
             display_labels=["name__value", "breed__value", "color__value"],
+            order_by=["name__value"],
             attributes=[
                 Attr(name="breed", kind=AttributeKind.TEXT, optional=False),
                 Attr(name="color", kind=AttributeKind.COLOR, default_value="#555555", optional=True),

infrahub_sdk/types.py

@@ -4,6 +4,8 @@
 from logging import Logger
 from typing import TYPE_CHECKING, Any, Protocol, Union, runtime_checkable
 
+from pydantic import BaseModel
+
 if TYPE_CHECKING:
     import httpx
 
@@ -64,3 +66,7 @@ def exception(self, event: str | None = None, *args: Any, **kw: Any) -> Any:
 
 
 InfrahubLoggers = Union[InfrahubLogger, Logger]
+
+
+class Order(BaseModel):
+    disable: bool | None = None

tests/integration/test_infrahub_client.py

@@ -59,7 +59,22 @@ async def test_get_all(self, client: InfrahubClient, base_dataset):
         nodes = await client.all(kind=TESTING_CAT)
         assert len(nodes) == 2
         assert isinstance(nodes[0], InfrahubNode)
-        assert sorted([node.name.value for node in nodes]) == ["Bella", "Luna"]
+        assert [node.name.value for node in nodes] == ["Bella", "Luna"]
+
+    # TODO enable these tests for infrahub version containing this commit
+    #  https://github.com/opsmill/infrahub/commit/5a4d6860196b5bfb51fb8a124f33125f4a0b6753
+    #  when we support testing against multiple infrahub versions.
+    # async def test_get_all_no_order(self, client: InfrahubClient, base_dataset):
+    #     nodes = await client.all(kind=TESTING_CAT, order=Order(disable=True))
+    #     assert len(nodes) == 2
+    #     assert isinstance(nodes[0], InfrahubNode)
+    #     assert {node.name.value for node in nodes} == {"Bella", "Luna"}
+    #
+    # async def test_get_filters_no_order(self, client: InfrahubClient, base_dataset):
+    #     nodes = await client.filters(kind=TESTING_CAT, order=Order(disable=True))
+    #     assert len(nodes) == 2
+    #     assert isinstance(nodes[0], InfrahubNode)
+    #     assert {node.name.value for node in nodes} == {"Bella", "Luna"}
 
     async def test_get_one(self, client: InfrahubClient, base_dataset, cat_luna, person_sophia):
         node1 = await client.get(kind=TESTING_CAT, id=cat_luna.id)