feat(incontext-sdk): autoSelectionSetWithDepth option

ardatan · Aug 10, 2023 · d8da4b2 · d8da4b2
1 parent a720179
commit d8da4b2
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 14 deletions.
diff --git a/.changeset/rude-numbers-check.md b/.changeset/rude-numbers-check.md
@@ -0,0 +1,7 @@
+---
+'@graphql-mesh/runtime': patch
+'@graphql-mesh/types': patch
+---
+
+New `autoSelectionSetWithDepth` option in the incontext sdk to avoid users to write manual selection
+sets if return types don't match
diff --git a/examples/openapi-javascript-wiki/additional-resolvers.ts b/examples/openapi-javascript-wiki/additional-resolvers.ts
@@ -18,15 +18,7 @@ export const resolvers: Resolvers = {
             },
             context,
             info,
-            selectionSet: /* GraphQL */ `
-              {
-                ... on pageview_project {
-                  items {
-                    views
-                  }
-                }
-              }
-            `,
+            autoSelectionSetWithDepth: 2,
           },
         );
 

diff --git a/packages/runtime/src/in-context-sdk.ts b/packages/runtime/src/in-context-sdk.ts
@@ -1,5 +1,6 @@
 import {
   DocumentNode,
+  FieldNode,
   getNamedType,
   GraphQLObjectType,
   GraphQLResolveInfo,
@@ -8,6 +9,7 @@ import {
   Kind,
   OperationDefinitionNode,
   OperationTypeNode,
+  print,
   SelectionSetNode,
 } from 'graphql';
 import {
@@ -26,7 +28,7 @@ import {
   StitchingInfo,
   SubschemaConfig,
 } from '@graphql-tools/delegate';
-import { isDocumentNode, memoize1 } from '@graphql-tools/utils';
+import { buildOperationNodeForField, isDocumentNode, memoize1 } from '@graphql-tools/utils';
 import { WrapQuery } from '@graphql-tools/wrap';
 import { MESH_API_CONTEXT_SYMBOL } from './constants.js';
 
@@ -110,6 +112,7 @@ export async function getInContextSDK(
             key,
             argsFromKeys,
             valuesFromResults,
+            autoSelectionSetWithDepth,
           }: {
             root: any;
             args: any;
@@ -119,6 +122,7 @@ export async function getInContextSDK(
             key?: string;
             argsFromKeys?: (keys: string[]) => any;
             valuesFromResults?: (result: any, keys?: string[]) => any;
+            autoSelectionSetWithDepth?: number;
           }) => {
             inContextSdkLogger.debug(`Called with`, {
               args,
@@ -147,9 +151,22 @@ export async function getInContextSDK(
               }
               if (selectionCount === 0) {
                 if (!selectionSet) {
-                  throw new Error(
-                    `You have to provide 'selectionSet' for context.${rawSource.name}.${rootType.name}.${fieldName}`,
-                  );
+                  if (autoSelectionSetWithDepth) {
+                    const operationNode = buildOperationNodeForField({
+                      schema: transformedSchema,
+                      kind: operationType as OperationTypeNode,
+                      depthLimit: autoSelectionSetWithDepth,
+                      field: fieldName,
+                    });
+                    selectionSet = print(
+                      (operationNode.selectionSet.selections[0] as FieldNode).selectionSet,
+                    );
+                    console.log({ selectionSet });
+                  } else {
+                    throw new Error(
+                      `You have to provide 'selectionSet' for context.${rawSource.name}.${rootType.name}.${fieldName}`,
+                    );
+                  }
                 }
                 commonDelegateOptions.info = {
                   ...info,

diff --git a/packages/types/src/index.ts b/packages/types/src/index.ts
@@ -244,10 +244,20 @@ export type InContextSdkMethodInfoParams = {
   info: GraphQLResolveInfo;
 };
 
+export type InContextSdkMethodAutoSelectionSetParams = {
+  // Use this parameter if the selection set of the return type doesn't match
+  autoSelectionSetWithDepth: number;
+  info?: GraphQLResolveInfo;
+};
+
 export type InContextSdkMethodParams<TDefaultReturn, TArgs, TContext, TKey, TReturn> = {
   root?: any;
   context: TContext;
-} & (InContextSdkMethodCustomSelectionSetParams | InContextSdkMethodInfoParams) &
+} & (
+  | InContextSdkMethodCustomSelectionSetParams
+  | InContextSdkMethodInfoParams
+  | InContextSdkMethodAutoSelectionSetParams
+) &
   (
     | InContextSdkMethodBatchingParams<TDefaultReturn, TArgs, TKey, TReturn>
     | InContextSdkMethodRegularParams<TDefaultReturn, TArgs, TReturn>