Update buildQueryPlan for new Query Plan format

packages/apollo-gateway/src/QueryPlan.ts

@@ -1,28 +1,28 @@
-import {
+  import {
   FragmentDefinitionNode,
   GraphQLSchema,
   OperationDefinitionNode,
-  SelectionSetNode,
-  VariableDefinitionNode,
+  Kind,
+  SelectionNode as GraphQLJSSelectionNode
 } from 'graphql';
-import { astSerializer, queryPlanSerializer } from './snapshotSerializers';
 import prettyFormat from 'pretty-format';
+import { queryPlanSerializer, astSerializer } from './snapshotSerializers';
 
 export type ResponsePath = (string | number)[];
 
 export type FragmentMap = { [fragmentName: string]: FragmentDefinitionNode };
 
-export interface QueryPlan {
-  kind: 'QueryPlan';
-  node?: PlanNode;
-}
-
 export type OperationContext = {
   schema: GraphQLSchema;
   operation: OperationDefinitionNode;
   fragments: FragmentMap;
 };
 
+export interface QueryPlan {
+  kind: 'QueryPlan';
+  node?: PlanNode;
+}
+
 export type PlanNode = SequenceNode | ParallelNode | FetchNode | FlattenNode;
 
 export interface SequenceNode {
@@ -38,20 +38,63 @@ export interface ParallelNode {
 export interface FetchNode {
   kind: 'Fetch';
   serviceName: string;
-  selectionSet: SelectionSetNode;
-  variableUsages?: { [name: string]: VariableDefinitionNode };
-  requires?: SelectionSetNode;
-  internalFragments: Set<FragmentDefinitionNode>;
-  source: string;
+  variableUsages?: string[];
+  requires?: SelectionNode[];
+  operation: string;
 }
+
 export interface FlattenNode {
   kind: 'Flatten';
   path: ResponsePath;
   node: PlanNode;
 }
 
+export type SelectionNode = FieldNode | InlineFragmentNode;
+
+export interface FieldNode {
+  readonly kind: 'Field';
+  readonly alias?: string;
+  readonly name: string;
+  readonly selections?: SelectionNode[];
+}
+
+export interface InlineFragmentNode {
+  readonly kind: 'InlineFragment';
+  readonly typeCondition?: string;
+  readonly selections: SelectionNode[];
+}
+
 export function serializeQueryPlan(queryPlan: QueryPlan) {
   return prettyFormat(queryPlan, {
     plugins: [queryPlanSerializer, astSerializer],
   });
 }
+
+export function getResponseName(node: FieldNode): string {
+  return node.alias ? node.alias : node.name;
+}
+
+export const trimSelectionNodes = (selections: readonly GraphQLJSSelectionNode[]): SelectionNode[] => {
+  let remapped: SelectionNode[] = [];
+
+  // intentionally leaving out fragment spread from the input selections, because I don't
+  // THINK that's possible to see in the final query plan -- prove me wrong
+  selections.map(selection => {
+    if(selection.kind === Kind.FIELD){
+      remapped.push({
+        kind: Kind.FIELD,
+        name: selection.name.value,
+        selections: selection.selectionSet ? trimSelectionNodes(selection.selectionSet?.selections) : undefined
+      });
+    }
+    if(selection.kind === Kind.INLINE_FRAGMENT){
+      remapped.push({
+        kind: Kind.INLINE_FRAGMENT,
+        typeCondition: selection.typeCondition?.name.value,
+        selections: trimSelectionNodes(selection.selectionSet?.selections)
+      });
+    }
+  })
+
+  return remapped;
+}

packages/apollo-gateway/src/__tests__/buildQueryPlan.test.ts

@@ -100,7 +100,6 @@ describe('buildQueryPlan', () => {
     `;
 
     const queryPlan = buildQueryPlan(buildOperationContext(schema, query));
-
     expect(queryPlan).toMatchInlineSnapshot(`
       QueryPlan {
         Parallel {
@@ -919,13 +918,15 @@ describe('buildQueryPlan', () => {
                   ...__QueryPlanFragment_1__
                 }
               }
+
               fragment __QueryPlanFragment_1__ on Review {
                 body
                 author
                 product {
                   ...__QueryPlanFragment_0__
                 }
               }
+
               fragment __QueryPlanFragment_0__ on Product {
                 __typename
                 ... on Book {
@@ -1064,6 +1065,7 @@ describe('buildQueryPlan', () => {
                 ...__QueryPlanFragment_0__
               }
             }
+
             fragment __QueryPlanFragment_0__ on Review {
               id
               body
@@ -1105,13 +1107,15 @@ describe('buildQueryPlan', () => {
                   ...__QueryPlanFragment_1__
                 }
               }
+
               fragment __QueryPlanFragment_1__ on Review {
                 content: body
                 author
                 product {
                   ...__QueryPlanFragment_0__
                 }
               }
+
               fragment __QueryPlanFragment_0__ on Product {
                 __typename
                 ... on Book {