ynput / ynput/ayon-python-api

Custom GraphQlQuery using set_limit on nested edge field can result in the limit turning negative when querying

Aperta
#350 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Python
Stelle
16
Fork
15
Merge medio
1g 9h
PR unite (30g)
10

Descrizione

Is there an existing issue for this?
  • I have searched the existing issues and added correct labels.

Description

Current Behavior

When creating a custom GraphQlQuery object, if you use set_limit on a nested edge field (e.g products in folders), the edge field limit can turn negative unexpectedly if you query some amount of entities from the parent edge field and will raise this error.

File "C:\Users\user\AppData\Local\Ynput\AYON\app\AYON 1.6.3\dependencies\ayon_api\graphql.py", line 376, in query
    raise GraphQlQueryFailed(response.errors, query_str, variables)
ayon_api.exceptions.GraphQlQueryFailed: GraphQl query Failed: LIMIT must not be negative on item 'project/folders/edges/0/node/products' (Line 7 Column 11)
Expected Behavior

The limit should be calculated correctly when querying the server and match the one given.

Steps To Reproduce:

Here is a script you can use in the AYON Launcher's Console or with ayon_api with the right env vars set up. This assumes you have a project already containing a certain amount folders and products, this example uses folder and products but you can apply it to any parent/child edge field case.

Exact conditions in which the error occur seem to depend on the contents of the project, however running the script as is should trigger it, as it queries all folders from the project and sets a limit to queried products. Setting a high limit for the parent field and a lower one for the child field should also trigger it. You can mess with the folder_limit and product_limit arguments to see different results.

from ayon_api.graphql import GraphQlQuery
from ayon_api import get_server_api_connection, get_folders
from pprint import pprint

project_name = "projectname"

def simple_graphql_query(
        project_name,
        folder_limit=None,
        product_limit=None,
):
    """Creates a simple GraphQL query to get products from
    a list of folder ids.
    """
    simple_query = GraphQlQuery("SimpleQuery")

    # Project field
    project_field = simple_query.add_field("project")
    project_field.set_filter("name", project_name)

    # Folders field
    folders_field = project_field.add_field_with_edges("folders")
    if folder_limit:
        folders_field.set_limit(folder_limit)
    folders_field.add_field("name")

    # Products field
    products_field = folders_field.add_field_with_edges("products")
    if product_limit:
        products_field.set_limit(product_limit)
    products_field.add_field("name")

    return simple_query

my_query = simple_graphql_query(
    project_name=project_name,
    folder_limit=None, # parent edge field
    product_limit=5 # nested child edge field
)

con = get_server_api_connection()

my_query_data = my_query.query(con)

pprint(my_query_data)

The conditions in which the problem manifest depend also on the ayon_api version coming with the launcher :

  • 1.2.4 (1.4.2 launcher) : If the number of parent edge field entities queried is strictly superior to 300 then ayon_api.exceptions.GraphQlQueryFailed will be raised.
  • 1.2.22 (1.6.3 launcher) and 1.2.23 : condition seem to vary much more but a parent edge field amount higher than that of the nested child edge seem to trigger it.
Additional context:
Version

Server : 1.15.17
Launcher : 1.4.2 and 1.6.3
ayon-python-api : 1.2.4, 1.2.22 and 1.2.23

Platforms

Windows, Mac

Relevant log output:

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia in ayon_api/graphql.py, in particolare nel percorso di creazione della query attorno alla chiamata di query che fallisce alla riga 376. Esegui la riproduzione fornita con cartelle/prodotti annidati usando valori diversi per folder_limit e product_limit, quindi verifica che i limiti generati non diventino mai negativi e che il server riceva il limite richiesto per gli elementi figli senza GraphQlQueryFailed.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
graphql, python
Ambito
api
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Attiva
Chiarezza
Abbastanza chiara
Idoneità per principianti
68/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.