graphql queries can pass in if supports links data

Author: iLLiCiTiT

ayon_api/graphql_queries.py

@@ -1,15 +1,30 @@
+from __future__ import annotations
+
 import collections
+import typing
 
 from .constants import DEFAULT_LINK_FIELDS
 from .graphql import FIELD_VALUE, GraphQlQuery, fields_to_dict
 
+if typing.TYPE_CHECKING:
+    from .graphql import (
+        GraphQlQueryEdgeField,
+    )
+
 
-def add_links_fields(entity_field, nested_fields):
+def add_links_fields(
+    entity_field: GraphQlQueryEdgeField,
+    nested_fields: dict | None,
+    supports_data: bool = False,
+) -> None:
     if "links" not in nested_fields:
         return
     links_fields = nested_fields.pop("links")
 
     link_edge_fields = set(DEFAULT_LINK_FIELDS)
+    if supports_data:
+        link_edge_fields.add("data")
+
     if isinstance(links_fields, dict):
         simple_fields = set(links_fields)
         simple_variant = len(simple_fields - link_edge_fields) == 0
@@ -121,7 +136,11 @@ def product_types_query(fields):
     return query
 
 
-def folders_graphql_query(fields):
+def folders_graphql_query(
+    fields: set[str],
+    *,
+    links_support_data: bool = False,
+) -> GraphQlQuery:
     query = GraphQlQuery("FoldersQuery")
     project_name_var = query.add_variable("projectName", "String!")
     folder_ids_var = query.add_variable("folderIds", "[String!]")
@@ -161,7 +180,11 @@ def folders_graphql_query(fields):
     folders_field.set_filter("filter", filter_var)
 
     nested_fields = fields_to_dict(fields)
-    add_links_fields(folders_field, nested_fields)
+    add_links_fields(
+        folders_field,
+        nested_fields,
+        supports_data=links_support_data,
+    )
 
     query_queue = collections.deque()
     for key, value in nested_fields.items():
@@ -179,7 +202,11 @@ def folders_graphql_query(fields):
     return query
 
 
-def tasks_graphql_query(fields):
+def tasks_graphql_query(
+    fields: set[str],
+    *,
+    links_support_data: bool = False,
+) -> GraphQlQuery:
     query = GraphQlQuery("TasksQuery")
     project_name_var = query.add_variable("projectName", "String!")
     task_ids_var = query.add_variable("taskIds", "[String!]")
@@ -209,7 +236,11 @@ def tasks_graphql_query(fields):
     tasks_field.set_filter("filter", filter_var)
 
     nested_fields = fields_to_dict(fields)
-    add_links_fields(tasks_field, nested_fields)
+    add_links_fields(
+        tasks_field,
+        nested_fields,
+        supports_data=links_support_data,
+    )
 
     query_queue = collections.deque()
     for key, value in nested_fields.items():
@@ -227,7 +258,11 @@ def tasks_graphql_query(fields):
     return query
 
 
-def tasks_by_folder_paths_graphql_query(fields):
+def tasks_by_folder_paths_graphql_query(
+    fields: set[str],
+    *,
+    links_support_data: bool = False,
+) -> GraphQlQuery:
     query = GraphQlQuery("TasksByFolderPathQuery")
     project_name_var = query.add_variable("projectName", "String!")
     task_names_var = query.add_variable("taskNames", "[String!]")
@@ -258,7 +293,11 @@ def tasks_by_folder_paths_graphql_query(fields):
     tasks_field.set_filter("filter", filter_var)
 
     nested_fields = fields_to_dict(fields)
-    add_links_fields(tasks_field, nested_fields)
+    add_links_fields(
+        tasks_field,
+        nested_fields,
+        supports_data=links_support_data,
+    )
 
     query_queue = collections.deque()
     for key, value in nested_fields.items():
@@ -276,7 +315,11 @@ def tasks_by_folder_paths_graphql_query(fields):
     return query
 
 
-def products_graphql_query(fields):
+def products_graphql_query(
+    fields: set[str],
+    *,
+    links_support_data: bool = False,
+) -> GraphQlQuery:
     query = GraphQlQuery("ProductsQuery")
 
     project_name_var = query.add_variable("projectName", "String!")
@@ -308,7 +351,11 @@ def products_graphql_query(fields):
     products_field.set_filter("filter", filter_var)
 
     nested_fields = fields_to_dict(set(fields))
-    add_links_fields(products_field, nested_fields)
+    add_links_fields(
+        products_field,
+        nested_fields,
+        supports_data=links_support_data,
+    )
 
     query_queue = collections.deque()
     for key, value in nested_fields.items():
@@ -326,7 +373,11 @@ def products_graphql_query(fields):
     return query
 
 
-def versions_graphql_query(fields):
+def versions_graphql_query(
+    fields: set[str],
+    *,
+    links_support_data: bool = False,
+) -> GraphQlQuery:
     query = GraphQlQuery("VersionsQuery")
 
     project_name_var = query.add_variable("projectName", "String!")
@@ -359,7 +410,11 @@ def versions_graphql_query(fields):
     versions_field.set_filter("filter", filter_var)
 
     nested_fields = fields_to_dict(set(fields))
-    add_links_fields(versions_field, nested_fields)
+    add_links_fields(
+        versions_field,
+        nested_fields,
+        supports_data=links_support_data,
+    )
 
     query_queue = collections.deque()
     for key, value in nested_fields.items():
@@ -377,7 +432,11 @@ def versions_graphql_query(fields):
     return query
 
 
-def representations_graphql_query(fields):
+def representations_graphql_query(
+    fields: set[str],
+    *,
+    links_support_data: bool = False,
+) -> GraphQlQuery:
     query = GraphQlQuery("RepresentationsQuery")
 
     project_name_var = query.add_variable("projectName", "String!")
@@ -408,7 +467,11 @@ def representations_graphql_query(fields):
     repres_field.set_filter("filter", filter_var)
 
     nested_fields = fields_to_dict(set(fields))
-    add_links_fields(repres_field, nested_fields)
+    add_links_fields(
+        repres_field,
+        nested_fields,
+        supports_data=links_support_data,
+    )
 
     query_queue = collections.deque()
     for key, value in nested_fields.items():
@@ -525,7 +588,11 @@ def representations_hierarchy_qraphql_query(
     return query
 
 
-def workfiles_info_graphql_query(fields):
+def workfiles_info_graphql_query(
+    fields: set[str],
+    *,
+    links_support_data: bool = False,
+) -> GraphQlQuery:
     query = GraphQlQuery("WorkfilesInfo")
     project_name_var = query.add_variable("projectName", "String!")
     workfiles_info_ids = query.add_variable("workfileIds", "[String!]")
@@ -549,7 +616,11 @@ def workfiles_info_graphql_query(fields):
     workfiles_field.set_filter("tags", tags_var)
 
     nested_fields = fields_to_dict(set(fields))
-    add_links_fields(workfiles_field, nested_fields)
+    add_links_fields(
+        workfiles_field,
+        nested_fields,
+        supports_data=links_support_data,
+    )
 
     query_queue = collections.deque()
     for key, value in nested_fields.items():