infrahub-server 1.2.2__py3-none-any.whl → 1.2.3__py3-none-any.whl

infrahub_sdk/store.py

@@ -1,16 +1,18 @@
 from __future__ import annotations
 
-from collections import defaultdict
-from typing import TYPE_CHECKING, Any, Literal, overload
+import warnings
+from typing import TYPE_CHECKING, Literal, overload
 
-from .exceptions import NodeNotFoundError
+from .exceptions import NodeInvalidError, NodeNotFoundError
+from .node import parse_human_friendly_id
 
 if TYPE_CHECKING:
-    from .client import SchemaType
+    from .client import SchemaType, SchemaTypeSync
     from .node import InfrahubNode, InfrahubNodeSync
+    from .protocols_base import CoreNode, CoreNodeSync
 
 
-def get_schema_name(schema: str | type[SchemaType] | None = None) -> str | None:
+def get_schema_name(schema: type[SchemaType | SchemaTypeSync] | str | None = None) -> str | None:
     if isinstance(schema, str):
         return schema
 
@@ -20,130 +22,404 @@ def get_schema_name(schema: str | type[SchemaType] | None = None) -> str | None:
     return None
 
 
-class NodeStoreBase:
-    """Internal Store for InfrahubNode objects.
-
-    Often while creating a lot of new objects,
-    we need to save them in order to reuse them later to associate them with another node for example.
-    """
+class NodeStoreBranch:
+    def __init__(self, name: str) -> None:
+        self.branch_name = name
 
-    def __init__(self) -> None:
-        self._store: dict[str, dict] = defaultdict(dict)
-        self._store_by_hfid: dict[str, Any] = defaultdict(dict)
+        self._objs: dict[str, InfrahubNode | InfrahubNodeSync | CoreNode | CoreNodeSync] = {}
+        self._hfids: dict[str, dict[tuple, str]] = {}
+        self._keys: dict[str, str] = {}
+        self._uuids: dict[str, str] = {}
 
-    def _set(self, node: InfrahubNode | InfrahubNodeSync | SchemaType, key: str | None = None) -> None:
-        hfid = node.get_human_friendly_id_as_string(include_kind=True)
+    def count(self) -> int:
+        return len(self._objs)
 
-        if not key and not hfid:
-            raise ValueError("Cannot store node without human friendly ID or key.")
+    def set(self, node: InfrahubNode | InfrahubNodeSync | CoreNode | CoreNodeSync, key: str | None = None) -> None:
+        self._objs[node._internal_id] = node
 
         if key:
-            node_kind = node._schema.kind
-            self._store[node_kind][key] = node
+            self._keys[key] = node._internal_id
 
-        if hfid:
-            self._store_by_hfid[hfid] = node
+        if node.id:
+            self._uuids[node.id] = node._internal_id
+
+        if hfid := node.get_human_friendly_id():
+            for kind in node.get_all_kinds():
+                if kind not in self._hfids:
+                    self._hfids[kind] = {}
+                self._hfids[kind][tuple(hfid)] = node._internal_id
+
+    def get(
+        self,
+        key: str | list[str],
+        kind: type[SchemaType | SchemaTypeSync] | str | None = None,
+        raise_when_missing: bool = True,
+    ) -> InfrahubNode | InfrahubNodeSync | CoreNode | CoreNodeSync | None:
+        found_invalid = False
 
-    def _get(self, key: str, kind: str | type[SchemaType] | None = None, raise_when_missing: bool = True):  # type: ignore[no-untyped-def]
         kind_name = get_schema_name(schema=kind)
-        if kind_name and kind_name not in self._store and key not in self._store[kind_name]:  # type: ignore[attr-defined]
-            if not raise_when_missing:
-                return None
+
+        if isinstance(key, list):
+            try:
+                return self._get_by_hfid(key, kind=kind_name)
+            except NodeNotFoundError:
+                pass
+
+        elif isinstance(key, str):
+            try:
+                return self._get_by_internal_id(key, kind=kind_name)
+            except NodeInvalidError:
+                found_invalid = True
+            except NodeNotFoundError:
+                pass
+
+            try:
+                return self._get_by_id(key, kind=kind_name)
+            except NodeInvalidError:
+                found_invalid = True
+            except NodeNotFoundError:
+                pass
+
+            try:
+                return self._get_by_key(key, kind=kind_name)
+            except NodeInvalidError:
+                found_invalid = True
+            except NodeNotFoundError:
+                pass
+
+            try:
+                return self._get_by_hfid(key, kind=kind_name)
+            except NodeNotFoundError:
+                pass
+
+        if not raise_when_missing:
+            return None
+
+        if kind and found_invalid:
+            raise NodeInvalidError(
+                identifier={"key": [key] if isinstance(key, str) else key},
+                message=f"Found a node of a different kind instead of {kind} for key {key!r} in the store ({self.branch_name})",
+            )
+
+        raise NodeNotFoundError(
+            identifier={"key": [key] if isinstance(key, str) else key},
+            message=f"Unable to find the node {key!r} in the store ({self.branch_name})",
+        )
+
+    def _get_by_internal_id(
+        self, internal_id: str, kind: str | None = None
+    ) -> InfrahubNode | InfrahubNodeSync | CoreNode | CoreNodeSync:
+        if internal_id not in self._objs:
+            raise NodeNotFoundError(
+                identifier={"internal_id": [internal_id]},
+                message=f"Unable to find the node {internal_id!r} in the store ({self.branch_name})",
+            )
+
+        node = self._objs[internal_id]
+        if kind and kind not in node.get_all_kinds():
+            raise NodeInvalidError(
+                node_type=kind,
+                identifier={"internal_id": [internal_id]},
+                message=f"Found a node of kind {node.get_kind()} instead of {kind} for internal_id {internal_id!r} in the store ({self.branch_name})",
+            )
+
+        return node
+
+    def _get_by_key(
+        self, key: str, kind: str | None = None
+    ) -> InfrahubNode | InfrahubNodeSync | CoreNode | CoreNodeSync:
+        if key not in self._keys:
             raise NodeNotFoundError(
-                node_type=kind_name,
                 identifier={"key": [key]},
-                message="Unable to find the node in the Store",
+                message=f"Unable to find the node {key!r} in the store ({self.branch_name})",
             )
 
-        if kind_name and kind_name in self._store and key in self._store[kind_name]:  # type: ignore[attr-defined]
-            return self._store[kind_name][key]  # type: ignore[attr-defined]
+        node = self._get_by_internal_id(self._keys[key])
 
-        for item in self._store.values():  # type: ignore[attr-defined]
-            if key in item:
-                return item[key]
+        if kind and node.get_kind() != kind:
+            raise NodeInvalidError(
+                node_type=kind,
+                identifier={"key": [key]},
+                message=f"Found a node of kind {node.get_kind()} instead of {kind} for key {key!r} in the store ({self.branch_name})",
+            )
 
-        if not raise_when_missing:
-            return None
-        raise NodeNotFoundError(
-            node_type="n/a",
-            identifier={"key": [key]},
-            message=f"Unable to find the node {key!r} in the store",
+        return node
+
+    def _get_by_id(self, id: str, kind: str | None = None) -> InfrahubNode | InfrahubNodeSync | CoreNode | CoreNodeSync:
+        if id not in self._uuids:
+            raise NodeNotFoundError(
+                identifier={"id": [id]},
+                message=f"Unable to find the node {id!r} in the store ({self.branch_name})",
+            )
+
+        node = self._get_by_internal_id(self._uuids[id])
+        if kind and kind not in node.get_all_kinds():
+            raise NodeInvalidError(
+                node_type=kind,
+                identifier={"id": [id]},
+                message=f"Found a node of kind {node.get_kind()} instead of {kind} for id {id!r} in the store ({self.branch_name})",
+            )
+
+        return node
+
+    def _get_by_hfid(
+        self, hfid: str | list[str], kind: str | None = None
+    ) -> InfrahubNode | InfrahubNodeSync | CoreNode | CoreNodeSync:
+        if not kind:
+            node_kind, node_hfid = parse_human_friendly_id(hfid)
+        elif kind and isinstance(hfid, str) and hfid.startswith(kind):
+            node_kind, node_hfid = parse_human_friendly_id(hfid)
+        else:
+            node_kind = kind
+            node_hfid = [hfid] if isinstance(hfid, str) else hfid
+
+        exception_to_raise_if_not_found = NodeNotFoundError(
+            node_type=node_kind,
+            identifier={"hfid": node_hfid},
+            message=f"Unable to find the node {hfid!r} in the store ({self.branch_name})",
         )
 
-    def _get_by_hfid(self, key: str, raise_when_missing: bool = True):  # type: ignore[no-untyped-def]
-        try:
-            return self._store_by_hfid[key]
-        except KeyError as exc:
-            if raise_when_missing:
-                raise NodeNotFoundError(
-                    node_type="n/a",
-                    identifier={"key": [key]},
-                    message=f"Unable to find the node {key!r} in the store",
-                ) from exc
-        return None
+        if node_kind not in self._hfids:
+            raise exception_to_raise_if_not_found
+
+        if tuple(node_hfid) not in self._hfids[node_kind]:
+            raise exception_to_raise_if_not_found
+
+        internal_id = self._hfids[node_kind][tuple(node_hfid)]
+        return self._objs[internal_id]
+
+
+class NodeStoreBase:
+    """Internal Store for InfrahubNode objects.
+
+    Often while creating a lot of new objects,
+    we need to save them in order to reuse them later to associate them with another node for example.
+    """
+
+    def __init__(self, default_branch: str | None = None) -> None:
+        self._branches: dict[str, NodeStoreBranch] = {}
+
+        if default_branch is None:
+            default_branch = "main"
+            warnings.warn(
+                "Using a store without specifying a default branch is deprecated and will be removed in a future version. "
+                "Please explicitly specify a branch name.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+
+        self._default_branch = default_branch
+
+    def _get_branch(self, branch: str | None = None) -> str:
+        return branch or self._default_branch
+
+    def _set(
+        self,
+        node: InfrahubNode | InfrahubNodeSync | SchemaType | SchemaTypeSync,
+        key: str | None = None,
+        branch: str | None = None,
+    ) -> None:
+        branch = self._get_branch(branch or node.get_branch())
+
+        if branch not in self._branches:
+            self._branches[branch] = NodeStoreBranch(name=branch)
+
+        self._branches[branch].set(node=node, key=key)
+
+    def _get(  # type: ignore[no-untyped-def]
+        self,
+        key: str | list[str],
+        kind: type[SchemaType | SchemaTypeSync] | str | None = None,
+        raise_when_missing: bool = True,
+        branch: str | None = None,
+    ):
+        branch = self._get_branch(branch)
+
+        if branch not in self._branches:
+            self._branches[branch] = NodeStoreBranch(name=branch)
+
+        return self._branches[branch].get(key=key, kind=kind, raise_when_missing=raise_when_missing)
+
+    def count(self, branch: str | None = None) -> int:
+        branch = self._get_branch(branch)
+
+        if branch not in self._branches:
+            return 0
+
+        return self._branches[branch].count()
 
 
 class NodeStore(NodeStoreBase):
     @overload
-    def get(self, key: str, kind: type[SchemaType], raise_when_missing: Literal[True] = True) -> SchemaType: ...
+    def get(
+        self,
+        key: str | list[str],
+        kind: type[SchemaType],
+        raise_when_missing: Literal[True] = True,
+        branch: str | None = ...,
+    ) -> SchemaType: ...
 
     @overload
     def get(
-        self, key: str, kind: type[SchemaType], raise_when_missing: Literal[False] = False
+        self,
+        key: str | list[str],
+        kind: type[SchemaType],
+        raise_when_missing: Literal[False] = False,
+        branch: str | None = ...,
     ) -> SchemaType | None: ...
 
     @overload
-    def get(self, key: str, kind: type[SchemaType], raise_when_missing: bool = ...) -> SchemaType: ...
+    def get(
+        self,
+        key: str | list[str],
+        kind: type[SchemaType],
+        raise_when_missing: bool = ...,
+        branch: str | None = ...,
+    ) -> SchemaType: ...
 
     @overload
     def get(
-        self, key: str, kind: str | None = ..., raise_when_missing: Literal[False] = False
-    ) -> InfrahubNode | None: ...
+        self,
+        key: str | list[str],
+        kind: str | None = ...,
+        raise_when_missing: Literal[True] = True,
+        branch: str | None = ...,
+    ) -> InfrahubNode: ...
 
     @overload
-    def get(self, key: str, kind: str | None = ..., raise_when_missing: Literal[True] = True) -> InfrahubNode: ...
+    def get(
+        self,
+        key: str | list[str],
+        kind: str | None = ...,
+        raise_when_missing: Literal[False] = False,
+        branch: str | None = ...,
+    ) -> InfrahubNode | None: ...
 
     @overload
-    def get(self, key: str, kind: str | None = ..., raise_when_missing: bool = ...) -> InfrahubNode: ...
+    def get(
+        self,
+        key: str | list[str],
+        kind: str | None = ...,
+        raise_when_missing: bool = ...,
+        branch: str | None = ...,
+    ) -> InfrahubNode: ...
 
     def get(
-        self, key: str, kind: str | type[SchemaType] | None = None, raise_when_missing: bool = True
+        self,
+        key: str | list[str],
+        kind: str | type[SchemaType] | None = None,
+        raise_when_missing: bool = True,
+        branch: str | None = None,
     ) -> InfrahubNode | SchemaType | None:
-        return self._get(key=key, kind=kind, raise_when_missing=raise_when_missing)
+        return self._get(key=key, kind=kind, raise_when_missing=raise_when_missing, branch=branch)
 
     @overload
-    def get_by_hfid(self, key: str, raise_when_missing: Literal[True] = True) -> InfrahubNode: ...
+    def get_by_hfid(
+        self, key: str | list[str], raise_when_missing: Literal[True] = True, branch: str | None = ...
+    ) -> InfrahubNode: ...
 
     @overload
-    def get_by_hfid(self, key: str, raise_when_missing: Literal[False] = False) -> InfrahubNode | None: ...
+    def get_by_hfid(
+        self, key: str | list[str], raise_when_missing: Literal[False] = False, branch: str | None = ...
+    ) -> InfrahubNode | None: ...
 
-    def get_by_hfid(self, key: str, raise_when_missing: bool = True) -> InfrahubNode | None:
-        return self._get_by_hfid(key=key, raise_when_missing=raise_when_missing)
+    def get_by_hfid(
+        self, key: str | list[str], raise_when_missing: bool = True, branch: str | None = None
+    ) -> InfrahubNode | None:
+        warnings.warn(
+            "get_by_hfid() is deprecated and will be removed in a future version. Use get() instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return self.get(key=key, raise_when_missing=raise_when_missing, branch=branch)
 
-    def set(self, node: Any, key: str | None = None) -> None:
-        return self._set(node=node, key=key)
+    def set(self, node: InfrahubNode | SchemaType, key: str | None = None, branch: str | None = None) -> None:
+        return self._set(node=node, key=key, branch=branch)
 
 
 class NodeStoreSync(NodeStoreBase):
     @overload
-    def get(self, key: str, kind: str | None = None, raise_when_missing: Literal[True] = True) -> InfrahubNodeSync: ...
+    def get(
+        self,
+        key: str | list[str],
+        kind: type[SchemaTypeSync],
+        raise_when_missing: Literal[True] = True,
+        branch: str | None = ...,
+    ) -> SchemaTypeSync: ...
 
     @overload
     def get(
-        self, key: str, kind: str | None = None, raise_when_missing: Literal[False] = False
+        self,
+        key: str | list[str],
+        kind: type[SchemaTypeSync],
+        raise_when_missing: Literal[False] = False,
+        branch: str | None = ...,
+    ) -> SchemaTypeSync | None: ...
+
+    @overload
+    def get(
+        self,
+        key: str | list[str],
+        kind: type[SchemaTypeSync],
+        raise_when_missing: bool = ...,
+        branch: str | None = ...,
+    ) -> SchemaTypeSync: ...
+
+    @overload
+    def get(
+        self,
+        key: str | list[str],
+        kind: str | None = ...,
+        raise_when_missing: Literal[True] = True,
+        branch: str | None = ...,
+    ) -> InfrahubNodeSync: ...
+
+    @overload
+    def get(
+        self,
+        key: str | list[str],
+        kind: str | None = ...,
+        raise_when_missing: Literal[False] = False,
+        branch: str | None = ...,
     ) -> InfrahubNodeSync | None: ...
 
-    def get(self, key: str, kind: str | None = None, raise_when_missing: bool = True) -> InfrahubNodeSync | None:
-        return self._get(key=key, kind=kind, raise_when_missing=raise_when_missing)
+    @overload
+    def get(
+        self,
+        key: str | list[str],
+        kind: str | None = ...,
+        raise_when_missing: bool = ...,
+        branch: str | None = ...,
+    ) -> InfrahubNodeSync: ...
+
+    def get(
+        self,
+        key: str | list[str],
+        kind: str | type[SchemaTypeSync] | None = None,
+        raise_when_missing: bool = True,
+        branch: str | None = None,
+    ) -> InfrahubNodeSync | SchemaTypeSync | None:
+        return self._get(key=key, kind=kind, raise_when_missing=raise_when_missing, branch=branch)
 
     @overload
-    def get_by_hfid(self, key: str, raise_when_missing: Literal[True] = True) -> InfrahubNodeSync: ...
+    def get_by_hfid(
+        self, key: str | list[str], raise_when_missing: Literal[True] = True, branch: str | None = ...
+    ) -> InfrahubNodeSync: ...
 
     @overload
-    def get_by_hfid(self, key: str, raise_when_missing: Literal[False] = False) -> InfrahubNodeSync | None: ...
+    def get_by_hfid(
+        self, key: str | list[str], raise_when_missing: Literal[False] = False, branch: str | None = ...
+    ) -> InfrahubNodeSync | None: ...
 
-    def get_by_hfid(self, key: str, raise_when_missing: bool = True) -> InfrahubNodeSync | None:
-        return self._get_by_hfid(key=key, raise_when_missing=raise_when_missing)
+    def get_by_hfid(
+        self, key: str | list[str], raise_when_missing: bool = True, branch: str | None = None
+    ) -> InfrahubNodeSync | None:
+        warnings.warn(
+            "get_by_hfid() is deprecated and will be removed in a future version. Use get() instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return self.get(key=key, raise_when_missing=raise_when_missing, branch=branch)
 
-    def set(self, node: InfrahubNodeSync, key: str | None = None) -> None:
-        return self._set(node=node, key=key)
+    def set(self, node: InfrahubNodeSync | SchemaTypeSync, key: str | None = None, branch: str | None = None) -> None:
+        return self._set(node=node, key=key, branch=branch)