Feature Request: Nested overrides while using the original mock function

[jpcafe10]

The problem

When using overrides, nested objects are not wrapping their correspondent mock function. Instead they just apply the raw object provided by the user. This could result in some missing keys for that GQL schema node.

It would be good if we apply the mock function for that nested object and pass it as an override.

aUser({
  // This is missing other nested keys.
  viewingControls: {
    lastModifiedDate: '10/02/2001',
  },
});

Example

Given some config, for ex.

    [`${CODEGEN_DIR}graphql-mocks.ts`]: {
      plugins: [
        {
          'typescript-mock-data': {
            typesFile: './graphql.ts',
            nestedOverrides: true
          },
        }
      ],
    },

Instead of

export const aUser = (overrides?: Partial<User>, _relationshipsToOmit: Set<string> = new Set()): { __typename: 'User' } & User => {
    const relationshipsToOmit: Set<string> = new Set(_relationshipsToOmit);
    relationshipsToOmit.add('User');
    return {
        __typename: 'User',
        _id: overrides && overrides.hasOwnProperty('_id') ? overrides._id! : 'dc8ad6c2-78d6-4914-a958-38a7e195fcf9',
        viewingControls: overrides && overrides.hasOwnProperty('viewingControls') ? overrides.viewingControls! : relationshipsToOmit.has('ViewingControls') ? {} as ViewingControls : aViewingControls({}, relationshipsToOmit),
    };
};

we could

export const aUser = (overrides?: Partial<User>, _relationshipsToOmit: Set<string> = new Set()): { __typename: 'User' } & User => {
    const relationshipsToOmit: Set<string> = new Set(_relationshipsToOmit);
    relationshipsToOmit.add('User');
    return {
        __typename: 'User',
        _id: overrides && overrides.hasOwnProperty('_id') ? overrides._id! : 'dc8ad6c2-78d6-4914-a958-38a7e195fcf9',
        viewingControls: overrides && overrides.hasOwnProperty('viewingControls') ? aViewingControls(overrides.viewingControls) : relationshipsToOmit.has('ViewingControls') ? {} as ViewingControls : aViewingControls({}, relationshipsToOmit),
    };
};

[jpcafe10]

I don't mind giving it a try if it's not super complex

[ardeois]

@jca you just need to do:

aUser({
  // This is missing other nested keys.
  viewingControls: aViewingControls({
    lastModifiedDate: '10/02/2001',
  }),
});

As if you use Typesrcipt I think you should get an error when you use the following code

aUser({
  // This is missing other nested keys.
  viewingControls: { //   viewingControls content is missing properties so typescript should fail
    lastModifiedDate: '10/02/2001',
  },
});

[tlmader]

This would be pretty great in conjunction with @graphql-codegen/typescript-msw.

I'm currently using these plugins together like this:

server.use(
  // mockMultiSearchQuery is generated by @graphql-codegen/typescript-msw
  mockMultiSearchQuery(({ variables }) => {
    expect(variables).toMatchSnapshot('mockMultiSearchQuery');

    return HttpResponse.json({
      // aQuery, etc. are generated by graphql-codegen-typescript-mock-data
      data: aQuery({
        MultiSearch: aMultiSearchResults({
          docs: [
            aProduct({
              accessibility: aProduct_Accessibility({
                label: 'Alden Indy Boot, Alden Madison, $595.00',
              }),
              sale: true,
            }),
          ],
        }),
      }),
    });
  }),
);

It would be great to only need one mock data import.

[jpcafe10]

@jca you just need to do:

aUser({
// This is missing other nested keys.
viewingControls: aViewingControls({
lastModifiedDate: '10/02/2001',
}),
});
As if you use Typesrcipt I think you should get an error when you use the following code

aUser({
  // This is missing other nested keys.
  viewingControls: { //   viewingControls content is missing properties so typescript should fail
    lastModifiedDate: '10/02/2001',
  },
});

Yes but my point is that it's not nested. it's not spreading the default codegen mocks on nested keys.

The example you've showed passes TS check.

aUser({
  // This is missing other nested keys but passes TS
  viewingControls: {
    //   viewingControls content is missing properties so typescript should fail
    lastModifiedDate: '10/02/2001',
  },
});

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[ardeois]

I'm not sure it's that necessary to add spreading on nested keys. Especially because it would also require to spread recursively if we have multiple layers of nesting