The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
Leave reserved variable names out of the app runtime env (#29230)
Paul Rastoin398c160a64ca
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 b4604c5ea4f..14f0b5ceba5 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@@ -1,6 +1,7 @@import { Injectable } from '@nestjs/common';import { InjectRepository } from '@nestjs/typeorm';+import { isNonEmptyString } from '@sniptt/guards';import { type ServerVariables } from 'twenty-shared/application';import { FieldMetadataType } from 'twenty-shared/types';import { isDefined, isNonEmptyArray } from 'twenty-shared/utils';@@ -68,6 +69,36 @@ export class ApplicationRegistrationVariableService {return variables.map((variable) => this.toObfuscatedDTO(variable));}+ async getServerEnvVariables({+ applicationRegistrationId,+ }: {+ applicationRegistrationId: string | null;+ }): Promise<Record<string, string>> {+ if (!isDefined(applicationRegistrationId)) {+ return {};+ }++ const variables = await this.variableRepository.find({+ where: { applicationRegistrationId },+ });++ const envVariables: Record<string, string> = {};++ for (const variable of variables) {+ if (isReservedEnvVariableName(variable.key)) {+ continue;+ }++ const plaintextValue = this.decryptValue(variable);++ if (isNonEmptyString(plaintextValue)) {+ envVariables[variable.key] = plaintextValue;+ }+ }++ return envVariables;+ }+async updateVariable({input,workspaceId,diff --git a/packages/twenty-server/src/engine/core-modules/application/application-variable/__tests__/user-application-variable-value.service.spec.ts b/packages/twenty-server/src/engine/core-modules/application/application-variable/__tests__/user-application-variable-value.service.spec.tsindex 435a38d7bfa..83d781b14fa 100644--- a/packages/twenty-server/src/engine/core-modules/application/application-variable/__tests__/user-application-variable-value.service.spec.ts+++ b/packages/twenty-server/src/engine/core-modules/application/application-variable/__tests__/user-application-variable-value.service.spec.ts@@ -12,6 +12,7 @@ import { WorkspaceCacheService } from 'src/engine/workspace-cache/services/worksconst WORKSPACE_ID = 'workspace-id';const APPLICATION_ID = 'application-id';const USER_WORKSPACE_ID = 'user-workspace-id';+const UNDECRYPTABLE_VALUE = 'enc:undecryptable';const buildFlatApplicationVariable = (overrides: Pick<FlatApplicationVariable, 'id' | 'key' | 'scope'> &@@ -50,6 +51,11 @@ const FLAT_APPLICATION_VARIABLES = [scope: 'USER',defaultValue: 'en',}),+ buildFlatApplicationVariable({+ id: 'legacy-setting-id',+ key: 'TWENTY_LEGACY_SETTING',+ scope: 'USER',+ }),];describe('UserApplicationVariableValueService', () => {@@ -81,7 +87,13 @@ describe('UserApplicationVariableValueService', () => {}: {value: string;isSecret: boolean;- }) => (isSecret ? '********' : `plaintext of ${value}`),+ }) => {+ if (value === UNDECRYPTABLE_VALUE) {+ throw new Error('Cannot decrypt');+ }++ return isSecret ? '********' : `plaintext of ${value}`;+ },},},{@@ -93,6 +105,9 @@ describe('UserApplicationVariableValueService', () => {'record-my-meetings-id': { [USER_WORKSPACE_ID]: 'enc:on' },'personal-api-key-id': { [USER_WORKSPACE_ID]: 'enc:key' },'language-id': { 'other-user-workspace-id': 'enc:fr' },+ 'legacy-setting-id': {+ [USER_WORKSPACE_ID]: UNDECRYPTABLE_VALUE,+ },},},}),@@ -106,7 +121,7 @@ describe('UserApplicationVariableValueService', () => {});describe('getServerEnvVariables', () => {- it('should give a run the values of the member behind it, secrets unmasked, and the defaults they did not set', async () => {+ it('should give a run the values of the member behind it, secrets unmasked, the defaults they did not set, and nothing stored under a reserved name', async () => {const envVariables = await service.getServerEnvVariables({workspaceId: WORKSPACE_ID,applicationId: APPLICATION_ID,@@ -130,4 +145,19 @@ describe('UserApplicationVariableValueService', () => {expect(envVariables).toEqual({});});});++ describe('getPublicEnvVariables', () => {+ it('should give front components the non-secret values of the member, without reserved names', async () => {+ const envVariables = await service.getPublicEnvVariables({+ workspaceId: WORKSPACE_ID,+ applicationId: APPLICATION_ID,+ userWorkspaceId: USER_WORKSPACE_ID,+ });++ expect(envVariables).toEqual({+ RECORD_MY_MEETINGS: 'plaintext of enc:on',+ LANGUAGE: 'en',+ });+ });+ });});diff --git a/packages/twenty-server/src/engine/core-modules/application/application-variable/application-variable.service.ts b/packages/twenty-server/src/engine/core-modules/application/application-variable/application-variable.service.tsindex 4de87710498..629781cb706 100644--- a/packages/twenty-server/src/engine/core-modules/application/application-variable/application-variable.service.ts+++ b/packages/twenty-server/src/engine/core-modules/application/application-variable/application-variable.service.ts@@ -8,6 +8,7 @@ import {ApplicationVariableEntityExceptionCode,} from 'src/engine/core-modules/application/application-variable/application-variable.exception';import { SECRET_APPLICATION_VARIABLE_MASK } from 'src/engine/core-modules/application/application-variable/constants/secret-application-variable-mask.constant';+import { isReservedEnvVariableName } from 'src/engine/core-modules/logic-function/logic-function-executor/utils/is-reserved-env-variable-name.util';import { type FlatApplicationVariableMaps } from 'src/engine/metadata-modules/flat-application-variable/types/flat-application-variable-maps.type';import { type PlaintextString } from 'src/engine/core-modules/secret-encryption/branded-strings/plaintext-string.type';import { SecretEncryptionService } from 'src/engine/core-modules/secret-encryption/secret-encryption.service';@@ -106,6 +107,7 @@ export class ApplicationVariableEntityService {): Record<string, string> {return flatApplicationVariables.filter(({ scope }) => scope !== 'USER')+ .filter(({ key }) => !isReservedEnvVariableName(key)).reduce<Record<string, string>>((acc, flatApplicationVariable) => {acc[flatApplicationVariable.key] = this.decryptValue(flatApplicationVariable,diff --git a/packages/twenty-server/src/engine/core-modules/application/application-variable/user-application-variable-value.service.ts b/packages/twenty-server/src/engine/core-modules/application/application-variable/user-application-variable-value.service.tsindex 67e00ce8ad4..68052e15148 100644--- a/packages/twenty-server/src/engine/core-modules/application/application-variable/user-application-variable-value.service.ts+++ b/packages/twenty-server/src/engine/core-modules/application/application-variable/user-application-variable-value.service.ts@@ -17,6 +17,7 @@ import { type WorkspaceMemberApplicationVariablesDTO } from 'src/engine/core-modimport { UserApplicationVariableValueEntity } from 'src/engine/core-modules/application/application-variable/user-application-variable-value.entity';import { toUserApplicationVariableValues } from 'src/engine/core-modules/application/application-variable/utils/to-user-application-variable-values.util';import { findActiveFlatApplicationByUniversalIdentifier } from 'src/engine/core-modules/application/utils/find-active-flat-application-by-universal-identifier.util';+import { isReservedEnvVariableName } from 'src/engine/core-modules/logic-function/logic-function-executor/utils/is-reserved-env-variable-name.util';import { type PlaintextString } from 'src/engine/core-modules/secret-encryption/branded-strings/plaintext-string.type';import { SecretEncryptionService } from 'src/engine/core-modules/secret-encryption/secret-encryption.service';import { UserWorkspaceEntity } from 'src/engine/core-modules/user-workspace/user-workspace.entity';@@ -267,7 +268,9 @@ export class UserApplicationVariableValueService {return Object.fromEntries(toUserApplicationVariableValues({- flatUserApplicationVariables,+ flatUserApplicationVariables: flatUserApplicationVariables.filter(+ ({ key }) => !isReservedEnvVariableName(key),+ ),userApplicationVariableValueMaps,userWorkspaceId,shouldMaskSecret: false,diff --git a/packages/twenty-server/src/engine/core-modules/logic-function/logic-function-executor/logic-function-executor.module.ts b/packages/twenty-server/src/engine/core-modules/logic-function/logic-function-executor/logic-function-executor.module.tsindex f5ff5947cde..7ac0a3fa330 100644--- a/packages/twenty-server/src/engine/core-modules/logic-function/logic-function-executor/logic-function-executor.module.ts+++ b/packages/twenty-server/src/engine/core-modules/logic-function/logic-function-executor/logic-function-executor.module.ts@@ -1,7 +1,7 @@import { Module } from '@nestjs/common';import { TypeOrmModule } from '@nestjs/typeorm';-import { ApplicationRegistrationVariableEntity } from 'src/engine/core-modules/application/application-registration-variable/application-registration-variable.entity';+import { ApplicationRegistrationVariableModule } from 'src/engine/core-modules/application/application-registration-variable/application-registration-variable.module';import { ApplicationVariableEntityModule } from 'src/engine/core-modules/application/application-variable/application-variable.module';import { ApplicationModule } from 'src/engine/core-modules/application/application.module';import { EventLogEmitterModule } from 'src/engine/core-modules/event-logs/emit/event-log-emitter.module';@@ -10,7 +10,6 @@ import { TokenModule } from 'src/engine/core-modules/auth/token/token.module';import { BillingModule } from 'src/engine/core-modules/billing/billing.module';import { WorkspaceDomainsModule } from 'src/engine/core-modules/domain/workspace-domains/workspace-domains.module';import { LogicFunctionExecutorService } from 'src/engine/core-modules/logic-function/logic-function-executor/logic-function-executor.service';-import { SecretEncryptionModule } from 'src/engine/core-modules/secret-encryption/secret-encryption.module';import { ThrottlerModule } from 'src/engine/core-modules/throttler/throttler.module';import { UsageLimitModule } from 'src/engine/core-modules/usage-limit/usage-limit.module';import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';@@ -23,18 +22,15 @@ import { WorkspaceCacheModule } from 'src/engine/workspace-cache/workspace-cacheEventLogEmitterModule,EventLogLiveModule,TokenModule,- SecretEncryptionModule,WorkspaceCacheModule,LogicFunctionPrebuiltWarmUpModule,BillingModule,WorkspaceDomainsModule,ApplicationModule,+ ApplicationRegistrationVariableModule,ApplicationVariableEntityModule,UsageLimitModule,- TypeOrmModule.forFeature([- ApplicationRegistrationVariableEntity,- WorkspaceEntity,- ]),+ TypeOrmModule.forFeature([WorkspaceEntity]),],providers: [LogicFunctionExecutorService],exports: [LogicFunctionExecutorService],diff --git a/packages/twenty-server/src/engine/core-modules/logic-function/logic-function-executor/logic-function-executor.service.ts b/packages/twenty-server/src/engine/core-modules/logic-function/logic-function-executor/logic-function-executor.service.tsindex a60dfc38e2a..4bfcd90bc83 100644--- a/packages/twenty-server/src/engine/core-modules/logic-function/logic-function-executor/logic-function-executor.service.ts+++ b/packages/twenty-server/src/engine/core-modules/logic-function/logic-function-executor/logic-function-executor.service.ts@@ -26,7 +26,7 @@ import {} from 'src/engine/core-modules/logic-function/logic-function-drivers/interfaces/logic-function-driver.interface';import { isBillingExemptApplication } from 'src/engine/core-modules/application/application-marketplace/utils/is-billing-exempt-application.util';-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 { ApplicationStopService } from 'src/engine/core-modules/application/application-stop/application-stop.service';import { UserApplicationVariableValueService } from 'src/engine/core-modules/application/application-variable/user-application-variable-value.service';import { ApplicationVariableEntityService } from 'src/engine/core-modules/application/application-variable/application-variable.service';@@ -45,7 +45,6 @@ import { buildLogicFunctionExecutionUsage } from 'src/engine/core-modules/logic-import { buildLogicFunctionRunMetricEvent } from 'src/engine/core-modules/logic-function/logic-function-executor/utils/build-logic-function-run-metric-event.util';import { LogicFunctionPrebuiltWarmUpService } from 'src/engine/core-modules/logic-function/logic-function-prebuilt-warm-up/logic-function-prebuilt-warm-up.service';import { SERVER_ROUTE_PATH } from 'src/engine/core-modules/server-route-trigger/constants/server-route-path.constant';-import { SecretEncryptionService } from 'src/engine/core-modules/secret-encryption/secret-encryption.service';import {ThrottlerException,ThrottlerExceptionCode,@@ -108,7 +107,7 @@ export class LogicFunctionExecutorService {private readonly twentyConfigService: TwentyConfigService,private readonly workspaceCacheService: WorkspaceCacheService,private readonly applicationTokenService: ApplicationTokenService,- private readonly secretEncryptionService: SecretEncryptionService,+ private readonly applicationRegistrationVariableService: ApplicationRegistrationVariableService,private readonly applicationVariableService: ApplicationVariableEntityService,private readonly userApplicationVariableValueService: UserApplicationVariableValueService,private readonly subscriptionService: SubscriptionService,@@ -121,8 +120,6 @@ export class LogicFunctionExecutorService {private readonly applicationStopService: ApplicationStopService,@InjectRepository(WorkspaceEntity)private readonly workspaceRepository: Repository<WorkspaceEntity>,- @InjectRepository(ApplicationRegistrationVariableEntity)- private readonly applicationRegistrationVariableRepository: Repository<ApplicationRegistrationVariableEntity>,) {}async executeOrThrow({@@ -458,9 +455,10 @@ export class LogicFunctionExecutorService {flatApplication,});- const serverVariables = await this.buildServerVariableEnvMap(- flatApplication.applicationRegistrationId,- );+ const serverVariables =+ await this.applicationRegistrationVariableService.getServerEnvVariables({+ applicationRegistrationId: flatApplication.applicationRegistrationId,+ });const workspaceVariables =await this.applicationVariableService.getServerEnvVariables({workspaceId,@@ -528,34 +526,6 @@ export class LogicFunctionExecutorService {});}- private async buildServerVariableEnvMap(- applicationRegistrationId: string | null,- ): Promise<Record<string, string>> {- if (!isDefined(applicationRegistrationId)) {- return {};- }-- const serverVariables =- await this.applicationRegistrationVariableRepository.find({- where: { applicationRegistrationId },- });-- const envMap: Record<string, string> = {};-- for (const variable of serverVariables) {- const plaintextValue =- this.secretEncryptionService.decryptVersionedOrThrow(- variable.encryptedValue,- );-- if (plaintextValue !== '') {- envMap[variable.key] = plaintextValue;- }- }-- return envMap;- }-private async publishLogicFunctionLogsToCli({result,flatApplication,