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

971 rest api bug sentry on filter parameters (#12088)

Browse Source 
- fix missing createBy injection in api createOne and createMany
endpoints
- add a command to fix null default value for createdBySource in
production entities
- tested on `1747159401197/` dump extract of production db without issue
This commit is contained in:
martmull
2025-05-19 12:46:03 +02:00
committed by GitHub
parent 58b40b1f89
commit b52ef76376
20 changed files with 418 additions and 162 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
packages/twenty-server/src/engine/core-modules/actor/query-hooks/created-by.create-many.pre-query-hook.ts
View File

@ -1,7 +1,4 @@
import { InjectRepository } from '@nestjs/typeorm';
import { isDefined } from 'twenty-shared/utils';
import { Repository } from 'typeorm';
import { WorkspacePreQueryHookInstance } from 'src/engine/api/graphql/workspace-query-runner/workspace-query-hook/interfaces/workspace-query-hook.interface';
import { CreateManyResolverArgs } from 'src/engine/api/graphql/workspace-resolver-builder/interfaces/workspace-resolvers-builder.interface';
@ -11,34 +8,25 @@ import {
GraphqlQueryRunnerExceptionCode,
} from 'src/engine/api/graphql/graphql-query-runner/errors/graphql-query-runner.exception';
import { WorkspaceQueryHook } from 'src/engine/api/graphql/workspace-query-runner/workspace-query-hook/decorators/workspace-query-hook.decorator';
import { CreatedByFromAuthContextService } from 'src/engine/core-modules/actor/services/created-by-from-auth-context.service';
import {
CreatedByFromAuthContextService,
CreateInput,
} from 'src/engine/core-modules/actor/services/created-by-from-auth-context.service';
import { AuthContext } from 'src/engine/core-modules/auth/types/auth-context.type';
import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { CustomWorkspaceEntity } from 'src/engine/twenty-orm/custom.workspace-entity';
type CustomWorkspaceItem = Omit<
CustomWorkspaceEntity,
'createdAt' | 'updatedAt'
> & {
createdAt: string;
updatedAt: string;
};
@WorkspaceQueryHook(`*.createMany`)
export class CreatedByCreateManyPreQueryHook
implements WorkspacePreQueryHookInstance
{
constructor(
@InjectRepository(FieldMetadataEntity, 'metadata')
private readonly fieldMetadataRepository: Repository<FieldMetadataEntity>,
private readonly createdByFromAuthContextService: CreatedByFromAuthContextService,
) {}
async execute(
authContext: AuthContext,
objectName: string,
payload: CreateManyResolverArgs<CustomWorkspaceItem>,
): Promise<CreateManyResolverArgs<CustomWorkspaceItem>> {
payload: CreateManyResolverArgs<CreateInput>,
): Promise<CreateManyResolverArgs<CreateInput>> {
if (!isDefined(payload.data)) {
throw new GraphqlQueryRunnerException(
'Payload data is required',
@ -46,34 +34,13 @@ export class CreatedByCreateManyPreQueryHook
);
}
// TODO: Once all objects have it, we can remove this check
const createdByFieldMetadata = await this.fieldMetadataRepository.findOne({
where: {
object: {
nameSingular: objectName,
},
name: 'createdBy',
workspaceId: authContext.workspace.id,
},
});
if (!createdByFieldMetadata) {
return payload;
}
const createdBy =
await this.createdByFromAuthContextService.buildCreatedBy(authContext);
for (const datum of payload.data) {
// Front-end can fill the source field
if (createdBy && (!datum.createdBy || !datum.createdBy?.name)) {
datum.createdBy = {
...createdBy,
source: datum.createdBy?.source ?? createdBy.source,
};
}
}
return payload;
return {
...payload,
data: await this.createdByFromAuthContextService.injectCreatedBy(
payload.data,
objectName,
authContext,
),
};
}
}

63
packages/twenty-server/src/engine/core-modules/actor/query-hooks/created-by.create-one.pre-query-hook.ts
View File

@ -1,7 +1,4 @@
import { InjectRepository } from '@nestjs/typeorm';
import { isDefined } from 'class-validator';
import { Repository } from 'typeorm';
import { WorkspacePreQueryHookInstance } from 'src/engine/api/graphql/workspace-query-runner/workspace-query-hook/interfaces/workspace-query-hook.interface';
import { CreateOneResolverArgs } from 'src/engine/api/graphql/workspace-resolver-builder/interfaces/workspace-resolvers-builder.interface';
@ -11,34 +8,25 @@ import {
GraphqlQueryRunnerExceptionCode,
} from 'src/engine/api/graphql/graphql-query-runner/errors/graphql-query-runner.exception';
import { WorkspaceQueryHook } from 'src/engine/api/graphql/workspace-query-runner/workspace-query-hook/decorators/workspace-query-hook.decorator';
import { CreatedByFromAuthContextService } from 'src/engine/core-modules/actor/services/created-by-from-auth-context.service';
import {
CreatedByFromAuthContextService,
CreateInput,
} from 'src/engine/core-modules/actor/services/created-by-from-auth-context.service';
import { AuthContext } from 'src/engine/core-modules/auth/types/auth-context.type';
import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { CustomWorkspaceEntity } from 'src/engine/twenty-orm/custom.workspace-entity';
type CustomWorkspaceItem = Omit<
CustomWorkspaceEntity,
'createdAt' | 'updatedAt'
> & {
createdAt: string;
updatedAt: string;
};
@WorkspaceQueryHook(`*.createOne`)
export class CreatedByCreateOnePreQueryHook
implements WorkspacePreQueryHookInstance
{
constructor(
@InjectRepository(FieldMetadataEntity, 'metadata')
private readonly fieldMetadataRepository: Repository<FieldMetadataEntity>,
private readonly createdByFromAuthContextService: CreatedByFromAuthContextService,
) {}
async execute(
authContext: AuthContext,
objectName: string,
payload: CreateOneResolverArgs<CustomWorkspaceItem>,
): Promise<CreateOneResolverArgs<CustomWorkspaceItem>> {
payload: CreateOneResolverArgs<CreateInput>,
): Promise<CreateOneResolverArgs<CreateInput>> {
if (!isDefined(payload.data)) {
throw new GraphqlQueryRunnerException(
'Payload data is required',
@ -46,35 +34,16 @@ export class CreatedByCreateOnePreQueryHook
);
}
// TODO: Once all objects have it, we can remove this check
const createdByFieldMetadata = await this.fieldMetadataRepository.findOne({
where: {
object: {
nameSingular: objectName,
},
name: 'createdBy',
workspaceId: authContext.workspace.id,
},
});
const [recordToCreateData] =
await this.createdByFromAuthContextService.injectCreatedBy(
[payload.data],
objectName,
authContext,
);
if (!createdByFieldMetadata) {
return payload;
}
const createdBy =
await this.createdByFromAuthContextService.buildCreatedBy(authContext);
// Front-end can fill the source field
if (
createdBy &&
(!payload.data.createdBy || !payload.data.createdBy?.name)
) {
payload.data.createdBy = {
...createdBy,
source: payload.data.createdBy?.source ?? createdBy.source,
};
}
return payload;
return {
...payload,
data: recordToCreateData,
};
}
}

81
packages/twenty-server/src/engine/core-modules/actor/services/__tests__/created-by-from-auth-context.service.spec.ts
View File

@ -1,4 +1,5 @@
import { Test, TestingModule } from '@nestjs/testing';
import { getRepositoryToken } from '@nestjs/typeorm';
import { CreatedByFromAuthContextService } from 'src/engine/core-modules/actor/services/created-by-from-auth-context.service';
import { AuthContext } from 'src/engine/core-modules/auth/types/auth-context.type';
@ -12,12 +13,16 @@ import { FullNameMetadata } from 'src/engine/metadata-modules/field-metadata/com
import { TwentyORMGlobalManager } from 'src/engine/twenty-orm/twenty-orm-global.manager';
import { ApiKeyWorkspaceEntity } from 'src/modules/api-key/standard-objects/api-key.workspace-entity';
import { WorkspaceMemberWorkspaceEntity } from 'src/modules/workspace-member/standard-objects/workspace-member.workspace-entity';
import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
type TestingAuthContext = Omit<AuthContext, 'workspace' | 'apiKey' | 'user'> & {
workspace: Partial<Workspace>;
apiKey?: Partial<ApiKeyWorkspaceEntity>;
user?: Partial<User>;
};
type ExpectedResult = { createdBy: ActorMetadata }[];
// TODO create util
const fromFullNameMetadataToName = ({
firstName,
@ -45,6 +50,12 @@ describe('CreatedByFromAuthContextService', () => {
provide: TwentyORMGlobalManager,
useValue: twentyORMGlobalManager,
},
{
provide: getRepositoryToken(FieldMetadataEntity, 'metadata'),
useValue: {
findOne: jest.fn().mockResolvedValue(true),
},
},
],
}).compile();
@ -60,7 +71,7 @@ describe('CreatedByFromAuthContextService', () => {
it('should be defined', () => {
expect(service).toBeDefined();
});
describe('buildCreatedBy', () => {
describe('injectCreatedBy', () => {
it('should build metadata from workspaceMemberId and user when both are present', async () => {
const authContext = {
workspaceMemberId: '20202020-0b5c-4178-bed7-d371f6411eaa',
@ -72,14 +83,22 @@ describe('CreatedByFromAuthContextService', () => {
workspace: { id: '20202020-bdec-497f-847a-1bb334fefe58' },
} as const satisfies TestingAuthContext;
const result = await service.buildCreatedBy(authContext as AuthContext);
const result = await service.injectCreatedBy(
[{}],
'person',
authContext as AuthContext,
);
expect(result).toEqual<ActorMetadata>({
context: {},
name: fromFullNameMetadataToName(authContext.user),
workspaceMemberId: authContext.workspaceMemberId,
source: FieldActorSource.MANUAL,
});
expect(result).toEqual<ExpectedResult>([
{
createdBy: {
context: {},
name: fromFullNameMetadataToName(authContext.user),
workspaceMemberId: authContext.workspaceMemberId,
source: FieldActorSource.MANUAL,
},
},
]);
});
it('should build metadata from user when workspaceMemberId is missing', async () => {
@ -104,14 +123,22 @@ describe('CreatedByFromAuthContextService', () => {
mockedWorkspaceMember,
);
const result = await service.buildCreatedBy(authContext as AuthContext);
const result = await service.injectCreatedBy(
[{}],
'person',
authContext as AuthContext,
);
expect(result).toEqual<ActorMetadata>({
context: {},
name: fromFullNameMetadataToName(mockedWorkspaceMember.name),
workspaceMemberId: mockedWorkspaceMember.id,
source: FieldActorSource.MANUAL,
});
expect(result).toEqual<ExpectedResult>([
{
createdBy: {
context: {},
name: fromFullNameMetadataToName(mockedWorkspaceMember.name),
workspaceMemberId: mockedWorkspaceMember.id,
source: FieldActorSource.MANUAL,
},
},
]);
});
it('should build metadata from apiKey when only apiKey is present', async () => {
@ -123,14 +150,22 @@ describe('CreatedByFromAuthContextService', () => {
workspace: { id: '20202020-bdec-497f-847a-1bb334fefe58' },
} as const satisfies TestingAuthContext;
const result = await service.buildCreatedBy(authContext as AuthContext);
const result = await service.injectCreatedBy(
[{}],
'person',
authContext as AuthContext,
);
expect(result).toEqual<ActorMetadata>({
source: FieldActorSource.API,
workspaceMemberId: null,
name: authContext.apiKey.name,
context: {},
});
expect(result).toEqual<ExpectedResult>([
{
createdBy: {
source: FieldActorSource.API,
workspaceMemberId: null,
name: authContext.apiKey.name,
context: {},
},
},
]);
});
it('should throw error when no valid actor information is found', async () => {
@ -139,7 +174,7 @@ describe('CreatedByFromAuthContextService', () => {
} as const satisfies TestingAuthContext;
await expect(
service.buildCreatedBy(authContext as AuthContext),
service.injectCreatedBy([{}], 'person', authContext as AuthContext),
).rejects.toThrowErrorMatchingInlineSnapshot(
`"Unable to build createdBy metadata - no valid actor information found in auth context"`,
);

58
packages/twenty-server/src/engine/core-modules/actor/services/created-by-from-auth-context.service.ts
View File

@ -1,6 +1,8 @@
import { Injectable, Logger } from '@nestjs/common';
import { InjectRepository } from '@nestjs/typeorm';
import { isDefined } from 'twenty-shared/utils';
import { Repository } from 'typeorm';
import { buildCreatedByFromApiKey } from 'src/engine/core-modules/actor/utils/build-created-by-from-api-key.util';
import { buildCreatedByFromFullNameMetadata } from 'src/engine/core-modules/actor/utils/build-created-by-from-full-name-metadata.util';
@ -8,16 +10,70 @@ import { AuthContext } from 'src/engine/core-modules/auth/types/auth-context.typ
import { ActorMetadata } from 'src/engine/metadata-modules/field-metadata/composite-types/actor.composite-type';
import { TwentyORMGlobalManager } from 'src/engine/twenty-orm/twenty-orm-global.manager';
import { WorkspaceMemberWorkspaceEntity } from 'src/modules/workspace-member/standard-objects/workspace-member.workspace-entity';
import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export type CreateInput = Record<string, any>;
@Injectable()
export class CreatedByFromAuthContextService {
private readonly logger = new Logger(CreatedByFromAuthContextService.name);
constructor(
@InjectRepository(FieldMetadataEntity, 'metadata')
private readonly fieldMetadataRepository: Repository<FieldMetadataEntity>,
private readonly twentyORMGlobalManager: TwentyORMGlobalManager,
) {}
public async buildCreatedBy(
async injectCreatedBy(
records: CreateInput[],
objectMetadataNameSingular: string,
authContext: AuthContext,
): Promise<CreateInput[]> {
// TODO: Once all objects have it, we can remove this check
const createdByFieldMetadata = await this.fieldMetadataRepository.findOne({
where: {
object: {
nameSingular: objectMetadataNameSingular,
},
name: 'createdBy',
workspaceId: authContext.workspace.id,
},
});
if (!createdByFieldMetadata) {
return records;
}
const clonedRecords = structuredClone(records);
const createdBy = await this.buildCreatedBy(authContext);
if (Array.isArray(clonedRecords)) {
for (const datum of clonedRecords) {
this.injectCreatedByToRecord(createdBy, datum);
}
} else {
this.injectCreatedByToRecord(createdBy, clonedRecords);
}
return clonedRecords;
}
private injectCreatedByToRecord(
createdBy: ActorMetadata,
record: CreateInput,
) {
// Front-end can fill the source field
if (createdBy && (!record.createdBy || !record.createdBy?.name)) {
record.createdBy = {
...createdBy,
source: record.createdBy?.source ?? createdBy.source,
};
}
}
private async buildCreatedBy(
authContext: AuthContext,
): Promise<ActorMetadata> {
const { workspace, workspaceMemberId, user, apiKey } = authContext;