Add Ipfs-DagSize and/or Ipfs-DataSize to gateway responses

Abierto
#461 0 comentarios 1 reacción 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
Estancado
Área
api, networking

Línea de trabajo

Empieza por convertir los requisitos establecidos para Ipfs-DagSize e Ipfs-DataSize en una especificación y, después, compara los enfoques propuestos de cabeceras HTTP y tipos de contenido personalizados. Resuelve el alcance en torno a UnixFS, single-block dag-cbor, las respuestas HEAD y la semántica de los tamaños. El trabajo se considera terminado cuando haya un acuerdo sobre una API y un plan de implementación para clientes de gateway.

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

Descripción

This is a placeholder issue for writing spec and tracking implementation.

The need is to expose equivalent of ipfs files stat's Size and CumulativeSize on HTTP gateway somehow, allowing light clients to understand how big is the DAG before fetching it as a CAR etc.

  • Ipfs-DagSize total size of the DAG (user data + DAG metadata, IPLD envelopes etc)
  • Ipfs-DataSize total size of the raw data (without DAG metadata, IPLD envelopes etc)

We don't want expensive equivalent of ipfs dag stat for Unixfs, we want to leverage hints from UnixFS. It could be limited to formats like UnixFS, or single-block dag-cbor etc, which include total sizes in the root blocks, removing the need for expensive ipfs dag stat of entire DAG.

Implementation options
  • 🟢 HTTP Headers
    • Ipfs-DagSize and Ipfs-DataSize headers with value in bytes
    • pro: simple and easy to implement, JS apps already use Content-Type for this (because without compression it matches payload size), we should not break them without giving a replacement header
    • 💡 caveat: unnecessary work on every request, unless we limit them to HEAD responses
  • ⛔ Custom content type that returns useful metadata
    • would be opt-in Accept HTTP header or format URL arg)
    • pro: could be leveraged for things other than size info
    • con: complexity, need to decide on JSON schema, harder for gateways and clients to adopt

cc @vasco-santos I know you needed something like this a while ago

Lenguaje dominante
HTML
Estrellas
1.2k
Forks
250
Métricas de merge de PR
Sin PR fusionados en 30 d

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

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 ipfs/specs

Todos los issues de ipfs/specs

Issues similares

Más issues de Backend & API Design

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.