Saltar al contenido

Errores GraphQL

Lee data y errors, distingue los códigos de error y maneja GraphQLResponseError.

Cada respuesta es un JSON con data y, si algún campo falló, errors. Una respuesta con HTTP 200 puede traer errors: revísalo antes de leer data.

Forma de la respuesta

Una ejecución sin errores trae solo data:

Respuesta correcta
{
  "data": {
    "store": {
      "id": "7204558912004325301",
      "name": "Mi tienda"
    }
  }
}

Cuando un campo falla, errors explica por qué y ese campo llega como null. Si el campo es no nulo, null sube hasta data:

Respuesta con error
{
  "errors": [
    {
      "message": "Product ID is invalid.",
      "path": ["relatedProducts"],
      "extensions": {
        "code": "BAD_USER_INPUT"
      }
    }
  ],
  "data": null
}
CampoContenido
dataLos campos que se resolvieron.
errors[].messageTexto en inglés para diagnóstico. Puede cambiar.
errors[].pathCampo que falló.
errors[].extensions.codeCódigo estable para decidir qué hacer.

Decide con extensions.code. Los errores de sintaxis o de validación del documento usan los códigos estándar de GraphQL.

Códigos

CódigoCausaQué hacer
BAD_USER_INPUTUn argumento, filtro, límite o ID no es válido.Corrige la entrada antes de reintentar.
NOT_FOUNDEl producto, colección o vendedor no existe en la tienda o no está publicado.Revisa el slug o ID y la tienda de x-Store-Domain.
STORE_CONTEXT_REQUIREDx-Store-Domain falta o no corresponde a una tienda.Envía el slug o un dominio configurado de la tienda.

Con fetch

Revisa el estado HTTP y luego errors:

graphql-fetch.js
const response = await fetch("https://storefront.ecomiq.pe/graphql", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "x-Store-Domain": "mi-tienda",
  },
  body: JSON.stringify({
    query: "query Store { store { id name } }",
  }),
});

if (!response.ok) {
  throw new Error(`HTTP ${response.status}`);
}

const result = await response.json();

if (result.errors?.length) {
  const [error] = result.errors;

  switch (error.extensions?.code) {
    case "BAD_USER_INPUT":
      console.error("Corrige los argumentos de la consulta.");
      break;
    case "NOT_FOUND":
      console.error("El recurso no existe en esta tienda.");
      break;
    case "STORE_CONTEXT_REQUIRED":
      console.error("Revisa x-Store-Domain.");
      break;
    default:
      console.error(error.message);
  }

  throw new Error(error.message);
}

console.log(result.data.store);

Con @ecomiq/core

graphql() valida data con el schema de Zod que le pasas. Lanza GraphQLResponseError si la respuesta trae errors, si no trae data o si data no cumple el schema; en este último caso el código es INVALID_RESPONSE.

graphql-client.ts
import { createClient, GraphQLResponseError } from "@ecomiq/core";
import { z } from "zod";

const SellerData = z.object({
  seller: z.object({
    id: z.string(),
    name: z.string(),
    slug: z.string(),
  }),
});

const api = createClient({ domain: "mi-tienda" });

try {
  const data = await api.graphql(
    `
      query Seller($slug: String!) {
        seller(slug: $slug) { id name slug }
      }
    `,
    SellerData,
    { slug: "acme" },
  );

  console.log(data.seller);
} catch (error) {
  if (!(error instanceof GraphQLResponseError)) {
    throw error;
  }

  for (const graphQLError of error.errors) {
    console.error(graphQLError.extensions?.code, graphQLError.message);
  }
}

error.errors trae la lista de errores y error.data, el data parcial que haya llegado.

Siguientes pasos

Última actualización:

En esta página