Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix resolveReference being generated as required when using generateInternalResolversIfNeeded.__resolveReference #10230

Merged
merged 3 commits into from
Jan 18, 2025
Merged

Fix resolveReference being generated as required when using generateInternalResolversIfNeeded.__resolveReference #10230

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7df983e
Fix generate generateInternalResolversIfNeeded.__resolveReference mak…
eddeee888 Jan 5, 2025
084c750
Add changeset
eddeee888 Jan 5, 2025
d7a711a
Merge branch 'master' into fix-generate-resolvereference-as-required
eddeee888 Jan 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .changeset/orange-pillows-decide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
'@graphql-codegen/visitor-plugin-common': patch
'@graphql-codegen/typescript-resolvers': patch
---

Fix generateInternalResolversIfNeeded.\_\_resolveReference making the resolver required

`__resolveReference`'s default behaviour when not declared is to pass the ref to subsequent resolvers i.e. becoming the `parent`. So, it means we don't have to make this resolver required.

This patch makes `__resolveReference` optional when `generateInternalResolversIfNeeded.__resolveReference` is set to true.
1 change: 0 additions & 1 deletion packages/plugins/other/visitor-plugin-common/src/base-resolvers-visitor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1531,7 +1531,6 @@ export class BaseResolversVisitor<
if (!federationDetails || federationDetails.resolvableKeyDirectives.length === 0) {
return '';
}
signature.modifier = ''; // if a federation type has resolvable @key, then it should be required
}

this._federation.setMeta(parentType.name, { hasResolveReference: true });
Expand Down
8 changes: 4 additions & 4 deletions packages/plugins/typescript/resolvers/tests/ts-resolvers.federation.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ describe('TypeScript Resolvers Plugin + Apollo Federation', () => {
// User should have __resolveReference because it has resolvable @key (by default)
expect(content).toBeSimilarStringTo(`
export type UserResolvers<ContextType = any, ParentType extends ResolversParentTypes['User'] = ResolversParentTypes['User']> = {
__resolveReference: ReferenceResolver<Maybe<ResolversTypes['User']>, { __typename: 'User' } & GraphQLRecursivePick<ParentType, {"id":true}>, ContextType>;
__resolveReference?: ReferenceResolver<Maybe<ResolversTypes['User']>, { __typename: 'User' } & GraphQLRecursivePick<ParentType, {"id":true}>, ContextType>;
id?: Resolver<ResolversTypes['ID'], ParentType, ContextType>;
name?: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
username?: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
Expand All @@ -223,7 +223,7 @@ describe('TypeScript Resolvers Plugin + Apollo Federation', () => {
// SingleResolvable has __resolveReference because it has resolvable: true
expect(content).toBeSimilarStringTo(`
export type SingleResolvableResolvers<ContextType = any, ParentType extends ResolversParentTypes['SingleResolvable'] = ResolversParentTypes['SingleResolvable']> = {
__resolveReference: ReferenceResolver<Maybe<ResolversTypes['SingleResolvable']>, { __typename: 'SingleResolvable' } & GraphQLRecursivePick<ParentType, {"id":true}>, ContextType>;
__resolveReference?: ReferenceResolver<Maybe<ResolversTypes['SingleResolvable']>, { __typename: 'SingleResolvable' } & GraphQLRecursivePick<ParentType, {"id":true}>, ContextType>;
id?: Resolver<ResolversTypes['ID'], ParentType, ContextType>;
__isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
};
Expand All @@ -240,7 +240,7 @@ describe('TypeScript Resolvers Plugin + Apollo Federation', () => {
// AtLeastOneResolvable has __resolveReference because it at least one resolvable
expect(content).toBeSimilarStringTo(`
export type AtLeastOneResolvableResolvers<ContextType = any, ParentType extends ResolversParentTypes['AtLeastOneResolvable'] = ResolversParentTypes['AtLeastOneResolvable']> = {
__resolveReference: ReferenceResolver<Maybe<ResolversTypes['AtLeastOneResolvable']>, { __typename: 'AtLeastOneResolvable' } & GraphQLRecursivePick<ParentType, {"id2":true}>, ContextType>;
__resolveReference?: ReferenceResolver<Maybe<ResolversTypes['AtLeastOneResolvable']>, { __typename: 'AtLeastOneResolvable' } & GraphQLRecursivePick<ParentType, {"id2":true}>, ContextType>;
id?: Resolver<ResolversTypes['ID'], ParentType, ContextType>;
id2?: Resolver<ResolversTypes['ID'], ParentType, ContextType>;
id3?: Resolver<ResolversTypes['ID'], ParentType, ContextType>;
Expand All @@ -251,7 +251,7 @@ describe('TypeScript Resolvers Plugin + Apollo Federation', () => {
// MixedResolvable has __resolveReference and references for resolvable keys
expect(content).toBeSimilarStringTo(`
export type MixedResolvableResolvers<ContextType = any, ParentType extends ResolversParentTypes['MixedResolvable'] = ResolversParentTypes['MixedResolvable']> = {
__resolveReference: ReferenceResolver<Maybe<ResolversTypes['MixedResolvable']>, { __typename: 'MixedResolvable' } & (GraphQLRecursivePick<ParentType, {"id":true}> | GraphQLRecursivePick<ParentType, {"id2":true}>), ContextType>;
__resolveReference?: ReferenceResolver<Maybe<ResolversTypes['MixedResolvable']>, { __typename: 'MixedResolvable' } & (GraphQLRecursivePick<ParentType, {"id":true}> | GraphQLRecursivePick<ParentType, {"id2":true}>), ContextType>;
id?: Resolver<ResolversTypes['ID'], ParentType, ContextType>;
id2?: Resolver<ResolversTypes['ID'], ParentType, ContextType>;
id3?: Resolver<ResolversTypes['ID'], ParentType, ContextType>;
Expand Down
Loading