@apollo/gateway 0.50.2 → 0.52.1

package/src/supergraphManagers/UplinkFetcher/index.ts

@@ -1,16 +1,16 @@
-import { fetch } from 'apollo-server-env';
 import type { Logger } from '@apollo/utils.logger';
 import resolvable from '@josephg/resolvable';
 import { SupergraphManager, SupergraphSdlHookOptions } from '../../config';
 import { SubgraphHealthCheckFunction, SupergraphSdlUpdateFunction } from '../..';
 import { loadSupergraphSdlFromUplinks } from './loadSupergraphSdlFromStorage';
+import { Fetcher } from '@apollo/utils.fetcher';
 
 export interface UplinkFetcherOptions {
   fallbackPollIntervalInMs: number;
   subgraphHealthCheck?: boolean;
   graphRef: string;
   apiKey: string;
-  fetcher: typeof fetch;
+  fetcher: Fetcher;
   maxRetries: number;
   uplinkEndpoints: string[];
   logger?: Logger;

package/src/supergraphManagers/UplinkFetcher/loadSupergraphSdlFromStorage.ts

@@ -1,9 +1,13 @@
-import { fetch, Response, Request } from 'apollo-server-env';
 import { GraphQLError } from 'graphql';
 import retry from 'async-retry';
 import { SupergraphSdlUpdate } from '../../config';
 import { submitOutOfBandReportIfConfigured } from './outOfBandReporter';
 import { SupergraphSdlQuery } from '../../__generated__/graphqlTypes';
+import type {
+  Fetcher,
+  FetcherResponse,
+  FetcherRequestInit,
+} from '@apollo/utils.fetcher';
 
 // Magic /* GraphQL */ comment below is for codegen, do not remove
 export const SUPERGRAPH_SDL_QUERY = /* GraphQL */`#graphql
@@ -63,7 +67,7 @@ export async function loadSupergraphSdlFromUplinks({
   apiKey: string;
   endpoints: string[];
   errorReportingEndpoint: string | undefined,
-  fetcher: typeof fetch;
+  fetcher: Fetcher;
   compositionId: string | null;
   maxRetries: number,
   roundRobinSeed: number,
@@ -105,20 +109,21 @@ export async function loadSupergraphSdlFromStorage({
   apiKey: string;
   endpoint: string;
   errorReportingEndpoint?: string;
-  fetcher: typeof fetch;
+  fetcher: Fetcher;
   compositionId: string | null;
 }) : Promise<SupergraphSdlUpdate | null> {
-  let result: Response;
-  const requestDetails = {
+  const requestBody = JSON.stringify({
+    query: SUPERGRAPH_SDL_QUERY,
+    variables: {
+      ref: graphRef,
+      apiKey,
+      ifAfterId: compositionId,
+    },
+  })
+
+  const requestDetails: FetcherRequestInit = {
     method: 'POST',
-    body: JSON.stringify({
-      query: SUPERGRAPH_SDL_QUERY,
-      variables: {
-        ref: graphRef,
-        apiKey,
-        ifAfterId: compositionId,
-      },
-    }),
+    body: requestBody,
     headers: {
       'apollographql-client-name': name,
       'apollographql-client-version': version,
@@ -127,9 +132,8 @@ export async function loadSupergraphSdlFromStorage({
     },
   };
 
-  const request: Request = new Request(endpoint, requestDetails);
-
   const startTime = new Date();
+  let result: FetcherResponse;
   try {
     result = await fetcher(endpoint, requestDetails);
   } catch (e) {
@@ -137,7 +141,8 @@ export async function loadSupergraphSdlFromStorage({
 
     await submitOutOfBandReportIfConfigured({
       error: e,
-      request,
+      requestEndpoint: endpoint,
+      requestBody,
       endpoint: errorReportingEndpoint,
       startedAt: startTime,
       endedAt: endTime,
@@ -168,7 +173,8 @@ export async function loadSupergraphSdlFromStorage({
   } else {
     await submitOutOfBandReportIfConfigured({
       error: new UplinkFetcherError(fetchErrorMsg + result.status + ' ' + result.statusText),
-      request,
+      requestEndpoint: endpoint,
+      requestBody,
       endpoint: errorReportingEndpoint,
       response: result,
       startedAt: startTime,

package/src/supergraphManagers/UplinkFetcher/outOfBandReporter.ts

@@ -1,4 +1,4 @@
-import { fetch, Response, Request } from 'apollo-server-env';
+import { Fetcher, FetcherResponse } from '@apollo/utils.fetcher';
 import { GraphQLError } from 'graphql';
 import {
   ErrorCode,
@@ -30,7 +30,8 @@ interface OobReportMutationFailure {
 
 export async function submitOutOfBandReportIfConfigured({
   error,
-  request,
+  requestEndpoint,
+  requestBody,
   endpoint,
   response,
   startedAt,
@@ -39,13 +40,14 @@ export async function submitOutOfBandReportIfConfigured({
   fetcher,
 }: {
   error: Error;
-  request: Request;
+  requestEndpoint: string;
+  requestBody: string;
   endpoint: string | undefined;
-  response?: Response;
+  response?: FetcherResponse;
   startedAt: Date;
   endedAt: Date;
   tags?: string[];
-  fetcher: typeof fetch;
+  fetcher: Fetcher;
 }) {
   // don't send report if the endpoint url is not configured
   if (!endpoint) {
@@ -85,8 +87,8 @@ export async function submitOutOfBandReportIfConfigured({
         message: error.message,
       },
       request: {
-        url: request.url,
-        body: await request.text(),
+        url: requestEndpoint,
+        body: requestBody,
       },
       response: response
         ? {

package/dist/cache.d.ts

@@ -1,18 +0,0 @@
-import { CacheManager } from 'make-fetch-happen';
-import { Request, Response, Headers } from 'apollo-server-env';
-import { InMemoryLRUCache } from 'apollo-server-caching';
-interface CachedRequest {
-    body: string;
-    status: number;
-    statusText: string;
-    headers: Headers;
-}
-export declare class HttpRequestCache implements CacheManager {
-    cache: InMemoryLRUCache<CachedRequest>;
-    constructor(cache?: InMemoryLRUCache<CachedRequest>);
-    delete(request: Request): Promise<boolean>;
-    put(request: Request, response: Response): Promise<Response>;
-    match(request: Request): Promise<Response | undefined>;
-}
-export {};
-//# sourceMappingURL=cache.d.ts.map

package/dist/cache.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../src/cache.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAQzD,UAAU,aAAa;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;CACpB;AAED,qBAAa,gBAAiB,YAAW,YAAY;IAE1C,KAAK,EAAE,gBAAgB,CAAC,aAAa,CAAC;gBAAtC,KAAK,GAAE,gBAAgB,CAAC,aAAa,CAE1C;IAIE,MAAM,CAAC,OAAO,EAAE,OAAO;IAOvB,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ;IAwBxC,KAAK,CAAC,OAAO,EAAE,OAAO;CAS7B"}

package/dist/cache.js

@@ -1,46 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HttpRequestCache = void 0;
-const apollo_server_env_1 = require("apollo-server-env");
-const apollo_server_caching_1 = require("apollo-server-caching");
-const MAX_SIZE = 5 * 1024 * 1024;
-function cacheKey(request) {
-    return `gateway:request-cache:${request.method}:${request.url}`;
-}
-class HttpRequestCache {
-    constructor(cache = new apollo_server_caching_1.InMemoryLRUCache({
-        maxSize: MAX_SIZE,
-    })) {
-        this.cache = cache;
-    }
-    async delete(request) {
-        const key = cacheKey(request);
-        const entry = await this.cache.get(key);
-        await this.cache.delete(key);
-        return Boolean(entry);
-    }
-    async put(request, response) {
-        if (request.method === "HEAD" || response.status === 304) {
-            return response;
-        }
-        const body = await response.text();
-        this.cache.set(cacheKey(request), {
-            body,
-            status: response.status,
-            statusText: response.statusText,
-            headers: response.headers,
-        });
-        return new apollo_server_env_1.Response(body, response);
-    }
-    async match(request) {
-        return this.cache.get(cacheKey(request)).then(response => {
-            if (response) {
-                const { body, ...requestInit } = response;
-                return new apollo_server_env_1.Response(body, requestInit);
-            }
-            return;
-        });
-    }
-}
-exports.HttpRequestCache = HttpRequestCache;
-//# sourceMappingURL=cache.js.map

package/dist/cache.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"cache.js","sourceRoot":"","sources":["../src/cache.ts"],"names":[],"mappings":";;;AACA,yDAA+D;AAC/D,iEAAyD;AAEzD,MAAM,QAAQ,GAAG,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC;AAEjC,SAAS,QAAQ,CAAC,OAAgB;IAChC,OAAO,yBAAyB,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;AAClE,CAAC;AASD,MAAa,gBAAgB;IAC3B,YACS,QAAyC,IAAI,wCAAgB,CAAC;QACnE,OAAO,EAAE,QAAQ;KAClB,CAAC;QAFK,UAAK,GAAL,KAAK,CAEV;IACD,CAAC;IAGJ,KAAK,CAAC,MAAM,CAAC,OAAgB;QAC3B,MAAM,GAAG,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC9B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACxC,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC7B,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC;IACxB,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,OAAgB,EAAE,QAAkB;QAQ5C,IAAI,OAAO,CAAC,MAAM,KAAK,MAAM,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;YACxD,OAAO,QAAQ,CAAC;SACjB;QAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAEnC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;YAChC,IAAI;YACJ,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,UAAU,EAAE,QAAQ,CAAC,UAAU;YAC/B,OAAO,EAAE,QAAQ,CAAC,OAAO;SAC1B,CAAC,CAAC;QAEH,OAAO,IAAI,4BAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,OAAgB;QAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;YACvD,IAAI,QAAQ,EAAE;gBACZ,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,EAAE,GAAG,QAAQ,CAAC;gBAC1C,OAAO,IAAI,4BAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;aACxC;YACD,OAAO;QACT,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAhDD,4CAgDC"}

package/src/__mocks__/apollo-server-env.ts

@@ -1,56 +0,0 @@
-import {
-  fetch,
-  Request,
-  Response,
-  Body,
-  BodyInit,
-  Headers,
-  HeadersInit,
-  URL,
-  URLSearchParams,
-} from 'apollo-server-env';
-interface FetchMock extends jest.MockedFunction<typeof fetch> {
-  mockResponseOnce(data?: any, headers?: HeadersInit, status?: number): this;
-  mockJSONResponseOnce(data?: object, headers?: HeadersInit): this;
-}
-
-const mockFetch = jest.fn(fetch) as unknown as FetchMock;
-
-mockFetch.mockResponseOnce = (
-  data?: BodyInit,
-  headers?: Headers,
-  status: number = 200,
-) => {
-  return mockFetch.mockImplementationOnce(async () => {
-    return new Response(data, {
-      status,
-      headers,
-    });
-  });
-};
-
-mockFetch.mockJSONResponseOnce = (
-  data = {},
-  headers?: Headers,
-  status?: number,
-) => {
-  return mockFetch.mockResponseOnce(
-    JSON.stringify(data),
-    Object.assign({ 'Content-Type': 'application/json' }, headers),
-    status,
-  );
-};
-
-const env = {
-  fetch: mockFetch,
-  Request,
-  Response,
-  Body,
-  Headers,
-  URL,
-  URLSearchParams,
-};
-
-jest.doMock('apollo-server-env', () => env);
-
-export = env;

package/src/__mocks__/make-fetch-happen-fetcher.ts

@@ -1,57 +0,0 @@
-/// <reference path="../make-fetch-happen.d.ts" />
-// This explicit reference shouldn't be needed because the project references
-// the main project, which includes these type declarations. For some reason,
-// VS Code doesn't pick that up though.
-// (This may be related to https://github.com/microsoft/TypeScript/issues/36708.)
-
-import {
-  fetch,
-  Response,
-  BodyInit,
-  Headers,
-  HeadersInit
-} from 'apollo-server-env';
-
-import fetcher from 'make-fetch-happen';
-
-interface MakeFetchHappenMock extends jest.MockedFunction<typeof fetch> {
-  mockResponseOnce(data?: any, headers?: HeadersInit, status?: number): this;
-  mockJSONResponseOnce(data?: object, headers?: HeadersInit): this;
-}
-
-const mockMakeFetchHappen = jest.fn(fetcher) as unknown as MakeFetchHappenMock;
-const defaults = () => mockMakeFetchHappen;
-
-mockMakeFetchHappen.mockResponseOnce = (
-  data?: BodyInit,
-  headers?: Headers,
-  status: number = 200,
-) => {
-  return mockMakeFetchHappen.mockImplementationOnce(async () => {
-    return new Response(data, {
-      status,
-      headers,
-    });
-  });
-};
-
-mockMakeFetchHappen.mockJSONResponseOnce = (
-  data = {},
-  headers?: Headers,
-  status?: number,
-) => {
-  return mockMakeFetchHappen.mockResponseOnce(
-    JSON.stringify(data),
-    Object.assign({ 'Content-Type': 'application/json' }, headers),
-    status,
-  );
-};
-
-const makeFetchMock = {
-  fetch: mockMakeFetchHappen,
-  defaults,
-};
-
-jest.doMock('make-fetch-happen', () => makeFetchMock);
-
-export = makeFetchMock;

package/src/cache.ts

@@ -1,66 +0,0 @@
-import { CacheManager } from 'make-fetch-happen';
-import { Request, Response, Headers } from 'apollo-server-env';
-import { InMemoryLRUCache } from 'apollo-server-caching';
-
-const MAX_SIZE = 5 * 1024 * 1024; // 5MB
-
-function cacheKey(request: Request) {
-  return `gateway:request-cache:${request.method}:${request.url}`;
-}
-
-interface CachedRequest {
-    body: string;
-    status: number;
-    statusText: string;
-    headers: Headers;
-}
-
-export class HttpRequestCache implements CacheManager {
-  constructor(
-    public cache: InMemoryLRUCache<CachedRequest> = new InMemoryLRUCache({
-      maxSize: MAX_SIZE,
-    }),
-  ) {}
-
-  // Return true if entry exists, else false
-  async delete(request: Request) {
-    const key = cacheKey(request);
-    const entry = await this.cache.get(key);
-    await this.cache.delete(key);
-    return Boolean(entry);
-  }
-
-  async put(request: Request, response: Response) {
-    // A `HEAD` request has no body to cache and a 304 response could have
-    // only been negotiated by using a cached body that was still valid.
-    // Therefore, we do NOT write to the cache in either of these cases.
-    // Without avoiding this, we will invalidate the cache, thus causing
-    // subsequent conditional requests (e.g., `If-None-Match: "MD%") to be
-    // lacking content to conditionally request against and necessitating
-    // a full request/response.
-    if (request.method === "HEAD" || response.status === 304) {
-      return response;
-    }
-
-    const body = await response.text();
-
-    this.cache.set(cacheKey(request), {
-      body,
-      status: response.status,
-      statusText: response.statusText,
-      headers: response.headers,
-    });
-
-    return new Response(body, response);
-  }
-
-  async match(request: Request) {
-    return this.cache.get(cacheKey(request)).then(response => {
-      if (response) {
-        const { body, ...requestInit } = response;
-        return new Response(body, requestInit);
-      }
-      return;
-    });
-  }
-}

package/src/make-fetch-happen.d.ts

@@ -1,59 +0,0 @@
-/**
- * We are attempting to get types included natively in this package, but it
- * has not happened, yet!
- *
- * See https://github.com/npm/make-fetch-happen/issues/20
- */
-declare module 'make-fetch-happen' {
-  import {
-    Response,
-    Request,
-    RequestInfo,
-    RequestInit,
-  } from 'apollo-server-env';
-
-  // If adding to these options, they should mirror those from `make-fetch-happen`
-  // @see: https://github.com/npm/make-fetch-happen/#extra-options
-  export interface FetcherOptions {
-    cacheManager?: string | CacheManager;
-    // @see: https://www.npmjs.com/package/retry#retrytimeoutsoptions
-    retry?:
-      | boolean
-      | number
-      | {
-          //  The maximum amount of times to retry the operation. Default is 10. Seting this to 1 means do it once, then retry it once
-          retries?: number;
-          // The exponential factor to use. Default is 2.
-          factor?: number;
-          // The number of milliseconds before starting the first retry. Default is 1000.
-          minTimeout?: number;
-          // The maximum number of milliseconds between two retries. Default is Infinity.
-          maxTimeout?: number;
-          // Randomizes the timeouts by multiplying with a factor between 1 to 2. Default is false.
-          randomize?: boolean;
-        };
-    onRetry?(): void;
-  }
-
-  export interface CacheManager {
-    delete(req: Request): Promise<Boolean>;
-    put(req: Request, res: Response): Promise<Response>;
-    match(req: Request): Promise<Response | undefined>;
-  }
-
-  /**
-   * This is an augmentation of the fetch function types provided by `apollo-server-env`
-   * @see: https://git.io/JvBwX
-   */
-  export interface Fetcher {
-    (input?: RequestInfo, init?: RequestInit & FetcherOptions): Promise<
-      Response
-    >;
-  }
-
-  let fetch: Fetcher & {
-    defaults(opts?: RequestInit & FetcherOptions): typeof fetch;
-  };
-
-  export default fetch;
-}