Limitaciones de los recursos

La API de GraphQL de GitHub cuenta con limitaciones para la protección contra las llamadas excesivas o abusivas a los servidores de GitHub.

En este artículo

Límite de nodo
Limite de tasa

Límite de nodo

Para pasar la validación del modelo, todas las llamadas la API v4 de GraphQL deben cumplir con los siguientes estándares:

Los clientes deben suministrar un argumento first o last en cualquier conexión.
Los valores de first y last deben estar dentro de 1-100.
Las llamadas individuales no pueden solicitar más de 500,000 nodos en total.

Calcular los nodos en una llamada

Estos dos ejemplos te muestran cómo calcular los nodos totales en una llamada.

Consulta simple:

query {
viewer {
repositories(first: 50) {
edges {
repository:node {
name
      issues(first: <span class="greenbox">10</span>) {
        totalCount
        edges {
          node {
            title
            bodyHTML
          }
        }
      }
    }
  }
}

  }
}

Cálculo:

50         = 50 repositories


50 x 10  = 500 repository issues
        = 550 total nodes</pre>

Consulta compleja:

query {
viewer {
repositories(first: 50) {
edges {
repository:node {
name
      pullRequests(first: <span class="greenbox">20</span>) {
        edges {
          pullRequest:node {
            title

            comments(first: <span class="bluebox">10</span>) {
              edges {
                comment:node {
                  bodyHTML
                }
              }
            }
          }
        }
      }

      issues(first: <span class="greenbox">20</span>) {
        totalCount
        edges {
          issue:node {
            title
            bodyHTML

            comments(first: <span class="bluebox">10</span>) {
              edges {
                comment:node {
                  bodyHTML
                }
              }
            }
          }
        }
      }
    }
  }
}

followers(first: <span class="bluebox">10</span>) {
  edges {
    follower:node {
      login
    }
  }
}

  }
}

Cálculo:

50              = 50 repositories


50 x 20       = 1,000 pullRequests


50 x 20 x 10 = 10,000 pullRequest comments


50 x 20       = 1,000 issues


50 x 20 x 10 = 10,000 issue comments


10              = 10 followers
             = 22,060 total nodes</pre>

Limite de tasa

El límite de la API v4 de GraphQL es diferente a los límites de tasa de la API v3 de REST.

¿Por qué son diferentes los límites de tasa de la API? Con GraphQL, una llamada de GraphQL puede reemplazar varias llamadas de REST. Una sola llamada compleja de GraphQL puede ser el equivalente a miles de solicitudes de REST. Si bien una sola llamada de GraphQL caería muy debajo del límite de tasa de la API de REST, la consulta podría ser igual de cara en términos de procesamiento para los servidores de GitHub.

Para representar con precisión el costo de una consulta al servidor, la API v4 de GraphQL calcula la puntuación de tasa límite de una llamada con base en una escala de puntos normalizada. Los factores de puntuación de una consulta en argumentos "firs" y "last" en una conexión padre y sus hijos.

La fórmula utiliza los argumentos first y last en una conexión padre y en sus hijos para pre-calcular la carga potencial en los sistemas de GitHub, tal como MySQL, ElasticSearch y Git.
Cada conexión nueva tiene su propio valor de puntos. Los puntos se combinan con otros puntos desde la llamada en una puntuación de tasa límite general.

El límite de tasa de la API v4 de GraphQL es de 5,000 puntos por hora.

Nota que 5,000 puntos por hora no es lo mismo que 5,000 llamadas por hora: la API v4 de GraphQL y la API v3 de REST utilizan límites de tasa diferentes.

Nota: La fórmula y el límite de tasa actuales están sujetos a cambio mientras observamos cómo los desarrolladores utilizan la API v4 de GraphQL.

Recuperar el estado de límite de tasa de una llamada

Con la API v3 de REST, puedes revisar el estado de límite de tasa si inspeccionas los encabezados HTTP devueltos.

Con la API v4 de GraphQL, puedes revisar el estado de límite de tasa si consultas los campos en el objeto rateLimit:

query {
  viewer {
    login
  }
  rateLimit {
    limit
    cost
    remaining
    resetAt
  }
}

El campo limit devuelve el número máximo de puntos que se permite consumir al cliente en una ventana de 60 minutos.
El campo cost devuelve el costo en puntos para la llamada actual que cuenta contra el límite de tasa.
El campo remaining devuelve la cantidad de puntos restantes en la ventana de límite de tasa actual.)
EL campo resetAt devuelve la hora en la que se reinicia la ventana de límite de tasa actual en segundos de satélite UTC.

Calcular el puntaje de límite de tasa antes de ejecutar la llamada

Al consultar el objeto rateLimit se devuelve el puntaje de una llamada, pero ejecutar la llamada tiene un costo en el límite. Para evitar este dilema, puedes calcular el puntaje de una llamada antes de ejecutarla. Los siguientes cálculos funcionan casi de la misma manera que lo que devuelve rateLimit { cost }.

Agrega la cantidad de solicitudes requeridas para completar cada conexión única en la llamada. Asume que cada solicitud alcanzará los límites de los argumentos first o last.
Divide la cantidad entre 100 y redondea el resultado para obtener el costo final agregado. Este paso normaliza las cantidades grandes.

Nota: El costo mínimo de una llamada a la API v4 de GraphQL es 1, lo cual representa solo una solicitud.

Aquí se muestra una consulta y cálculo de puntaje de ejemplo:

query {
  viewer {
    login
    repositories(first: 100) {
      edges {
        node {
          id

          issues(first: 50) {
            edges {
              node {
                id

                labels(first: 60) {
                  edges {
                    node {
                      id
                      name
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Esta consulta requiere de 5,101 solicitudes para completarse:

Aunque se devolvieron 100 repositorios, la API se tiene que conectar a la cuenta del visualizador una vez para obtener la lista de repositorios. Así que, las solicitudes de repositorios = 1
Aunque estámos obteniendo 50 informes de problemas de vuelta, la API tiene que conectarse a cada uno de los 100 repositorios para obtener la lista de informes de problemas. Así que, las solicitudes de informes de problemas = 100
Aunque estamos obteniendo 60 etiquetas de vuelta, la API se tiene que conectar a cada uno de los 5,000 informes de problemas potenciales totales para obtener la lista de etiquetas. Así que, las solicitudes de etiquetas = 5,000
Total = 5,101

Si lo dividimos entre 100 y lo redondeamos, obtenemos el puntaje final de la consulta: 51