feat: dynamic graphQL schema generation based on user workspace (#1725)
* wip: refacto and start creating custom resolver * feat: findMany & findUnique of a custom entity * feat: wip pagination * feat: initial metadata migration * feat: universal findAll with pagination * fix: clean small stuff in pagination * fix: test * fix: miss file * feat: rename custom into universal * feat: create metadata schema in default database * Multi-tenant db schemas POC fix tests and use query builders remove synchronize restore updatedAt remove unnecessary import use queryRunner fix camelcase add migrations for standard objects Multi-tenant db schemas POC fix tests and use query builders remove synchronize restore updatedAt remove unnecessary import use queryRunner fix camelcase add migrations for standard objects poc: conditional schema at runtime wip: try to create resolver in Nest.JS context fix * feat: wip add pg_graphql * feat: setup pg_graphql during database init * wip: dynamic resolver * poc: dynamic resolver and query using pg_graphql * feat: pg_graphql use ARG in Dockerfile * feat: clean findMany & findOne dynamic resolver * feat: get correct schema based on access token * fix: remove old file * fix: tests * fix: better comment * fix: e2e test not working, error format change due to yoga * remove typeorm entity generation + fix jwt + fix search_path + remove anon * fix conflict --------- Co-authored-by: Charles Bochet <charles@twenty.com> Co-authored-by: corentin <corentin@twenty.com>
This commit is contained in:
Jérémy M
@ -0,0 +1,24 @@
|
||||
import { GraphQLList, GraphQLNonNull, GraphQLObjectType } from 'graphql';
|
||||
|
||||
import { PageInfoType } from './page-info.graphql-type';
|
||||
|
||||
/**
|
||||
* Generate a GraphQL connection type based on the EdgeType.
|
||||
* @param EdgeType Edge type to be used in the connection.
|
||||
* @returns GraphQL connection type.
|
||||
*/
|
||||
export const generateConnectionType = <T extends GraphQLObjectType>(
|
||||
EdgeType: T,
|
||||
): GraphQLObjectType<any, any> => {
|
||||
return new GraphQLObjectType({
|
||||
name: `${EdgeType.name.slice(0, -4)}Connection`, // Removing 'Edge' from the name
|
||||
fields: {
|
||||
edges: {
|
||||
type: new GraphQLList(EdgeType),
|
||||
},
|
||||
pageInfo: {
|
||||
type: new GraphQLNonNull(PageInfoType),
|
||||
},
|
||||
},
|
||||
});
|
||||
};
|
||||
@ -0,0 +1,22 @@
|
||||
import { GraphQLNonNull, GraphQLObjectType, GraphQLString } from 'graphql';
|
||||
|
||||
/**
|
||||
* Generate a GraphQL edge type based on the ObjectType.
|
||||
* @param ObjectType Object type to be used in the Edge.
|
||||
* @returns GraphQL edge type.
|
||||
*/
|
||||
export const generateEdgeType = <T extends GraphQLObjectType>(
|
||||
ObjectType: T,
|
||||
): GraphQLObjectType<any, any> => {
|
||||
return new GraphQLObjectType({
|
||||
name: `${ObjectType.name}Edge`,
|
||||
fields: {
|
||||
node: {
|
||||
type: ObjectType,
|
||||
},
|
||||
cursor: {
|
||||
type: new GraphQLNonNull(GraphQLString),
|
||||
},
|
||||
},
|
||||
});
|
||||
};
|
||||
@ -0,0 +1,99 @@
|
||||
import {
|
||||
GraphQLBoolean,
|
||||
GraphQLEnumType,
|
||||
GraphQLID,
|
||||
GraphQLInt,
|
||||
GraphQLNonNull,
|
||||
GraphQLObjectType,
|
||||
GraphQLString,
|
||||
} from 'graphql';
|
||||
|
||||
import { FieldMetadata } from 'src/tenant/metadata/field-metadata/field-metadata.entity';
|
||||
import { ObjectMetadata } from 'src/tenant/metadata/object-metadata/object-metadata.entity';
|
||||
import { pascalCase } from 'src/utils/pascal-case';
|
||||
|
||||
/**
|
||||
* Map the column type from field-metadata to its corresponding GraphQL type.
|
||||
* @param columnType Type of the column in the database.
|
||||
*/
|
||||
const mapColumnTypeToGraphQLType = (column: FieldMetadata): any => {
|
||||
switch (column.type) {
|
||||
case 'uuid':
|
||||
return GraphQLID;
|
||||
case 'text':
|
||||
case 'url':
|
||||
case 'date':
|
||||
return GraphQLString;
|
||||
case 'boolean':
|
||||
return GraphQLBoolean;
|
||||
case 'number':
|
||||
return GraphQLInt;
|
||||
case 'enum': {
|
||||
if (column.enums && column.enums.length > 0) {
|
||||
const enumName = `${pascalCase(column.objectId)}${pascalCase(
|
||||
column.displayName,
|
||||
)}Enum`;
|
||||
|
||||
return new GraphQLEnumType({
|
||||
name: enumName,
|
||||
values: Object.fromEntries(
|
||||
column.enums.map((value) => [value, { value }]),
|
||||
),
|
||||
});
|
||||
}
|
||||
}
|
||||
default:
|
||||
return GraphQLString;
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Generate a GraphQL object type based on the name and columns.
|
||||
* @param name Name for the GraphQL object.
|
||||
* @param columns Array of FieldMetadata columns.
|
||||
*/
|
||||
export const generateObjectType = <TSource = any, TContext = any>(
|
||||
name: string,
|
||||
columns: FieldMetadata[],
|
||||
): GraphQLObjectType<TSource, TContext> => {
|
||||
const fields: Record<string, any> = {
|
||||
// Default fields
|
||||
id: { type: new GraphQLNonNull(GraphQLID) },
|
||||
createdAt: { type: new GraphQLNonNull(GraphQLString) },
|
||||
updatedAt: { type: new GraphQLNonNull(GraphQLString) },
|
||||
};
|
||||
|
||||
columns.forEach((column) => {
|
||||
let graphqlType = mapColumnTypeToGraphQLType(column);
|
||||
|
||||
if (!column.isNullable) {
|
||||
graphqlType = new GraphQLNonNull(graphqlType);
|
||||
}
|
||||
|
||||
fields[column.displayName] = {
|
||||
type: graphqlType,
|
||||
description: column.targetColumnName,
|
||||
};
|
||||
});
|
||||
|
||||
return new GraphQLObjectType({
|
||||
name: pascalCase(name),
|
||||
fields,
|
||||
});
|
||||
};
|
||||
|
||||
/**
|
||||
* Generate multiple GraphQL object types based on an array of object metadata.
|
||||
* @param objectMetadata Array of ObjectMetadata.
|
||||
*/
|
||||
export const generateObjectTypes = (objectMetadata: ObjectMetadata[]) => {
|
||||
const objectTypes: Record<string, GraphQLObjectType> = {};
|
||||
|
||||
for (const object of objectMetadata) {
|
||||
const ObjectType = generateObjectType(object.displayName, object.fields);
|
||||
|
||||
objectTypes[object.displayName] = ObjectType;
|
||||
}
|
||||
|
||||
return objectTypes;
|
||||
};
|
||||
@ -0,0 +1,19 @@
|
||||
import {
|
||||
GraphQLBoolean,
|
||||
GraphQLNonNull,
|
||||
GraphQLObjectType,
|
||||
GraphQLString,
|
||||
} from 'graphql';
|
||||
|
||||
/**
|
||||
* GraphQL PageInfo type.
|
||||
*/
|
||||
export const PageInfoType = new GraphQLObjectType({
|
||||
name: 'PageInfo',
|
||||
fields: {
|
||||
startCursor: { type: GraphQLString },
|
||||
endCursor: { type: GraphQLString },
|
||||
hasNextPage: { type: new GraphQLNonNull(GraphQLBoolean) },
|
||||
hasPreviousPage: { type: new GraphQLNonNull(GraphQLBoolean) },
|
||||
},
|
||||
});
|
||||
@ -0,0 +1,21 @@
|
||||
import { Module } from '@nestjs/common';
|
||||
|
||||
import { EntityResolverModule } from 'src/tenant/entity-resolver/entity-resolver.module';
|
||||
import { JwtAuthGuard } from 'src/guards/jwt.auth.guard';
|
||||
import { DataSourceMetadataModule } from 'src/tenant/metadata/data-source-metadata/data-source-metadata.module';
|
||||
import { EntitySchemaGeneratorModule } from 'src/tenant/metadata/entity-schema-generator/entity-schema-generator.module';
|
||||
import { ObjectMetadataModule } from 'src/tenant/metadata/object-metadata/object-metadata.module';
|
||||
|
||||
import { SchemaGenerationService } from './schema-generation.service';
|
||||
|
||||
@Module({
|
||||
imports: [
|
||||
EntityResolverModule,
|
||||
DataSourceMetadataModule,
|
||||
EntitySchemaGeneratorModule,
|
||||
ObjectMetadataModule,
|
||||
],
|
||||
providers: [SchemaGenerationService, JwtAuthGuard],
|
||||
exports: [SchemaGenerationService],
|
||||
})
|
||||
export class SchemaGenerationModule {}
|
||||
@ -0,0 +1,37 @@
|
||||
import { Test, TestingModule } from '@nestjs/testing';
|
||||
|
||||
import { DataSourceMetadataService } from 'src/tenant/metadata/data-source-metadata/data-source-metadata.service';
|
||||
import { ObjectMetadataService } from 'src/tenant/metadata/object-metadata/object-metadata.service';
|
||||
import { EntityResolverService } from 'src/tenant/entity-resolver/entity-resolver.service';
|
||||
|
||||
import { SchemaGenerationService } from './schema-generation.service';
|
||||
|
||||
describe('SchemaGenerationService', () => {
|
||||
let service: SchemaGenerationService;
|
||||
|
||||
beforeEach(async () => {
|
||||
const module: TestingModule = await Test.createTestingModule({
|
||||
providers: [
|
||||
SchemaGenerationService,
|
||||
{
|
||||
provide: DataSourceMetadataService,
|
||||
useValue: {},
|
||||
},
|
||||
{
|
||||
provide: ObjectMetadataService,
|
||||
useValue: {},
|
||||
},
|
||||
{
|
||||
provide: EntityResolverService,
|
||||
useValue: {},
|
||||
},
|
||||
],
|
||||
}).compile();
|
||||
|
||||
service = module.get<SchemaGenerationService>(SchemaGenerationService);
|
||||
});
|
||||
|
||||
it('should be defined', () => {
|
||||
expect(service).toBeDefined();
|
||||
});
|
||||
});
|
||||
150
server/src/tenant/schema-generation/schema-generation.service.ts
Normal file
150
server/src/tenant/schema-generation/schema-generation.service.ts
Normal file
@ -0,0 +1,150 @@
|
||||
import { Injectable, InternalServerErrorException } from '@nestjs/common';
|
||||
|
||||
import {
|
||||
GraphQLID,
|
||||
GraphQLNonNull,
|
||||
GraphQLObjectType,
|
||||
GraphQLResolveInfo,
|
||||
GraphQLSchema,
|
||||
} from 'graphql';
|
||||
|
||||
import { EntityResolverService } from 'src/tenant/entity-resolver/entity-resolver.service';
|
||||
import { DataSourceMetadataService } from 'src/tenant/metadata/data-source-metadata/data-source-metadata.service';
|
||||
import { pascalCase } from 'src/utils/pascal-case';
|
||||
import { ObjectMetadataService } from 'src/tenant/metadata/object-metadata/object-metadata.service';
|
||||
import { ObjectMetadata } from 'src/tenant/metadata/object-metadata/object-metadata.entity';
|
||||
|
||||
import { generateEdgeType } from './graphql-types/edge.graphql-type';
|
||||
import { generateConnectionType } from './graphql-types/connection.graphql-type';
|
||||
import { generateObjectTypes } from './graphql-types/object.graphql-type';
|
||||
|
||||
@Injectable()
|
||||
export class SchemaGenerationService {
|
||||
constructor(
|
||||
private readonly dataSourceMetadataService: DataSourceMetadataService,
|
||||
private readonly objectMetadataService: ObjectMetadataService,
|
||||
private readonly entityResolverService: EntityResolverService,
|
||||
) {}
|
||||
|
||||
private generateQueryFieldForEntity(
|
||||
entityName: string,
|
||||
tableName: string,
|
||||
ObjectType: GraphQLObjectType,
|
||||
objectDefinition: ObjectMetadata,
|
||||
workspaceId: string,
|
||||
) {
|
||||
const fieldAliases =
|
||||
objectDefinition?.fields.reduce(
|
||||
(acc, field) => ({
|
||||
...acc,
|
||||
[field.displayName]: field.targetColumnName,
|
||||
}),
|
||||
{},
|
||||
) || {};
|
||||
|
||||
const EdgeType = generateEdgeType(ObjectType);
|
||||
const ConnectionType = generateConnectionType(EdgeType);
|
||||
|
||||
return {
|
||||
[`findAll${pascalCase(entityName)}`]: {
|
||||
type: ConnectionType,
|
||||
resolve: async (root, args, context, info: GraphQLResolveInfo) => {
|
||||
return this.entityResolverService.findAll(
|
||||
entityName,
|
||||
tableName,
|
||||
workspaceId,
|
||||
info,
|
||||
fieldAliases,
|
||||
);
|
||||
},
|
||||
},
|
||||
[`findOne${pascalCase(entityName)}`]: {
|
||||
type: ObjectType,
|
||||
args: {
|
||||
id: { type: new GraphQLNonNull(GraphQLID) },
|
||||
},
|
||||
resolve: (root, args, context, info) => {
|
||||
return this.entityResolverService.findOne(
|
||||
entityName,
|
||||
tableName,
|
||||
args,
|
||||
workspaceId,
|
||||
info,
|
||||
fieldAliases,
|
||||
);
|
||||
},
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
private generateQueryType(
|
||||
ObjectTypes: Record<string, GraphQLObjectType>,
|
||||
objectMetadata: ObjectMetadata[],
|
||||
workspaceId: string,
|
||||
): GraphQLObjectType {
|
||||
const fields: any = {};
|
||||
|
||||
for (const [entityName, ObjectType] of Object.entries(ObjectTypes)) {
|
||||
const objectDefinition = objectMetadata.find(
|
||||
(object) => object.displayName === entityName,
|
||||
);
|
||||
const tableName = objectDefinition?.targetTableName ?? '';
|
||||
|
||||
if (!objectDefinition) {
|
||||
throw new InternalServerErrorException('Object definition not found');
|
||||
}
|
||||
|
||||
Object.assign(
|
||||
fields,
|
||||
this.generateQueryFieldForEntity(
|
||||
entityName,
|
||||
tableName,
|
||||
ObjectType,
|
||||
objectDefinition,
|
||||
workspaceId,
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
return new GraphQLObjectType({
|
||||
name: 'Query',
|
||||
fields,
|
||||
});
|
||||
}
|
||||
|
||||
async generateSchema(
|
||||
workspaceId: string | undefined,
|
||||
): Promise<GraphQLSchema> {
|
||||
if (!workspaceId) {
|
||||
return new GraphQLSchema({});
|
||||
}
|
||||
|
||||
const dataSourcesMetadata =
|
||||
await this.dataSourceMetadataService.getDataSourcesMetadataFromWorkspaceId(
|
||||
workspaceId,
|
||||
);
|
||||
|
||||
// Can'f find any data sources for this workspace
|
||||
if (!dataSourcesMetadata || dataSourcesMetadata.length === 0) {
|
||||
return new GraphQLSchema({});
|
||||
}
|
||||
|
||||
const dataSourceMetadata = dataSourcesMetadata[0];
|
||||
|
||||
const objectMetadata =
|
||||
await this.objectMetadataService.getObjectMetadataFromDataSourceId(
|
||||
dataSourceMetadata.id,
|
||||
);
|
||||
|
||||
const ObjectTypes = generateObjectTypes(objectMetadata);
|
||||
const QueryType = this.generateQueryType(
|
||||
ObjectTypes,
|
||||
objectMetadata,
|
||||
workspaceId,
|
||||
);
|
||||
|
||||
return new GraphQLSchema({
|
||||
query: QueryType,
|
||||
});
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user