feat[useOnResolve] add skipDefaultResolvers option

Author: cecchi

packages/plugins/on-resolve/src/index.ts

@@ -40,6 +40,13 @@ export type UseOnResolveOptions = {
    * @default true
    */
   skipIntrospection?: boolean;
+
+  /**
+   * Skip executing the `onResolve` hook on fields with default resolvers.
+   *
+   * @default false
+   */
+  skipDefaultResolvers?: boolean;
 };
 
 /**
@@ -49,7 +56,7 @@ export type UseOnResolveOptions = {
  */
 export function useOnResolve<PluginContext extends Record<string, any> = {}>(
   onResolve: OnResolve<PluginContext>,
-  opts: UseOnResolveOptions = { skipIntrospection: true },
+  opts: UseOnResolveOptions = { skipIntrospection: true, skipDefaultResolvers: false },
 ): Plugin<PluginContext> {
   const hasWrappedResolveSymbol = Symbol('hasWrappedResolve');
   return {
@@ -61,6 +68,7 @@ export function useOnResolve<PluginContext extends Record<string, any> = {}>(
         if ((!opts.skipIntrospection || !isIntrospectionType(type)) && isObjectType(type)) {
           for (const field of Object.values(type.getFields())) {
             if ((field as { [hasWrappedResolveSymbol]?: true })[hasWrappedResolveSymbol]) continue;
+            if (opts.skipDefaultResolvers && !field.resolve) continue;
 
             let resolver = (field.resolve || defaultFieldResolver) as Resolver<PluginContext>;
 

packages/plugins/on-resolve/test/use-on-resolve.spec.ts

@@ -8,12 +8,20 @@ describe('useOnResolve', () => {
       type Query {
         value1: String!
         value2: String!
+        obj: Obj!
+      }
+
+      type Obj {
+        field1: String!
       }
     `,
     resolvers: {
       Query: {
         value1: () => 'value1',
         value2: () => 'value2',
+        obj: () => ({
+          field1: 'field1',
+        }),
       },
     },
   });
@@ -85,6 +93,47 @@ describe('useOnResolve', () => {
     expect(onResolveDoneFn).toHaveBeenCalledTimes(0);
   });
 
+  it('should invoke the callback for default resolvers when not skipping', async () => {
+    const onResolveDoneFn = jest.fn();
+    const onResolveFn = jest.fn((_opts: OnResolveOptions) => onResolveDoneFn);
+    const testkit = createTestkit(
+      [useOnResolve(onResolveFn, { skipDefaultResolvers: false })],
+      schema,
+    );
+
+    await testkit.execute('{ obj { field1 } }');
+
+    expect(onResolveFn).toHaveBeenCalledTimes(2);
+    expect(onResolveDoneFn).toHaveBeenCalledTimes(2);
+
+    let i = 0;
+    for (const field of ['obj', 'field1']) {
+      expect(onResolveFn.mock.calls[i][0].context).toBeDefined();
+      expect(onResolveFn.mock.calls[i][0].root).toBeDefined();
+      expect(onResolveFn.mock.calls[i][0].args).toBeDefined();
+      expect(onResolveFn.mock.calls[i][0].info).toBeDefined();
+      expect(onResolveFn.mock.calls[i][0].info.fieldName).toBe(field);
+      expect(onResolveFn.mock.calls[i][0].resolver).toBeInstanceOf(Function);
+      expect(onResolveFn.mock.calls[i][0].replaceResolver).toBeInstanceOf(Function);
+
+      i++;
+    }
+  });
+
+  it('should not invoke the callback for default resolvers when skipping', async () => {
+    const onResolveDoneFn = jest.fn();
+    const onResolveFn = jest.fn((_opts: OnResolveOptions) => onResolveDoneFn);
+    const testkit = createTestkit(
+      [useOnResolve(onResolveFn, { skipDefaultResolvers: true })],
+      schema,
+    );
+
+    await testkit.execute('{ obj { field1 } }');
+
+    expect(onResolveFn).toHaveBeenCalledTimes(1);
+    expect(onResolveDoneFn).toHaveBeenCalledTimes(1);
+  });
+
   it('should replace the result using the after hook', async () => {
     const testkit = createTestkit(
       [