Skip to content

The open alternative to Salesforce, designed for AI.

Derive permission principals straight from the auth context (#29514)

Charles Bochet140dae383ae4
diff --git a/packages/twenty-server/src/engine/api/common/common-select-fields/common-select-fields-builder.ts b/packages/twenty-server/src/engine/api/common/common-select-fields/common-select-fields-builder.ts
index d0f1d4e7635..b244db03b2c 100644
--- a/packages/twenty-server/src/engine/api/common/common-select-fields/common-select-fields-builder.ts
+++ b/packages/twenty-server/src/engine/api/common/common-select-fields/common-select-fields-builder.ts
@@ -18,7 +18,7 @@ import { findManyFlatEntityByIdInFlatEntityMapsOrThrow } from 'src/engine/metada
import { type OrmFlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/orm-flat-field-metadata.type';
import { type FlatObjectMetadata } from 'src/engine/metadata-modules/flat-object-metadata/types/flat-object-metadata.type';
import { RecordAccessPolicyService } from 'src/engine/permissions/combine/services/record-access-policy.service';
-import { type PermissionsPrincipalsContext } from 'src/engine/permissions/principal/types/permissions-principals-context.type';
+import { type PermissionsAuthContext } from 'src/engine/permissions/principal/types/permissions-auth-context.type';
@Injectable()
export class CommonSelectFieldsBuilder {
@@ -28,20 +28,21 @@ export class CommonSelectFieldsBuilder {
// Relations to objects the ORM would refuse are left out, so they cannot fail the whole query
async findReadableObjectMetadataIds({
- principals,
+ authContext,
flatObjectMetadataMaps,
}: {
- principals: PermissionsPrincipalsContext;
+ authContext: PermissionsAuthContext;
flatObjectMetadataMaps: FlatEntityMaps<FlatObjectMetadata>;
}): Promise<Set<string>> {
const flatObjectMetadatas = Object.values(
flatObjectMetadataMaps.byUniversalIdentifier,
).filter(isDefined);
+ const recordAccessPolicy =
+ this.recordAccessPolicyService.forAuthContext(authContext);
const readableFlags = await Promise.all(
flatObjectMetadatas.map((flatObjectMetadata) =>
- this.recordAccessPolicyService.hasAccessToSomeRecords({
- principals,
+ recordAccessPolicy.hasAccessToSomeRecords({
flatObjectMetadata,
operationType: 'select',
}),
diff --git a/packages/twenty-server/src/engine/api/rest/core/handlers/rest-api-base.handler.ts b/packages/twenty-server/src/engine/api/rest/core/handlers/rest-api-base.handler.ts
index acbe74d950b..4c420e15d15 100644
--- a/packages/twenty-server/src/engine/api/rest/core/handlers/rest-api-base.handler.ts
+++ b/packages/twenty-server/src/engine/api/rest/core/handlers/rest-api-base.handler.ts
@@ -27,15 +27,9 @@ import { type OrmFlatFieldMetadata } from 'src/engine/metadata-modules/flat-fiel
import { type FlatIndexMetadata } from 'src/engine/metadata-modules/flat-index-metadata/types/flat-index-metadata.type';
import { type FlatObjectMetadata } from 'src/engine/metadata-modules/flat-object-metadata/types/flat-object-metadata.type';
import { buildObjectIdByNameMaps } from 'src/engine/metadata-modules/flat-object-metadata/utils/build-object-id-by-name-maps.util';
-import {
- PermissionsException,
- PermissionsExceptionCode,
- PermissionsExceptionMessage,
-} from 'src/engine/permissions/permissions.exception';
import { WorkspaceCacheStorageService } from 'src/engine/workspace-cache-storage/workspace-cache-storage.service';
import { WorkspaceCacheService } from 'src/engine/workspace-cache/services/workspace-cache.service';
import { RecordAccessPolicyService } from 'src/engine/permissions/combine/services/record-access-policy.service';
-import { getPermissionsPrincipalsFromAuthContext } from 'src/engine/permissions/principal/utils/get-permissions-principals-from-auth-context.util';
export interface PageInfo {
hasNextPage?: boolean;
@@ -78,25 +72,6 @@ export abstract class RestApiBaseHandler {
FormatResult | { data: FormatResult[] } | CommonGroupByOutputItem[]
>;
- private getPermissionsContext = async (authContext: WorkspaceAuthContext) => {
- const principals = getPermissionsPrincipalsFromAuthContext(authContext);
-
- if (!isDefined(principals)) {
- throw new PermissionsException(
- PermissionsExceptionMessage.PERMISSION_DENIED,
- PermissionsExceptionCode.PERMISSION_DENIED,
- );
- }
-
- return {
- principals,
- objectsPermissions:
- await this.recordAccessPolicyService.getObjectsPermissionsOrThrow(
- principals,
- ),
- };
- };
-
async computeSelectedFields({
authContext,
depth,
@@ -110,14 +85,16 @@ export abstract class RestApiBaseHandler {
flatObjectMetadataMaps: FlatEntityMaps<FlatObjectMetadata>;
flatFieldMetadataMaps: FlatEntityMaps<OrmFlatFieldMetadata>;
}): Promise<CommonSelectedFields> {
- const { principals, objectsPermissions } =
- await this.getPermissionsContext(authContext);
+ const objectsPermissions =
+ await this.recordAccessPolicyService.getObjectsPermissionsOrThrow(
+ authContext,
+ );
const { selectedFields } = this.commonSelectFieldsBuilder.buildFromDepth({
objectsPermissions,
readableObjectMetadataIds:
await this.findRelationReadableObjectMetadataIds({
- principals,
+ authContext,
flatObjectMetadataMaps,
depth,
}),
@@ -147,14 +124,16 @@ export abstract class RestApiBaseHandler {
}): Promise<{
selectedFields: CommonSelectedFields;
}> {
- const { principals, objectsPermissions } =
- await this.getPermissionsContext(authContext);
+ const objectsPermissions =
+ await this.recordAccessPolicyService.getObjectsPermissionsOrThrow(
+ authContext,
+ );
return this.commonSelectFieldsBuilder.buildFromDepth({
objectsPermissions,
readableObjectMetadataIds:
await this.findRelationReadableObjectMetadataIds({
- principals,
+ authContext,
flatObjectMetadataMaps,
depth,
}),
@@ -168,7 +147,7 @@ export abstract class RestApiBaseHandler {
}
private async findRelationReadableObjectMetadataIds({
- principals,
+ authContext,
flatObjectMetadataMaps,
depth,
}: Parameters<
@@ -181,7 +160,7 @@ export abstract class RestApiBaseHandler {
}
return this.commonSelectFieldsBuilder.findReadableObjectMetadataIds({
- principals,
+ authContext,
flatObjectMetadataMaps,
});
}
diff --git a/packages/twenty-server/src/engine/core-modules/logic-function/logic-function-trigger/triggers/database-event/call-database-event-trigger-jobs.job.ts b/packages/twenty-server/src/engine/core-modules/logic-function/logic-function-trigger/triggers/database-event/call-database-event-trigger-jobs.job.ts
index 586ef5c3709..8ad6e20cc06 100644
--- a/packages/twenty-server/src/engine/core-modules/logic-function/logic-function-trigger/triggers/database-event/call-database-event-trigger-jobs.job.ts
+++ b/packages/twenty-server/src/engine/core-modules/logic-function/logic-function-trigger/triggers/database-event/call-database-event-trigger-jobs.job.ts
@@ -101,8 +101,7 @@ export class CallDatabaseEventTriggerJobsJob {
}
const admittedEvents = await resolveEventsReadableByRole({
- applicationId,
- roleId: application.defaultRoleId,
+ application,
workspaceEventBatch,
eventRecordAccessGate,
metadataMaps,
diff --git a/packages/twenty-server/src/engine/core-modules/record-crud/services/common-api-context-builder.service.ts b/packages/twenty-server/src/engine/core-modules/record-crud/services/common-api-context-builder.service.ts
index f85648fddc5..6a6ee7fade3 100644
--- a/packages/twenty-server/src/engine/core-modules/record-crud/services/common-api-context-builder.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/record-crud/services/common-api-context-builder.service.ts
@@ -18,14 +18,7 @@ import { findFlatEntityByIdInFlatEntityMaps } from 'src/engine/metadata-modules/
import { type FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata.type';
import { type FlatObjectMetadata } from 'src/engine/metadata-modules/flat-object-metadata/types/flat-object-metadata.type';
import { buildObjectIdByNameMaps } from 'src/engine/metadata-modules/flat-object-metadata/utils/build-object-id-by-name-maps.util';
-import { type PermissionsPrincipalsContext } from 'src/engine/permissions/principal/types/permissions-principals-context.type';
-import { getPermissionsPrincipalsFromAuthContext } from 'src/engine/permissions/principal/utils/get-permissions-principals-from-auth-context.util';
import { RecordAccessPolicyService } from 'src/engine/permissions/combine/services/record-access-policy.service';
-import {
- PermissionsException,
- PermissionsExceptionCode,
- PermissionsExceptionMessage,
-} from 'src/engine/permissions/permissions.exception';
export type CommonApiContext = {
queryRunnerContext: CommonBaseQueryRunnerContext;
@@ -34,7 +27,6 @@ export type CommonApiContext = {
flatObjectMetadataMaps: FlatEntityMaps<FlatObjectMetadata>;
flatFieldMetadataMaps: FlatEntityMaps<FlatFieldMetadata>;
objectsPermissions: ObjectsPermissions;
- principals: PermissionsPrincipalsContext;
};
@Injectable()
@@ -96,8 +88,10 @@ export class CommonApiContextBuilderService {
);
}
- const { objectsPermissions, principals } =
- await this.getPermissionsContext(authContext);
+ const objectsPermissions =
+ await this.recordAccessPolicyService.getObjectsPermissionsOrThrow(
+ authContext,
+ );
const restrictedFields =
objectsPermissions[flatObjectMetadata.id]?.restrictedFields ?? {};
@@ -125,31 +119,6 @@ export class CommonApiContextBuilderService {
flatObjectMetadataMaps,
flatFieldMetadataMaps,
objectsPermissions,
- principals,
- };
- }
-
- private async getPermissionsContext(
- authContext: WorkspaceAuthContext,
- ): Promise<{
- objectsPermissions: ObjectsPermissions;
- principals: PermissionsPrincipalsContext;
- }> {
- const principals = getPermissionsPrincipalsFromAuthContext(authContext);
-
- if (!isDefined(principals)) {
- throw new PermissionsException(
- PermissionsExceptionMessage.PERMISSION_DENIED,
- PermissionsExceptionCode.PERMISSION_DENIED,
- );
- }
-
- return {
- objectsPermissions:
- await this.recordAccessPolicyService.getObjectsPermissionsOrThrow(
- principals,
- ),
- principals,
};
}
}
diff --git a/packages/twenty-server/src/engine/core-modules/record-crud/services/find-records.service.ts b/packages/twenty-server/src/engine/core-modules/record-crud/services/find-records.service.ts
index bcc7a47061f..a39c0a95833 100644
--- a/packages/twenty-server/src/engine/core-modules/record-crud/services/find-records.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/record-crud/services/find-records.service.ts
@@ -59,7 +59,6 @@ export class FindRecordsService {
flatObjectMetadataMaps,
flatFieldMetadataMaps,
objectsPermissions,
- principals,
} = await this.commonApiContextBuilder.build({
authContext,
objectName,
@@ -88,7 +87,7 @@ export class FindRecordsService {
objectsPermissions,
readableObjectMetadataIds:
await this.commonSelectFieldsBuilder.findReadableObjectMetadataIds(
- { principals, flatObjectMetadataMaps },
+ { authContext, flatObjectMetadataMaps },
),
depth: 1,
onlyUseLabelIdentifierFieldsInRelations: true,
diff --git a/packages/twenty-server/src/engine/core-modules/tool-provider/providers/__tests__/database-tool.provider.spec.ts b/packages/twenty-server/src/engine/core-modules/tool-provider/providers/__tests__/database-tool.provider.spec.ts
index 305650f28e1..df8bc0a0192 100644
--- a/packages/twenty-server/src/engine/core-modules/tool-provider/providers/__tests__/database-tool.provider.spec.ts
+++ b/packages/twenty-server/src/engine/core-modules/tool-provider/providers/__tests__/database-tool.provider.spec.ts
@@ -121,7 +121,7 @@ describe('DatabaseToolProvider', () => {
...allObjectPermissions,
...options?.composedObjectPermissions,
};
- const recordAccessPolicyService = {
+ const scopedRecordAccessPolicy = {
findObjectsPermissions: jest
.fn()
.mockResolvedValue(composedObjectPermissionsByObjectId),
@@ -136,6 +136,9 @@ describe('DatabaseToolProvider', () => {
);
},
),
+ };
+ const recordAccessPolicyService = {
+ forAuthContext: jest.fn(() => scopedRecordAccessPolicy),
} as unknown as RecordAccessPolicyService;
const provider = new DatabaseToolProvider(
diff --git a/packages/twenty-server/src/engine/core-modules/tool-provider/providers/database-tool.provider.ts b/packages/twenty-server/src/engine/core-modules/tool-provider/providers/database-tool.provider.ts
index 8ed0a260463..4860aa32746 100644
--- a/packages/twenty-server/src/engine/core-modules/tool-provider/providers/database-tool.provider.ts
+++ b/packages/twenty-server/src/engine/core-modules/tool-provider/providers/database-tool.provider.ts
@@ -36,7 +36,6 @@ import { buildExplicitObjectPermissionByObjectId } from 'src/engine/core-modules
import { getDatabaseCrudToolFlatObjects } from 'src/engine/metadata-modules/ai/ai-agent/utils/get-database-crud-tool-flat-objects.util';
import { WorkspaceManyOrAllFlatEntityMapsCacheService } from 'src/engine/metadata-modules/flat-entity/services/workspace-many-or-all-flat-entity-maps-cache.service';
import { RecordAccessPolicyService } from 'src/engine/permissions/combine/services/record-access-policy.service';
-import { getPermissionsPrincipalsFromAuthContext } from 'src/engine/permissions/principal/utils/get-permissions-principals-from-auth-context.util';
import { type OperationType } from 'src/engine/permissions/role/utils/validate-operation-is-permitted-or-throw.util';
import { RECORDS_TOOL_WIDGET_NAME, ToolCategory } from 'twenty-shared/ai';
import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
@@ -85,15 +84,14 @@ export class DatabaseToolProvider implements ToolProvider {
},
);
- const principals = isDefined(context.authContext)
- ? getPermissionsPrincipalsFromAuthContext(context.authContext)
- : undefined;
- const objectPermissions = isDefined(principals)
- ? await this.recordAccessPolicyService.findObjectsPermissions(principals)
+ const recordAccessPolicy = isDefined(context.authContext)
+ ? this.recordAccessPolicyService.forAuthContext(context.authContext)
: undefined;
+ const objectPermissions =
+ await recordAccessPolicy?.findObjectsPermissions();
if (
- !isDefined(principals) ||
+ !isDefined(recordAccessPolicy) ||
!isDefined(objectPermissions) ||
Object.keys(objectPermissions).length === 0
) {
@@ -149,8 +147,7 @@ export class DatabaseToolProvider implements ToolProvider {
!requireExplicitObjectGrants ||
(explicitPermission?.[objectPermission] ?? false);
const hasAccessToSomeRecords = async (operationType: OperationType) =>
- this.recordAccessPolicyService.hasAccessToSomeRecords({
- principals,
+ recordAccessPolicy.hasAccessToSomeRecords({
flatObjectMetadata: flatObject,
operationType,
});
diff --git a/packages/twenty-server/src/engine/metadata-modules/ai/ai-agent-trigger/jobs/call-agent-database-event-triggers.job.ts b/packages/twenty-server/src/engine/metadata-modules/ai/ai-agent-trigger/jobs/call-agent-database-event-triggers.job.ts
index c3dd9fc3ced..412cd4e019e 100644
--- a/packages/twenty-server/src/engine/metadata-modules/ai/ai-agent-trigger/jobs/call-agent-database-event-triggers.job.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/ai/ai-agent-trigger/jobs/call-agent-database-event-triggers.job.ts
@@ -10,6 +10,7 @@ import { Process } from 'src/engine/core-modules/message-queue/decorators/proces
import { Processor } from 'src/engine/core-modules/message-queue/decorators/processor.decorator';
import { MessageQueue } from 'src/engine/core-modules/message-queue/message-queue.constants';
import { MessageQueueService } from 'src/engine/core-modules/message-queue/services/message-queue.service';
+import { type PermissionsAuthContext } from 'src/engine/permissions/principal/types/permissions-auth-context.type';
import { RecordAccessPolicyService } from 'src/engine/permissions/combine/services/record-access-policy.service';
import { isUpdateOfHiddenFieldsOnly } from 'src/engine/permissions/masking/utils/is-update-of-hidden-fields-only.util';
import { omitRestrictedFieldsFromEvent } from 'src/engine/permissions/masking/utils/omit-restricted-fields-from-event.util';
@@ -45,14 +46,14 @@ export class CallAgentDatabaseEventTriggersJob {
const {
flatAgentMaps,
+ flatApplicationMaps,
flatRoleTargetByAgentIdMaps,
- rolesPermissions,
flatFieldMetadataMaps,
flatObjectMetadataMaps,
} = await this.workspaceCacheService.getOrRecompute(workspaceId, [
'flatAgentMaps',
+ 'flatApplicationMaps',
'flatRoleTargetByAgentIdMaps',
- 'rolesPermissions',
'flatFieldMetadataMaps',
'flatObjectMetadataMaps',
]);
@@ -72,22 +73,29 @@ export class CallAgentDatabaseEventTriggersJob {
);
for (const { flatAgent, trigger } of matchingAgentTriggers) {
- const agentRoleId = flatRoleTargetByAgentIdMaps[flatAgent.id]?.roleId;
- const agentObjectsPermissions = isDefined(agentRoleId)
- ? rolesPermissions[agentRoleId]
- : undefined;
+ const application = flatApplicationMaps.byId[flatAgent.applicationId];
- // An agent receives what its role lets it read: without a role it reads nothing
- if (!isDefined(agentRoleId) || !isDefined(agentObjectsPermissions)) {
+ if (!isDefined(application) || isDefined(application.deletedAt)) {
+ continue;
+ }
+
+ const agentAuthContext: PermissionsAuthContext = {
+ type: 'application',
+ workspace: { id: workspaceId },
+ application,
+ agentId: flatAgent.id,
+ };
+ const agentObjectsPermissions =
+ await this.recordAccessPolicyService.findObjectsPermissions(
+ agentAuthContext,
+ );
+
+ if (!isDefined(agentObjectsPermissions)) {
continue;
}
const admittedRecordIds =
- await eventRecordAccessGate.resolveAdmittedRecordIds({
- workspaceId: workspaceEventBatch.workspaceId,
- mainPrincipal: { type: 'agent', agentId: flatAgent.id },
- applicationPrincipal: { type: 'customApplication' },
- });
+ await eventRecordAccessGate.resolveAdmittedRecordIds(agentAuthContext);
const admittedEvents = workspaceEventBatch.events
.filter((event) => admittedRecordIds.has(event.recordId))
.filter(
@@ -150,7 +158,7 @@ export class CallAgentDatabaseEventTriggersJob {
workspaceId,
agentId: flatAgent.id,
triggerId: trigger.id,
- dispatchedRoleId: agentRoleId,
+ dispatchedRoleId: flatRoleTargetByAgentIdMaps[flatAgent.id]?.roleId,
payload: {
type: 'DATABASE_EVENT',
eventName,
diff --git a/packages/twenty-server/src/engine/metadata-modules/ai/ai-chat/services/agent-chat-sharing.service.ts b/packages/twenty-server/src/engine/metadata-modules/ai/ai-chat/services/agent-chat-sharing.service.ts
index 623e1eb79e1..1805e8fcd7f 100644
--- a/packages/twenty-server/src/engine/metadata-modules/ai/ai-chat/services/agent-chat-sharing.service.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/ai/ai-chat/services/agent-chat-sharing.service.ts
@@ -327,13 +327,10 @@ export class AgentChatSharingService {
const grants = await Promise.all(
AGENT_CHAT_REPLY_OPERATION_TYPES.map((operationType) =>
this.recordAccessPolicyService.hasAccessToRecords({
- principals: {
- workspaceId,
- mainPrincipal: {
- type: 'workspaceMember',
- workspaceMemberId: memberId,
- },
- applicationPrincipal: { type: 'customApplication' },
+ authContext: {
+ type: 'user',
+ workspace: { id: workspaceId },
+ workspaceMemberId: memberId,
},
flatObjectMetadata: threadFlatObjectMetadata,
recordIds: [threadId],
diff --git a/packages/twenty-server/src/engine/metadata-modules/webhook/jobs/call-webhook-jobs.job.ts b/packages/twenty-server/src/engine/metadata-modules/webhook/jobs/call-webhook-jobs.job.ts
index 4ca8fa70641..ab959fb6708 100644
--- a/packages/twenty-server/src/engine/metadata-modules/webhook/jobs/call-webhook-jobs.job.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/webhook/jobs/call-webhook-jobs.job.ts
@@ -94,9 +94,9 @@ export class CallWebhookJobsJob {
const admittedRecordIds =
admittedRecordIdsByRoleId.get(webhookRoleId) ??
eventRecordAccessGate.resolveAdmittedRecordIds({
- workspaceId: workspaceEventBatch.workspaceId,
- mainPrincipal: { type: 'webhook', webhookId: webhook.id },
- applicationPrincipal: { type: 'customApplication' },
+ type: 'webhook',
+ workspace: { id: workspaceEventBatch.workspaceId },
+ webhook,
});
admittedRecordIdsByRoleId.set(webhookRoleId, admittedRecordIds);
diff --git a/packages/twenty-server/src/engine/permissions/combine/services/record-access-policy.service.ts b/packages/twenty-server/src/engine/permissions/combine/services/record-access-policy.service.ts
index 696cfb9ab82..903b6377cd7 100644
--- a/packages/twenty-server/src/engine/permissions/combine/services/record-access-policy.service.ts
+++ b/packages/twenty-server/src/engine/permissions/combine/services/record-access-policy.service.ts
@@ -10,11 +10,13 @@ import {
} from 'twenty-shared/types';
import { isDefined } from 'twenty-shared/utils';
+import { type PermissionsAuthContext } from 'src/engine/permissions/principal/types/permissions-auth-context.type';
import {
PermissionsException,
PermissionsExceptionCode,
PermissionsExceptionMessage,
} from 'src/engine/permissions/permissions.exception';
+import { PermissionsService } from 'src/engine/permissions/permissions.service';
import { getPermissionsPrincipalObjectsPermissions } from 'src/engine/permissions/role/utils/get-permissions-principal-objects-permissions.util';
import { PrivateRecordStorageService } from 'src/engine/permissions/private-record/services/private-record-storage.service';
import { type PrivateRecordState } from 'src/engine/permissions/private-record/types/private-record-state.type';
@@ -24,9 +26,7 @@ import {
type PermissionsMetadataMaps,
type PermissionsObjectAccessRequest,
} from 'src/engine/permissions/combine/types/row-access-policy.type';
-import { type PermissionsPrincipalsContext } from 'src/engine/permissions/principal/types/permissions-principals-context.type';
import { type PermissionsPrincipalsWithRolesContext } from 'src/engine/permissions/principal/types/permissions-principals-with-roles-context.type';
-import { resolvePermissionsPrincipalsWithRoles } from 'src/engine/permissions/principal/utils/resolve-permissions-principals-with-roles.util';
import { getPermissionsPrincipalShareKeys } from 'src/engine/permissions/principal/utils/get-permissions-principal-share-keys.util';
import { resolvePermissionsShareGrant } from 'src/engine/permissions/record-share/utils/resolve-permissions-share-grant.util';
import { isObjectOperationDeniedToPrincipal } from 'src/engine/permissions/role/utils/is-object-operation-denied-to-principal.util';
@@ -43,20 +43,33 @@ import { resolveEventRecordSnapshots } from 'src/engine/permissions/combine/util
import { WorkspaceCacheService } from 'src/engine/workspace-cache/services/workspace-cache.service';
import { type WorkspaceEventBatch } from 'src/engine/workspace-event-emitter/types/workspace-event-batch.type';
-type PrincipalsAccessRequest = Omit<
+type ObjectAccessRequest = Omit<
PermissionsObjectAccessRequest,
'principal' | 'metadataMaps'
-> & { principals: PermissionsPrincipalsContext };
+>;
-const EMPTY_WORKSPACE_MEMBER_MAPS = { byId: {}, userWorkspaceIdByUserId: {} };
+type AuthContextAccessRequest = ObjectAccessRequest & {
+ authContext: PermissionsAuthContext;
+};
+
+type RecordsAccessRequest = ObjectAccessRequest & {
+ recordIds: string[];
+ hypotheticalRecordShareAccessLevel?: RecordShareAccessLevel;
+ transactionScope?: WorkspaceTransactionScope;
+};
+
+type PrincipalWithRoles = Promise<
+ PermissionsPrincipalsWithRolesContext | undefined
+>;
+
+export type ScopedRecordAccessPolicy = {
+ hasAccessToSomeRecords: (request: ObjectAccessRequest) => Promise<boolean>;
+ hasAccessToRecords: (request: RecordsAccessRequest) => Promise<boolean>;
+ findObjectsPermissions: () => Promise<ObjectsPermissions | undefined>;
+};
@Injectable()
export class RecordAccessPolicyService {
- private readonly principalsWithRolesByPrincipals = new WeakMap<
- PermissionsPrincipalsContext,
- Promise<PermissionsPrincipalsWithRolesContext | undefined>
- >();
-
private readonly metadataMapsByPrincipal = new WeakMap<
PermissionsPrincipalsWithRolesContext,
Promise<PermissionsMetadataMaps>
@@ -72,15 +85,53 @@ export class RecordAccessPolicyService {
private readonly recordShareStorageService: RecordShareStorageService,
private readonly privateRecordStorageService: PrivateRecordStorageService,
private readonly workspaceOrmManager: WorkspaceOrmManager,
+ private readonly permissionsService: PermissionsService,
) {}
- // Shares only count once a row exists, so an object reached by nothing stays out of reach
+ forAuthContext(
+ authContext: PermissionsAuthContext,
+ ): ScopedRecordAccessPolicy {
+ const principal = this.resolvePrincipalsWithRoles(authContext);
+
+ return {
+ hasAccessToSomeRecords: (request) =>
+ this.hasPrincipalAccessToSomeRecords({ ...request, principal }),
+ hasAccessToRecords: (request) =>
+ this.hasPrincipalAccessToRecords({ ...request, principal }),
+ findObjectsPermissions: () =>
+ this.findPrincipalObjectsPermissions(principal),
+ };
+ }
+
async hasAccessToSomeRecords({
- principals,
+ authContext,
+ ...request
+ }: AuthContextAccessRequest): Promise<boolean> {
+ return this.hasPrincipalAccessToSomeRecords({
+ ...request,
+ principal: this.resolvePrincipalsWithRoles(authContext),
+ });
+ }
+
+ async hasAccessToRecords({
+ authContext,
+ ...request
+ }: AuthContextAccessRequest & RecordsAccessRequest): Promise<boolean> {
+ return this.hasPrincipalAccessToRecords({
+ ...request,
+ principal: this.resolvePrincipalsWithRoles(authContext),
+ });
+ }
+
+ // Shares only count once a row exists, so an object reached by nothing stays out of reach
+ private async hasPrincipalAccessToSomeRecords({
+ principal: principalWithRoles,
flatObjectMetadata,
operationType,
- }: PrincipalsAccessRequest): Promise<boolean> {
- const principal = await this.findPrincipalsWithRoles(principals);
+ }: Pick<ObjectAccessRequest, 'flatObjectMetadata' | 'operationType'> & {
+ principal: PrincipalWithRoles;
+ }): Promise<boolean> {
+ const principal = await principalWithRoles;
if (!isDefined(principal)) {
return false;
@@ -120,22 +171,20 @@ export class RecordAccessPolicyService {
);
}
- async hasAccessToRecords({
- principals,
+ private async hasPrincipalAccessToRecords({
+ principal: principalWithRoles,
flatObjectMetadata,
operationType,
recordIds,
hypotheticalRecordShareAccessLevel,
transactionScope,
- }: PrincipalsAccessRequest & {
- recordIds: string[];
- hypotheticalRecordShareAccessLevel?: RecordShareAccessLevel;
- transactionScope?: WorkspaceTransactionScope;
+ }: RecordsAccessRequest & {
+ principal: PrincipalWithRoles;
}): Promise<boolean> {
const uniqueRecordIds = [
...new Set(recordIds.map((recordId) => recordId.toLowerCase())),
];
- const principal = await this.findPrincipalsWithRoles(principals);
+ const principal = await principalWithRoles;
if (uniqueRecordIds.length === 0 || !isDefined(principal)) {
return false;
@@ -159,9 +208,9 @@ export class RecordAccessPolicyService {
}
async getObjectsPermissionsOrThrow(
- principals: PermissionsPrincipalsContext,
+ authContext: PermissionsAuthContext,
): Promise<ObjectsPermissions> {
- const objectsPermissions = await this.findObjectsPermissions(principals);
+ const objectsPermissions = await this.findObjectsPermissions(authContext);
if (!isDefined(objectsPermissions)) {
throw new PermissionsException(
@@ -173,11 +222,18 @@ export class RecordAccessPolicyService {
return objectsPermissions;
}
- // undefined when the principals hold no role
async findObjectsPermissions(
- principals: PermissionsPrincipalsContext,
+ authContext: PermissionsAuthContext,
+ ): Promise<ObjectsPermissions | undefined> {
+ return this.findPrincipalObjectsPermissions(
+ this.resolvePrincipalsWithRoles(authContext),
+ );
+ }
+
+ private async findPrincipalObjectsPermissions(
+ principalWithRoles: PrincipalWithRoles,
): Promise<ObjectsPermissions | undefined> {
- const principal = await this.findPrincipalsWithRoles(principals);
+ const principal = await principalWithRoles;
if (!isDefined(principal)) {
return undefined;
@@ -314,8 +370,8 @@ export class RecordAccessPolicyService {
let metadataMaps: Promise<PermissionsMetadataMaps> | undefined;
return {
- resolveAdmittedRecordIds: async (principals) => {
- const principal = await this.findPrincipalsWithRoles(principals);
+ resolveAdmittedRecordIds: async (authContext) => {
+ const principal = await this.resolvePrincipalsWithRoles(authContext);
if (!isDefined(principal)) {
return new Set<string>();
@@ -368,62 +424,10 @@ export class RecordAccessPolicyService {
);
}
- private findPrincipalsWithRoles(
- principals: PermissionsPrincipalsContext,
+ private resolvePrincipalsWithRoles(
+ authContext: PermissionsAuthContext,
): Promise<PermissionsPrincipalsWithRolesContext | undefined> {
- const cachedPrincipalsWithRoles =
- this.principalsWithRolesByPrincipals.get(principals);
-
- if (isDefined(cachedPrincipalsWithRoles)) {
- return cachedPrincipalsWithRoles;
- }
-
- const principalsWithRoles = this.resolvePrincipalsWithRoles(principals);
-
- this.principalsWithRolesByPrincipals.set(principals, principalsWithRoles);
-
- return principalsWithRoles;
- }
-
- private async resolvePrincipalsWithRoles(
- principals: PermissionsPrincipalsContext,
- ): Promise<PermissionsPrincipalsWithRolesContext | undefined> {
- const { mainPrincipal, workspaceId } = principals;
- const {
- userWorkspaceRoleMap,
- apiKeyRoleMap,
- flatRoleTargetByAgentIdMaps,
- flatApplicationMaps,
- } = await this.workspaceCacheService.getOrRecompute(workspaceId, [
- 'userWorkspaceRoleMap',
- 'apiKeyRoleMap',
- 'flatRoleTargetByAgentIdMaps',
- 'flatApplicationMaps',
- ]);
- const { flatWorkspaceMemberMaps } =
- mainPrincipal.type === 'workspaceMember'
- ? await this.workspaceCacheService.getOrRecompute(workspaceId, [
- 'flatWorkspaceMemberMaps',
- ])
- : { flatWorkspaceMemberMaps: EMPTY_WORKSPACE_MEMBER_MAPS };
- const { flatRoleTargetMaps } =
- mainPrincipal.type === 'webhook'
- ? await this.workspaceCacheService.getOrRecompute(workspaceId, [
- 'flatRoleTargetMaps',
- ])
- : { flatRoleTargetMaps: undefined };
-
- return resolvePermissionsPrincipalsWithRoles({
- principalsContext: principals,
- roleMaps: {
- flatWorkspaceMemberMaps,
- userWorkspaceRoleMap,
- apiKeyRoleMap,
- flatRoleTargetByAgentIdMaps,
- flatApplicationMaps,
- flatRoleTargetMaps,
- },
- });
+ return this.permissionsService.findPrincipalWithRoles(authContext);
}
private findPrincipalMetadataMaps(
diff --git a/packages/twenty-server/src/engine/permissions/combine/types/event-record-access-gate.type.ts b/packages/twenty-server/src/engine/permissions/combine/types/event-record-access-gate.type.ts
index 04644f1e710..5fdbe76c482 100644
--- a/packages/twenty-server/src/engine/permissions/combine/types/event-record-access-gate.type.ts
+++ b/packages/twenty-server/src/engine/permissions/combine/types/event-record-access-gate.type.ts
@@ -1,9 +1,9 @@
/* @license Enterprise */
-import { type PermissionsPrincipalsContext } from 'src/engine/permissions/principal/types/permissions-principals-context.type';
+import { type PermissionsAuthContext } from 'src/engine/permissions/principal/types/permissions-auth-context.type';
export type EventRecordAccessGate = {
resolveAdmittedRecordIds: (
- principals: PermissionsPrincipalsContext,
+ authContext: PermissionsAuthContext,
) => Promise<Set<string>>;
};
diff --git a/packages/twenty-server/src/engine/permissions/combine/utils/__tests__/resolve-events-readable-by-role.util.spec.ts b/packages/twenty-server/src/engine/permissions/combine/utils/__tests__/resolve-events-readable-by-role.util.spec.ts
index 2db35064a3a..3e96e5362d9 100644
--- a/packages/twenty-server/src/engine/permissions/combine/utils/__tests__/resolve-events-readable-by-role.util.spec.ts
+++ b/packages/twenty-server/src/engine/permissions/combine/utils/__tests__/resolve-events-readable-by-role.util.spec.ts
@@ -72,8 +72,7 @@ const updateEvent: ObjectRecordUpdateEvent = {
const resolveForApplication = (applicationId: string) =>
resolveEventsReadableByRole({
- applicationId,
- roleId: ROLE_ID,
+ application: { id: applicationId, defaultRoleId: ROLE_ID },
workspaceEventBatch: {
name: 'invoice.updated',
workspaceId: 'workspace-id',
diff --git a/packages/twenty-server/src/engine/permissions/combine/utils/resolve-events-readable-by-role.util.ts b/packages/twenty-server/src/engine/permissions/combine/utils/resolve-events-readable-by-role.util.ts
index abb2dbdd1e9..9a902246678 100644
--- a/packages/twenty-server/src/engine/permissions/combine/utils/resolve-events-readable-by-role.util.ts
+++ b/packages/twenty-server/src/engine/permissions/combine/utils/resolve-events-readable-by-role.util.ts
@@ -1,6 +1,7 @@
import { type ObjectRecordEvent } from 'twenty-shared/database-events';
import { isDefined } from 'twenty-shared/utils';
+import { type FlatApplication } from 'src/engine/core-modules/application/types/flat-application.type';
import { type EventRecordAccessGate } from 'src/engine/permissions/combine/types/event-record-access-gate.type';
import { type PermissionsMetadataMaps } from 'src/engine/permissions/combine/types/row-access-policy.type';
import { isUpdateOfHiddenFieldsOnly } from 'src/engine/permissions/masking/utils/is-update-of-hidden-fields-only.util';
@@ -12,18 +13,18 @@ import { type PermissionsPrincipalsWithRolesContext } from 'src/engine/permissio
export const resolveEventsReadableByRole = async <
TEvent extends ObjectRecordEvent,
>({
- applicationId,
- roleId,
+ application,
workspaceEventBatch,
eventRecordAccessGate,
metadataMaps,
}: {
- applicationId: string;
- roleId: string | null;
+ application: Pick<FlatApplication, 'id' | 'defaultRoleId'>;
workspaceEventBatch: WorkspaceEventBatch<TEvent>;
eventRecordAccessGate: EventRecordAccessGate;
metadataMaps: PermissionsMetadataMaps;
}): Promise<TEvent[]> => {
+ const { id: applicationId, defaultRoleId: roleId } = application;
+
if (!isDefined(roleId) || !isDefined(metadataMaps.rolesPermissions[roleId])) {
return [];
}
@@ -39,9 +40,9 @@ export const resolveEventsReadableByRole = async <
});
const admittedRecordIds =
await eventRecordAccessGate.resolveAdmittedRecordIds({
- workspaceId: workspaceEventBatch.workspaceId,
- mainPrincipal: { type: 'application', applicationId },
- applicationPrincipal: { type: 'application', applicationId },
+ type: 'application',
+ workspace: { id: workspaceEventBatch.workspaceId },
+ application,
});
return workspaceEventBatch.events
diff --git a/packages/twenty-server/src/engine/permissions/permissions.service.ts b/packages/twenty-server/src/engine/permissions/permissions.service.ts
index e79510818d0..b02adf4ac63 100644
--- a/packages/twenty-server/src/engine/permissions/permissions.service.ts
+++ b/packages/twenty-server/src/engine/permissions/permissions.service.ts
@@ -26,12 +26,16 @@ import { type UserWorkspacePermissions } from 'src/engine/permissions/types/user
import { type UserWorkspaceRoleMap } from 'src/engine/metadata-modules/role-target/types/user-workspace-role-map.type';
import { isSystemAuthContext } from 'src/engine/core-modules/auth/guards/is-system-auth-context.guard';
import { type WorkspaceAuthContext } from 'src/engine/core-modules/auth/types/workspace-auth-context.type';
-import { buildPermissionsPrincipalRoleMaps } from 'src/engine/permissions/principal/utils/build-permissions-principal-role-maps.util';
+import { type PermissionsAuthContext } from 'src/engine/permissions/principal/types/permissions-auth-context.type';
import { getPermissionsPrincipalRoleIds } from 'src/engine/permissions/principal/utils/get-permissions-principal-role-ids.util';
-import { getPermissionsPrincipalsFromAuthContext } from 'src/engine/permissions/principal/utils/get-permissions-principals-from-auth-context.util';
import { resolveApplicationRoleId } from 'src/engine/permissions/principal/utils/resolve-application-role-id.util';
import { type PermissionsPrincipalsWithRolesContext } from 'src/engine/permissions/principal/types/permissions-principals-with-roles-context.type';
-import { resolvePermissionsPrincipalsWithRoles } from 'src/engine/permissions/principal/utils/resolve-permissions-principals-with-roles.util';
+import { canAuthContextHoldRoles } from 'src/engine/permissions/principal/utils/can-auth-context-hold-roles.util';
+import { buildPermissionsPrincipalRoleMaps } from 'src/engine/permissions/principal/utils/build-permissions-principal-role-maps.util';
+import {
+ type PermissionsPrincipalRoleMaps,
+ resolvePermissionsPrincipalsWithRoles,
+} from 'src/engine/permissions/principal/utils/resolve-permissions-principals-with-roles.util';
import { WorkspaceCacheService } from 'src/engine/workspace-cache/services/workspace-cache.service';
@Injectable()
@@ -212,42 +216,78 @@ export class PermissionsService {
: [];
}
- private async findPrincipalWithRoles(
- authContext: WorkspaceAuthContext,
+ public async findPrincipalWithRoles(
+ authContext: PermissionsAuthContext,
): Promise<PermissionsPrincipalsWithRolesContext | undefined> {
- const principals = getPermissionsPrincipalsFromAuthContext(authContext);
-
- if (!isDefined(principals)) {
+ if (!canAuthContextHoldRoles(authContext)) {
return undefined;
}
+ return resolvePermissionsPrincipalsWithRoles({
+ authContext,
+ roleMaps: await this.loadPrincipalRoleMaps(authContext),
+ });
+ }
+
+ private async loadPrincipalRoleMaps(
+ authContext: Pick<PermissionsAuthContext, 'type' | 'workspace'>,
+ ): Promise<PermissionsPrincipalRoleMaps> {
+ const workspaceId = authContext.workspace.id;
const {
userWorkspaceRoleMap,
apiKeyRoleMap,
flatRoleTargetByAgentIdMaps,
flatApplicationMaps,
- flatWorkspaceMemberMaps,
- } = await this.workspaceCacheService.getOrRecompute(
- principals.workspaceId,
- [
- 'userWorkspaceRoleMap',
- 'apiKeyRoleMap',
- 'flatRoleTargetByAgentIdMaps',
- 'flatApplicationMaps',
- 'flatWorkspaceMemberMaps',
- ],
- );
+ } = await this.workspaceCacheService.getOrRecompute(workspaceId, [
+ 'userWorkspaceRoleMap',
+ 'apiKeyRoleMap',
+ 'flatRoleTargetByAgentIdMaps',
+ 'flatApplicationMaps',
+ ]);
- return resolvePermissionsPrincipalsWithRoles({
- principalsContext: principals,
- roleMaps: buildPermissionsPrincipalRoleMaps({
- flatWorkspaceMemberMaps,
+ return {
+ ...buildPermissionsPrincipalRoleMaps({
+ flatWorkspaceMemberMaps:
+ await this.loadFlatWorkspaceMemberMaps(authContext),
userWorkspaceRoleMap,
apiKeyRoleMap,
flatRoleTargetByAgentIdMaps,
flatApplicationMaps,
}),
- });
+ flatRoleTargetMaps: await this.loadFlatRoleTargetMaps(authContext),
+ };
+ }
+
+ private async loadFlatWorkspaceMemberMaps(
+ authContext: Pick<PermissionsAuthContext, 'type' | 'workspace'>,
+ ) {
+ if (authContext.type !== 'user') {
+ return undefined;
+ }
+
+ const { flatWorkspaceMemberMaps } =
+ await this.workspaceCacheService.getOrRecompute(
+ authContext.workspace.id,
+ ['flatWorkspaceMemberMaps'],
+ );
+
+ return flatWorkspaceMemberMaps;
+ }
+
+ private async loadFlatRoleTargetMaps(
+ authContext: Pick<PermissionsAuthContext, 'type' | 'workspace'>,
+ ) {
+ if (authContext.type !== 'webhook') {
+ return undefined;
+ }
+
+ const { flatRoleTargetMaps } =
+ await this.workspaceCacheService.getOrRecompute(
+ authContext.workspace.id,
+ ['flatRoleTargetMaps'],
+ );
+
+ return flatRoleTargetMaps;
}
// Like the ORM, a role missing from the cache grants nothing, and every role must grant the flag
diff --git a/packages/twenty-server/src/engine/permissions/principal/types/permissions-auth-context.type.ts b/packages/twenty-server/src/engine/permissions/principal/types/permissions-auth-context.type.ts
new file mode 100644
index 00000000000..6e654e3fd99
--- /dev/null
+++ b/packages/twenty-server/src/engine/permissions/principal/types/permissions-auth-context.type.ts
@@ -0,0 +1,62 @@
+/* @license Enterprise */
+
+import {
+ type ApiKeyWorkspaceAuthContext,
+ type ApplicationWorkspaceAuthContext,
+ type PendingActivationUserWorkspaceAuthContext,
+ type SystemWorkspaceAuthContext,
+ type UserWorkspaceAuthContext,
+} from 'src/engine/core-modules/auth/types/workspace-auth-context.type';
+import { type FlatWebhook } from 'src/engine/metadata-modules/flat-webhook/types/flat-webhook.type';
+
+type PermissionsWorkspace = Pick<UserWorkspaceAuthContext['workspace'], 'id'>;
+
+type PermissionsApplication = Pick<
+ ApplicationWorkspaceAuthContext['application'],
+ 'id'
+>;
+
+type PermissionsUserAuthContext = Pick<
+ UserWorkspaceAuthContext,
+ 'type' | 'workspaceMemberId' | 'agentId' | 'permissionScope'
+> & {
+ workspace: PermissionsWorkspace;
+ application?: PermissionsApplication;
+};
+
+type PermissionsApiKeyAuthContext = Pick<
+ ApiKeyWorkspaceAuthContext,
+ 'type' | 'agentId' | 'permissionScope'
+> & {
+ workspace: PermissionsWorkspace;
+ apiKey: Pick<ApiKeyWorkspaceAuthContext['apiKey'], 'id'>;
+ application?: PermissionsApplication;
+};
+
+type PermissionsApplicationAuthContext = Pick<
+ ApplicationWorkspaceAuthContext,
+ 'type' | 'agentId' | 'permissionScope'
+> & {
+ workspace: PermissionsWorkspace;
+ application: PermissionsApplication;
+};
+
+type PermissionsWebhookAuthContext = {
+ type: 'webhook';
+ workspace: PermissionsWorkspace;
+ webhook: Pick<FlatWebhook, 'id'>;
+};
+
+type PermissionsWithoutActorAuthContext = Pick<
+ SystemWorkspaceAuthContext | PendingActivationUserWorkspaceAuthContext,
+ 'type'
+> & {
+ workspace: PermissionsWorkspace;
+};
+
+export type PermissionsAuthContext =
+ | PermissionsUserAuthContext
+ | PermissionsApiKeyAuthContext
+ | PermissionsApplicationAuthContext
+ | PermissionsWebhookAuthContext
+ | PermissionsWithoutActorAuthContext;
diff --git a/packages/twenty-server/src/engine/permissions/principal/types/permissions-principals-context.type.ts b/packages/twenty-server/src/engine/permissions/principal/types/permissions-principal.type.ts
similarity index 76%
rename from packages/twenty-server/src/engine/permissions/principal/types/permissions-principals-context.type.ts
rename to packages/twenty-server/src/engine/permissions/principal/types/permissions-principal.type.ts
index 498fafbfe44..6ca8463b3f6 100644
--- a/packages/twenty-server/src/engine/permissions/principal/types/permissions-principals-context.type.ts
+++ b/packages/twenty-server/src/engine/permissions/principal/types/permissions-principal.type.ts
@@ -1,7 +1,5 @@
/* @license Enterprise */
-import { type PermissionScope } from 'src/engine/permissions/principal/types/permission-scope.type';
-
// TODO(@charlesBochet): drop deprecatedRoleOnly once every caller names the principal holding the role
export type PermissionsDeprecatedRoleOnlyPrincipal = {
type: 'deprecatedRoleOnly';
@@ -53,12 +51,3 @@ export type PermissionsApplicationPrincipal =
| PermissionsApplicationIdPrincipal
| PermissionsCustomApplicationPrincipal
| PermissionsDeprecatedRoleOnlyPrincipal;
-
-export type PermissionsPrincipalsContext = {
- workspaceId: string;
- mainPrincipal: PermissionsMainPrincipal;
- limitingPrincipal?: PermissionsLimitingPrincipal;
- applicationPrincipal: PermissionsApplicationPrincipal;
- // narrows what the roles allow, and leaves no reach beyond them
- scope?: PermissionScope;
-};
diff --git a/packages/twenty-server/src/engine/permissions/principal/types/permissions-principals-with-roles-context.type.ts b/packages/twenty-server/src/engine/permissions/principal/types/permissions-principals-with-roles-context.type.ts
index ecf46d89d5f..f67ced935e4 100644
--- a/packages/twenty-server/src/engine/permissions/principal/types/permissions-principals-with-roles-context.type.ts
+++ b/packages/twenty-server/src/engine/permissions/principal/types/permissions-principals-with-roles-context.type.ts
@@ -9,7 +9,7 @@ import {
type PermissionsDeprecatedRoleOnlyPrincipal,
type PermissionsWebhookPrincipal,
type PermissionsWorkspaceMemberPrincipal,
-} from 'src/engine/permissions/principal/types/permissions-principals-context.type';
+} from 'src/engine/permissions/principal/types/permissions-principal.type';
type WithRoleId<TPrincipal> = TPrincipal & { roleId: string };
diff --git a/packages/twenty-server/src/engine/permissions/principal/utils/build-permissions-principals-context.util.ts b/packages/twenty-server/src/engine/permissions/principal/utils/build-permissions-principals-context.util.ts
deleted file mode 100644
index 1500a6af5cd..00000000000
--- a/packages/twenty-server/src/engine/permissions/principal/utils/build-permissions-principals-context.util.ts
+++ /dev/null
@@ -1,67 +0,0 @@
-/* @license Enterprise */
-
-import { isDefined } from 'twenty-shared/utils';
-
-import {
- type PermissionsMainPrincipal,
- type PermissionsPrincipalsContext,
-} from 'src/engine/permissions/principal/types/permissions-principals-context.type';
-
-const buildMainPrincipal = ({
- workspaceMemberId,
- apiKeyId,
- applicationId,
-}: {
- workspaceMemberId: string | undefined;
- apiKeyId: string | undefined;
- applicationId: string | undefined;
-}): PermissionsMainPrincipal | undefined => {
- if (isDefined(workspaceMemberId)) {
- return { type: 'workspaceMember', workspaceMemberId };
- }
-
- if (isDefined(apiKeyId)) {
- return { type: 'apiKey', apiKeyId };
- }
-
- if (isDefined(applicationId)) {
- return { type: 'application', applicationId };
- }
-
- return undefined;
-};
-
-export const buildPermissionsPrincipalsContext = ({
- workspaceId,
- workspaceMemberId,
- apiKeyId,
- applicationId,
- agentId,
-}: {
- workspaceId: string;
- workspaceMemberId: string | undefined;
- apiKeyId: string | undefined;
- applicationId: string | undefined;
- agentId: string | undefined;
-}): PermissionsPrincipalsContext | undefined => {
- const mainPrincipal = buildMainPrincipal({
- workspaceMemberId,
- apiKeyId,
- applicationId,
- });
-
- if (!isDefined(mainPrincipal)) {
- return undefined;
- }
-
- return {
- workspaceId,
- mainPrincipal,
- limitingPrincipal: isDefined(agentId)
- ? { type: 'agent', agentId }
- : undefined,
- applicationPrincipal: isDefined(applicationId)
- ? { type: 'application', applicationId }
- : { type: 'customApplication' },
- };
-};
diff --git a/packages/twenty-server/src/engine/permissions/principal/utils/can-auth-context-hold-roles.util.ts b/packages/twenty-server/src/engine/permissions/principal/utils/can-auth-context-hold-roles.util.ts
new file mode 100644
index 00000000000..030d131b7e1
--- /dev/null
+++ b/packages/twenty-server/src/engine/permissions/principal/utils/can-auth-context-hold-roles.util.ts
@@ -0,0 +1,8 @@
+/* @license Enterprise */
+
+import { type PermissionsAuthContext } from 'src/engine/permissions/principal/types/permissions-auth-context.type';
+
+export const canAuthContextHoldRoles = (
+ authContext: Pick<PermissionsAuthContext, 'type'>,
+): boolean =>
+ authContext.type !== 'system' && authContext.type !== 'pendingActivationUser';
diff --git a/packages/twenty-server/src/engine/permissions/principal/utils/get-permissions-principals-from-auth-context.util.ts b/packages/twenty-server/src/engine/permissions/principal/utils/get-permissions-principals-from-auth-context.util.ts
deleted file mode 100644
index 2303819f555..00000000000
--- a/packages/twenty-server/src/engine/permissions/principal/utils/get-permissions-principals-from-auth-context.util.ts
+++ /dev/null
@@ -1,62 +0,0 @@
-/* @license Enterprise */
-
-import { isDefined } from 'twenty-shared/utils';
-
-import { isApiKeyAuthContext } from 'src/engine/core-modules/auth/guards/is-api-key-auth-context.guard';
-import { isApplicationAuthContext } from 'src/engine/core-modules/auth/guards/is-application-auth-context.guard';
-import { isUserAuthContext } from 'src/engine/core-modules/auth/guards/is-user-auth-context.guard';
-import { type WorkspaceAuthContext } from 'src/engine/core-modules/auth/types/workspace-auth-context.type';
-import { type PermissionsPrincipalsContext } from 'src/engine/permissions/principal/types/permissions-principals-context.type';
-import { buildPermissionsPrincipalsContext } from 'src/engine/permissions/principal/utils/build-permissions-principals-context.util';
-
-const getIdentityPrincipalsFromAuthContext = (
- authContext: WorkspaceAuthContext,
-): PermissionsPrincipalsContext | undefined => {
- if (isUserAuthContext(authContext)) {
- return buildPermissionsPrincipalsContext({
- workspaceId: authContext.workspace.id,
- workspaceMemberId: authContext.workspaceMemberId,
- apiKeyId: undefined,
- applicationId: authContext.application?.id,
- agentId: authContext.agentId,
- });
- }
-
- if (isApiKeyAuthContext(authContext)) {
- return buildPermissionsPrincipalsContext({
- workspaceId: authContext.workspace.id,
- workspaceMemberId: undefined,
- apiKeyId: authContext.apiKey.id,
- applicationId: authContext.application?.id,
- agentId: authContext.agentId,
- });
- }
-
- if (isApplicationAuthContext(authContext)) {
- return buildPermissionsPrincipalsContext({
- workspaceId: authContext.workspace.id,
- workspaceMemberId: undefined,
- apiKeyId: undefined,
- applicationId: authContext.application.id,
- agentId: authContext.agentId,
- });
- }
-
- return undefined;
-};
-
-export const getPermissionsPrincipalsFromAuthContext = (
- authContext: WorkspaceAuthContext,
-): PermissionsPrincipalsContext | undefined => {
- const principalsContext = getIdentityPrincipalsFromAuthContext(authContext);
-
- if (
- !isDefined(principalsContext) ||
- !('permissionScope' in authContext) ||
- !isDefined(authContext.permissionScope)
- ) {
- return principalsContext;
- }
-
- return { ...principalsContext, scope: authContext.permissionScope };
-};
diff --git a/packages/twenty-server/src/engine/permissions/principal/utils/resolve-permissions-principals-with-roles.util.ts b/packages/twenty-server/src/engine/permissions/principal/utils/resolve-permissions-principals-with-roles.util.ts
index 0cf5c53a91e..4a87b74d955 100644
--- a/packages/twenty-server/src/engine/permissions/principal/utils/resolve-permissions-principals-with-roles.util.ts
+++ b/packages/twenty-server/src/engine/permissions/principal/utils/resolve-permissions-principals-with-roles.util.ts
@@ -3,12 +3,13 @@
import { isDefined } from 'twenty-shared/utils';
import { findFlatRoleTargetFromForeignKey } from 'src/engine/metadata-modules/flat-role-target/utils/find-flat-role-target-from-foreign-key.util';
+import { type PermissionsAuthContext } from 'src/engine/permissions/principal/types/permissions-auth-context.type';
import {
type PermissionsApplicationPrincipal,
type PermissionsLimitingPrincipal,
type PermissionsMainPrincipal,
- type PermissionsPrincipalsContext,
-} from 'src/engine/permissions/principal/types/permissions-principals-context.type';
+} from 'src/engine/permissions/principal/types/permissions-principal.type';
+import { type PermissionScope } from 'src/engine/permissions/principal/types/permission-scope.type';
import {
type PermissionsApplicationPrincipalWithRole,
type PermissionsLimitingPrincipalWithRole,
@@ -163,15 +164,86 @@ const resolveApplicationPrincipal = ({
: undefined;
};
+type PermissionsIdentities = {
+ mainPrincipal: PermissionsMainPrincipal;
+ limitingPrincipal?: PermissionsLimitingPrincipal;
+ applicationPrincipal: PermissionsApplicationPrincipal;
+ scope?: PermissionScope;
+};
+
+const toApplicationPrincipal = (
+ applicationId: string | undefined,
+): PermissionsApplicationPrincipal =>
+ isDefined(applicationId)
+ ? { type: 'application', applicationId }
+ : { type: 'customApplication' };
+
+const toLimitingPrincipal = (
+ agentId: string | undefined,
+): PermissionsLimitingPrincipal | undefined =>
+ isDefined(agentId) ? { type: 'agent', agentId } : undefined;
+
+const getPermissionsIdentitiesFromAuthContext = (
+ authContext: PermissionsAuthContext,
+): PermissionsIdentities | undefined => {
+ switch (authContext.type) {
+ case 'user':
+ return {
+ mainPrincipal: {
+ type: 'workspaceMember',
+ workspaceMemberId: authContext.workspaceMemberId,
+ },
+ limitingPrincipal: toLimitingPrincipal(authContext.agentId),
+ applicationPrincipal: toApplicationPrincipal(
+ authContext.application?.id,
+ ),
+ scope: authContext.permissionScope,
+ };
+ case 'apiKey':
+ return {
+ mainPrincipal: { type: 'apiKey', apiKeyId: authContext.apiKey.id },
+ limitingPrincipal: toLimitingPrincipal(authContext.agentId),
+ applicationPrincipal: toApplicationPrincipal(
+ authContext.application?.id,
+ ),
+ scope: authContext.permissionScope,
+ };
+ case 'application':
+ return {
+ mainPrincipal: isDefined(authContext.agentId)
+ ? { type: 'agent', agentId: authContext.agentId }
+ : { type: 'application', applicationId: authContext.application.id },
+ applicationPrincipal: toApplicationPrincipal(
+ authContext.application.id,
+ ),
+ scope: authContext.permissionScope,
+ };
+ case 'webhook':
+ return {
+ mainPrincipal: { type: 'webhook', webhookId: authContext.webhook.id },
+ applicationPrincipal: { type: 'customApplication' },
+ };
+ case 'system':
+ case 'pendingActivationUser':
+ return undefined;
+ }
+};
+
export const resolvePermissionsPrincipalsWithRoles = ({
- principalsContext,
+ authContext,
roleMaps,
}: {
- principalsContext: PermissionsPrincipalsContext;
+ authContext: PermissionsAuthContext;
roleMaps: PermissionsPrincipalRoleMaps;
}): PermissionsPrincipalsWithRolesContext | undefined => {
+ const identities = getPermissionsIdentitiesFromAuthContext(authContext);
+
+ if (!isDefined(identities)) {
+ return undefined;
+ }
+
const mainRoleId = findMainPrincipalRoleId({
- mainPrincipal: principalsContext.mainPrincipal,
+ mainPrincipal: identities.mainPrincipal,
roleMaps,
});
@@ -180,12 +252,12 @@ export const resolvePermissionsPrincipalsWithRoles = ({
}
const mainPrincipal: PermissionsMainPrincipalWithRole = {
- ...principalsContext.mainPrincipal,
+ ...identities.mainPrincipal,
roleId: mainRoleId,
};
const applicationPrincipal = resolveApplicationPrincipal({
- applicationPrincipal: principalsContext.applicationPrincipal,
+ applicationPrincipal: identities.applicationPrincipal,
mainPrincipal,
roleMaps,
});
@@ -194,7 +266,7 @@ export const resolvePermissionsPrincipalsWithRoles = ({
return undefined;
}
- const { limitingPrincipal } = principalsContext;
+ const { limitingPrincipal } = identities;
const limitingPrincipalWithRole = isDefined(limitingPrincipal)
? resolveLimitingPrincipal({ limitingPrincipal, roleMaps })
: undefined;
@@ -205,12 +277,10 @@ export const resolvePermissionsPrincipalsWithRoles = ({
}
return {
- workspaceId: principalsContext.workspaceId,
+ workspaceId: authContext.workspace.id,
mainPrincipal,
limitingPrincipal: limitingPrincipalWithRole,
applicationPrincipal,
- ...(isDefined(principalsContext.scope)
- ? { scope: principalsContext.scope }
- : {}),
+ ...(isDefined(identities.scope) ? { scope: identities.scope } : {}),
};
};
diff --git a/packages/twenty-server/src/engine/permissions/record-share/record-share.module.ts b/packages/twenty-server/src/engine/permissions/record-share/record-share.module.ts
index 8b051122113..f3dfa636fd5 100644
--- a/packages/twenty-server/src/engine/permissions/record-share/record-share.module.ts
+++ b/packages/twenty-server/src/engine/permissions/record-share/record-share.module.ts
@@ -4,6 +4,7 @@ import { RecordSharingResolver } from 'src/engine/permissions/record-share/resol
import { RecordSharingService } from 'src/engine/permissions/record-share/services/record-sharing.service';
import { Module } from '@nestjs/common';
+import { PermissionsModule } from 'src/engine/permissions/permissions.module';
import { RecordAccessPolicyService } from 'src/engine/permissions/combine/services/record-access-policy.service';
import { RecordSharePrincipalService } from 'src/engine/permissions/record-share/services/record-share-principal.service';
import { RecordShareStorageModule } from 'src/engine/permissions/record-share/record-share-storage.module';
@@ -16,6 +17,7 @@ import { WorkspaceCacheModule } from 'src/engine/workspace-cache/workspace-cache
WorkspaceCacheModule,
RecordShareStorageModule,
RecordPermissionsModule,
+ PermissionsModule,
],
providers: [
ShareWithService,
diff --git a/packages/twenty-server/src/engine/permissions/record-share/services/record-share-principal.service.ts b/packages/twenty-server/src/engine/permissions/record-share/services/record-share-principal.service.ts
index c17642740aa..b0b3fe4c938 100644
--- a/packages/twenty-server/src/engine/permissions/record-share/services/record-share-principal.service.ts
+++ b/packages/twenty-server/src/engine/permissions/record-share/services/record-share-principal.service.ts
@@ -154,13 +154,10 @@ export class RecordSharePrincipalService {
}
const hasGrant = await this.recordAccessPolicyService.hasAccessToRecords({
- principals: {
- workspaceId,
- mainPrincipal: {
- type: 'workspaceMember',
- workspaceMemberId: principal.principalId,
- },
- applicationPrincipal: { type: 'customApplication' },
+ authContext: {
+ type: 'user',
+ workspace: { id: workspaceId },
+ workspaceMemberId: principal.principalId,
},
flatObjectMetadata,
operationType: 'select',
diff --git a/packages/twenty-server/src/engine/permissions/record-share/services/record-sharing.service.ts b/packages/twenty-server/src/engine/permissions/record-share/services/record-sharing.service.ts
index 731401c7446..2a1befff31c 100644
--- a/packages/twenty-server/src/engine/permissions/record-share/services/record-sharing.service.ts
+++ b/packages/twenty-server/src/engine/permissions/record-share/services/record-sharing.service.ts
@@ -43,7 +43,6 @@ import { resolvePrincipalIdsFromAuthContext } from 'src/engine/permissions/princ
import { WorkspaceOrmManager } from 'src/engine/twenty-orm/workspace-orm.manager';
import { buildPermissionsPrincipalRoleMaps } from 'src/engine/permissions/principal/utils/build-permissions-principal-role-maps.util';
import { getPermissionsPrincipalRoleIds } from 'src/engine/permissions/principal/utils/get-permissions-principal-role-ids.util';
-import { getPermissionsPrincipalsFromAuthContext } from 'src/engine/permissions/principal/utils/get-permissions-principals-from-auth-context.util';
import { resolvePermissionsPrincipalsWithRoles } from 'src/engine/permissions/principal/utils/resolve-permissions-principals-with-roles.util';
import { WorkspaceCacheService } from 'src/engine/workspace-cache/services/workspace-cache.service';
import { getWorkspaceSchemaName } from 'src/engine/workspace-datasource/utils/get-workspace-schema-name.util';
@@ -483,19 +482,16 @@ export class RecordSharingService {
userWorkspaceRoleMap,
apiKeyRoleMap,
}) ?? [];
- const principals = getPermissionsPrincipalsFromAuthContext(authContext);
- const principal = isDefined(principals)
- ? resolvePermissionsPrincipalsWithRoles({
- principalsContext: principals,
- roleMaps: buildPermissionsPrincipalRoleMaps({
- flatWorkspaceMemberMaps,
- userWorkspaceRoleMap,
- apiKeyRoleMap,
- flatRoleTargetByAgentIdMaps,
- flatApplicationMaps,
- }),
- })
- : undefined;
+ const principal = resolvePermissionsPrincipalsWithRoles({
+ authContext,
+ roleMaps: buildPermissionsPrincipalRoleMaps({
+ flatWorkspaceMemberMaps,
+ userWorkspaceRoleMap,
+ apiKeyRoleMap,
+ flatRoleTargetByAgentIdMaps,
+ flatApplicationMaps,
+ }),
+ });
const canAccessAllRecords =
isDefined(principal) &&
canRolesAccessAllRecords({
diff --git a/packages/twenty-server/src/engine/permissions/role/utils/__tests__/compute-objects-permissions-for-roles.util.spec.ts b/packages/twenty-server/src/engine/permissions/role/utils/__tests__/compute-objects-permissions-for-roles.util.spec.ts
index eaf813593d8..423b2720d99 100644
--- a/packages/twenty-server/src/engine/permissions/role/utils/__tests__/compute-objects-permissions-for-roles.util.spec.ts
+++ b/packages/twenty-server/src/engine/permissions/role/utils/__tests__/compute-objects-permissions-for-roles.util.spec.ts
@@ -17,7 +17,8 @@ import { type FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-m
import { type OrmFlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/orm-flat-field-metadata.type';
import { getFlatObjectMetadataMock } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/get-flat-object-metadata.mock';
import { type FlatObjectMetadata } from 'src/engine/metadata-modules/flat-object-metadata/types/flat-object-metadata.type';
-import { type PermissionsPrincipalsContext } from 'src/engine/permissions/principal/types/permissions-principals-context.type';
+import { type PermissionsAuthContext } from 'src/engine/permissions/principal/types/permissions-auth-context.type';
+import { type PermissionScope } from 'src/engine/permissions/principal/types/permission-scope.type';
import { type PermissionsPrincipalsWithRolesContext } from 'src/engine/permissions/principal/types/permissions-principals-with-roles-context.type';
import { buildPermissionsPrincipalRoleMaps } from 'src/engine/permissions/principal/utils/build-permissions-principal-role-maps.util';
import {
@@ -88,15 +89,47 @@ const computeForPrincipal = (principal: PrincipalWithRoles) =>
flatApplicationMaps: { byId: {} },
});
-const computeForPrincipalsContext = ({
- principalsContext,
+const buildMemberAuthContext = ({
+ workspaceMemberId,
+ applicationId,
+ agentId,
+}: {
+ workspaceMemberId: string;
+ applicationId?: string;
+ agentId?: string;
+}): PermissionsAuthContext => ({
+ type: 'user',
+ workspace: { id: 'workspace-id' },
+ workspaceMemberId,
+ ...(isDefined(applicationId) ? { application: { id: applicationId } } : {}),
+ ...(isDefined(agentId) ? { agentId } : {}),
+});
+
+const buildApiKeyAuthContext = ({
+ apiKeyId,
+ agentId,
+ permissionScope,
+}: {
+ apiKeyId: string;
+ agentId?: string;
+ permissionScope?: PermissionScope;
+}): PermissionsAuthContext => ({
+ type: 'apiKey',
+ workspace: { id: 'workspace-id' },
+ apiKey: { id: apiKeyId },
+ ...(isDefined(agentId) ? { agentId } : {}),
+ ...(isDefined(permissionScope) ? { permissionScope } : {}),
+});
+
+const computeForAuthContext = ({
+ authContext,
roleMaps,
}: {
- principalsContext: PermissionsPrincipalsContext;
+ authContext: PermissionsAuthContext;
roleMaps: PermissionsPrincipalRoleMaps;
}): ObjectsPermissions => {
const principal = resolvePermissionsPrincipalsWithRoles({
- principalsContext,
+ authContext,
roleMaps,
});
@@ -202,20 +235,17 @@ describe('computeObjectsPermissionsForRoles', () => {
it('should deny when the main principal has no role', () => {
expect(
- computeForPrincipalsContext({
- principalsContext: {
- workspaceId: 'workspace-id',
- mainPrincipal: {
- type: 'workspaceMember',
- workspaceMemberId: 'member-id',
- },
- limitingPrincipal: {
- type: 'deprecatedRoleOnly',
- roleId: 'agent-role-id',
+ computeForAuthContext({
+ authContext: buildMemberAuthContext({
+ workspaceMemberId: 'member-id',
+ agentId: 'agent-id',
+ }),
+ roleMaps: {
+ ...buildRoleMaps(),
+ flatRoleTargetByAgentIdMaps: {
+ 'agent-id': { roleId: 'agent-role-id' },
},
- applicationPrincipal: { type: 'customApplication' },
},
- roleMaps: buildRoleMaps(),
}),
).toEqual({});
});
@@ -225,22 +255,60 @@ describe('computeObjectsPermissionsForRoles', () => {
...buildRoleMaps(),
apiKeyRoleMap: { 'api-key-id': 'default-role-id' },
};
- const principalsContext: PermissionsPrincipalsContext = {
- workspaceId: 'workspace-id',
- mainPrincipal: { type: 'apiKey', apiKeyId: 'api-key-id' },
- applicationPrincipal: { type: 'customApplication' },
+ expect(
+ computeForAuthContext({
+ authContext: buildApiKeyAuthContext({ apiKeyId: 'api-key-id' }),
+ roleMaps,
+ }),
+ ).toEqual(defaultRolePermissions);
+ expect(
+ computeForAuthContext({
+ authContext: buildApiKeyAuthContext({
+ apiKeyId: 'api-key-id',
+ agentId: 'deleted-agent-id',
+ }),
+ roleMaps,
+ }),
+ ).toEqual({});
+ });
+
+ it('should run an application agent within both its role and its application role', () => {
+ const roleMaps = {
+ ...buildRoleMaps({
+ byId: {
+ 'application-id': {
+ id: 'application-id',
+ defaultRoleId: 'default-role-id',
+ sourceType: ApplicationRegistrationSourceType.LOCAL,
+ deletedAt: null,
+ },
+ },
+ }),
+ flatRoleTargetByAgentIdMaps: { 'agent-id': { roleId: 'agent-role-id' } },
};
expect(
- computeForPrincipalsContext({ principalsContext, roleMaps }),
+ computeForAuthContext({
+ authContext: {
+ type: 'application',
+ workspace: { id: 'workspace-id' },
+ application: { id: 'application-id' },
+ agentId: 'agent-id',
+ },
+ roleMaps,
+ }),
).toEqual(defaultRolePermissions);
+ });
+
+ it('should deny a webhook whose role cannot be found', () => {
expect(
- computeForPrincipalsContext({
- principalsContext: {
- ...principalsContext,
- limitingPrincipal: { type: 'agent', agentId: 'deleted-agent-id' },
+ computeForAuthContext({
+ authContext: {
+ type: 'webhook',
+ workspace: { id: 'workspace-id' },
+ webhook: { id: 'webhook-id' },
},
- roleMaps,
+ roleMaps: buildRoleMaps(),
}),
).toEqual({});
});
@@ -255,18 +323,11 @@ describe('computeObjectsPermissionsForRoles', () => {
applicationRoleId?: string | null;
memberRoleId?: string | null;
}) =>
- computeForPrincipalsContext({
- principalsContext: {
- workspaceId: 'workspace-id',
- mainPrincipal: {
- type: 'workspaceMember',
- workspaceMemberId: 'workspace-member-id',
- },
- applicationPrincipal: {
- type: 'application',
- applicationId: 'application-id',
- },
- },
+ computeForAuthContext({
+ authContext: buildMemberAuthContext({
+ workspaceMemberId: 'workspace-member-id',
+ applicationId: 'application-id',
+ }),
roleMaps: {
...buildRoleMaps({
byId: {
@@ -646,31 +707,30 @@ describe('computeObjectsPermissionsForRoles with a scope', () => {
};
const compute = ({
- mainPrincipal = { type: 'deprecatedRoleOnly', roleId: 'user-role-id' },
+ apiKeyId = 'api-key-id',
scopeObjectPermissions,
hasScope = true,
}: {
- mainPrincipal?: PermissionsPrincipalsContext['mainPrincipal'];
+ apiKeyId?: string;
scopeObjectPermissions?: ObjectPermissions;
hasScope?: boolean;
}) => {
const principal = resolvePermissionsPrincipalsWithRoles({
- principalsContext: {
- workspaceId: 'workspace-id',
- mainPrincipal,
- applicationPrincipal: { type: 'customApplication' },
- ...(hasScope
+ authContext: buildApiKeyAuthContext({
+ apiKeyId,
+ permissionScope: hasScope
? {
- scope: {
- objectsPermissions: isDefined(scopeObjectPermissions)
- ? { [INVOICE_ID]: scopeObjectPermissions }
- : {},
- permissionFlags: {},
- },
+ objectsPermissions: isDefined(scopeObjectPermissions)
+ ? { [INVOICE_ID]: scopeObjectPermissions }
+ : {},
+ permissionFlags: {},
}
- : {}),
+ : undefined,
+ }),
+ roleMaps: {
+ ...buildRoleMaps(flatApplicationMaps),
+ apiKeyRoleMap: { 'api-key-id': 'user-role-id' },
},
- roleMaps: buildRoleMaps(flatApplicationMaps),
});
return isDefined(principal)
@@ -786,7 +846,7 @@ describe('computeObjectsPermissionsForRoles with a scope', () => {
it('grants nothing without a role', () => {
expect(
compute({
- mainPrincipal: { type: 'apiKey', apiKeyId: 'api-key-without-role' },
+ apiKeyId: 'api-key-without-role',
scopeObjectPermissions: FULL_ACCESS,
}),
).toBeUndefined();
diff --git a/packages/twenty-server/src/engine/permissions/role/utils/resolve-object-records-permissions.util.ts b/packages/twenty-server/src/engine/permissions/role/utils/resolve-object-records-permissions.util.ts
index b54cbe042ea..7b676d10389 100644
--- a/packages/twenty-server/src/engine/permissions/role/utils/resolve-object-records-permissions.util.ts
+++ b/packages/twenty-server/src/engine/permissions/role/utils/resolve-object-records-permissions.util.ts
@@ -10,7 +10,6 @@ import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/typ
import { type OrmFlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/orm-flat-field-metadata.type';
import { type FlatObjectMetadata } from 'src/engine/metadata-modules/flat-object-metadata/types/flat-object-metadata.type';
import { type PermissionsPrincipalsWithRolesContext } from 'src/engine/permissions/principal/types/permissions-principals-with-roles-context.type';
-import { getPermissionsPrincipalsFromAuthContext } from 'src/engine/permissions/principal/utils/get-permissions-principals-from-auth-context.util';
import {
type PermissionsPrincipalRoleMaps,
resolvePermissionsPrincipalsWithRoles,
@@ -44,13 +43,10 @@ export const resolveObjectRecordsPermissions = ({
};
}
- const principals = getPermissionsPrincipalsFromAuthContext(authContext);
- const permissionsPrincipal = isDefined(principals)
- ? resolvePermissionsPrincipalsWithRoles({
- principalsContext: principals,
- roleMaps,
- })
- : undefined;
+ const permissionsPrincipal = resolvePermissionsPrincipalsWithRoles({
+ authContext,
+ roleMaps,
+ });
if (!isDefined(permissionsPrincipal)) {
return {
diff --git a/packages/twenty-server/src/engine/subscriptions/object-record-event/object-record-event-publisher.ts b/packages/twenty-server/src/engine/subscriptions/object-record-event/object-record-event-publisher.ts
index 39644b63c5e..892da33500a 100644
--- a/packages/twenty-server/src/engine/subscriptions/object-record-event/object-record-event-publisher.ts
+++ b/packages/twenty-server/src/engine/subscriptions/object-record-event/object-record-event-publisher.ts
@@ -38,11 +38,10 @@ import { ObjectRecordSubscriptionEvent } from 'src/engine/subscriptions/types/ob
import { isRecordMatchingRLSRowLevelPermissionPredicate } from 'src/engine/permissions/rls/utils/is-record-matching-rls-row-level-permission-predicate.util';
import { UserWorkspaceAuthContextService } from 'src/engine/core-modules/user-workspace/services/user-workspace-auth-context.service';
import { WorkspaceOrmManager } from 'src/engine/twenty-orm/workspace-orm.manager';
-import { type PermissionsPrincipalsContext } from 'src/engine/permissions/principal/types/permissions-principals-context.type';
+import { type PermissionsAuthContext } from 'src/engine/permissions/principal/types/permissions-auth-context.type';
import { WorkspaceCacheService } from 'src/engine/workspace-cache/services/workspace-cache.service';
import { WorkspaceEventBatch } from 'src/engine/workspace-event-emitter/types/workspace-event-batch.type';
import { parseEventNameOrThrow } from 'src/engine/workspace-event-emitter/utils/parse-event-name';
-import { buildPermissionsPrincipalsContext } from 'src/engine/permissions/principal/utils/build-permissions-principals-context.util';
type StreamPermissionsContext = {
flatRowLevelPermissionPredicateMaps: FlatRowLevelPermissionPredicateMaps;
@@ -167,25 +166,6 @@ export class ObjectRecordEventPublisher {
return;
}
- const principals = buildPermissionsPrincipalsContext({
- workspaceId: workspaceEventBatch.workspaceId,
- workspaceMemberId,
- apiKeyId: undefined,
- applicationId: subscriberAuthContext.applicationId,
- agentId: undefined,
- });
-
- if (!isDefined(principals)) {
- return;
- }
-
- const objectsPermissions =
- await this.recordAccessPolicyService.findObjectsPermissions(principals);
-
- if (!isDefined(objectsPermissions)) {
- return;
- }
-
const objectNameSingular = workspaceEventBatch.objectMetadata.nameSingular;
if (
@@ -198,13 +178,34 @@ export class ObjectRecordEventPublisher {
return;
}
+ const { applicationId } = subscriberAuthContext;
+ const permissionsAuthContext: PermissionsAuthContext = {
+ type: 'user',
+ workspace: { id: workspaceEventBatch.workspaceId },
+ workspaceMemberId,
+ ...(isDefined(applicationId)
+ ? { application: { id: applicationId } }
+ : {}),
+ };
+
+ const objectsPermissions =
+ await this.recordAccessPolicyService.findObjectsPermissions(
+ permissionsAuthContext,
+ );
+
+ if (!isDefined(objectsPermissions)) {
+ return;
+ }
+
const matchedEvents: {
queryIds: string[];
objectRecordEvent: ObjectRecordSubscriptionEvent;
}[] = [];
const admittedRecordIds =
- await eventRecordAccessGate.resolveAdmittedRecordIds(principals);
+ await eventRecordAccessGate.resolveAdmittedRecordIds(
+ permissionsAuthContext,
+ );
if (admittedRecordIds.size === 0) {
return;
@@ -273,7 +274,7 @@ export class ObjectRecordEventPublisher {
userWorkspaceId,
applicationId: subscriberAuthContext.applicationId,
}),
- principals,
+ permissionsAuthContext,
objectsPermissions,
});
} catch (error) {
@@ -303,14 +304,14 @@ export class ObjectRecordEventPublisher {
events,
workspaceId,
subscriberAuthContext,
- principals,
+ permissionsAuthContext,
objectsPermissions,
}: {
objectMetadata: FlatObjectMetadata;
events: ObjectRecordEvent[];
workspaceId: string;
subscriberAuthContext: Promise<WorkspaceAuthContext>;
- principals: PermissionsPrincipalsContext;
+ permissionsAuthContext: PermissionsAuthContext;
objectsPermissions: ObjectsPermissions;
}) {
const { flatFieldMetadataMaps, flatObjectMetadataMaps } =
@@ -344,7 +345,7 @@ export class ObjectRecordEventPublisher {
const { selectedFields } = this.commonSelectFieldsBuilder.buildFromDepth({
readableObjectMetadataIds:
await this.commonSelectFieldsBuilder.findReadableObjectMetadataIds({
- principals,
+ authContext: permissionsAuthContext,
flatObjectMetadataMaps,
}),
depth: 1,
diff --git a/packages/twenty-server/src/modules/workflow/workflow-trigger/automated-trigger/listeners/workflow-database-event-trigger.listener.ts b/packages/twenty-server/src/modules/workflow/workflow-trigger/automated-trigger/listeners/workflow-database-event-trigger.listener.ts
index 393113efe29..663d18ee430 100644
--- a/packages/twenty-server/src/modules/workflow/workflow-trigger/automated-trigger/listeners/workflow-database-event-trigger.listener.ts
+++ b/packages/twenty-server/src/modules/workflow/workflow-trigger/automated-trigger/listeners/workflow-database-event-trigger.listener.ts
@@ -505,11 +505,17 @@ export class WorkflowDatabaseEventTriggerListener {
['flatApplicationMaps'],
);
- return resolveEventsReadableByRole({
+ const application = findActiveFlatApplicationById(
+ flatApplicationMaps,
applicationId,
- roleId:
- findActiveFlatApplicationById(flatApplicationMaps, applicationId)
- ?.defaultRoleId ?? null,
+ );
+
+ if (!isDefined(application)) {
+ return [];
+ }
+
+ return resolveEventsReadableByRole({
+ application,
workspaceEventBatch,
eventRecordAccessGate:
this.recordAccessPolicyService.buildEventRecordAccessGate(
diff --git a/packages/twenty-server/test/integration/graphql/suites/object-records-permissions/chat-thread-sharing.integration-spec.ts b/packages/twenty-server/test/integration/graphql/suites/object-records-permissions/chat-thread-sharing.integration-spec.ts
index e65e46b4158..c6c6faa6d06 100644
--- a/packages/twenty-server/test/integration/graphql/suites/object-records-permissions/chat-thread-sharing.integration-spec.ts
+++ b/packages/twenty-server/test/integration/graphql/suites/object-records-permissions/chat-thread-sharing.integration-spec.ts
@@ -33,6 +33,7 @@ import { isDefined } from 'twenty-shared/utils';
import { makeMetadataApiRequest } from 'test/integration/metadata/suites/utils/make-metadata-api-request.util';
import { type WorkspaceEventEmitter } from 'src/engine/workspace-event-emitter/workspace-event-emitter';
+import { resolveWorkspaceMemberAuthContext } from 'test/integration/utils/resolve-workspace-member-auth-context.util';
import { getAppProviderByClassName } from 'test/integration/utils/get-app-provider-by-class-name.util';
import { type AgentChatService } from 'src/engine/metadata-modules/ai/ai-chat/services/agent-chat.service';
import { type AgentChatQueueService } from 'src/engine/metadata-modules/ai/ai-chat/services/agent-chat-queue.service';
@@ -993,11 +994,12 @@ describe('Conversations through the record API', () => {
'RecordAccessPolicyService',
)
.buildEventRecordAccessGate(batch)
- .resolveAdmittedRecordIds({
- workspaceId: SEED_APPLE_WORKSPACE_ID,
- mainPrincipal: { type: 'workspaceMember', workspaceMemberId },
- applicationPrincipal: { type: 'customApplication' },
- });
+ .resolveAdmittedRecordIds(
+ await resolveWorkspaceMemberAuthContext({
+ workspaceId: SEED_APPLE_WORKSPACE_ID,
+ workspaceMemberId,
+ }),
+ );
return admittedRecordIds.has(threadId);
};
diff --git a/packages/twenty-server/test/integration/graphql/suites/object-records-permissions/record-level-sharing-restricted-record-surfaces.integration-spec.ts b/packages/twenty-server/test/integration/graphql/suites/object-records-permissions/record-level-sharing-restricted-record-surfaces.integration-spec.ts
index 9a879bc97d6..7131c429973 100644
--- a/packages/twenty-server/test/integration/graphql/suites/object-records-permissions/record-level-sharing-restricted-record-surfaces.integration-spec.ts
+++ b/packages/twenty-server/test/integration/graphql/suites/object-records-permissions/record-level-sharing-restricted-record-surfaces.integration-spec.ts
@@ -18,6 +18,7 @@ import { updateManyOperationFactory } from 'test/integration/graphql/utils/updat
import { makeMetadataApiRequest } from 'test/integration/metadata/suites/utils/make-metadata-api-request.util';
import { updateFeatureFlag } from 'test/integration/metadata/suites/utils/update-feature-flag.util';
import { makeRestApiRequest } from 'test/integration/rest/utils/make-rest-api-request.util';
+import { resolveWorkspaceMemberAuthContext } from 'test/integration/utils/resolve-workspace-member-auth-context.util';
import { getAppProviderByClassName } from 'test/integration/utils/get-app-provider-by-class-name.util';
import { getCoreRepository } from 'test/integration/utils/get-core-repository.util';
@@ -306,14 +307,12 @@ describe('A restricted record on an object open by default', () => {
properties: { after: { id: recordId } },
})) as ObjectRecordEvent[],
})
- .resolveAdmittedRecordIds({
- workspaceId: workspaceId,
- mainPrincipal: {
- type: 'workspaceMember',
+ .resolveAdmittedRecordIds(
+ await resolveWorkspaceMemberAuthContext({
+ workspaceId,
workspaceMemberId: WORKSPACE_MEMBER_DATA_SEED_IDS.JONY,
- },
- applicationPrincipal: { type: 'customApplication' },
- });
+ }),
+ );
expect([...admittedRecordIds]).toEqual([OPEN_COMPANY_ID]);
});
diff --git a/packages/twenty-server/test/integration/graphql/suites/object-records-permissions/record-sharing-beyond-role.integration-spec.ts b/packages/twenty-server/test/integration/graphql/suites/object-records-permissions/record-sharing-beyond-role.integration-spec.ts
index ea1ce1781f2..2ace0884e4d 100644
--- a/packages/twenty-server/test/integration/graphql/suites/object-records-permissions/record-sharing-beyond-role.integration-spec.ts
+++ b/packages/twenty-server/test/integration/graphql/suites/object-records-permissions/record-sharing-beyond-role.integration-spec.ts
@@ -25,6 +25,7 @@ import { findOneRoleByLabel } from 'test/integration/metadata/suites/role/utils/
import { upsertRowLevelPermissionPredicates } from 'test/integration/metadata/suites/row-level-permission-predicate/utils/upsert-row-level-permission-predicates.util';
import { updateFeatureFlag } from 'test/integration/metadata/suites/utils/update-feature-flag.util';
import { makeMetadataApiRequest } from 'test/integration/metadata/suites/utils/make-metadata-api-request.util';
+import { resolveWorkspaceMemberAuthContext } from 'test/integration/utils/resolve-workspace-member-auth-context.util';
import { getAppProviderByClassName } from 'test/integration/utils/get-app-provider-by-class-name.util';
import { type RecordSharePrincipalInput } from 'src/engine/permissions/record-share/dtos/record-sharing.dto';
@@ -34,7 +35,6 @@ import { type WorkspaceCacheService } from 'src/engine/workspace-cache/services/
import { type RecordShareStorageService } from 'src/engine/permissions/record-share/services/record-share-storage.service';
import { SEED_APPLE_WORKSPACE_ID } from 'src/engine/workspace-manager/dev-seeder/core/constants/seeder-workspaces.constant';
import { WORKSPACE_MEMBER_DATA_SEED_IDS } from 'src/engine/workspace-manager/dev-seeder/data/constants/workspace-member-data-seeds.constant';
-import { type PermissionsPrincipalsContext } from 'src/engine/permissions/principal/types/permissions-principals-context.type';
const OBJECT_NAME = 'beyondRoleRecord';
const OBJECT_PLURAL = 'beyondRoleRecords';
@@ -255,18 +255,15 @@ describe('Records shared beyond the role that can access their object', () => {
throw new Error('The object under test is not cached');
}
- const buildJonyPrincipal = (): PermissionsPrincipalsContext => ({
- workspaceId,
- mainPrincipal: {
- type: 'workspaceMember',
+ const resolveJonyAuthContext = () =>
+ resolveWorkspaceMemberAuthContext({
+ workspaceId,
workspaceMemberId: WORKSPACE_MEMBER_DATA_SEED_IDS.JONY,
- },
- applicationPrincipal: { type: 'customApplication' },
- });
+ });
expect(
await recordAccessPolicyService.hasAccessToSomeRecords({
- principals: buildJonyPrincipal(),
+ authContext: await resolveJonyAuthContext(),
flatObjectMetadata,
operationType: 'select',
}),
@@ -274,25 +271,25 @@ describe('Records shared beyond the role that can access their object', () => {
await setShare({ principal: JONY });
- const principals = buildJonyPrincipal();
+ const authContext = await resolveJonyAuthContext();
expect(
await recordAccessPolicyService.hasAccessToSomeRecords({
- principals,
+ authContext,
flatObjectMetadata,
operationType: 'select',
}),
).toBe(true);
expect(
await recordAccessPolicyService.hasAccessToSomeRecords({
- principals,
+ authContext,
flatObjectMetadata,
operationType: 'update',
}),
).toBe(false);
expect(
await recordAccessPolicyService.hasAccessToRecords({
- principals,
+ authContext,
flatObjectMetadata,
operationType: 'select',
recordIds: [SHARED_RECORD_ID],
@@ -300,7 +297,7 @@ describe('Records shared beyond the role that can access their object', () => {
).toBe(true);
expect(
await recordAccessPolicyService.hasAccessToRecords({
- principals,
+ authContext,
flatObjectMetadata,
operationType: 'select',
recordIds: [SHARED_RECORD_ID, OTHER_RECORD_ID],
@@ -522,14 +519,12 @@ describe('Records shared beyond the role that can access their object', () => {
properties: { after: { id: recordId } },
})) as ObjectRecordEvent[],
})
- .resolveAdmittedRecordIds({
- workspaceId: workspaceId,
- mainPrincipal: {
- type: 'workspaceMember',
+ .resolveAdmittedRecordIds(
+ await resolveWorkspaceMemberAuthContext({
+ workspaceId,
workspaceMemberId: WORKSPACE_MEMBER_DATA_SEED_IDS.JONY,
- },
- applicationPrincipal: { type: 'customApplication' },
- });
+ }),
+ );
};
expect((await findIdsAsJony()).ids).toEqual([]);
diff --git a/packages/twenty-server/test/integration/graphql/suites/user-session/successful-agent-run-tool-role-for-caller.integration-spec.ts b/packages/twenty-server/test/integration/graphql/suites/user-session/successful-agent-run-tool-role-for-caller.integration-spec.ts
index 559985c7e69..8a4b023eacb 100644
--- a/packages/twenty-server/test/integration/graphql/suites/user-session/successful-agent-run-tool-role-for-caller.integration-spec.ts
+++ b/packages/twenty-server/test/integration/graphql/suites/user-session/successful-agent-run-tool-role-for-caller.integration-spec.ts
@@ -1,5 +1,3 @@
-import { type PermissionsMainPrincipal } from 'src/engine/permissions/principal/types/permissions-principals-context.type';
-import { getPermissionsPrincipalsFromAuthContext } from 'src/engine/permissions/principal/utils/get-permissions-principals-from-auth-context.util';
import { captureAgentRunExecution } from 'test/integration/graphql/suites/user-session/utils/capture-agent-run-execution.util';
import { cleanupApplicationAndAppRegistration } from 'test/integration/metadata/suites/application/utils/cleanup-application-and-app-registration.util';
import {
@@ -27,7 +25,9 @@ type GlobalTestContext = {
type TestContext = {
token: (globalContext: GlobalTestContext) => string;
runAsWorkspaceMemberId?: string;
- mainPrincipal: PermissionsMainPrincipal;
+ expectedCaller:
+ | { type: 'user'; workspaceMemberId: string }
+ | { type: 'apiKey'; apiKey: { id: string } };
};
const callerRunTestCases: EachTestingContext<TestContext>[] = [
@@ -35,8 +35,8 @@ const callerRunTestCases: EachTestingContext<TestContext>[] = [
title: 'a member session runs another application agent',
context: {
token: () => APPLE_JONY_MEMBER_ACCESS_TOKEN,
- mainPrincipal: {
- type: 'workspaceMember',
+ expectedCaller: {
+ type: 'user',
workspaceMemberId: WORKSPACE_MEMBER_DATA_SEED_IDS.JONY,
},
},
@@ -45,8 +45,8 @@ const callerRunTestCases: EachTestingContext<TestContext>[] = [
title: 'an application token issued for a member runs its own agent',
context: {
token: (globalContext) => globalContext.janeApplicationToken,
- mainPrincipal: {
- type: 'workspaceMember',
+ expectedCaller: {
+ type: 'user',
workspaceMemberId: WORKSPACE_MEMBER_DATA_SEED_IDS.JANE,
},
},
@@ -56,8 +56,8 @@ const callerRunTestCases: EachTestingContext<TestContext>[] = [
context: {
token: (globalContext) => globalContext.applicationToken,
runAsWorkspaceMemberId: WORKSPACE_MEMBER_DATA_SEED_IDS.JONY,
- mainPrincipal: {
- type: 'workspaceMember',
+ expectedCaller: {
+ type: 'user',
workspaceMemberId: WORKSPACE_MEMBER_DATA_SEED_IDS.JONY,
},
},
@@ -66,7 +66,10 @@ const callerRunTestCases: EachTestingContext<TestContext>[] = [
title: 'an API key runs an application agent',
context: {
token: () => API_KEY_ACCESS_TOKEN,
- mainPrincipal: { type: 'apiKey', apiKeyId: API_KEY_DATA_SEED_IDS.ID_1 },
+ expectedCaller: {
+ type: 'apiKey',
+ apiKey: { id: API_KEY_DATA_SEED_IDS.ID_1 },
+ },
},
},
];
@@ -123,16 +126,11 @@ describe('Agent run tools should be limited to the caller role', () => {
runAsWorkspaceMemberId: context.runAsWorkspaceMemberId,
});
- expect(
- getPermissionsPrincipalsFromAuthContext(executionContext.authContext),
- ).toEqual({
- workspaceId: SEED_APPLE_WORKSPACE_ID,
- mainPrincipal: context.mainPrincipal,
- limitingPrincipal: { type: 'agent', agentId: application.agentId },
- applicationPrincipal: {
- type: 'application',
- applicationId: application.id,
- },
+ expect(executionContext.authContext).toMatchObject({
+ ...context.expectedCaller,
+ workspace: expect.objectContaining({ id: SEED_APPLE_WORKSPACE_ID }),
+ agentId: application.agentId,
+ application: expect.objectContaining({ id: application.id }),
});
},
);
@@ -143,16 +141,11 @@ describe('Agent run tools should be limited to the caller role', () => {
token: globalTestContext.applicationToken,
});
- expect(
- getPermissionsPrincipalsFromAuthContext(executionContext.authContext),
- ).toEqual({
- workspaceId: SEED_APPLE_WORKSPACE_ID,
- mainPrincipal: { type: 'application', applicationId: application.id },
- limitingPrincipal: { type: 'agent', agentId: application.agentId },
- applicationPrincipal: {
- type: 'application',
- applicationId: application.id,
- },
+ expect(executionContext.authContext).toMatchObject({
+ type: 'application',
+ workspace: expect.objectContaining({ id: SEED_APPLE_WORKSPACE_ID }),
+ agentId: application.agentId,
+ application: expect.objectContaining({ id: application.id }),
});
});
});
diff --git a/packages/twenty-server/test/integration/twenty-orm/record-access-policy.integration-spec.ts b/packages/twenty-server/test/integration/twenty-orm/record-access-policy.integration-spec.ts
index 44e92116fd1..9e808cd8469 100644
--- a/packages/twenty-server/test/integration/twenty-orm/record-access-policy.integration-spec.ts
+++ b/packages/twenty-server/test/integration/twenty-orm/record-access-policy.integration-spec.ts
@@ -6,26 +6,27 @@ import { isDefined } from 'twenty-shared/utils';
import { createOneOperationFactory } from 'test/integration/graphql/utils/create-one-operation-factory.util';
import { destroyOneOperationFactory } from 'test/integration/graphql/utils/destroy-one-operation-factory.util';
import { makeGraphqlApiRequest } from 'test/integration/graphql/utils/make-graphql-api-request.util';
+import { resolveWorkspaceMemberAuthContext } from 'test/integration/utils/resolve-workspace-member-auth-context.util';
import { getAppProviderByClassName } from 'test/integration/utils/get-app-provider-by-class-name.util';
import { findFlatEntityByUniversalIdentifier } from 'src/engine/metadata-modules/flat-entity/utils/find-flat-entity-by-universal-identifier.util';
import { type FlatObjectMetadata } from 'src/engine/metadata-modules/flat-object-metadata/types/flat-object-metadata.type';
import { type RecordAccessPolicyService } from 'src/engine/permissions/combine/services/record-access-policy.service';
-import { type PermissionsPrincipalsContext } from 'src/engine/permissions/principal/types/permissions-principals-context.type';
+import { type PermissionsAuthContext } from 'src/engine/permissions/principal/types/permissions-auth-context.type';
import { type OperationType } from 'src/engine/permissions/role/utils/validate-operation-is-permitted-or-throw.util';
import { type WorkspaceCacheService } from 'src/engine/workspace-cache/services/workspace-cache.service';
import { SEED_APPLE_WORKSPACE_ID } from 'src/engine/workspace-manager/dev-seeder/core/constants/seeder-workspaces.constant';
-import { STANDARD_ROLE } from 'src/engine/workspace-manager/twenty-standard-application/constants/standard-role.constant';
+import { WORKSPACE_MEMBER_DATA_SEED_IDS } from 'src/engine/workspace-manager/dev-seeder/data/constants/workspace-member-data-seeds.constant';
describe('RecordAccessPolicyService', () => {
const recordId = randomUUID();
- let adminPrincipal: PermissionsPrincipalsContext;
+ let adminAuthContext: PermissionsAuthContext;
let personFlatObjectMetadata: FlatObjectMetadata;
let recordAccessPolicyService: RecordAccessPolicyService;
- const missingRolePrincipal: PermissionsPrincipalsContext = {
- workspaceId: SEED_APPLE_WORKSPACE_ID,
- mainPrincipal: { type: 'deprecatedRoleOnly', roleId: randomUUID() },
- applicationPrincipal: { type: 'customApplication' },
+ const missingRoleAuthContext: PermissionsAuthContext = {
+ type: 'apiKey',
+ workspace: { id: SEED_APPLE_WORKSPACE_ID },
+ apiKey: { id: randomUUID() },
};
// Other suites wipe every person, so the record under test is created here
@@ -43,24 +44,16 @@ describe('RecordAccessPolicyService', () => {
expect(response.body.errors).toBeUndefined();
- const { flatRoleMaps, flatObjectMetadataMaps } =
+ const { flatObjectMetadataMaps } =
await getAppProviderByClassName<WorkspaceCacheService>(
'WorkspaceCacheService',
- ).getOrRecompute(SEED_APPLE_WORKSPACE_ID, [
- 'flatRoleMaps',
- 'flatObjectMetadataMaps',
- ]);
+ ).getOrRecompute(SEED_APPLE_WORKSPACE_ID, ['flatObjectMetadataMaps']);
const person = findFlatEntityByUniversalIdentifier({
flatEntityMaps: flatObjectMetadataMaps,
universalIdentifier: STANDARD_OBJECTS.person.universalIdentifier,
});
- const adminRoleId = findFlatEntityByUniversalIdentifier({
- flatEntityMaps: flatRoleMaps,
- universalIdentifier: STANDARD_ROLE.admin.universalIdentifier,
- })?.id;
-
- if (!isDefined(adminRoleId) || !isDefined(person)) {
- throw new Error('The admin role or the person object is not seeded');
+ if (!isDefined(person)) {
+ throw new Error('The person object is not seeded');
}
personFlatObjectMetadata = person;
@@ -69,11 +62,10 @@ describe('RecordAccessPolicyService', () => {
'RecordAccessPolicyService',
);
- adminPrincipal = {
+ adminAuthContext = await resolveWorkspaceMemberAuthContext({
workspaceId: SEED_APPLE_WORKSPACE_ID,
- mainPrincipal: { type: 'deprecatedRoleOnly', roleId: adminRoleId },
- applicationPrincipal: { type: 'customApplication' },
- };
+ workspaceMemberId: WORKSPACE_MEMBER_DATA_SEED_IDS.JANE,
+ });
});
afterAll(async () => {
@@ -87,16 +79,16 @@ describe('RecordAccessPolicyService', () => {
});
const hasAccessToRecords = ({
- principal,
+ authContext,
recordIds,
operationType = 'select',
}: {
- principal: PermissionsPrincipalsContext;
+ authContext: PermissionsAuthContext;
recordIds: string[];
operationType?: OperationType;
}): Promise<boolean> =>
recordAccessPolicyService.hasAccessToRecords({
- principals: principal,
+ authContext,
flatObjectMetadata: personFlatObjectMetadata,
operationType,
recordIds,
@@ -106,23 +98,23 @@ describe('RecordAccessPolicyService', () => {
it('grants a role reading and updating an existing record it permits', async () => {
expect(
await hasAccessToRecords({
- principal: adminPrincipal,
+ authContext: adminAuthContext,
recordIds: [recordId],
}),
).toBe(true);
expect(
await hasAccessToRecords({
- principal: adminPrincipal,
+ authContext: adminAuthContext,
recordIds: [recordId],
operationType: 'update',
}),
).toBe(true);
});
- it('denies a principal whose role does not exist', async () => {
+ it('denies an API key without a role', async () => {
expect(
await hasAccessToRecords({
- principal: missingRolePrincipal,
+ authContext: missingRoleAuthContext,
recordIds: [recordId],
}),
).toBe(false);
@@ -131,7 +123,7 @@ describe('RecordAccessPolicyService', () => {
it('denies when one of the records does not exist', async () => {
expect(
await hasAccessToRecords({
- principal: adminPrincipal,
+ authContext: adminAuthContext,
recordIds: [recordId, randomUUID()],
}),
).toBe(false);
@@ -142,17 +134,17 @@ describe('RecordAccessPolicyService', () => {
it('follows the role when it permits the operation', async () => {
expect(
await recordAccessPolicyService.hasAccessToSomeRecords({
- principals: adminPrincipal,
+ authContext: adminAuthContext,
flatObjectMetadata: personFlatObjectMetadata,
operationType: 'select',
}),
).toBe(true);
});
- it('denies a principal with no role and no share on the object', async () => {
+ it('denies an API key with no role and no share on the object', async () => {
expect(
await recordAccessPolicyService.hasAccessToSomeRecords({
- principals: missingRolePrincipal,
+ authContext: missingRoleAuthContext,
flatObjectMetadata: personFlatObjectMetadata,
operationType: 'select',
}),
diff --git a/packages/twenty-server/test/integration/utils/resolve-workspace-member-auth-context.util.ts b/packages/twenty-server/test/integration/utils/resolve-workspace-member-auth-context.util.ts
new file mode 100644
index 00000000000..c0c96380ac5
--- /dev/null
+++ b/packages/twenty-server/test/integration/utils/resolve-workspace-member-auth-context.util.ts
@@ -0,0 +1,14 @@
+import { getAppProviderByClassName } from 'test/integration/utils/get-app-provider-by-class-name.util';
+
+import { type UserWorkspaceAuthContextService } from 'src/engine/core-modules/user-workspace/services/user-workspace-auth-context.service';
+
+export const resolveWorkspaceMemberAuthContext = ({
+ workspaceId,
+ workspaceMemberId,
+}: {
+ workspaceId: string;
+ workspaceMemberId: string;
+}) =>
+ getAppProviderByClassName<UserWorkspaceAuthContextService>(
+ 'UserWorkspaceAuthContextService',
+ ).resolveWorkspaceMember({ workspaceId, workspaceMemberId });