@apollo/gateway 2.4.5 → 2.4.6

package/src/supergraphManagers/UplinkSupergraphManager/__tests__/loadSupergraphSdlFromStorage.test.ts

@@ -1,511 +0,0 @@
-import nock from 'nock';
-import {
-  loadSupergraphSdlFromStorage,
-  loadSupergraphSdlFromUplinks,
-  UplinkFetcherError,
-} from '../loadSupergraphSdlFromStorage';
-import fetcher from 'make-fetch-happen';
-import {
-  graphRef,
-  apiKey,
-  mockCloudConfigUrl1,
-  mockCloudConfigUrl2,
-  mockOutOfBandReporterUrl,
-  mockSupergraphSdlRequest,
-  mockOutOfBandReportRequestSuccess,
-  mockSupergraphSdlRequestSuccess,
-  mockSupergraphSdlRequestIfAfterUnchanged,
-  mockSupergraphSdlRequestIfAfter,
-} from '../../../__tests__/integration/nockMocks';
-import { getTestingSupergraphSdl } from '../../../__tests__/execution-utils';
-import {
-  nockAfterEach,
-  nockBeforeEach,
-} from '../../../__tests__/nockAssertions';
-import { FetcherRequestInit } from '@apollo/utils.fetcher';
-
-const logger = {
-  warn: jest.fn(),
-  debug: jest.fn(),
-  error: jest.fn(),
-  info: jest.fn(),
-};
-
-const requestTimeoutMs = 100;
-
-describe('loadSupergraphSdlFromStorage', () => {
-  beforeEach(nockBeforeEach);
-  afterEach(nockAfterEach);
-
-  it('fetches Supergraph SDL as expected', async () => {
-    mockSupergraphSdlRequestSuccess();
-    const result = await loadSupergraphSdlFromStorage({
-      graphRef,
-      apiKey,
-      endpoint: mockCloudConfigUrl1,
-      errorReportingEndpoint: undefined,
-      fetcher,
-      requestTimeoutMs,
-      compositionId: null,
-      logger,
-    });
-    expect(result).toMatchObject({
-      id: 'originalId-1234',
-      supergraphSdl: getTestingSupergraphSdl(),
-    });
-  });
-
-  it('Queries alternate Uplink URL if first one fails', async () => {
-    mockSupergraphSdlRequest('originalId-1234', mockCloudConfigUrl1).reply(500);
-    mockSupergraphSdlRequestIfAfter(
-      'originalId-1234',
-      mockCloudConfigUrl2,
-    ).reply(
-      200,
-      JSON.stringify({
-        data: {
-          routerConfig: {
-            __typename: 'RouterConfigResult',
-            id: 'originalId-1234',
-            supergraphSdl: getTestingSupergraphSdl(),
-          },
-        },
-      }),
-    );
-
-    const result = await loadSupergraphSdlFromUplinks({
-      graphRef,
-      apiKey,
-      endpoints: [mockCloudConfigUrl1, mockCloudConfigUrl2],
-      errorReportingEndpoint: undefined,
-      fetcher,
-      requestTimeoutMs,
-      compositionId: 'originalId-1234',
-      maxRetries: 1,
-      roundRobinSeed: 0,
-      logger,
-    });
-
-    expect(result).toMatchObject({
-      id: 'originalId-1234',
-      supergraphSdl: getTestingSupergraphSdl(),
-    });
-  });
-
-  it('Queries alternate Uplink URL if first one times out', async () => {
-    mockSupergraphSdlRequest('originalId-1234', mockCloudConfigUrl1).delay(120_000).reply(500);
-    mockSupergraphSdlRequestIfAfter(
-      'originalId-1234',
-      mockCloudConfigUrl2,
-    ).reply(
-      200,
-      JSON.stringify({
-        data: {
-          routerConfig: {
-            __typename: 'RouterConfigResult',
-            id: 'originalId-1234',
-            supergraphSdl: getTestingSupergraphSdl(),
-          },
-        },
-      }),
-    );
-
-    const result = await loadSupergraphSdlFromUplinks({
-      graphRef,
-      apiKey,
-      endpoints: [mockCloudConfigUrl1, mockCloudConfigUrl2],
-      errorReportingEndpoint: undefined,
-      fetcher,
-      requestTimeoutMs,
-      compositionId: 'originalId-1234',
-      maxRetries: 1,
-      roundRobinSeed: 0,
-      logger,
-    });
-
-    expect(result).toMatchObject({
-      id: 'originalId-1234',
-      supergraphSdl: getTestingSupergraphSdl(),
-    });
-
-    // We're intentionally delaying the response above, so we need to make sure
-    // nock shuts down correctly, and isn't related to the underlying abort
-    // mechanism.
-    nock.abortPendingRequests();
-  });
-
-  it('Throws error if all Uplink URLs fail', async () => {
-    mockSupergraphSdlRequest('originalId-1234', mockCloudConfigUrl1).reply(500);
-    mockSupergraphSdlRequestIfAfter(
-      'originalId-1234',
-      mockCloudConfigUrl2,
-    ).reply(500);
-
-    await expect(
-      loadSupergraphSdlFromUplinks({
-        graphRef,
-        apiKey,
-        endpoints: [mockCloudConfigUrl1, mockCloudConfigUrl2],
-        errorReportingEndpoint: undefined,
-        fetcher,
-        requestTimeoutMs,
-        compositionId: 'originalId-1234',
-        maxRetries: 1,
-        roundRobinSeed: 0,
-        logger,
-      }),
-    ).rejects.toThrowError(
-      new UplinkFetcherError(
-        'An error occurred while fetching your schema from Apollo: 500 Internal Server Error',
-      ),
-    );
-  });
-
-  describe('errors', () => {
-    it('throws on a malformed response', async () => {
-      mockSupergraphSdlRequest().reply(200, 'Invalid JSON');
-
-      await expect(
-        loadSupergraphSdlFromStorage({
-          graphRef,
-          apiKey,
-          endpoint: mockCloudConfigUrl1,
-          errorReportingEndpoint: mockOutOfBandReporterUrl,
-          fetcher,
-          requestTimeoutMs,
-          compositionId: null,
-          logger,
-        }),
-      ).rejects.toThrowError(
-        /An error occurred while fetching your schema from Apollo: 200 invalid json response body at https:\/\/example1.cloud-config-url.com\/cloudconfig\/ reason: Unexpected token/,
-      );
-    });
-
-    it('throws errors from JSON on 400', async () => {
-      const message = 'Query syntax error';
-      mockSupergraphSdlRequest().reply(
-        400,
-        JSON.stringify({
-          errors: [{ message }],
-        }),
-      );
-
-      await expect(
-        loadSupergraphSdlFromStorage({
-          graphRef,
-          apiKey,
-          endpoint: mockCloudConfigUrl1,
-          errorReportingEndpoint: mockOutOfBandReporterUrl,
-          fetcher,
-          requestTimeoutMs,
-          compositionId: null,
-          logger,
-        }),
-      ).rejects.toThrowError(
-        new UplinkFetcherError(
-          `An error occurred while fetching your schema from Apollo: \n${message}`,
-        ),
-      );
-    });
-
-    it("throws on non-OK status codes when `errors` isn't present in a JSON response", async () => {
-      mockSupergraphSdlRequest().reply(500);
-      mockOutOfBandReportRequestSuccess();
-
-      await expect(
-        loadSupergraphSdlFromStorage({
-          graphRef,
-          apiKey,
-          endpoint: mockCloudConfigUrl1,
-          errorReportingEndpoint: mockOutOfBandReporterUrl,
-          fetcher,
-          requestTimeoutMs,
-          compositionId: null,
-          logger,
-        }),
-      ).rejects.toThrowError(
-        new UplinkFetcherError(
-          'An error occurred while fetching your schema from Apollo: 500 Internal Server Error',
-        ),
-      );
-    });
-
-    // if an additional request were made by the out of band reporter, nock would throw since it's unmocked
-    // and this test would fail
-    it("Out of band reporting doesn't submit reports when endpoint is not configured", async () => {
-      mockSupergraphSdlRequest().reply(400);
-
-      await expect(
-        loadSupergraphSdlFromStorage({
-          graphRef,
-          apiKey,
-          endpoint: mockCloudConfigUrl1,
-          errorReportingEndpoint: mockOutOfBandReporterUrl,
-          fetcher,
-          requestTimeoutMs,
-          compositionId: null,
-          logger,
-        }),
-      ).rejects.toThrowError(
-        new UplinkFetcherError(
-          'An error occurred while fetching your schema from Apollo: 400 invalid json response body at https://example1.cloud-config-url.com/cloudconfig/ reason: Unexpected end of JSON input',
-        ),
-      );
-    });
-
-    it('throws on 400 status response and does not submit an out of band error', async () => {
-      mockSupergraphSdlRequest().reply(400);
-
-      await expect(
-        loadSupergraphSdlFromStorage({
-          graphRef,
-          apiKey,
-          endpoint: mockCloudConfigUrl1,
-          errorReportingEndpoint: mockOutOfBandReporterUrl,
-          fetcher,
-          requestTimeoutMs,
-          compositionId: null,
-          logger,
-        }),
-      ).rejects.toThrowError(
-        new UplinkFetcherError(
-          'An error occurred while fetching your schema from Apollo: 400 invalid json response body at https://example1.cloud-config-url.com/cloudconfig/ reason: Unexpected end of JSON input',
-        ),
-      );
-    });
-
-    it('throws on 413 status response and successfully submits an out of band error', async () => {
-      mockSupergraphSdlRequest().reply(413);
-      mockOutOfBandReportRequestSuccess();
-
-      await expect(
-        loadSupergraphSdlFromStorage({
-          graphRef,
-          apiKey,
-          endpoint: mockCloudConfigUrl1,
-          errorReportingEndpoint: mockOutOfBandReporterUrl,
-          fetcher,
-          requestTimeoutMs,
-          compositionId: null,
-          logger,
-        }),
-      ).rejects.toThrowError(
-        new UplinkFetcherError(
-          'An error occurred while fetching your schema from Apollo: 413 Payload Too Large',
-        ),
-      );
-    });
-
-    it('throws on 422 status response and successfully submits an out of band error', async () => {
-      mockSupergraphSdlRequest().reply(422);
-      mockOutOfBandReportRequestSuccess();
-
-      await expect(
-        loadSupergraphSdlFromStorage({
-          graphRef,
-          apiKey,
-          endpoint: mockCloudConfigUrl1,
-          errorReportingEndpoint: mockOutOfBandReporterUrl,
-          fetcher,
-          requestTimeoutMs,
-          compositionId: null,
-          logger,
-        }),
-      ).rejects.toThrowError(
-        new UplinkFetcherError(
-          'An error occurred while fetching your schema from Apollo: 422 Unprocessable Entity',
-        ),
-      );
-    });
-
-    it('throws on 408 status response and successfully submits an out of band error', async () => {
-      mockSupergraphSdlRequest().reply(408);
-      mockOutOfBandReportRequestSuccess();
-
-      await expect(
-        loadSupergraphSdlFromStorage({
-          graphRef,
-          apiKey,
-          endpoint: mockCloudConfigUrl1,
-          errorReportingEndpoint: mockOutOfBandReporterUrl,
-          fetcher,
-          requestTimeoutMs,
-          compositionId: null,
-          logger,
-        }),
-      ).rejects.toThrowError(
-        new UplinkFetcherError(
-          'An error occurred while fetching your schema from Apollo: 408 Request Timeout',
-        ),
-      );
-    });
-  });
-
-  it('throws on 504 status response and successfully submits an out of band error', async () => {
-    mockSupergraphSdlRequest().reply(504);
-    mockOutOfBandReportRequestSuccess();
-
-    await expect(
-      loadSupergraphSdlFromStorage({
-        graphRef,
-        apiKey,
-        endpoint: mockCloudConfigUrl1,
-        errorReportingEndpoint: mockOutOfBandReporterUrl,
-        fetcher,
-        requestTimeoutMs,
-        compositionId: null,
-        logger,
-      }),
-    ).rejects.toThrowError(
-      new UplinkFetcherError(
-        'An error occurred while fetching your schema from Apollo: 504 Gateway Timeout',
-      ),
-    );
-  });
-
-  it('throws when there is no response and successfully submits an out of band error', async () => {
-    mockSupergraphSdlRequest().replyWithError('no response');
-    mockOutOfBandReportRequestSuccess();
-
-    await expect(
-      loadSupergraphSdlFromStorage({
-        graphRef,
-        apiKey,
-        endpoint: mockCloudConfigUrl1,
-        errorReportingEndpoint: mockOutOfBandReporterUrl,
-        fetcher,
-        requestTimeoutMs,
-        compositionId: null,
-        logger,
-      }),
-    ).rejects.toThrowError(
-      new UplinkFetcherError(
-        'An error occurred while fetching your schema from Apollo: request to https://example1.cloud-config-url.com/cloudconfig/ failed, reason: no response',
-      ),
-    );
-  });
-
-  it('throws on 502 status response and successfully submits an out of band error', async () => {
-    mockSupergraphSdlRequest().reply(502);
-    mockOutOfBandReportRequestSuccess();
-
-    await expect(
-      loadSupergraphSdlFromStorage({
-        graphRef,
-        apiKey,
-        endpoint: mockCloudConfigUrl1,
-        errorReportingEndpoint: mockOutOfBandReporterUrl,
-        fetcher,
-        requestTimeoutMs,
-        compositionId: null,
-        logger,
-      }),
-    ).rejects.toThrowError(
-      new UplinkFetcherError(
-        'An error occurred while fetching your schema from Apollo: 502 Bad Gateway',
-      ),
-    );
-  });
-
-  it('throws on 503 status response and successfully submits an out of band error', async () => {
-    mockSupergraphSdlRequest().reply(503);
-    mockOutOfBandReportRequestSuccess();
-
-    await expect(
-      loadSupergraphSdlFromStorage({
-        graphRef,
-        apiKey,
-        endpoint: mockCloudConfigUrl1,
-        errorReportingEndpoint: mockOutOfBandReporterUrl,
-        fetcher,
-        requestTimeoutMs,
-        compositionId: null,
-        logger,
-      }),
-    ).rejects.toThrowError(
-      new UplinkFetcherError(
-        'An error occurred while fetching your schema from Apollo: 503 Service Unavailable',
-      ),
-    );
-  });
-
-  it('successfully responds to SDL unchanged by returning null', async () => {
-    mockSupergraphSdlRequestIfAfterUnchanged('id-1234');
-
-    const result = await loadSupergraphSdlFromStorage({
-      graphRef,
-      apiKey,
-      endpoint: mockCloudConfigUrl1,
-      errorReportingEndpoint: mockOutOfBandReporterUrl,
-      fetcher,
-      requestTimeoutMs,
-      compositionId: 'id-1234',
-      logger,
-    });
-    expect(result).toBeNull();
-  });
-});
-
-describe('loadSupergraphSdlFromUplinks', () => {
-  beforeEach(nockBeforeEach);
-  afterEach(nockAfterEach);
-
-  it("doesn't retry in the unchanged / null case", async () => {
-    mockSupergraphSdlRequestIfAfterUnchanged('id-1234', mockCloudConfigUrl1);
-
-    let calls = 0;
-    const result = await loadSupergraphSdlFromUplinks({
-      graphRef,
-      apiKey,
-      endpoints: [mockCloudConfigUrl1, mockCloudConfigUrl2],
-      errorReportingEndpoint: mockOutOfBandReporterUrl,
-      fetcher: (url: string, init?: FetcherRequestInit) => {
-        calls++;
-        return fetcher(url, init);
-      },
-      requestTimeoutMs,
-      compositionId: 'id-1234',
-      maxRetries: 5,
-      roundRobinSeed: 0,
-      logger,
-    });
-
-    expect(result).toBeNull();
-    expect(calls).toBe(1);
-  });
-
-  it('Retries on error', async () => {
-    mockSupergraphSdlRequest('originalId-1234', mockCloudConfigUrl1).reply(500);
-    const supergraphSdl = getTestingSupergraphSdl();
-    mockSupergraphSdlRequestIfAfter(
-      'originalId-1234',
-      mockCloudConfigUrl2,
-    ).reply(
-      200,
-      JSON.stringify({
-        data: {
-          routerConfig: {
-            __typename: 'RouterConfigResult',
-            id: 'originalId-1234',
-            supergraphSdl,
-          },
-        },
-      }),
-    );
-
-    const result = await loadSupergraphSdlFromUplinks({
-      graphRef,
-      apiKey,
-      endpoints: [mockCloudConfigUrl1, mockCloudConfigUrl2],
-      errorReportingEndpoint: undefined,
-      fetcher,
-      requestTimeoutMs,
-      compositionId: 'originalId-1234',
-      maxRetries: 1,
-      roundRobinSeed: 0,
-      logger,
-    });
-
-    expect(result?.supergraphSdl).toEqual(supergraphSdl);
-  });
-});

package/src/utilities/__tests__/deepMerge.test.ts

@@ -1,77 +0,0 @@
-import { deepMerge } from '../deepMerge';
-
-describe('deepMerge', () => {
-  it('merges basic', () => {
-    const target = {
-      a: 1,
-      b: 2,
-    };
-
-    const source = {
-      b: 3,
-      c: 4,
-    };
-
-    expect(deepMerge(target, source)).toEqual({
-      a: 1,
-      b: 3,
-      c: 4,
-    });
-  });
-
-  it('merges nested objects', () => {
-    const target = {
-      a: 1,
-      b: {
-        someProperty: 1,
-        overwrittenProperty: 'clean',
-      },
-    };
-
-    const source = {
-      b: {
-        overwrittenProperty: 'dirty',
-        newProperty: 'new',
-      },
-      c: 4,
-    };
-
-    expect(deepMerge(target, source)).toEqual({
-      a: 1,
-      b: {
-        newProperty: 'new',
-        overwrittenProperty: 'dirty',
-        someProperty: 1,
-      },
-      c: 4,
-    });
-  });
-
-  it('ignores merging __proto__ fields', () => {
-    const target = {};
-
-    // Bypass setters on __proto__
-    const source = JSON.parse('{"__proto__": {"pollution": true}}');
-    deepMerge(target, source);
-
-    expect(Object.prototype.hasOwnProperty('pollution')).toBe(false);
-  });
-
-  it('merges arrays', () => {
-    const target = {
-      a: 1,
-      b: [{ c: 1, d: 2 }],
-    };
-
-    const source = {
-      e: 2,
-      b: [{ f: 3 }],
-    };
-
-    expect(deepMerge(target, source)).toEqual({
-      a: 1,
-      e: 2,
-      b: [{ c: 1, d: 2, f: 3 }],
-    });
-  });
-});