houseassassin/twenty
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Common - many fixes (#15395)

Browse Source
This commit is contained in:
Etienne
2025-10-28 13:33:41 +01:00
committed by GitHub
parent 99d73d1d4b
commit ee6b86b1a8
30 changed files with 391 additions and 105 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/twenty-server/src/engine/api/common/common-args-handlers/common-query-selected-fields/common-selected-fields.handler.ts
+1 -1
View File
@@ -4,9 +4,9 @@ import { FieldMetadataType, ObjectsPermissions } from 'twenty-shared/types';
import { isDefined } from 'twenty-shared/utils';
import { CommonSelectedFieldsResult } from 'src/engine/api/common/types/common-selected-fields-result.type';
import { getAllSelectableFields } from 'src/engine/api/rest/core/rest-to-common-args-handlers/utils/get-all-selectable-fields.util';
import { MAX_DEPTH } from 'src/engine/api/rest/input-request-parsers/constants/max-depth.constant';
import { Depth } from 'src/engine/api/rest/input-request-parsers/types/depth.type';
import { getAllSelectableFields } from 'src/engine/api/utils/get-all-selectable-fields.utils';
import { ObjectMetadataItemWithFieldMaps } from 'src/engine/metadata-modules/types/object-metadata-item-with-field-maps';
import { ObjectMetadataMaps } from 'src/engine/metadata-modules/types/object-metadata-maps';
import { isFieldMetadataEntityOfType } from 'src/engine/utils/is-field-metadata-of-type.util';
packages/twenty-server/src/engine/api/common/common-query-runners/common-base-query-runner.service.ts
+2 -2
View File
@@ -94,6 +94,8 @@ export abstract class CommonBaseQueryRunnerService<
);
}
await this.throttleQueryExecution(authContext.workspace.id);
await this.validate(args, queryRunnerContext);
if (objectMetadataItemWithFieldMaps.isSystem === true) {
@@ -115,8 +117,6 @@ export abstract class CommonBaseQueryRunnerService<
commonQueryParser,
);
await this.throttleQueryExecution(authContext.workspace.id);
const extendedQueryRunnerContext =
await this.prepareExtendedQueryRunnerContext(
authContext,
packages/twenty-server/src/engine/api/common/common-query-runners/common-create-many-query-runner/common-create-many-query-runner.service.ts
+2 -2
View File
@@ -28,7 +28,7 @@ import { CommonSelectedFieldsResult } from 'src/engine/api/common/types/common-s
import { buildColumnsToReturn } from 'src/engine/api/graphql/graphql-query-runner/utils/build-columns-to-return';
import { buildColumnsToSelect } from 'src/engine/api/graphql/graphql-query-runner/utils/build-columns-to-select';
import { assertIsValidUuid } from 'src/engine/api/graphql/workspace-query-runner/utils/assert-is-valid-uuid.util';
import { getAllSelectableFields } from 'src/engine/api/utils/get-all-selectable-fields.utils';
import { getAllSelectableColumnNames } from 'src/engine/api/utils/get-all-selectable-column-names.utils';
import { AuthContext } from 'src/engine/core-modules/auth/types/auth-context.type';
import { assertMutationNotOnRemoteObject } from 'src/engine/metadata-modules/object-metadata/utils/assert-mutation-not-on-remote-object.util';
import { ObjectMetadataItemWithFieldMaps } from 'src/engine/metadata-modules/types/object-metadata-item-with-field-maps';
@@ -276,7 +276,7 @@ export class CommonCreateManyQueryRunnerService extends CommonBaseQueryRunnerSer
repository.objectRecordsPermissions?.[objectMetadataItemWithFieldMaps.id]
?.restrictedFields;
const selectOptions = getAllSelectableFields({
const selectOptions = getAllSelectableColumnNames({
restrictedFields: restrictedFields ?? {},
objectMetadata: {
objectMetadataMapItem: objectMetadataItemWithFieldMaps,
packages/twenty-server/src/engine/api/common/common-query-runners/common-create-one-query-runner.service.ts
+13 -2
View File
@@ -49,9 +49,20 @@ export class CommonCreateOneQueryRunnerService extends CommonBaseQueryRunnerServ
async computeArgs(
args: CommonInput<CreateOneQueryArgs>,
_queryRunnerContext: CommonBaseQueryRunnerContext,
queryRunnerContext: CommonBaseQueryRunnerContext,
): Promise<CommonInput<CreateOneQueryArgs>> {
return args;
const { authContext, objectMetadataItemWithFieldMaps } = queryRunnerContext;
return {
...args,
data: (
await this.queryRunnerArgsFactory.overrideDataByFieldMetadata({
partialRecordInputs: [args.data],
authContext,
objectMetadataItemWithFieldMaps,
})
)[0],
};
}
async processQueryResult(
packages/twenty-server/src/engine/api/common/common-query-runners/common-find-duplicates-query-runner.service.ts
+25 -2
View File
@@ -4,7 +4,7 @@ import isEmpty from 'lodash.isempty';
import { QUERY_MAX_RECORDS } from 'twenty-shared/constants';
import { ObjectRecord, OrderByDirection } from 'twenty-shared/types';
import { isDefined } from 'twenty-shared/utils';
import { In } from 'typeorm';
import { FindOptionsRelations, In, ObjectLiteral } from 'typeorm';
import { WorkspaceAuthContext } from 'src/engine/api/common/interfaces/workspace-auth-context.interface';
@@ -43,6 +43,9 @@ export class CommonFindDuplicatesQueryRunnerService extends CommonBaseQueryRunne
objectMetadataItemWithFieldMaps,
objectMetadataMaps,
commonQueryParser,
authContext,
workspaceDataSource,
rolePermissionConfig,
} = queryRunnerContext;
const existingRecordsQueryBuilder = repository.createQueryBuilder(
@@ -58,7 +61,7 @@ export class CommonFindDuplicatesQueryRunnerService extends CommonBaseQueryRunne
objectMetadataMaps,
});
if (isDefined(args.ids)) {
if (isDefined(args.ids) && args.ids.length > 0) {
objectRecords = (await existingRecordsQueryBuilder
.where({ id: In(args.ids) })
.setFindOptions({
@@ -127,6 +130,26 @@ export class CommonFindDuplicatesQueryRunnerService extends CommonBaseQueryRunne
}),
);
if (isDefined(args.selectedFieldsResult.relations)) {
await this.processNestedRelationsHelper.processNestedRelations({
objectMetadataMaps,
parentObjectMetadataItem: objectMetadataItemWithFieldMaps,
parentObjectRecords: findDuplicatesOutput.flatMap(
(item) => item.records,
),
parentObjectRecordsAggregatedValues: {},
relations: args.selectedFieldsResult.relations as Record<
string,
FindOptionsRelations<ObjectLiteral>
>,
limit: QUERY_MAX_RECORDS,
authContext,
workspaceDataSource,
rolePermissionConfig,
selectedFields: args.selectedFieldsResult.select,
});
}
return findDuplicatesOutput;
}
packages/twenty-server/src/engine/api/common/common-query-runners/common-find-many-query-runner.service.ts
-4
View File
@@ -140,10 +140,6 @@ export class CommonFindManyQueryRunnerService extends CommonBaseQueryRunnerServi
isForwardPagination,
);
if (objectRecords.length > limit) {
objectRecords.pop();
}
if (!isForwardPagination) {
objectRecords.reverse();
}
packages/twenty-server/src/engine/api/common/common-query-runners/common-update-one-query-runner.service.ts
+14 -2
View File
@@ -58,9 +58,21 @@ export class CommonUpdateOneQueryRunnerService extends CommonBaseQueryRunnerServ
async computeArgs(
args: CommonInput<UpdateOneQueryArgs>,
_queryRunnerContext: CommonBaseQueryRunnerContext,
queryRunnerContext: CommonBaseQueryRunnerContext,
): Promise<CommonInput<UpdateOneQueryArgs>> {
return args;
const { authContext, objectMetadataItemWithFieldMaps } = queryRunnerContext;
return {
...args,
data: (
await this.queryRunnerArgsFactory.overrideDataByFieldMetadata({
partialRecordInputs: [args.data],
authContext,
objectMetadataItemWithFieldMaps,
shouldBackfillPositionIfUndefined: false,
})
)[0],
};
}
async processQueryResult(
packages/twenty-server/src/engine/api/common/common-query-runners/errors/common-query-runner.exception.ts
+1
View File
@@ -11,4 +11,5 @@ export enum CommonQueryRunnerExceptionCode {
INVALID_ARGS_LAST = 'INVALID_ARGS_LAST',
UPSERT_MULTIPLE_MATCHING_RECORDS_CONFLICT = 'UPSERT_MULTIPLE_MATCHING_RECORDS_CONFLICT',
MISSING_SYSTEM_FIELD = 'MISSING_SYSTEM_FIELD',
INVALID_CURSOR = 'INVALID_CURSOR',
}
packages/twenty-server/src/engine/api/common/common-query-runners/utils/common-query-runner-to-graphql-api-exception-handler.util.ts
+1
View File
@@ -21,6 +21,7 @@ export const commonQueryRunnerToGraphqlApiExceptionHandler = (
case CommonQueryRunnerExceptionCode.INVALID_ARGS_LAST:
case CommonQueryRunnerExceptionCode.INVALID_QUERY_INPUT:
case CommonQueryRunnerExceptionCode.UPSERT_MULTIPLE_MATCHING_RECORDS_CONFLICT:
case CommonQueryRunnerExceptionCode.INVALID_CURSOR:
throw new UserInputError(error);
case CommonQueryRunnerExceptionCode.INVALID_AUTH_CONTEXT:
throw new AuthenticationError(error);
packages/twenty-server/src/engine/api/common/common-query-runners/utils/common-query-runner-to-rest-api-exception-handler.util.ts
+1
View File
@@ -20,6 +20,7 @@ export const commonQueryRunnerToRestApiExceptionHandler = (
case CommonQueryRunnerExceptionCode.INVALID_ARGS_LAST:
case CommonQueryRunnerExceptionCode.INVALID_QUERY_INPUT:
case CommonQueryRunnerExceptionCode.UPSERT_MULTIPLE_MATCHING_RECORDS_CONFLICT:
case CommonQueryRunnerExceptionCode.INVALID_CURSOR:
throw new BadRequestException(error.message);
case CommonQueryRunnerExceptionCode.RECORD_NOT_FOUND:
throw new NotFoundException('Record not found');
packages/twenty-server/src/engine/api/common/utils/get-page-info.util.ts
+5 -1
View File
@@ -14,12 +14,16 @@ export const getPageInfo = (
limit: number,
isForwardPagination: boolean,
): CommonPageInfo => {
const { hasNextPage, hasPreviousPage } = getPaginationInfo(
const { hasNextPage, hasPreviousPage, hasMoreRecords } = getPaginationInfo(
records,
limit,
isForwardPagination,
);
if (hasMoreRecords) {
records.pop();
}
const startCursor =
records.length > 0 ? encodeCursor(records[0], orderBy) : null;
const endCursor =
packages/twenty-server/src/engine/api/graphql/graphql-query-runner/resolvers/graphql-query-create-many-resolver.service.ts
+2 -2
View File
@@ -26,7 +26,7 @@ import { ObjectRecordsToGraphqlConnectionHelper } from 'src/engine/api/graphql/g
import { buildColumnsToReturn } from 'src/engine/api/graphql/graphql-query-runner/utils/build-columns-to-return';
import { buildColumnsToSelect } from 'src/engine/api/graphql/graphql-query-runner/utils/build-columns-to-select';
import { assertIsValidUuid } from 'src/engine/api/graphql/workspace-query-runner/utils/assert-is-valid-uuid.util';
import { getAllSelectableFields } from 'src/engine/api/utils/get-all-selectable-fields.utils';
import { getAllSelectableColumnNames } from 'src/engine/api/utils/get-all-selectable-column-names.utils';
import { compositeTypeDefinitions } from 'src/engine/metadata-modules/field-metadata/composite-types';
import { assertMutationNotOnRemoteObject } from 'src/engine/metadata-modules/object-metadata/utils/assert-mutation-not-on-remote-object.util';
import { type ObjectMetadataItemWithFieldMaps } from 'src/engine/metadata-modules/types/object-metadata-item-with-field-maps';
@@ -222,7 +222,7 @@ export class GraphqlQueryCreateManyResolverService extends GraphqlQueryBaseResol
objectMetadataItemWithFieldMaps.id
]?.restrictedFields;
const selectOptions = getAllSelectableFields({
const selectOptions = getAllSelectableColumnNames({
restrictedFields: restrictedFields ?? {},
objectMetadata: {
objectMetadataMapItem: objectMetadataItemWithFieldMaps,
packages/twenty-server/src/engine/api/graphql/graphql-query-runner/utils/cursors.util.ts
+6 -5
View File
@@ -4,9 +4,9 @@ import { type ObjectRecordOrderBy } from 'src/engine/api/graphql/workspace-query
import { type FindManyResolverArgs } from 'src/engine/api/graphql/workspace-resolver-builder/interfaces/workspace-resolvers-builder.interface';
import {
GraphqlQueryRunnerException,
GraphqlQueryRunnerExceptionCode,
} from 'src/engine/api/graphql/graphql-query-runner/errors/graphql-query-runner.exception';
CommonQueryRunnerException,
CommonQueryRunnerExceptionCode,
} from 'src/engine/api/common/common-query-runners/errors/common-query-runner.exception';
export interface CursorData {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -17,9 +17,9 @@ export const decodeCursor = <T = CursorData>(cursor: string): T => {
try {
return JSON.parse(Buffer.from(cursor, 'base64').toString());
} catch {
throw new GraphqlQueryRunnerException(
throw new CommonQueryRunnerException(
`Invalid cursor: ${cursor}`,
GraphqlQueryRunnerExceptionCode.INVALID_CURSOR,
CommonQueryRunnerExceptionCode.INVALID_CURSOR,
);
}
};
@@ -72,5 +72,6 @@ export const getPaginationInfo = (
return {
hasNextPage: isForwardPagination && hasMoreRecords,
hasPreviousPage: !isForwardPagination && hasMoreRecords,
hasMoreRecords,
};
};
packages/twenty-server/src/engine/api/rest/core/handlers/rest-api-create-many.handler.ts
+2 -2
View File
@@ -15,7 +15,7 @@ import { parseDepthRestRequest } from 'src/engine/api/rest/input-request-parsers
import { parseUpsertRestRequest } from 'src/engine/api/rest/input-request-parsers/upsert-parser-utils/parse-upsert-rest-request.util';
import { AuthenticatedRequest } from 'src/engine/api/rest/types/authenticated-request';
import { workspaceQueryRunnerRestApiExceptionHandler } from 'src/engine/api/rest/utils/workspace-query-runner-rest-api-exception-handler.util';
import { getAllSelectableFields } from 'src/engine/api/utils/get-all-selectable-fields.utils';
import { getAllSelectableColumnNames } from 'src/engine/api/utils/get-all-selectable-column-names.utils';
@Injectable()
export class RestApiCreateManyHandler extends RestApiBaseHandler {
constructor(
@@ -122,7 +122,7 @@ export class RestApiCreateManyHandler extends RestApiBaseHandler {
let selectedColumns = undefined;
if (!isEmpty(restrictedFields)) {
const selectableFields = getAllSelectableFields({
const selectableFields = getAllSelectableColumnNames({
restrictedFields,
objectMetadata,
});
packages/twenty-server/src/engine/api/rest/core/handlers/rest-api-create-one.handler.ts
+2 -2
View File
@@ -15,7 +15,7 @@ import { parseDepthRestRequest } from 'src/engine/api/rest/input-request-parsers
import { parseUpsertRestRequest } from 'src/engine/api/rest/input-request-parsers/upsert-parser-utils/parse-upsert-rest-request.util';
import { AuthenticatedRequest } from 'src/engine/api/rest/types/authenticated-request';
import { workspaceQueryRunnerRestApiExceptionHandler } from 'src/engine/api/rest/utils/workspace-query-runner-rest-api-exception-handler.util';
import { getAllSelectableFields } from 'src/engine/api/utils/get-all-selectable-fields.utils';
import { getAllSelectableColumnNames } from 'src/engine/api/utils/get-all-selectable-column-names.utils';
@Injectable()
export class RestApiCreateOneHandler extends RestApiBaseHandler {
@@ -103,7 +103,7 @@ export class RestApiCreateOneHandler extends RestApiBaseHandler {
let selectedColumns = undefined;
if (!isEmpty(restrictedFields)) {
const selectableFields = getAllSelectableFields({
const selectableFields = getAllSelectableColumnNames({
restrictedFields,
objectMetadata,
});
packages/twenty-server/src/engine/api/rest/core/handlers/rest-api-destroy-one.handler.ts
+2 -2
View File
@@ -9,7 +9,7 @@ import { CommonDestroyOneQueryRunnerService } from 'src/engine/api/common/common
import { parseCorePath } from 'src/engine/api/rest/core/query-builder/utils/path-parsers/parse-core-path.utils';
import { AuthenticatedRequest } from 'src/engine/api/rest/types/authenticated-request';
import { workspaceQueryRunnerRestApiExceptionHandler } from 'src/engine/api/rest/utils/workspace-query-runner-rest-api-exception-handler.util';
import { getAllSelectableFields } from 'src/engine/api/utils/get-all-selectable-fields.utils';
import { getAllSelectableColumnNames } from 'src/engine/api/utils/get-all-selectable-column-names.utils';
@Injectable()
export class RestApiDestroyOneHandler extends RestApiBaseHandler {
@@ -73,7 +73,7 @@ export class RestApiDestroyOneHandler extends RestApiBaseHandler {
const { objectMetadata, repository, restrictedFields } =
await this.getRepositoryAndMetadataOrFail(request);
const selectOptions = getAllSelectableFields({
const selectOptions = getAllSelectableColumnNames({
restrictedFields,
objectMetadata,
});
packages/twenty-server/src/engine/api/rest/core/handlers/rest-api-find-duplicates.handler.ts
+1 -3
View File
@@ -75,9 +75,7 @@ export class RestApiFindDuplicatesHandler extends RestApiBaseHandler {
) {
return {
data: duplicateConnections.map((connection) => ({
data: {
[`${objectNameSingular}Duplicates`]: connection.records,
},
[`${objectNameSingular}Duplicates`]: connection.records,
totalCount: connection.totalCount,
pageInfo: {
hasNextPage: connection.hasNextPage,
packages/twenty-server/src/engine/api/rest/core/handlers/rest-api-find-many.handler.ts
+5 -2
View File
@@ -111,7 +111,10 @@ export class RestApiFindManyHandler extends RestApiBaseHandler {
const { records, aggregatedValues, pageInfo } =
await this.commonFindManyQueryRunnerService.execute(
{ ...parsedArgs, selectedFields },
{
...parsedArgs,
selectedFields: { ...selectedFields, totalCount: true },
},
{
authContext,
objectMetadataMaps,
@@ -140,7 +143,7 @@ export class RestApiFindManyHandler extends RestApiBaseHandler {
data: {
[objectNamePlural]: records,
},
totalCount: aggregatedValues.totalCount,
totalCount: Number(aggregatedValues.totalCount),
pageInfo,
};
}
packages/twenty-server/src/engine/api/rest/core/handlers/rest-api-update-one.handler.ts
+2 -2
View File
@@ -15,7 +15,7 @@ import { parseCorePath } from 'src/engine/api/rest/core/query-builder/utils/path
import { parseDepthRestRequest } from 'src/engine/api/rest/input-request-parsers/depth-parser-utils/parse-depth-rest-request.util';
import { AuthenticatedRequest } from 'src/engine/api/rest/types/authenticated-request';
import { workspaceQueryRunnerRestApiExceptionHandler } from 'src/engine/api/rest/utils/workspace-query-runner-rest-api-exception-handler.util';
import { getAllSelectableFields } from 'src/engine/api/utils/get-all-selectable-fields.utils';
import { getAllSelectableColumnNames } from 'src/engine/api/utils/get-all-selectable-column-names.utils';
@Injectable()
export class RestApiUpdateOneHandler extends RestApiBaseHandler {
@@ -102,7 +102,7 @@ export class RestApiUpdateOneHandler extends RestApiBaseHandler {
let selectedColumns = undefined;
if (!isEmpty(restrictedFields)) {
const selectableFields = getAllSelectableFields({
const selectableFields = getAllSelectableColumnNames({
restrictedFields,
objectMetadata,
});
packages/twenty-server/src/engine/api/rest/core/interfaces/rest-api-base.handler.ts
+2 -2
View File
@@ -27,7 +27,7 @@ import { parseDepthRestRequest } from 'src/engine/api/rest/input-request-parsers
import { Depth } from 'src/engine/api/rest/input-request-parsers/types/depth.type';
import { AuthenticatedRequest } from 'src/engine/api/rest/types/authenticated-request';
import { computeCursorArgFilter } from 'src/engine/api/utils/compute-cursor-arg-filter.utils';
import { getAllSelectableFields } from 'src/engine/api/utils/get-all-selectable-fields.utils';
import { getAllSelectableColumnNames } from 'src/engine/api/utils/get-all-selectable-column-names.utils';
import { CreatedByFromAuthContextService } from 'src/engine/core-modules/actor/services/created-by-from-auth-context.service';
import { ApiKeyRoleService } from 'src/engine/core-modules/api-key/api-key-role.service';
import { InternalServerError } from 'src/engine/core-modules/graphql/utils/graphql-errors.util';
@@ -298,7 +298,7 @@ export abstract class RestApiBaseHandler {
let selectOptions = undefined;
if (!isEmpty(restrictedFields)) {
selectOptions = getAllSelectableFields({
selectOptions = getAllSelectableColumnNames({
restrictedFields,
objectMetadata,
});
packages/twenty-server/src/engine/api/rest/core/rest-to-common-args-handlers/selected-fields-handler.ts
+1 -1
View File
@@ -4,9 +4,9 @@ import { FieldMetadataType, ObjectsPermissions } from 'twenty-shared/types';
import { isDefined } from 'twenty-shared/utils';
import { CommonSelectedFields } from 'src/engine/api/common/types/common-selected-fields-result.type';
import { getAllSelectableFields } from 'src/engine/api/rest/core/rest-to-common-args-handlers/utils/get-all-selectable-fields.util';
import { MAX_DEPTH } from 'src/engine/api/rest/input-request-parsers/constants/max-depth.constant';
import { Depth } from 'src/engine/api/rest/input-request-parsers/types/depth.type';
import { getAllSelectableFields } from 'src/engine/api/utils/get-all-selectable-fields.utils';
import { ObjectMetadataItemWithFieldMaps } from 'src/engine/metadata-modules/types/object-metadata-item-with-field-maps';
import { ObjectMetadataMaps } from 'src/engine/metadata-modules/types/object-metadata-maps';
import { isFieldMetadataEntityOfType } from 'src/engine/utils/is-field-metadata-of-type.util';
packages/twenty-server/src/engine/api/rest/core/rest-to-common-args-handlers/utils/__tests__/get-all-selectable-fields.util.spec.ts
+182
View File
@@ -0,0 +1,182 @@
import { FieldMetadataType } from 'twenty-shared/types';
import { getAllSelectableFields } from 'src/engine/api/rest/core/rest-to-common-args-handlers/utils/get-all-selectable-fields.util';
import { type ObjectMetadataItemWithFieldMaps } from 'src/engine/metadata-modules/types/object-metadata-item-with-field-maps';
describe('getAllSelectableFields', () => {
it('should return all fields as selectable when no restrictions', () => {
const objectMetadata = {
objectMetadataMapItem: {
fieldsById: {
'field-1': {
id: 'field-1',
name: 'name',
type: FieldMetadataType.TEXT,
},
'field-2': {
id: 'field-2',
name: 'email',
type: FieldMetadataType.TEXT,
},
},
} as any as ObjectMetadataItemWithFieldMaps,
};
const result = getAllSelectableFields({
restrictedFields: {},
objectMetadata,
});
expect(result).toEqual({
name: true,
email: true,
});
});
it('should not return restricted fields', () => {
const objectMetadata = {
objectMetadataMapItem: {
fieldsById: {
'field-1': {
id: 'field-1',
name: 'name',
type: FieldMetadataType.TEXT,
},
'field-2': {
id: 'field-2',
name: 'email',
type: FieldMetadataType.TEXT,
},
},
} as any as ObjectMetadataItemWithFieldMaps,
};
const result = getAllSelectableFields({
restrictedFields: {
'field-2': { canRead: false },
},
objectMetadata,
});
expect(result).toEqual({
name: true,
});
});
it('should create nested objects for composite fields', () => {
const objectMetadata = {
objectMetadataMapItem: {
fieldsById: {
'field-1': {
id: 'field-1',
name: 'name',
type: FieldMetadataType.TEXT,
},
'field-2': {
id: 'field-2',
name: 'fullName',
type: FieldMetadataType.FULL_NAME,
},
'field-3': {
id: 'field-3',
name: 'domainName',
type: FieldMetadataType.LINKS,
},
},
} as any as ObjectMetadataItemWithFieldMaps,
};
const result = getAllSelectableFields({
restrictedFields: {},
objectMetadata,
});
expect(result).toEqual({
name: true,
fullName: {
firstName: true,
lastName: true,
},
domainName: {
primaryLinkLabel: true,
primaryLinkUrl: true,
secondaryLinks: true,
},
});
});
it('should restrict all sub-fields when composite field is restricted', () => {
const objectMetadata = {
objectMetadataMapItem: {
fieldsById: {
'field-1': {
id: 'field-1',
name: 'name',
type: FieldMetadataType.TEXT,
},
'field-2': {
id: 'field-2',
name: 'fullName',
type: FieldMetadataType.FULL_NAME,
},
},
} as any as ObjectMetadataItemWithFieldMaps,
};
const result = getAllSelectableFields({
restrictedFields: {
'field-2': { canRead: false },
},
objectMetadata,
});
expect(result).toEqual({
name: true,
});
});
it('should handle mixed regular and composite fields with restrictions', () => {
const objectMetadata = {
objectMetadataMapItem: {
fieldsById: {
'field-1': {
id: 'field-1',
name: 'name',
type: FieldMetadataType.TEXT,
},
'field-2': {
id: 'field-2',
name: 'email',
type: FieldMetadataType.TEXT,
},
'field-3': {
id: 'field-3',
name: 'fullName',
type: FieldMetadataType.FULL_NAME,
},
'field-4': {
id: 'field-4',
name: 'address',
type: FieldMetadataType.ADDRESS,
},
},
} as any as ObjectMetadataItemWithFieldMaps,
};
const result = getAllSelectableFields({
restrictedFields: {
'field-2': { canRead: false },
'field-4': { canRead: false },
},
objectMetadata,
});
expect(result).toEqual({
name: true,
fullName: {
firstName: true,
lastName: true,
},
});
});
});
packages/twenty-server/src/engine/api/rest/core/rest-to-common-args-handlers/utils/get-all-selectable-fields.util.ts
+60
View File
@@ -0,0 +1,60 @@
import {
FieldMetadataType,
RelationType,
type RestrictedFieldsPermissions,
} from 'twenty-shared/types';
import { isDefined } from 'twenty-shared/utils';
import { compositeTypeDefinitions } from 'src/engine/metadata-modules/field-metadata/composite-types';
import { isCompositeFieldMetadataType } from 'src/engine/metadata-modules/field-metadata/utils/is-composite-field-metadata-type.util';
import { type ObjectMetadataItemWithFieldMaps } from 'src/engine/metadata-modules/types/object-metadata-item-with-field-maps';
import { isFieldMetadataEntityOfType } from 'src/engine/utils/is-field-metadata-of-type.util';
type SelectableFieldsStructured = Record<
string,
boolean | Record<string, boolean>
>;
export const getAllSelectableFields = ({
restrictedFields,
objectMetadata,
}: {
restrictedFields: RestrictedFieldsPermissions;
objectMetadata: { objectMetadataMapItem: ObjectMetadataItemWithFieldMaps };
}): SelectableFieldsStructured => {
const result: SelectableFieldsStructured = {};
const fields = Object.values(objectMetadata.objectMetadataMapItem.fieldsById);
for (const field of fields) {
if (restrictedFields[field.id]?.canRead === false) continue;
if (isCompositeFieldMetadataType(field.type)) {
const compositeType = compositeTypeDefinitions.get(field.type);
if (!compositeType) {
throw new Error(
`Composite type definition not found for type: ${field.type}`,
);
}
const compositeFields: Record<string, boolean> = {};
for (const property of compositeType.properties) {
compositeFields[property.name] = true;
}
result[field.name] = compositeFields;
} else if (
isFieldMetadataEntityOfType(field, FieldMetadataType.RELATION) &&
field.settings.relationType === RelationType.MANY_TO_ONE &&
isDefined(field.settings.joinColumnName)
) {
result[field.settings.joinColumnName] = true;
} else {
result[field.name] = true;
}
}
return result;
};
packages/twenty-server/src/engine/api/utils/get-all-selectable-fields.utils.ts → packages/twenty-server/src/engine/api/utils/get-all-selectable-column-names.utils.ts
+1 -1
View File
@@ -9,7 +9,7 @@ type GetAllSelectableFieldsArgs = {
objectMetadata: { objectMetadataMapItem: ObjectMetadataItemWithFieldMaps };
};
export const getAllSelectableFields = ({
export const getAllSelectableColumnNames = ({
restrictedFields,
objectMetadata,
}: GetAllSelectableFieldsArgs) => {
packages/twenty-server/src/engine/core-modules/record-crud/services/find-records.service.ts
+2 -2
View File
@@ -11,7 +11,7 @@ import {
} from 'src/engine/api/graphql/workspace-query-builder/interfaces/object-record.interface';
import { GraphqlQueryParser } from 'src/engine/api/graphql/graphql-query-runner/graphql-query-parsers/graphql-query.parser';
import { getAllSelectableFields } from 'src/engine/api/utils/get-all-selectable-fields.utils';
import { getAllSelectableColumnNames } from 'src/engine/api/utils/get-all-selectable-column-names.utils';
import { type FindRecordsParams } from 'src/engine/core-modules/record-crud/types/find-records-params.type';
import { FindRecordsResult } from 'src/engine/core-modules/record-crud/types/find-records-result.type';
import { type ToolOutput } from 'src/engine/core-modules/tool/types/tool-output.type';
@@ -125,7 +125,7 @@ export class FindRecordsService {
return queryBuilder;
}
const selectableFields = getAllSelectableFields({
const selectableFields = getAllSelectableColumnNames({
restrictedFields,
objectMetadata: {
objectMetadataMapItem: objectMetadataItemWithFieldsMaps,
packages/twenty-server/src/engine/core-modules/record-crud/utils/get-selected-columns-from-restricted-fields.util.ts
+3 -3
View File
@@ -1,7 +1,7 @@
import isEmpty from 'lodash.isempty';
import { type RestrictedFieldsPermissions } from 'twenty-shared/types';
import { getAllSelectableFields } from 'src/engine/api/utils/get-all-selectable-fields.utils';
import { getAllSelectableColumnNames } from 'src/engine/api/utils/get-all-selectable-column-names.utils';
import { type ObjectMetadataItemWithFieldMaps } from 'src/engine/metadata-modules/types/object-metadata-item-with-field-maps';
export const getSelectedColumnsFromRestrictedFields = (
@@ -12,12 +12,12 @@ export const getSelectedColumnsFromRestrictedFields = (
return undefined;
}
const selectableFields = getAllSelectableFields({
const selectableFields = getAllSelectableColumnNames({
restrictedFields,
objectMetadata: {
objectMetadataMapItem: objectMetadataItemWithFieldsMaps,
},
});
return Object.keys(selectableFields).filter((key) => selectableFields[key]);
return Object.keys(selectableFields);
};
packages/twenty-server/src/engine/metadata-modules/agent/agent-execution.service.ts
+2 -2
View File
@@ -14,7 +14,7 @@ import { AppPath } from 'twenty-shared/types';
import { getAppPath } from 'twenty-shared/utils';
import { In } from 'typeorm';
import { getAllSelectableFields } from 'src/engine/api/utils/get-all-selectable-fields.utils';
import { getAllSelectableColumnNames } from 'src/engine/api/utils/get-all-selectable-column-names.utils';
import { AI_TELEMETRY_CONFIG } from 'src/engine/core-modules/ai/constants/ai-telemetry.const';
import { AIBillingService } from 'src/engine/core-modules/ai/services/ai-billing.service';
import { AiModelRegistryService } from 'src/engine/core-modules/ai/services/ai-model-registry.service';
@@ -230,7 +230,7 @@ export class AgentExecutionService implements AgentExecutionContext {
);
const selectOptions = hasRestrictedFields
? getAllSelectableFields({
? getAllSelectableColumnNames({
restrictedFields,
objectMetadata: { objectMetadataMapItem },
})
packages/twenty-server/test/integration/rest/suites/rest-api-core-delete.integration-spec.ts
+6 -9
View File
@@ -51,16 +51,13 @@ describe('Core REST API Delete One endpoint', () => {
});
it('should return a EntityNotFoundError when trying to delete a non-existing person', async () => {
await makeRestAPIRequest({
const response = await makeRestAPIRequest({
method: 'delete',
path: `/people/${NOT_EXISTING_TEST_PERSON_ID}`,
})
.expect(400)
.expect((res) => {
expect(res.body.messages[0]).toContain(
`Could not find any entity of type "person"`,
);
expect(res.body.error).toBe('EntityNotFoundError');
});
});
expect(response.status).toBe(400);
expect(response.body.error).toBe('EntityNotFoundError');
// expect(response.body.messages[0]).toBe('Record not found');
});
});
packages/twenty-server/test/integration/rest/suites/rest-api-core-find-many.integration-spec.ts
+22 -22
View File
@@ -208,22 +208,24 @@ describe('Core REST API Find Many endpoint', () => {
expect(filteredPeople.length).toBeGreaterThan(0);
});
it('should fail to filter on a relation field name', async () => {
const response = await makeRestAPIRequest({
method: 'get',
path: `/people?filter=company[in]:["${TEST_COMPANY_1_ID}"]`,
});
// TODO: Refacto-common - Uncomment this after https://github.com/twentyhq/core-team-issues/issues/1627
expect(response.body).toMatchInlineSnapshot(`
{
"error": "BadRequestException",
"messages": [
"field 'company' does not exist in 'person' object",
],
"statusCode": 400,
}
`);
});
// it('should fail to filter on a relation field name', async () => {
// const response = await makeRestAPIRequest({
// method: 'get',
// path: `/people?filter=company[in]:["${TEST_COMPANY_1_ID}"]`,
// });
// expect(response.body).toMatchInlineSnapshot(`
// {
// "error": "BadRequestException",
// "messages": [
// "field 'company' does not exist in 'person' object",
// ],
// "statusCode": 400,
// }
// `);
// });
it('should support ordering Desc of results', async () => {
const descResponse = await makeRestAPIRequest({
@@ -265,15 +267,13 @@ describe('Core REST API Find Many endpoint', () => {
});
it('should handle invalid cursor gracefully', async () => {
await makeRestAPIRequest({
const response = await makeRestAPIRequest({
method: 'get',
path: '/people?starting_after=invalid-cursor',
})
.expect(400)
.expect((res) => {
expect(res.body.error).toBe('BadRequestException');
expect(res.body.messages[0]).toContain('Invalid cursor');
});
});
expect(response.body.error).toBe('BadRequestException');
expect(response.body.messages[0]).toContain('Invalid cursor');
});
it('should combine filtering, ordering, and pagination', async () => {
packages/twenty-server/test/integration/rest/suites/rest-api-core-update.integration-spec.ts
+23 -27
View File
@@ -44,29 +44,28 @@ describe('Core REST API Update One endpoint', () => {
});
it('should update an existing person (name, emails, and city)', async () => {
await makeRestAPIRequest({
const response = await makeRestAPIRequest({
method: 'patch',
path: `/people/${TEST_PERSON_1_ID}`,
body: updatedData,
})
.expect(200)
.expect((res) => {
const updatedPerson = res.body.data.updatePerson;
});
expect(updatedPerson.id).toBe(TEST_PERSON_1_ID);
expect(updatedPerson.name.firstName).toBe(updatedData.name.firstName);
expect(updatedPerson.name.lastName).toBe(updatedData.name.lastName);
expect(updatedPerson.emails.primaryEmail).toBe(
updatedData.emails.primaryEmail,
);
expect(updatedPerson.emails.additionalEmails).toEqual(
updatedData.emails.additionalEmails,
);
expect(updatedPerson.city).toBe(updatedData.city);
expect(response.status).toBe(200);
expect(updatedPerson.jobTitle).toBe('');
expect(updatedPerson.companyId).toBe(TEST_COMPANY_1_ID);
});
const updatedPerson = response.body.data.updatePerson;
expect(updatedPerson.id).toBe(TEST_PERSON_1_ID);
expect(updatedPerson.name.firstName).toBe(updatedData.name.firstName);
expect(updatedPerson.name.lastName).toBe(updatedData.name.lastName);
expect(updatedPerson.emails.primaryEmail).toBe(
updatedData.emails.primaryEmail,
);
expect(updatedPerson.emails.additionalEmails).toEqual(
updatedData.emails.additionalEmails,
);
expect(updatedPerson.city).toBe(updatedData.city);
expect(updatedPerson.jobTitle).toBe('');
expect(updatedPerson.companyId).toBe(TEST_COMPANY_1_ID);
});
it('should support depth 0 parameter', async () => {
@@ -108,16 +107,13 @@ describe('Core REST API Update One endpoint', () => {
});
it('should return a EntityNotFoundError when trying to update a non-existing person', async () => {
await makeRestAPIRequest({
const response = await makeRestAPIRequest({
method: 'patch',
path: `/people/${NOT_EXISTING_TEST_PERSON_ID}`,
})
.expect(400)
.expect((res) => {
expect(res.body.messages[0]).toContain(
`Could not find any entity of type "person"`,
);
expect(res.body.error).toBe('EntityNotFoundError');
});
});
expect(response.status).toBe(400);
expect(response.body.error).toBe('EntityNotFoundError');
// expect(response.body.message).toBe('Record not found');
});
});