check on label metadata #12852

guillim · 2025-06-24T16:22:08Z

Better catching label input

there were absolutely no check on label when creating the target field while doing a relation : we crearted these checks here.
- We keep the label quite open to special char as discussed with Felix. so mostly checking length of label.
- We check that label does not already exists on the targetted object
making sure the Target fieldinput label is checked before we create it. The previous checks are not enough since the label goes through anoteher merthod before going in the database
validate-metadata-name-is-camel-case.utils.ts : making sure we can use this error message for metadata name and for target label

greptile-apps

PR Summary

Enhanced label validation across metadata modules with improved error handling and messaging.

Modified error message format in validateMetadataNameIsCamelCase to improve clarity by placing the invalid name at the start
Added new validateMetadataTargetLabelOrThrow utility that combines multiple validation checks for label validation
Implemented additional validation in field-metadata.service.ts to prevent duplicate field names and ensure valid target labels in relations
Added NOT_FIRST_LETTER_UPPER_CASE validation rule to enforce consistent label capitalization standards

_{4 files reviewed, 2 comments}
_{Edit PR Review Bot Settings | Greptile}

greptile-apps · 2025-06-24T16:22:42Z

...ages/twenty-server/src/engine/metadata-modules/utils/validate-metadata-target-label.utils.ts

@@ -0,0 +1,13 @@
+import { validateMetadataNameIsNotReservedKeywordOrThrow } from 'src/engine/metadata-modules/utils/validate-metadata-name-is-not-reserved-keyword';


syntax: Import path missing '.utils' extension - should match the pattern of other imports

greptile-apps · 2025-06-24T16:22:42Z

...ages/twenty-server/src/engine/metadata-modules/utils/validate-metadata-target-label.utils.ts

+    validateMetadataNameIsNotReservedKeywordOrThrow,
+  ];
+
+  validators.forEach((validator) => validator(label));


style: label.trim() should be used before validation to maintain consistency with existing label validation functions

github-actions · 2025-06-24T16:36:22Z

🚀 Preview Environment Ready!

Your preview environment is available at: http://bore.pub:55093

This environment will automatically shut down when the PR is closed or after 5 hours.

…check-metadata

charlesBochet · 2025-06-24T16:43:28Z

packages/twenty-server/src/engine/metadata-modules/field-metadata/field-metadata.service.ts

@@ -773,13 +798,28 @@ export class FieldMetadataService extends TypeOrmQueryService<FieldMetadataEntit
      );
    }

+    const targetFieldMetadataName = computeMetadataNameFromLabel(


…enty into label-check-metadata

prastoin · 2025-06-24T17:13:45Z

...ges/twenty-server/src/engine/metadata-modules/utils/exceptions/invalid-metadata.exception.ts

@@ -12,6 +12,7 @@ export enum InvalidMetadataExceptionCode {
  EXCEEDS_MAX_LENGTH = 'Exceeds max length',
  RESERVED_KEYWORD = 'Reserved keyword',
  NOT_CAMEL_CASE = 'Not camel case',
+  NOT_FIRST_LETTER_UPPER_CASE = 'Not first letter upper case',


Nitpick: IMO would be better as FIRST_LETTER_LOWER_CASE or NOT_CAPITALIZED

prastoin · 2025-06-24T17:14:05Z

...wenty-server/src/engine/metadata-modules/utils/validate-metadata-name-is-camel-case.utils.ts

@@ -8,7 +8,7 @@ import {
 export const validateMetadataNameIsCamelCaseOrThrow = (name: string) => {
  if (name !== camelCase(name)) {
    throw new InvalidMetadataException(
-      `Name should be in camelCase: ${name}`,
+      `${name} should be in camelCase`,


Remark: That's why you have so many snapshots errors

prastoin · 2025-06-24T17:44:36Z

@guillim I would highly recommend to implement integration testing on each relation label exceptions
We can do some peer on the subject, would recommend following the update object metadata testing tables

prastoin · 2025-06-24T17:57:43Z

Blocking test

  [Nest] 6252  - 06/24/2025, 5:46:26 PM   ERROR [WorkspaceMigrationRunnerService] Error executing migration: Enum type name not found for column createdBySource in table _house while trying to alter enum

prastoin

Looks like this has broken more things than expected
Will release 1.0.0 without it from now

[Nest] 6252  - 06/24/2025, 5:46:26 PM   ERROR [WorkspaceMigrationRunnerService] Error executing migration: Enum type name not found for column createdBySource in 
table _house while trying to alter enum

prastoin · 2025-06-24T18:01:40Z

Unable to reproduce in local tho 🤔
Might be flakiness, rerunning failed jobs

prastoin · 2025-06-24T18:19:45Z

Indeed there's flakiness

@prastoin

# Introduction Following #12852 Discovered that: - `relationCreationPayload` does not seem to be validated through the input decorators ```ts // TODO @prastoin implement validation for this with validate nested and dedicated class instance @IsOptional() @field(() => GraphQLJSON, { nullable: true }) relationCreationPayload?: { targetObjectMetadataId: string; targetFieldLabel: string; targetFieldIcon: string; type: RelationType; }; ``` - Sending an unknown `targetObjectMetadataId` generates an `internal_server_error` `500` @guillim on the go ## Coverage ```ts PASS test/integration/metadata/suites/object-metadata/failing-field-metadata-relation-creation.integration-spec.ts Field metadata relation creation should fail ✓ relation when targetFieldLabel is empty (109 ms) ✓ relation when targetFieldLabel exceeds maximum length (100 ms) ✓ relation when targetObjectMetadataId is unknown (97 ms) ✓ relation when targetFieldLabel contains only whitespace (103 ms) ✓ relation when targetFieldLabel conflicts with an existing field on target object metadata id (108 ms) Test Suites: 1 passed, 1 total Tests: 5 passed, 5 total Snapshots: 5 passed, 5 total Time: 2.629 s, estimated 3 s ```

Better catching label input - there were absolutely no check on label when creating the target field while doing a relation : we crearted these checks here. - We keep the label quite open to special char as discussed with Felix. so mostly checking length of label. - We check that label does not already exists on the targetted object - making sure the Target fieldinput label is checked before we create it. The previous checks are not enough since the label goes through anoteher merthod before going in the database - validate-metadata-name-is-camel-case.utils.ts : making sure we can use this error message for metadata name and for target label --------- Co-authored-by: Charles Bochet <[email protected]> Co-authored-by: prastoin <[email protected]>

@prastoin

# Introduction Following twentyhq#12852 Discovered that: - `relationCreationPayload` does not seem to be validated through the input decorators ```ts // TODO @prastoin implement validation for this with validate nested and dedicated class instance @IsOptional() @field(() => GraphQLJSON, { nullable: true }) relationCreationPayload?: { targetObjectMetadataId: string; targetFieldLabel: string; targetFieldIcon: string; type: RelationType; }; ``` - Sending an unknown `targetObjectMetadataId` generates an `internal_server_error` `500` @guillim on the go ## Coverage ```ts PASS test/integration/metadata/suites/object-metadata/failing-field-metadata-relation-creation.integration-spec.ts Field metadata relation creation should fail ✓ relation when targetFieldLabel is empty (109 ms) ✓ relation when targetFieldLabel exceeds maximum length (100 ms) ✓ relation when targetObjectMetadataId is unknown (97 ms) ✓ relation when targetFieldLabel contains only whitespace (103 ms) ✓ relation when targetFieldLabel conflicts with an existing field on target object metadata id (108 ms) Test Suites: 1 passed, 1 total Tests: 5 passed, 5 total Snapshots: 5 passed, 5 total Time: 2.629 s, estimated 3 s ```

check on label metadata

359ef65

greptile-apps bot reviewed Jun 24, 2025

View reviewed changes

guillim self-assigned this Jun 24, 2025

guillim added this to 🎯 Roadmap & Sprints Jun 24, 2025

guillim added 3 commits June 24, 2025 18:36

fix

cef61f2

Merge branch 'main' of https://github.com/twentyhq/twenty into label-…

eb68d60

…check-metadata

fix test

af59568

charlesBochet reviewed Jun 24, 2025

View reviewed changes

guillim and others added 4 commits June 24, 2025 18:45

fix test

d626061

Fix

9de7830

remove

99d476b

Merge branch 'label-check-metadata' of https://github.com/twentyhq/tw…

4afc758

…enty into label-check-metadata

prastoin reviewed Jun 24, 2025

View reviewed changes

chore(server): update snapshots

e47e6a7

prastoin enabled auto-merge (squash) June 24, 2025 17:42

prastoin approved these changes Jun 24, 2025

View reviewed changes

prastoin disabled auto-merge June 24, 2025 17:45

prastoin self-requested a review June 24, 2025 17:57

prastoin requested changes Jun 24, 2025

View reviewed changes

prastoin self-requested a review June 24, 2025 18:20

prastoin approved these changes Jun 24, 2025

View reviewed changes

prastoin merged commit fb0cf11 into main Jun 24, 2025
48 of 50 checks passed

prastoin deleted the label-check-metadata branch June 24, 2025 18:20

github-project-automation bot moved this to 🔦 In QA in 🎯 Roadmap & Sprints Jun 24, 2025

prastoin mentioned this pull request Jun 25, 2025

Field metadata relation edge cases exceptions coverage #12866

Merged

guillim moved this from 🔦 In QA to ✅ Done in 🎯 Roadmap & Sprints Jun 26, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

check on label metadata #12852

check on label metadata #12852

Uh oh!

guillim commented Jun 24, 2025 •

edited

Loading

Uh oh!

greptile-apps bot left a comment

Uh oh!

greptile-apps bot Jun 24, 2025

Uh oh!

greptile-apps bot Jun 24, 2025

Uh oh!

github-actions bot commented Jun 24, 2025 •

edited

Loading

Uh oh!

charlesBochet Jun 24, 2025

Uh oh!

prastoin Jun 24, 2025

Uh oh!

prastoin Jun 24, 2025

Uh oh!

prastoin commented Jun 24, 2025 •

edited

Loading

Uh oh!

prastoin commented Jun 24, 2025

Uh oh!

prastoin left a comment

Uh oh!

prastoin commented Jun 24, 2025

Uh oh!

prastoin commented Jun 24, 2025

Uh oh!

Uh oh!

Uh oh!

		@@ -0,0 +1,13 @@
		import { validateMetadataNameIsNotReservedKeywordOrThrow } from 'src/engine/metadata-modules/utils/validate-metadata-name-is-not-reserved-keyword';

check on label metadata #12852

check on label metadata #12852

Uh oh!

Conversation

guillim commented Jun 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

Uh oh!

greptile-apps bot Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jun 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

charlesBochet Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

prastoin Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

prastoin Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

prastoin commented Jun 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

prastoin commented Jun 24, 2025

Uh oh!

prastoin left a comment

Choose a reason for hiding this comment

Uh oh!

prastoin commented Jun 24, 2025

Uh oh!

prastoin commented Jun 24, 2025

Uh oh!

Uh oh!

Uh oh!

guillim commented Jun 24, 2025 •

edited

Loading

github-actions bot commented Jun 24, 2025 •

edited

Loading

prastoin commented Jun 24, 2025 •

edited

Loading