Skip to content

The open alternative to Salesforce, designed for AI.

Deny settings access to applications without a default role instead of throwing a 500 (#26910)

Thomas Trompette37f5ccd1f926
diff --git a/packages/twenty-server/src/engine/guards/__tests__/settings-permission.guard.spec.ts b/packages/twenty-server/src/engine/guards/__tests__/settings-permission.guard.spec.ts
index 7fa72558c3c..67786a3ac36 100644
--- a/packages/twenty-server/src/engine/guards/__tests__/settings-permission.guard.spec.ts
+++ b/packages/twenty-server/src/engine/guards/__tests__/settings-permission.guard.spec.ts
@@ -1,12 +1,22 @@
import { type ExecutionContext } from '@nestjs/common';
import { GqlExecutionContext } from '@nestjs/graphql';
+import { Test, type TestingModule } from '@nestjs/testing';
import { WorkspaceActivationStatus } from 'twenty-shared/workspace';
import { PermissionFlagType } from 'twenty-shared/constants';
+import { ApiKeyRoleService } from 'src/engine/core-modules/api-key/services/api-key-role.service';
+import { ApplicationEntity } from 'src/engine/core-modules/application/application.entity';
import { SettingsPermissionGuard } from 'src/engine/guards/settings-permission.guard';
-import { PermissionsException } from 'src/engine/metadata-modules/permissions/permissions.exception';
-import { type PermissionsService } from 'src/engine/metadata-modules/permissions/permissions.service';
+import {
+ PermissionsException,
+ PermissionsExceptionCode,
+} from 'src/engine/metadata-modules/permissions/permissions.exception';
+import { PermissionsService } from 'src/engine/metadata-modules/permissions/permissions.service';
+import { RoleEntity } from 'src/engine/metadata-modules/role/role.entity';
+import { UserRoleService } from 'src/engine/metadata-modules/user-role/user-role.service';
+import { getWorkspaceScopedRepositoryToken } from 'src/engine/twenty-orm/workspace-scoped-repository/get-workspace-scoped-repository-token.util';
+import { WorkspaceCacheService } from 'src/engine/workspace-cache/services/workspace-cache.service';
describe('SettingsPermissionGuard', () => {
let guard: any;
@@ -86,4 +96,133 @@ describe('SettingsPermissionGuard', () => {
);
});
});
+
+ describe('canActivate with an application-only token', () => {
+ let mockApplicationRepository: { findOne: jest.Mock };
+ let mockRoleRepository: { findOne: jest.Mock };
+
+ beforeEach(async () => {
+ mockApplicationRepository = { findOne: jest.fn() };
+ mockRoleRepository = { findOne: jest.fn() };
+
+ mockGqlContext.req.userWorkspaceId = undefined;
+ mockGqlContext.req.application = { id: 'application-id' };
+
+ const module: TestingModule = await Test.createTestingModule({
+ providers: [
+ PermissionsService,
+ { provide: UserRoleService, useValue: {} },
+ { provide: WorkspaceCacheService, useValue: {} },
+ { provide: ApiKeyRoleService, useValue: {} },
+ {
+ provide: getWorkspaceScopedRepositoryToken(RoleEntity),
+ useValue: mockRoleRepository,
+ },
+ {
+ provide: getWorkspaceScopedRepositoryToken(ApplicationEntity),
+ useValue: mockApplicationRepository,
+ },
+ ],
+ }).compile();
+
+ const permissionsService = module.get(PermissionsService);
+
+ const GuardClass = SettingsPermissionGuard(PermissionFlagType.LAYOUTS);
+
+ guard = new GuardClass(permissionsService);
+ });
+
+ it('should deny with PERMISSION_DENIED when the application has no default role', async () => {
+ mockApplicationRepository.findOne.mockResolvedValue({
+ id: 'application-id',
+ defaultRoleId: null,
+ });
+
+ await expect(
+ guard.canActivate(mockExecutionContext),
+ ).rejects.toMatchObject({
+ code: PermissionsExceptionCode.PERMISSION_DENIED,
+ });
+ expect(mockApplicationRepository.findOne).toHaveBeenCalledTimes(1);
+ expect(mockApplicationRepository.findOne).toHaveBeenCalledWith(
+ 'workspace-id',
+ { where: { id: 'application-id' } },
+ );
+ expect(mockRoleRepository.findOne).not.toHaveBeenCalled();
+ });
+
+ it('should allow when the default role of the application grants the setting', async () => {
+ mockApplicationRepository.findOne.mockResolvedValue({
+ id: 'application-id',
+ defaultRoleId: 'role-id',
+ });
+ mockRoleRepository.findOne.mockResolvedValue({
+ id: 'role-id',
+ canUpdateAllSettings: true,
+ rolePermissionFlags: [],
+ });
+
+ await expect(guard.canActivate(mockExecutionContext)).resolves.toBe(true);
+ expect(mockApplicationRepository.findOne).toHaveBeenCalledTimes(1);
+ expect(mockApplicationRepository.findOne).toHaveBeenCalledWith(
+ 'workspace-id',
+ { where: { id: 'application-id' } },
+ );
+ expect(mockRoleRepository.findOne).toHaveBeenCalledTimes(1);
+ expect(mockRoleRepository.findOne).toHaveBeenCalledWith('workspace-id', {
+ where: { id: 'role-id' },
+ relations: [
+ 'rolePermissionFlags',
+ 'rolePermissionFlags.permissionFlag',
+ ],
+ });
+ });
+
+ it('should deny with PERMISSION_DENIED when the default role of the application lacks the setting', async () => {
+ mockApplicationRepository.findOne.mockResolvedValue({
+ id: 'application-id',
+ defaultRoleId: 'role-id',
+ });
+ mockRoleRepository.findOne.mockResolvedValue({
+ id: 'role-id',
+ canUpdateAllSettings: false,
+ rolePermissionFlags: [],
+ });
+
+ await expect(
+ guard.canActivate(mockExecutionContext),
+ ).rejects.toMatchObject({
+ code: PermissionsExceptionCode.PERMISSION_DENIED,
+ });
+ expect(mockApplicationRepository.findOne).toHaveBeenCalledTimes(1);
+ expect(mockApplicationRepository.findOne).toHaveBeenCalledWith(
+ 'workspace-id',
+ { where: { id: 'application-id' } },
+ );
+ expect(mockRoleRepository.findOne).toHaveBeenCalledTimes(1);
+ expect(mockRoleRepository.findOne).toHaveBeenCalledWith('workspace-id', {
+ where: { id: 'role-id' },
+ relations: [
+ 'rolePermissionFlags',
+ 'rolePermissionFlags.permissionFlag',
+ ],
+ });
+ });
+
+ it('should reject with NO_AUTHENTICATION_CONTEXT when the application does not exist', async () => {
+ mockApplicationRepository.findOne.mockResolvedValue(null);
+
+ await expect(
+ guard.canActivate(mockExecutionContext),
+ ).rejects.toMatchObject({
+ code: PermissionsExceptionCode.NO_AUTHENTICATION_CONTEXT,
+ });
+ expect(mockApplicationRepository.findOne).toHaveBeenCalledTimes(1);
+ expect(mockApplicationRepository.findOne).toHaveBeenCalledWith(
+ 'workspace-id',
+ { where: { id: 'application-id' } },
+ );
+ expect(mockRoleRepository.findOne).not.toHaveBeenCalled();
+ });
+ });
});
diff --git a/packages/twenty-server/src/engine/metadata-modules/permissions/permissions.service.ts b/packages/twenty-server/src/engine/metadata-modules/permissions/permissions.service.ts
index c20979c0aa5..e3edbeb5fda 100644
--- a/packages/twenty-server/src/engine/metadata-modules/permissions/permissions.service.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/permissions/permissions.service.ts
@@ -231,13 +231,17 @@ export class PermissionsService {
},
);
- if (!isDefined(application) || !isDefined(application.defaultRoleId)) {
- throw new ApplicationException(
- `Could not find application ${applicationId}`,
- ApplicationExceptionCode.APPLICATION_NOT_FOUND,
+ if (!isDefined(application)) {
+ throw new PermissionsException(
+ PermissionsExceptionMessage.NO_AUTHENTICATION_CONTEXT,
+ PermissionsExceptionCode.NO_AUTHENTICATION_CONTEXT,
);
}
+ if (!isDefined(application.defaultRoleId)) {
+ return false;
+ }
+
const applicationRoleId = application.defaultRoleId;
const role = await this.roleRepository.findOne(workspaceId, {