Skip to content

The open alternative to Salesforce, designed for AI.

Reserve the standard application universal identifier for registrations (#28074)

Paul Rastoin9595fe07e39f
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-registration/__tests__/application-registration-upsert-from-catalog.spec.ts b/packages/twenty-server/src/engine/core-modules/application/application-registration/__tests__/application-registration-upsert-from-catalog.spec.ts
index 52737f81745..527777a7557 100644
--- a/packages/twenty-server/src/engine/core-modules/application/application-registration/__tests__/application-registration-upsert-from-catalog.spec.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/application-registration/__tests__/application-registration-upsert-from-catalog.spec.ts
@@ -1,10 +1,14 @@
import { Test, type TestingModule } from '@nestjs/testing';
import { getRepositoryToken } from '@nestjs/typeorm';
-import { type Manifest } from 'twenty-shared/application';
+import {
+ TWENTY_STANDARD_APPLICATION_UNIVERSAL_IDENTIFIER,
+ type Manifest,
+} from 'twenty-shared/application';
import { ApplicationRegistrationAssetUrlService } from 'src/engine/core-modules/application/application-registration/application-registration-asset-url.service';
import { ApplicationRegistrationEntity } from 'src/engine/core-modules/application/application-registration/application-registration.entity';
+import { ApplicationRegistrationExceptionCode } from 'src/engine/core-modules/application/application-registration/application-registration.exception';
import { ApplicationRegistrationLookupService } from 'src/engine/core-modules/application/application-registration/application-registration-lookup/application-registration-lookup.service';
import { ApplicationRegistrationService } from 'src/engine/core-modules/application/application-registration/application-registration.service';
import { ApplicationRegistrationVariableService } from 'src/engine/core-modules/application/application-registration-variable/application-registration-variable.service';
@@ -54,7 +58,7 @@ describe('ApplicationRegistrationService - upsertFromCatalog', () => {
beforeEach(async () => {
applicationRegistrationRepository = {
findOne: jest.fn(),
- save: jest.fn(),
+ save: jest.fn(async (entity) => entity),
create: jest.fn((entity) => entity),
};
@@ -248,4 +252,19 @@ describe('ApplicationRegistrationService - upsertFromCatalog', () => {
expect.objectContaining({ isListed: true }),
);
});
+
+ it('should refuse a catalog entry claiming the standard application identifier', async () => {
+ applicationRegistrationRepository.findOne.mockResolvedValue(null);
+
+ await expect(
+ service.upsertFromCatalog({
+ ...catalogParams,
+ universalIdentifier: TWENTY_STANDARD_APPLICATION_UNIVERSAL_IDENTIFIER,
+ }),
+ ).rejects.toMatchObject({
+ code: ApplicationRegistrationExceptionCode.UNIVERSAL_IDENTIFIER_ALREADY_CLAIMED,
+ });
+
+ expect(applicationRegistrationRepository.save).not.toHaveBeenCalled();
+ });
});
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-registration/application-registration.resolver.ts b/packages/twenty-server/src/engine/core-modules/application/application-registration/application-registration.resolver.ts
index b6015af344d..529867ceebd 100644
--- a/packages/twenty-server/src/engine/core-modules/application/application-registration/application-registration.resolver.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/application-registration/application-registration.resolver.ts
@@ -243,7 +243,7 @@ export class ApplicationRegistrationResolver {
@AuthWorkspace() { id: workspaceId }: WorkspaceEntity,
@AuthUser({ allowUndefined: true }) user: UserEntity | undefined,
): Promise<CreateApplicationRegistrationDTO> {
- return this.applicationRegistrationService.create({
+ return this.applicationRegistrationService.createWithClientSecret({
input,
ownerWorkspaceId: workspaceId,
createdByUserId: user?.id ?? null,
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-registration/application-registration.service.ts b/packages/twenty-server/src/engine/core-modules/application/application-registration/application-registration.service.ts
index a747c734f7b..62df974fc14 100644
--- a/packages/twenty-server/src/engine/core-modules/application/application-registration/application-registration.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/application-registration/application-registration.service.ts
@@ -6,10 +6,18 @@ import crypto from 'crypto';
import { isNonEmptyString } from '@sniptt/guards';
import * as bcrypt from 'bcrypt';
import isEqual from 'lodash.isequal';
-import { type Manifest } from 'twenty-shared/application';
+import {
+ TWENTY_STANDARD_APPLICATION_UNIVERSAL_IDENTIFIER,
+ type Manifest,
+} from 'twenty-shared/application';
import { isDefined, isNonEmptyArray, isValidUuid } from 'twenty-shared/utils';
import { WorkspaceActivationStatus } from 'twenty-shared/workspace';
-import { IsNull, type FindOptionsWhere, type Repository } from 'typeorm';
+import {
+ IsNull,
+ type DeepPartial,
+ type FindOptionsWhere,
+ type Repository,
+} from 'typeorm';
import { type QueryDeepPartialEntity } from 'typeorm/query-builder/QueryPartialEntity';
import { v4 } from 'uuid';
@@ -469,7 +477,7 @@ export class ApplicationRegistrationService {
};
}
- async create({
+ async createWithClientSecret({
input,
ownerWorkspaceId,
createdByUserId,
@@ -481,20 +489,6 @@ export class ApplicationRegistrationService {
applicationRegistration: ApplicationRegistrationEntity;
clientSecret: string;
}> {
- const universalIdentifier = input.universalIdentifier ?? v4();
-
- const existingByUid =
- await this.applicationRegistrationLookupService.findOneByUniversalIdentifierGlobal(
- universalIdentifier,
- );
-
- if (existingByUid) {
- throw new ApplicationRegistrationException(
- `Universal identifier ${universalIdentifier} is already claimed`,
- ApplicationRegistrationExceptionCode.UNIVERSAL_IDENTIFIER_ALREADY_CLAIMED,
- );
- }
-
if (isDefined(input.oAuthRedirectUris)) {
this.validateRedirectUris(input.oAuthRedirectUris);
}
@@ -503,24 +497,46 @@ export class ApplicationRegistrationService {
this.validateScopes(input.oAuthScopes);
}
- const clientId = v4();
const { clientSecret, clientSecretHash } =
await this.generateClientSecret();
- const applicationRegistration =
- this.applicationRegistrationRepository.create({
- universalIdentifier,
- name: input.name,
- oAuthClientId: clientId,
- oAuthClientSecretHash: clientSecretHash,
- oAuthRedirectUris: input.oAuthRedirectUris ?? [],
- oAuthScopes: input.oAuthScopes ?? [],
- createdByUserId,
- ownerWorkspaceId,
- });
+ const applicationRegistration = await this.create({
+ universalIdentifier: input.universalIdentifier ?? v4(),
+ name: input.name,
+ oAuthClientId: v4(),
+ oAuthClientSecretHash: clientSecretHash,
+ oAuthRedirectUris: input.oAuthRedirectUris ?? [],
+ oAuthScopes: input.oAuthScopes ?? [],
+ createdByUserId,
+ ownerWorkspaceId,
+ });
+
+ return { applicationRegistration, clientSecret };
+ }
+
+ async create(
+ fields: DeepPartial<ApplicationRegistrationEntity> & {
+ universalIdentifier: string;
+ },
+ ): Promise<ApplicationRegistrationEntity> {
+ const existingByUid =
+ await this.applicationRegistrationLookupService.findOneByUniversalIdentifierGlobal(
+ fields.universalIdentifier,
+ );
+
+ if (
+ isDefined(existingByUid) ||
+ fields.universalIdentifier.toLowerCase() ===
+ TWENTY_STANDARD_APPLICATION_UNIVERSAL_IDENTIFIER
+ ) {
+ throw new ApplicationRegistrationException(
+ `Universal identifier ${fields.universalIdentifier} is already claimed`,
+ ApplicationRegistrationExceptionCode.UNIVERSAL_IDENTIFIER_ALREADY_CLAIMED,
+ );
+ }
const saved = await this.applicationRegistrationRepository.save(
- applicationRegistration,
+ this.applicationRegistrationRepository.create(fields),
);
await this.invalidateMarketplaceAppsCache();
@@ -530,7 +546,7 @@ export class ApplicationRegistrationService {
applicationRegistration: saved,
});
- return { applicationRegistration: saved, clientSecret };
+ return saved;
}
async update(
@@ -940,7 +956,7 @@ export class ApplicationRegistrationService {
params: UpsertApplicationRegistrationFromCatalogParams,
{ isVetted }: { isVetted: boolean },
): Promise<ApplicationRegistrationEntity> {
- const registration = this.applicationRegistrationRepository.create({
+ const registration = await this.create({
universalIdentifier: params.universalIdentifier,
name: params.name,
sourceType: params.sourceType,
@@ -956,8 +972,6 @@ export class ApplicationRegistrationService {
ownerWorkspaceId: null,
});
- await this.applicationRegistrationRepository.save(registration);
-
this.emitRegistrationPublishMetric({
isNewRegistration: true,
universalIdentifier: params.universalIdentifier,
@@ -966,8 +980,6 @@ export class ApplicationRegistrationService {
version: params.latestAvailableVersion,
});
- await this.invalidateMarketplaceAppsCache();
-
if (isDefined(params.manifest.application.serverVariables)) {
await this.applicationRegistrationVariableService.syncVariableSchemas(
registration.id,
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-registration/application-tarball.service.ts b/packages/twenty-server/src/engine/core-modules/application/application-registration/application-tarball.service.ts
index 5f370a70761..49a461334bf 100644
--- a/packages/twenty-server/src/engine/core-modules/application/application-registration/application-tarball.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/application-registration/application-tarball.service.ts
@@ -484,22 +484,20 @@ export class ApplicationTarballService {
packageJsonVersion: string | null;
ownerWorkspaceId: string;
}): Promise<ApplicationRegistrationEntity> {
- return this.appRegistrationRepository.save(
- this.appRegistrationRepository.create({
- universalIdentifier,
- name: manifest.application?.displayName ?? 'Unknown App',
- sourceType: ApplicationRegistrationSourceType.TARBALL,
- manifest,
- ...fromManifestApplicationToDisplayFields(manifest.application),
- latestAvailableVersion: packageJsonVersion,
- isListed: false,
- isVetted: false,
- oAuthClientId: v4(),
- oAuthRedirectUris: [],
- oAuthScopes: [],
- ownerWorkspaceId,
- }),
- );
+ return this.applicationRegistrationService.create({
+ universalIdentifier,
+ name: manifest.application?.displayName ?? 'Unknown App',
+ sourceType: ApplicationRegistrationSourceType.TARBALL,
+ manifest,
+ ...fromManifestApplicationToDisplayFields(manifest.application),
+ latestAvailableVersion: packageJsonVersion,
+ isListed: false,
+ isVetted: false,
+ oAuthClientId: v4(),
+ oAuthRedirectUris: [],
+ oAuthScopes: [],
+ ownerWorkspaceId,
+ });
}
private async findOwnerCustomApplicationUniversalIdentifier(
diff --git a/packages/twenty-server/test/integration/metadata/suites/application/failing-application-registration-standard-universal-identifier.integration-spec.ts b/packages/twenty-server/test/integration/metadata/suites/application/failing-application-registration-standard-universal-identifier.integration-spec.ts
new file mode 100644
index 00000000000..39abf10b949
--- /dev/null
+++ b/packages/twenty-server/test/integration/metadata/suites/application/failing-application-registration-standard-universal-identifier.integration-spec.ts
@@ -0,0 +1,107 @@
+import gql from 'graphql-tag';
+import { buildBaseManifest } from 'test/integration/metadata/suites/application/utils/build-base-manifest.util';
+import { createAppTarball } from 'test/integration/metadata/suites/application/utils/create-app-tarball.util';
+import { findApplicationRegistrationByUniversalIdentifier } from 'test/integration/metadata/suites/application/utils/find-application-registration-by-universal-identifier.util';
+import { syncMarketplaceCatalogFromRegistryPackage } from 'test/integration/metadata/suites/application/utils/sync-marketplace-catalog-from-registry-package.util';
+import { uploadAppTarball } from 'test/integration/metadata/suites/application/utils/upload-app-tarball.util';
+import { makeMetadataApiRequest } from 'test/integration/metadata/suites/utils/make-metadata-api-request.util';
+import { TWENTY_STANDARD_APPLICATION_UNIVERSAL_IDENTIFIER } from 'twenty-shared/application';
+import { v4 as uuidv4 } from 'uuid';
+
+import { ApplicationRegistrationExceptionCode } from 'src/engine/core-modules/application/application-registration/application-registration.exception';
+
+jest.setTimeout(120000);
+
+const STANDARD_APPLICATION_UNIVERSAL_IDENTIFIERS = [
+ TWENTY_STANDARD_APPLICATION_UNIVERSAL_IDENTIFIER,
+ TWENTY_STANDARD_APPLICATION_UNIVERSAL_IDENTIFIER.toUpperCase(),
+];
+
+const expectNoStandardApplicationRegistration = async () => {
+ expect(
+ await findApplicationRegistrationByUniversalIdentifier({
+ universalIdentifier: TWENTY_STANDARD_APPLICATION_UNIVERSAL_IDENTIFIER,
+ }),
+ ).toBeNull();
+};
+
+describe('Application registration should refuse the standard application universal identifier', () => {
+ beforeAll(() => {
+ jest.useRealTimers();
+ });
+
+ afterAll(async () => {
+ // Registration rows only: the shared cleanup util would also delete the
+ // workspaces' real standard application rows.
+ await globalThis.testDataSource.query(
+ `DELETE FROM core."applicationRegistration"
+ WHERE "universalIdentifier" = $1`,
+ [TWENTY_STANDARD_APPLICATION_UNIVERSAL_IDENTIFIER],
+ );
+
+ jest.useFakeTimers();
+ });
+
+ it.each(STANDARD_APPLICATION_UNIVERSAL_IDENTIFIERS)(
+ 'should refuse createApplicationRegistration with %s',
+ async (universalIdentifier) => {
+ const response = await makeMetadataApiRequest({
+ query: gql`
+ mutation CreateApplicationRegistration(
+ $input: CreateApplicationRegistrationInput!
+ ) {
+ createApplicationRegistration(input: $input) {
+ applicationRegistration {
+ id
+ }
+ }
+ }
+ `,
+ variables: {
+ input: { name: 'Standard application', universalIdentifier },
+ },
+ });
+
+ expect(response.body.errors?.[0]?.extensions?.subCode).toBe(
+ ApplicationRegistrationExceptionCode.UNIVERSAL_IDENTIFIER_ALREADY_CLAIMED,
+ );
+ await expectNoStandardApplicationRegistration();
+ },
+ );
+
+ it.each(STANDARD_APPLICATION_UNIVERSAL_IDENTIFIERS)(
+ 'should refuse a tarball upload with %s',
+ async (universalIdentifier) => {
+ const { errors } = await uploadAppTarball({
+ tarballBuffer: await createAppTarball({
+ 'manifest.json': JSON.stringify(
+ buildBaseManifest({ appId: universalIdentifier, roleId: uuidv4() }),
+ ),
+ 'package.json': JSON.stringify({
+ name: 'test-standard-application-tarball',
+ version: '1.0.0',
+ }),
+ }),
+ expectToFail: true,
+ });
+
+ expect(errors?.[0]?.extensions?.subCode).toBe(
+ ApplicationRegistrationExceptionCode.UNIVERSAL_IDENTIFIER_ALREADY_CLAIMED,
+ );
+ await expectNoStandardApplicationRegistration();
+ },
+ );
+
+ it('should not register a catalog entry with the standard application identifier', async () => {
+ await syncMarketplaceCatalogFromRegistryPackage({
+ packageName: '@test/standard-application-squatter',
+ version: '1.0.0',
+ manifest: buildBaseManifest({
+ appId: TWENTY_STANDARD_APPLICATION_UNIVERSAL_IDENTIFIER,
+ roleId: uuidv4(),
+ }),
+ });
+
+ await expectNoStandardApplicationRegistration();
+ });
+});