@openreplay/tracker-graphql

    3.0.0 • Public • Published

    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 returns result without changes.

    import Tracker from '@openreplay/tracker';
    import trackerGraphQL from '@openreplay/tracker-graphql';
    
    const tracker = new Tracker({
      projectKey: YOUR_PROJECT_KEY,
    });
    
    export const recordGraphQL = tracker.plugin(trackerGraphQL());

    Relay

    For Relay you should 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 { recordGraphQL } from 'tracker'; // see above for recordGraphQL definition
    import { Environment } from 'relay-runtime';
    
    function fetchQuery(operation, variables, cacheConfig, uploadables) {
      return fetch('www.myapi.com/resource', {
        // ...
      })
        .then(response => response.json())
        .then(result =>
          recordGraphQL(operation.operationKind, operation.name, variables, result),
        );
    }
    
    const network = Network.create(fetchQuery);

    See Relay Network Layer for details.

    Apollo

    For Apollo you should create a new ApolloLink with recordGraphQL call and put it to your chain like below

    import { recordGraphQL } from 'tracker'; // see above for recordGraphQL definition
    import { ApolloLink } from 'apollo-link';
    
    const trackerApolloLink = new ApolloLink((operation, forward) => {
      return forward(operation).map(result =>
        recordGraphQL(
          operation.query.definitions[0].operation,
          operation.operationName,
          operation.variables,
          result,
        ),
      );
    });
    
    const link = ApolloLink.from([
      trackerApolloLink,
      // ...
    ]);

    See Apollo Link and Apollo Networking for details.

    Install

    npm i @openreplay/tracker-graphql

    DownloadsWeekly Downloads

    1

    Version

    3.0.0

    License

    MIT

    Unpacked Size

    5.79 kB

    Total Files

    8

    Last publish

    Collaborators

    • avatar
    • avatar