Refactor backend folder structure (#4505)

* Refactor backend folder structure

Co-authored-by: Charles Bochet <charles@twenty.com>

* fix tests

* fix

* move yoga hooks

---------

Co-authored-by: Charles Bochet <charles@twenty.com>
This commit is contained in:
Weiko
2024-03-15 18:37:09 +01:00
committed by GitHub
parent afb9b3e375
commit 2c09096edd
523 changed files with 1386 additions and 1856 deletions

View File

@ -0,0 +1,53 @@
import { cleanGraphQLResponse } from 'src/engine/api/rest/api-rest.controller.utils';
describe('cleanGraphQLResponse', () => {
it('should remove edges/node from results', () => {
const data = {
companies: {
edges: [
{
node: { id: 'id', createdAt: '2023-01-01' },
},
],
},
};
const expectedResult = {
companies: [{ id: 'id', createdAt: '2023-01-01' }],
};
expect(cleanGraphQLResponse(data)).toEqual(expectedResult);
});
it('should remove nested edges/node from results', () => {
const data = {
companies: {
edges: [
{
node: {
id: 'id',
createdAt: '2023-01-01',
people: {
edges: [{ node: { id: 'id1' } }, { node: { id: 'id2' } }],
},
},
},
],
},
};
const expectedResult = {
companies: [
{
id: 'id',
createdAt: '2023-01-01',
people: [{ id: 'id1' }, { id: 'id2' }],
},
],
};
expect(cleanGraphQLResponse(data)).toEqual(expectedResult);
});
it('should not format when no list returned', () => {
const data = { company: { id: 'id' } };
expect(cleanGraphQLResponse(data)).toEqual(data);
});
});

View File

@ -0,0 +1,40 @@
import { Test, TestingModule } from '@nestjs/testing';
import { HttpService } from '@nestjs/axios';
import { ApiRestService } from 'src/engine/api/rest/api-rest.service';
import { EnvironmentService } from 'src/engine/integrations/environment/environment.service';
import { TokenService } from 'src/engine/modules/auth/services/token.service';
import { ApiRestQueryBuilderFactory } from 'src/engine/api/rest/api-rest-query-builder/api-rest-query-builder.factory';
describe('ApiRestService', () => {
let service: ApiRestService;
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
providers: [
ApiRestService,
{
provide: ApiRestQueryBuilderFactory,
useValue: {},
},
{
provide: EnvironmentService,
useValue: {},
},
{
provide: TokenService,
useValue: {},
},
{
provide: HttpService,
useValue: {},
},
],
}).compile();
service = module.get<ApiRestService>(ApiRestService);
});
it('should be defined', () => {
expect(service).toBeDefined();
});
});

View File

@ -0,0 +1,46 @@
import { Test, TestingModule } from '@nestjs/testing';
import { ApiRestQueryBuilderFactory } from 'src/engine/api/rest/api-rest-query-builder/api-rest-query-builder.factory';
import { DeleteQueryFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/delete-query.factory';
import { CreateQueryFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/create-query.factory';
import { UpdateQueryFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/update-query.factory';
import { FindOneQueryFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/find-one-query.factory';
import { FindManyQueryFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/find-many-query.factory';
import { DeleteVariablesFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/delete-variables.factory';
import { CreateVariablesFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/create-variables.factory';
import { UpdateVariablesFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/update-variables.factory';
import { GetVariablesFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/get-variables.factory';
import { ObjectMetadataService } from 'src/engine-metadata/object-metadata/object-metadata.service';
import { TokenService } from 'src/engine/modules/auth/services/token.service';
import { EnvironmentService } from 'src/engine/integrations/environment/environment.service';
describe('ApiRestQueryBuilderFactory', () => {
let service: ApiRestQueryBuilderFactory;
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
providers: [
ApiRestQueryBuilderFactory,
{ provide: DeleteQueryFactory, useValue: {} },
{ provide: CreateQueryFactory, useValue: {} },
{ provide: UpdateQueryFactory, useValue: {} },
{ provide: FindOneQueryFactory, useValue: {} },
{ provide: FindManyQueryFactory, useValue: {} },
{ provide: DeleteVariablesFactory, useValue: {} },
{ provide: CreateVariablesFactory, useValue: {} },
{ provide: UpdateVariablesFactory, useValue: {} },
{ provide: GetVariablesFactory, useValue: {} },
{ provide: ObjectMetadataService, useValue: {} },
{ provide: TokenService, useValue: {} },
{ provide: EnvironmentService, useValue: {} },
],
}).compile();
service = module.get<ApiRestQueryBuilderFactory>(
ApiRestQueryBuilderFactory,
);
});
it('should be defined', () => {
expect(service).toBeDefined();
});
});

View File

@ -0,0 +1,145 @@
import { BadRequestException, Injectable } from '@nestjs/common';
import { Request } from 'express';
import { DeleteQueryFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/delete-query.factory';
import { ObjectMetadataService } from 'src/engine-metadata/object-metadata/object-metadata.service';
import { TokenService } from 'src/engine/modules/auth/services/token.service';
import { CreateQueryFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/create-query.factory';
import { UpdateQueryFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/update-query.factory';
import { FindOneQueryFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/find-one-query.factory';
import { FindManyQueryFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/find-many-query.factory';
import { DeleteVariablesFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/delete-variables.factory';
import { CreateVariablesFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/create-variables.factory';
import { UpdateVariablesFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/update-variables.factory';
import { GetVariablesFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/get-variables.factory';
import { parsePath } from 'src/engine/api/rest/api-rest-query-builder/utils/parse-path.utils';
import { computeDepth } from 'src/engine/api/rest/api-rest-query-builder/utils/compute-depth.utils';
import { ObjectMetadataEntity } from 'src/engine-metadata/object-metadata/object-metadata.entity';
import { ApiRestQuery } from 'src/engine/api/rest/types/api-rest-query.type';
import { EnvironmentService } from 'src/engine/integrations/environment/environment.service';
@Injectable()
export class ApiRestQueryBuilderFactory {
constructor(
private readonly deleteQueryFactory: DeleteQueryFactory,
private readonly createQueryFactory: CreateQueryFactory,
private readonly updateQueryFactory: UpdateQueryFactory,
private readonly findOneQueryFactory: FindOneQueryFactory,
private readonly findManyQueryFactory: FindManyQueryFactory,
private readonly deleteVariablesFactory: DeleteVariablesFactory,
private readonly createVariablesFactory: CreateVariablesFactory,
private readonly updateVariablesFactory: UpdateVariablesFactory,
private readonly getVariablesFactory: GetVariablesFactory,
private readonly objectMetadataService: ObjectMetadataService,
private readonly tokenService: TokenService,
private readonly environmentService: EnvironmentService,
) {}
async getObjectMetadata(request: Request): Promise<{
objectMetadataItems: ObjectMetadataEntity[];
objectMetadataItem: ObjectMetadataEntity;
}> {
const { workspace } = await this.tokenService.validateToken(request);
const objectMetadataItems =
await this.objectMetadataService.findManyWithinWorkspace(workspace.id);
if (!objectMetadataItems.length) {
throw new BadRequestException(
`No object was found for the workspace associated with this API key. You may generate a new one here ${this.environmentService.get(
'FRONT_BASE_URL',
)}/settings/developers`,
);
}
const { object: parsedObject } = parsePath(request);
const [objectMetadata] = objectMetadataItems.filter(
(object) => object.namePlural === parsedObject,
);
if (!objectMetadata) {
const [wrongObjectMetadata] = objectMetadataItems.filter(
(object) => object.nameSingular === parsedObject,
);
let hint = 'eg: companies';
if (wrongObjectMetadata) {
hint = `Did you mean '${wrongObjectMetadata.namePlural}'?`;
}
throw new BadRequestException(
`object '${parsedObject}' not found. ${hint}`,
);
}
return {
objectMetadataItems,
objectMetadataItem: objectMetadata,
};
}
async delete(request: Request): Promise<ApiRestQuery> {
const objectMetadata = await this.getObjectMetadata(request);
const { id } = parsePath(request);
if (!id) {
throw new BadRequestException(
`delete ${objectMetadata.objectMetadataItem.nameSingular} query invalid. Id missing. eg: /rest/${objectMetadata.objectMetadataItem.namePlural}/0d4389ef-ea9c-4ae8-ada1-1cddc440fb56`,
);
}
return {
query: this.deleteQueryFactory.create(objectMetadata.objectMetadataItem),
variables: this.deleteVariablesFactory.create(id),
};
}
async create(request): Promise<ApiRestQuery> {
const objectMetadata = await this.getObjectMetadata(request);
const depth = computeDepth(request);
return {
query: this.createQueryFactory.create(objectMetadata, depth),
variables: this.createVariablesFactory.create(request),
};
}
async update(request): Promise<ApiRestQuery> {
const objectMetadata = await this.getObjectMetadata(request);
const depth = computeDepth(request);
const { id } = parsePath(request);
if (!id) {
throw new BadRequestException(
`update ${objectMetadata.objectMetadataItem.nameSingular} query invalid. Id missing. eg: /rest/${objectMetadata.objectMetadataItem.namePlural}/0d4389ef-ea9c-4ae8-ada1-1cddc440fb56`,
);
}
return {
query: this.updateQueryFactory.create(objectMetadata, depth),
variables: this.updateVariablesFactory.create(id, request),
};
}
async get(request): Promise<ApiRestQuery> {
const objectMetadata = await this.getObjectMetadata(request);
const depth = computeDepth(request);
const { id } = parsePath(request);
return {
query: id
? this.findOneQueryFactory.create(objectMetadata, depth)
: this.findManyQueryFactory.create(objectMetadata, depth),
variables: this.getVariablesFactory.create(id, request, objectMetadata),
};
}
}

View File

@ -0,0 +1,13 @@
import { Module } from '@nestjs/common';
import { ApiRestQueryBuilderFactory } from 'src/engine/api/rest/api-rest-query-builder/api-rest-query-builder.factory';
import { apiRestQueryBuilderFactories } from 'src/engine/api/rest/api-rest-query-builder/factories/factories';
import { ObjectMetadataModule } from 'src/engine-metadata/object-metadata/object-metadata.module';
import { AuthModule } from 'src/engine/modules/auth/auth.module';
@Module({
imports: [ObjectMetadataModule, AuthModule],
providers: [...apiRestQueryBuilderFactories, ApiRestQueryBuilderFactory],
exports: [ApiRestQueryBuilderFactory],
})
export class ApiRestQueryBuilderModule {}

View File

@ -0,0 +1,30 @@
import { Injectable } from '@nestjs/common';
import { capitalize } from 'src/utils/capitalize';
import { mapFieldMetadataToGraphqlQuery } from 'src/engine/api/rest/api-rest-query-builder/utils/map-field-metadata-to-graphql-query.utils';
@Injectable()
export class CreateQueryFactory {
create(objectMetadata, depth?: number): string {
const objectNameSingular = capitalize(
objectMetadata.objectMetadataItem.nameSingular,
);
return `
mutation Create${objectNameSingular}($data: ${objectNameSingular}CreateInput!) {
create${objectNameSingular}(data: $data) {
id
${objectMetadata.objectMetadataItem.fields
.map((field) =>
mapFieldMetadataToGraphqlQuery(
objectMetadata.objectMetadataItems,
field,
depth,
),
)
.join('\n')}
}
}
`;
}
}

View File

@ -0,0 +1,12 @@
import { Injectable } from '@nestjs/common';
import { ApiRestQueryVariables } from 'src/engine/api/rest/types/api-rest-query-variables.type';
@Injectable()
export class CreateVariablesFactory {
create(request: Request): ApiRestQueryVariables {
return {
data: request.body,
};
}
}

View File

@ -0,0 +1,18 @@
import { Injectable } from '@nestjs/common';
import { capitalize } from 'src/utils/capitalize';
@Injectable()
export class DeleteQueryFactory {
create(objectMetadataItem): string {
const objectNameSingular = capitalize(objectMetadataItem.nameSingular);
return `
mutation Delete${objectNameSingular}($id: ID!) {
delete${objectNameSingular}(id: $id) {
id
}
}
`;
}
}

View File

@ -0,0 +1,12 @@
import { Injectable } from '@nestjs/common';
import { ApiRestQueryVariables } from 'src/engine/api/rest/types/api-rest-query-variables.type';
@Injectable()
export class DeleteVariablesFactory {
create(id: string): ApiRestQueryVariables {
return {
id: id,
};
}
}

View File

@ -0,0 +1,29 @@
import { DeleteQueryFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/delete-query.factory';
import { CreateQueryFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/create-query.factory';
import { UpdateQueryFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/update-query.factory';
import { FindOneQueryFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/find-one-query.factory';
import { FindManyQueryFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/find-many-query.factory';
import { DeleteVariablesFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/delete-variables.factory';
import { CreateVariablesFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/create-variables.factory';
import { UpdateVariablesFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/update-variables.factory';
import { GetVariablesFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/get-variables.factory';
import { LastCursorInputFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/input-factories/last-cursor-input.factory';
import { LimitInputFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/input-factories/limit-input.factory';
import { OrderByInputFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/input-factories/order-by-input.factory';
import { FilterInputFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/input-factories/filter-input.factory';
export const apiRestQueryBuilderFactories = [
DeleteQueryFactory,
CreateQueryFactory,
UpdateQueryFactory,
FindOneQueryFactory,
FindManyQueryFactory,
DeleteVariablesFactory,
CreateVariablesFactory,
UpdateVariablesFactory,
GetVariablesFactory,
LastCursorInputFactory,
LimitInputFactory,
OrderByInputFactory,
FilterInputFactory,
];

View File

@ -0,0 +1,48 @@
import { Injectable } from '@nestjs/common';
import { capitalize } from 'src/utils/capitalize';
import { mapFieldMetadataToGraphqlQuery } from 'src/engine/api/rest/api-rest-query-builder/utils/map-field-metadata-to-graphql-query.utils';
@Injectable()
export class FindManyQueryFactory {
create(objectMetadata, depth?: number): string {
const objectNameSingular = capitalize(
objectMetadata.objectMetadataItem.nameSingular,
);
const objectNamePlural = objectMetadata.objectMetadataItem.namePlural;
return `
query FindMany${capitalize(objectNamePlural)}(
$filter: ${objectNameSingular}FilterInput,
$orderBy: ${objectNameSingular}OrderByInput,
$lastCursor: String,
$limit: Float = 60
) {
${objectNamePlural}(
filter: $filter, orderBy: $orderBy, first: $limit, after: $lastCursor
) {
edges {
node {
id
${objectMetadata.objectMetadataItem.fields
.map((field) =>
mapFieldMetadataToGraphqlQuery(
objectMetadata.objectMetadataItems,
field,
depth,
),
)
.join('\n')}
}
cursor
}
pageInfo {
hasNextPage
startCursor
endCursor
}
}
}
`;
}
}

View File

@ -0,0 +1,30 @@
import { Injectable } from '@nestjs/common';
import { capitalize } from 'src/utils/capitalize';
import { mapFieldMetadataToGraphqlQuery } from 'src/engine/api/rest/api-rest-query-builder/utils/map-field-metadata-to-graphql-query.utils';
@Injectable()
export class FindOneQueryFactory {
create(objectMetadata, depth?: number): string {
const objectNameSingular = objectMetadata.objectMetadataItem.nameSingular;
return `
query FindOne${capitalize(objectNameSingular)}(
$filter: ${capitalize(objectNameSingular)}FilterInput!,
) {
${objectNameSingular}(filter: $filter) {
id
${objectMetadata.objectMetadataItem.fields
.map((field) =>
mapFieldMetadataToGraphqlQuery(
objectMetadata.objectMetadataItems,
field,
depth,
),
)
.join('\n')}
}
}
`;
}
}

View File

@ -0,0 +1,36 @@
import { Injectable } from '@nestjs/common';
import { Request } from 'express';
import { LastCursorInputFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/input-factories/last-cursor-input.factory';
import { LimitInputFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/input-factories/limit-input.factory';
import { OrderByInputFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/input-factories/order-by-input.factory';
import { FilterInputFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/input-factories/filter-input.factory';
import { ApiRestQueryVariables } from 'src/engine/api/rest/types/api-rest-query-variables.type';
@Injectable()
export class GetVariablesFactory {
constructor(
private readonly lastCursorInputFactory: LastCursorInputFactory,
private readonly limitInputFactory: LimitInputFactory,
private readonly orderByInputFactory: OrderByInputFactory,
private readonly filterInputFactory: FilterInputFactory,
) {}
create(
id: string | undefined,
request: Request,
objectMetadata,
): ApiRestQueryVariables {
if (id) {
return { filter: { id: { eq: id } } };
}
return {
filter: this.filterInputFactory.create(request, objectMetadata),
orderBy: this.orderByInputFactory.create(request, objectMetadata),
limit: this.limitInputFactory.create(request),
lastCursor: this.lastCursorInputFactory.create(request),
};
}
}

View File

@ -0,0 +1,120 @@
import { Test, TestingModule } from '@nestjs/testing';
import { objectMetadataItemMock } from 'src/engine/api/__mocks__/object-metadata-item.mock';
import { FilterInputFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/input-factories/filter-input.factory';
describe('FilterInputFactory', () => {
const objectMetadata = { objectMetadataItem: objectMetadataItemMock };
let service: FilterInputFactory;
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
providers: [FilterInputFactory],
}).compile();
service = module.get<FilterInputFactory>(FilterInputFactory);
});
it('should be defined', () => {
expect(service).toBeDefined();
});
describe('create', () => {
it('should return default if filter missing', () => {
const request: any = { query: {} };
expect(service.create(request, objectMetadata)).toEqual({});
});
it('should throw when wrong field provided', () => {
const request: any = {
query: {
filter: 'wrongField[eq]:1',
},
};
expect(() => service.create(request, objectMetadata)).toThrow(
"field 'wrongField' does not exist in 'objectName' object",
);
});
it('should throw when wrong comparator provided', () => {
const request: any = {
query: {
filter: 'fieldNumber[wrongComparator]:1',
},
};
expect(() => service.create(request, objectMetadata)).toThrow(
"'filter' invalid for 'fieldNumber[wrongComparator]:1', comparator wrongComparator not in eq,neq,in,is,gt,gte,lt,lte,startsWith,like,ilike",
);
});
it('should throw when wrong filter provided', () => {
const request: any = {
query: {
filter: 'fieldNumber[wrongComparator:1',
},
};
expect(() => service.create(request, objectMetadata)).toThrow(
"'filter' invalid for 'fieldNumber[wrongComparator:1'. eg: price[gte]:10",
);
});
it('should throw when parenthesis are not closed', () => {
const request: any = {
query: {
filter: 'and(fieldNumber[eq]:1,not(fieldNumber[neq]:1)',
},
};
expect(() => service.create(request, objectMetadata)).toThrow(
"'filter' invalid. 1 close bracket is missing in the query",
);
});
it('should create filter parser properly', () => {
const request: any = {
query: {
filter: 'fieldNumber[eq]:1,fieldString[eq]:"Test"',
},
};
expect(service.create(request, objectMetadata)).toEqual({
and: [{ fieldNumber: { eq: 1 } }, { fieldString: { eq: 'Test' } }],
});
});
it('should create complex filter parser properly', () => {
const request: any = {
query: {
filter:
'and(fieldNumber[eq]:1,fieldString[gte]:"Test",not(fieldString[ilike]:"%val%"),or(not(and(fieldString[startsWith]:"test",fieldNumber[in]:[2,4,5])),fieldCurrency.amountMicros[gt]:1))',
},
};
expect(service.create(request, objectMetadata)).toEqual({
and: [
{ fieldNumber: { eq: 1 } },
{ fieldString: { gte: 'Test' } },
{ not: { fieldString: { ilike: '%val%' } } },
{
or: [
{
not: {
and: [
{ fieldString: { startsWith: 'test' } },
{ fieldNumber: { in: [2, 4, 5] } },
],
},
},
{ fieldCurrency: { amountMicros: { gt: '1' } } },
],
},
],
});
});
});
});

View File

@ -0,0 +1,33 @@
import { Test, TestingModule } from '@nestjs/testing';
import { LastCursorInputFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/input-factories/last-cursor-input.factory';
describe('LastCursorInputFactory', () => {
let service: LastCursorInputFactory;
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
providers: [LastCursorInputFactory],
}).compile();
service = module.get<LastCursorInputFactory>(LastCursorInputFactory);
});
it('should be defined', () => {
expect(service).toBeDefined();
});
describe('create', () => {
it('should return default if last_cursor missing', () => {
const request: any = { query: {} };
expect(service.create(request)).toEqual(undefined);
});
it('should return last_cursor', () => {
const request: any = { query: { last_cursor: 'uuid' } };
expect(service.create(request)).toEqual('uuid');
});
});
});

View File

@ -0,0 +1,49 @@
import { Test, TestingModule } from '@nestjs/testing';
import { LimitInputFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/input-factories/limit-input.factory';
describe('LimitInputFactory', () => {
let service: LimitInputFactory;
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
providers: [LimitInputFactory],
}).compile();
service = module.get<LimitInputFactory>(LimitInputFactory);
});
it('should be defined', () => {
expect(service).toBeDefined();
});
describe('create', () => {
it('should return default if limit missing', () => {
const request: any = { query: {} };
expect(service.create(request)).toEqual(60);
});
it('should return limit', () => {
const request: any = { query: { limit: '10' } };
expect(service.create(request)).toEqual(10);
});
it('should throw if not integer', () => {
const request: any = { query: { limit: 'aaa' } };
expect(() => service.create(request)).toThrow(
"limit 'aaa' is invalid. Should be an integer",
);
});
it('should throw if limit negative', () => {
const request: any = { query: { limit: -1 } };
expect(() => service.create(request)).toThrow(
"limit '-1' is invalid. Should be an integer",
);
});
});
});

View File

@ -0,0 +1,119 @@
import { Test, TestingModule } from '@nestjs/testing';
import { OrderByDirection } from 'src/engine/api/graphql/workspace-query-builder/interfaces/record.interface';
import { objectMetadataItemMock } from 'src/engine/api/__mocks__/object-metadata-item.mock';
import { OrderByInputFactory } from 'src/engine/api/rest/api-rest-query-builder/factories/input-factories/order-by-input.factory';
describe('OrderByInputFactory', () => {
const objectMetadata = { objectMetadataItem: objectMetadataItemMock };
let service: OrderByInputFactory;
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
providers: [OrderByInputFactory],
}).compile();
service = module.get<OrderByInputFactory>(OrderByInputFactory);
});
it('should be defined', () => {
expect(service).toBeDefined();
});
describe('create', () => {
it('should return default if order by missing', () => {
const request: any = { query: {} };
expect(service.create(request, objectMetadata)).toEqual({});
});
it('should create order by parser properly', () => {
const request: any = {
query: {
order_by: 'fieldNumber[AscNullsFirst],fieldString[DescNullsLast]',
},
};
expect(service.create(request, objectMetadata)).toEqual({
fieldNumber: OrderByDirection.AscNullsFirst,
fieldString: OrderByDirection.DescNullsLast,
});
});
it('should choose default direction if missing', () => {
const request: any = {
query: {
order_by: 'fieldNumber',
},
};
expect(service.create(request, objectMetadata)).toEqual({
fieldNumber: OrderByDirection.AscNullsFirst,
});
});
it('should handler complex fields', () => {
const request: any = {
query: {
order_by: 'fieldCurrency.amountMicros',
},
};
expect(service.create(request, objectMetadata)).toEqual({
fieldCurrency: { amountMicros: OrderByDirection.AscNullsFirst },
});
});
it('should handler complex fields with direction', () => {
const request: any = {
query: {
order_by: 'fieldCurrency.amountMicros[DescNullsLast]',
},
};
expect(service.create(request, objectMetadata)).toEqual({
fieldCurrency: { amountMicros: OrderByDirection.DescNullsLast },
});
});
it('should handler multiple complex fields with direction', () => {
const request: any = {
query: {
order_by:
'fieldCurrency.amountMicros[DescNullsLast],fieldLink.label[AscNullsLast]',
},
};
expect(service.create(request, objectMetadata)).toEqual({
fieldCurrency: { amountMicros: OrderByDirection.DescNullsLast },
fieldLink: { label: OrderByDirection.AscNullsLast },
});
});
it('should throw if direction invalid', () => {
const request: any = {
query: {
order_by: 'fieldString[invalid]',
},
};
expect(() => service.create(request, objectMetadata)).toThrow(
"'order_by' direction 'invalid' invalid. Allowed values are 'AscNullsFirst', 'AscNullsLast', 'DescNullsFirst', 'DescNullsLast'. eg: ?order_by=field_1[AscNullsFirst],field_2[DescNullsLast],field_3",
);
});
it('should throw if field invalid', () => {
const request: any = {
query: {
order_by: 'wrongField[DescNullsLast]',
},
};
expect(() => service.create(request, objectMetadata)).toThrow(
"field 'wrongField' does not exist in 'objectName' object",
);
});
});
});

View File

@ -0,0 +1,25 @@
import { Injectable } from '@nestjs/common';
import { Request } from 'express';
import { addDefaultConjunctionIfMissing } from 'src/engine/api/rest/api-rest-query-builder/factories/input-factories/filter-utils/add-default-conjunction.utils';
import { checkFilterQuery } from 'src/engine/api/rest/api-rest-query-builder/factories/input-factories/filter-utils/check-filter-query.utils';
import { parseFilter } from 'src/engine/api/rest/api-rest-query-builder/factories/input-factories/filter-utils/parse-filter.utils';
import { FieldValue } from 'src/engine/api/rest/types/api-rest-field-value.type';
@Injectable()
export class FilterInputFactory {
create(request: Request, objectMetadata): Record<string, FieldValue> {
let filterQuery = request.query.filter;
if (typeof filterQuery !== 'string') {
return {};
}
checkFilterQuery(filterQuery);
filterQuery = addDefaultConjunctionIfMissing(filterQuery);
return parseFilter(filterQuery, objectMetadata.objectMetadataItem);
}
}

View File

@ -0,0 +1,15 @@
import { addDefaultConjunctionIfMissing } from 'src/engine/api/rest/api-rest-query-builder/factories/input-factories/filter-utils/add-default-conjunction.utils';
describe('addDefaultConjunctionIfMissing', () => {
it('should add default conjunction if missing', () => {
expect(addDefaultConjunctionIfMissing('field[eq]:1')).toEqual(
'and(field[eq]:1)',
);
});
it('should not add default conjunction if not missing', () => {
expect(addDefaultConjunctionIfMissing('and(field[eq]:1)')).toEqual(
'and(field[eq]:1)',
);
});
});

View File

@ -0,0 +1,33 @@
import { checkFilterQuery } from 'src/engine/api/rest/api-rest-query-builder/factories/input-factories/filter-utils/check-filter-query.utils';
describe('checkFilterQuery', () => {
it('should check filter query', () => {
expect(() => checkFilterQuery('(')).toThrow(
"'filter' invalid. 1 close bracket is missing in the query",
);
expect(() => checkFilterQuery(')')).toThrow(
"'filter' invalid. 1 open bracket is missing in the query",
);
expect(() => checkFilterQuery('(()')).toThrow(
"'filter' invalid. 1 close bracket is missing in the query",
);
expect(() => checkFilterQuery('()))')).toThrow(
"'filter' invalid. 2 open brackets are missing in the query",
);
expect(() =>
checkFilterQuery(
'and(or(fieldNumber[eq]:1,fieldNumber[eq]:2)),fieldNumber[eq]:3)',
),
).toThrow("'filter' invalid. 1 open bracket is missing in the query");
expect(() =>
checkFilterQuery(
'and(or(fieldNumber[eq]:1,fieldNumber[eq]:2),fieldNumber[eq]:3)',
),
).not.toThrow();
});
});

View File

@ -0,0 +1,56 @@
import { FieldMetadataType } from 'src/engine-metadata/field-metadata/field-metadata.entity';
import { formatFieldValue } from 'src/engine/api/rest/api-rest-query-builder/factories/input-factories/filter-utils/format-field-values.utils';
describe('formatFieldValue', () => {
it('should format fieldNumber value', () => {
expect(formatFieldValue('1', FieldMetadataType.NUMBER)).toEqual(1);
expect(formatFieldValue('a', FieldMetadataType.NUMBER)).toEqual(NaN);
expect(formatFieldValue('true', FieldMetadataType.BOOLEAN)).toEqual(true);
expect(formatFieldValue('True', FieldMetadataType.BOOLEAN)).toEqual(true);
expect(formatFieldValue('false', FieldMetadataType.BOOLEAN)).toEqual(false);
expect(formatFieldValue('value', FieldMetadataType.TEXT)).toEqual('value');
expect(formatFieldValue('"value"', FieldMetadataType.TEXT)).toEqual(
'value',
);
expect(formatFieldValue("'value'", FieldMetadataType.TEXT)).toEqual(
'value',
);
expect(formatFieldValue('value', FieldMetadataType.DATE_TIME)).toEqual(
'value',
);
expect(formatFieldValue('"value"', FieldMetadataType.DATE_TIME)).toEqual(
'value',
);
expect(formatFieldValue("'value'", FieldMetadataType.DATE_TIME)).toEqual(
'value',
);
expect(
formatFieldValue(
'["2023-12-01T14:23:23.914Z","2024-12-01T14:23:23.914Z"]',
undefined,
'in',
),
).toEqual(['2023-12-01T14:23:23.914Z', '2024-12-01T14:23:23.914Z']);
expect(formatFieldValue('[1,2]', FieldMetadataType.NUMBER, 'in')).toEqual([
1, 2,
]);
expect(() =>
formatFieldValue('2024-12-01T14:23:23.914Z', undefined, 'in'),
).toThrow(
"'filter' invalid for 'in' operator. Received '2024-12-01T14:23:23.914Z' but array value expected eg: 'field[in]:[value_1,value_2]'",
);
});
});

View File

@ -0,0 +1,49 @@
import { parseBaseFilter } from 'src/engine/api/rest/api-rest-query-builder/factories/input-factories/filter-utils/parse-base-filter.utils';
describe('parseBaseFilter', () => {
it('should parse simple filter string test 1', () => {
expect(parseBaseFilter('price[lte]:100')).toEqual({
fields: ['price'],
comparator: 'lte',
value: '100',
});
});
it('should parse simple filter string test 2', () => {
expect(parseBaseFilter('date[gt]:2023-12-01T14:23:23.914Z')).toEqual({
fields: ['date'],
comparator: 'gt',
value: '2023-12-01T14:23:23.914Z',
});
});
it('should parse simple filter string test 3', () => {
expect(parseBaseFilter('fieldNumber[gt]:valStart]:[valEnd')).toEqual({
fields: ['fieldNumber'],
comparator: 'gt',
value: 'valStart]:[valEnd',
});
});
it('should parse simple filter string test 4', () => {
expect(
parseBaseFilter('person.createdAt[gt]:"2023-12-01T14:23:23.914Z"'),
).toEqual({
fields: ['person', 'createdAt'],
comparator: 'gt',
value: '"2023-12-01T14:23:23.914Z"',
});
});
it('should parse simple filter string test 5', () => {
expect(
parseBaseFilter(
'person.createdAt[in]:["2023-12-01T14:23:23.914Z","2024-12-01T14:23:23.914Z"]',
),
).toEqual({
fields: ['person', 'createdAt'],
comparator: 'in',
value: '["2023-12-01T14:23:23.914Z","2024-12-01T14:23:23.914Z"]',
});
});
});

View File

@ -0,0 +1,54 @@
import { parseFilterContent } from 'src/engine/api/rest/api-rest-query-builder/factories/input-factories/filter-utils/parse-filter-content.utils';
describe('parseFilterContent', () => {
it('should parse query filter test 1', () => {
expect(parseFilterContent('and(fieldNumber[eq]:1)')).toEqual([
'fieldNumber[eq]:1',
]);
});
it('should parse query filter test 2', () => {
expect(
parseFilterContent('and(fieldNumber[eq]:1,fieldNumber[eq]:2)'),
).toEqual(['fieldNumber[eq]:1', 'fieldNumber[eq]:2']);
});
it('should parse query filter test 3', () => {
expect(
parseFilterContent(
'and(fieldNumber[eq]:1,or(fieldNumber[eq]:2,fieldNumber[eq]:3))',
),
).toEqual(['fieldNumber[eq]:1', 'or(fieldNumber[eq]:2,fieldNumber[eq]:3)']);
});
it('should parse query filter test 4', () => {
expect(
parseFilterContent(
'and(fieldNumber[eq]:1,or(fieldNumber[eq]:2,not(fieldNumber[eq]:3)),fieldNumber[eq]:4,not(fieldNumber[eq]:5))',
),
).toEqual([
'fieldNumber[eq]:1',
'or(fieldNumber[eq]:2,not(fieldNumber[eq]:3))',
'fieldNumber[eq]:4',
'not(fieldNumber[eq]:5)',
]);
});
it('should parse query filter test 5', () => {
expect(
parseFilterContent('and(fieldNumber[in]:[1,2],fieldNumber[eq]:4)'),
).toEqual(['fieldNumber[in]:[1,2]', 'fieldNumber[eq]:4']);
});
it('should parse query filter with comma in value ', () => {
expect(parseFilterContent('and(fieldString[eq]:"val,ue")')).toEqual([
'fieldString[eq]:"val,ue"',
]);
});
it('should parse query filter with comma in value ', () => {
expect(parseFilterContent("and(fieldString[eq]:'val,ue')")).toEqual([
"fieldString[eq]:'val,ue'",
]);
});
});

View File

@ -0,0 +1,92 @@
import { objectMetadataItemMock } from 'src/engine/api/__mocks__/object-metadata-item.mock';
import { parseFilter } from 'src/engine/api/rest/api-rest-query-builder/factories/input-factories/filter-utils/parse-filter.utils';
describe('parseFilter', () => {
it('should parse string filter test 1', () => {
expect(
parseFilter(
'and(fieldNumber[eq]:1,fieldNumber[eq]:2)',
objectMetadataItemMock,
),
).toEqual({
and: [{ fieldNumber: { eq: 1 } }, { fieldNumber: { eq: 2 } }],
});
});
it('should parse string filter test 2', () => {
expect(
parseFilter(
'and(fieldNumber[eq]:1,or(fieldNumber[eq]:2,fieldNumber[eq]:3))',
objectMetadataItemMock,
),
).toEqual({
and: [
{ fieldNumber: { eq: 1 } },
{ or: [{ fieldNumber: { eq: 2 } }, { fieldNumber: { eq: 3 } }] },
],
});
});
it('should parse string filter test 3', () => {
expect(
parseFilter(
'and(fieldNumber[eq]:1,or(fieldNumber[eq]:2,fieldNumber[eq]:3,and(fieldNumber[eq]:6,fieldNumber[eq]:7)),or(fieldNumber[eq]:4,fieldNumber[eq]:5))',
objectMetadataItemMock,
),
).toEqual({
and: [
{ fieldNumber: { eq: 1 } },
{
or: [
{ fieldNumber: { eq: 2 } },
{ fieldNumber: { eq: 3 } },
{ and: [{ fieldNumber: { eq: 6 } }, { fieldNumber: { eq: 7 } }] },
],
},
{ or: [{ fieldNumber: { eq: 4 } }, { fieldNumber: { eq: 5 } }] },
],
});
});
it('should parse string filter test 4', () => {
expect(
parseFilter(
'and(fieldString[gt]:"val,ue",or(fieldNumber[is]:NOT_NULL,not(fieldString[startsWith]:"val"),and(fieldNumber[eq]:6,fieldString[ilike]:"%val%")),or(fieldNumber[eq]:4,fieldString[is]:NULL))',
objectMetadataItemMock,
),
).toEqual({
and: [
{ fieldString: { gt: 'val,ue' } },
{
or: [
{ fieldNumber: { is: 'NOT_NULL' } },
{ not: { fieldString: { startsWith: 'val' } } },
{
and: [
{ fieldNumber: { eq: 6 } },
{ fieldString: { ilike: '%val%' } },
],
},
],
},
{ or: [{ fieldNumber: { eq: 4 } }, { fieldString: { is: 'NULL' } }] },
],
});
});
it('should handler not', () => {
expect(
parseFilter(
'and(fieldNumber[eq]:1,not(fieldNumber[eq]:2))',
objectMetadataItemMock,
),
).toEqual({
and: [
{ fieldNumber: { eq: 1 } },
{
not: { fieldNumber: { eq: 2 } },
},
],
});
});
});

View File

@ -0,0 +1,11 @@
import { Conjunctions } from 'src/engine/api/rest/api-rest-query-builder/factories/input-factories/filter-utils/parse-filter.utils';
export const DEFAULT_CONJUNCTION = Conjunctions.and;
export const addDefaultConjunctionIfMissing = (filterQuery: string): string => {
if (!(filterQuery.includes('(') && filterQuery.includes(')'))) {
return `${DEFAULT_CONJUNCTION}(${filterQuery})`;
}
return filterQuery;
};

View File

@ -0,0 +1,22 @@
import { BadRequestException } from '@nestjs/common';
export const checkFilterQuery = (filterQuery: string): void => {
const countOpenedBrackets = (filterQuery.match(/\(/g) || []).length;
const countClosedBrackets = (filterQuery.match(/\)/g) || []).length;
const diff = countOpenedBrackets - countClosedBrackets;
if (diff !== 0) {
const hint =
diff > 0
? `${diff} close bracket${diff > 1 ? 's are' : ' is'}`
: `${Math.abs(diff)} open bracket${
Math.abs(diff) > 1 ? 's are' : ' is'
}`;
throw new BadRequestException(
`'filter' invalid. ${hint} missing in the query`,
);
}
return;
};

View File

@ -0,0 +1,41 @@
import { BadRequestException } from '@nestjs/common';
import { FieldMetadataType } from 'src/engine-metadata/field-metadata/field-metadata.entity';
import { FieldValue } from 'src/engine/api/rest/types/api-rest-field-value.type';
export const formatFieldValue = (
value: string,
fieldType?: FieldMetadataType,
comparator?: string,
): FieldValue => {
if (comparator === 'in') {
if (value[0] !== '[' || value[value.length - 1] !== ']') {
throw new BadRequestException(
`'filter' invalid for 'in' operator. Received '${value}' but array value expected eg: 'field[in]:[value_1,value_2]'`,
);
}
const stringValues = value.substring(1, value.length - 1);
return stringValues
.split(',')
.map((value) => formatFieldValue(value, fieldType));
}
if (comparator === 'is') {
return value;
}
if (fieldType === FieldMetadataType.NUMBER) {
return parseInt(value);
}
if (fieldType === FieldMetadataType.BOOLEAN) {
return value.toLowerCase() === 'true';
}
if (
(value[0] === '"' || value[0] === "'") &&
(value.charAt(value.length - 1) === '"' ||
value.charAt(value.length - 1) === "'")
) {
return value.substring(1, value.length - 1);
}
return value;
};

View File

@ -0,0 +1,67 @@
import { BadRequestException } from '@nestjs/common';
export enum FilterComparators {
eq = 'eq',
neq = 'neq',
in = 'in',
is = 'is',
gt = 'gt',
gte = 'gte',
lt = 'lt',
lte = 'lte',
startsWith = 'startsWith',
like = 'like',
ilike = 'ilike',
// Not handled rigth now
// regex = 'regex',
// iregex = 'iregex',
}
export const parseBaseFilter = (
baseFilter: string,
): {
fields: string[];
comparator: string;
value: string;
} => {
if (!baseFilter.match(`^(.+)\\[(.+)\\]:(.+)$`)) {
throw new BadRequestException(
`'filter' invalid for '${baseFilter}'. eg: price[gte]:10`,
);
}
let fields = '';
let comparator = '';
let value = '';
let fillFields = true;
let fillComparator = false;
let fillValue = false;
// baseFilter = field_1.subfield[in]:["2023-00-00 OO:OO:OO","2024-00-00 OO:OO:OO"]
for (const c of baseFilter) {
if (fillValue) value += c;
if (c === ']' && !fillValue) fillComparator = false;
if (c === ':' && !fillComparator) fillValue = true;
if (fillComparator) comparator += c;
if (c === '[' && fillFields) {
fillFields = false;
fillComparator = true;
}
if (fillFields) fields += c;
}
// field = field_1.subfield ; comparator = in ; value = ["2023-00-00 OO:OO:OO","2024-00-00 OO:OO:OO"]
if (!Object.keys(FilterComparators).includes(comparator)) {
throw new BadRequestException(
`'filter' invalid for '${baseFilter}', comparator ${comparator} not in ${Object.keys(
FilterComparators,
).join(',')}`,
);
}
return { fields: fields.split('.'), comparator, value };
};

View File

@ -0,0 +1,45 @@
export const parseFilterContent = (filterQuery: string): string[] => {
let isWithinBrackets = false;
let isWithinDoubleQuotes = false;
let isWithinSingleQuotes = false;
let parenthesisCounter = 0;
const predicates: string[] = [];
let currentPredicates = '';
for (const c of filterQuery) {
let shouldPersistCharacter = parenthesisCounter >= 1;
if (c === '(') {
parenthesisCounter++;
}
if (c === ')') {
parenthesisCounter--;
shouldPersistCharacter = parenthesisCounter >= 1;
}
if (['[', ']'].includes(c)) isWithinBrackets = !isWithinBrackets;
if (c === '"') isWithinDoubleQuotes = !isWithinDoubleQuotes;
if (c === "'") isWithinSingleQuotes = !isWithinSingleQuotes;
if (
c === ',' &&
parenthesisCounter === 1 &&
!isWithinBrackets &&
!isWithinDoubleQuotes &&
!isWithinSingleQuotes
) {
predicates.push(currentPredicates);
currentPredicates = '';
shouldPersistCharacter = false;
}
if (shouldPersistCharacter) currentPredicates += c;
}
predicates.push(currentPredicates);
return predicates;
};

View File

@ -0,0 +1,64 @@
import { BadRequestException } from '@nestjs/common';
import { parseFilterContent } from 'src/engine/api/rest/api-rest-query-builder/factories/input-factories/filter-utils/parse-filter-content.utils';
import { parseBaseFilter } from 'src/engine/api/rest/api-rest-query-builder/factories/input-factories/filter-utils/parse-base-filter.utils';
import {
checkFields,
getFieldType,
} from 'src/engine/api/rest/api-rest-query-builder/utils/fields.utils';
import { formatFieldValue } from 'src/engine/api/rest/api-rest-query-builder/factories/input-factories/filter-utils/format-field-values.utils';
import { FieldValue } from 'src/engine/api/rest/types/api-rest-field-value.type';
export enum Conjunctions {
or = 'or',
and = 'and',
not = 'not',
}
export const parseFilter = (
filterQuery: string,
objectMetadataItem,
): Record<string, FieldValue> => {
const result = {};
const match = filterQuery.match(
`^(${Object.values(Conjunctions).join('|')})((.+))$`,
);
if (match) {
const conjunction = match?.[1];
if (!conjunction) {
throw new BadRequestException(
'Error while matching filter query. Conjunction not found',
);
}
const subResult = parseFilterContent(filterQuery).map((elem) =>
parseFilter(elem, objectMetadataItem),
);
if (conjunction === Conjunctions.not) {
if (subResult.length > 1) {
throw new BadRequestException(
`'filter' invalid. 'not' conjunction should contain only 1 condition. eg: not(field[eq]:1)`,
);
}
result[conjunction] = subResult[0];
} else {
result[conjunction] = subResult;
}
return result;
}
const { fields, comparator, value } = parseBaseFilter(filterQuery);
checkFields(objectMetadataItem, fields);
const fieldType = getFieldType(objectMetadataItem, fields[0]);
const formattedValue = formatFieldValue(value, fieldType, comparator);
return fields.reverse().reduce(
(acc, currentValue) => {
return { [currentValue]: acc };
},
{ [comparator]: formattedValue },
);
};

View File

@ -0,0 +1,16 @@
import { Injectable } from '@nestjs/common';
import { Request } from 'express';
@Injectable()
export class LastCursorInputFactory {
create(request: Request): string | undefined {
const cursorQuery = request.query.last_cursor;
if (typeof cursorQuery !== 'string') {
return undefined;
}
return cursorQuery;
}
}

View File

@ -0,0 +1,21 @@
import { BadRequestException, Injectable } from '@nestjs/common';
import { Request } from 'express';
@Injectable()
export class LimitInputFactory {
create(request: Request): number {
if (!request.query.limit) {
return 60;
}
const limit = +request.query.limit;
if (isNaN(limit) || limit < 0) {
throw new BadRequestException(
`limit '${request.query.limit}' is invalid. Should be an integer`,
);
}
return limit;
}
}

View File

@ -0,0 +1,75 @@
import { BadRequestException, Injectable } from '@nestjs/common';
import { Request } from 'express';
import {
OrderByDirection,
RecordOrderBy,
} from 'src/engine/api/graphql/workspace-query-builder/interfaces/record.interface';
import { checkFields } from 'src/engine/api/rest/api-rest-query-builder/utils/fields.utils';
export const DEFAULT_ORDER_DIRECTION = OrderByDirection.AscNullsFirst;
@Injectable()
export class OrderByInputFactory {
create(request: Request, objectMetadata): RecordOrderBy {
const orderByQuery = request.query.order_by;
if (typeof orderByQuery !== 'string') {
return {};
}
//orderByQuery = field_1[AscNullsFirst],field_2[DescNullsLast],field_3
const orderByItems = orderByQuery.split(',');
let result = {};
let itemDirection = '';
let itemFields = '';
for (const orderByItem of orderByItems) {
// orderByItem -> field_1[AscNullsFirst]
if (orderByItem.includes('[') && orderByItem.includes(']')) {
const [fieldsString, direction] = orderByItem
.replace(']', '')
.split('[');
// fields -> [field_1] ; direction -> AscNullsFirst
if (!(direction in OrderByDirection)) {
throw new BadRequestException(
`'order_by' direction '${direction}' invalid. Allowed values are '${Object.values(
OrderByDirection,
).join(
"', '",
)}'. eg: ?order_by=field_1[AscNullsFirst],field_2[DescNullsLast],field_3`,
);
}
itemDirection = direction;
itemFields = fieldsString;
} else {
// orderByItem -> field_3
itemDirection = DEFAULT_ORDER_DIRECTION;
itemFields = orderByItem;
}
let fieldResult = {};
itemFields
.split('.')
.reverse()
.forEach((field) => {
if (Object.keys(fieldResult).length) {
fieldResult = { [field]: fieldResult };
} else {
fieldResult[field] = itemDirection;
}
}, itemDirection);
result = { ...result, ...fieldResult };
}
checkFields(objectMetadata.objectMetadataItem, Object.keys(result));
return result;
}
}

View File

@ -0,0 +1,30 @@
import { Injectable } from '@nestjs/common';
import { capitalize } from 'src/utils/capitalize';
import { mapFieldMetadataToGraphqlQuery } from 'src/engine/api/rest/api-rest-query-builder/utils/map-field-metadata-to-graphql-query.utils';
@Injectable()
export class UpdateQueryFactory {
create(objectMetadata, depth?: number): string {
const objectNameSingular = objectMetadata.objectMetadataItem.nameSingular;
return `
mutation Update${capitalize(
objectNameSingular,
)}($id: ID!, $data: ${capitalize(objectNameSingular)}UpdateInput!) {
update${capitalize(objectNameSingular)}(id: $id, data: $data) {
id
${objectMetadata.objectMetadataItem.fields
.map((field) =>
mapFieldMetadataToGraphqlQuery(
objectMetadata.objectMetadataItems,
field,
depth,
),
)
.join('\n')}
}
}
`;
}
}

View File

@ -0,0 +1,13 @@
import { Injectable } from '@nestjs/common';
import { ApiRestQueryVariables } from 'src/engine/api/rest/types/api-rest-query-variables.type';
@Injectable()
export class UpdateVariablesFactory {
create(id: string, request: Request): ApiRestQueryVariables {
return {
id,
data: request.body,
};
}
}

View File

@ -0,0 +1,26 @@
import { computeDepth } from 'src/engine/api/rest/api-rest-query-builder/utils/compute-depth.utils';
describe('computeDepth', () => {
it('should compute depth from query', () => {
const request: any = {
query: { depth: '1' },
};
expect(computeDepth(request)).toEqual(1);
});
it('should return default depth if missing', () => {
const request: any = { query: {} };
expect(computeDepth(request)).toEqual(undefined);
});
it('should raise if wrong depth', () => {
const request: any = { query: { depth: '100' } };
expect(() => computeDepth(request)).toThrow();
request.query.depth = '0';
expect(() => computeDepth(request)).toThrow();
});
});

View File

@ -0,0 +1,30 @@
import { objectMetadataItemMock } from 'src/engine/api/__mocks__/object-metadata-item.mock';
import {
checkFields,
getFieldType,
} from 'src/engine/api/rest/api-rest-query-builder/utils/fields.utils';
import { FieldMetadataType } from 'src/engine-metadata/field-metadata/field-metadata.entity';
describe('FieldUtils', () => {
describe('getFieldType', () => {
it('should get field type', () => {
expect(getFieldType(objectMetadataItemMock, 'fieldNumber')).toEqual(
FieldMetadataType.NUMBER,
);
});
});
describe('checkFields', () => {
it('should check field types', () => {
expect(() =>
checkFields(objectMetadataItemMock, ['fieldNumber']),
).not.toThrow();
expect(() => checkFields(objectMetadataItemMock, ['wrongField'])).toThrow();
expect(() =>
checkFields(objectMetadataItemMock, ['fieldNumber', 'wrongField']),
).toThrow();
});
});
});

View File

@ -0,0 +1,37 @@
import {
fieldCurrencyMock,
fieldLinkMock,
fieldNumberMock,
fieldStringMock,
objectMetadataItemMock,
} from 'src/engine/api/__mocks__/object-metadata-item.mock';
import { mapFieldMetadataToGraphqlQuery } from 'src/engine/api/rest/api-rest-query-builder/utils/map-field-metadata-to-graphql-query.utils';
describe('mapFieldMetadataToGraphqlQuery', () => {
it('should map properly', () => {
expect(
mapFieldMetadataToGraphqlQuery(objectMetadataItemMock, fieldNumberMock),
).toEqual('fieldNumber');
expect(
mapFieldMetadataToGraphqlQuery(objectMetadataItemMock, fieldStringMock),
).toEqual('fieldString');
expect(
mapFieldMetadataToGraphqlQuery(objectMetadataItemMock, fieldLinkMock),
).toEqual(`
fieldLink
{
label
url
}
`);
expect(
mapFieldMetadataToGraphqlQuery(objectMetadataItemMock, fieldCurrencyMock),
).toEqual(`
fieldCurrency
{
amountMicros
currencyCode
}
`);
});
});

View File

@ -0,0 +1,21 @@
import { parsePath } from 'src/engine/api/rest/api-rest-query-builder/utils/parse-path.utils';
describe('parsePath', () => {
it('should parse object from request path', () => {
const request: any = { path: '/rest/companies/uuid' };
expect(parsePath(request)).toEqual({
object: 'companies',
id: 'uuid',
});
});
it('should parse object from request path', () => {
const request: any = { path: '/rest/companies' };
expect(parsePath(request)).toEqual({
object: 'companies',
id: undefined,
});
});
});

View File

@ -0,0 +1,25 @@
import { BadRequestException } from '@nestjs/common';
import { Request } from 'express';
const ALLOWED_DEPTH_VALUES = [1, 2];
export const computeDepth = (request: Request): number | undefined => {
if (!request.query.depth) {
return undefined;
}
const depth = +request.query.depth;
if (isNaN(depth) || !ALLOWED_DEPTH_VALUES.includes(depth)) {
throw new BadRequestException(
`'depth=${
request.query.depth
}' parameter invalid. Allowed values are ${ALLOWED_DEPTH_VALUES.join(
', ',
)}`,
);
}
return depth;
};

View File

@ -0,0 +1,38 @@
import { BadRequestException } from '@nestjs/common';
import { FieldMetadataType } from 'src/engine-metadata/field-metadata/field-metadata.entity';
import { computeObjectTargetTable } from 'src/engine/utils/compute-object-target-table.util';
export const getFieldType = (
objectMetadataItem,
fieldName,
): FieldMetadataType | undefined => {
for (const itemField of objectMetadataItem.fields) {
if (fieldName === itemField.name) {
return itemField.type;
}
}
};
export const checkFields = (objectMetadataItem, fieldNames): void => {
for (const fieldName of fieldNames) {
if (
!objectMetadataItem.fields
.reduce(
(acc, itemField) => [
...acc,
itemField.name,
...Object.keys(itemField.targetColumnMap),
],
[],
)
.includes(fieldName)
) {
throw new BadRequestException(
`field '${fieldName}' does not exist in '${computeObjectTargetTable(
objectMetadataItem,
)}' object`,
);
}
}
};

View File

@ -0,0 +1,108 @@
import { FieldMetadataType } from 'src/engine-metadata/field-metadata/field-metadata.entity';
import { RelationMetadataType } from 'src/engine-metadata/relation-metadata/relation-metadata.entity';
const DEFAULT_DEPTH_VALUE = 2;
export const mapFieldMetadataToGraphqlQuery = (
objectMetadataItems,
field,
maxDepthForRelations = DEFAULT_DEPTH_VALUE,
): string | undefined => {
if (maxDepthForRelations <= 0) {
return '';
}
const fieldType = field.type;
const fieldIsSimpleValue = [
FieldMetadataType.UUID,
FieldMetadataType.TEXT,
FieldMetadataType.PHONE,
FieldMetadataType.DATE_TIME,
FieldMetadataType.EMAIL,
FieldMetadataType.NUMBER,
FieldMetadataType.BOOLEAN,
FieldMetadataType.POSITION,
].includes(fieldType);
if (fieldIsSimpleValue) {
return field.name;
} else if (
fieldType === FieldMetadataType.RELATION &&
field.toRelationMetadata?.relationType === RelationMetadataType.ONE_TO_MANY
) {
const relationMetadataItem = objectMetadataItems.find(
(objectMetadataItem) =>
objectMetadataItem.id ===
(field.toRelationMetadata as any)?.fromObjectMetadataId,
);
return `${field.name}
{
id
${(relationMetadataItem?.fields ?? [])
.filter((field) => field.type !== FieldMetadataType.RELATION)
.map((field) =>
mapFieldMetadataToGraphqlQuery(
objectMetadataItems,
field,
maxDepthForRelations - 1,
),
)
.join('\n')}
}`;
} else if (
fieldType === FieldMetadataType.RELATION &&
field.fromRelationMetadata?.relationType ===
RelationMetadataType.ONE_TO_MANY
) {
const relationMetadataItem = objectMetadataItems.find(
(objectMetadataItem) =>
objectMetadataItem.id ===
(field.fromRelationMetadata as any)?.toObjectMetadataId,
);
return `${field.name}
{
edges {
node {
id
${(relationMetadataItem?.fields ?? [])
.filter((field) => field.type !== FieldMetadataType.RELATION)
.map((field) =>
mapFieldMetadataToGraphqlQuery(
objectMetadataItems,
field,
maxDepthForRelations - 1,
),
)
.join('\n')}
}
}
}`;
} else if (fieldType === FieldMetadataType.LINK) {
return `
${field.name}
{
label
url
}
`;
} else if (fieldType === FieldMetadataType.CURRENCY) {
return `
${field.name}
{
amountMicros
currencyCode
}
`;
} else if (fieldType === FieldMetadataType.FULL_NAME) {
return `
${field.name}
{
firstName
lastName
}
`;
}
};

View File

@ -0,0 +1,77 @@
import { BadRequestException } from '@nestjs/common';
import { Request } from 'express';
export const parsePath = (
request: Request,
): { object: string; id?: string } => {
const queryAction = request.path.replace('/rest/', '').split('/');
if (queryAction.length > 2) {
throw new BadRequestException(
`Query path '${request.path}' invalid. Valid examples: /rest/companies/id or /rest/companies`,
);
}
if (queryAction.length === 1) {
return { object: queryAction[0] };
}
return { object: queryAction[0], id: queryAction[1] };
};
export const parseMetadataPath = (
request: Request,
): { objectNameSingular: string; objectNamePlural: string; id?: string } => {
const queryAction = request.path.replace('/rest/metadata/', '').split('/');
if (queryAction.length > 3 || queryAction.length === 0) {
throw new BadRequestException(
`Query path '${request.path}' invalid. Valid examples: /rest/metadata/fields or /rest/metadata/objects/id`,
);
}
if (!['fields', 'objects', 'relations'].includes(queryAction[0])) {
throw new BadRequestException(
`Query path '${request.path}' invalid. Metadata path "${queryAction[0]}" does not exist. Valid examples: /rest/metadata/fields or /rest/metadata/objects or /rest/metadata/relations`,
);
}
const objectName = queryAction[0];
if (queryAction.length === 2) {
switch (objectName) {
case 'fields':
return {
objectNameSingular: 'field',
objectNamePlural: objectName,
id: queryAction[1],
};
case 'objects':
return {
objectNameSingular: 'object',
objectNamePlural: objectName,
id: queryAction[1],
};
case 'relations':
return {
objectNameSingular: 'relation',
objectNamePlural: objectName,
id: queryAction[1],
};
default:
return { objectNameSingular: '', objectNamePlural: '', id: '' };
}
} else {
switch (objectName) {
case 'fields':
return { objectNameSingular: 'field', objectNamePlural: objectName };
case 'objects':
return { objectNameSingular: 'object', objectNamePlural: objectName };
case 'relations':
return { objectNameSingular: 'relation', objectNamePlural: objectName };
default:
return { objectNameSingular: '', objectNamePlural: '' };
}
}
};

View File

@ -0,0 +1,31 @@
import { Controller, Delete, Get, Post, Put, Req, Res } from '@nestjs/common';
import { Request, Response } from 'express';
import { ApiRestService } from 'src/engine/api/rest/api-rest.service';
import { handleResult } from 'src/engine/api/rest/api-rest.controller.utils';
@Controller('rest/*')
export class ApiRestController {
constructor(private readonly apiRestService: ApiRestService) {}
@Get()
async handleApiGet(@Req() request: Request, @Res() res: Response) {
handleResult(res, await this.apiRestService.get(request));
}
@Delete()
async handleApiDelete(@Req() request: Request, @Res() res: Response) {
handleResult(res, await this.apiRestService.delete(request));
}
@Post()
async handleApiPost(@Req() request: Request, @Res() res: Response) {
handleResult(res, await this.apiRestService.create(request));
}
@Put()
async handleApiPut(@Req() request: Request, @Res() res: Response) {
handleResult(res, await this.apiRestService.update(request));
}
}

View File

@ -0,0 +1,36 @@
import { Response } from 'express';
import { ApiRestResponse } from 'src/engine/api/rest/types/api-rest-response.type';
// https://gist.github.com/ManUtopiK/469aec75b655d6a4d912aeb3b75af3c9
export const cleanGraphQLResponse = (input) => {
if (!input) return null;
const output = {};
const isObject = (obj) => {
return obj !== null && typeof obj === 'object' && !Array.isArray(obj);
};
Object.keys(input).forEach((key) => {
if (input[key] && input[key].edges) {
output[key] = input[key].edges.map((edge) =>
cleanGraphQLResponse(edge.node),
);
} else if (isObject(input[key])) {
output[key] = cleanGraphQLResponse(input[key]);
} else if (key !== '__typename') {
output[key] = input[key];
}
});
return output;
};
export const handleResult = (res: Response, result: ApiRestResponse) => {
if (result.data.error) {
res
.status(result.data.status || 400)
.send({ error: `${result.data.error}` });
} else {
res.send(cleanGraphQLResponse(result.data));
}
};

View File

@ -0,0 +1,17 @@
import { Module } from '@nestjs/common';
import { HttpModule } from '@nestjs/axios';
import { ApiRestController } from 'src/engine/api/rest/api-rest.controller';
import { ApiRestService } from 'src/engine/api/rest/api-rest.service';
import { ApiRestQueryBuilderModule } from 'src/engine/api/rest/api-rest-query-builder/api-rest-query-builder.module';
import { AuthModule } from 'src/engine/modules/auth/auth.module';
import { ApiRestMetadataController } from 'src/engine/api/rest/metadata-rest.controller';
import { ApiRestMetadataService } from 'src/engine/api/rest/metadata-rest.service';
@Module({
imports: [ApiRestQueryBuilderModule, AuthModule, HttpModule],
controllers: [ApiRestMetadataController, ApiRestController],
providers: [ApiRestMetadataService, ApiRestService],
exports: [ApiRestMetadataService],
})
export class ApiRestModule {}

View File

@ -0,0 +1,83 @@
import { Injectable } from '@nestjs/common';
import { HttpService } from '@nestjs/axios';
import { Request } from 'express';
import { EnvironmentService } from 'src/engine/integrations/environment/environment.service';
import { ApiRestQueryBuilderFactory } from 'src/engine/api/rest/api-rest-query-builder/api-rest-query-builder.factory';
import { TokenService } from 'src/engine/modules/auth/services/token.service';
import { ApiRestResponse } from 'src/engine/api/rest/types/api-rest-response.type';
import { ApiRestQuery } from 'src/engine/api/rest/types/api-rest-query.type';
@Injectable()
export class ApiRestService {
constructor(
private readonly tokenService: TokenService,
private readonly environmentService: EnvironmentService,
private readonly apiRestQueryBuilderFactory: ApiRestQueryBuilderFactory,
private readonly httpService: HttpService,
) {}
async callGraphql(
request: Request,
data: ApiRestQuery,
): Promise<ApiRestResponse> {
const baseUrl = this.environmentService.getBaseUrl(request);
try {
return await this.httpService.axiosRef.post(`${baseUrl}/graphql`, data, {
headers: {
'Content-Type': 'application/json',
Authorization: request.headers.authorization,
},
});
} catch (err) {
return {
data: {
error: `${err}. Please check your query.`,
status: err.response.status,
},
};
}
}
async get(request: Request): Promise<ApiRestResponse> {
try {
const data = await this.apiRestQueryBuilderFactory.get(request);
return await this.callGraphql(request, data);
} catch (err) {
return { data: { error: err, status: err.status } };
}
}
async delete(request: Request): Promise<ApiRestResponse> {
try {
const data = await this.apiRestQueryBuilderFactory.delete(request);
return await this.callGraphql(request, data);
} catch (err) {
return { data: { error: err, status: err.status } };
}
}
async create(request: Request): Promise<ApiRestResponse> {
try {
const data = await this.apiRestQueryBuilderFactory.create(request);
return await this.callGraphql(request, data);
} catch (err) {
return { data: { error: err, status: err.status } };
}
}
async update(request: Request): Promise<ApiRestResponse> {
try {
const data = await this.apiRestQueryBuilderFactory.update(request);
return await this.callGraphql(request, data);
} catch (err) {
return { data: { error: err, status: err.status } };
}
}
}

View File

@ -0,0 +1,31 @@
import { Controller, Get, Delete, Post, Put, Req, Res } from '@nestjs/common';
import { Request, Response } from 'express';
import { handleResult } from 'src/engine/api/rest/api-rest.controller.utils';
import { ApiRestMetadataService } from 'src/engine/api/rest/metadata-rest.service';
@Controller('rest/metadata/*')
export class ApiRestMetadataController {
constructor(private readonly apiRestService: ApiRestMetadataService) {}
@Get()
async handleApiGet(@Req() request: Request, @Res() res: Response) {
handleResult(res, await this.apiRestService.get(request));
}
@Delete()
async handleApiDelete(@Req() request: Request, @Res() res: Response) {
handleResult(res, await this.apiRestService.delete(request));
}
@Post()
async handleApiPost(@Req() request: Request, @Res() res: Response) {
handleResult(res, await this.apiRestService.create(request));
}
@Put()
async handleApiPut(@Req() request: Request, @Res() res: Response) {
handleResult(res, await this.apiRestService.update(request));
}
}

View File

@ -0,0 +1,321 @@
import { BadRequestException, Injectable } from '@nestjs/common';
import { HttpService } from '@nestjs/axios';
import { EnvironmentService } from 'src/engine/integrations/environment/environment.service';
import { ApiRestQueryBuilderFactory } from 'src/engine/api/rest/api-rest-query-builder/api-rest-query-builder.factory';
import { ApiRestQuery } from 'src/engine/api/rest/types/api-rest-query.type';
import { TokenService } from 'src/engine/modules/auth/services/token.service';
import { parseMetadataPath } from 'src/engine/api/rest/api-rest-query-builder/utils/parse-path.utils';
import { capitalize } from 'src/utils/capitalize';
@Injectable()
export class ApiRestMetadataService {
constructor(
private readonly tokenService: TokenService,
private readonly environmentService: EnvironmentService,
private readonly apiRestQueryBuilderFactory: ApiRestQueryBuilderFactory,
private readonly httpService: HttpService,
) {}
async callMetadata(request, data: ApiRestQuery) {
const baseUrl = this.environmentService.getBaseUrl(request);
try {
return await this.httpService.axiosRef.post(`${baseUrl}/metadata`, data, {
headers: {
'Content-Type': 'application/json',
Authorization: request.headers.authorization,
},
});
} catch (err) {
return {
data: {
error: `${err}. Please check your query.`,
status: err.response.status,
},
};
}
}
async fetchMetadataInputFields(request, fieldName: string) {
const query = `
query {
__type(name: "${fieldName}") {
inputFields { name }
}
}
`;
const data: ApiRestQuery = {
query,
variables: {},
};
const { data: response } = await this.callMetadata(request, data);
const fields = response.data.__type.inputFields.map((field) => field.name);
return fields;
}
fetchMetadataFields(objectNamePlural: string) {
const fields = `
type
name
label
description
icon
isCustom
isActive
isSystem
isNullable
createdAt
updatedAt
fromRelationMetadata {
id
relationType
toObjectMetadata {
id
dataSourceId
nameSingular
namePlural
isSystem
}
toFieldMetadataId
}
toRelationMetadata {
id
relationType
fromObjectMetadata {
id
dataSourceId
nameSingular
namePlural
isSystem
}
fromFieldMetadataId
}
defaultValue
options
`;
switch (objectNamePlural) {
case 'objects':
return `
dataSourceId
nameSingular
namePlural
labelSingular
labelPlural
description
icon
isCustom
isActive
isSystem
createdAt
updatedAt
labelIdentifierFieldMetadataId
imageIdentifierFieldMetadataId
fields(paging: { first: 1000 }) {
edges {
node {
id
${fields}
}
}
}
`;
case 'fields':
return fields;
case 'relations':
return `
relationType
fromObjectMetadata {
id
dataSourceId
nameSingular
namePlural
isSystem
}
fromObjectMetadataId
toObjectMetadata {
id
dataSourceId
nameSingular
namePlural
isSystem
}
toObjectMetadataId
fromFieldMetadataId
toFieldMetadataId
`;
}
}
generateFindManyQuery(objectNameSingular: string, objectNamePlural: string) {
const fields = this.fetchMetadataFields(objectNamePlural);
return `
query FindMany${capitalize(objectNamePlural)}(
$filter: ${objectNameSingular}Filter,
) {
${objectNamePlural}(
filter: $filter,
paging: { first: 1000 }
) {
edges {
node {
id
${fields}
}
}
}
}
`;
}
generateFindOneQuery(objectNameSingular: string, objectNamePlural: string) {
const fields = this.fetchMetadataFields(objectNamePlural);
return `
query FindOne${capitalize(objectNameSingular)}(
$id: ID!,
) {
${objectNameSingular}(id: $id) {
id
${fields}
}
}
`;
}
async get(request) {
try {
await this.tokenService.validateToken(request);
const { objectNameSingular, objectNamePlural, id } =
parseMetadataPath(request);
const query = id
? this.generateFindOneQuery(objectNameSingular, objectNamePlural)
: this.generateFindManyQuery(objectNameSingular, objectNamePlural);
const data: ApiRestQuery = {
query,
variables: id ? { id } : request.body,
};
return await this.callMetadata(request, data);
} catch (err) {
return { data: { error: err, status: err.status } };
}
}
async create(request) {
try {
await this.tokenService.validateToken(request);
const { objectNameSingular: objectName } = parseMetadataPath(request);
const objectNameCapitalized = capitalize(objectName);
const fieldName = `Create${objectNameCapitalized}Input`;
const fields = await this.fetchMetadataInputFields(request, fieldName);
const query = `
mutation Create${objectNameCapitalized}($input: CreateOne${objectNameCapitalized}Input!) {
createOne${objectNameCapitalized}(input: $input) {
id
${fields.map((field) => field).join('\n')}
}
}
`;
const data: ApiRestQuery = {
query,
variables: {
input: {
[objectName]: request.body,
},
},
};
return await this.callMetadata(request, data);
} catch (err) {
return { data: { error: err, status: err.status } };
}
}
async update(request) {
try {
await this.tokenService.validateToken(request);
const { objectNameSingular: objectName, id } = parseMetadataPath(request);
const objectNameCapitalized = capitalize(objectName);
if (!id) {
throw new BadRequestException(
`update ${objectName} query invalid. Id missing. eg: /rest/metadata/${objectName}/0d4389ef-ea9c-4ae8-ada1-1cddc440fb56`,
);
}
const fieldName = `Update${objectNameCapitalized}Input`;
const fields = await this.fetchMetadataInputFields(request, fieldName);
const query = `
mutation Update${objectNameCapitalized}($input: UpdateOne${objectNameCapitalized}Input!) {
updateOne${objectNameCapitalized}(input: $input) {
id
${fields.map((field) => field).join('\n')}
}
}
`;
const data: ApiRestQuery = {
query,
variables: {
input: {
update: request.body,
id,
},
},
};
return await this.callMetadata(request, data);
} catch (err) {
return { data: { error: err, status: err.status } };
}
}
async delete(request) {
try {
await this.tokenService.validateToken(request);
const { objectNameSingular: objectName, id } = parseMetadataPath(request);
const objectNameCapitalized = capitalize(objectName);
if (!id) {
throw new BadRequestException(
`delete ${objectName} query invalid. Id missing. eg: /rest/metadata/${objectName}/0d4389ef-ea9c-4ae8-ada1-1cddc440fb56`,
);
}
const query = `
mutation Delete${objectNameCapitalized}($input: DeleteOne${objectNameCapitalized}Input!) {
deleteOne${objectNameCapitalized}(input: $input) {
id
}
}
`;
const data: ApiRestQuery = {
query,
variables: {
input: {
id,
},
},
};
return await this.callMetadata(request, data);
} catch (err) {
return { data: { error: err, status: err.status } };
}
}
}

View File

@ -0,0 +1,6 @@
export type FieldValue =
| string
| boolean
| number
| FieldValue[]
| { [key: string]: FieldValue };

View File

@ -0,0 +1,8 @@
export type ApiRestQueryVariables = {
id?: string;
data?: object | null;
filter?: object;
orderBy?: object;
limit?: number;
lastCursor?: string;
};

View File

@ -0,0 +1,4 @@
export type ApiRestQuery = {
query: string;
variables: object;
};

View File

@ -0,0 +1,5 @@
import { HttpException } from '@nestjs/common';
export type ApiRestResponse = {
data: { error?: HttpException | string; status?: number };
};