fix: nested relations not working and relations not prefixed (#2782)

* fix: nested relations n+n

* fix: prefix custom relations

* fix: only apply targetColumnMap when it's a custom object

* fix: force workspaceId to be provided

* fix: toIsCustom -> isToCustom

* fix: remove console.log
This commit is contained in:
Jérémy M
2023-12-01 15:26:48 +01:00
committed by GitHub
parent 6e6f0af26e
commit 474db1e142
28 changed files with 226 additions and 131 deletions

View File

@ -20,11 +20,11 @@ export class CreateManyQueryFactory {
private readonly argsAliasFactory: ArgsAliasFactory,
) {}
create<Record extends IRecord = IRecord>(
async create<Record extends IRecord = IRecord>(
args: CreateManyResolverArgs<Record>,
options: WorkspaceQueryBuilderOptions,
) {
const fieldsString = this.fieldsStringFactory.create(
const fieldsString = await this.fieldsStringFactory.create(
options.info,
options.fieldMetadataCollection,
);

View File

@ -11,8 +11,11 @@ import { FieldsStringFactory } from './fields-string.factory';
export class DeleteManyQueryFactory {
constructor(private readonly fieldsStringFactory: FieldsStringFactory) {}
create(args: DeleteManyResolverArgs, options: WorkspaceQueryBuilderOptions) {
const fieldsString = this.fieldsStringFactory.create(
async create(
args: DeleteManyResolverArgs,
options: WorkspaceQueryBuilderOptions,
) {
const fieldsString = await this.fieldsStringFactory.create(
options.info,
options.fieldMetadataCollection,
);

View File

@ -11,8 +11,11 @@ export class DeleteOneQueryFactory {
constructor(private readonly fieldsStringFactory: FieldsStringFactory) {}
create(args: DeleteOneResolverArgs, options: WorkspaceQueryBuilderOptions) {
const fieldsString = this.fieldsStringFactory.create(
async create(
args: DeleteOneResolverArgs,
options: WorkspaceQueryBuilderOptions,
) {
const fieldsString = await this.fieldsStringFactory.create(
options.info,
options.fieldMetadataCollection,
);

View File

@ -23,7 +23,7 @@ export class FieldsStringFactory {
create(
info: GraphQLResolveInfo,
fieldMetadataCollection: FieldMetadataInterface[],
) {
): Promise<string> {
const selectedFields: Record<string, any> = graphqlFields(info);
return this.createFieldsStringRecursive(
@ -33,12 +33,12 @@ export class FieldsStringFactory {
);
}
createFieldsStringRecursive(
async createFieldsStringRecursive(
info: GraphQLResolveInfo,
selectedFields: Record<string, any>,
fieldMetadataCollection: FieldMetadataInterface[],
accumulator = '',
): string {
): Promise<string> {
const fieldMetadataMap = new Map(
fieldMetadataCollection.map((metadata) => [metadata.name, metadata]),
);
@ -54,7 +54,7 @@ export class FieldsStringFactory {
// If the field is a relation field, we need to create a special alias
if (isRelationFieldMetadataType(fieldMetadata.type)) {
const alias = this.relationFieldAliasFactory.create(
const alias = await this.relationFieldAliasFactory.create(
fieldKey,
fieldValue,
fieldMetadata,
@ -80,7 +80,7 @@ export class FieldsStringFactory {
!isEmpty(fieldValue)
) {
accumulator += `${fieldKey} {\n`;
accumulator = this.createFieldsStringRecursive(
accumulator = await this.createFieldsStringRecursive(
info,
fieldValue,
fieldMetadataCollection,

View File

@ -19,14 +19,14 @@ export class FindManyQueryFactory {
private readonly argsStringFactory: ArgsStringFactory,
) {}
create<
async create<
Filter extends RecordFilter = RecordFilter,
OrderBy extends RecordOrderBy = RecordOrderBy,
>(
args: FindManyResolverArgs<Filter, OrderBy>,
options: WorkspaceQueryBuilderOptions,
) {
const fieldsString = this.fieldsStringFactory.create(
const fieldsString = await this.fieldsStringFactory.create(
options.info,
options.fieldMetadataCollection,
);

View File

@ -16,11 +16,11 @@ export class FindOneQueryFactory {
private readonly argsStringFactory: ArgsStringFactory,
) {}
create<Filter extends RecordFilter = RecordFilter>(
async create<Filter extends RecordFilter = RecordFilter>(
args: FindOneResolverArgs<Filter>,
options: WorkspaceQueryBuilderOptions,
) {
const fieldsString = this.fieldsStringFactory.create(
const fieldsString = await this.fieldsStringFactory.create(
options.info,
options.fieldMetadataCollection,
);

View File

@ -11,6 +11,7 @@ import {
RelationDirection,
} from 'src/workspace/utils/deduce-relation-direction.util';
import { getFieldArgumentsByKey } from 'src/workspace/workspace-query-builder/utils/get-field-arguments-by-key.util';
import { ObjectMetadataService } from 'src/metadata/object-metadata/object-metadata.service';
import { FieldsStringFactory } from './fields-string.factory';
import { ArgsStringFactory } from './args-string.factory';
@ -23,6 +24,7 @@ export class RelationFieldAliasFactory {
@Inject(forwardRef(() => FieldsStringFactory))
private readonly fieldsStringFactory: FieldsStringFactory,
private readonly argsStringFactory: ArgsStringFactory,
private readonly objectMetadataService: ObjectMetadataService,
) {}
create(
@ -30,7 +32,7 @@ export class RelationFieldAliasFactory {
fieldValue: any,
fieldMetadata: FieldMetadataInterface,
info: GraphQLResolveInfo,
) {
): Promise<string> {
if (!isRelationFieldMetadataType(fieldMetadata.type)) {
throw new Error(`Field ${fieldMetadata.name} is not a relation field`);
}
@ -38,12 +40,12 @@ export class RelationFieldAliasFactory {
return this.createRelationAlias(fieldKey, fieldValue, fieldMetadata, info);
}
private createRelationAlias(
private async createRelationAlias(
fieldKey: string,
fieldValue: any,
fieldMetadata: FieldMetadataInterface,
info: GraphQLResolveInfo,
) {
): Promise<string> {
const relationMetadata =
fieldMetadata.fromRelationMetadata ?? fieldMetadata.toRelationMetadata;
@ -53,14 +55,36 @@ export class RelationFieldAliasFactory {
);
}
if (!fieldMetadata.workspaceId) {
throw new Error(
`Workspace id not found for field ${fieldMetadata.name} in object metadata ${fieldMetadata.objectMetadataId}`,
);
}
const relationDirection = deduceRelationDirection(
fieldMetadata.objectMetadataId,
relationMetadata,
);
// Retrieve the referenced object metadata based on the relation direction
// Mandatory to handle n+n relations
const referencedObjectMetadata =
relationDirection == RelationDirection.TO
? relationMetadata.fromObjectMetadata
: relationMetadata.toObjectMetadata;
await this.objectMetadataService.findOneWithinWorkspace(
fieldMetadata.workspaceId,
{
where: {
id:
relationDirection == RelationDirection.TO
? relationMetadata.fromObjectMetadataId
: relationMetadata.toObjectMetadataId,
},
},
);
if (!referencedObjectMetadata) {
throw new Error(
`Referenced object metadata not found for relation ${relationMetadata.id}`,
);
}
// If it's a relation destination is of kind MANY, we need to add the collection suffix and extract the args
if (
@ -70,21 +94,26 @@ export class RelationFieldAliasFactory {
const args = getFieldArgumentsByKey(info, fieldKey);
const argsString = this.argsStringFactory.create(
args,
relationMetadata.toObjectMetadata.fields ?? [],
referencedObjectMetadata.fields ?? [],
);
const fieldsString =
await this.fieldsStringFactory.createFieldsStringRecursive(
info,
fieldValue,
referencedObjectMetadata.fields ?? [],
);
return `
${fieldKey}: ${referencedObjectMetadata.targetTableName}Collection${
argsString ? `(${argsString})` : ''
} {
${this.fieldsStringFactory.createFieldsStringRecursive(
info,
fieldValue,
relationMetadata.toObjectMetadata.fields ?? [],
)}
${fieldsString}
}
`;
}
let relationAlias = fieldMetadata.isCustom ? `_${fieldKey}` : fieldKey;
let relationAlias = fieldMetadata.isCustom
? `${fieldKey}: ${fieldMetadata.targetColumnMap.value}`
: fieldKey;
// For one to one relations, pg_graphql use the targetTableName on the side that is not storing the foreign key
// so we need to alias it to the field key
@ -94,15 +123,17 @@ export class RelationFieldAliasFactory {
) {
relationAlias = `${fieldKey}: ${referencedObjectMetadata.targetTableName}`;
}
const fieldsString =
await this.fieldsStringFactory.createFieldsStringRecursive(
info,
fieldValue,
referencedObjectMetadata.fields ?? [],
);
// Otherwise it means it's a relation destination is of kind ONE
return `
${relationAlias} {
${this.fieldsStringFactory.createFieldsStringRecursive(
info,
fieldValue,
referencedObjectMetadata.fields ?? [],
)}
${fieldsString}
}
`;
}

View File

@ -18,14 +18,14 @@ export class UpdateManyQueryFactory {
private readonly argsAliasFactory: ArgsAliasFactory,
) {}
create<
async create<
Record extends IRecord = IRecord,
Filter extends RecordFilter = RecordFilter,
>(
args: UpdateManyResolverArgs<Record, Filter>,
options: WorkspaceQueryBuilderOptions,
) {
const fieldsString = this.fieldsStringFactory.create(
const fieldsString = await this.fieldsStringFactory.create(
options.info,
options.fieldMetadataCollection,
);

View File

@ -18,11 +18,11 @@ export class UpdateOneQueryFactory {
private readonly argsAliasFactory: ArgsAliasFactory,
) {}
create<Record extends IRecord = IRecord>(
async create<Record extends IRecord = IRecord>(
args: UpdateOneResolverArgs<Record>,
options: WorkspaceQueryBuilderOptions,
) {
const fieldsString = this.fieldsStringFactory.create(
const fieldsString = await this.fieldsStringFactory.create(
options.info,
options.fieldMetadataCollection,
);

View File

@ -44,35 +44,35 @@ export class WorkspaceQueryBuilderFactory {
>(
args: FindManyResolverArgs<Filter, OrderBy>,
options: WorkspaceQueryBuilderOptions,
): string {
): Promise<string> {
return this.findManyQueryFactory.create<Filter, OrderBy>(args, options);
}
findOne<Filter extends RecordFilter = RecordFilter>(
args: FindOneResolverArgs<Filter>,
options: WorkspaceQueryBuilderOptions,
): string {
): Promise<string> {
return this.findOneQueryFactory.create<Filter>(args, options);
}
createMany<Record extends IRecord = IRecord>(
args: CreateManyResolverArgs<Record>,
options: WorkspaceQueryBuilderOptions,
): string {
): Promise<string> {
return this.createManyQueryFactory.create<Record>(args, options);
}
updateOne<Record extends IRecord = IRecord>(
initialArgs: UpdateOneResolverArgs<Record>,
options: WorkspaceQueryBuilderOptions,
): string {
): Promise<string> {
return this.updateOneQueryFactory.create<Record>(initialArgs, options);
}
deleteOne(
args: DeleteOneResolverArgs,
options: WorkspaceQueryBuilderOptions,
): string {
): Promise<string> {
return this.deleteOneQueryFactory.create(args, options);
}
@ -82,14 +82,14 @@ export class WorkspaceQueryBuilderFactory {
>(
args: UpdateManyResolverArgs<Record, Filter>,
options: WorkspaceQueryBuilderOptions,
): string {
): Promise<string> {
return this.updateManyQueryFactory.create(args, options);
}
deleteMany<Filter extends RecordFilter = RecordFilter>(
args: DeleteManyResolverArgs<Filter>,
options: WorkspaceQueryBuilderOptions,
): string {
): Promise<string> {
return this.deleteManyQueryFactory.create(args, options);
}
}

View File

@ -1,11 +1,13 @@
import { Module } from '@nestjs/common';
import { ObjectMetadataModule } from 'src/metadata/object-metadata/object-metadata.module';
import { WorkspaceQueryBuilderFactory } from './workspace-query-builder.factory';
import { workspaceQueryBuilderFactories } from './factories/factories';
@Module({
imports: [],
imports: [ObjectMetadataModule],
providers: [...workspaceQueryBuilderFactories, WorkspaceQueryBuilderFactory],
exports: [WorkspaceQueryBuilderFactory],
})

View File

@ -45,7 +45,10 @@ export class WorkspaceQueryRunnerService {
options: WorkspaceQueryRunnerOptions,
): Promise<IConnection<Record> | undefined> {
const { workspaceId, targetTableName } = options;
const query = this.workspaceQueryBuilderFactory.findMany(args, options);
const query = await this.workspaceQueryBuilderFactory.findMany(
args,
options,
);
const result = await this.execute(query, workspaceId);
return this.parseResult<IConnection<Record>>(result, targetTableName, '');
@ -62,7 +65,10 @@ export class WorkspaceQueryRunnerService {
throw new BadRequestException('Missing filter argument');
}
const { workspaceId, targetTableName } = options;
const query = this.workspaceQueryBuilderFactory.findOne(args, options);
const query = await this.workspaceQueryBuilderFactory.findOne(
args,
options,
);
const result = await this.execute(query, workspaceId);
const parsedResult = this.parseResult<IConnection<Record>>(
result,
@ -78,7 +84,10 @@ export class WorkspaceQueryRunnerService {
options: WorkspaceQueryRunnerOptions,
): Promise<Record[] | undefined> {
const { workspaceId, targetTableName } = options;
const query = this.workspaceQueryBuilderFactory.createMany(args, options);
const query = await this.workspaceQueryBuilderFactory.createMany(
args,
options,
);
const result = await this.execute(query, workspaceId);
return this.parseResult<PGGraphQLMutation<Record>>(
@ -102,9 +111,10 @@ export class WorkspaceQueryRunnerService {
options: WorkspaceQueryRunnerOptions,
): Promise<Record | undefined> {
const { workspaceId, targetTableName } = options;
const query = this.workspaceQueryBuilderFactory.updateOne(args, options);
const query = await this.workspaceQueryBuilderFactory.updateOne(
args,
options,
);
const result = await this.execute(query, workspaceId);
return this.parseResult<PGGraphQLMutation<Record>>(
@ -119,7 +129,10 @@ export class WorkspaceQueryRunnerService {
options: WorkspaceQueryRunnerOptions,
): Promise<Record | undefined> {
const { workspaceId, targetTableName } = options;
const query = this.workspaceQueryBuilderFactory.deleteOne(args, options);
const query = await this.workspaceQueryBuilderFactory.deleteOne(
args,
options,
);
const result = await this.execute(query, workspaceId);
return this.parseResult<PGGraphQLMutation<Record>>(
@ -134,9 +147,10 @@ export class WorkspaceQueryRunnerService {
options: WorkspaceQueryRunnerOptions,
): Promise<Record[] | undefined> {
const { workspaceId, targetTableName } = options;
const query = this.workspaceQueryBuilderFactory.updateMany(args, options);
const query = await this.workspaceQueryBuilderFactory.updateMany(
args,
options,
);
const result = await this.execute(query, workspaceId);
return this.parseResult<PGGraphQLMutation<Record>>(
@ -154,9 +168,10 @@ export class WorkspaceQueryRunnerService {
options: WorkspaceQueryRunnerOptions,
): Promise<Record[] | undefined> {
const { workspaceId, targetTableName } = options;
const query = this.workspaceQueryBuilderFactory.deleteMany(args, options);
const query = await this.workspaceQueryBuilderFactory.deleteMany(
args,
options,
);
const result = await this.execute(query, workspaceId);
return this.parseResult<PGGraphQLMutation<Record>>(

View File

@ -18,7 +18,7 @@ export class ArgsFactory {
) {}
public create(
{ args, objectMetadata }: ArgsMetadata,
{ args, objectMetadataId }: ArgsMetadata,
options: WorkspaceBuildSchemaOptions,
): GraphQLFieldConfigArgumentMap {
const fieldConfigMap: GraphQLFieldConfigArgumentMap = {};
@ -65,21 +65,21 @@ export class ArgsFactory {
// Argument is an input type
if (arg.kind) {
const inputType = this.typeDefinitionsStorage.getInputTypeByKey(
objectMetadata.id,
objectMetadataId,
arg.kind,
);
if (!inputType) {
this.logger.error(
`Could not find a GraphQL input type for ${objectMetadata.id}`,
`Could not find a GraphQL input type for ${objectMetadataId}`,
{
objectMetadata,
objectMetadataId,
options,
},
);
throw new Error(
`Could not find a GraphQL input type for ${objectMetadata.id}`,
`Could not find a GraphQL input type for ${objectMetadataId}`,
);
}

View File

@ -155,7 +155,7 @@ export class ExtendObjectTypeDefinitionFactory {
argsType = this.argsFactory.create(
{
args,
objectMetadata: relationMetadata.toObjectMetadata,
objectMetadataId: relationMetadata.toObjectMetadataId,
},
options,
);

View File

@ -81,7 +81,7 @@ export class RootTypeFactory {
const argsType = this.argsFactory.create(
{
args,
objectMetadata,
objectMetadataId: objectMetadata.id,
},
options,
);

View File

@ -1,5 +1,3 @@
import { ObjectMetadataInterface } from 'src/metadata/field-metadata/interfaces/object-metadata.interface';
import { InputTypeDefinitionKind } from 'src/workspace/workspace-schema-builder/factories/input-type-definition.factory';
import { FieldMetadataType } from 'src/metadata/field-metadata/field-metadata.entity';
@ -15,5 +13,5 @@ export interface ArgsMetadata {
args: {
[key: string]: ArgMetadata;
};
objectMetadata: ObjectMetadataInterface;
objectMetadataId: string;
}

View File

@ -51,9 +51,7 @@ export class WorkspaceFactory {
// If object metadata is not cached, get it from the database
if (!objectMetadataCollection) {
objectMetadataCollection =
await this.objectMetadataService.getObjectMetadataFromWorkspaceId(
workspaceId,
);
await this.objectMetadataService.findManyWithinWorkspace(workspaceId);
await this.workspaceSchemaStorageService.setObjectMetadata(
workspaceId,