src/traversal/__tests__/flattenRelayQuery-test.js

/**
 * Copyright (c) 2013-present, Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree. An additional grant
 * of patent rights can be found in the PATENTS file in the same directory.
 *
 * @emails oncall+relay
 */

'use strict';

require('configureForRelayOSS');

const Relay = require('Relay');
const RelayTestUtils = require('RelayTestUtils');

const flattenRelayQuery = require('flattenRelayQuery');

describe('flattenRelayQuery', () => {
  const {getNode} = RelayTestUtils;

  beforeEach(() => {
    jasmine.addMatchers(RelayTestUtils.matchers);
  });

  it('flattens roots', () => {
    const node = getNode(Relay.QL`
      query {
        viewer {
          ... on Viewer {
            actor {
              name
            }
          }
          actor {
            firstName
            ... on Actor {
              lastName
            }
          }
        }
      }
    `);
    const expected = getNode(Relay.QL`
      query {
        viewer {
          actor {
            firstName
            name
            lastName
          }
        }
      }
    `);
    expect(flattenRelayQuery(node)).toEqualQueryRoot(expected);
  });

  it('flattens fragments', () => {
    const node = getNode(Relay.QL`
      fragment on Viewer {
        actor {
          firstName
          ... on Actor {
            lastName
            ... on Actor {
              name
              ... on User {
                username
              }
            }
          }
        }
      }
    `);
    const expected = getNode(Relay.QL`
      fragment on Viewer {
        actor {
          firstName
          lastName
          name
          ... on User {
            username
          }
        }
      }
    `);
    expect(flattenRelayQuery(node)).toEqualQueryNode(expected);
  });

  it('flattens fields', () => {
    const node = getNode(Relay.QL`
      query {
        viewer {
          actor {
            firstName
            name
            ... on Actor {
              name
              lastName
            }
          }
        }
      }
    `).getFieldByStorageKey('actor');
    const expected = getNode(Relay.QL`
      query {
        viewer {
          actor {
            firstName
            name
            lastName
          }
        }
      }
    `).getFieldByStorageKey('actor');
    expect(flattenRelayQuery(node)).toEqualQueryNode(expected);
  });

  it('flattens empty fragments', () => {
    const emptyFragment = Relay.QL`
      fragment on TimezoneInfo {
        ${null}
      }
    `;

    const fragmentNode = getNode(emptyFragment);
    const rootNode = getNode(Relay.QL`
      query {
        viewer {
          timezoneEstimate {
            ${emptyFragment}
          }
        }
      }
    `);
    const fieldNode = rootNode.getFieldByStorageKey('timezoneEstimate');

    expect(flattenRelayQuery(fragmentNode)).toBe(null);
    expect(flattenRelayQuery(rootNode)).toBe(null);
    expect(flattenRelayQuery(fieldNode)).toBe(null);
  });

  it('optionally removes fragments', () => {
    const node = getNode(Relay.QL`
      query {
        viewer {
          ... on Viewer {
            actor {
              ... on User {
                firstName
              }
              ... on Page {
                name
              }
            }
          }
        }
      }
    `);
    const expected = getNode(Relay.QL`
      query {
        viewer {
          actor {
            firstName
            name
          }
        }
      }
    `);
    expect(flattenRelayQuery(node, {
      shouldRemoveFragments: true,
    })).toEqualQueryNode(expected);
  });

  it('optionally preserves empty non-leaf nodes', () => {
    const node = getNode(Relay.QL`
      fragment on Comment {
        likers # can have sub-selections, normally is removed
        doesViewerLike
      }
    `);
    const flattened = flattenRelayQuery(node, {
      preserveEmptyNodes: true,
    });
    expect(flattened.getChildren().length).toBe(3);
    expect(flattened.getChildren()[0].getSchemaName()).toBe('likers');
    expect(flattened.getChildren()[1].getSchemaName()).toBe('doesViewerLike');
    expect(flattened.getChildren()[2].getSchemaName()).toBe('id');
  });
});