Skip to content

The open alternative to Salesforce, designed for AI.

Run app health checks in their configured execution mode (#29250)

nitin48d0872ab4a0
diff --git a/packages/twenty-client-sdk/src/metadata/generated/schema.graphql b/packages/twenty-client-sdk/src/metadata/generated/schema.graphql
index 383e3ffb4fb..86007cfb050 100644
--- a/packages/twenty-client-sdk/src/metadata/generated/schema.graphql
+++ b/packages/twenty-client-sdk/src/metadata/generated/schema.graphql
@@ -449,6 +449,7 @@ type Application {
objects: [Object!]!
packageJsonChecksum: String
packageJsonFileId: UUID
+ runOnUserPreferences: Boolean!
settingsCustomTabFrontComponentId: UUID
settingsMenuItems: [SettingsMenuItem!]
universalIdentifier: String!
@@ -663,6 +664,7 @@ type ApplicationMonitoringVersion {
type ApplicationPreferences {
applicationId: UUID!
connectionProviders: [ApplicationConnectionProvider!]!
+ hasUserHealthCheck: Boolean!
settingsMenuItems: [SettingsMenuItem!]!
variables: [UserApplicationVariableValue!]!
}
@@ -3409,6 +3411,7 @@ type Mutation {
rotateApplicationRegistrationClientSecret(id: String!): RotateClientSecret!
runAgent(input: RunAgentInput!): RunAgentResult!
runApplicationHealthCheck(applicationId: UUID!): ApplicationHealthCheckResult
+ runMyApplicationHealthCheck(applicationId: UUID!): ApplicationHealthCheckResult
saveImapSmtpCaldavAccount(connectionParameters: EmailAccountConnectionParameters!, handle: String!, id: UUID): ImapSmtpCaldavConnectionSuccess!
sendAppChannelMessage(input: SendAppChannelMessageInput!): SendAppChannelMessageOutput!
sendChatMessage(browsingContext: JSON, channelId: UUID, fileAttachments: [FileAttachmentInput!], mentionedWorkspaceMemberIds: [UUID!], messageId: UUID!, modelId: String, shouldAssistantReply: Boolean, text: String!, threadId: UUID!): SendChatMessageResult!
diff --git a/packages/twenty-client-sdk/src/metadata/generated/schema.ts b/packages/twenty-client-sdk/src/metadata/generated/schema.ts
index 27377a13677..33cb3025ee5 100644
--- a/packages/twenty-client-sdk/src/metadata/generated/schema.ts
+++ b/packages/twenty-client-sdk/src/metadata/generated/schema.ts
@@ -356,6 +356,7 @@ export interface Application {
objects: Object[]
packageJsonChecksum?: Scalars['String']
packageJsonFileId?: Scalars['UUID']
+ runOnUserPreferences: Scalars['Boolean']
settingsCustomTabFrontComponentId?: Scalars['UUID']
settingsMenuItems?: SettingsMenuItem[]
universalIdentifier: Scalars['String']
@@ -574,6 +575,7 @@ export interface ApplicationMonitoringVersion {
export interface ApplicationPreferences {
applicationId: Scalars['UUID']
connectionProviders: ApplicationConnectionProvider[]
+ hasUserHealthCheck: Scalars['Boolean']
settingsMenuItems: SettingsMenuItem[]
variables: UserApplicationVariableValue[]
__typename: 'ApplicationPreferences'
@@ -2414,6 +2416,7 @@ export interface Mutation {
rotateApplicationRegistrationClientSecret: RotateClientSecret
runAgent: RunAgentResult
runApplicationHealthCheck?: ApplicationHealthCheckResult
+ runMyApplicationHealthCheck?: ApplicationHealthCheckResult
saveImapSmtpCaldavAccount: ImapSmtpCaldavConnectionSuccess
sendAppChannelMessage: SendAppChannelMessageOutput
sendChatMessage: SendChatMessageResult
@@ -4591,6 +4594,7 @@ export interface ApplicationGenqlSelection{
objects?: ObjectGenqlSelection
packageJsonChecksum?: boolean | number
packageJsonFileId?: boolean | number
+ runOnUserPreferences?: boolean | number
settingsCustomTabFrontComponentId?: boolean | number
settingsMenuItems?: SettingsMenuItemGenqlSelection
universalIdentifier?: boolean | number
@@ -4829,6 +4833,7 @@ export interface ApplicationMonitoringVersionGenqlSelection{
export interface ApplicationPreferencesGenqlSelection{
applicationId?: boolean | number
connectionProviders?: ApplicationConnectionProviderGenqlSelection
+ hasUserHealthCheck?: boolean | number
settingsMenuItems?: SettingsMenuItemGenqlSelection
variables?: UserApplicationVariableValueGenqlSelection
__typename?: boolean | number
@@ -6931,6 +6936,7 @@ export interface MutationGenqlSelection{
rotateApplicationRegistrationClientSecret?: (RotateClientSecretGenqlSelection & { __args: {id: Scalars['String']} })
runAgent?: (RunAgentResultGenqlSelection & { __args: {input: RunAgentInput} })
runApplicationHealthCheck?: (ApplicationHealthCheckResultGenqlSelection & { __args: {applicationId: Scalars['UUID']} })
+ runMyApplicationHealthCheck?: (ApplicationHealthCheckResultGenqlSelection & { __args: {applicationId: Scalars['UUID']} })
saveImapSmtpCaldavAccount?: (ImapSmtpCaldavConnectionSuccessGenqlSelection & { __args: {connectionParameters: EmailAccountConnectionParameters, handle: Scalars['String'], id?: (Scalars['UUID'] | null)} })
sendAppChannelMessage?: (SendAppChannelMessageOutputGenqlSelection & { __args: {input: SendAppChannelMessageInput} })
sendChatMessage?: (SendChatMessageResultGenqlSelection & { __args: {browsingContext?: (Scalars['JSON'] | null), channelId?: (Scalars['UUID'] | null), fileAttachments?: (FileAttachmentInput[] | null), mentionedWorkspaceMemberIds?: (Scalars['UUID'][] | null), messageId: Scalars['UUID'], modelId?: (Scalars['String'] | null), shouldAssistantReply?: (Scalars['Boolean'] | null), text: Scalars['String'], threadId: Scalars['UUID']} })
diff --git a/packages/twenty-client-sdk/src/metadata/generated/types.ts b/packages/twenty-client-sdk/src/metadata/generated/types.ts
index f0d8a888b3d..6c6bea50d72 100644
--- a/packages/twenty-client-sdk/src/metadata/generated/types.ts
+++ b/packages/twenty-client-sdk/src/metadata/generated/types.ts
@@ -997,6 +997,9 @@ export default {
"packageJsonFileId": [
525
],
+ "runOnUserPreferences": [
+ 4
+ ],
"settingsCustomTabFrontComponentId": [
525
],
@@ -1495,6 +1498,9 @@ export default {
"connectionProviders": [
50
],
+ "hasUserHealthCheck": [
+ 4
+ ],
"settingsMenuItems": [
484
],
@@ -8343,6 +8349,15 @@ export default {
]
}
],
+ "runMyApplicationHealthCheck": [
+ 62,
+ {
+ "applicationId": [
+ 525,
+ "UUID!"
+ ]
+ }
+ ],
"saveImapSmtpCaldavAccount": [
299,
{
diff --git a/packages/twenty-front/src/generated-metadata/schema.ts b/packages/twenty-front/src/generated-metadata/schema.ts
index fe00d5ecc24..0ac61673c04 100644
--- a/packages/twenty-front/src/generated-metadata/schema.ts
+++ b/packages/twenty-front/src/generated-metadata/schema.ts
@@ -492,6 +492,7 @@ export type Application = {
objects: Array<Object>;
packageJsonChecksum?: Maybe<Scalars['String']['output']>;
packageJsonFileId?: Maybe<Scalars['UUID']['output']>;
+ runOnUserPreferences: Scalars['Boolean']['output'];
settingsCustomTabFrontComponentId?: Maybe<Scalars['UUID']['output']>;
settingsMenuItems?: Maybe<Array<SettingsMenuItem>>;
universalIdentifier: Scalars['String']['output'];
@@ -730,6 +731,7 @@ export type ApplicationPreferences = {
__typename?: 'ApplicationPreferences';
applicationId: Scalars['UUID']['output'];
connectionProviders: Array<ApplicationConnectionProvider>;
+ hasUserHealthCheck: Scalars['Boolean']['output'];
settingsMenuItems: Array<SettingsMenuItem>;
variables: Array<UserApplicationVariableValue>;
};
@@ -3590,6 +3592,7 @@ export type Mutation = {
rotateApplicationRegistrationClientSecret: RotateClientSecret;
runAgent: RunAgentResult;
runApplicationHealthCheck?: Maybe<ApplicationHealthCheckResult>;
+ runMyApplicationHealthCheck?: Maybe<ApplicationHealthCheckResult>;
saveImapSmtpCaldavAccount: ImapSmtpCaldavConnectionSuccess;
sendAppChannelMessage: SendAppChannelMessageOutput;
sendChatMessage: SendChatMessageResult;
@@ -4607,6 +4610,11 @@ export type MutationRunApplicationHealthCheckArgs = {
};
+export type MutationRunMyApplicationHealthCheckArgs = {
+ applicationId: Scalars['UUID']['input'];
+};
+
+
export type MutationSaveImapSmtpCaldavAccountArgs = {
connectionParameters: EmailAccountConnectionParameters;
handle: Scalars['String']['input'];
diff --git a/packages/twenty-front/src/modules/object-metadata/hooks/__tests__/constants/CustomWorkspaceApplicationMock.test.constant.ts b/packages/twenty-front/src/modules/object-metadata/hooks/__tests__/constants/CustomWorkspaceApplicationMock.test.constant.ts
index 95413e61392..1ba15ded38d 100644
--- a/packages/twenty-front/src/modules/object-metadata/hooks/__tests__/constants/CustomWorkspaceApplicationMock.test.constant.ts
+++ b/packages/twenty-front/src/modules/object-metadata/hooks/__tests__/constants/CustomWorkspaceApplicationMock.test.constant.ts
@@ -11,6 +11,7 @@ export const CUSTOM_WORKSPACE_APPLICATION_MOCK = {
canBeUninstalled: false,
isUninstallBlockedByOtherWorkspaceInstallations: false,
autoUpgrade: false,
+ runOnUserPreferences: false,
createdAt: '2024-01-01T00:00:00.000Z',
description: 'workpace custom application',
name: 'custom',
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-health/application-health-check.service.ts b/packages/twenty-server/src/engine/core-modules/application/application-health/application-health-check.service.ts
index f597aa869cd..a7a278df6c6 100644
--- a/packages/twenty-server/src/engine/core-modules/application/application-health/application-health-check.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/application-health/application-health-check.service.ts
@@ -6,9 +6,16 @@ import {
} from 'twenty-shared/application';
import { isDefined } from 'twenty-shared/utils';
+import {
+ USER_HEALTH_CHECK_RATE_LIMIT_MAX,
+ USER_HEALTH_CHECK_RATE_LIMIT_WINDOW_MS,
+} from 'src/engine/core-modules/application/application-health/constants/user-health-check-rate-limit.constant';
+import { buildUserHealthCheckRateLimitKey } from 'src/engine/core-modules/application/application-health/utils/build-user-health-check-rate-limit-key.util';
+import { getHealthCheckLogicFunctionIdForUser } from 'src/engine/core-modules/application/application-health/utils/get-health-check-logic-function-id-for-user.util';
import { ApplicationService } from 'src/engine/core-modules/application/application.service';
import { type ApplicationHealthCheckResultDTO } from 'src/engine/core-modules/application/dtos/application-health-check-result.dto';
import { LogicFunctionExecutorService } from 'src/engine/core-modules/logic-function/logic-function-executor/logic-function-executor.service';
+import { ThrottlerService } from 'src/engine/core-modules/throttler/throttler.service';
const UNKNOWN_HEALTH: ApplicationHealthCheckResultDTO = {
status: ApplicationHealthStatus.UNKNOWN,
@@ -22,6 +29,7 @@ export class ApplicationHealthCheckService {
constructor(
private readonly applicationService: ApplicationService,
private readonly logicFunctionExecutorService: LogicFunctionExecutorService,
+ private readonly throttlerService: ThrottlerService,
) {}
async run({
@@ -54,18 +62,67 @@ export class ApplicationHealthCheckService {
});
}
+ async runForUser({
+ applicationId,
+ workspaceId,
+ userId,
+ userWorkspaceId,
+ }: {
+ applicationId: string;
+ workspaceId: string;
+ userId: string;
+ userWorkspaceId: string;
+ }): Promise<ApplicationHealthCheckResultDTO | null> {
+ const application = await this.applicationService.findOneApplicationOrThrow(
+ {
+ id: applicationId,
+ workspaceId,
+ },
+ );
+ const healthCheckLogicFunctionId =
+ getHealthCheckLogicFunctionIdForUser(application);
+
+ if (!isDefined(healthCheckLogicFunctionId)) {
+ return null;
+ }
+
+ await this.throttlerService.tokenBucketThrottleOrThrow(
+ buildUserHealthCheckRateLimitKey({
+ workspaceId,
+ userWorkspaceId,
+ applicationId: application.id,
+ }),
+ 1,
+ USER_HEALTH_CHECK_RATE_LIMIT_MAX,
+ USER_HEALTH_CHECK_RATE_LIMIT_WINDOW_MS,
+ );
+
+ return await this.executeHealthCheck({
+ healthCheckLogicFunctionId,
+ workspaceId,
+ userId,
+ userWorkspaceId,
+ });
+ }
+
private async executeHealthCheck({
healthCheckLogicFunctionId,
workspaceId,
+ userId,
+ userWorkspaceId,
}: {
healthCheckLogicFunctionId: string;
workspaceId: string;
+ userId?: string;
+ userWorkspaceId?: string;
}): Promise<ApplicationHealthCheckResultDTO> {
const executionResult = await this.logicFunctionExecutorService
.execute({
logicFunctionId: healthCheckLogicFunctionId,
workspaceId,
- payload: {},
+ payload: isDefined(userWorkspaceId) ? { userWorkspaceId } : {},
+ userId,
+ userWorkspaceId,
})
.catch(() => null);
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-health/application-health.module.ts b/packages/twenty-server/src/engine/core-modules/application/application-health/application-health.module.ts
index 4d3b6ce46ee..6f209ec0930 100644
--- a/packages/twenty-server/src/engine/core-modules/application/application-health/application-health.module.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/application-health/application-health.module.ts
@@ -7,6 +7,7 @@ import { PermissionsModule } from 'src/engine/permissions/permissions.module';
import { WorkspaceManyOrAllFlatEntityMapsCacheModule } from 'src/engine/metadata-modules/flat-entity/services/workspace-many-or-all-flat-entity-maps-cache.module';
import { ApplicationLookupModule } from 'src/engine/core-modules/application/application-lookup/application-lookup.module';
import { ApplicationRegistrationLookupModule } from 'src/engine/core-modules/application/application-registration/application-registration-lookup/application-registration-lookup.module';
+import { ThrottlerModule } from 'src/engine/core-modules/throttler/throttler.module';
@Module({
imports: [
@@ -14,8 +15,10 @@ import { ApplicationRegistrationLookupModule } from 'src/engine/core-modules/app
ApplicationRegistrationLookupModule,
ApplicationModule,
PermissionsModule,
+ ThrottlerModule,
WorkspaceManyOrAllFlatEntityMapsCacheModule,
],
providers: [ApplicationHealthCheckService, ApplicationHealthResolver],
+ exports: [ApplicationHealthCheckService],
})
export class ApplicationHealthModule {}
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-health/constants/user-health-check-rate-limit.constant.ts b/packages/twenty-server/src/engine/core-modules/application/application-health/constants/user-health-check-rate-limit.constant.ts
new file mode 100644
index 00000000000..63aa62ba611
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/application/application-health/constants/user-health-check-rate-limit.constant.ts
@@ -0,0 +1,2 @@
+export const USER_HEALTH_CHECK_RATE_LIMIT_MAX = 10;
+export const USER_HEALTH_CHECK_RATE_LIMIT_WINDOW_MS = 60 * 1000;
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-health/utils/build-user-health-check-rate-limit-key.util.ts b/packages/twenty-server/src/engine/core-modules/application/application-health/utils/build-user-health-check-rate-limit-key.util.ts
new file mode 100644
index 00000000000..95d3f785239
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/application/application-health/utils/build-user-health-check-rate-limit-key.util.ts
@@ -0,0 +1,10 @@
+export const buildUserHealthCheckRateLimitKey = ({
+ workspaceId,
+ userWorkspaceId,
+ applicationId,
+}: {
+ workspaceId: string;
+ userWorkspaceId: string;
+ applicationId: string;
+}): string =>
+ `user-health-check:${workspaceId}:${userWorkspaceId}:${applicationId}`;
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-health/utils/get-health-check-logic-function-id-for-user.util.spec.ts b/packages/twenty-server/src/engine/core-modules/application/application-health/utils/get-health-check-logic-function-id-for-user.util.spec.ts
new file mode 100644
index 00000000000..9eeee4f860b
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/application/application-health/utils/get-health-check-logic-function-id-for-user.util.spec.ts
@@ -0,0 +1,42 @@
+import { getHealthCheckLogicFunctionIdForUser } from 'src/engine/core-modules/application/application-health/utils/get-health-check-logic-function-id-for-user.util';
+
+const HEALTH_CHECK_LOGIC_FUNCTION_ID = 'health-check-logic-function-id';
+
+describe('getHealthCheckLogicFunctionIdForUser', () => {
+ it('returns the existing function when member execution is enabled', () => {
+ expect(
+ getHealthCheckLogicFunctionIdForUser({
+ healthCheckLogicFunctionId: HEALTH_CHECK_LOGIC_FUNCTION_ID,
+ isUserHealthCheckEnabled: true,
+ }),
+ ).toBe(HEALTH_CHECK_LOGIC_FUNCTION_ID);
+ });
+
+ it.each([false, undefined])(
+ 'does not expose a function when member opt-in is %s',
+ (isUserHealthCheckEnabled) => {
+ expect(
+ getHealthCheckLogicFunctionIdForUser({
+ healthCheckLogicFunctionId: HEALTH_CHECK_LOGIC_FUNCTION_ID,
+ isUserHealthCheckEnabled,
+ }),
+ ).toBeNull();
+ },
+ );
+
+ it.each([null, undefined])(
+ 'does not expose a missing function (%s) even when opted in',
+ (healthCheckLogicFunctionId) => {
+ expect(
+ getHealthCheckLogicFunctionIdForUser({
+ healthCheckLogicFunctionId,
+ isUserHealthCheckEnabled: true,
+ }),
+ ).toBeNull();
+ },
+ );
+
+ it('keeps an unavailable declaration workspace-only', () => {
+ expect(getHealthCheckLogicFunctionIdForUser({})).toBeNull();
+ });
+});
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-health/utils/get-health-check-logic-function-id-for-user.util.ts b/packages/twenty-server/src/engine/core-modules/application/application-health/utils/get-health-check-logic-function-id-for-user.util.ts
new file mode 100644
index 00000000000..4acde556d1a
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/application/application-health/utils/get-health-check-logic-function-id-for-user.util.ts
@@ -0,0 +1,19 @@
+import { isDefined } from 'twenty-shared/utils';
+
+import { type ApplicationEntity } from 'src/engine/core-modules/application/application.entity';
+
+export const getHealthCheckLogicFunctionIdForUser = ({
+ healthCheckLogicFunctionId,
+ isUserHealthCheckEnabled,
+}: Partial<
+ Pick<
+ ApplicationEntity,
+ 'healthCheckLogicFunctionId' | 'isUserHealthCheckEnabled'
+ >
+>): string | null => {
+ if (!isUserHealthCheckEnabled || !isDefined(healthCheckLogicFunctionId)) {
+ return null;
+ }
+
+ return healthCheckLogicFunctionId;
+};
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-preferences/application-preferences.module.ts b/packages/twenty-server/src/engine/core-modules/application/application-preferences/application-preferences.module.ts
index ff6305074d7..33910cc94db 100644
--- a/packages/twenty-server/src/engine/core-modules/application/application-preferences/application-preferences.module.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/application-preferences/application-preferences.module.ts
@@ -1,5 +1,6 @@
import { Module } from '@nestjs/common';
+import { ApplicationHealthModule } from 'src/engine/core-modules/application/application-health/application-health.module';
import { ApplicationPreferencesResolver } from 'src/engine/core-modules/application/application-preferences/application-preferences.resolver';
import { ApplicationPreferencesService } from 'src/engine/core-modules/application/application-preferences/application-preferences.service';
import { ApplicationVariableEntityModule } from 'src/engine/core-modules/application/application-variable/application-variable.module';
@@ -10,6 +11,7 @@ import { WorkspaceCacheModule } from 'src/engine/workspace-cache/workspace-cache
@Module({
imports: [
+ ApplicationHealthModule,
ApplicationModule,
ApplicationVariableEntityModule,
ConnectionProviderModule,
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-preferences/application-preferences.resolver.ts b/packages/twenty-server/src/engine/core-modules/application/application-preferences/application-preferences.resolver.ts
index e62bf3736e4..4a09ba77904 100644
--- a/packages/twenty-server/src/engine/core-modules/application/application-preferences/application-preferences.resolver.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/application-preferences/application-preferences.resolver.ts
@@ -1,13 +1,20 @@
import { UseFilters, UseGuards } from '@nestjs/common';
-import { Query } from '@nestjs/graphql';
+import { Args, Mutation, Query } from '@nestjs/graphql';
import { PermissionFlagType } from 'twenty-shared/constants';
import { MetadataResolver } from 'src/engine/api/graphql/graphql-config/decorators/metadata-resolver.decorator';
+import { UUIDScalarType } from 'src/engine/api/graphql/workspace-schema-builder/graphql-types/scalars';
+import { ApplicationExceptionFilter } from 'src/engine/core-modules/application/application-exception-filter';
+import { ApplicationHealthCheckService } from 'src/engine/core-modules/application/application-health/application-health-check.service';
import { ApplicationPreferencesService } from 'src/engine/core-modules/application/application-preferences/application-preferences.service';
import { ApplicationPreferencesDTO } from 'src/engine/core-modules/application/application-preferences/dtos/application-preferences.dto';
+import { ApplicationHealthCheckResultDTO } from 'src/engine/core-modules/application/dtos/application-health-check-result.dto';
import { AuthGraphqlApiExceptionFilter } from 'src/engine/core-modules/auth/filters/auth-graphql-api-exception.filter';
+import { type AuthContextUser } from 'src/engine/core-modules/auth/types/auth-context.type';
+import { ThrottlerGraphqlApiExceptionFilter } from 'src/engine/core-modules/throttler/filters/throttler-graphql-api-exception.filter';
import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
+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 { AuthPrincipalGuard } from 'src/engine/guards/auth-principal.guard';
@@ -32,6 +39,7 @@ import { SettingsPermissionGuard } from 'src/engine/guards/settings-permission.g
export class ApplicationPreferencesResolver {
constructor(
private readonly applicationPreferencesService: ApplicationPreferencesService,
+ private readonly applicationHealthCheckService: ApplicationHealthCheckService,
) {}
@Query(() => [ApplicationPreferencesDTO])
@@ -44,4 +52,21 @@ export class ApplicationPreferencesResolver {
userWorkspaceId,
});
}
+
+ @Mutation(() => ApplicationHealthCheckResultDTO, { nullable: true })
+ @UseFilters(ApplicationExceptionFilter, ThrottlerGraphqlApiExceptionFilter)
+ async runMyApplicationHealthCheck(
+ @Args('applicationId', { type: () => UUIDScalarType })
+ applicationId: string,
+ @AuthWorkspace() { id: workspaceId }: WorkspaceEntity,
+ @AuthUser() { id: userId }: AuthContextUser,
+ @AuthUserWorkspaceId() userWorkspaceId: string,
+ ): Promise<ApplicationHealthCheckResultDTO | null> {
+ return await this.applicationHealthCheckService.runForUser({
+ applicationId,
+ workspaceId,
+ userId,
+ userWorkspaceId,
+ });
+ }
}
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-preferences/application-preferences.service.ts b/packages/twenty-server/src/engine/core-modules/application/application-preferences/application-preferences.service.ts
index 39e64fb9522..7f24819248f 100644
--- a/packages/twenty-server/src/engine/core-modules/application/application-preferences/application-preferences.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/application-preferences/application-preferences.service.ts
@@ -1,7 +1,8 @@
import { Injectable } from '@nestjs/common';
-import { isNonEmptyArray } from 'twenty-shared/utils';
+import { isDefined, isNonEmptyArray } from 'twenty-shared/utils';
+import { getHealthCheckLogicFunctionIdForUser } from 'src/engine/core-modules/application/application-health/utils/get-health-check-logic-function-id-for-user.util';
import { type ApplicationPreferencesDTO } from 'src/engine/core-modules/application/application-preferences/dtos/application-preferences.dto';
import { UserApplicationVariableValueService } from 'src/engine/core-modules/application/application-variable/user-application-variable-value.service';
import { ApplicationService } from 'src/engine/core-modules/application/application.service';
@@ -55,26 +56,44 @@ export class ApplicationPreferencesService {
]);
return installedFlatApplications
- .map(({ id: applicationId }): ApplicationPreferencesDTO => ({
- applicationId,
- settingsMenuItems: findFlatEntitiesByApplicationId({
- flatEntityMaps: flatSettingsMenuItemMaps,
+ .map(
+ ({
+ id: applicationId,
+ healthCheckLogicFunctionId,
+ isUserHealthCheckEnabled,
+ }): ApplicationPreferencesDTO => ({
applicationId,
- })
- .filter(({ scope }) => scope === 'USER')
- .map(fromFlatSettingsMenuItemToSettingsMenuItemDto),
- variables:
- myUserApplicationVariableValuesByApplicationId[applicationId],
- connectionProviders: connectionProviders.filter(
- (connectionProvider) =>
- connectionProvider.applicationId === applicationId,
- ),
- }))
+ settingsMenuItems: findFlatEntitiesByApplicationId({
+ flatEntityMaps: flatSettingsMenuItemMaps,
+ applicationId,
+ })
+ .filter(({ scope }) => scope === 'USER')
+ .map(fromFlatSettingsMenuItemToSettingsMenuItemDto),
+ variables:
+ myUserApplicationVariableValuesByApplicationId[applicationId],
+ connectionProviders: connectionProviders.filter(
+ (connectionProvider) =>
+ connectionProvider.applicationId === applicationId,
+ ),
+ hasUserHealthCheck: isDefined(
+ getHealthCheckLogicFunctionIdForUser({
+ healthCheckLogicFunctionId,
+ isUserHealthCheckEnabled,
+ }),
+ ),
+ }),
+ )
.filter(
- ({ settingsMenuItems, variables, connectionProviders }) =>
+ ({
+ settingsMenuItems,
+ variables,
+ connectionProviders,
+ hasUserHealthCheck,
+ }) =>
isNonEmptyArray(settingsMenuItems) ||
isNonEmptyArray(variables) ||
- isNonEmptyArray(connectionProviders),
+ isNonEmptyArray(connectionProviders) ||
+ hasUserHealthCheck,
);
}
}
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-preferences/dtos/application-preferences.dto.ts b/packages/twenty-server/src/engine/core-modules/application/application-preferences/dtos/application-preferences.dto.ts
index a11be672d28..95807774f8c 100644
--- a/packages/twenty-server/src/engine/core-modules/application/application-preferences/dtos/application-preferences.dto.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/application-preferences/dtos/application-preferences.dto.ts
@@ -1,6 +1,6 @@
import { Field, ObjectType } from '@nestjs/graphql';
-import { IsUUID } from 'class-validator';
+import { IsBoolean, IsUUID } from 'class-validator';
import { UUIDScalarType } from 'src/engine/api/graphql/workspace-schema-builder/graphql-types/scalars';
import { UserApplicationVariableValueDTO } from 'src/engine/core-modules/application/application-variable/dtos/user-application-variable-value.dto';
@@ -21,4 +21,8 @@ export class ApplicationPreferencesDTO {
@Field(() => [ApplicationConnectionProviderDTO])
connectionProviders: ApplicationConnectionProviderDTO[];
+
+ @IsBoolean()
+ @Field()
+ hasUserHealthCheck: boolean;
}
diff --git a/packages/twenty-server/src/engine/core-modules/application/application.resolver.ts b/packages/twenty-server/src/engine/core-modules/application/application.resolver.ts
index 64a8221ad80..2772de89a4c 100644
--- a/packages/twenty-server/src/engine/core-modules/application/application.resolver.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/application.resolver.ts
@@ -13,6 +13,7 @@ import {
ApplicationExceptionCode,
} from 'src/engine/core-modules/application/application.exception';
import { ApplicationService } from 'src/engine/core-modules/application/application.service';
+import { type ApplicationEntity } from 'src/engine/core-modules/application/application.entity';
import { ApplicationDTO } from 'src/engine/core-modules/application/dtos/application.dto';
import { type FlatApplication } from 'src/engine/core-modules/application/types/flat-application.type';
import { buildPublicAssetLogoUrl } from 'src/engine/core-modules/application/utils/build-public-asset-logo-url.util';
@@ -121,6 +122,21 @@ export class ApplicationResolver {
});
}
+ @ResolveField(() => Boolean)
+ runOnUserPreferences(
+ @Parent()
+ application: Partial<
+ Pick<ApplicationEntity, 'isUserHealthCheckEnabled'> &
+ Pick<ApplicationDTO, 'runOnUserPreferences'>
+ >,
+ ): boolean {
+ return (
+ application.runOnUserPreferences ??
+ application.isUserHealthCheckEnabled ??
+ false
+ );
+ }
+
@ResolveField(() => Boolean)
isUninstallBlockedByOtherWorkspaceInstallations(
@Parent()
diff --git a/packages/twenty-server/src/engine/core-modules/application/dtos/application.dto.ts b/packages/twenty-server/src/engine/core-modules/application/dtos/application.dto.ts
index b1be6233ab6..4d13468dd0e 100644
--- a/packages/twenty-server/src/engine/core-modules/application/dtos/application.dto.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/dtos/application.dto.ts
@@ -112,6 +112,10 @@ export class ApplicationDTO {
@Field(() => UUIDScalarType, { nullable: true })
healthCheckLogicFunctionId?: string;
+ @IsBoolean()
+ @Field(() => Boolean)
+ runOnUserPreferences: boolean;
+
@IsOptional()
@Field(() => RoleDTO, { nullable: true })
defaultLogicFunctionRole?: RoleDTO;
diff --git a/packages/twenty-server/src/engine/core-modules/application/utils/from-flat-application-to-application-dto.util.ts b/packages/twenty-server/src/engine/core-modules/application/utils/from-flat-application-to-application-dto.util.ts
index a20b120e144..513194c35df 100644
--- a/packages/twenty-server/src/engine/core-modules/application/utils/from-flat-application-to-application-dto.util.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/utils/from-flat-application-to-application-dto.util.ts
@@ -18,6 +18,7 @@ export const fromFlatApplicationToApplicationDto = ({
version,
settingsCustomTabFrontComponentId,
healthCheckLogicFunctionId,
+ isUserHealthCheckEnabled,
}: FlatApplication): ApplicationDTO => {
return {
canBeUninstalled,
@@ -38,5 +39,6 @@ export const fromFlatApplicationToApplicationDto = ({
settingsCustomTabFrontComponentId:
settingsCustomTabFrontComponentId ?? undefined,
healthCheckLogicFunctionId: healthCheckLogicFunctionId ?? undefined,
+ runOnUserPreferences: isUserHealthCheckEnabled ?? false,
};
};
diff --git a/packages/twenty-server/test/integration/endpoint-permissions/__snapshots__/endpoint-permission-declarations.integration-spec.ts.snap b/packages/twenty-server/test/integration/endpoint-permissions/__snapshots__/endpoint-permission-declarations.integration-spec.ts.snap
index 53cd4dccac1..a7e20608de9 100644
--- a/packages/twenty-server/test/integration/endpoint-permissions/__snapshots__/endpoint-permission-declarations.integration-spec.ts.snap
+++ b/packages/twenty-server/test/integration/endpoint-permissions/__snapshots__/endpoint-permission-declarations.integration-spec.ts.snap
@@ -165,6 +165,7 @@ exports[`endpoint permission declarations should match the auth principals, perm
"ApplicationMonitoringResolver.findApplicationRegistrationMonitoring {"applicationTarget":{"argName":"id","kind":"applicationRegistrationId","requireApplicationRegistrationOwnership":true,"source":"graphqlArg"},"authPrincipalGuards":[{"apiKey":false,"application":{"withAgent":false,"withUser":false,"withoutUser":false},"oauthClient":{"withUser":false,"withoutUser":false},"userSession":{"impersonated":true,"playground":true,"standard":true,"workspaceAgnostic":false}}],"requiredFeatureFlags":[],"requiredPermissionFlags":["API_KEYS_AND_WEBHOOKS"]}",
"ApplicationOAuthResolver.renewApplicationToken {"applicationTarget":null,"authPrincipalGuards":[{"apiKey":true,"application":{"withAgent":false,"withUser":true,"withoutUser":true},"oauthClient":{"withUser":true,"withoutUser":true},"userSession":{"impersonated":true,"playground":true,"standard":true,"workspaceAgnostic":false}},{"apiKey":false,"application":{"withAgent":false,"withUser":false,"withoutUser":false},"oauthClient":{"withUser":false,"withoutUser":false},"userSession":{"impersonated":true,"playground":false,"standard":true,"workspaceAgnostic":false}}],"requiredFeatureFlags":[],"requiredPermissionFlags":[]}",
"ApplicationPreferencesResolver.myApplicationPreferences {"applicationTarget":null,"authPrincipalGuards":[{"apiKey":false,"application":{"withAgent":false,"withUser":false,"withoutUser":false},"oauthClient":{"withUser":false,"withoutUser":false},"userSession":{"impersonated":true,"playground":true,"standard":true,"workspaceAgnostic":false}}],"requiredFeatureFlags":[],"requiredPermissionFlags":["CONNECTED_ACCOUNTS"]}",
+ "ApplicationPreferencesResolver.runMyApplicationHealthCheck {"applicationTarget":null,"authPrincipalGuards":[{"apiKey":false,"application":{"withAgent":false,"withUser":false,"withoutUser":false},"oauthClient":{"withUser":false,"withoutUser":false},"userSession":{"impersonated":true,"playground":true,"standard":true,"workspaceAgnostic":false}}],"requiredFeatureFlags":[],"requiredPermissionFlags":["CONNECTED_ACCOUNTS"]}",
"ApplicationRegistrationClaimController.githubCallback {"applicationTarget":null,"authPrincipalGuards":[],"requiredFeatureFlags":[],"requiredPermissionFlags":[]}",
"ApplicationRegistrationResolver.applicationRegistrationTarballUrl {"applicationTarget":{"argName":"id","kind":"applicationRegistrationId","requireApplicationRegistrationOwnership":true,"source":"graphqlArg"},"authPrincipalGuards":[{"apiKey":true,"application":{"withAgent":false,"withUser":true,"withoutUser":true},"oauthClient":{"withUser":true,"withoutUser":true},"userSession":{"impersonated":true,"playground":true,"standard":true,"workspaceAgnostic":false}}],"requiredFeatureFlags":[],"requiredPermissionFlags":["API_KEYS_AND_WEBHOOKS"]}",
"ApplicationRegistrationResolver.claimApplicationRegistrationOwnership {"applicationTarget":null,"authPrincipalGuards":[{"apiKey":false,"application":{"withAgent":false,"withUser":false,"withoutUser":false},"oauthClient":{"withUser":false,"withoutUser":false},"userSession":{"impersonated":true,"playground":true,"standard":true,"workspaceAgnostic":false}}],"requiredFeatureFlags":[],"requiredPermissionFlags":["APPLICATIONS"]}",
diff --git a/packages/twenty-server/test/integration/metadata/suites/application/__snapshots__/failing-application-preferences.integration-spec.ts.snap b/packages/twenty-server/test/integration/metadata/suites/application/__snapshots__/failing-application-preferences.integration-spec.ts.snap
index cd06cf2f689..86694525192 100644
--- a/packages/twenty-server/test/integration/metadata/suites/application/__snapshots__/failing-application-preferences.integration-spec.ts.snap
+++ b/packages/twenty-server/test/integration/metadata/suites/application/__snapshots__/failing-application-preferences.integration-spec.ts.snap
@@ -19,3 +19,47 @@ exports[`My application preferences should fail should refuse an application tok
"message": "This endpoint is not available to this caller",
}
`;
+
+exports[`My application preferences should fail when running my application health check past the rate limit should refuse a member once their bucket for the application is spent 1`] = `
+{
+ "extensions": {
+ "code": "BAD_USER_INPUT",
+ "subCode": "LIMIT_REACHED",
+ "userFriendlyMessage": "Rate limit reached. Please try again later.",
+ },
+ "message": "Limit reached (10 tokens per 60000 ms)",
+ "name": "UserInputError",
+}
+`;
+
+exports[`My application preferences should fail when running my application health check should not find an application that is not installed in the workspace 1`] = `
+{
+ "extensions": {
+ "code": "NOT_FOUND",
+ "subCode": "APPLICATION_NOT_FOUND",
+ "userFriendlyMessage": "Application not found.",
+ },
+ "message": "Application with id 9f1b7c2e-4d3a-4b5c-8e6f-0a1b2c3d4e5f or universalIdentifier undefined not found",
+ "name": "NotFoundError",
+}
+`;
+
+exports[`My application preferences should fail when running my application health check should refuse an API key 1`] = `
+{
+ "extensions": {
+ "code": "FORBIDDEN",
+ "userFriendlyMessage": "You do not have permission to perform this action.",
+ },
+ "message": "This endpoint is not available to this caller",
+}
+`;
+
+exports[`My application preferences should fail when running my application health check should refuse an application token, even one a member is behind 1`] = `
+{
+ "extensions": {
+ "code": "FORBIDDEN",
+ "userFriendlyMessage": "You do not have permission to perform this action.",
+ },
+ "message": "This endpoint is not available to this caller",
+}
+`;
diff --git a/packages/twenty-server/test/integration/metadata/suites/application/failing-application-preferences.integration-spec.ts b/packages/twenty-server/test/integration/metadata/suites/application/failing-application-preferences.integration-spec.ts
index f6424f4716a..b44d88823f4 100644
--- a/packages/twenty-server/test/integration/metadata/suites/application/failing-application-preferences.integration-spec.ts
+++ b/packages/twenty-server/test/integration/metadata/suites/application/failing-application-preferences.integration-spec.ts
@@ -1,22 +1,39 @@
import { randomUUID } from 'crypto';
+import IORedis from 'ioredis';
import { expectOneNotInternalServerErrorSnapshot } from 'test/integration/graphql/utils/expect-one-not-internal-server-error-snapshot.util';
import { expectPermissionDenied } from 'test/integration/metadata/suites/application/utils/expect-permission-denied.util';
import { cleanupApplicationAndAppRegistration } from 'test/integration/metadata/suites/application/utils/cleanup-application-and-app-registration.util';
import { myApplicationPreferences } from 'test/integration/metadata/suites/application/utils/my-application-preferences.util';
+import { runMyApplicationHealthCheckQueryFactory } from 'test/integration/metadata/suites/application/utils/run-my-application-health-check-query-factory.util';
+import { runMyApplicationHealthCheck } from 'test/integration/metadata/suites/application/utils/run-my-application-health-check.util';
+import {
+ type ApplicationWithUserHealthCheck,
+ setupApplicationWithUserHealthCheck,
+} from 'test/integration/metadata/suites/application/utils/setup-application-with-user-health-check.util';
import {
type ApplicationWithVariable,
setupApplicationWithVariable,
} from 'test/integration/metadata/suites/application/utils/setup-application-with-variable.util';
+import { makeMetadataApiRequest } from 'test/integration/metadata/suites/utils/make-metadata-api-request.util';
import { createOneRole } from 'test/integration/metadata/suites/role/utils/create-one-role.util';
import { deleteOneRole } from 'test/integration/metadata/suites/role/utils/delete-one-role.util';
import { findOneRoleByLabel } from 'test/integration/metadata/suites/role/utils/find-one-role-by-label.util';
import { updateWorkspaceMemberRole } from 'test/integration/metadata/suites/role/utils/update-workspace-member-role.util';
import { generateAppleAdminApplicationTokenPair } from 'test/integration/utils/generate-apple-admin-application-token-pair.util';
import { jestExpectToBeDefined } from 'test/utils/jest-expect-to-be-defined.util.test';
+import { isDefined } from 'twenty-shared/utils';
+import { USER_HEALTH_CHECK_RATE_LIMIT_MAX } from 'src/engine/core-modules/application/application-health/constants/user-health-check-rate-limit.constant';
+import { buildUserHealthCheckRateLimitKey } from 'src/engine/core-modules/application/application-health/utils/build-user-health-check-rate-limit-key.util';
+import { CacheStorageNamespace } from 'src/engine/core-modules/cache-storage/types/cache-storage-namespace.enum';
+import { TOKEN_BUCKET_THROTTLE_KEY_PREFIX } from 'src/engine/core-modules/throttler/constants/token-bucket-throttle-key-prefix.constant';
+import { SEED_APPLE_WORKSPACE_ID } from 'src/engine/workspace-manager/dev-seeder/core/constants/seeder-workspaces.constant';
+import { USER_WORKSPACE_DATA_SEED_IDS } from 'src/engine/workspace-manager/dev-seeder/core/utils/seed-user-workspaces.util';
import { WORKSPACE_MEMBER_DATA_SEED_IDS } from 'src/engine/workspace-manager/dev-seeder/data/constants/workspace-member-data-seeds.constant';
+const UNINSTALLED_APPLICATION_ID = '9f1b7c2e-4d3a-4b5c-8e6f-0a1b2c3d4e5f';
+
describe('My application preferences should fail', () => {
let application: ApplicationWithVariable;
let janeApplicationToken: string;
@@ -74,6 +91,113 @@ describe('My application preferences should fail', () => {
expectPermissionDenied(errors);
});
+ describe('when running my application health check', () => {
+ it('should refuse an API key', async () => {
+ const { errors } = await runMyApplicationHealthCheck({
+ input: { applicationId: application.id },
+ token: API_KEY_ACCESS_TOKEN,
+ expectToFail: true,
+ });
+
+ expectOneNotInternalServerErrorSnapshot({ errors });
+ });
+
+ it('should refuse an application token, even one a member is behind', async () => {
+ const { errors } = await runMyApplicationHealthCheck({
+ input: { applicationId: application.id },
+ token: janeApplicationToken,
+ expectToFail: true,
+ });
+
+ expectOneNotInternalServerErrorSnapshot({ errors });
+ });
+
+ it('should refuse a guest whose role lacks the User Apps permission', async () => {
+ const { data, errors } = await runMyApplicationHealthCheck({
+ input: { applicationId: application.id },
+ token: APPLE_PHIL_GUEST_ACCESS_TOKEN,
+ expectToFail: true,
+ });
+
+ expect(data.runMyApplicationHealthCheck).toBeNull();
+ expectPermissionDenied(errors);
+ });
+
+ it('should not find an application that is not installed in the workspace', async () => {
+ const { errors } = await runMyApplicationHealthCheck({
+ input: { applicationId: UNINSTALLED_APPLICATION_ID },
+ token: APPLE_JONY_MEMBER_ACCESS_TOKEN,
+ expectToFail: true,
+ });
+
+ expectOneNotInternalServerErrorSnapshot({ errors });
+ });
+
+ describe('past the rate limit', () => {
+ let applicationWithUserHealthCheck: ApplicationWithUserHealthCheck;
+
+ const clearJonyRateLimitBucket = async (): Promise<void> => {
+ const redis = new IORedis(
+ process.env.REDIS_URL ?? 'redis://localhost:6379',
+ );
+ const rateLimitKey = buildUserHealthCheckRateLimitKey({
+ workspaceId: SEED_APPLE_WORKSPACE_ID,
+ userWorkspaceId: USER_WORKSPACE_DATA_SEED_IDS.JONY,
+ applicationId: applicationWithUserHealthCheck.id,
+ });
+
+ try {
+ await redis.del(
+ `${CacheStorageNamespace.IntegrationTests}:${CacheStorageNamespace.EngineWorkspace}:${TOKEN_BUCKET_THROTTLE_KEY_PREFIX}:${rateLimitKey}`,
+ );
+ } finally {
+ redis.disconnect();
+ }
+ };
+
+ beforeAll(async () => {
+ applicationWithUserHealthCheck =
+ await setupApplicationWithUserHealthCheck({
+ name: 'Application with a rate limited user health check',
+ });
+ await clearJonyRateLimitBucket();
+ }, 120000);
+
+ afterAll(async () => {
+ await clearJonyRateLimitBucket();
+ await cleanupApplicationAndAppRegistration({
+ applicationUniversalIdentifier:
+ applicationWithUserHealthCheck.universalIdentifier,
+ });
+ });
+
+ it('should refuse a member once their bucket for the application is spent', async () => {
+ const responses = await Promise.all(
+ Array.from({ length: USER_HEALTH_CHECK_RATE_LIMIT_MAX + 1 }, () =>
+ makeMetadataApiRequest(
+ runMyApplicationHealthCheckQueryFactory({
+ input: { applicationId: applicationWithUserHealthCheck.id },
+ }),
+ APPLE_JONY_MEMBER_ACCESS_TOKEN,
+ ),
+ ),
+ );
+
+ const refusedResponses = responses.filter(({ body }) =>
+ isDefined(body.errors),
+ );
+
+ expect(responses.length - refusedResponses.length).toBe(
+ USER_HEALTH_CHECK_RATE_LIMIT_MAX,
+ );
+ expect(refusedResponses).toHaveLength(1);
+ expectOneNotInternalServerErrorSnapshot({
+ errors: refusedResponses[0].body.errors,
+ });
+ });
+ });
+ });
+
describe('for a member whose role lacks the User Apps permission', () => {
let memberRoleId: string;
let customRoleId: string;
diff --git a/packages/twenty-server/test/integration/metadata/suites/application/successful-run-my-application-health-check.integration-spec.ts b/packages/twenty-server/test/integration/metadata/suites/application/successful-run-my-application-health-check.integration-spec.ts
new file mode 100644
index 00000000000..c3938817b81
--- /dev/null
+++ b/packages/twenty-server/test/integration/metadata/suites/application/successful-run-my-application-health-check.integration-spec.ts
@@ -0,0 +1,353 @@
+import { createHash } from 'crypto';
+
+import { TEST_APPLICATION_PACKAGE_JSON_CHECKSUM } from 'test/integration/metadata/suites/application/constants/test-application-package-json.constant';
+import { buildBaseManifest } from 'test/integration/metadata/suites/application/utils/build-base-manifest.util';
+import { cleanupApplicationAndAppRegistration } from 'test/integration/metadata/suites/application/utils/cleanup-application-and-app-registration.util';
+import { findOneApplication } from 'test/integration/metadata/suites/application/utils/find-one-application.util';
+import { installedApplicationHealthChecksQueryFactory } from 'test/integration/metadata/suites/application/utils/installed-application-health-checks-query-factory.util';
+import { myApplicationPreferences } from 'test/integration/metadata/suites/application/utils/my-application-preferences.util';
+import { runApplicationHealthCheck } from 'test/integration/metadata/suites/application/utils/run-application-health-check.util';
+import { runMyApplicationHealthCheck } from 'test/integration/metadata/suites/application/utils/run-my-application-health-check.util';
+import {
+ type ApplicationWithUserHealthCheck,
+ setupApplicationWithUserHealthCheck,
+} from 'test/integration/metadata/suites/application/utils/setup-application-with-user-health-check.util';
+import {
+ type ApplicationWithVariable,
+ setupApplicationWithVariable,
+} from 'test/integration/metadata/suites/application/utils/setup-application-with-variable.util';
+import { setupApplicationForSync } from 'test/integration/metadata/suites/application/utils/setup-application-for-sync.util';
+import { syncApplication } from 'test/integration/metadata/suites/application/utils/sync-application.util';
+import { updateMyUserApplicationVariable } from 'test/integration/metadata/suites/application/utils/update-my-user-application-variable.util';
+import { uploadApplicationFile } from 'test/integration/metadata/suites/application/utils/upload-application-file.util';
+import { makeMetadataApiRequest } from 'test/integration/metadata/suites/utils/make-metadata-api-request.util';
+import { type Manifest } from 'twenty-shared/application';
+import { v4 as uuidv4 } from 'uuid';
+
+import { USER_WORKSPACE_DATA_SEED_IDS } from 'src/engine/workspace-manager/dev-seeder/core/utils/seed-user-workspaces.util';
+import { WORKSPACE_MEMBER_DATA_SEED_IDS } from 'src/engine/workspace-manager/dev-seeder/data/constants/workspace-member-data-seeds.constant';
+
+type HealthCheckSource = {
+ universalIdentifier: string;
+ name: string;
+ source: string;
+};
+
+const APPLICATION_UNIVERSAL_IDENTIFIER = uuidv4();
+const ROLE_UNIVERSAL_IDENTIFIER = uuidv4();
+const LANGUAGE_VARIABLE_UNIVERSAL_IDENTIFIER = uuidv4();
+const APPLICATION_NAME = 'Application with a user health check';
+
+const HEALTH_CHECK: HealthCheckSource = {
+ universalIdentifier: uuidv4(),
+ name: 'health-check',
+ source: `export const handler = ({ userWorkspaceId }, context) => {
+ if (userWorkspaceId === undefined) {
+ return {
+ status: 'INFO',
+ title: 'Workspace check run by ' + String(context.userWorkspaceId) + ' with payload ' + String(userWorkspaceId),
+ };
+ }
+
+ return {
+ status: 'WARNING',
+ title: 'User check run by ' + context.workspaceMemberId + ' as ' + userWorkspaceId,
+ description: 'Language: ' + process.env.LANGUAGE + ' for ' + context.userWorkspaceId,
+ };
+};`,
+};
+
+const buildHealthCheckManifest = ({
+ runOnUserPreferences,
+}: {
+ runOnUserPreferences?: boolean;
+}): Manifest =>
+ buildBaseManifest({
+ appId: APPLICATION_UNIVERSAL_IDENTIFIER,
+ roleId: ROLE_UNIVERSAL_IDENTIFIER,
+ overrides: {
+ application: {
+ universalIdentifier: APPLICATION_UNIVERSAL_IDENTIFIER,
+ defaultRoleUniversalIdentifier: ROLE_UNIVERSAL_IDENTIFIER,
+ displayName: APPLICATION_NAME,
+ description: 'App for testing the user health check',
+ applicationVariables: {
+ LANGUAGE: {
+ universalIdentifier: LANGUAGE_VARIABLE_UNIVERSAL_IDENTIFIER,
+ scope: 'USER',
+ value: 'en',
+ },
+ },
+ healthCheckLogicFunction: {
+ universalIdentifier: HEALTH_CHECK.universalIdentifier,
+ runOnUserPreferences,
+ },
+ packageJsonChecksum: TEST_APPLICATION_PACKAGE_JSON_CHECKSUM,
+ yarnLockChecksum: null,
+ },
+ logicFunctions: [HEALTH_CHECK].map(
+ ({ universalIdentifier, name, source }) => ({
+ universalIdentifier,
+ name,
+ handlerName: 'handler',
+ sourceHandlerPath: `src/${name}.ts`,
+ builtHandlerPath: `dist/${name}.mjs`,
+ builtHandlerChecksum: createHash('sha256')
+ .update(source)
+ .digest('hex'),
+ timeoutSeconds: 10,
+ }),
+ ),
+ },
+ });
+
+describe('Run my application health check should succeed', () => {
+ let applicationId: string;
+ let healthCheckOnlyApplication: ApplicationWithUserHealthCheck;
+ let applicationWithoutHealthCheck: ApplicationWithVariable;
+
+ beforeAll(async () => {
+ await setupApplicationForSync({
+ applicationUniversalIdentifier: APPLICATION_UNIVERSAL_IDENTIFIER,
+ name: APPLICATION_NAME,
+ description: 'App for testing the user health check',
+ sourcePath: 'user-health-check',
+ });
+ jest.useRealTimers();
+
+ for (const healthCheck of [HEALTH_CHECK]) {
+ await uploadApplicationFile({
+ applicationUniversalIdentifier: APPLICATION_UNIVERSAL_IDENTIFIER,
+ fileFolder: 'BuiltLogicFunction',
+ filePath: `dist/${healthCheck.name}.mjs`,
+ filename: `${healthCheck.name}.mjs`,
+ contentType: 'application/javascript',
+ fileBuffer: Buffer.from(healthCheck.source),
+ expectToFail: false,
+ });
+ }
+
+ await syncApplication({
+ manifest: buildHealthCheckManifest({
+ runOnUserPreferences: true,
+ }),
+ expectToFail: false,
+ });
+ jest.useRealTimers();
+
+ const { data } = await findOneApplication({
+ input: { universalIdentifier: APPLICATION_UNIVERSAL_IDENTIFIER },
+ gqlFields: 'id',
+ expectToFail: false,
+ });
+
+ applicationId = data.findOneApplication.id;
+
+ healthCheckOnlyApplication = await setupApplicationWithUserHealthCheck({
+ name: 'Application with only a user health check',
+ });
+
+ applicationWithoutHealthCheck = await setupApplicationWithVariable({
+ name: 'Application without a user health check',
+ variableKey: 'RECORD_MY_MEETINGS',
+ variableScope: 'USER',
+ });
+ jest.useRealTimers();
+ }, 240000);
+
+ afterAll(async () => {
+ await cleanupApplicationAndAppRegistration({
+ applicationUniversalIdentifier: APPLICATION_UNIVERSAL_IDENTIFIER,
+ });
+ await cleanupApplicationAndAppRegistration({
+ applicationUniversalIdentifier:
+ healthCheckOnlyApplication.universalIdentifier,
+ });
+ await cleanupApplicationAndAppRegistration({
+ applicationUniversalIdentifier:
+ applicationWithoutHealthCheck.universalIdentifier,
+ });
+ });
+
+ it('should list applications that enable member execution, even without other preferences', async () => {
+ const { data } = await myApplicationPreferences({
+ input: {},
+ gqlFields: 'applicationId hasUserHealthCheck',
+ token: APPLE_JONY_MEMBER_ACCESS_TOKEN,
+ expectToFail: false,
+ });
+
+ expect(data.myApplicationPreferences).toEqual(
+ expect.arrayContaining([
+ { applicationId, hasUserHealthCheck: true },
+ {
+ applicationId: healthCheckOnlyApplication.id,
+ hasUserHealthCheck: true,
+ },
+ {
+ applicationId: applicationWithoutHealthCheck.id,
+ hasUserHealthCheck: false,
+ },
+ ]),
+ );
+ });
+
+ it('should expose the execution location on mapped installed applications', async () => {
+ const response = await makeMetadataApiRequest(
+ installedApplicationHealthChecksQueryFactory(),
+ );
+
+ expect(response.body.errors).toBeUndefined();
+ expect(
+ response.body.data.currentUser.currentWorkspace.installedApplications,
+ ).toEqual(
+ expect.arrayContaining([
+ { id: applicationId, runOnUserPreferences: true },
+ { id: healthCheckOnlyApplication.id, runOnUserPreferences: true },
+ { id: applicationWithoutHealthCheck.id, runOnUserPreferences: false },
+ ]),
+ );
+ });
+
+ it('should run the health check as the requesting member with their own variable values', async () => {
+ await updateMyUserApplicationVariable({
+ input: {
+ applicationUniversalIdentifier: APPLICATION_UNIVERSAL_IDENTIFIER,
+ key: 'LANGUAGE',
+ value: 'fr',
+ },
+ token: APPLE_JONY_MEMBER_ACCESS_TOKEN,
+ expectToFail: false,
+ });
+ await updateMyUserApplicationVariable({
+ input: {
+ applicationUniversalIdentifier: APPLICATION_UNIVERSAL_IDENTIFIER,
+ key: 'LANGUAGE',
+ value: 'de',
+ },
+ token: APPLE_JANE_ADMIN_ACCESS_TOKEN,
+ expectToFail: false,
+ });
+
+ const { data: jonyData } = await runMyApplicationHealthCheck({
+ input: { applicationId },
+ token: APPLE_JONY_MEMBER_ACCESS_TOKEN,
+ expectToFail: false,
+ });
+
+ expect(jonyData.runMyApplicationHealthCheck).toEqual({
+ status: 'WARNING',
+ title: `User check run by ${WORKSPACE_MEMBER_DATA_SEED_IDS.JONY} as ${USER_WORKSPACE_DATA_SEED_IDS.JONY}`,
+ description: `Language: fr for ${USER_WORKSPACE_DATA_SEED_IDS.JONY}`,
+ });
+
+ const { data: janeData } = await runMyApplicationHealthCheck({
+ input: { applicationId },
+ token: APPLE_JANE_ADMIN_ACCESS_TOKEN,
+ expectToFail: false,
+ });
+
+ expect(janeData.runMyApplicationHealthCheck).toEqual({
+ status: 'WARNING',
+ title: `User check run by ${WORKSPACE_MEMBER_DATA_SEED_IDS.JANE} as ${USER_WORKSPACE_DATA_SEED_IDS.JANE}`,
+ description: `Language: de for ${USER_WORKSPACE_DATA_SEED_IDS.JANE}`,
+ });
+ });
+
+ it('should not run a member-only handler from the workspace application page', async () => {
+ const { data: applicationData } = await findOneApplication({
+ input: { universalIdentifier: APPLICATION_UNIVERSAL_IDENTIFIER },
+ gqlFields: 'id runOnUserPreferences',
+ expectToFail: false,
+ });
+
+ expect(applicationData.findOneApplication.runOnUserPreferences).toBe(true);
+
+ const { data } = await runApplicationHealthCheck({
+ input: { applicationId },
+ expectToFail: false,
+ });
+
+ expect(data.runApplicationHealthCheck).toBeNull();
+ });
+
+ it('should return null for an application without a health check', async () => {
+ const { data } = await runMyApplicationHealthCheck({
+ input: { applicationId: applicationWithoutHealthCheck.id },
+ token: APPLE_JONY_MEMBER_ACCESS_TOKEN,
+ expectToFail: false,
+ });
+
+ expect(data.runMyApplicationHealthCheck).toBeNull();
+ });
+
+ it.each([undefined, false])(
+ 'should keep runOnUserPreferences=%s workspace-only and out of member preferences',
+ async (runOnUserPreferences) => {
+ const workspaceOnlyManifest = buildHealthCheckManifest({
+ runOnUserPreferences,
+ });
+
+ await syncApplication({
+ manifest: {
+ ...workspaceOnlyManifest,
+ application: {
+ ...workspaceOnlyManifest.application,
+ applicationVariables: {},
+ },
+ },
+ expectToFail: false,
+ });
+ jest.useRealTimers();
+
+ const [storedApplication] = await globalThis.testDataSource.query(
+ `SELECT "healthCheckLogicFunctionId", "isUserHealthCheckEnabled" FROM core."application" WHERE id = $1`,
+ [applicationId],
+ );
+
+ expect(storedApplication.healthCheckLogicFunctionId).toEqual(
+ expect.any(String),
+ );
+ expect(storedApplication.isUserHealthCheckEnabled).toBe(false);
+
+ const { data: applicationData } = await findOneApplication({
+ input: { universalIdentifier: APPLICATION_UNIVERSAL_IDENTIFIER },
+ gqlFields: 'id runOnUserPreferences',
+ expectToFail: false,
+ });
+
+ expect(applicationData.findOneApplication.runOnUserPreferences).toBe(
+ false,
+ );
+
+ const { data: workspaceData } = await runApplicationHealthCheck({
+ input: { applicationId },
+ expectToFail: false,
+ });
+
+ expect(workspaceData.runApplicationHealthCheck).toEqual({
+ status: 'INFO',
+ title: 'Workspace check run by null with payload undefined',
+ });
+
+ const { data: preferencesData } = await myApplicationPreferences({
+ input: {},
+ gqlFields: 'applicationId hasUserHealthCheck',
+ token: APPLE_JONY_MEMBER_ACCESS_TOKEN,
+ expectToFail: false,
+ });
+
+ expect(preferencesData.myApplicationPreferences).not.toEqual(
+ expect.arrayContaining([expect.objectContaining({ applicationId })]),
+ );
+
+ const { data } = await runMyApplicationHealthCheck({
+ input: { applicationId },
+ token: APPLE_JONY_MEMBER_ACCESS_TOKEN,
+ expectToFail: false,
+ });
+
+ expect(data.runMyApplicationHealthCheck).toBeNull();
+ },
+ );
+});
diff --git a/packages/twenty-server/test/integration/metadata/suites/application/utils/installed-application-health-checks-query-factory.util.ts b/packages/twenty-server/test/integration/metadata/suites/application/utils/installed-application-health-checks-query-factory.util.ts
new file mode 100644
index 00000000000..b2769fb0b3a
--- /dev/null
+++ b/packages/twenty-server/test/integration/metadata/suites/application/utils/installed-application-health-checks-query-factory.util.ts
@@ -0,0 +1,17 @@
+import gql from 'graphql-tag';
+
+export const installedApplicationHealthChecksQueryFactory = () => ({
+ query: gql`
+ query InstalledApplicationHealthChecks {
+ currentUser {
+ currentWorkspace {
+ installedApplications {
+ id
+ runOnUserPreferences
+ }
+ }
+ }
+ }
+ `,
+ variables: {},
+});
diff --git a/packages/twenty-server/test/integration/metadata/suites/application/utils/run-my-application-health-check-query-factory.util.ts b/packages/twenty-server/test/integration/metadata/suites/application/utils/run-my-application-health-check-query-factory.util.ts
new file mode 100644
index 00000000000..756ba3c7a8e
--- /dev/null
+++ b/packages/twenty-server/test/integration/metadata/suites/application/utils/run-my-application-health-check-query-factory.util.ts
@@ -0,0 +1,28 @@
+import gql from 'graphql-tag';
+import { type PerformMetadataQueryParams } from 'test/integration/metadata/types/perform-metadata-query.type';
+
+export type RunMyApplicationHealthCheckFactoryInput = {
+ applicationId: string;
+};
+
+const DEFAULT_RUN_MY_APPLICATION_HEALTH_CHECK_GQL_FIELDS = `
+ status
+ title
+ description
+`;
+
+export const runMyApplicationHealthCheckQueryFactory = ({
+ input,
+ gqlFields = DEFAULT_RUN_MY_APPLICATION_HEALTH_CHECK_GQL_FIELDS,
+}: PerformMetadataQueryParams<RunMyApplicationHealthCheckFactoryInput>) => ({
+ query: gql`
+ mutation RunMyApplicationHealthCheck($applicationId: UUID!) {
+ runMyApplicationHealthCheck(applicationId: $applicationId) {
+ ${gqlFields}
+ }
+ }
+ `,
+ variables: {
+ applicationId: input.applicationId,
+ },
+});
diff --git a/packages/twenty-server/test/integration/metadata/suites/application/utils/run-my-application-health-check.util.ts b/packages/twenty-server/test/integration/metadata/suites/application/utils/run-my-application-health-check.util.ts
new file mode 100644
index 00000000000..d5d56dee1b2
--- /dev/null
+++ b/packages/twenty-server/test/integration/metadata/suites/application/utils/run-my-application-health-check.util.ts
@@ -0,0 +1,45 @@
+import {
+ type RunMyApplicationHealthCheckFactoryInput,
+ runMyApplicationHealthCheckQueryFactory,
+} from 'test/integration/metadata/suites/application/utils/run-my-application-health-check-query-factory.util';
+import { makeMetadataApiRequest } from 'test/integration/metadata/suites/utils/make-metadata-api-request.util';
+import { type CommonResponseBody } from 'test/integration/metadata/types/common-response-body.type';
+import { type PerformMetadataQueryParams } from 'test/integration/metadata/types/perform-metadata-query.type';
+import { warnIfErrorButNotExpectedToFail } from 'test/integration/metadata/utils/warn-if-error-but-not-expected-to-fail.util';
+import { warnIfNoErrorButExpectedToFail } from 'test/integration/metadata/utils/warn-if-no-error-but-expected-to-fail.util';
+
+import { type ApplicationHealthCheckResultDTO } from 'src/engine/core-modules/application/dtos/application-health-check-result.dto';
+
+export const runMyApplicationHealthCheck = async ({
+ input,
+ gqlFields,
+ expectToFail = false,
+ token,
+}: PerformMetadataQueryParams<RunMyApplicationHealthCheckFactoryInput>): CommonResponseBody<{
+ runMyApplicationHealthCheck: ApplicationHealthCheckResultDTO | null;
+}> => {
+ const graphqlOperation = runMyApplicationHealthCheckQueryFactory({
+ input,
+ gqlFields,
+ });
+
+ const response = await makeMetadataApiRequest(graphqlOperation, token);
+
+ if (expectToFail) {
+ warnIfNoErrorButExpectedToFail({
+ response,
+ errorMessage:
+ 'Running my application health check should have failed but did not',
+ });
+ }
+
+ if (!expectToFail) {
+ warnIfErrorButNotExpectedToFail({
+ response,
+ errorMessage:
+ 'Running my application health check has failed but should not',
+ });
+ }
+
+ return { data: response.body.data, errors: response.body.errors };
+};
diff --git a/packages/twenty-server/test/integration/metadata/suites/application/utils/setup-application-with-user-health-check.util.ts b/packages/twenty-server/test/integration/metadata/suites/application/utils/setup-application-with-user-health-check.util.ts
new file mode 100644
index 00000000000..a5d41364a26
--- /dev/null
+++ b/packages/twenty-server/test/integration/metadata/suites/application/utils/setup-application-with-user-health-check.util.ts
@@ -0,0 +1,101 @@
+import { createHash } from 'crypto';
+
+import { TEST_APPLICATION_PACKAGE_JSON_CHECKSUM } from 'test/integration/metadata/suites/application/constants/test-application-package-json.constant';
+import { buildBaseManifest } from 'test/integration/metadata/suites/application/utils/build-base-manifest.util';
+import { findOneApplication } from 'test/integration/metadata/suites/application/utils/find-one-application.util';
+import { setupApplicationForSync } from 'test/integration/metadata/suites/application/utils/setup-application-for-sync.util';
+import { syncApplication } from 'test/integration/metadata/suites/application/utils/sync-application.util';
+import { uploadApplicationFile } from 'test/integration/metadata/suites/application/utils/upload-application-file.util';
+import { v4 as uuidv4 } from 'uuid';
+
+export type ApplicationWithUserHealthCheck = {
+ id: string;
+ universalIdentifier: string;
+};
+
+const USER_HEALTH_CHECK_NAME = 'user-health-check';
+
+const USER_HEALTH_CHECK_SOURCE = `export const handler = () => ({ status: 'OK' });`;
+
+export const setupApplicationWithUserHealthCheck = async ({
+ name,
+}: {
+ name: string;
+}): Promise<ApplicationWithUserHealthCheck> => {
+ const applicationUniversalIdentifier = uuidv4();
+ const roleUniversalIdentifier = uuidv4();
+ const userHealthCheckUniversalIdentifier = uuidv4();
+
+ await setupApplicationForSync({
+ applicationUniversalIdentifier,
+ name,
+ description: `${name} for user health check tests`,
+ sourcePath: `test-${applicationUniversalIdentifier}`,
+ });
+ jest.useRealTimers();
+
+ await uploadApplicationFile({
+ applicationUniversalIdentifier,
+ fileFolder: 'BuiltLogicFunction',
+ filePath: `dist/${USER_HEALTH_CHECK_NAME}.mjs`,
+ filename: `${USER_HEALTH_CHECK_NAME}.mjs`,
+ contentType: 'application/javascript',
+ fileBuffer: Buffer.from(USER_HEALTH_CHECK_SOURCE),
+ expectToFail: false,
+ });
+
+ await syncApplication({
+ manifest: buildBaseManifest({
+ appId: applicationUniversalIdentifier,
+ roleId: roleUniversalIdentifier,
+ overrides: {
+ application: {
+ universalIdentifier: applicationUniversalIdentifier,
+ defaultRoleUniversalIdentifier: roleUniversalIdentifier,
+ displayName: name,
+ description: `${name} for user health check tests`,
+ applicationVariables: {},
+ healthCheckLogicFunction: {
+ universalIdentifier: userHealthCheckUniversalIdentifier,
+ runOnUserPreferences: true,
+ },
+ packageJsonChecksum: TEST_APPLICATION_PACKAGE_JSON_CHECKSUM,
+ yarnLockChecksum: null,
+ },
+ roles: [
+ {
+ universalIdentifier: roleUniversalIdentifier,
+ label: `${name} role`,
+ description: 'A test role',
+ },
+ ],
+ logicFunctions: [
+ {
+ universalIdentifier: userHealthCheckUniversalIdentifier,
+ name: USER_HEALTH_CHECK_NAME,
+ handlerName: 'handler',
+ sourceHandlerPath: `src/${USER_HEALTH_CHECK_NAME}.ts`,
+ builtHandlerPath: `dist/${USER_HEALTH_CHECK_NAME}.mjs`,
+ builtHandlerChecksum: createHash('sha256')
+ .update(USER_HEALTH_CHECK_SOURCE)
+ .digest('hex'),
+ timeoutSeconds: 10,
+ },
+ ],
+ },
+ }),
+ expectToFail: false,
+ });
+ jest.useRealTimers();
+
+ const { data } = await findOneApplication({
+ input: { universalIdentifier: applicationUniversalIdentifier },
+ gqlFields: 'id',
+ expectToFail: false,
+ });
+
+ return {
+ id: data.findOneApplication.id,
+ universalIdentifier: applicationUniversalIdentifier,
+ };
+};