@apollo/gateway 2.4.5 → 2.4.6

package/src/__tests__/gateway/supergraphSdl.test.ts

@@ -1,396 +0,0 @@
-import {
-  ApolloGateway,
-  RemoteGraphQLDataSource,
-  SubgraphHealthCheckFunction,
-  SupergraphSdlUpdateFunction,
-} from '@apollo/gateway';
-import { accounts, fixturesWithUpdate } from 'apollo-federation-integration-testsuite';
-import { createHash } from '@apollo/utils.createhash';
-import { ApolloServer } from '@apollo/server';
-import { startStandaloneServer } from '@apollo/server/standalone';
-import type { Logger } from '@apollo/utils.logger';
-import { getTestingSupergraphSdl } from '../execution-utils';
-import { mockAllServicesHealthCheckSuccess } from '../integration/nockMocks';
-import resolvable from '@josephg/resolvable';
-import { nockAfterEach, nockBeforeEach } from '../nockAssertions';
-import nock from 'nock';
-import { unwrapSingleResultKind } from '../gateway/testUtils';
-
-async function getSupergraphSdlGatewayServer() {
-  const server = new ApolloServer({
-    gateway: new ApolloGateway({
-      supergraphSdl: getTestingSupergraphSdl(),
-      buildService({ url }) {
-        return new RemoteGraphQLDataSource({
-          url,
-        });
-      },
-    }),
-  });
-
-  await startStandaloneServer(server, { listen: { port: 0 } });
-  return server;
-}
-
-let logger: Logger;
-let gateway: ApolloGateway | null;
-beforeEach(() => {
-  nockBeforeEach();
-
-  logger = {
-    debug: jest.fn(),
-    info: jest.fn(),
-    warn: jest.fn(),
-    error: jest.fn(),
-  };
-});
-
-afterEach(async () => {
-  nockAfterEach();
-
-  if (gateway) {
-    await gateway.stop();
-    gateway = null;
-  }
-});
-
-const testingFixturesDefaultCompositionId = createHash('sha256').update(getTestingSupergraphSdl()).digest('hex');
-
-describe('Using supergraphSdl static configuration', () => {
-  it('successfully starts and serves requests to the proper services', async () => {
-    const server = await getSupergraphSdlGatewayServer();
-
-    nock(accounts.url)
-      .post('/', { query: '{me{username}}', variables: {} })
-      .reply(200, { data: { me: { username: '@apollo-user' } } });
-
-
-    const result = await server.executeOperation({
-      query: '{ me { username } }',
-    });
-
-    expect(unwrapSingleResultKind(result).data).toMatchInlineSnapshot(`
-      Object {
-        "me": Object {
-          "username": "@apollo-user",
-        },
-      }
-    `);
-
-    await server.stop();
-  });
-});
-
-describe('Using supergraphSdl dynamic configuration', () => {
-  it('calls the user provided function after `gateway.load()` is called', async () => {
-    const callbackSpy = jest.fn(async () => ({
-      supergraphSdl: getTestingSupergraphSdl(),
-    }));
-
-    gateway = new ApolloGateway({
-      supergraphSdl: callbackSpy,
-    });
-
-    expect(callbackSpy).not.toHaveBeenCalled();
-    await gateway.load();
-    expect(callbackSpy).toHaveBeenCalled();
-  });
-
-  it('starts and remains in `initialized` state until `supergraphSdl` Promise resolves', async () => {
-    const promiseGuaranteeingWeAreInTheCallback = resolvable();
-    const promiseGuaranteeingWeStayInTheCallback = resolvable();
-
-    gateway = new ApolloGateway({
-      async supergraphSdl() {
-        promiseGuaranteeingWeAreInTheCallback.resolve();
-        await promiseGuaranteeingWeStayInTheCallback;
-        return {
-          supergraphSdl: getTestingSupergraphSdl(),
-        };
-      },
-    });
-
-    expect(gateway.__testing().state.phase).toEqual('initialized');
-
-    const gatewayLoaded = gateway.load();
-    await promiseGuaranteeingWeAreInTheCallback;
-    expect(gateway.__testing().state.phase).toEqual('initialized');
-
-    promiseGuaranteeingWeStayInTheCallback.resolve();
-    await gatewayLoaded;
-    expect(gateway.__testing().state.phase).toEqual('loaded');
-  });
-
-  it('moves from `initialized` to `loaded` state after calling `load()` and after user Promise resolves', async () => {
-    const userPromise = resolvable<{ supergraphSdl: string }>();
-
-    gateway = new ApolloGateway({
-      async supergraphSdl() {
-        return userPromise;
-      },
-    });
-
-    const loadPromise = gateway.load();
-    expect(gateway.__testing().state.phase).toEqual('initialized');
-
-    const supergraphSdl = getTestingSupergraphSdl();
-    const expectedCompositionId = createHash('sha256')
-      .update(supergraphSdl)
-      .digest('hex');
-    userPromise.resolve({ supergraphSdl });
-
-    await loadPromise;
-    const { state, compositionId } = gateway.__testing();
-    expect(state.phase).toEqual('loaded');
-    expect(compositionId).toEqual(expectedCompositionId);
-  });
-
-  it('updates its supergraph after user calls update function', async () => {
-    const userPromise = resolvable<{ supergraphSdl: string }>();
-
-    let userUpdateFn: SupergraphSdlUpdateFunction;
-    gateway = new ApolloGateway({
-      async supergraphSdl({ update }) {
-        userUpdateFn = update;
-        return userPromise;
-      },
-    });
-
-    const supergraphSdl = getTestingSupergraphSdl();
-    const expectedId = createHash('sha256').update(supergraphSdl).digest('hex');
-    userPromise.resolve({ supergraphSdl: getTestingSupergraphSdl() });
-    await gateway.load();
-    expect(gateway.__testing().compositionId).toEqual(expectedId);
-
-    const updatedSupergraphSdl = getTestingSupergraphSdl(fixturesWithUpdate);
-    const expectedUpdatedId = createHash('sha256')
-      .update(updatedSupergraphSdl)
-      .digest('hex');
-
-    userUpdateFn!(updatedSupergraphSdl);
-    expect(gateway.__testing().compositionId).toEqual(expectedUpdatedId);
-  });
-
-  it('calls user-provided `cleanup` function when stopped', async () => {
-    const cleanup = jest.fn(() => Promise.resolve());
-    gateway = new ApolloGateway({
-      async supergraphSdl() {
-        return {
-          supergraphSdl: getTestingSupergraphSdl(),
-          cleanup,
-        };
-      },
-    });
-
-    await gateway.load();
-    const { state, compositionId } = gateway.__testing();
-    expect(state.phase).toEqual('loaded');
-    expect(compositionId).toEqual(
-      testingFixturesDefaultCompositionId,
-    );
-
-    await gateway.stop();
-    expect(cleanup).toHaveBeenCalledTimes(1);
-  });
-
-  it('performs a successful health check on subgraphs', async () => {
-    mockAllServicesHealthCheckSuccess();
-
-    let healthCheckCallback: SubgraphHealthCheckFunction;
-    const supergraphSdl = getTestingSupergraphSdl();
-    gateway = new ApolloGateway({
-      async supergraphSdl({ healthCheck }) {
-        healthCheckCallback = healthCheck;
-        return {
-          supergraphSdl,
-        };
-      },
-    });
-
-    await gateway.load();
-    const { state, compositionId } = gateway.__testing();
-    expect(state.phase).toEqual('loaded');
-    expect(compositionId).toEqual(
-      testingFixturesDefaultCompositionId,
-    );
-
-    await expect(healthCheckCallback!(supergraphSdl)).resolves.toBeUndefined();
-  });
-
-  it('calls `initialize` on an object provided to `supergraphSdl`', async () => {
-    const MockSdlUpdatingClass = {
-      initialize() {
-        return Promise.resolve({
-          supergraphSdl: getTestingSupergraphSdl(),
-        });
-      },
-    };
-    const initializeSpy = jest.spyOn(MockSdlUpdatingClass, 'initialize');
-
-    gateway = new ApolloGateway({
-      supergraphSdl: MockSdlUpdatingClass,
-    });
-
-    expect(initializeSpy).not.toHaveBeenCalled();
-    await gateway.load();
-    expect(initializeSpy).toHaveBeenCalled();
-  });
-
-  describe('errors', () => {
-    it('fails to load if `SupergraphManager` throws on initialization', async () => {
-      const failureMessage = 'Error from supergraphSdl function';
-      gateway = new ApolloGateway({
-        async supergraphSdl() {
-          throw new Error(failureMessage);
-        },
-        logger,
-      });
-
-      await expect(gateway.load()).rejects.toThrowError(failureMessage);
-
-      expect(gateway.__testing().state.phase).toEqual('failed to load');
-      // we don't want the `afterEach` to call `gateway.stop()` in this case
-      // since it would throw an error due to the gateway's failed to load state
-      gateway = null;
-    });
-
-    it('gracefully handles Promise rejections from user `cleanup` function', async () => {
-      const rejectionMessage = 'thrown from cleanup function';
-      const cleanup = jest.fn(() => Promise.reject(rejectionMessage));
-      gateway = new ApolloGateway({
-        async supergraphSdl() {
-          return {
-            supergraphSdl: getTestingSupergraphSdl(),
-            cleanup,
-          };
-        },
-        logger,
-      });
-
-      await gateway.load();
-      await expect(gateway.stop()).resolves.toBeUndefined();
-      expect(cleanup).toHaveBeenCalledTimes(1);
-      expect(logger.error).toHaveBeenCalledWith(
-        'Error occured while calling user provided `cleanup` function: ' +
-          rejectionMessage,
-      );
-    });
-
-    it('throws an error when `healthCheck` rejects', async () => {
-      // no mocks, so nock will reject
-      let healthCheckCallback: SubgraphHealthCheckFunction;
-      const supergraphSdl = getTestingSupergraphSdl();
-      gateway = new ApolloGateway({
-        async supergraphSdl({ healthCheck }) {
-          healthCheckCallback = healthCheck;
-          return {
-            supergraphSdl,
-          };
-        },
-      });
-
-      await gateway.load();
-      const { state, compositionId } = gateway.__testing();
-      expect(state.phase).toEqual('loaded');
-      expect(compositionId).toEqual(
-        testingFixturesDefaultCompositionId
-      );
-
-      await expect(healthCheckCallback!(supergraphSdl)).rejects.toThrowError(
-        /The gateway subgraphs health check failed\. Updating to the provided `supergraphSdl` will likely result in future request failures to subgraphs\. The following error occurred during the health check/,
-      );
-    });
-
-    it('throws an error when `update` is called after gateway fails to load', async () => {
-      let updateCallback: SupergraphSdlUpdateFunction;
-      const supergraphSdl = getTestingSupergraphSdl();
-      gateway = new ApolloGateway({
-        async supergraphSdl({ update }) {
-          updateCallback = update;
-          return {
-            supergraphSdl: 'invalid SDL',
-          };
-        },
-      });
-
-      try {
-        await gateway.load();
-      } catch {}
-
-      expect(() =>
-        updateCallback!(supergraphSdl),
-      ).toThrowErrorMatchingInlineSnapshot(
-        `"Can't call \`update\` callback after gateway failed to load."`,
-      );
-
-      // gateway failed to load, so we don't want the `afterEach` to call `gateway.stop()`
-      gateway = null;
-    });
-
-    it('throws an error when `update` is called while an update is in progress', async () => {
-      let updateCallback: SupergraphSdlUpdateFunction;
-      const supergraphSdl = getTestingSupergraphSdl();
-      gateway = new ApolloGateway({
-        async supergraphSdl({ update }) {
-          updateCallback = update;
-          return {
-            supergraphSdl,
-          };
-        },
-        experimental_didUpdateSupergraph() {
-          updateCallback(getTestingSupergraphSdl(fixturesWithUpdate));
-        },
-      });
-
-      await expect(gateway.load()).rejects.toThrowErrorMatchingInlineSnapshot(
-        `"Can't call \`update\` callback while supergraph update is in progress."`,
-      );
-
-      // gateway failed to load, so we don't want the `afterEach` to call `gateway.stop()`
-      gateway = null;
-    });
-
-    it('throws an error when `update` is called after gateway is stopped', async () => {
-      let updateCallback: SupergraphSdlUpdateFunction;
-      const supergraphSdl = getTestingSupergraphSdl();
-      gateway = new ApolloGateway({
-        async supergraphSdl({ update }) {
-          updateCallback = update;
-          return {
-            supergraphSdl,
-          };
-        },
-      });
-
-      await gateway.load();
-      await gateway.stop();
-
-      expect(() =>
-        updateCallback!(getTestingSupergraphSdl(fixturesWithUpdate)),
-      ).toThrowErrorMatchingInlineSnapshot(
-        `"Can't call \`update\` callback after gateway has been stopped."`,
-      );
-    });
-
-    it('throws an error when `update` is called with an invalid supergraph', async () => {
-      let updateCallback: SupergraphSdlUpdateFunction;
-      const supergraphSdl = getTestingSupergraphSdl();
-      gateway = new ApolloGateway({
-        async supergraphSdl({ update }) {
-          updateCallback = update;
-          return {
-            supergraphSdl,
-          };
-        },
-      });
-
-      await gateway.load();
-
-      expect(() =>
-        updateCallback!('invalid SDL'),
-      ).toThrowErrorMatchingInlineSnapshot(
-        `"Syntax Error: Unexpected Name \\"invalid\\"."`,
-      );
-    });
-  });
-});

package/src/__tests__/gateway/testUtils.ts

@@ -1,89 +0,0 @@
-import { buildSubgraphSchema } from '@apollo/subgraph';
-import {
-  ApolloServer,
-  ApolloServerOptionsWithGateway,
-  BaseContext,
-  GraphQLResponse,
-} from '@apollo/server';
-import { startStandaloneServer } from '@apollo/server/standalone';
-import { ApolloServerPluginInlineTrace } from '@apollo/server/plugin/inlineTrace';
-import { GraphQLSchemaModule } from '@apollo/subgraph/src/schema-helper';
-import { ApolloGateway, GatewayConfig } from '../..';
-import { ServiceDefinition } from '@apollo/federation-internals';
-import fetch, { Response } from 'node-fetch';
-import { assert } from '@apollo/federation-internals';
-
-export class Services {
-  constructor(
-    readonly subgraphServers: ApolloServer[],
-    readonly gateway: ApolloGateway,
-    readonly gatewayServer: ApolloServer,
-    readonly gatewayUrl: string,
-  ) {
-  }
-
-  async queryGateway(query: string): Promise<Response> {
-    return fetch(this.gatewayUrl, {
-      method: 'POST',
-      headers: {
-        'Content-Type': 'application/json',
-      },
-      body: JSON.stringify({ query }),
-    });
-  }
-
-  async stop() {
-    for (const server of this.subgraphServers) {
-      await server.stop();
-    }
-    await this.gatewayServer.stop();
-  }
-}
-
-async function startFederatedServer(modules: GraphQLSchemaModule[]) {
-  const schema = buildSubgraphSchema(modules);
-  const server = new ApolloServer({
-    schema,
-    // Manually installing the inline trace plugin means it doesn't log a message.
-    plugins: [ApolloServerPluginInlineTrace()],
-  });
-  const { url } = await startStandaloneServer(server, { listen: { port: 0 } });
-  return { url, server };
-}
-
-export async function startSubgraphsAndGateway(
-  servicesDefs: ServiceDefinition[],
-  config?: {
-    gatewayConfig?: GatewayConfig;
-    gatewayServerConfig?: Partial<ApolloServerOptionsWithGateway<BaseContext>>;
-  },
-): Promise<Services> {
-  const backendServers = [];
-  const serviceList = [];
-  for (const serviceDef of servicesDefs) {
-    const { server, url } = await startFederatedServer([serviceDef]);
-    backendServers.push(server);
-    serviceList.push({ name: serviceDef.name, url });
-  }
-
-  const gateway = new ApolloGateway({
-    serviceList,
-    ...config?.gatewayConfig,
-  });
-  const gatewayServer = new ApolloServer({
-    gateway,
-    ...config?.gatewayServerConfig,
-  });
-  const { url: gatewayUrl } = await startStandaloneServer(gatewayServer, {
-    listen: { port: 0 },
-  });
-  return new Services(backendServers, gateway, gatewayServer, gatewayUrl);
-}
-
-export function unwrapSingleResultKind(response: GraphQLResponse) {
-  assert(
-    response.body.kind === 'single',
-    `Expected single result, got ${response.body.kind}`,
-  );
-  return response.body.singleResult;
-}