Skip to content

The open alternative to Salesforce, designed for AI.

Ignore isSecret changes on existing application and server variables (#28800)

Paul Rastoin2e5df366688a
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.ts
index a7ab7d92682..48000a21fab 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
@@ -138,7 +138,6 @@ export class ApplicationRegistrationVariableService {
if (existing) {
await variableRepository.update(existing.id, {
description: schema.description ?? '',
- isSecret: schema.isSecret ?? true,
isRequired,
isDeprecated,
type: schema.type ?? FieldMetadataType.TEXT,
diff --git a/packages/twenty-server/src/engine/metadata-modules/flat-entity/constant/__tests__/__snapshots__/all-universal-flat-entity-properties-to-compare-and-stringify.constant.spec.ts.snap b/packages/twenty-server/src/engine/metadata-modules/flat-entity/constant/__tests__/__snapshots__/all-universal-flat-entity-properties-to-compare-and-stringify.constant.spec.ts.snap
index 11992107f45..7b6e9011c4a 100644
--- a/packages/twenty-server/src/engine/metadata-modules/flat-entity/constant/__tests__/__snapshots__/all-universal-flat-entity-properties-to-compare-and-stringify.constant.spec.ts.snap
+++ b/packages/twenty-server/src/engine/metadata-modules/flat-entity/constant/__tests__/__snapshots__/all-universal-flat-entity-properties-to-compare-and-stringify.constant.spec.ts.snap
@@ -42,7 +42,6 @@ exports[`ALL_UNIVERSAL_FLAT_ENTITY_PROPERTIES_TO_COMPARE_AND_STRINGIFY should ma
"key",
"description",
"label",
- "isSecret",
"isDeprecated",
"isRequired",
"type",
diff --git a/packages/twenty-server/src/engine/metadata-modules/flat-entity/constant/all-entity-properties-configuration-by-metadata-name.constant.ts b/packages/twenty-server/src/engine/metadata-modules/flat-entity/constant/all-entity-properties-configuration-by-metadata-name.constant.ts
index 9097f6d39f2..543d3213985 100644
--- a/packages/twenty-server/src/engine/metadata-modules/flat-entity/constant/all-entity-properties-configuration-by-metadata-name.constant.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/flat-entity/constant/all-entity-properties-configuration-by-metadata-name.constant.ts
@@ -1868,7 +1868,7 @@ export const ALL_ENTITY_PROPERTIES_CONFIGURATION_BY_METADATA_NAME = {
universalProperty: undefined,
},
isSecret: {
- toCompare: true,
+ toCompare: false,
toStringify: false,
universalProperty: undefined,
},
diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/application-variable/services/update-application-variable-action-handler.service.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/application-variable/services/update-application-variable-action-handler.service.ts
index 1e6bd62e684..a14c1ebabe9 100644
--- a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/application-variable/services/update-application-variable-action-handler.service.ts
+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/action-handlers/application-variable/services/update-application-variable-action-handler.service.ts
@@ -47,8 +47,6 @@ export class UpdateApplicationVariableActionHandlerService extends WorkspaceMigr
};
}
- // Value is always encrypted regardless of isSecret, so toggling
- // isSecret does not require re-encrypting or decrypting the stored value.
async executeForMetadata(
context: WorkspaceMigrationActionRunnerContext<FlatUpdateApplicationVariableAction>,
): Promise<void> {
diff --git a/packages/twenty-server/test/integration/metadata/suites/application/application-variable-is-secret-manifest-sync.integration-spec.ts b/packages/twenty-server/test/integration/metadata/suites/application/application-variable-is-secret-manifest-sync.integration-spec.ts
new file mode 100644
index 00000000000..db3cb350fc8
--- /dev/null
+++ b/packages/twenty-server/test/integration/metadata/suites/application/application-variable-is-secret-manifest-sync.integration-spec.ts
@@ -0,0 +1,140 @@
+import crypto from 'crypto';
+
+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 { 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 { type Manifest } from 'twenty-shared/application';
+
+const TEST_APP_ID = crypto.randomUUID();
+const TEST_ROLE_ID = crypto.randomUUID();
+const SECRET_SETTING_ID = crypto.randomUUID();
+const PUBLIC_SETTING_ID = crypto.randomUUID();
+
+type IsSecretByKey = Record<
+ | 'SECRET_SETTING'
+ | 'PUBLIC_SETTING'
+ | 'SECRET_SERVER_KEY'
+ | 'PUBLIC_SERVER_KEY',
+ boolean
+>;
+
+const INITIAL_IS_SECRET_BY_KEY: IsSecretByKey = {
+ SECRET_SETTING: true,
+ PUBLIC_SETTING: false,
+ SECRET_SERVER_KEY: true,
+ PUBLIC_SERVER_KEY: false,
+};
+
+const buildManifest = ({
+ isSecretByKey,
+ description,
+}: {
+ isSecretByKey: IsSecretByKey;
+ description: string;
+}): Manifest => {
+ const baseManifest = buildBaseManifest({
+ appId: TEST_APP_ID,
+ roleId: TEST_ROLE_ID,
+ });
+
+ return {
+ ...baseManifest,
+ application: {
+ ...baseManifest.application,
+ applicationVariables: {
+ SECRET_SETTING: {
+ universalIdentifier: SECRET_SETTING_ID,
+ description,
+ isSecret: isSecretByKey.SECRET_SETTING,
+ },
+ PUBLIC_SETTING: {
+ universalIdentifier: PUBLIC_SETTING_ID,
+ description,
+ isSecret: isSecretByKey.PUBLIC_SETTING,
+ },
+ },
+ serverVariables: {
+ SECRET_SERVER_KEY: {
+ description,
+ isSecret: isSecretByKey.SECRET_SERVER_KEY,
+ },
+ PUBLIC_SERVER_KEY: {
+ description,
+ isSecret: isSecretByKey.PUBLIC_SERVER_KEY,
+ },
+ },
+ },
+ };
+};
+
+const readVariablesByKey = async () => {
+ const rows: { key: string; description: string; isSecret: boolean }[] =
+ await globalThis.testDataSource.query(
+ `SELECT key, description, "isSecret" FROM core."applicationVariable"
+ WHERE "universalIdentifier" = ANY($1)
+ UNION ALL
+ SELECT variable.key, variable.description, variable."isSecret"
+ FROM core."applicationRegistrationVariable" variable
+ JOIN core."applicationRegistration" registration
+ ON registration.id = variable."applicationRegistrationId"
+ WHERE registration."universalIdentifier" = $2`,
+ [[SECRET_SETTING_ID, PUBLIC_SETTING_ID], TEST_APP_ID],
+ );
+
+ return Object.fromEntries(
+ rows.map(({ key, description, isSecret }) => [
+ key,
+ { description, isSecret },
+ ]),
+ );
+};
+
+describe('Manifest sync - variable isSecret', () => {
+ beforeAll(async () => {
+ await setupApplicationForSync({
+ applicationUniversalIdentifier: TEST_APP_ID,
+ name: 'Test Variable Is Secret App',
+ description: 'App for testing variable isSecret changes',
+ sourcePath: 'test-application-variable-is-secret',
+ });
+
+ await syncApplication({
+ manifest: buildManifest({
+ isSecretByKey: INITIAL_IS_SECRET_BY_KEY,
+ description: 'Initial description',
+ }),
+ expectToFail: false,
+ });
+ }, 120000);
+
+ afterAll(async () => {
+ await cleanupApplicationAndAppRegistration({
+ applicationUniversalIdentifier: TEST_APP_ID,
+ });
+ });
+
+ it('should ignore isSecret changes on existing variables', async () => {
+ await syncApplication({
+ manifest: buildManifest({
+ isSecretByKey: {
+ SECRET_SETTING: false,
+ PUBLIC_SETTING: true,
+ SECRET_SERVER_KEY: false,
+ PUBLIC_SERVER_KEY: true,
+ },
+ description: 'Updated description',
+ }),
+ expectToFail: false,
+ });
+
+ expect(await readVariablesByKey()).toEqual(
+ Object.fromEntries(
+ Object.entries(INITIAL_IS_SECRET_BY_KEY).map(([key, isSecret]) => [
+ key,
+ { description: 'Updated description', isSecret },
+ ]),
+ ),
+ );
+ });
+});