apollo-server-testing/src/createTestClient.ts

Test utils for apollo-server

import { ApolloServerBase } from 'apollo-server-core';
import { GraphQLResponse as GraphQLResponseType } from 'apollo-server-types';
import { print, DocumentNode } from 'graphql';

type StringOrAst = string | DocumentNode;

// A query must not come with a mutation (and vice versa).
type Query<TVariables = Record<string, any>> = {
  query: StringOrAst;
  mutation?: undefined;
  variables?: TVariables;
  operationName?: string;
};
type Mutation<TVariables = Record<string, any>> = {
  mutation: StringOrAst;
  query?: undefined;
  variables?: TVariables;
  operationName?: string;
};

type GraphQLResponse<TData> = Omit<GraphQLResponseType, 'data'> & {
  data?: TData;
};

export interface ApolloServerTestClient {
  query<TData = any, TVariables = Record<string, any>>(query: Query<TVariables>): Promise<GraphQLResponse<TData>>;
  mutate<TData = any, TVariables = Record<string, any>>(mutation: Mutation<TVariables>): Promise<GraphQLResponse<TData>>;
}

export default (server: ApolloServerBase): ApolloServerTestClient => {
  const executeOperation = server.executeOperation.bind(server);
  const test = ({ query, mutation, ...args }: Query | Mutation) => {
    const operation = query || mutation;

    if (!operation || (query && mutation)) {
      throw new Error(
        'Either `query` or `mutation` must be passed, but not both.',
      );
    }

    return executeOperation({
      // Convert ASTs, which are produced by `graphql-tag` but not currently
      // used by `executeOperation`, to a String using `graphql/language/print`.
      query: typeof operation === 'string' ? operation : print(operation),
      ...args,
    });
  };

  return { query: test, mutate: test } as ApolloServerTestClient;
};