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

[resolvers][federation] Bring Federation reference selection set to ResolversParentTypes instead of each resolver #10297

Draft
wants to merge 1 commit into
base: federation-fixes
Choose a base branch
from
Draft

[resolvers][federation] Bring Federation reference selection set to ResolversParentTypes instead of each resolver #10297

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 19 additions & 0 deletions 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 @@ -769,13 +769,25 @@ export class BaseResolversVisitor<
clearWrapper: type => this.clearResolverTypeWrapper(type),
getTypeToUse: name => this.getTypeToUse(name),
currentType: 'ResolversTypes',
onNotMappedObjectType: ({ initialType }) => initialType,
});
this._resolversParentTypes = this.createResolversFields({
applyWrapper: type => type,
clearWrapper: type => type,
getTypeToUse: name => this.getParentTypeToUse(name),
currentType: 'ResolversParentTypes',
shouldInclude: namedType => !isEnumType(namedType),
onNotMappedObjectType: ({ typeName, initialType }) => {
let result = initialType;
const federationReferenceTypes = this._federation.printReferenceSelectionSets({
convertName: this.convertName,
typeName,
});
if (federationReferenceTypes) {
result += ` | ${federationReferenceTypes}`;
}
return result;
},
});
this._resolversUnionTypes = this.createResolversUnionTypes();
this._resolversInterfaceTypes = this.createResolversInterfaceTypes();
Expand Down Expand Up @@ -848,12 +860,14 @@ export class BaseResolversVisitor<
getTypeToUse,
currentType,
shouldInclude,
onNotMappedObjectType,
}: {
applyWrapper: (str: string) => string;
clearWrapper: (str: string) => string;
getTypeToUse: (str: string) => string;
currentType: 'ResolversTypes' | 'ResolversParentTypes';
shouldInclude?: (type: GraphQLNamedType) => boolean;
onNotMappedObjectType: (params: { initialType: string; typeName: string }) => string;
}): ResolverTypes {
const allSchemaTypes = this._schema.getTypeMap();
const typeNames = this._federation.filterTypeNames(Object.keys(allSchemaTypes));
Expand Down Expand Up @@ -942,6 +956,11 @@ export class BaseResolversVisitor<
if (this.config.mappers[typeName].type && hasPlaceholder(this.config.mappers[typeName].type)) {
internalType = replacePlaceholder(this.config.mappers[typeName].type, internalType);
}
} else {
internalType = onNotMappedObjectType({
typeName,
initialType: internalType,
});
}

prev[typeName] = applyWrapper(internalType);
Expand Down
4 changes: 2 additions & 2 deletions packages/plugins/typescript/resolvers/tests/ts-resolvers.federation.interface.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,8 @@ describe('TypeScript Resolvers Plugin + Apollo Federation - Interface', () => {
Query: {};
Person: ResolversInterfaceTypes<ResolversParentTypes>['Person'];
ID: Scalars['ID']['output'];
User: User;
Admin: Admin;
User: User | ( { __typename: 'User' } & GraphQLRecursivePick<FederationTypes['User'], {"id":true}> );
Admin: Admin | ( { __typename: 'Admin' } & GraphQLRecursivePick<FederationTypes['Admin'], {"id":true}> );
Boolean: Scalars['Boolean']['output'];
PersonName: PersonName;
String: Scalars['String']['output'];
Expand Down
116 changes: 112 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 @@ -83,6 +83,31 @@ describe('TypeScript Resolvers Plugin + Apollo Federation', () => {
},
});

expect(content).toBeSimilarStringTo(`
export type FederationTypes = {
User: User;
SingleResolvable: SingleResolvable;
AtLeastOneResolvable: AtLeastOneResolvable;
MixedResolvable: MixedResolvable;
};
`);

expect(content).toBeSimilarStringTo(`
export type ResolversParentTypes = {
Query: {};
User: User | ( { __typename: 'User' } & GraphQLRecursivePick<FederationTypes['User'], {"id":true}> );
ID: Scalars['ID']['output'];
String: Scalars['String']['output'];
Book: Book;
SingleResolvable: SingleResolvable | ( { __typename: 'SingleResolvable' } & GraphQLRecursivePick<FederationTypes['SingleResolvable'], {"id":true}> );
SingleNonResolvable: SingleNonResolvable;
AtLeastOneResolvable: AtLeastOneResolvable | ( { __typename: 'AtLeastOneResolvable' } & GraphQLRecursivePick<FederationTypes['AtLeastOneResolvable'], {"id2":true}> );
MixedResolvable: MixedResolvable | ( { __typename: 'MixedResolvable' } & ( GraphQLRecursivePick<FederationTypes['MixedResolvable'], {"id":true}> | GraphQLRecursivePick<FederationTypes['MixedResolvable'], {"id2":true}> ) );
MultipleNonResolvable: MultipleNonResolvable;
Boolean: Scalars['Boolean']['output'];
};
`);

// 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'], FederationType extends FederationTypes['User'] = FederationTypes['User']> = {
Expand Down Expand Up @@ -248,12 +273,23 @@ describe('TypeScript Resolvers Plugin + Apollo Federation', () => {
},
});

expect(content).toBeSimilarStringTo(`
export type ResolversParentTypes = {
Query: {};
User: User | ( { __typename: 'User' } & GraphQLRecursivePick<FederationTypes['User'], {"id":true}> & GraphQLRecursivePick<FederationTypes['User'], {"name":true,"age":true}> );
ID: Scalars['ID']['output'];
String: Scalars['String']['output'];
Int: Scalars['Int']['output'];
Boolean: Scalars['Boolean']['output'];
};
`);

// User should have it
expect(content).toBeSimilarStringTo(`
export type UserResolvers<ContextType = any, ParentType extends ResolversParentTypes['User'] = ResolversParentTypes['User'], FederationType extends FederationTypes['User'] = FederationTypes['User']> = {
__resolveReference?: ReferenceResolver<Maybe<ResolversTypes['User']>, { __typename: 'User' } & GraphQLRecursivePick<FederationType, {"id":true}>, ContextType>;
id?: Resolver<ResolversTypes['ID'], { __typename: 'User' } & GraphQLRecursivePick<FederationType, {"id":true}>, ContextType>;
username?: Resolver<Maybe<ResolversTypes['String']>, { __typename: 'User' } & GraphQLRecursivePick<FederationType, {"id":true}> & GraphQLRecursivePick<FederationType, {"name":true,"age":true}>, ContextType>;
id?: Resolver<ResolversTypes['ID'], Parent, ContextType>;
username?: Resolver<Maybe<ResolversTypes['String']>, Parent, ContextType>;
};
`);
});
Expand Down Expand Up @@ -285,10 +321,22 @@ describe('TypeScript Resolvers Plugin + Apollo Federation', () => {
},
});

expect(content).toBeSimilarStringTo(`
export type ResolversParentTypes = {
Query: {};
User: User | ( { __typename: 'User' } & GraphQLRecursivePick<FederationTypes['User'], {"id":true}> & GraphQLRecursivePick<FederationTypes['User'], {"name":true,"age":true,"address":{"street":true}}> );
ID: Scalars['ID']['output'];
String: Scalars['String']['output'];
Int: Scalars['Int']['output'];
Address: Address;
Boolean: Scalars['Boolean']['output'];
};
`);

expect(content).toBeSimilarStringTo(`
export type UserResolvers<ContextType = any, ParentType extends ResolversParentTypes['User'] = ResolversParentTypes['User'], FederationType extends FederationTypes['User'] = FederationTypes['User']> = {
__resolveReference?: ReferenceResolver<Maybe<ResolversTypes['User']>, { __typename: 'User' } & GraphQLRecursivePick<FederationType, {"id":true}>, ContextType>;
username?: Resolver<Maybe<ResolversTypes['String']>, { __typename: 'User' } & GraphQLRecursivePick<FederationType, {"id":true}> & GraphQLRecursivePick<FederationType, {"name":true,"age":true,"address":{"street":true}}>, ContextType>;
username?: Resolver<Maybe<ResolversTypes['String']>, Parent, ContextType>;
};
`);
});
Expand Down Expand Up @@ -317,10 +365,70 @@ describe('TypeScript Resolvers Plugin + Apollo Federation', () => {
},
});

expect(content).toBeSimilarStringTo(`
export type ResolversParentTypes = {
Query: {};
User: User | ( { __typename: 'User' } & GraphQLRecursivePick<FederationTypes['User'], {"name":{"first":true,"last":true}}> );
String: Scalars['String']['output'];
Name: Name;
Boolean: Scalars['Boolean']['output'];
};
`);

expect(content).toBeSimilarStringTo(`
export type UserResolvers<ContextType = any, ParentType extends ResolversParentTypes['User'] = ResolversParentTypes['User'], FederationType extends FederationTypes['User'] = FederationTypes['User']> = {
__resolveReference?: ReferenceResolver<Maybe<ResolversTypes['User']>, { __typename: 'User' } & GraphQLRecursivePick<FederationType, {"name":{"first":true,"last":true}}>, ContextType>;
username?: Resolver<Maybe<ResolversTypes['String']>, { __typename: 'User' } & GraphQLRecursivePick<FederationType, {"name":{"first":true,"last":true}}>, ContextType>;
username?: Resolver<Maybe<ResolversTypes['String']>, Parent, ContextType>;
};
`);
});

it('handles a mix of @key and @requires directives', async () => {
const federatedSchema = /* GraphQL */ `
type Query {
users: [User]
}

type User @key(fields: "id") @key(fields: "uuid") @key(fields: "legacyId { oldId1 oldId2 }") {
id: ID!
uuid: ID!
legacyId: LegacyId! @external
name: String! @external
username: String! @requires(fields: "id name")
usernameLegacy: String! @requires(fields: "legacyId { oldId1 } name")
}

type LegacyId {
oldId1: ID! @external
oldId2: ID! @external
}
`;

const content = await generate({
schema: federatedSchema,
config: {
federation: true,
},
});

expect(content).toBeSimilarStringTo(`
export type ResolversParentTypes = {
Query: {};
User: User | ( { __typename: 'User' } & ( GraphQLRecursivePick<FederationTypes['User'], {"id":true}> | GraphQLRecursivePick<FederationTypes['User'], {"uuid":true}> | GraphQLRecursivePick<FederationTypes['User'], {"legacyId":{"oldId1":true,"oldId2":true}}> ) & GraphQLRecursivePick<FederationTypes['User'], {"id":true,"name":true}> & GraphQLRecursivePick<FederationTypes['User'], {"legacyId":{"oldId1":true},"name":true}> );
ID: Scalars['ID']['output'];
String: Scalars['String']['output'];
LegacyId: LegacyId;
Boolean: Scalars['Boolean']['output'];
};
`);

expect(content).toBeSimilarStringTo(`
export type UserResolvers<ContextType = any, ParentType extends ResolversParentTypes['User'] = ResolversParentTypes['User'], FederationType extends FederationTypes['User'] = FederationTypes['User']> = {
__resolveReference?: ReferenceResolver<Maybe<ResolversTypes['User']>, { __typename: 'User' } & (GraphQLRecursivePick<FederationType, {"id":true}> | GraphQLRecursivePick<FederationType, {"uuid":true}> | GraphQLRecursivePick<FederationType, {"legacyId":{"oldId1":true,"oldId2":true}}>), ContextType>;
id?: Resolver<ResolversTypes['ID'], Parent, ContextType>;
uuid?: Resolver<ResolversTypes['ID'], Parent, ContextType>;
username?: Resolver<ResolversTypes['String'], Parent, ContextType>;
usernameLegacy?: Resolver<ResolversTypes['String'], Parent, ContextType>;
};
`);
});
Expand Down
Loading
Loading