@openreplay/tracker-graphql

OpenReplay Tracker GraphQL plugin

This plugin allows you to capture the GraphQL requests and then search by them.

Installation

npm i @openreplay/tracker-graphql

Usage

Initialize the @openreplay/tracker package as usual and load the plugin into it. The plugin call will return the function, which receives four variables operationKind, operationName, variables, result and duration (default 0)

returns result without changes.

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());

Relay

If you're using Relay network tools, you can simply create a middleware

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

const trackerMiddleware = tracker.use(createRelayMiddleware());

const network = new RelayNetworkLayer([
  // your middleware
  // ,
  trackerMiddleware,
]);

You can pass a Sanitizer function to createRelayMiddleware to sanitize the variables and data before sending them to OpenReplay.

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

Or you can manually put recordGraphQL call to the NetworkLayer implementation. If you are standard Network.create way to implement it, then you should do something like below

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);

See Relay Network Layer for details.

Apollo

For Apollo you should create a new ApolloLink

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

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

You can pass a Sanitizer function to createRelayMiddleware to sanitize the variables and data before sending them to OpenReplay.

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

Alternatively you can use generic graphql handler:

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,
  // ...
]);

See Apollo Link and Apollo Networking for details.