Skip to content

The open alternative to Salesforce, designed for AI.

refactor(shared): expose universal identifier validation (#27140)

Weiko183d0a7854c5
diff --git a/packages/twenty-sdk/src/cli/utilities/build/manifest/__tests__/manifest-validate.spec.ts b/packages/twenty-sdk/src/cli/utilities/build/manifest/__tests__/manifest-validate.spec.ts
index d068fb1775e..54393a3bd5b 100644
--- a/packages/twenty-sdk/src/cli/utilities/build/manifest/__tests__/manifest-validate.spec.ts
+++ b/packages/twenty-sdk/src/cli/utilities/build/manifest/__tests__/manifest-validate.spec.ts
@@ -441,23 +441,24 @@ describe('manifestValidate', () => {
expect(result.errors).toHaveLength(0);
});
- it('should pass with UUID v5 identifiers', () => {
- const v5Field: FieldManifest = {
- objectUniversalIdentifier: '20202020-b374-4779-a561-80086cb2e17f',
- universalIdentifier: '21f7f8de-8051-5b89-8680-0195ef798b6a',
- type: FieldMetadataType.TEXT,
- name: 'v5Field',
- label: 'V5 Field',
- };
-
- const result = manifestValidate({
- ...validManifest,
- fields: [v5Field],
- });
+ it.each([
+ '21f7f8de-8051-5b89-8680-0195ef798b6a',
+ 'bbbbbbbb-bbbb-6bbb-8bbb-bbbbbbbbbbbb',
+ 'bbbbbbbb-bbbb-7bbb-8bbb-bbbbbbbbbbbb',
+ 'bbbbbbbb-bbbb-8bbb-8bbb-bbbbbbbbbbbb',
+ 'ffffffff-ffff-ffff-ffff-ffffffffffff',
+ ])(
+ 'should pass with supported universal identifier %s',
+ (universalIdentifier) => {
+ const result = manifestValidate({
+ ...validManifest,
+ fields: [{ ...validField, universalIdentifier }],
+ });
- expect(result.isValid).toBe(true);
- expect(result.errors).toHaveLength(0);
- });
+ expect(result.isValid).toBe(true);
+ expect(result.errors).toHaveLength(0);
+ },
+ );
it('should fail with UUID v1 identifiers', () => {
const v1Uuid = '6ba7b810-9dad-11d1-80b4-00c04fd430c8';
@@ -475,12 +476,9 @@ describe('manifestValidate', () => {
});
expect(result.isValid).toBe(false);
- expect(result.errors).toContainEqual(
- expect.stringContaining(`"${v1Uuid}" is UUID version 1`),
- );
- expect(result.errors).toContainEqual(
- expect.stringContaining('Only UUID version 4 or higher is allowed'),
- );
+ expect(result.errors).toEqual([
+ `Invalid universal identifiers: Universal identifier "${v1Uuid}" is UUID version 1. Only UUID version 4 or higher is allowed.`,
+ ]);
});
it('should fail with UUID v3 identifiers', () => {
@@ -529,9 +527,9 @@ describe('manifestValidate', () => {
});
expect(result.isValid).toBe(false);
- expect(result.errors).toContainEqual(
- expect.stringContaining('"not-a-uuid" is not a valid UUID'),
- );
+ expect(result.errors).toEqual([
+ 'Invalid universal identifiers: Universal identifier "not-a-uuid" is not a valid UUID.',
+ ]);
});
it('should not report duplicate version errors for the same identifier', () => {
@@ -968,6 +966,32 @@ describe('manifestValidate', () => {
expect(manifestValidate(manifest).errors).toHaveLength(0);
});
+ it.each([
+ 'bbbbbbbb-bbbb-7bbb-8bbb-bbbbbbbbbbbb',
+ 'ffffffff-ffff-ffff-ffff-ffffffffffff',
+ ])(
+ 'accepts supported external timeline reference %s',
+ (universalIdentifier) => {
+ const manifest = buildTimelineManifest();
+ const [timelineActivityType] = manifest.timelineActivityTypes;
+
+ timelineActivityType.emit!.objectUniversalIdentifier =
+ universalIdentifier;
+ timelineActivityType.replacesTimelineActivityTypeUniversalIdentifier =
+ universalIdentifier;
+ timelineActivityType.emit!.through!.relationFieldUniversalIdentifier =
+ universalIdentifier;
+ timelineActivityType.emit!.through!.triggerFieldUniversalIdentifiers = [
+ universalIdentifier,
+ ];
+
+ const result = manifestValidate(manifest);
+
+ expect(result.isValid).toBe(true);
+ expect(result.errors).toHaveLength(0);
+ },
+ );
+
it('validates external-object route identifiers without resolving their metadata', () => {
const manifest = buildTimelineManifest();
const [timelineActivityType] = manifest.timelineActivityTypes;
diff --git a/packages/twenty-sdk/src/cli/utilities/build/manifest/manifest-validate.ts b/packages/twenty-sdk/src/cli/utilities/build/manifest/manifest-validate.ts
index ded2686c9a6..84bb1bb5822 100644
--- a/packages/twenty-sdk/src/cli/utilities/build/manifest/manifest-validate.ts
+++ b/packages/twenty-sdk/src/cli/utilities/build/manifest/manifest-validate.ts
@@ -2,10 +2,12 @@ import { isNonEmptyString } from '@sniptt/guards';
import { validate as uuidValidate, version as uuidVersion } from 'uuid';
import {
+ MINIMUM_UNIVERSAL_IDENTIFIER_UUID_VERSION,
type Manifest,
type PageLayoutManifest,
type PageLayoutTabManifest,
type PageLayoutWidgetManifest,
+ isValidUniversalIdentifier,
normalizePageLayoutTabManifest,
} from 'twenty-shared/application';
import {
@@ -18,7 +20,6 @@ import { isDefined } from 'twenty-shared/utils';
import {
getDuplicateValues,
type ManifestField,
- MINIMUM_UNIVERSAL_IDENTIFIER_UUID_VERSION,
isRelationFieldManifest,
} from '@/cli/utilities/build/manifest/utils/manifest-validation-helpers';
import { getPageLayoutDeprecationWarnings } from '@/cli/utilities/build/manifest/utils/get-page-layout-deprecation-warnings';
@@ -118,7 +119,10 @@ const validateRelationFields = (fields: ManifestField[]): string[] => {
};
const collectPageLayoutWidgets = (
- manifest: Pick<Manifest, 'pageLayouts' | 'pageLayoutTabs' | 'pageLayoutWidgets'>,
+ manifest: Pick<
+ Manifest,
+ 'pageLayouts' | 'pageLayoutTabs' | 'pageLayoutWidgets'
+ >,
): PageLayoutWidgetManifest[] => {
const widgetsFromPageLayouts = manifest.pageLayouts.flatMap(
(pageLayout) => pageLayout.tabs?.flatMap((tab) => tab.widgets ?? []) ?? [],
@@ -230,9 +234,9 @@ const invalidUniversalIdentifierVersions = (
continue;
}
- const version = uuidVersion(identifier);
+ if (!isValidUniversalIdentifier(identifier)) {
+ const version = uuidVersion(identifier);
- if (version < MINIMUM_UNIVERSAL_IDENTIFIER_UUID_VERSION) {
errors.push(
`Universal identifier "${identifier}" is UUID version ${version}. ` +
`Only UUID version ${MINIMUM_UNIVERSAL_IDENTIFIER_UUID_VERSION} or higher is allowed.`,
diff --git a/packages/twenty-sdk/src/cli/utilities/build/manifest/utils/manifest-validation-helpers.ts b/packages/twenty-sdk/src/cli/utilities/build/manifest/utils/manifest-validation-helpers.ts
index 8cc2e6a9d59..95c2617869e 100644
--- a/packages/twenty-sdk/src/cli/utilities/build/manifest/utils/manifest-validation-helpers.ts
+++ b/packages/twenty-sdk/src/cli/utilities/build/manifest/utils/manifest-validation-helpers.ts
@@ -4,8 +4,6 @@ import {
type RelationAndMorphRelationFieldMetadataType,
} from 'twenty-shared/types';
-export const MINIMUM_UNIVERSAL_IDENTIFIER_UUID_VERSION = 4;
-
const RELATION_FIELD_TYPES: FieldMetadataType[] = [
FieldMetadataType.RELATION,
FieldMetadataType.MORPH_RELATION,
diff --git a/packages/twenty-sdk/src/cli/utilities/build/manifest/utils/validate-timeline-activity-types.ts b/packages/twenty-sdk/src/cli/utilities/build/manifest/utils/validate-timeline-activity-types.ts
index e9991f1a13c..b87016b6f83 100644
--- a/packages/twenty-sdk/src/cli/utilities/build/manifest/utils/validate-timeline-activity-types.ts
+++ b/packages/twenty-sdk/src/cli/utilities/build/manifest/utils/validate-timeline-activity-types.ts
@@ -1,19 +1,15 @@
import { isNonEmptyString } from '@sniptt/guards';
-import { validate as uuidValidate, version as uuidVersion } from 'uuid';
-
-import { type Manifest } from 'twenty-shared/application';
+import {
+ type Manifest,
+ isValidUniversalIdentifier,
+} from 'twenty-shared/application';
import { RelationType } from 'twenty-shared/types';
import { isDefined, isNonEmptyArray } from 'twenty-shared/utils';
import {
getDuplicateValues,
- MINIMUM_UNIVERSAL_IDENTIFIER_UUID_VERSION,
isRelationFieldManifest,
} from '@/cli/utilities/build/manifest/utils/manifest-validation-helpers';
-const isValidUniversalIdentifier = (universalIdentifier: string): boolean =>
- uuidValidate(universalIdentifier) &&
- uuidVersion(universalIdentifier) >= MINIMUM_UNIVERSAL_IDENTIFIER_UUID_VERSION;
-
export const validateTimelineActivityTypes = (
manifest: Pick<
Manifest,
diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/services/workspace-entity-migration-builder.service.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/services/workspace-entity-migration-builder.service.ts
index d18b646b311..d60bec41c8b 100644
--- a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/services/workspace-entity-migration-builder.service.ts
+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/services/workspace-entity-migration-builder.service.ts
@@ -1,9 +1,12 @@
import { Inject } from '@nestjs/common';
+import {
+ isValidUniversalIdentifier,
+ MINIMUM_UNIVERSAL_IDENTIFIER_UUID_VERSION,
+} from 'twenty-shared/application';
import { type AllMetadataName } from 'twenty-shared/metadata';
import { type FromTo } from 'twenty-shared/types';
import { isDefined } from 'twenty-shared/utils';
-import { validate as uuidValidate, version as uuidVersion } from 'uuid';
import { LoggerService } from 'src/engine/core-modules/logger/logger.service';
import { WORKSPACE_MIGRATION_DURATION_MS_BUCKET_BOUNDARIES } from 'src/engine/core-modules/metrics/constants/workspace-migration-duration-ms-bucket-boundaries.constant';
@@ -476,14 +479,11 @@ export abstract class WorkspaceEntityMigrationBuilderService<
private validateUniversalIdentifier({
flatEntityToValidate: { universalIdentifier },
}: UniversalFlatEntityValidationArgs<T>): FlatEntityValidationError[] {
- if (
- !uuidValidate(universalIdentifier) ||
- uuidVersion(universalIdentifier) < 4
- ) {
+ if (!isValidUniversalIdentifier(universalIdentifier)) {
return [
{
code: FlatEntityMapsExceptionCode.ENTITY_MALFORMED,
- message: `Invalid universalIdentifier: "${universalIdentifier}" is not a valid UUID, uuid version should be greater than 4`,
+ message: `Invalid universalIdentifier: "${universalIdentifier}" is not a valid UUID, uuid version should be greater than ${MINIMUM_UNIVERSAL_IDENTIFIER_UUID_VERSION}`,
value: universalIdentifier,
},
];
diff --git a/packages/twenty-shared/src/application/constants/MinimumUniversalIdentifierUuidVersion.ts b/packages/twenty-shared/src/application/constants/MinimumUniversalIdentifierUuidVersion.ts
new file mode 100644
index 00000000000..aef48db5766
--- /dev/null
+++ b/packages/twenty-shared/src/application/constants/MinimumUniversalIdentifierUuidVersion.ts
@@ -0,0 +1 @@
+export const MINIMUM_UNIVERSAL_IDENTIFIER_UUID_VERSION = 4;
diff --git a/packages/twenty-shared/src/application/index.ts b/packages/twenty-shared/src/application/index.ts
index 284f873b439..04bcbdebe61 100644
--- a/packages/twenty-shared/src/application/index.ts
+++ b/packages/twenty-shared/src/application/index.ts
@@ -78,6 +78,7 @@ export { DEFAULT_SETTINGS_MENU_ITEM_POSITION } from './constants/DefaultSettings
export { FRONT_COMPONENT_SHARED_DEPENDENCIES_BUILT_PATH } from './constants/FrontComponentSharedDependenciesBuiltPath';
export { FRONT_COMPONENT_SHARED_DEPENDENCIES_IMPORT_SPECIFIER } from './constants/FrontComponentSharedDependenciesImportSpecifier';
export { GENERATED_DIR } from './constants/GeneratedDirectory';
+export { MINIMUM_UNIVERSAL_IDENTIFIER_UUID_VERSION } from './constants/MinimumUniversalIdentifierUuidVersion';
export { NODE_ESM_CJS_BANNER } from './constants/NodeEsmCjsBanner';
export { OUTPUT_DIR } from './constants/OutputDirectory';
export { TWENTY_STANDARD_APPLICATION_NAME } from './constants/TwentyStandardApplicationName';
@@ -252,6 +253,7 @@ export {
RESERVED_SETTINGS_MENU_ITEM_TITLES,
isReservedSettingsMenuItemTitle,
} from './utils/isReservedSettingsMenuItemTitle';
+export { isValidUniversalIdentifier } from './utils/isValidUniversalIdentifier';
export type {
ViewManifestFilterValue,
ViewFieldManifest,
diff --git a/packages/twenty-shared/src/application/utils/__tests__/isValidUniversalIdentifier.test.ts b/packages/twenty-shared/src/application/utils/__tests__/isValidUniversalIdentifier.test.ts
new file mode 100644
index 00000000000..9da842c5e84
--- /dev/null
+++ b/packages/twenty-shared/src/application/utils/__tests__/isValidUniversalIdentifier.test.ts
@@ -0,0 +1,38 @@
+import { isValidUniversalIdentifier } from '@/application/utils/isValidUniversalIdentifier';
+
+describe('isValidUniversalIdentifier', () => {
+ it.each([4, 5, 6, 7, 8])('should accept UUIDv%s', (version) => {
+ const universalIdentifier = `bbbbbbbb-bbbb-${version}bbb-8bbb-bbbbbbbbbbbb`;
+
+ expect(isValidUniversalIdentifier(universalIdentifier)).toBe(true);
+ expect(isValidUniversalIdentifier(universalIdentifier.toUpperCase())).toBe(
+ true,
+ );
+ });
+
+ it.each([1, 2, 3])('should reject UUIDv%s', (version) => {
+ expect(
+ isValidUniversalIdentifier(
+ `bbbbbbbb-bbbb-${version}bbb-8bbb-bbbbbbbbbbbb`,
+ ),
+ ).toBe(false);
+ });
+
+ it.each([
+ '',
+ 'invalid',
+ 'bbbbbbbbbbbb4bbb8bbbbbbbbbbbbbbb',
+ 'bbbbbbbb-bbbb-4bbb-0bbb-bbbbbbbbbbbb',
+ 'bbbbbbbb-bbbb-9bbb-8bbb-bbbbbbbbbbbb',
+ ' bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb',
+ '00000000-0000-0000-0000-000000000000',
+ ])('should reject invalid universal identifier %j', (universalIdentifier) => {
+ expect(isValidUniversalIdentifier(universalIdentifier)).toBe(false);
+ });
+
+ it('should preserve acceptance of the maximum UUID', () => {
+ expect(
+ isValidUniversalIdentifier('ffffffff-ffff-ffff-ffff-ffffffffffff'),
+ ).toBe(true);
+ });
+});
diff --git a/packages/twenty-shared/src/application/utils/isValidUniversalIdentifier.ts b/packages/twenty-shared/src/application/utils/isValidUniversalIdentifier.ts
new file mode 100644
index 00000000000..a987f2a05bb
--- /dev/null
+++ b/packages/twenty-shared/src/application/utils/isValidUniversalIdentifier.ts
@@ -0,0 +1,7 @@
+import { validate as uuidValidate, version as uuidVersion } from 'uuid';
+
+import { MINIMUM_UNIVERSAL_IDENTIFIER_UUID_VERSION } from '@/application/constants/MinimumUniversalIdentifierUuidVersion';
+
+export const isValidUniversalIdentifier = (identifier: string): boolean =>
+ uuidValidate(identifier) &&
+ uuidVersion(identifier) >= MINIMUM_UNIVERSAL_IDENTIFIER_UUID_VERSION;