Persisted documents by default?

Abierto
  • ¿Algo no está bien?
#392 0 comentarios 4 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Nueva funcionalidad
Claridad
Necesita aclaración
Estado de actividad
Tranquilo
Stack tecnológico
graphql
Área
api

Línea de trabajo

Empieza leyendo las propuestas de #370 y #379 junto con esta issue; después, revisa los documentos persistidos, las URLs de los documentos persistidos y el trabajo de Golden Path mencionados aquí. La issue no nombra archivos ni tests; solo estará terminada cuando el proyecto haya tomado una decisión sobre el comportamiento predeterminado de los documentos de confianza y sobre los cambios de tooling y protocolo necesarios para admitirlo.

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

Descripción

Persisted documents are a great bandwidth optimization, but when used as a "document allow list" (aka "trusted documents" - just those approved by your engineering team) they're also a significant security protection, avoiding the need to protect your endpoint against arbitrary potentially malicious documents.

Not all APIs can support "trusted documents" - the GitHub and Shopify public APIs for example are expected to run queries from untrusted third parties - but most GraphQL APIs are only intended to be used with an organization's own applications (web/mobile/desktop/CLI/service-to-service/etc).

If we launched GraphQL today, given what we know now, I think we would want to make trusted documents the default experience[^1] so that users were protected by default. Those who wished to accept arbitrary documents could opt into that more dangerous behavior - whether that be for public APIs or just for LLM-written queries - and know that they need to add additional protections.

Since #370 and #379 are proposing dropping backward-compatibility anyway, I thought it would be worth discussing if we should go the whole hog and really encourage the patterns of GraphQL usage we'd like to see by default going forward.

Note: GitHub is currently having an outage w.r.t. seeing pull requests, so I can't pull up the persisted documents, persisted documents URLs, and related PRs currently.

[^1]: This would also involve improving the tooling and protocols around it, streamlining it to ease usage - something I intend to work on as part of the Golden Path.

Lenguaje dominante
JavaScript
Estrellas
428
Forks
70
Merge medio
11 min
PR fusionados (30 d)
4

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de graphql/graphql-over-http

Todos los issues de graphql/graphql-over-http

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.