@apollo/federation/src/composition/validate/postComposition/__tests__/keysMatchBaseService.test.ts

Apollo Federation Utilities

import { composeServices } from '../../../compose';
import { keysMatchBaseService as validateKeysMatchBaseService } from '../';
import {
  gql,
  graphqlErrorSerializer,
} from 'apollo-federation-integration-testsuite';
import { assertCompositionSuccess } from '../../../utils';

expect.addSnapshotSerializer(graphqlErrorSerializer);

describe('keysMatchBaseService', () => {
  it('returns no errors with proper @key usage', () => {
    const serviceA = {
      typeDefs: gql`
        type Product @key(fields: "sku") {
          sku: String!
          upc: String!
        }
      `,
      name: 'serviceA',
    };

    const serviceB = {
      typeDefs: gql`
        extend type Product @key(fields: "sku") {
          sku: String! @external
          price: Int!
        }
      `,
      name: 'serviceB',
    };

    const serviceList = [serviceA, serviceB];
    const compositionResult = composeServices(serviceList);
    assertCompositionSuccess(compositionResult);
    const { schema } = compositionResult;

    const validationErrors = validateKeysMatchBaseService({
      schema,
      serviceList,
    });
    expect(validationErrors).toHaveLength(0);
  });

  it('requires a @key to be specified on the originating type', () => {
    const serviceA = {
      typeDefs: gql`
        type Product {
          sku: String!
          upc: String!
        }
      `,
      name: 'serviceA',
    };

    const serviceB = {
      typeDefs: gql`
        extend type Product @key(fields: "sku") {
          sku: String! @external
          price: Int!
        }
      `,
      name: 'serviceB',
    };

    const serviceList = [serviceA, serviceB];
    const compositionResult = composeServices(serviceList);
    assertCompositionSuccess(compositionResult);
    const { schema } = compositionResult;

    const validationErrors = validateKeysMatchBaseService({
      schema,
      serviceList,
    });
    expect(validationErrors).toHaveLength(1);
    expect(validationErrors[0]).toMatchInlineSnapshot(`
      Object {
        "code": "KEY_MISSING_ON_BASE",
        "locations": Array [
          Object {
            "column": 1,
            "line": 2,
          },
        ],
        "message": "[serviceA] Product -> appears to be an entity but no @key directives are specified on the originating type.",
      }
    `);
  });

  it('requires an extending service use only one @key specified on the originating type', () => {
    const serviceA = {
      typeDefs: gql`
        type Product @key(fields: "sku") @key(fields: "upc") {
          sku: String!
          upc: String!
        }
      `,
      name: 'serviceA',
    };

    const serviceB = {
      typeDefs: gql`
        extend type Product @key(fields: "sku") @key(fields: "upc") {
          sku: String! @external
          upc: String! @external
          price: Int!
        }
      `,
      name: 'serviceB',
    };

    const serviceList = [serviceA, serviceB];
    const compositionResult = composeServices(serviceList);
    assertCompositionSuccess(compositionResult);
    const { schema } = compositionResult;

    const validationErrors = validateKeysMatchBaseService({
      schema,
      serviceList,
    });
    expect(validationErrors).toHaveLength(1);
    expect(validationErrors[0]).toMatchInlineSnapshot(`
      Object {
        "code": "MULTIPLE_KEYS_ON_EXTENSION",
        "locations": Array [
          Object {
            "column": 1,
            "line": 2,
          },
        ],
        "message": "[serviceB] Product -> is extended from service serviceA but specifies multiple @key directives. Extensions may only specify one @key.",
      }
    `);
  });

  it('requires extending services to use a @key specified by the originating type', () => {
    const serviceA = {
      typeDefs: gql`
        type Product @key(fields: "sku upc") {
          sku: String!
          upc: String!
        }
      `,
      name: 'serviceA',
    };

    const serviceB = {
      typeDefs: gql`
        extend type Product @key(fields: "sku") {
          sku: String! @external
          price: Int!
        }
      `,
      name: 'serviceB',
    };

    const serviceList = [serviceA, serviceB];
    const compositionResult = composeServices(serviceList);
    assertCompositionSuccess(compositionResult);
    const { schema } = compositionResult;

    const validationErrors = validateKeysMatchBaseService({
      schema,
      serviceList,
    });
    expect(validationErrors).toHaveLength(1);
    expect(validationErrors[0]).toMatchInlineSnapshot(`
      Object {
        "code": "KEY_NOT_SPECIFIED",
        "locations": Array [
          Object {
            "column": 34,
            "line": 2,
          },
        ],
        "message": "[serviceB] Product -> extends from serviceA but specifies an invalid @key directive. Valid @key directives are specified by the originating type. Available @key directives for this type are:
      	@key(fields: \\"sku upc\\")",
      }
    `);
  });
});