Skip to content

The open alternative to Salesforce, designed for AI.

feat: add new mixin guard (#26663)

BOHEUS8f5f78950e3f
diff --git a/packages/twenty-server/src/engine/guards/feature-flag.guard.ts b/packages/twenty-server/src/engine/guards/feature-flag.guard.ts
index 2905df2e638..667d6d3eefc 100644
--- a/packages/twenty-server/src/engine/guards/feature-flag.guard.ts
+++ b/packages/twenty-server/src/engine/guards/feature-flag.guard.ts
@@ -3,69 +3,45 @@ import {
type ExecutionContext,
ForbiddenException,
Injectable,
+ mixin,
+ type Type,
} from '@nestjs/common';
-import { Reflector } from '@nestjs/core';
import { GqlExecutionContext } from '@nestjs/graphql';
import { type FeatureFlagKey } from 'twenty-shared/types';
+import { isDefined } from 'twenty-shared/utils';
import { FeatureFlagService } from 'src/engine/core-modules/feature-flag/services/feature-flag.service';
-import { TypedReflect } from 'src/utils/typed-reflect';
-export const FEATURE_FLAG_KEY = 'feature-flag-metadata-args';
+export const FeatureFlagGuard = (
+ featureFlag: FeatureFlagKey,
+): Type<CanActivate> => {
+ @Injectable()
+ class FeatureFlagMixin implements CanActivate {
+ constructor(private readonly featureFlagService: FeatureFlagService) {}
-export function RequireFeatureFlag(featureFlag: FeatureFlagKey) {
- return (
- target: object,
- _propertyKey?: string,
- descriptor?: PropertyDescriptor,
- ) => {
- TypedReflect.defineMetadata(
- FEATURE_FLAG_KEY,
- featureFlag,
- descriptor?.value || target,
- );
+ async canActivate(context: ExecutionContext): Promise<boolean> {
+ const ctx = GqlExecutionContext.create(context);
+ const workspaceId = ctx.getContext().req.workspace?.id;
- return descriptor;
- };
-}
+ if (!isDefined(workspaceId)) {
+ return false;
+ }
-@Injectable()
-export class FeatureFlagGuard implements CanActivate {
- constructor(
- private readonly reflector: Reflector,
- private readonly featureFlagService: FeatureFlagService,
- ) {}
-
- async canActivate(context: ExecutionContext): Promise<boolean> {
- const ctx = GqlExecutionContext.create(context);
- const request = ctx.getContext().req;
- const workspaceId = request.workspace?.id;
-
- if (!workspaceId) {
- return false;
- }
+ const isEnabled = await this.featureFlagService.isFeatureEnabled(
+ featureFlag,
+ workspaceId,
+ );
- const featureFlag = this.reflector.get<FeatureFlagKey>(
- FEATURE_FLAG_KEY,
- context.getHandler(),
- );
+ if (!isEnabled) {
+ throw new ForbiddenException(
+ `Feature flag "${featureFlag}" is not enabled for this workspace`,
+ );
+ }
- if (!featureFlag) {
return true;
}
-
- const isEnabled = await this.featureFlagService.isFeatureEnabled(
- featureFlag,
- workspaceId,
- );
-
- if (!isEnabled) {
- throw new ForbiddenException(
- `Feature flag "${featureFlag}" is not enabled for this workspace`,
- );
- }
-
- return true;
}
-}
+
+ return mixin(FeatureFlagMixin);
+};
diff --git a/packages/twenty-server/src/engine/metadata-modules/logic-function/logic-function.resolver.ts b/packages/twenty-server/src/engine/metadata-modules/logic-function/logic-function.resolver.ts
index 84839453442..aef8e7fefe8 100644
--- a/packages/twenty-server/src/engine/metadata-modules/logic-function/logic-function.resolver.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/logic-function/logic-function.resolver.ts
@@ -28,7 +28,6 @@ import { AuthUser } from 'src/engine/decorators/auth/auth-user.decorator';
import { AuthUserWorkspaceId } from 'src/engine/decorators/auth/auth-user-workspace-id.decorator';
import { AuthWorkspace } from 'src/engine/decorators/auth/auth-workspace.decorator';
import { AllowSuspendedWorkspace } from 'src/engine/decorators/auth/allow-suspended-workspace.decorator';
-import { FeatureFlagGuard } from 'src/engine/guards/feature-flag.guard';
import { NoPermissionGuard } from 'src/engine/guards/no-permission.guard';
import { SettingsPermissionGuard } from 'src/engine/guards/settings-permission.guard';
import { AuthPrincipalGuard } from 'src/engine/guards/auth-principal.guard';
@@ -66,7 +65,6 @@ import { ApplicationTargetGuard } from 'src/engine/guards/application-target.gua
oauthClient: true,
application: true,
}),
- FeatureFlagGuard,
NoPermissionGuard,
)
@MetadataResolver(() => LogicFunctionDTO)
diff --git a/packages/twenty-server/src/engine/metadata-modules/validation-rule/validation-rule.resolver.ts b/packages/twenty-server/src/engine/metadata-modules/validation-rule/validation-rule.resolver.ts
index c5d00be2ed8..ed2de5318cf 100644
--- a/packages/twenty-server/src/engine/metadata-modules/validation-rule/validation-rule.resolver.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/validation-rule/validation-rule.resolver.ts
@@ -15,10 +15,7 @@ import { AuthGraphqlApiExceptionFilter } from 'src/engine/core-modules/auth/filt
import { ResolverValidationPipe } from 'src/engine/core-modules/graphql/pipes/resolver-validation.pipe';
import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
import { AuthWorkspace } from 'src/engine/decorators/auth/auth-workspace.decorator';
-import {
- FeatureFlagGuard,
- RequireFeatureFlag,
-} from 'src/engine/guards/feature-flag.guard';
+import { FeatureFlagGuard } from 'src/engine/guards/feature-flag.guard';
import { NoPermissionGuard } from 'src/engine/guards/no-permission.guard';
import { SettingsPermissionGuard } from 'src/engine/guards/settings-permission.guard';
import { AuthPrincipalGuard } from 'src/engine/guards/auth-principal.guard';
@@ -41,7 +38,6 @@ import { WorkspaceMigrationGraphqlApiExceptionInterceptor } from 'src/engine/wor
oauthClient: true,
application: true,
}),
- FeatureFlagGuard,
)
@UseInterceptors(WorkspaceMigrationGraphqlApiExceptionInterceptor)
@MetadataResolver(() => ValidationRuleDTO)
@@ -54,8 +50,10 @@ export class ValidationRuleResolver {
constructor(private readonly validationRuleService: ValidationRuleService) {}
@Query(() => [ValidationRuleDTO])
- @RequireFeatureFlag(FeatureFlagKey.IS_VALIDATION_RULES_ENABLED)
- @UseGuards(NoPermissionGuard)
+ @UseGuards(
+ FeatureFlagGuard(FeatureFlagKey.IS_VALIDATION_RULES_ENABLED),
+ NoPermissionGuard,
+ )
async validationRules(
@Args('objectMetadataId', { type: () => UUIDScalarType })
objectMetadataId: string,
@@ -68,8 +66,10 @@ export class ValidationRuleResolver {
}
@Mutation(() => ValidationRuleDTO)
- @RequireFeatureFlag(FeatureFlagKey.IS_VALIDATION_RULES_ENABLED)
- @UseGuards(SettingsPermissionGuard(PermissionFlagType.DATA_MODEL))
+ @UseGuards(
+ FeatureFlagGuard(FeatureFlagKey.IS_VALIDATION_RULES_ENABLED),
+ SettingsPermissionGuard(PermissionFlagType.DATA_MODEL),
+ )
async createValidationRule(
@Args('input') input: CreateValidationRuleInput,
@AuthWorkspace() workspace: WorkspaceEntity,
@@ -81,8 +81,10 @@ export class ValidationRuleResolver {
}
@Mutation(() => ValidationRuleDTO)
- @RequireFeatureFlag(FeatureFlagKey.IS_VALIDATION_RULES_ENABLED)
- @UseGuards(SettingsPermissionGuard(PermissionFlagType.DATA_MODEL))
+ @UseGuards(
+ FeatureFlagGuard(FeatureFlagKey.IS_VALIDATION_RULES_ENABLED),
+ SettingsPermissionGuard(PermissionFlagType.DATA_MODEL),
+ )
async updateValidationRule(
@Args('input') input: UpdateValidationRuleInput,
@AuthWorkspace() workspace: WorkspaceEntity,
@@ -94,8 +96,10 @@ export class ValidationRuleResolver {
}
@Mutation(() => ValidationRuleDTO)
- @RequireFeatureFlag(FeatureFlagKey.IS_VALIDATION_RULES_ENABLED)
- @UseGuards(SettingsPermissionGuard(PermissionFlagType.DATA_MODEL))
+ @UseGuards(
+ FeatureFlagGuard(FeatureFlagKey.IS_VALIDATION_RULES_ENABLED),
+ SettingsPermissionGuard(PermissionFlagType.DATA_MODEL),
+ )
async deleteValidationRule(
@Args('id', { type: () => UUIDScalarType }) id: string,
@AuthWorkspace() workspace: WorkspaceEntity,
diff --git a/packages/twenty-server/src/modules/emailing/resolvers/emailing-send.resolver.ts b/packages/twenty-server/src/modules/emailing/resolvers/emailing-send.resolver.ts
index 882fb852d8f..395c215db44 100644
--- a/packages/twenty-server/src/modules/emailing/resolvers/emailing-send.resolver.ts
+++ b/packages/twenty-server/src/modules/emailing/resolvers/emailing-send.resolver.ts
@@ -28,10 +28,7 @@ import { type UsageSpenders } from 'src/engine/core-modules/usage/types/usage-sp
import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
import { AuthUserWorkspaceId } from 'src/engine/decorators/auth/auth-user-workspace-id.decorator';
import { AuthWorkspace } from 'src/engine/decorators/auth/auth-workspace.decorator';
-import {
- FeatureFlagGuard,
- RequireFeatureFlag,
-} from 'src/engine/guards/feature-flag.guard';
+import { FeatureFlagGuard } from 'src/engine/guards/feature-flag.guard';
import { SettingsPermissionGuard } from 'src/engine/guards/settings-permission.guard';
import { AuthPrincipalGuard } from 'src/engine/guards/auth-principal.guard';
import { ThrottlerGraphqlApiExceptionFilter } from 'src/engine/core-modules/throttler/filters/throttler-graphql-api-exception.filter';
@@ -56,7 +53,6 @@ import { AuthGraphqlApiExceptionFilter } from 'src/engine/core-modules/auth/filt
oauthClient: true,
application: true,
}),
- FeatureFlagGuard,
SettingsPermissionGuard(PermissionFlagType.WORKSPACE),
)
@UseFilters(
@@ -82,7 +78,7 @@ export class EmailingSendResolver {
) {}
@Mutation(() => SendMessageCampaignOutputDTO)
- @RequireFeatureFlag(FeatureFlagKey.IS_MESSAGE_CAMPAIGN_ENABLED)
+ @UseGuards(FeatureFlagGuard(FeatureFlagKey.IS_MESSAGE_CAMPAIGN_ENABLED))
async sendMessageCampaign(
@Args('input') input: SendMessageCampaignInput,
@AuthWorkspace() currentWorkspace: WorkspaceEntity,
@@ -123,7 +119,7 @@ export class EmailingSendResolver {
}
@Mutation(() => CancelMessageCampaignOutputDTO)
- @RequireFeatureFlag(FeatureFlagKey.IS_MESSAGE_CAMPAIGN_ENABLED)
+ @UseGuards(FeatureFlagGuard(FeatureFlagKey.IS_MESSAGE_CAMPAIGN_ENABLED))
async cancelMessageCampaign(
@Args('input') input: CancelMessageCampaignInput,
@AuthWorkspace() currentWorkspace: WorkspaceEntity,
@@ -139,7 +135,7 @@ export class EmailingSendResolver {
}
@Mutation(() => SendEmailViaDomainOutputDTO)
- @RequireFeatureFlag(FeatureFlagKey.IS_MESSAGE_CAMPAIGN_ENABLED)
+ @UseGuards(FeatureFlagGuard(FeatureFlagKey.IS_MESSAGE_CAMPAIGN_ENABLED))
async sendMessageCampaignTest(
@Args('input') input: SendMessageCampaignTestInput,
@AuthWorkspace() currentWorkspace: WorkspaceEntity,
@@ -171,7 +167,7 @@ export class EmailingSendResolver {
}
@Query(() => CampaignAudiencePreviewDTO)
- @RequireFeatureFlag(FeatureFlagKey.IS_MESSAGE_CAMPAIGN_ENABLED)
+ @UseGuards(FeatureFlagGuard(FeatureFlagKey.IS_MESSAGE_CAMPAIGN_ENABLED))
async previewMessageCampaignAudience(
@Args('input') input: PreviewMessageCampaignAudienceInput,
@AuthWorkspace() currentWorkspace: WorkspaceEntity,
diff --git a/packages/twenty-server/src/modules/emailing/resolvers/message-list.resolver.ts b/packages/twenty-server/src/modules/emailing/resolvers/message-list.resolver.ts
index 2a504661b73..2e79d246946 100644
--- a/packages/twenty-server/src/modules/emailing/resolvers/message-list.resolver.ts
+++ b/packages/twenty-server/src/modules/emailing/resolvers/message-list.resolver.ts
@@ -10,10 +10,7 @@ import { AuthGraphqlApiExceptionFilter } from 'src/engine/core-modules/auth/filt
import { ResolverValidationPipe } from 'src/engine/core-modules/graphql/pipes/resolver-validation.pipe';
import { AuthUserWorkspaceId } from 'src/engine/decorators/auth/auth-user-workspace-id.decorator';
import { NoPermissionGuard } from 'src/engine/guards/no-permission.guard';
-import {
- FeatureFlagGuard,
- RequireFeatureFlag,
-} from 'src/engine/guards/feature-flag.guard';
+import { FeatureFlagGuard } from 'src/engine/guards/feature-flag.guard';
import { AuthPrincipalGuard } from 'src/engine/guards/auth-principal.guard';
import { PermissionsGraphqlApiExceptionFilter } from 'src/engine/metadata-modules/permissions/utils/permissions-graphql-api-exception.filter';
import { DuplicatedMessageListDTO } from 'src/modules/emailing/dtos/duplicated-message-list.dto';
@@ -39,7 +36,7 @@ import { MessageListGraphqlApiExceptionFilter } from 'src/modules/emailing/utils
oauthClient: true,
application: true,
}),
- FeatureFlagGuard,
+ FeatureFlagGuard(FeatureFlagKey.IS_MESSAGE_CAMPAIGN_ENABLED),
)
@UsePipes(ResolverValidationPipe)
export class MessageListResolver {
@@ -49,7 +46,6 @@ export class MessageListResolver {
@Mutation(() => DuplicatedMessageListDTO)
@UseGuards(NoPermissionGuard)
- @RequireFeatureFlag(FeatureFlagKey.IS_MESSAGE_CAMPAIGN_ENABLED)
async duplicateMessageList(
@Args('id', { type: () => UUIDScalarType }) id: string,
@AuthUserWorkspaceId() userWorkspaceId: string,
diff --git a/packages/twenty-server/src/modules/emailing/resolvers/message-suppression.resolver.ts b/packages/twenty-server/src/modules/emailing/resolvers/message-suppression.resolver.ts
index b28224f21b3..10f8363dc0d 100644
--- a/packages/twenty-server/src/modules/emailing/resolvers/message-suppression.resolver.ts
+++ b/packages/twenty-server/src/modules/emailing/resolvers/message-suppression.resolver.ts
@@ -18,10 +18,7 @@ import { EmailGroupAccessService } from 'src/engine/core-modules/emailing-domain
import { ResolverValidationPipe } from 'src/engine/core-modules/graphql/pipes/resolver-validation.pipe';
import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
import { AuthWorkspace } from 'src/engine/decorators/auth/auth-workspace.decorator';
-import {
- FeatureFlagGuard,
- RequireFeatureFlag,
-} from 'src/engine/guards/feature-flag.guard';
+import { FeatureFlagGuard } from 'src/engine/guards/feature-flag.guard';
import { SettingsPermissionGuard } from 'src/engine/guards/settings-permission.guard';
import { AuthPrincipalGuard } from 'src/engine/guards/auth-principal.guard';
import { MessageSuppressionService } from 'src/modules/emailing/services/message-suppression.service';
@@ -39,7 +36,7 @@ import { AuthGraphqlApiExceptionFilter } from 'src/engine/core-modules/auth/filt
oauthClient: true,
application: true,
}),
- FeatureFlagGuard,
+ FeatureFlagGuard(FeatureFlagKey.IS_MESSAGE_CAMPAIGN_ENABLED),
SettingsPermissionGuard(PermissionFlagType.WORKSPACE),
)
@UseFilters(
@@ -56,7 +53,6 @@ export class MessageSuppressionResolver {
) {}
@Query(() => MessageSuppressionListDTO)
- @RequireFeatureFlag(FeatureFlagKey.IS_MESSAGE_CAMPAIGN_ENABLED)
async messageSuppressions(
@Args('input') input: FindMessageSuppressionsInput,
@AuthWorkspace() currentWorkspace: WorkspaceEntity,
@@ -74,7 +70,6 @@ export class MessageSuppressionResolver {
}
@Mutation(() => MessageSuppressionDTO)
- @RequireFeatureFlag(FeatureFlagKey.IS_MESSAGE_CAMPAIGN_ENABLED)
async createMessageSuppression(
@Args('input') input: CreateMessageSuppressionInput,
@AuthWorkspace() currentWorkspace: WorkspaceEntity,
@@ -89,7 +84,6 @@ export class MessageSuppressionResolver {
}
@Mutation(() => Boolean)
- @RequireFeatureFlag(FeatureFlagKey.IS_MESSAGE_CAMPAIGN_ENABLED)
async deleteMessageSuppression(
@Args('id', { type: () => UUIDScalarType }) suppressionId: string,
@AuthWorkspace() currentWorkspace: WorkspaceEntity,
diff --git a/packages/twenty-server/src/modules/emailing/resolvers/unsubscribe-topic.resolver.ts b/packages/twenty-server/src/modules/emailing/resolvers/unsubscribe-topic.resolver.ts
index de1cc4f48db..672b916ded0 100644
--- a/packages/twenty-server/src/modules/emailing/resolvers/unsubscribe-topic.resolver.ts
+++ b/packages/twenty-server/src/modules/emailing/resolvers/unsubscribe-topic.resolver.ts
@@ -13,10 +13,7 @@ import { EmailGroupAccessService } from 'src/engine/core-modules/emailing-domain
import { ResolverValidationPipe } from 'src/engine/core-modules/graphql/pipes/resolver-validation.pipe';
import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
import { AuthWorkspace } from 'src/engine/decorators/auth/auth-workspace.decorator';
-import {
- FeatureFlagGuard,
- RequireFeatureFlag,
-} from 'src/engine/guards/feature-flag.guard';
+import { FeatureFlagGuard } from 'src/engine/guards/feature-flag.guard';
import { SettingsPermissionGuard } from 'src/engine/guards/settings-permission.guard';
import { AuthPrincipalGuard } from 'src/engine/guards/auth-principal.guard';
import { UnsubscribeTopicService } from 'src/modules/emailing/services/unsubscribe-topic.service';
@@ -34,7 +31,7 @@ import { AuthGraphqlApiExceptionFilter } from 'src/engine/core-modules/auth/filt
oauthClient: true,
application: true,
}),
- FeatureFlagGuard,
+ FeatureFlagGuard(FeatureFlagKey.IS_MESSAGE_CAMPAIGN_ENABLED),
SettingsPermissionGuard(PermissionFlagType.WORKSPACE),
)
@UseFilters(
@@ -50,7 +47,6 @@ export class UnsubscribeTopicResolver {
) {}
@Query(() => [UnsubscribeTopicDTO])
- @RequireFeatureFlag(FeatureFlagKey.IS_MESSAGE_CAMPAIGN_ENABLED)
async unsubscribeTopics(
@AuthWorkspace() currentWorkspace: WorkspaceEntity,
): Promise<UnsubscribeTopicDTO[]> {
@@ -62,7 +58,6 @@ export class UnsubscribeTopicResolver {
}
@Mutation(() => UnsubscribeTopicDTO)
- @RequireFeatureFlag(FeatureFlagKey.IS_MESSAGE_CAMPAIGN_ENABLED)
async createUnsubscribeTopic(
@Args('input') input: CreateUnsubscribeTopicInput,
@AuthWorkspace() currentWorkspace: WorkspaceEntity,
@@ -76,7 +71,6 @@ export class UnsubscribeTopicResolver {
}
@Mutation(() => UnsubscribeTopicDTO)
- @RequireFeatureFlag(FeatureFlagKey.IS_MESSAGE_CAMPAIGN_ENABLED)
async updateUnsubscribeTopic(
@Args('input') input: UpdateUnsubscribeTopicInput,
@AuthWorkspace() currentWorkspace: WorkspaceEntity,
@@ -90,7 +84,6 @@ export class UnsubscribeTopicResolver {
}
@Mutation(() => Boolean)
- @RequireFeatureFlag(FeatureFlagKey.IS_MESSAGE_CAMPAIGN_ENABLED)
async deleteUnsubscribeTopic(
@Args('id') id: string,
@AuthWorkspace() currentWorkspace: WorkspaceEntity,
diff --git a/packages/twenty-server/test/integration/metadata/suites/emailing/message-suppression.integration-spec.ts b/packages/twenty-server/test/integration/metadata/suites/emailing/message-suppression.integration-spec.ts
index 2ad90b2aede..970678cdec8 100644
--- a/packages/twenty-server/test/integration/metadata/suites/emailing/message-suppression.integration-spec.ts
+++ b/packages/twenty-server/test/integration/metadata/suites/emailing/message-suppression.integration-spec.ts
@@ -167,6 +167,32 @@ describe('messageSuppressionResolver (integration)', () => {
});
});
+ it('should refuse the list query when message campaigns are disabled for the workspace', async () => {
+ await updateFeatureFlag({
+ featureFlag: FeatureFlagKey.IS_MESSAGE_CAMPAIGN_ENABLED,
+ value: false,
+ expectToFail: false,
+ });
+
+ try {
+ const listResponse = await makeMetadataApiRequest({
+ query: MESSAGE_SUPPRESSIONS,
+ variables: { input: { searchTerm: '', limit: 30, offset: 0 } },
+ });
+
+ expect(listResponse.body.data).toBeNull();
+ expect(listResponse.body.errors[0].message).toBe(
+ `Feature flag "${FeatureFlagKey.IS_MESSAGE_CAMPAIGN_ENABLED}" is not enabled for this workspace`,
+ );
+ } finally {
+ await updateFeatureFlag({
+ featureFlag: FeatureFlagKey.IS_MESSAGE_CAMPAIGN_ENABLED,
+ value: true,
+ expectToFail: false,
+ });
+ }
+ });
+
it('should fail when the suppression does not exist', async () => {
const deleteResponse = await makeMetadataApiRequest({
query: DELETE_MESSAGE_SUPPRESSION,