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

Enhance role-check system with stricter checks (#15392)

Browse Source 
## Overview

This PR strengthens our permission system by introducing more granular
role-based access control across the platform.

## Changes

### New Permissions Added
- **Applications** - Control who can install and manage applications
- **Layouts** - Control who can customize page layouts and UI structure
- **AI** - Control access to AI features and agents
- **Upload File** - Separate permission for file uploads
- **Download File** - Separate permission for file downloads (frontend
visibility)

### Security Enhancements
- Implemented whitelist-based validation for workspace field updates
- Added explicit permission guards to core entity resolvers
- Enhanced ESLint rule to enforce permission checks on all mutations
- Created `CustomPermissionGuard` and `NoPermissionGuard` for better
code documentation

### Affected Components
- Core entity resolvers: webhooks, files, domains, applications,
layouts, postgres credentials
- Workspace update mutations now use whitelist validation
- Settings UI updated with new permission controls

### Developer Experience
- ESLint now catches missing permission guards during development
- Explicit guard markers make permission requirements clear in code
review
- Comprehensive test coverage for new permission logic

## Testing
- ✅ All TypeScript type checks pass
- ✅ ESLint validation passes
- ✅ New permission guards properly enforced
- ✅ Frontend UI displays new permissions correctly

## Migration Notes
Existing workspaces will need to assign the new permissions to roles as
needed. By default, all new permissions are set to `false` for non-admin
roles.
This commit is contained in:
Félix Malfait
2025-11-07 15:37:17 +01:00
committed by GitHub
parent 44d6ec2594
commit cff17db6cb
306 changed files with 13863 additions and 976 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/twenty-server/src/engine/metadata-modules/view/controllers/view.controller.ts
+8 -1
View File
@@ -18,10 +18,13 @@ import { FeatureFlagKey } from 'src/engine/core-modules/feature-flag/enums/featu
import { FeatureFlagService } from 'src/engine/core-modules/feature-flag/services/feature-flag.service';
import { I18nService } from 'src/engine/core-modules/i18n/i18n.service';
import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
import { AuthUserWorkspaceId } from 'src/engine/decorators/auth/auth-user-workspace-id.decorator';
import { AuthWorkspace } from 'src/engine/decorators/auth/auth-workspace.decorator';
import { RequestLocale } from 'src/engine/decorators/locale/request-locale.decorator';
import { WorkspaceAuthGuard } from 'src/engine/guards/workspace-auth.guard';
import { resolveObjectMetadataStandardOverride } from 'src/engine/metadata-modules/object-metadata/utils/resolve-object-metadata-standard-override.util';
import { DeleteViewPermissionGuard } from 'src/engine/metadata-modules/view-permissions/guards/delete-view-permission.guard';
import { UpdateViewPermissionGuard } from 'src/engine/metadata-modules/view-permissions/guards/update-view-permission.guard';
import { CreateViewInput } from 'src/engine/metadata-modules/view/dtos/inputs/create-view.input';
import { UpdateViewInput } from 'src/engine/metadata-modules/view/dtos/inputs/update-view.input';
import { type ViewDTO } from 'src/engine/metadata-modules/view/dtos/view.dto';
@@ -53,14 +56,16 @@ export class ViewController {
async findMany(
@RequestLocale() locale: keyof typeof APP_LOCALES | undefined,
@AuthWorkspace() workspace: WorkspaceEntity,
@AuthUserWorkspaceId() userWorkspaceId: string | undefined,
@Query('objectMetadataId') objectMetadataId?: string,
): Promise<ViewDTO[]> {
const views = objectMetadataId
? await this.viewService.findByObjectMetadataId(
workspace.id,
objectMetadataId,
userWorkspaceId,
)
: await this.viewService.findByWorkspaceId(workspace.id);
: await this.viewService.findByWorkspaceId(workspace.id, userWorkspaceId);
return this.processViewsWithTemplates(views, workspace.id, locale);
}
@@ -133,6 +138,7 @@ export class ViewController {
}
@Patch(':id')
@UseGuards(UpdateViewPermissionGuard)
async update(
@Param('id') id: string,
@Body() input: UpdateViewInput,
@@ -169,6 +175,7 @@ export class ViewController {
}
@Delete(':id')
@UseGuards(DeleteViewPermissionGuard)
async delete(
@Param('id') id: string,
@AuthWorkspace() workspace: WorkspaceEntity,
packages/twenty-server/src/engine/metadata-modules/view/dtos/inputs/create-view.input.ts
+8
View File
@@ -17,6 +17,7 @@ import { ViewCalendarLayout } from 'src/engine/metadata-modules/view/enums/view-
import { ViewKey } from 'src/engine/metadata-modules/view/enums/view-key.enum';
import { ViewOpenRecordIn } from 'src/engine/metadata-modules/view/enums/view-open-record-in';
import { ViewType } from 'src/engine/metadata-modules/view/enums/view-type.enum';
import { ViewVisibility } from 'src/engine/metadata-modules/view/enums/view-visibility.enum';
@InputType()
export class CreateViewInput {
@@ -91,6 +92,13 @@ export class CreateViewInput {
@Field(() => UUIDScalarType, { nullable: true })
calendarFieldMetadataId?: string;
@IsOptional()
@IsEnum(ViewVisibility)
@Field(() => ViewVisibility, {
nullable: true,
})
visibility?: ViewVisibility;
@HideField()
universalIdentifier?: string;
packages/twenty-server/src/engine/metadata-modules/view/dtos/inputs/update-view.input.ts
+6
View File
@@ -15,6 +15,7 @@ import { IsValidMetadataName } from 'src/engine/decorators/metadata/is-valid-met
import { ViewCalendarLayout } from 'src/engine/metadata-modules/view/enums/view-calendar-layout.enum';
import { ViewOpenRecordIn } from 'src/engine/metadata-modules/view/enums/view-open-record-in';
import { ViewType } from 'src/engine/metadata-modules/view/enums/view-type.enum';
import { ViewVisibility } from 'src/engine/metadata-modules/view/enums/view-visibility.enum';
// TODO: this should be refactored like for view-field.input.ts
// This is a temporary fix as we were extending the CreateViewInput class which was adding default values for the non filled fields
@@ -81,4 +82,9 @@ export class UpdateViewInput {
@IsUUID()
@Field(() => UUIDScalarType, { nullable: true })
calendarFieldMetadataId?: string;
@IsOptional()
@IsEnum(ViewVisibility)
@Field(() => ViewVisibility, { nullable: true })
visibility?: ViewVisibility;
}
packages/twenty-server/src/engine/metadata-modules/view/dtos/view.dto.ts
+10
View File
@@ -13,11 +13,13 @@ import { ViewCalendarLayout } from 'src/engine/metadata-modules/view/enums/view-
import { ViewKey } from 'src/engine/metadata-modules/view/enums/view-key.enum';
import { ViewOpenRecordIn } from 'src/engine/metadata-modules/view/enums/view-open-record-in';
import { ViewType } from 'src/engine/metadata-modules/view/enums/view-type.enum';
import { ViewVisibility } from 'src/engine/metadata-modules/view/enums/view-visibility.enum';
registerEnumType(ViewOpenRecordIn, { name: 'ViewOpenRecordIn' });
registerEnumType(ViewType, { name: 'ViewType' });
registerEnumType(ViewKey, { name: 'ViewKey' });
registerEnumType(ViewCalendarLayout, { name: 'ViewCalendarLayout' });
registerEnumType(ViewVisibility, { name: 'ViewVisibility' });
@ObjectType('CoreView')
export class ViewDTO {
@@ -95,4 +97,12 @@ export class ViewDTO {
@Field(() => [ViewGroupDTO])
viewGroups?: ViewGroupDTO[];
@Field(() => ViewVisibility, {
nullable: false,
})
visibility: ViewVisibility;
@Field(() => UUIDScalarType, { nullable: true })
createdByUserWorkspaceId?: string | null;
}
packages/twenty-server/src/engine/metadata-modules/view/entities/view.entity.ts
+20
View File
@@ -16,6 +16,7 @@ import {
import { SyncableEntity } from 'src/engine/workspace-manager/workspace-sync/interfaces/syncable-entity.interface';
import { AggregateOperations } from 'src/engine/api/graphql/graphql-query-runner/constants/aggregate-operations.constant';
import { UserWorkspaceEntity } from 'src/engine/core-modules/user-workspace/user-workspace.entity';
import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
@@ -28,6 +29,7 @@ import { ViewCalendarLayout } from 'src/engine/metadata-modules/view/enums/view-
import { ViewKey } from 'src/engine/metadata-modules/view/enums/view-key.enum';
import { ViewOpenRecordIn } from 'src/engine/metadata-modules/view/enums/view-open-record-in';
import { ViewType } from 'src/engine/metadata-modules/view/enums/view-type.enum';
import { ViewVisibility } from 'src/engine/metadata-modules/view/enums/view-visibility.enum';
// We could refactor this type to be dynamic to view type
@Entity({ name: 'view', schema: 'core' })
@@ -35,6 +37,7 @@ import { ViewType } from 'src/engine/metadata-modules/view/enums/view-type.enum'
'workspaceId',
'objectMetadataId',
])
@Index('IDX_VIEW_VISIBILITY', ['visibility'])
@Check(
'CHK_VIEW_CALENDAR_INTEGRITY',
`("type" != 'CALENDAR' OR ("calendarLayout" IS NOT NULL AND "calendarFieldMetadataId" IS NOT NULL))`,
@@ -150,6 +153,23 @@ export class ViewEntity extends SyncableEntity implements Required<ViewEntity> {
@Column({ nullable: true, type: 'text', default: null })
anyFieldFilterValue: string | null;
@Column({
type: 'enum',
enum: Object.values(ViewVisibility),
nullable: false,
default: ViewVisibility.WORKSPACE,
})
visibility: ViewVisibility;
@Column({ nullable: true, type: 'uuid' })
createdByUserWorkspaceId: string | null;
@ManyToOne(() => UserWorkspaceEntity, {
onDelete: 'SET NULL',
})
@JoinColumn({ name: 'createdByUserWorkspaceId' })
createdBy: Relation<UserWorkspaceEntity>;
@ManyToOne(() => WorkspaceEntity, {
onDelete: 'CASCADE',
})
packages/twenty-server/src/engine/metadata-modules/view/enums/view-visibility.enum.ts
+4
View File
@@ -0,0 +1,4 @@
export enum ViewVisibility {
WORKSPACE = 'WORKSPACE',
UNLISTED = 'UNLISTED',
}
packages/twenty-server/src/engine/metadata-modules/view/exceptions/view.exception.ts
+12
View File
@@ -18,6 +18,8 @@ export class ViewException extends CustomException {
export enum ViewExceptionCode {
VIEW_NOT_FOUND = 'VIEW_NOT_FOUND',
INVALID_VIEW_DATA = 'INVALID_VIEW_DATA',
VIEW_CREATE_PERMISSION_DENIED = 'VIEW_CREATE_PERMISSION_DENIED',
VIEW_MODIFY_PERMISSION_DENIED = 'VIEW_MODIFY_PERMISSION_DENIED',
}
export enum ViewExceptionMessageKey {
@@ -25,6 +27,8 @@ export enum ViewExceptionMessageKey {
OBJECT_METADATA_ID_REQUIRED = 'OBJECT_METADATA_ID_REQUIRED',
VIEW_NOT_FOUND = 'VIEW_NOT_FOUND',
INVALID_VIEW_DATA = 'INVALID_VIEW_DATA',
VIEW_CREATE_PERMISSION_DENIED = 'VIEW_CREATE_PERMISSION_DENIED',
VIEW_MODIFY_PERMISSION_DENIED = 'VIEW_MODIFY_PERMISSION_DENIED',
}
export const generateViewExceptionMessage = (
@@ -40,6 +44,10 @@ export const generateViewExceptionMessage = (
return `View${id ? ` (id: ${id})` : ''} not found`;
case ViewExceptionMessageKey.INVALID_VIEW_DATA:
return `Invalid view data${id ? ` for view id: ${id}` : ''}`;
case ViewExceptionMessageKey.VIEW_CREATE_PERMISSION_DENIED:
return 'You do not have permission to create workspace-level views';
case ViewExceptionMessageKey.VIEW_MODIFY_PERMISSION_DENIED:
return 'You do not have permission to modify this view';
default:
assertUnreachable(key);
}
@@ -53,5 +61,9 @@ export const generateViewUserFriendlyExceptionMessage = (
return msg`WorkspaceId is required to create a view.`;
case ViewExceptionMessageKey.OBJECT_METADATA_ID_REQUIRED:
return msg`ObjectMetadataId is required to create a view.`;
case ViewExceptionMessageKey.VIEW_CREATE_PERMISSION_DENIED:
return msg`You don't have permission to create workspace-level views.`;
case ViewExceptionMessageKey.VIEW_MODIFY_PERMISSION_DENIED:
return msg`You don't have permission to modify this view.`;
}
};
packages/twenty-server/src/engine/metadata-modules/view/filters/view-rest-api-exception.filter.ts
+6
View File
@@ -67,6 +67,12 @@ export class ViewRestApiExceptionFilter implements ExceptionFilter {
response,
400,
);
case ViewExceptionCode.VIEW_MODIFY_PERMISSION_DENIED:
return this.httpExceptionHandlerService.handleError(
exception as CustomException,
response,
403,
);
default:
// TODO: change to 500 when we have input validation
return this.httpExceptionHandlerService.handleError(
packages/twenty-server/src/engine/metadata-modules/view/resolvers/view.resolver.ts
+67 -4
View File
@@ -18,9 +18,14 @@ import { I18nService } from 'src/engine/core-modules/i18n/i18n.service';
import { type I18nContext } from 'src/engine/core-modules/i18n/types/i18n-context.type';
import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
import { type IDataloaders } from 'src/engine/dataloaders/dataloader.interface';
import { AuthUserWorkspaceId } from 'src/engine/decorators/auth/auth-user-workspace-id.decorator';
import { AuthWorkspace } from 'src/engine/decorators/auth/auth-workspace.decorator';
import { CustomPermissionGuard } from 'src/engine/guards/custom-permission.guard';
import { WorkspaceAuthGuard } from 'src/engine/guards/workspace-auth.guard';
import { resolveObjectMetadataStandardOverride } from 'src/engine/metadata-modules/object-metadata/utils/resolve-object-metadata-standard-override.util';
import { PermissionFlagType } from 'src/engine/metadata-modules/permissions/constants/permission-flag-type.constants';
import { PermissionsService } from 'src/engine/metadata-modules/permissions/permissions.service';
import { UserRoleService } from 'src/engine/metadata-modules/user-role/user-role.service';
import { ViewFieldDTO } from 'src/engine/metadata-modules/view-field/dtos/view-field.dto';
import { ViewFieldService } from 'src/engine/metadata-modules/view-field/services/view-field.service';
import { ViewFilterGroupDTO } from 'src/engine/metadata-modules/view-filter-group/dtos/view-filter-group.dto';
@@ -29,11 +34,23 @@ import { ViewFilterDTO } from 'src/engine/metadata-modules/view-filter/dtos/view
import { ViewFilterService } from 'src/engine/metadata-modules/view-filter/services/view-filter.service';
import { ViewGroupDTO } from 'src/engine/metadata-modules/view-group/dtos/view-group.dto';
import { ViewGroupService } from 'src/engine/metadata-modules/view-group/services/view-group.service';
import { DeleteViewPermissionGuard } from 'src/engine/metadata-modules/view-permissions/guards/delete-view-permission.guard';
import { DestroyViewPermissionGuard } from 'src/engine/metadata-modules/view-permissions/guards/destroy-view-permission.guard';
import { UpdateViewPermissionGuard } from 'src/engine/metadata-modules/view-permissions/guards/update-view-permission.guard';
import { ViewSortDTO } from 'src/engine/metadata-modules/view-sort/dtos/view-sort.dto';
import { ViewSortService } from 'src/engine/metadata-modules/view-sort/services/view-sort.service';
import { CreateViewInput } from 'src/engine/metadata-modules/view/dtos/inputs/create-view.input';
import { UpdateViewInput } from 'src/engine/metadata-modules/view/dtos/inputs/update-view.input';
import { ViewDTO } from 'src/engine/metadata-modules/view/dtos/view.dto';
import { ViewEntity } from 'src/engine/metadata-modules/view/entities/view.entity';
import { ViewVisibility } from 'src/engine/metadata-modules/view/enums/view-visibility.enum';
import {
ViewException,
ViewExceptionCode,
ViewExceptionMessageKey,
generateViewExceptionMessage,
generateViewUserFriendlyExceptionMessage,
} from 'src/engine/metadata-modules/view/exceptions/view.exception';
import { ViewV2Service } from 'src/engine/metadata-modules/view/services/view-v2.service';
import { ViewService } from 'src/engine/metadata-modules/view/services/view.service';
import { ViewGraphqlApiExceptionFilter } from 'src/engine/metadata-modules/view/utils/view-graphql-api-exception.filter';
@@ -52,6 +69,8 @@ export class ViewResolver {
private readonly i18nService: I18nService,
private readonly featureFlagService: FeatureFlagService,
private readonly viewV2Service: ViewV2Service,
private readonly userRoleService: UserRoleService,
private readonly permissionsService: PermissionsService,
) {}
@ResolveField(() => String)
@@ -102,17 +121,19 @@ export class ViewResolver {
@Query(() => [ViewDTO])
async getCoreViews(
@AuthWorkspace() workspace: WorkspaceEntity,
@AuthUserWorkspaceId() userWorkspaceId: string | undefined,
@Args('objectMetadataId', { type: () => String, nullable: true })
objectMetadataId?: string,
): Promise<ViewDTO[]> {
): Promise<ViewEntity[]> {
if (objectMetadataId) {
return this.viewService.findByObjectMetadataId(
workspace.id,
objectMetadataId,
userWorkspaceId,
);
}
return this.viewService.findByWorkspaceId(workspace.id);
return this.viewService.findByWorkspaceId(workspace.id, userWorkspaceId);
}
@Query(() => ViewDTO, { nullable: true })
@@ -120,14 +141,49 @@ export class ViewResolver {
@Args('id', { type: () => String }) id: string,
@AuthWorkspace() workspace: WorkspaceEntity,
): Promise<ViewDTO | null> {
return this.viewService.findById(id, workspace.id);
const view = await this.viewService.findById(id, workspace.id);
if (!view) {
return null;
}
// Do not apply list visibility filtering here: unlisted views are accessible by link
return view;
}
@Mutation(() => ViewDTO)
@UseGuards(CustomPermissionGuard)
async createCoreView(
@Args('input') input: CreateViewInput,
@AuthWorkspace() workspace: WorkspaceEntity,
@AuthUserWorkspaceId() userWorkspaceId: string | undefined,
): Promise<ViewDTO> {
const visibility = input.visibility ?? ViewVisibility.WORKSPACE;
if (visibility === ViewVisibility.WORKSPACE && isDefined(userWorkspaceId)) {
const permissions =
await this.permissionsService.getUserWorkspacePermissions({
userWorkspaceId,
workspaceId: workspace.id,
});
if (!permissions.permissionFlags[PermissionFlagType.VIEWS]) {
throw new ViewException(
generateViewExceptionMessage(
ViewExceptionMessageKey.VIEW_CREATE_PERMISSION_DENIED,
),
ViewExceptionCode.VIEW_CREATE_PERMISSION_DENIED,
{
userFriendlyMessage: generateViewUserFriendlyExceptionMessage(
ViewExceptionMessageKey.VIEW_CREATE_PERMISSION_DENIED,
),
},
);
}
}
input.visibility = visibility;
const isWorkspaceMigrationV2Enabled =
await this.featureFlagService.isFeatureEnabled(
FeatureFlagKey.IS_WORKSPACE_MIGRATION_V2_ENABLED,
@@ -138,16 +194,21 @@ export class ViewResolver {
return await this.viewV2Service.createOne({
createViewInput: input,
workspaceId: workspace.id,
createdByUserWorkspaceId: userWorkspaceId ?? '',
});
}
return this.viewService.create({
const createdView = await this.viewService.create({
...input,
workspaceId: workspace.id,
createdByUserWorkspaceId: userWorkspaceId ?? '',
});
return createdView;
}
@Mutation(() => ViewDTO)
@UseGuards(UpdateViewPermissionGuard)
async updateCoreView(
@Args('id', { type: () => String }) id: string,
@Args('input') input: UpdateViewInput,
@@ -170,6 +231,7 @@ export class ViewResolver {
}
@Mutation(() => Boolean)
@UseGuards(DeleteViewPermissionGuard)
async deleteCoreView(
@Args('id', { type: () => String }) id: string,
@AuthWorkspace() workspace: WorkspaceEntity,
@@ -195,6 +257,7 @@ export class ViewResolver {
}
@Mutation(() => Boolean)
@UseGuards(DestroyViewPermissionGuard)
async destroyCoreView(
@Args('id', { type: () => String }) id: string,
@AuthWorkspace() workspace: WorkspaceEntity,
packages/twenty-server/src/engine/metadata-modules/view/services/tests/view.service.spec.ts
+116 -11
View File
@@ -7,6 +7,7 @@ import { I18nService } from 'src/engine/core-modules/i18n/i18n.service';
import { ViewEntity } from 'src/engine/metadata-modules/view/entities/view.entity';
import { ViewOpenRecordIn } from 'src/engine/metadata-modules/view/enums/view-open-record-in';
import { ViewType } from 'src/engine/metadata-modules/view/enums/view-type.enum';
import { ViewVisibility } from 'src/engine/metadata-modules/view/enums/view-visibility.enum';
import {
ViewException,
ViewExceptionCode,
@@ -37,6 +38,8 @@ describe('ViewService', () => {
kanbanAggregateOperation: null,
kanbanAggregateOperationFieldMetadataId: null,
anyFieldFilterValue: null,
visibility: ViewVisibility.WORKSPACE,
createdByUserWorkspaceId: null,
createdAt: new Date(),
updatedAt: new Date(),
deletedAt: null,
@@ -84,13 +87,34 @@ describe('ViewService', () => {
});
describe('findByWorkspaceId', () => {
it('should return views for a workspace', async () => {
it('should return workspace views and user-owned unlisted views', async () => {
const workspaceId = 'workspace-id';
const expectedViews = [mockView];
const userWorkspaceId = 'user-workspace-id';
const workspaceView = {
...mockView,
id: 'workspace-view',
visibility: ViewVisibility.WORKSPACE,
} as ViewEntity;
const userUnlistedView = {
...mockView,
id: 'user-unlisted-view',
visibility: ViewVisibility.UNLISTED,
createdByUserWorkspaceId: userWorkspaceId,
} as ViewEntity;
const otherUserUnlistedView = {
...mockView,
id: 'other-user-unlisted-view',
visibility: ViewVisibility.UNLISTED,
createdByUserWorkspaceId: 'other-user-workspace-id',
} as ViewEntity;
const allViews = [workspaceView, userUnlistedView, otherUserUnlistedView];
jest.spyOn(viewRepository, 'find').mockResolvedValue(expectedViews);
jest.spyOn(viewRepository, 'find').mockResolvedValue(allViews);
const result = await viewService.findByWorkspaceId(workspaceId);
const result = await viewService.findByWorkspaceId(
workspaceId,
userWorkspaceId,
);
expect(viewRepository.find).toHaveBeenCalledWith({
where: {
@@ -107,21 +131,67 @@ describe('ViewService', () => {
'viewFilterGroups',
],
});
expect(result).toEqual(expectedViews);
expect(result).toEqual([workspaceView, userUnlistedView]);
expect(result).not.toContain(otherUserUnlistedView);
});
it('should return only workspace views when no userWorkspaceId provided', async () => {
const workspaceId = 'workspace-id';
const workspaceView = {
...mockView,
id: 'workspace-view',
visibility: ViewVisibility.WORKSPACE,
} as ViewEntity;
const unlistedView = {
...mockView,
id: 'unlisted-view',
visibility: ViewVisibility.UNLISTED,
createdByUserWorkspaceId: 'some-user-workspace-id',
} as ViewEntity;
const allViews = [workspaceView, unlistedView];
jest.spyOn(viewRepository, 'find').mockResolvedValue(allViews);
const result = await viewService.findByWorkspaceId(workspaceId);
expect(result).toEqual([workspaceView]);
expect(result).not.toContain(unlistedView);
});
});
describe('findByObjectMetadataId', () => {
it('should return views for an object metadata id', async () => {
it('should return workspace views and user-owned unlisted views for an object', async () => {
const workspaceId = 'workspace-id';
const objectMetadataId = 'object-id';
const expectedViews = [mockView];
const userWorkspaceId = 'user-workspace-id';
const workspaceView = {
...mockView,
id: 'workspace-view',
visibility: ViewVisibility.WORKSPACE,
objectMetadataId,
} as ViewEntity;
const userUnlistedView = {
...mockView,
id: 'user-unlisted-view',
visibility: ViewVisibility.UNLISTED,
createdByUserWorkspaceId: userWorkspaceId,
objectMetadataId,
} as ViewEntity;
const otherUserUnlistedView = {
...mockView,
id: 'other-user-unlisted-view',
visibility: ViewVisibility.UNLISTED,
createdByUserWorkspaceId: 'other-user-workspace-id',
objectMetadataId,
} as ViewEntity;
const allViews = [workspaceView, userUnlistedView, otherUserUnlistedView];
jest.spyOn(viewRepository, 'find').mockResolvedValue(expectedViews);
jest.spyOn(viewRepository, 'find').mockResolvedValue(allViews);
const result = await viewService.findByObjectMetadataId(
workspaceId,
objectMetadataId,
userWorkspaceId,
);
expect(viewRepository.find).toHaveBeenCalledWith({
@@ -140,7 +210,37 @@ describe('ViewService', () => {
'viewFilterGroups',
],
});
expect(result).toEqual(expectedViews);
expect(result).toEqual([workspaceView, userUnlistedView]);
expect(result).not.toContain(otherUserUnlistedView);
});
it('should return only workspace views when no userWorkspaceId provided', async () => {
const workspaceId = 'workspace-id';
const objectMetadataId = 'object-id';
const workspaceView = {
...mockView,
id: 'workspace-view',
visibility: ViewVisibility.WORKSPACE,
objectMetadataId,
} as ViewEntity;
const unlistedView = {
...mockView,
id: 'unlisted-view',
visibility: ViewVisibility.UNLISTED,
createdByUserWorkspaceId: 'some-user-workspace-id',
objectMetadataId,
} as ViewEntity;
const allViews = [workspaceView, unlistedView];
jest.spyOn(viewRepository, 'find').mockResolvedValue(allViews);
const result = await viewService.findByObjectMetadataId(
workspaceId,
objectMetadataId,
);
expect(result).toEqual([workspaceView]);
expect(result).not.toContain(unlistedView);
});
});
@@ -322,12 +422,17 @@ describe('ViewService', () => {
const id = 'view-id';
const workspaceId = 'workspace-id';
jest.spyOn(viewService, 'findById').mockResolvedValue(mockView);
jest
.spyOn(viewService, 'findByIdIncludingDeleted')
.mockResolvedValue(mockView);
jest.spyOn(viewRepository, 'delete').mockResolvedValue({} as any);
const result = await viewService.destroy(id, workspaceId);
expect(viewService.findById).toHaveBeenCalledWith(id, workspaceId);
expect(viewService.findByIdIncludingDeleted).toHaveBeenCalledWith(
id,
workspaceId,
);
expect(viewRepository.delete).toHaveBeenCalledWith(id);
expect(result).toEqual(true);
});
packages/twenty-server/src/engine/metadata-modules/view/services/view-v2.service.ts
+3
View File
@@ -27,9 +27,11 @@ export class ViewV2Service {
async createOne({
createViewInput,
workspaceId,
createdByUserWorkspaceId,
}: {
createViewInput: CreateViewInput;
workspaceId: string;
createdByUserWorkspaceId?: string;
}): Promise<ViewDTO> {
const {
flatObjectMetadataMaps,
@@ -49,6 +51,7 @@ export class ViewV2Service {
const flatViewFromCreateInput = fromCreateViewInputToFlatViewToCreate({
createViewInput,
workspaceId,
createdByUserWorkspaceId,
});
const validateAndBuildResult =
packages/twenty-server/src/engine/metadata-modules/view/services/view.service.ts
+80 -4
View File
@@ -9,6 +9,7 @@ import { I18nService } from 'src/engine/core-modules/i18n/i18n.service';
import { generateMessageId } from 'src/engine/core-modules/i18n/utils/generateMessageId';
import { FIND_ALL_CORE_VIEWS_GRAPHQL_OPERATION } from 'src/engine/metadata-modules/view/constants/find-all-core-views-graphql-operation.constant';
import { ViewEntity } from 'src/engine/metadata-modules/view/entities/view.entity';
import { ViewVisibility } from 'src/engine/metadata-modules/view/enums/view-visibility.enum';
import {
ViewException,
ViewExceptionCode,
@@ -27,8 +28,11 @@ export class ViewService {
private readonly workspaceCacheStorageService: WorkspaceCacheStorageService,
) {}
async findByWorkspaceId(workspaceId: string): Promise<ViewEntity[]> {
return this.viewRepository.find({
async findByWorkspaceId(
workspaceId: string,
userWorkspaceId?: string,
): Promise<ViewEntity[]> {
const views = await this.viewRepository.find({
where: {
workspaceId,
deletedAt: IsNull(),
@@ -43,13 +47,30 @@ export class ViewService {
'viewFilterGroups',
],
});
return views.filter((view) => {
if (view.visibility === ViewVisibility.WORKSPACE) {
return true;
}
if (
view.visibility === ViewVisibility.UNLISTED &&
isDefined(userWorkspaceId) &&
view.createdByUserWorkspaceId === userWorkspaceId
) {
return true;
}
return false;
});
}
async findByObjectMetadataId(
workspaceId: string,
objectMetadataId: string,
userWorkspaceId?: string,
): Promise<ViewEntity[]> {
return this.viewRepository.find({
const views = await this.viewRepository.find({
where: {
workspaceId,
objectMetadataId,
@@ -65,6 +86,23 @@ export class ViewService {
'viewFilterGroups',
],
});
// Apply visibility filtering
return views.filter((view) => {
if (view.visibility === ViewVisibility.WORKSPACE) {
return true;
}
if (
view.visibility === ViewVisibility.UNLISTED &&
isDefined(userWorkspaceId) &&
view.createdByUserWorkspaceId === userWorkspaceId
) {
return true;
}
return false;
});
}
async findById(id: string, workspaceId: string): Promise<ViewEntity | null> {
@@ -87,6 +125,29 @@ export class ViewService {
return view || null;
}
async findByIdIncludingDeleted(
id: string,
workspaceId: string,
): Promise<ViewEntity | null> {
const view = await this.viewRepository.findOne({
where: {
id,
workspaceId,
},
relations: [
'workspace',
'viewFields',
'viewFilters',
'viewSorts',
'viewGroups',
'viewFilterGroups',
],
withDeleted: true,
});
return view || null;
}
async create(viewData: Partial<ViewEntity>): Promise<ViewEntity> {
if (!isDefined(viewData.workspaceId)) {
throw new ViewException(
@@ -176,7 +237,7 @@ export class ViewService {
}
async destroy(id: string, workspaceId: string): Promise<boolean> {
const view = await this.findById(id, workspaceId);
const view = await this.findByIdIncludingDeleted(id, workspaceId);
if (!isDefined(view)) {
throw new ViewException(
@@ -232,6 +293,21 @@ export class ViewService {
return viewName;
}
canUserUpdateView(
view: ViewEntity,
userWorkspaceId: string | undefined,
userHasViewsPermission: boolean,
): boolean {
if (userHasViewsPermission) {
return true;
}
return (
view.visibility === ViewVisibility.UNLISTED &&
view.createdByUserWorkspaceId === userWorkspaceId
);
}
async flushGraphQLCache(workspaceId: string): Promise<void> {
await this.workspaceCacheStorageService.flushGraphQLOperation({
operationName: FIND_ALL_CORE_VIEWS_GRAPHQL_OPERATION,
packages/twenty-server/src/engine/metadata-modules/view/utils/view-graphql-api-exception-handler.util.ts
+19
View File
@@ -2,6 +2,7 @@ import { type I18n } from '@lingui/core';
import { assertUnreachable } from 'twenty-shared/utils';
import {
ForbiddenError,
NotFoundError,
UserInputError,
} from 'src/engine/core-modules/graphql/utils/graphql-errors.util';
@@ -45,6 +46,14 @@ export const viewGraphqlApiExceptionHandler = (error: Error, i18n: I18n) => {
throw new UserInputError(error.message, {
userFriendlyMessage: error.userFriendlyMessage,
});
case ViewExceptionCode.VIEW_CREATE_PERMISSION_DENIED:
throw new ForbiddenError(error.message, {
userFriendlyMessage: error.userFriendlyMessage,
});
case ViewExceptionCode.VIEW_MODIFY_PERMISSION_DENIED:
throw new ForbiddenError(error.message, {
userFriendlyMessage: error.userFriendlyMessage,
});
default: {
return assertUnreachable(error.code);
}
@@ -55,6 +64,8 @@ export const viewGraphqlApiExceptionHandler = (error: Error, i18n: I18n) => {
switch (error.code) {
case ViewFieldExceptionCode.VIEW_FIELD_NOT_FOUND:
throw new NotFoundError(error.message);
case ViewFieldExceptionCode.VIEW_NOT_FOUND:
throw new NotFoundError(error.message);
case ViewFieldExceptionCode.INVALID_VIEW_FIELD_DATA:
throw new UserInputError(error.message, {
userFriendlyMessage: error.userFriendlyMessage,
@@ -69,6 +80,8 @@ export const viewGraphqlApiExceptionHandler = (error: Error, i18n: I18n) => {
switch (error.code) {
case ViewFilterExceptionCode.VIEW_FILTER_NOT_FOUND:
throw new NotFoundError(error.message);
case ViewFilterExceptionCode.VIEW_NOT_FOUND:
throw new NotFoundError(error.message);
case ViewFilterExceptionCode.INVALID_VIEW_FILTER_DATA:
throw new UserInputError(error.message, {
userFriendlyMessage: error.userFriendlyMessage,
@@ -83,6 +96,8 @@ export const viewGraphqlApiExceptionHandler = (error: Error, i18n: I18n) => {
switch (error.code) {
case ViewFilterGroupExceptionCode.VIEW_FILTER_GROUP_NOT_FOUND:
throw new NotFoundError(error.message);
case ViewFilterGroupExceptionCode.VIEW_NOT_FOUND:
throw new NotFoundError(error.message);
case ViewFilterGroupExceptionCode.INVALID_VIEW_FILTER_GROUP_DATA:
throw new UserInputError(error.message, {
userFriendlyMessage: error.userFriendlyMessage,
@@ -97,6 +112,8 @@ export const viewGraphqlApiExceptionHandler = (error: Error, i18n: I18n) => {
switch (error.code) {
case ViewGroupExceptionCode.VIEW_GROUP_NOT_FOUND:
throw new NotFoundError(error.message);
case ViewGroupExceptionCode.VIEW_NOT_FOUND:
throw new NotFoundError(error.message);
case ViewGroupExceptionCode.INVALID_VIEW_GROUP_DATA:
throw new UserInputError(error.message, {
userFriendlyMessage: error.userFriendlyMessage,
@@ -111,6 +128,8 @@ export const viewGraphqlApiExceptionHandler = (error: Error, i18n: I18n) => {
switch (error.code) {
case ViewSortExceptionCode.VIEW_SORT_NOT_FOUND:
throw new NotFoundError(error.message);
case ViewSortExceptionCode.VIEW_NOT_FOUND:
throw new NotFoundError(error.message);
case ViewSortExceptionCode.INVALID_VIEW_SORT_DATA:
throw new UserInputError(error.message, {
userFriendlyMessage: error.userFriendlyMessage,
packages/twenty-server/src/engine/metadata-modules/view/view.module.ts
+6
View File
@@ -5,6 +5,9 @@ import { FeatureFlagModule } from 'src/engine/core-modules/feature-flag/feature-
import { I18nModule } from 'src/engine/core-modules/i18n/i18n.module';
import { WorkspaceManyOrAllFlatEntityMapsCacheModule } from 'src/engine/metadata-modules/flat-entity/services/workspace-many-or-all-flat-entity-maps-cache.module';
import { FlatViewModule } from 'src/engine/metadata-modules/flat-view/flat-view.module';
import { PermissionsModule } from 'src/engine/metadata-modules/permissions/permissions.module';
import { UserRoleModule } from 'src/engine/metadata-modules/user-role/user-role.module';
import { ViewPermissionsModule } from 'src/engine/metadata-modules/view-permissions/view-permissions.module';
import { ViewFieldModule } from 'src/engine/metadata-modules/view-field/view-field.module';
import { ViewFilterGroupModule } from 'src/engine/metadata-modules/view-filter-group/view-filter-group.module';
import { ViewFilterModule } from 'src/engine/metadata-modules/view-filter/view-filter.module';
@@ -22,6 +25,7 @@ import { WorkspaceMigrationV2Module } from 'src/engine/workspace-manager/workspa
@Module({
imports: [
TypeOrmModule.forFeature([ViewEntity]),
ViewPermissionsModule,
ViewFieldModule,
ViewFilterModule,
ViewFilterGroupModule,
@@ -29,6 +33,8 @@ import { WorkspaceMigrationV2Module } from 'src/engine/workspace-manager/workspa
ViewSortModule,
I18nModule,
FeatureFlagModule,
PermissionsModule,
UserRoleModule,
WorkspaceMetadataCacheModule,
WorkspaceCacheStorageModule,
WorkspaceMigrationV2Module,