@apollo/gateway 0.48.1 → 0.50.0

package/src/__tests__/buildQueryPlan.test.ts

@@ -7,7 +7,12 @@ import {
   fixturesWithUpdate,
 } from 'apollo-federation-integration-testsuite';
 import { getFederatedTestingSchema } from './execution-utils';
-import { QueryPlanner, FetchNode } from '@apollo/query-planner';
+import {
+  QueryPlanner,
+  FetchNode,
+  SequenceNode,
+  FlattenNode,
+} from '@apollo/query-planner';
 
 expect.addSnapshotSerializer(astSerializer);
 expect.addSnapshotSerializer(queryPlanSerializer);
@@ -1935,4 +1940,270 @@ describe('buildQueryPlan', () => {
       );
     });
   });
+
+  it(`when key is marked external inside another type`, () => {
+    const operationString = `#graphql
+      query {
+          libraryAccount {
+            description
+            library {
+              id
+              name
+            }
+          }
+        }
+    `;
+
+    const operationDocument = gql(operationString);
+
+    const queryPlan = queryPlanner.buildQueryPlan(
+      buildOperationContext({
+        schema,
+        operationDocument,
+      }),
+    );
+
+    expect(queryPlan).toMatchInlineSnapshot(`
+      QueryPlan {
+        Fetch(service: "accounts") {
+          {
+            libraryAccount {
+              description
+              library {
+                id
+                name
+              }
+            }
+          }
+        },
+      }
+    `);
+  });
+  
+  describe('fetch operation names', () => {
+    it('handle subgraph with - in the name', () => {
+      const subgraph1 = {
+        name: 'S1',
+        typeDefs: gql`
+          type Query {
+            t: T
+          }
+          type T @key(fields: "id") {
+            id: ID!
+          }
+        `,
+      };
+
+      const subgraph2 = {
+        name: 'non-graphql-name',
+        typeDefs: gql`
+          extend type T @key(fields: "id") {
+            id: ID! @external
+            x: Int
+          }
+        `,
+      };
+
+      ({ schema, queryPlanner } = getFederatedTestingSchema([
+        subgraph1,
+        subgraph2,
+      ]));
+
+      const operationDocument = gql`
+        query myOp {
+          t {
+            x
+          }
+        }
+      `;
+
+      const plan = queryPlanner.buildQueryPlan(
+        buildOperationContext({ schema, operationDocument }),
+      );
+
+      expect(plan).toMatchInlineSnapshot(`
+        QueryPlan {
+          Sequence {
+            Fetch(service: "S1") {
+              {
+                t {
+                  __typename
+                  id
+                }
+              }
+            },
+            Flatten(path: "t") {
+              Fetch(service: "non-graphql-name") {
+                {
+                  ... on T {
+                    __typename
+                    id
+                  }
+                } =>
+                {
+                  ... on T {
+                    x
+                  }
+                }
+              },
+            },
+          },
+        }
+      `);
+      const fetch = ((plan.node as SequenceNode).nodes[1] as FlattenNode)
+        .node as FetchNode;
+      expect(fetch.operation).toMatch(/^query myOp__non_graphql_name__1.*/i);
+    });
+
+    it('ensures sanitization applies repeatedly', () => {
+      const subgraph1 = {
+        name: 'S1',
+        typeDefs: gql`
+          type Query {
+            t: T
+          }
+          type T @key(fields: "id") {
+            id: ID!
+          }
+        `,
+      };
+
+      const subgraph2 = {
+        name: 'a-na&me-with-plen&ty-replace*ments',
+        typeDefs: gql`
+          extend type T @key(fields: "id") {
+            id: ID! @external
+            x: Int
+          }
+        `,
+      };
+
+      ({ schema, queryPlanner } = getFederatedTestingSchema([
+        subgraph1,
+        subgraph2,
+      ]));
+
+      const operationDocument = gql`
+        query myOp {
+          t {
+            x
+          }
+        }
+      `;
+
+      const plan = queryPlanner.buildQueryPlan(
+        buildOperationContext({ schema, operationDocument }),
+      );
+
+      expect(plan).toMatchInlineSnapshot(`
+        QueryPlan {
+          Sequence {
+            Fetch(service: "S1") {
+              {
+                t {
+                  __typename
+                  id
+                }
+              }
+            },
+            Flatten(path: "t") {
+              Fetch(service: "a-na&me-with-plen&ty-replace*ments") {
+                {
+                  ... on T {
+                    __typename
+                    id
+                  }
+                } =>
+                {
+                  ... on T {
+                    x
+                  }
+                }
+              },
+            },
+          },
+        }
+      `);
+
+      const fetch = ((plan.node as SequenceNode).nodes[1] as FlattenNode)
+        .node as FetchNode;
+      expect(fetch.operation).toMatch(
+        /^query myOp__a_name_with_plenty_replacements__1.*/i,
+      );
+    });
+
+    it('handle very non-graph subgraph name', () => {
+      const subgraph1 = {
+        name: 'S1',
+        typeDefs: gql`
+          type Query {
+            t: T
+          }
+          type T @key(fields: "id") {
+            id: ID!
+          }
+        `,
+      };
+
+      const subgraph2 = {
+        name: '42!',
+        typeDefs: gql`
+          extend type T @key(fields: "id") {
+            id: ID! @external
+            x: Int
+          }
+        `,
+      };
+
+      ({ schema, queryPlanner } = getFederatedTestingSchema([
+        subgraph1,
+        subgraph2,
+      ]));
+
+      const operationDocument = gql`
+        query myOp {
+          t {
+            x
+          }
+        }
+      `;
+
+      const plan = queryPlanner.buildQueryPlan(
+        buildOperationContext({ schema, operationDocument }),
+      );
+      expect(plan).toMatchInlineSnapshot(`
+        QueryPlan {
+          Sequence {
+            Fetch(service: "S1") {
+              {
+                t {
+                  __typename
+                  id
+                }
+              }
+            },
+            Flatten(path: "t") {
+              Fetch(service: "42!") {
+                {
+                  ... on T {
+                    __typename
+                    id
+                  }
+                } =>
+                {
+                  ... on T {
+                    x
+                  }
+                }
+              },
+            },
+          },
+        }
+      `);
+      const fetch = ((plan.node as SequenceNode).nodes[1] as FlattenNode)
+        .node as FetchNode;
+
+      expect(fetch.operation).toMatch(/^query myOp___42__1.*/i);
+    });
+  });
 });

package/src/__tests__/gateway/lifecycle-hooks.test.ts

@@ -135,13 +135,13 @@ describe('lifecycle hooks', () => {
 
     const [firstCall, secondCall] = mockDidUpdate.mock.calls;
 
-    const expectedFirstId = '562c22b3382b56b1651944a96e89a361fe847b9b32660eae5ecbd12adc20bf8b'
+    const expectedFirstId = '1cb734eadae95dd1778f3fe3c9df6cbaecb95e80c2bcefed397c63ec72469032'
     expect(firstCall[0]!.compositionId).toEqual(expectedFirstId);
     // first call should have no second "previous" argument
     expect(firstCall[1]).toBeUndefined();
 
     expect(secondCall[0]!.compositionId).toEqual(
-      '0ced02894592ade4376276d11735b46723eb84850c32765cb78502ba5c29a563',
+      '5d24c0f42d0d372c2ad671567cee186e3680400dffbcc3430cb57b9dc04b2be2',
     );
     // second call should have previous info in the second arg
     expect(secondCall[1]!.compositionId).toEqual(expectedFirstId);
@@ -177,7 +177,7 @@ describe('lifecycle hooks', () => {
     );
   });
 
-  it('registers schema change callbacks when experimental_pollInterval is set for unmanaged configs', async () => {
+  it('registers schema change callbacks when pollIntervalInMs is set for unmanaged configs', async () => {
     const experimental_updateServiceDefinitions: Experimental_UpdateServiceDefinitions =
       jest.fn(async (_config) => {
         return { serviceDefinitions, isNewSchema: true };

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

@@ -228,6 +228,7 @@ describe('reporting', () => {
           "seconds": "1562203363",
         },
         "header": "<HEADER>",
+        "operationCount": 1,
         "tracesPerQuery": Object {
           "# -
       {me{name{first last}}topProducts{name}}": Object {
@@ -299,6 +300,7 @@ describe('reporting', () => {
                               "nanos": 123000000,
                               "seconds": "1562203363",
                             },
+                            "fieldExecutionWeight": 1,
                             "root": Object {
                               "child": Array [
                                 Object {
@@ -364,6 +366,7 @@ describe('reporting', () => {
                                     "nanos": 123000000,
                                     "seconds": "1562203363",
                                   },
+                                  "fieldExecutionWeight": 1,
                                   "root": Object {
                                     "child": Array [
                                       Object {
@@ -465,6 +468,7 @@ describe('reporting', () => {
                                         "nanos": 123000000,
                                         "seconds": "1562203363",
                                       },
+                                      "fieldExecutionWeight": 1,
                                       "root": Object {
                                         "child": Array [
                                           Object {
@@ -568,6 +572,7 @@ describe('reporting', () => {
                                         "nanos": 123000000,
                                         "seconds": "1562203363",
                                       },
+                                      "fieldExecutionWeight": 1,
                                       "root": Object {
                                         "child": Array [
                                           Object {

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

@@ -184,7 +184,7 @@ describe('Using supergraphSdl dynamic configuration', () => {
     const { state, compositionId } = gateway.__testing();
     expect(state.phase).toEqual('loaded');
     expect(compositionId).toEqual(
-      '562c22b3382b56b1651944a96e89a361fe847b9b32660eae5ecbd12adc20bf8b',
+      '1cb734eadae95dd1778f3fe3c9df6cbaecb95e80c2bcefed397c63ec72469032',
     );
 
     await gateway.stop();
@@ -209,7 +209,7 @@ describe('Using supergraphSdl dynamic configuration', () => {
     const { state, compositionId } = gateway.__testing();
     expect(state.phase).toEqual('loaded');
     expect(compositionId).toEqual(
-      '562c22b3382b56b1651944a96e89a361fe847b9b32660eae5ecbd12adc20bf8b',
+      '1cb734eadae95dd1778f3fe3c9df6cbaecb95e80c2bcefed397c63ec72469032',
     );
 
     await expect(healthCheckCallback!(supergraphSdl)).resolves.toBeUndefined();
@@ -291,7 +291,7 @@ describe('Using supergraphSdl dynamic configuration', () => {
       const { state, compositionId } = gateway.__testing();
       expect(state.phase).toEqual('loaded');
       expect(compositionId).toEqual(
-        '562c22b3382b56b1651944a96e89a361fe847b9b32660eae5ecbd12adc20bf8b',
+        '1cb734eadae95dd1778f3fe3c9df6cbaecb95e80c2bcefed397c63ec72469032',
       );
 
       await expect(healthCheckCallback!(supergraphSdl)).rejects.toThrowError(

package/src/__tests__/integration/abstract-types.test.ts

@@ -297,7 +297,7 @@ it('prunes unfilled type conditions', async () => {
 
 it('fetches interfaces returned from other services', async () => {
   const query = `#graphql
-    query GetUserAndProducts {
+    query GetUserAndProductsWithPriceAndTitle {
       me {
         reviews {
           product {
@@ -412,7 +412,7 @@ it('fetches interfaces returned from other services', async () => {
 
 it('fetches composite fields from a foreign type casted to an interface [@provides field]', async () => {
   const query = `#graphql
-    query GetUserAndProducts {
+    query GetUserAndProductsWithPriceAndName {
       me {
         reviews {
           product {
@@ -624,7 +624,7 @@ it('allows for extending an interface from another service with fields', async (
 describe('unions', () => {
   it('handles unions from the same service', async () => {
     const query = `#graphql
-      query GetUserAndProducts {
+      query GetUserAndProductsWithBrandInfo {
         me {
           reviews {
             product {

package/src/__tests__/integration/configuration.test.ts

@@ -443,15 +443,4 @@ describe('deprecation warnings', () => {
       'The `schemaConfigDeliveryEndpoint` option is deprecated and will be removed in a future version of `@apollo/gateway`. Please migrate to the equivalent (array form) `uplinkEndpoints` configuration option.',
     );
   });
-
-  it('warns with `experimental_pollInterval` option set', async () => {
-    new ApolloGateway({
-      experimental_pollInterval: 10000,
-      logger,
-    });
-
-    expect(logger.warn).toHaveBeenCalledWith(
-      'The `experimental_pollInterval` option is deprecated and will be removed in a future version of `@apollo/gateway`. Please migrate to the equivalent `pollIntervalInMs` configuration option.',
-    );
-  });
 });

package/src/__tests__/integration/requires.test.ts

@@ -6,7 +6,7 @@ expect.addSnapshotSerializer(astSerializer);
 expect.addSnapshotSerializer(queryPlanSerializer);
 it('supports passing additional fields defined by a requires', async () => {
   const query = `#graphql
-    query GetReviwedBookNames {
+    query GetReviewedBookNames {
       me {
         reviews {
           product {

package/src/__tests__/integration/value-types.test.ts

@@ -22,7 +22,7 @@ describe('value types', () => {
         }
       }
 
-      query ProducsWithMetadata {
+      query ProductsWithMetadata {
         topProducts(first: 10) {
           upc
           ... on Book {

package/src/config.ts

@@ -81,6 +81,7 @@ export interface ServiceDefinitionUpdate {
 export interface SupergraphSdlUpdate {
   id: string;
   supergraphSdl: string;
+  minDelaySeconds?: number;
 }
 
 export function isSupergraphSdlUpdate(
@@ -125,11 +126,6 @@ interface GatewayConfigBase {
   // experimental observability callbacks
   experimental_didResolveQueryPlan?: Experimental_DidResolveQueryPlanCallback;
   experimental_didUpdateSupergraph?: Experimental_DidUpdateSupergraphCallback;
-  /**
-   * @deprecated use `pollIntervalInMs` instead
-   */
-  experimental_pollInterval?: number;
-  pollIntervalInMs?: number;
   experimental_approximateQueryPlanStoreMiB?: number;
   experimental_autoFragmentization?: boolean;
   fetcher?: typeof fetch;
@@ -150,6 +146,7 @@ export interface ServiceListGatewayConfig extends GatewayConfigBase {
     | ((
         service: ServiceEndpointDefinition,
       ) => Promise<HeadersInit> | HeadersInit);
+  pollIntervalInMs?: number;
 }
 
 export interface ManagedGatewayConfig extends GatewayConfigBase {
@@ -168,6 +165,11 @@ export interface ManagedGatewayConfig extends GatewayConfigBase {
    */
   uplinkEndpoints?: string[];
   uplinkMaxRetries?: number;
+  /**
+   * @deprecated use `fallbackPollIntervalInMs` instead
+   */
+  pollIntervalInMs?: number;
+  fallbackPollIntervalInMs?: number;
 }
 
 // TODO(trevor:removeServiceList): migrate users to `supergraphSdl` function option
@@ -176,6 +178,7 @@ interface ManuallyManagedServiceDefsGatewayConfig extends GatewayConfigBase {
    * @deprecated: use `supergraphSdl` instead (either as a `SupergraphSdlHook` or `SupergraphManager`)
    */
   experimental_updateServiceDefinitions: Experimental_UpdateServiceDefinitions;
+  pollIntervalInMs?: number;
 }
 
 // TODO(trevor:removeServiceList): migrate users to `supergraphSdl` function option
@@ -185,6 +188,7 @@ interface ExperimentalManuallyManagedSupergraphSdlGatewayConfig
    * @deprecated: use `supergraphSdl` instead (either as a `SupergraphSdlHook` or `SupergraphManager`)
    */
   experimental_updateSupergraphSdl: Experimental_UpdateSupergraphSdl;
+  pollIntervalInMs?: number;
 }
 
 export function isManuallyManagedSupergraphSdlGatewayConfig(
@@ -238,7 +242,7 @@ type ManuallyManagedGatewayConfig =
   | ManuallyManagedServiceDefsGatewayConfig
   | ExperimentalManuallyManagedSupergraphSdlGatewayConfig
   | ManuallyManagedSupergraphSdlGatewayConfig
-  // TODO(trevor:removeServiceList
+  // TODO(trevor:removeServiceList)
   | ServiceListGatewayConfig;
 
 // TODO(trevor:removeServiceList)
@@ -322,6 +326,7 @@ export function isManagedConfig(
   return (
     'schemaConfigDeliveryEndpoint' in config ||
     'uplinkEndpoints' in config ||
+    'fallbackPollIntervalInMs' in config ||
     (!isLocalConfig(config) &&
       !isStaticSupergraphSdlConfig(config) &&
       !isManuallyManagedConfig(config))

package/src/executeQueryPlan.ts

@@ -329,6 +329,7 @@ async function executeFetch<TContext>(
             context,
             fetch.operation,
             variables,
+            fetch.operationName,
         );
 
         for (const entity of entities) {
@@ -364,6 +365,7 @@ async function executeFetch<TContext>(
             context,
             fetch.operation,
             {...variables, representations},
+            fetch.operationName,
         );
 
         if (!dataReceivedFromService) {
@@ -405,6 +407,7 @@ async function executeFetch<TContext>(
     context: ExecutionContext<TContext>,
     source: string,
     variables: Record<string, any>,
+    operationName: string | undefined,
   ): Promise<ResultMap | void | null> {
     // We declare this as 'any' because it is missing url and method, which
     // GraphQLRequest.http is supposed to have if it exists.
@@ -433,6 +436,7 @@ async function executeFetch<TContext>(
       request: {
         query: source,
         variables,
+        operationName,
         http,
       },
       incomingRequestContext: context.requestContext,

package/src/index.ts

@@ -202,8 +202,12 @@ export class ApolloGateway implements GraphQLService {
     this.experimental_didUpdateSupergraph =
       config?.experimental_didUpdateSupergraph;
 
-    this.pollIntervalInMs =
-      config?.pollIntervalInMs ?? config?.experimental_pollInterval;
+    if (isManagedConfig(this.config)) {
+      this.pollIntervalInMs =
+        this.config.fallbackPollIntervalInMs ?? this.config.pollIntervalInMs;
+    } else if (isServiceListConfig(this.config)) {
+      this.pollIntervalInMs = this.config?.pollIntervalInMs;
+    }
 
     this.issueConfigurationWarningsIfApplicable();
 
@@ -254,7 +258,7 @@ export class ApolloGateway implements GraphQLService {
         'Polling Apollo services at a frequency of less than once per 10 ' +
           'seconds (10000) is disallowed. Instead, the minimum allowed ' +
           'pollInterval of 10000 will be used. Please reconfigure your ' +
-          '`pollIntervalInMs` accordingly. If this is problematic for ' +
+          '`fallbackPollIntervalInMs` accordingly. If this is problematic for ' +
           'your team, please contact support.',
       );
     }
@@ -288,9 +292,11 @@ export class ApolloGateway implements GraphQLService {
       );
     }
 
-    if ('experimental_pollInterval' in this.config) {
+    if (isManagedConfig(this.config) && 'pollIntervalInMs' in this.config) {
       this.logger.warn(
-        'The `experimental_pollInterval` option is deprecated and will be removed in a future version of `@apollo/gateway`. Please migrate to the equivalent `pollIntervalInMs` configuration option.',
+        'The `pollIntervalInMs` option is deprecated and will be removed in a future version of `@apollo/gateway`. ' +
+        'Please migrate to the equivalent `fallbackPollIntervalInMs` configuration option. ' +
+        'The poll interval is now defined by Uplink, this option will only be used if it is greater than the value defined by Uplink or as a fallback.',
       );
     }
   }
@@ -404,7 +410,7 @@ export class ApolloGateway implements GraphQLService {
           subgraphHealthCheck: this.config.serviceHealthCheck,
           fetcher: this.fetcher,
           logger: this.logger,
-          pollIntervalInMs: this.pollIntervalInMs ?? 10000,
+          fallbackPollIntervalInMs: this.pollIntervalInMs ?? 10000,
         }),
       );
     }

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

@@ -65,6 +65,7 @@ describe('loadSupergraphSdlFromStorage', () => {
       compositionId: "originalId-1234",
       maxRetries: 1,
       roundRobinSeed: 0,
+      earliestFetchTime: null,
     });
 
     expect(result).toMatchObject({
@@ -88,6 +89,7 @@ describe('loadSupergraphSdlFromStorage', () => {
         compositionId: "originalId-1234",
         maxRetries: 1,
         roundRobinSeed: 0,
+        earliestFetchTime: null,
       }),
     ).rejects.toThrowError(
       new UplinkFetcherError(
@@ -388,10 +390,49 @@ describe("loadSupergraphSdlFromUplinks", () => {
       compositionId: "id-1234",
       maxRetries: 5,
       roundRobinSeed: 0,
+      earliestFetchTime: null,
     });
 
     expect(result).toBeNull();
     expect(fetcher).toHaveBeenCalledTimes(1);
   });
+
+  it("Waits the correct time before retrying", async () => {
+    const timeoutSpy = jest.spyOn(global, 'setTimeout');
+
+    mockSupergraphSdlRequest('originalId-1234', mockCloudConfigUrl1).reply(500);
+    mockSupergraphSdlRequestIfAfter('originalId-1234', mockCloudConfigUrl2).reply(
+      200,
+      JSON.stringify({
+        data: {
+          routerConfig: {
+            __typename: 'RouterConfigResult',
+            id: 'originalId-1234',
+            supergraphSdl: getTestingSupergraphSdl()
+          },
+        },
+      }),
+    );
+    const fetcher = getDefaultFetcher();
+
+    await loadSupergraphSdlFromUplinks({
+      graphRef,
+      apiKey,
+      endpoints: [mockCloudConfigUrl1, mockCloudConfigUrl2],
+      errorReportingEndpoint: undefined,
+      fetcher: fetcher,
+      compositionId: "originalId-1234",
+      maxRetries: 1,
+      roundRobinSeed: 0,
+      earliestFetchTime: new Date(Date.now() + 1000),
+    });
+
+    // test if setTimeout was called with a value in range to deal with time jitter
+    const setTimeoutCall = timeoutSpy.mock.calls[1][1];
+    expect(setTimeoutCall).toBeLessThanOrEqual(1000);
+    expect(setTimeoutCall).toBeGreaterThanOrEqual(900);
+
+    timeoutSpy.mockRestore();
+  });
 });