0xPlaygrounds / 0xPlaygrounds/subgrounds

Better `FieldPath` argument validation

Abierto
#10 0 comentarios 0 reacciones 0 asignados Ver en GitHub
enhancement
Lenguaje dominante
Python
Estrellas
73
Forks
12
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

**Is your feature request related to a problem? Please describe.** Yes. When constructing `FieldPaths` with arguments, any extra arguments (i.e.: arguments which don't exist in the subgraph schema) are silently ignored, leading to harder debugging in case of errors like typos.

Moreover, although the values of real arguments are type-checked, the exceptions are cryptic and uninformative.

**Describe the solution you'd like** When constructing `FieldPaths` with arguments, for each argument, Subgrounds should check whether:

1. The argument exists in the schema
2. The type of the argument's value matches the type indicated in the schema
3. If using relative `FieldPaths` (e.g.: `subgraph.Query.entities(orderBy=subgraph.Entity.field)`), validate that the field type on which that argument is applied matches the type of the relative `FieldPath` (i.e.: the type of `entities` matches the `Entity` object).

Error messages should also be clear and informative. E.g.: "X is not a valid value for argument orderBy".

**Describe alternatives you've considered** None

**Additional context** None

**Implementation checklist**

* [ ] Validate arguments
* [ ] Check whether the argument exists in the schema
* [ ] Check whether the value given to the argument matches the type specified in the schema
* [ ] Check whether relative `FieldPaths` match the type of the field
* [ ] Improved error messages

*Originally from: cvauclair*

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Look at the FieldPath class and its argument handling. The subgraph schema is used for validation. Start by understanding how arguments are currently passed and ignored. Check the schema for argument definitions and types. Write validation logic that raises clear error messages for missing arguments or type mismatches. Test with a subgraph query to ensure errors are informative.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
graphql, python
Área
backend-api-design, devtools
Tipo de issue
Nueva funcionalidad
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bien especificado
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.