Este plugin te permite capturar solicitudes GraphQL e inspeccionarlas más tarde mientras reproduces las grabaciones de sesiones. Esto resulta muy útil para entender y solucionar problemas. El plugin de GraphQL es compatible con las implementaciones de Apollo y Relay.

npm i @openreplay/tracker-graphql

Inicializa el paquete @openreplay/tracker como de costumbre y carga el plugin en él. La llamada a plugin devolverá la función, que recibe cuatro variables operationKind, operationName, variables, result y duration (por defecto 0) y devuelve result sin cambios.

import Tracker from '@openreplay/tracker';
import { createGraphqlMiddleware } from '@openreplay/tracker-graphql';

const tracker = new Tracker({
  projectKey: YOUR_PROJECT_KEY,
});

export const recordGraphQL = tracker.use(createGraphqlMiddleware());

Si estás usando las herramientas de red de Relay, puedes simplemente crear un middleware

import { createRelayMiddleware } from '@openreplay/tracker-graphql';

const trackerMiddleware = tracker.use(createRelayMiddleware());
const network = new RelayNetworkLayer([
  // your middleware
  // ,
  trackerMiddleware,
]);

Puedes pasar una función Sanitizer a createRelayMiddleware para sanear las variables y los datos antes de enviarlos a OpenReplay.

const trackerLink = tracker.use(
  createRelayMiddleware((variables) => {
    return {
      ...variables,
      password: '***',
    };
  }),
);

O puedes colocar manualmente la llamada recordGraphQL en la implementación de NetworkLayer. Si usas la forma estándar Network.create para implementarlo, entonces deberías hacer algo como lo siguiente:

import { createGraphqlMiddleware } from '@openreplay/tracker-graphql'; // see above for recordGraphQL definition
import { Environment } from 'relay-runtime';

const handler = tracker.use(createGraphqlMiddleware());

function fetchQuery(operation, variables, cacheConfig, uploadables) {
  return fetch('www.myapi.com/resource', {
    // ...
  })
    .then((response) => response.json())
    .then((result) =>
      handler(
        // op kind, name, variables, response, duration (default 0)
        operation.operationKind,
        operation.name,
        variables,
        result,
        duration,
      ),
    );
}

const network = Network.create(fetchQuery);

Consulta Relay Network Layer para más detalles.

Para Apollo deberías crear un nuevo ApolloLink:

import { createTrackerLink } from '@openreplay/tracker-graphql';

const trackerLink = tracker.use(createTrackerLink());
const yourLink = new ApolloLink(trackerLink);

Puedes pasar una función Sanitizer a createRelayMiddleware para sanear las variables y los datos antes de enviarlos a OpenReplay.

const trackerLink = tracker.use(
  createTrackerLink((variables) => {
    return {
      ...variables,
      password: '***',
    };
  }),
);

Como alternativa, puedes usar el manejador genérico de graphql:

import { createGraphqlMiddleware } from '@openreplay/tracker-graphql'; // see above for recordGraphQL definition
import { ApolloLink } from 'apollo-link';

const handler = tracker.use(createGraphqlMiddleware());

const trackerApolloLink = new ApolloLink((operation, forward) => {
  operation.setContext({ start: performance.now() });
  return forward(operation).map((result) => {
    const time = performance.now() - operation.getContext().start;
    return handler(
      // op kind, name, variables, response, duration (default 0)
      operation.query.definitions[0].operation,
      operation.operationName,
      operation.variables,
      result,
      time,
    );
  });
});

const link = ApolloLink.from([
  trackerApolloLink,
  // ...
]);

Consulta Apollo Link y Apollo Networking para más detalles.

Si buscas un ejemplo práctico de cómo usar este plugin para capturar datos de operaciones (mutaciones y consultas) en tus repeticiones de sesiones, consulta nuestro tutorial detallado aquí.

¿Tienes problemas para configurar este plugin? Conéctate a nuestro Slack o visita nuestro Foro y obtén ayuda de nuestra comunidad.