[resotocore][feat] Allow kind to be part of the node data (#1817)

resotocore/resotocore/cli/command.py

@@ -1446,7 +1446,7 @@ async def get_db(at: Optional[datetime], graph_name: GraphName) -> Tuple[GraphDB
 
         async def load_query_model(db: GraphDB, graph_name: GraphName) -> QueryModel:
             model = await self.dependencies.model_handler.load_model(graph_name)
-            query_model = QueryModel(query, model)
+            query_model = QueryModel(query, model, ctx.env)
             await db.to_query(query_model)  # only here to validate the query itself (can throw)
             return query_model
 
@@ -3127,7 +3127,7 @@ async def load_element(items: List[JsonElement]) -> AsyncIterator[JsonElement]:
                     .merge_with("ancestors.region", NavigateUntilRoot, P.of_kind("region"))
                     .merge_with("ancestors.zone", NavigateUntilRoot, P.of_kind("zone"))
                 ).rewrite_for_ancestors_descendants(variables)
-                query_model = QueryModel(query, model)
+                query_model = QueryModel(query, model, env)
                 async with await self.dependencies.db_access.get_graph_db(GraphName(env["graph"])).search_list(
                     query_model
                 ) as crs:
@@ -5889,7 +5889,7 @@ async def sync_database_result(p: Namespace, maybe_stream: Optional[JsStream]) -
                     query = Query(parts=[Part(term=IsTerm(["graph_root"]), navigation=NavigateUntilLeaf)])
                     graph_db = self.dependencies.db_access.get_graph_db(ctx.graph_name)
                     async with await graph_db.search_graph_gen(
-                        QueryModel(query, resoto_model), timeout=timedelta(weeks=200000)
+                        QueryModel(query, resoto_model, ctx.env), timeout=timedelta(weeks=200000)
                     ) as cursor:
                         await sync_fn(query=query, in_stream=stream.iterate(cursor))
 

resotocore/resotocore/db/graphdb.py

@@ -53,6 +53,7 @@
     synthetic_metadata_kinds,
 )
 from resotocore.model.resolve_in_graph import NodePath, GraphResolver
+from resotocore.model.typed_model import to_js
 from resotocore.query.model import Query, FulltextTerm, MergeTerm, P, Predicate
 from resotocore.report import ReportSeverity
 from resotocore.types import JsonElement, EdgeType
@@ -569,7 +570,7 @@ async def search_list(
         q_string, bind = await self.to_query(query)
         return await self.db.aql_cursor(
             query=q_string,
-            trafo=self.document_to_instance_fn(query.model, query.query),
+            trafo=self.document_to_instance_fn(query.model, query),
             count=with_count,
             bind_vars=bind,
             batch_size=10000,
@@ -605,7 +606,10 @@ async def search_history(
             None
             if query.query.aggregate
             else self.document_to_instance_fn(
-                query.model, query.query, ["change", "changed_at", "created", "updated", "deleted"], id_column="id"
+                query.model,
+                query,
+                ["change", "changed_at", "created", "updated", "deleted"],
+                id_column="id",
             )
         )
         ttl = cast(Number, int(timeout.total_seconds())) if timeout else None
@@ -620,7 +624,7 @@ async def search_graph_gen(
         query_string, bind = await self.to_query(query, with_edges=True)
         return await self.db.aql_cursor(
             query=query_string,
-            trafo=self.document_to_instance_fn(query.model, query.query),
+            trafo=self.document_to_instance_fn(query.model, query),
             bind_vars=bind,
             count=with_count,
             batch_size=10000,
@@ -655,11 +659,12 @@ async def wipe(self) -> None:
     @staticmethod
     def document_to_instance_fn(
         model: Model,
-        query: Optional[Query] = None,
+        query: Optional[QueryModel] = None,
         additional_root_props: Optional[List[str]] = None,
         id_column: str = "_key",
     ) -> Callable[[Json], Json]:
         synthetic_metadata = model.predefined_synthetic_props(synthetic_metadata_kinds)
+        with_kinds = query and query.is_set("with-kind")
 
         def props(doc: Json, result: Json, definition: Iterable[str]) -> None:
             for prop in definition:
@@ -682,11 +687,13 @@ def render_prop(doc: Json, root_level: bool) -> Json:
                 if "_rev" in doc:
                     result["revision"] = doc["_rev"]
                 props(doc, result, Section.content_ordered)
+                kind = model.get(doc[Section.reported])
                 if root_level:
                     props(doc, result, Section.lookup_sections_ordered)
                     if additional_root_props:
                         props(doc, result, additional_root_props)
-                kind = model.get(doc[Section.reported])
+                    if with_kinds and kind is not None:
+                        result["kind"] = to_js(kind)
                 if isinstance(kind, ComplexKind):
                     synth_props(doc, result, Section.reported, kind.synthetic_props())
                     synth_props(doc, result, Section.metadata, synthetic_metadata)
@@ -709,7 +716,7 @@ def render_merge_results(doc: Json, result: Json, q: Query) -> Json:
         def merge_results(doc: Json) -> Json:
             rendered = render_prop(doc, True)
             if query:
-                render_merge_results(doc, rendered, query)
+                render_merge_results(doc, rendered, query.query)
             return rendered
 
         return merge_results

resotocore/resotocore/db/model.py

@@ -1,33 +1,37 @@
 from __future__ import annotations
+
 from abc import ABC
-from typing import Any
+from typing import Dict, Any
+
+from attr import define
 
 from resotocore.model.model import Model
 from resotocore.query.model import Query
 
 
-class QueryModel(ABC):
-    def __init__(self, query: Query, model: Model):
-        self.query = query
-        self.model = model
+@define
+class QueryModel:
+    query: Query
+    model: Model
+    env: Dict[str, Any] = {}
+
+    def is_set(self, name: str) -> bool:
+        if value := self.env.get(name):
+            if isinstance(value, bool):
+                return value
+            elif isinstance(value, str):
+                return value.lower() in ["1", "true", "yes", "y"]
+        return False
 
 
+@define(repr=True, eq=True)
 class GraphUpdate(ABC):
-    def __init__(
-        self,
-        nodes_created: int = 0,
-        nodes_updates: int = 0,
-        nodes_deleted: int = 0,
-        edges_created: int = 0,
-        edges_updated: int = 0,
-        edges_deleted: int = 0,
-    ):
-        self.nodes_created = nodes_created
-        self.nodes_updated = nodes_updates
-        self.nodes_deleted = nodes_deleted
-        self.edges_created = edges_created
-        self.edges_updated = edges_updated
-        self.edges_deleted = edges_deleted
+    nodes_created: int = 0
+    nodes_updated: int = 0
+    nodes_deleted: int = 0
+    edges_created: int = 0
+    edges_updated: int = 0
+    edges_deleted: int = 0
 
     def all_changes(self) -> int:
         return (
@@ -48,20 +52,3 @@ def __add__(self, other: GraphUpdate) -> GraphUpdate:
             self.edges_updated + other.edges_updated,
             self.edges_deleted + other.edges_deleted,
         )
-
-    def __repr__(self) -> str:
-        return (
-            f"[[{self.nodes_created},{self.nodes_updated},"
-            f"{self.nodes_deleted}],[{self.edges_created},"
-            f"{self.edges_updated},{self.edges_deleted}]]"
-        )
-
-    def __str__(self) -> str:
-        return (
-            f"GraphUpdate(nodes_created={self.nodes_created}, nodes_updated={self.nodes_updated}, "
-            f"nodes_deleted={self.nodes_deleted}, edges_created={self.edges_created}, "
-            f"edges_updated={self.edges_updated}, edges_deleted={self.edges_deleted})"
-        )
-
-    def __eq__(self, other: Any) -> bool:
-        return self.__dict__ == other.__dict__ if isinstance(other, GraphUpdate) else False