4655 batch endpoints on the rest api (#5411)
- add POST rest/batch/<OBJECT> endpoint - rearrange rest api code with Twenty quality standard - unify REST API error format - Added PATCH verb to update objects - In openapi schema, we replaced PUT with PATCH verb to comply with REST standard - fix openApi schema to match the REST api ### Batch Create  ### Replace PUT by PATCH in open Api  ### Error format unification   
This commit is contained in:
martmull
@@ -0,0 +1,30 @@
|
||||
import { Test, TestingModule } from '@nestjs/testing';
|
||||
|
||||
import { RestApiCoreService } from 'src/engine/api/rest/services/rest-api-core.service';
|
||||
import { CoreQueryBuilderFactory } from 'src/engine/api/rest/rest-api-core-query-builder/core-query-builder.factory';
|
||||
import { RestApiService } from 'src/engine/api/rest/services/rest-api.service';
|
||||
|
||||
describe('RestApiCoreService', () => {
|
||||
let service: RestApiCoreService;
|
||||
|
||||
beforeEach(async () => {
|
||||
const module: TestingModule = await Test.createTestingModule({
|
||||
providers: [
|
||||
RestApiCoreService,
|
||||
{
|
||||
provide: CoreQueryBuilderFactory,
|
||||
useValue: {},
|
||||
},
|
||||
{
|
||||
provide: RestApiService,
|
||||
useValue: {},
|
||||
},
|
||||
],
|
||||
}).compile();
|
||||
|
||||
service = module.get<RestApiCoreService>(RestApiCoreService);
|
||||
});
|
||||
it('should be defined', () => {
|
||||
expect(service).toBeDefined();
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,47 @@
|
||||
import { Injectable } from '@nestjs/common';
|
||||
|
||||
import { Request } from 'express';
|
||||
|
||||
import { CoreQueryBuilderFactory } from 'src/engine/api/rest/rest-api-core-query-builder/core-query-builder.factory';
|
||||
import {
|
||||
GraphqlApiType,
|
||||
RestApiService,
|
||||
} from 'src/engine/api/rest/services/rest-api.service';
|
||||
|
||||
@Injectable()
|
||||
export class RestApiCoreService {
|
||||
constructor(
|
||||
private readonly coreQueryBuilderFactory: CoreQueryBuilderFactory,
|
||||
private readonly restApiService: RestApiService,
|
||||
) {}
|
||||
|
||||
async get(request: Request) {
|
||||
const data = await this.coreQueryBuilderFactory.get(request);
|
||||
|
||||
return await this.restApiService.call(GraphqlApiType.CORE, request, data);
|
||||
}
|
||||
|
||||
async delete(request: Request) {
|
||||
const data = await this.coreQueryBuilderFactory.delete(request);
|
||||
|
||||
return await this.restApiService.call(GraphqlApiType.CORE, request, data);
|
||||
}
|
||||
|
||||
async createOne(request: Request) {
|
||||
const data = await this.coreQueryBuilderFactory.createOne(request);
|
||||
|
||||
return await this.restApiService.call(GraphqlApiType.CORE, request, data);
|
||||
}
|
||||
|
||||
async createMany(request: Request) {
|
||||
const data = await this.coreQueryBuilderFactory.createMany(request);
|
||||
|
||||
return await this.restApiService.call(GraphqlApiType.CORE, request, data);
|
||||
}
|
||||
|
||||
async update(request: Request) {
|
||||
const data = await this.coreQueryBuilderFactory.update(request);
|
||||
|
||||
return await this.restApiService.call(GraphqlApiType.CORE, request, data);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,284 @@
|
||||
import { BadRequestException, Injectable } from '@nestjs/common';
|
||||
|
||||
import { Query } from 'src/engine/api/rest/types/query.type';
|
||||
import { TokenService } from 'src/engine/core-modules/auth/services/token.service';
|
||||
import { capitalize } from 'src/utils/capitalize';
|
||||
import { parseMetadataPath } from 'src/engine/api/rest/rest-api-core-query-builder/utils/path-parsers/parse-metadata-path.utils';
|
||||
import {
|
||||
GraphqlApiType,
|
||||
RestApiService,
|
||||
} from 'src/engine/api/rest/services/rest-api.service';
|
||||
|
||||
@Injectable()
|
||||
export class RestApiMetadataService {
|
||||
constructor(
|
||||
private readonly tokenService: TokenService,
|
||||
private readonly restApiService: RestApiService,
|
||||
) {}
|
||||
|
||||
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: UUID!,
|
||||
) {
|
||||
${objectNameSingular}(id: $id) {
|
||||
id
|
||||
${fields}
|
||||
}
|
||||
}
|
||||
`;
|
||||
}
|
||||
|
||||
async get(request) {
|
||||
await this.tokenService.validateToken(request);
|
||||
|
||||
const { objectNameSingular, objectNamePlural, id } =
|
||||
parseMetadataPath(request);
|
||||
|
||||
const query = id
|
||||
? this.generateFindOneQuery(objectNameSingular, objectNamePlural)
|
||||
: this.generateFindManyQuery(objectNameSingular, objectNamePlural);
|
||||
|
||||
const data: Query = {
|
||||
query,
|
||||
variables: id ? { id } : request.body,
|
||||
};
|
||||
|
||||
return await this.restApiService.call(
|
||||
GraphqlApiType.METADATA,
|
||||
request,
|
||||
data,
|
||||
);
|
||||
}
|
||||
|
||||
async create(request) {
|
||||
await this.tokenService.validateToken(request);
|
||||
|
||||
const { objectNameSingular: objectName, objectNamePlural } =
|
||||
parseMetadataPath(request);
|
||||
const objectNameCapitalized = capitalize(objectName);
|
||||
|
||||
const fields = this.fetchMetadataFields(objectNamePlural);
|
||||
|
||||
const query = `
|
||||
mutation Create${objectNameCapitalized}($input: CreateOne${objectNameCapitalized}Input!) {
|
||||
createOne${objectNameCapitalized}(input: $input) {
|
||||
id
|
||||
${fields}
|
||||
}
|
||||
}
|
||||
`;
|
||||
|
||||
const data: Query = {
|
||||
query,
|
||||
variables: {
|
||||
input: {
|
||||
[objectName]: request.body,
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
return await this.restApiService.call(
|
||||
GraphqlApiType.METADATA,
|
||||
request,
|
||||
data,
|
||||
);
|
||||
}
|
||||
|
||||
async update(request) {
|
||||
await this.tokenService.validateToken(request);
|
||||
|
||||
const {
|
||||
objectNameSingular: objectName,
|
||||
objectNamePlural,
|
||||
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 fields = this.fetchMetadataFields(objectNamePlural);
|
||||
|
||||
const query = `
|
||||
mutation Update${objectNameCapitalized}($input: UpdateOne${objectNameCapitalized}Input!) {
|
||||
updateOne${objectNameCapitalized}(input: $input) {
|
||||
id
|
||||
${fields}
|
||||
}
|
||||
}
|
||||
`;
|
||||
|
||||
const data: Query = {
|
||||
query,
|
||||
variables: {
|
||||
input: {
|
||||
update: request.body,
|
||||
id,
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
return await this.restApiService.call(
|
||||
GraphqlApiType.METADATA,
|
||||
request,
|
||||
data,
|
||||
);
|
||||
}
|
||||
|
||||
async delete(request) {
|
||||
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: Query = {
|
||||
query,
|
||||
variables: {
|
||||
input: {
|
||||
id,
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
return await this.restApiService.call(
|
||||
GraphqlApiType.METADATA,
|
||||
request,
|
||||
data,
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,53 @@
|
||||
import { Injectable } from '@nestjs/common';
|
||||
import { HttpService } from '@nestjs/axios';
|
||||
|
||||
import { Request } from 'express';
|
||||
import { AxiosResponse } from 'axios';
|
||||
|
||||
import { Query } from 'src/engine/api/rest/types/query.type';
|
||||
import { getServerUrl } from 'src/utils/get-server-url';
|
||||
import { EnvironmentService } from 'src/engine/integrations/environment/environment.service';
|
||||
import { RestApiException } from 'src/engine/api/rest/errors/RestApiException';
|
||||
|
||||
export enum GraphqlApiType {
|
||||
CORE = 'core',
|
||||
METADATA = 'metadata',
|
||||
}
|
||||
|
||||
@Injectable()
|
||||
export class RestApiService {
|
||||
constructor(
|
||||
private readonly environmentService: EnvironmentService,
|
||||
private readonly httpService: HttpService,
|
||||
) {}
|
||||
|
||||
async call(graphqlApiType: GraphqlApiType, request: Request, data: Query) {
|
||||
const baseUrl = getServerUrl(
|
||||
request,
|
||||
this.environmentService.get('SERVER_URL'),
|
||||
);
|
||||
let response: AxiosResponse;
|
||||
const url = `${baseUrl}/${
|
||||
graphqlApiType === GraphqlApiType.CORE
|
||||
? 'graphql'
|
||||
: GraphqlApiType.METADATA
|
||||
}`;
|
||||
|
||||
try {
|
||||
response = await this.httpService.axiosRef.post(url, data, {
|
||||
headers: {
|
||||
'Content-Type': 'application/json',
|
||||
Authorization: request.headers.authorization,
|
||||
},
|
||||
});
|
||||
} catch (err) {
|
||||
throw new RestApiException(err.response.data.errors);
|
||||
}
|
||||
|
||||
if (response.data.errors?.length) {
|
||||
throw new RestApiException(response.data.errors);
|
||||
}
|
||||
|
||||
return response;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user