Merge branch 'develop'

Author: iLLiCiTiT

ayon_api/entity_hub.py

@@ -589,12 +589,15 @@ def query_entities_from_server(self):
             parent_id = task["folderId"]
             tasks_by_parent_id[parent_id].append(task)
 
+        lock_queue = collections.deque()
         hierarchy_queue = collections.deque()
         hierarchy_queue.append((None, project_entity))
         while hierarchy_queue:
             item = hierarchy_queue.popleft()
             parent_id, parent_entity = item
 
+            lock_queue.append(parent_entity)
+
             children_ids = set()
             for folder in folders_by_parent_id[parent_id]:
                 folder_entity = self.add_folder(folder)
@@ -604,10 +607,16 @@ def query_entities_from_server(self):
 
             for task in tasks_by_parent_id[parent_id]:
                 task_entity = self.add_task(task)
+                lock_queue.append(task_entity)
                 children_ids.add(task_entity.id)
 
             parent_entity.fill_children_ids(children_ids)
-        self.lock()
+
+        # Lock entities when all are added to hub
+        # - lock only entities added in this method
+        while lock_queue:
+            entity = lock_queue.popleft()
+            entity.lock()
 
     def lock(self):
         if self._project_entity is None:
@@ -1198,6 +1207,7 @@ def lock(self):
         self._attribs.lock()
 
         self._immutable_for_hierarchy_cache = None
+        self._created = False
 
     def _get_entity_by_id(self, entity_id):
         return self._entity_hub.get_entity_by_id(entity_id)

ayon_api/graphql_queries.py

@@ -314,7 +314,6 @@ def representations_graphql_query(fields):
 def representations_parents_qraphql_query(
     version_fields, subset_fields, folder_fields
 ):
-
     query = GraphQlQuery("RepresentationsParentsQuery")
 
     project_name_var = query.add_variable("projectName", "String!")
@@ -388,7 +387,7 @@ def workfiles_info_graphql_query(fields):
 
 
 def events_graphql_query(fields):
-    query = GraphQlQuery("WorkfilesInfo")
+    query = GraphQlQuery("Events")
     topics_var = query.add_variable("eventTopics", "[String!]")
     projects_var = query.add_variable("projectNames", "[String!]")
     states_var = query.add_variable("eventStates", "[String!]")

ayon_api/server_api.py

@@ -14,6 +14,7 @@
     HTTPStatus = None
 
 import requests
+from requests.exceptions import JSONDecodeError as RequestsJSONDecodeError
 
 from .constants import (
     DEFAULT_PROJECT_FIELDS,
@@ -112,9 +113,9 @@ def headers(self):
     @property
     def data(self):
         if self._data is None:
-            if self.status != 204:
+            try:
                 self._data = self.orig_response.json()
-            else:
+            except RequestsJSONDecodeError:
                 self._data = {}
         return self._data
 
@@ -128,7 +129,10 @@ def content_type(self):
 
     @property
     def detail(self):
-        return self.get("detail", _get_description(self))
+        detail = self.get("detail")
+        if detail:
+            return detail
+        return _get_description(self)
 
     @property
     def status_code(self):
@@ -299,14 +303,6 @@ class ServerAPI(object):
             'production').
     """
 
-    _entity_types_link_mapping = {
-        "folder": ("folderIds", "folders"),
-        "task": ("taskIds", "tasks"),
-        "subset": ("subsetIds", "subsets"),
-        "version": ("versionIds", "versions"),
-        "representation": ("representationIds", "representations"),
-    }
-
     def __init__(
         self,
         base_url,
@@ -916,7 +912,7 @@ def get_events(
             project_names = set(project_names)
             if not project_names:
                 return
-            filters["projectName"] = list(project_names)
+            filters["projectNames"] = list(project_names)
 
         if states is not None:
             states = set(states)
@@ -4514,13 +4510,34 @@ def get_entities_links(
             dict[str, list[dict[str, Any]]]: Link info by entity ids.
         """
 
-        mapped_type = self._entity_types_link_mapping.get(entity_type)
-        if not mapped_type:
+        if entity_type == "folder":
+            query_func = folders_graphql_query
+            id_filter_key = "folderIds"
+            project_sub_key = "folders"
+        elif entity_type == "task":
+            query_func = tasks_graphql_query
+            id_filter_key = "taskIds"
+            project_sub_key = "tasks"
+        elif entity_type == "subset":
+            query_func = subsets_graphql_query
+            id_filter_key = "subsetIds"
+            project_sub_key = "subsets"
+        elif entity_type == "version":
+            query_func = versions_graphql_query
+            id_filter_key = "versionIds"
+            project_sub_key = "versions"
+        elif entity_type == "representation":
+            query_func = representations_graphql_query
+            id_filter_key = "representationIds"
+            project_sub_key = "representations"
+        else:
             raise ValueError("Unknown type \"{}\". Expected {}".format(
-                entity_type, ", ".join(self._entity_types_link_mapping.keys())
+                entity_type,
+                ", ".join(
+                    ("folder", "task", "subset", "version", "representation")
+                )
             ))
 
-        id_filter_key, project_sub_key = mapped_type
         output = collections.defaultdict(list)
         filters = {
             "projectName": project_name
@@ -4534,7 +4551,7 @@ def get_entities_links(
         if not self._prepare_link_filters(filters, link_types, link_direction):
             return output
 
-        query = folders_graphql_query({"id", "links"})
+        query = query_func({"id", "links"})
         for attr, filter_value in filters.items():
             query.set_variable_value(attr, filter_value)
 

ayon_api/version.py

@@ -1,2 +1,2 @@
 """Package declaring Python API for Ayon server."""
-__version__ = "0.1.17"
+__version__ = "0.1.18"

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ayon_api"
-version = "0.1.17"
+version = "0.1.18"
 description = "Python api for AYON server"
 authors = ["ynput.io <info@ynput.io>"]
 

tests/test_graphql_queries.py

@@ -0,0 +1,110 @@
+import pytest
+from ayon_api.graphql import GraphQlQuery
+from ayon_api.graphql_queries import (
+    project_graphql_query,
+    folders_graphql_query,
+)
+
+
+@pytest.fixture
+def empty_query():
+    return GraphQlQuery("ProjectQuery")
+
+
+@pytest.fixture
+def project_query():
+    return project_graphql_query(["name"])
+
+
+@pytest.fixture
+def folder_query():
+    return folders_graphql_query(["name"])
+
+
+def test_simple_duplicate_add_variable_exception(empty_query):
+    key, value_type = "someVariable", "String"
+    empty_query.add_variable(key, value_type)
+    with pytest.raises(KeyError):
+        empty_query.add_variable(key, value_type)
+
+
+def test_exception_empty_query(empty_query):
+    with pytest.raises(ValueError, match="Missing fields to query"):
+        out = empty_query.calculate_query()
+
+
+def test_simple_output(project_query):
+    result = project_query.calculate_query()
+    expected = "query ProjectQuery {\n  project {\n    name\n  }\n}"
+    assert result == expected
+
+
+def make_project_query(keys, values, types):
+    query = project_graphql_query(["name"])
+
+    # Function 'project_graphql_query' always adds 'projectName' variable
+    inserted = {"projectName"}
+    for key, value_type, value in zip(keys, types, values):
+        if key not in inserted:
+            inserted.add(key)
+            query.add_variable(key, value_type)
+        query.set_variable_value(key, value)
+
+    return query
+
+
+def make_expected_get_variables_values(keys, values):
+    return dict(zip(keys, values))
+
+
+@pytest.mark.parametrize(
+    "keys, values, types",
+    [
+        (["projectName", "projectId", "numOf"], 
+         ["kuba_v4_sync", "0x23", 3], 
+         ["[String!]", "[String!]", "Int"]),
+        (["projectName", "testStrInt"],
+         ["my_name", 42],
+         ["[String!]", "[String!]"]),
+        (["projectName", "testIntStr"],
+         ["my_name", "test_123"],
+         ["[String!]", "Int"]),
+    ])
+def test_get_variables_values(keys, values, types):
+    query = make_project_query(keys, values, types)
+    # None means: unexpected exception thrown while adding variables
+    assert query is not None
+
+    expected = make_expected_get_variables_values(keys, values)
+    assert query.get_variables_values() == expected
+
+
+"""
+def test_filtering(empty_query):
+    assert empty_query._children == []
+    project_name_var = empty_query.add_variable("projectName", "String!")
+    project_field = empty_query.add_field("project")
+    project_field.set_filter("name", project_name_var)
+
+    for field in empty_query._children:
+        print(field.get_filters())
+
+    print(empty_query.calculate_query())
+
+
+def print_rec_filters(field):
+    print(field.get_filters())
+    for k in field._children:
+        print_rec_filters(k)
+
+
+def test_folders_graphql_query(folder_query):
+    print(folder_query.calculate_query())
+    
+
+def test_filters(folder_query):
+    print(folder_query._children[0]._children[0].get_filters())
+    folder_query._children[0]._children[0].remove_filter("ids")
+    print(folder_query._children[0]._children[0].get_filters())
+    print(folder_query.calculate_query())
+"""