morph relation : renaming an object #13404
Merged
+343
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
Greptile Summary
This PR implements support for renaming objects that participate in morph relations. In Twenty's system, morph relations enable polymorphic associations where a field can reference multiple object types (e.g., Opportunity -> Company OR Person). When such objects are renamed, the join column names in the database must be updated accordingly.
The implementation adds four key components:
-
New exception handling: Adds
INVALID_ORM_OUTPUTtoObjectMetadataExceptionCodefor handling ORM operation errors during complex metadata operations -
Morph relation field discovery: Introduces
findTargetMorphRelationFieldMetadatasmethod to identify morph relation fields that target a specific object being renamed -
Join column name updates: Implements
updateMorphRelationsJoinColumnNamemethod that updates join column names for MANY_TO_ONE morph relations, with proper type validation and database persistence -
Database migration generation: Adds
updateMorphRelationMigrationsmethod that creates ALTER migrations to rename join columns while preserving data integrity
The solution integrates into the existing object renaming workflow in object-metadata.service.ts, following the same pattern used for regular relation updates. When an object like 'Person' is renamed to 'Individual', join columns like 'ownerPersonId' are automatically updated to 'ownerIndividualId' across all morph relations, ensuring referential integrity is maintained.
Confidence score: 3/5
- This change involves complex metadata operations with potential for data corruption if migration logic is incorrect
- The implementation uses sequential database operations in loops which could impact performance and introduce race conditions
- The
findTargetMorphRelationFieldMetadatasmethod loads full relations which may cause performance issues in workspaces with many morph relations - Files need more attention:
object-metadata-field-relation.service.ts(performance concerns with nested loops and sequential saves),object-metadata-migration.service.ts(migration correctness validation needed)
4 files reviewed, 2 comments
Comment on lines
+383
to
+385
| `Settings for morph relation field should be defined ${morphRelationFieldMetadata.fieldMetadata.name}`, | ||
| ObjectMetadataExceptionCode.INVALID_ORM_OUTPUT, | ||
| ); |
There was a problem hiding this comment.
style: Error message includes technical implementation details like 'Settings' and field metadata concepts that users wouldn't understand
Comment on lines
+492
to
+493
| const morphRelationFieldMetadataToUpdateWithNewJoinColumnName = []; | ||
|
|
There was a problem hiding this comment.
style: Consider using a more descriptive variable name like updatedMorphRelations instead of abbreviating to avoid confusion
|
🚀 Preview Environment Ready! Your preview environment is available at: http://bore.pub:30484 This environment will automatically shut down when the PR is closed or after 5 hours. |
| }, | ||
| }); | ||
|
|
||
| if (!this.validateFieldMetadataTypeIsMorphRelation(fieldMetadatas)) { |
There was a problem hiding this comment.
I think you have created this type validator util in deleted morph field PR, no ?
There was a problem hiding this comment.
there was this one for both relation and morph relation but not exaclty the same though
areFieldMetadatasTypeRelationOrMorphRelation
you think i should refactor those util into one ?
...c/engine/metadata-modules/object-metadata/services/object-metadata-field-relation.service.ts
Show resolved
Hide resolved
...c/engine/metadata-modules/object-metadata/services/object-metadata-field-relation.service.ts
Outdated
Show resolved
Hide resolved
📊 API Changes ReportREST Metadata API Analysis ErrorError Output |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why
If we have a Morph Relation, like :
Opportunity <-> Company & People
Let's say it's a MANY_TO_ONE on Opportunity side
Then we have two joinColumnNames looking like
Let's say someone renames the obejct Person (assume we can even though standard obejcts cannot be renames per say at the moment in the API)
We need to update the joinColumnName and create the associated migrations