sangria-graphql/sangria

New middleware to limit visibility of schema elements

Aperta

#417 aperta il 12 nov 2018

Vedi su GitHub
 (0 commenti) (1 reazione) (0 assegnatari)Scala (219 fork)batch import
featurehelp wanted

Metriche repository

Star
 (1961 stelle)
Metriche merge PR
 (Merge medio 8g 15h) (4 PR mergiate in 30 g)

Descrizione

The idea is to provide a middleware that allows to hide specific fields and types based on arbitrary logic. There hidden parts of the schema should be unavailable:

  • During the execution
  • During input value coercion (it should be possible to hide input as well as output types)
  • During validation
  • In the introspection results

The validation might be tricky since it is not aware of the middleware right now. On the other had, if for example a field is hidden, GraphQL query that uses the field should produce a violation during the validation phase. So maybe this feature needs to implemented as a new concept in the library and not necessarily as a middleware.

It should be possible to "hide" following elements of the schema:

  • Type (input and output)
  • Field (input and output)
  • Argument
  • Enum value

This idea is inspired by "Limiting Visibility" feature in graphql-ruby:

http://graphql-ruby.org/schema/limiting_visibility.html

Guida contributor

Direzione di ricerca
Studia il meccanismo middleware esistente in Sangria e come si integra con la validazione e l'introspezione. Guarda l'implementazione di graphql ruby per ispirazione. Considera di progettare un nuovo concetto che incapsuli lo schema e ne modifichi il comportamento durante l'esecuzione, la coercizione, la validazione e l'introspezione. Inizia definendo un tratto o una classe in grado di filtrare tipi, campi, argomenti e valori enum in base a una funzione predicato fornita. Quindi integralo nella pipeline di esecuzione delle query e nella risposta di introspezione.
Tech stack
scala
Dominio
apibackend
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitGraphQLScala
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65