The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
Enforce server route app configuration requirements (#22091)
martmullb5958fb331b4
diff --git a/packages/twenty-docs/developers/extend/apps/logic/logic-functions.mdx b/packages/twenty-docs/developers/extend/apps/logic/logic-functions.mdxindex 2562f335bdc..2d0799f07df 100644--- a/packages/twenty-docs/developers/extend/apps/logic/logic-functions.mdx+++ b/packages/twenty-docs/developers/extend/apps/logic/logic-functions.mdx@@ -262,6 +262,10 @@ POST https://your-twenty-server.com/webhooks/server/:resolverLogicFunctionUniverThe identifier is the resolver's `universalIdentifier` from your manifest. Register that URL with the provider.+<Note>+**The application must be claimed and installed on its owner workspace.** Because the resolver runs in the **owner workspace** (the workspace that owns the application registration), a server route trigger only works once the application has been *claimed* — i.e. it has an owner workspace — **and** that application is **installed on the owner workspace**. Until both are true the resolver has nowhere to run, so the route cannot be dispatched. An application that exposes a `serverRouteTriggerSettings` logic function therefore cannot be listed in the marketplace until it is claimed and installed on its owner workspace.+</Note>+**Resolver contract.** The SDK's `LogicFunctionConfig` type enforces this at compile time: as soon as you set `serverRouteTriggerSettings`, your handler is constrained to return `{ workspaceId: string; targetLogicFunctionUniversalIdentifier: string; payload?: object }` (or a `Promise` of it). The `workspaceId` must be a workspace where the target function is installed, otherwise the request is rejected with `404`.| Field | Type | Notes |diff --git a/packages/twenty-front/src/pages/settings/applications/tabs/SettingsApplicationRegistrationGeneralTab.tsx b/packages/twenty-front/src/pages/settings/applications/tabs/SettingsApplicationRegistrationGeneralTab.tsxindex 6f7e9540a6f..03021db0b81 100644--- a/packages/twenty-front/src/pages/settings/applications/tabs/SettingsApplicationRegistrationGeneralTab.tsx+++ b/packages/twenty-front/src/pages/settings/applications/tabs/SettingsApplicationRegistrationGeneralTab.tsx@@ -24,7 +24,7 @@ export const SettingsApplicationRegistrationGeneralTab = ({{!registration.isConfigured && fromAdmin && (<InlineBannercolor="danger"- message={t`This app has required server variables that are not configured. Users won't be able to install it until all required variables are set.`}+ message={t`This app is not fully configured. Users won't be able to install it until all required server variables are set, and — for apps exposing a server route — until the app is claimed and installed on its owner workspace.`}button={{title: t`Configure`,onClick: () => navigate('#config'),diff --git a/packages/twenty-server/src/engine/core-modules/application/application-registration-variable/application-registration-variable.module.ts b/packages/twenty-server/src/engine/core-modules/application/application-registration-variable/application-registration-variable.module.tsindex 04e15401590..a15aa7bfe11 100644--- a/packages/twenty-server/src/engine/core-modules/application/application-registration-variable/application-registration-variable.module.ts+++ b/packages/twenty-server/src/engine/core-modules/application/application-registration-variable/application-registration-variable.module.ts@@ -4,6 +4,7 @@ import { TypeOrmModule } from '@nestjs/typeorm';import { ApplicationRegistrationVariableEntity } from 'src/engine/core-modules/application/application-registration-variable/application-registration-variable.entity';import { ApplicationRegistrationVariableService } from 'src/engine/core-modules/application/application-registration-variable/application-registration-variable.service';import { ApplicationRegistrationEntity } from 'src/engine/core-modules/application/application-registration/application-registration.entity';+import { ApplicationEntity } from 'src/engine/core-modules/application/application.entity';import { SecretEncryptionModule } from 'src/engine/core-modules/secret-encryption/secret-encryption.module';@Module({@@ -11,6 +12,7 @@ import { SecretEncryptionModule } from 'src/engine/core-modules/secret-encryptioTypeOrmModule.forFeature([ApplicationRegistrationVariableEntity,ApplicationRegistrationEntity,+ ApplicationEntity,]),SecretEncryptionModule,],diff --git a/packages/twenty-server/src/engine/core-modules/application/application-registration-variable/application-registration-variable.service.ts b/packages/twenty-server/src/engine/core-modules/application/application-registration-variable/application-registration-variable.service.tsindex 37037990956..9f662b58801 100644--- a/packages/twenty-server/src/engine/core-modules/application/application-registration-variable/application-registration-variable.service.ts+++ b/packages/twenty-server/src/engine/core-modules/application/application-registration-variable/application-registration-variable.service.ts@@ -7,6 +7,7 @@ import { In, Not, type Repository } from 'typeorm';import { ApplicationRegistrationVariableEntity } from 'src/engine/core-modules/application/application-registration-variable/application-registration-variable.entity';import { ApplicationRegistrationEntity } from 'src/engine/core-modules/application/application-registration/application-registration.entity';+import { ApplicationEntity } from 'src/engine/core-modules/application/application.entity';import {ApplicationRegistrationException,ApplicationRegistrationExceptionCode,@@ -23,6 +24,8 @@ export class ApplicationRegistrationVariableService {private readonly variableRepository: Repository<ApplicationRegistrationVariableEntity>,@InjectRepository(ApplicationRegistrationEntity)private readonly applicationRegistrationRepository: Repository<ApplicationRegistrationEntity>,+ @InjectRepository(ApplicationEntity)+ private readonly applicationRepository: Repository<ApplicationEntity>,private readonly encryptionService: SecretEncryptionService,) {}@@ -161,43 +164,71 @@ export class ApplicationRegistrationVariableService {async isConfiguredBatch(applicationRegistrationIds: string[],): Promise<Map<string, boolean>> {- const variables = await this.variableRepository.find({- where: { applicationRegistrationId: In(applicationRegistrationIds) },- });-- const variablesByRegistrationId = new Map<- string,- ApplicationRegistrationVariableEntity[]- >();-- for (const variable of variables) {- const existing =- variablesByRegistrationId.get(variable.applicationRegistrationId) ?? [];-- existing.push(variable);- variablesByRegistrationId.set(- variable.applicationRegistrationId,- existing,- );- }+ const [variables, registrations, installedApps] = await Promise.all([+ this.variableRepository.find({+ where: { applicationRegistrationId: In(applicationRegistrationIds) },+ }),+ this.applicationRegistrationRepository.find({+ where: { id: In(applicationRegistrationIds) },+ select: { id: true, manifest: true, ownerWorkspaceId: true },+ }),+ this.applicationRepository.find({+ where: { applicationRegistrationId: In(applicationRegistrationIds) },+ select: { applicationRegistrationId: true, workspaceId: true },+ }),+ ]);const result = new Map<string, boolean>();for (const id of applicationRegistrationIds) {- const registrationVariables = variablesByRegistrationId.get(id) ?? [];- const requiredVariables = registrationVariables.filter(- (v) => v.isRequired,+ const registration = registrations.find(+ (registration) => registration.id === id,+ );++ const areVariablesConfigured = variables+ .filter(+ (variable) =>+ variable.applicationRegistrationId === id && variable.isRequired,+ )+ .every((variable) => variable.isFilled);++ const isInstalledOnOwnerWorkspace = installedApps.some(+ (app) =>+ app.applicationRegistrationId === id &&+ app.workspaceId === registration?.ownerWorkspaceId,);result.set(id,- requiredVariables.every((v) => v.isFilled),+ areVariablesConfigured &&+ this.isServerRouteConfigured(+ registration,+ isInstalledOnOwnerWorkspace,+ ),);}return result;}+ private isServerRouteConfigured(+ registration: ApplicationRegistrationEntity | undefined,+ isInstalledOnOwnerWorkspace: boolean,+ ): boolean {+ const hasServerRouteFunction =+ registration?.manifest?.logicFunctions?.some((logicFunction) =>+ isDefined(logicFunction.serverRouteTriggerSettings),+ ) ?? false;++ if (!hasServerRouteFunction) {+ return true;+ }++ return (+ isDefined(registration?.ownerWorkspaceId) && isInstalledOnOwnerWorkspace+ );+ }+private async findVariableOrThrow(id: string,): Promise<ApplicationRegistrationVariableEntity> {diff --git a/packages/twenty-server/src/engine/core-modules/server-route-trigger/__tests__/server-route-trigger.service.spec.ts b/packages/twenty-server/src/engine/core-modules/server-route-trigger/__tests__/server-route-trigger.service.spec.tsindex d8b5cb6f09c..b61ef4479e1 100644--- a/packages/twenty-server/src/engine/core-modules/server-route-trigger/__tests__/server-route-trigger.service.spec.ts+++ b/packages/twenty-server/src/engine/core-modules/server-route-trigger/__tests__/server-route-trigger.service.spec.ts@@ -9,7 +9,6 @@ import {} from 'src/engine/core-modules/logic-function/logic-function-executor/logic-function-executor.service';import { ServerRouteTriggerExceptionCode } from 'src/engine/core-modules/server-route-trigger/exceptions/server-route-trigger.exception';import { ServerRouteTriggerService } from 'src/engine/core-modules/server-route-trigger/server-route-trigger.service';-import { type TwentyConfigService } from 'src/engine/core-modules/twenty-config/twenty-config.service';import { type LogicFunctionEntity } from 'src/engine/metadata-modules/logic-function/logic-function.entity';import { LogicFunctionExecutionStatus } from 'src/engine/metadata-modules/logic-function/dtos/logic-function-execution-result.dto';@@ -55,7 +54,6 @@ describe('ServerRouteTriggerService', () => {let logicFunctionExecutorService: jest.Mocked<Pick<LogicFunctionExecutorService, 'execute'>>;- let twentyConfigService: jest.Mocked<Pick<TwentyConfigService, 'get'>>;const handle = () =>service.handle({@@ -98,12 +96,10 @@ describe('ServerRouteTriggerService', () => {// target returns the final response body.mockResolvedValueOnce(buildExecuteResult({ ok: true })),};- twentyConfigService = { get: jest.fn().mockReturnValue(true) };service = new ServerRouteTriggerService(logicFunctionRepository as unknown as Repository<LogicFunctionEntity>,logicFunctionExecutorService as unknown as LogicFunctionExecutorService,- twentyConfigService as unknown as TwentyConfigService,);});@@ -133,14 +129,6 @@ describe('ServerRouteTriggerService', () => {);});- it('refuses when the feature is disabled', async () => {- twentyConfigService.get.mockReturnValue(false);-- await expect(handle()).rejects.toMatchObject({- code: ServerRouteTriggerExceptionCode.FEATURE_DISABLED,- });- });-it('throws LOGIC_FUNCTION_NOT_FOUND when no row matches the universalIdentifier', async () => {logicFunctionRepository.find.mockResolvedValue([]);diff --git a/packages/twenty-server/src/engine/core-modules/server-route-trigger/exceptions/server-route-trigger-rest-api-exception-filter.ts b/packages/twenty-server/src/engine/core-modules/server-route-trigger/exceptions/server-route-trigger-rest-api-exception-filter.tsindex 794d7bc3194..6c128abdbf5 100644--- a/packages/twenty-server/src/engine/core-modules/server-route-trigger/exceptions/server-route-trigger-rest-api-exception-filter.ts+++ b/packages/twenty-server/src/engine/core-modules/server-route-trigger/exceptions/server-route-trigger-rest-api-exception-filter.ts@@ -30,12 +30,6 @@ export class ServerRouteTriggerRestApiExceptionFilter implements ExceptionFilterresponse,404,);- case ServerRouteTriggerExceptionCode.FEATURE_DISABLED:- return this.httpExceptionHandlerService.handleError(- exception as CustomException,- response,- 503,- );case ServerRouteTriggerExceptionCode.RATE_LIMIT_EXCEEDED:return this.httpExceptionHandlerService.handleError(exception as CustomException,diff --git a/packages/twenty-server/src/engine/core-modules/server-route-trigger/exceptions/server-route-trigger.exception.ts b/packages/twenty-server/src/engine/core-modules/server-route-trigger/exceptions/server-route-trigger.exception.tsindex e821dd8cb8d..5016f5ee269 100644--- a/packages/twenty-server/src/engine/core-modules/server-route-trigger/exceptions/server-route-trigger.exception.ts+++ b/packages/twenty-server/src/engine/core-modules/server-route-trigger/exceptions/server-route-trigger.exception.ts@@ -5,7 +5,6 @@ import { assertUnreachable } from 'twenty-shared/utils';import { CustomException } from 'src/utils/custom-exception';export enum ServerRouteTriggerExceptionCode {- FEATURE_DISABLED = 'FEATURE_DISABLED',LOGIC_FUNCTION_NOT_FOUND = 'LOGIC_FUNCTION_NOT_FOUND',RATE_LIMIT_EXCEEDED = 'RATE_LIMIT_EXCEEDED',SERVER_ROUTE_USER_UNCAUGHT_ERROR = 'SERVER_ROUTE_USER_UNCAUGHT_ERROR',@@ -17,8 +16,6 @@ const getServerRouteTriggerExceptionUserFriendlyMessage = (code: ServerRouteTriggerExceptionCode,) => {switch (code) {- case ServerRouteTriggerExceptionCode.FEATURE_DISABLED:- return msg`Server logic functions are disabled on this instance.`;case ServerRouteTriggerExceptionCode.LOGIC_FUNCTION_NOT_FOUND:return msg`Server logic function not found.`;case ServerRouteTriggerExceptionCode.RATE_LIMIT_EXCEEDED:diff --git a/packages/twenty-server/src/engine/core-modules/server-route-trigger/server-route-trigger.service.ts b/packages/twenty-server/src/engine/core-modules/server-route-trigger/server-route-trigger.service.tsindex 60d8e23ee71..82c8b8ecf8b 100644--- a/packages/twenty-server/src/engine/core-modules/server-route-trigger/server-route-trigger.service.ts+++ b/packages/twenty-server/src/engine/core-modules/server-route-trigger/server-route-trigger.service.ts@@ -20,7 +20,6 @@ import {ServerRouteTriggerException,ServerRouteTriggerExceptionCode,} from 'src/engine/core-modules/server-route-trigger/exceptions/server-route-trigger.exception';-import { TwentyConfigService } from 'src/engine/core-modules/twenty-config/twenty-config.service';import { LogicFunctionEntity } from 'src/engine/metadata-modules/logic-function/logic-function.entity';type ResolverResult = {@@ -37,7 +36,6 @@ export class ServerRouteTriggerService {@InjectRepository(LogicFunctionEntity)private readonly logicFunctionRepository: Repository<LogicFunctionEntity>,private readonly logicFunctionExecutorService: LogicFunctionExecutorService,- private readonly twentyConfigService: TwentyConfigService,) {}async handle({@@ -47,13 +45,6 @@ export class ServerRouteTriggerService {request: Request;resolverLogicFunctionUniversalIdentifier: string;}): Promise<RouteTriggerResponse> {- if (!this.twentyConfigService.get('IS_SERVER_LOGIC_FUNCTION_ENABLED')) {- throw new ServerRouteTriggerException(- 'Server logic functions are disabled on this instance',- ServerRouteTriggerExceptionCode.FEATURE_DISABLED,- );- }-const resolver = await this.findResolver({logicFunctionUniversalIdentifier:resolverLogicFunctionUniversalIdentifier,diff --git a/packages/twenty-server/src/engine/core-modules/twenty-config/config-variables.ts b/packages/twenty-server/src/engine/core-modules/twenty-config/config-variables.tsindex 1b58b790cfe..027a6707a27 100644--- a/packages/twenty-server/src/engine/core-modules/twenty-config/config-variables.ts+++ b/packages/twenty-server/src/engine/core-modules/twenty-config/config-variables.ts@@ -695,14 +695,6 @@ export class ConfigVariables {@IsAWSRegion()LOGIC_FUNCTION_LAMBDA_LAYER_BUCKET_REGION?: AwsRegion;- @ConfigVariablesMetadata({- group: ConfigVariablesGroup.LOGIC_FUNCTION_CONFIG,- description: 'Enable instance-level (server) logic functions',- type: ConfigVariableType.BOOLEAN,- })- @IsOptional()- IS_SERVER_LOGIC_FUNCTION_ENABLED = false;-@ConfigVariablesMetadata({group: ConfigVariablesGroup.CODE_INTERPRETER_CONFIG,description: