houseassassin/twenty
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: provision INDEX view fields for relations created in the same batch as their object (#23665)

Browse Source 
## Context

Fixes twentyhq/core-team-issues#2749: when an app manifest creates an
object and its relation fields in a single sync, the engine-owned INDEX
view ended up with no viewField at all for RELATION / MORPH_RELATION
fields, not even a hidden one. Adding the same relation to a
pre-existing object in a second sync produced a visible viewField.

## Root cause

`fieldIndexViewFieldOnCreate` is the sole owner of caller-field view
fields on the INDEX view (`objectSystemFieldsAndIndexViewOnCreate` only
emits view fields for displayable system fields). Its same-batch branch
gated on `isFlatFieldMetadataDisplayableInDefaultView`, which excludes
RELATION / MORPH_RELATION, so relations were dropped and nothing else
picked them up.

The guard's other exclusions (reserved names like `id`/`deletedAt`,
system-only types TS_VECTOR / POSITION) are unreachable there: side
effect handlers only trigger on caller-authored entities (the engine
reads triggers from the pre-expansion matrix), and the flat field
validators reject those names/types for caller fields. The guard could
only ever drop relations.

## Fix

- Remove the displayability guard from
`buildViewFieldForObjectCreatedInSameBatch`.
- Remove the `displayableOnly` filter from
`computeCallerFlatFieldMetadatasForObject`: every caller field now gets
a view field, and both handlers keep deriving positions from the same
list, so the interleaved layout stays consistent by construction (label
identifier, caller fields in input order with relations, then
displayable system fields).
- Build the view field literal through a single
`buildIndexFlatViewFieldToCreate` helper on all handler branches instead
of `computeFlatViewFieldsToCreate`, whose internal displayability filter
would have dropped relations again. That util keeps its semantics for
its remaining callers (system-field view fields, object creation via
API, committed upgrade commands). Both identifier derivations are the
same deterministic uuid (asserted by an existing twenty-shared spec), so
emitted identifiers are unchanged.
- `isFlatFieldMetadataDisplayableInDefaultView` itself is untouched: the
committed 2-26 upgrade command and the system-field filtering still rely
on its current semantics.

## Tests

- New manifest-sync integration test (first commit, TDD red then green):
a single sync creating two objects and a MANY_TO_ONE / ONE_TO_MANY
relation pair asserts each object's INDEX view has a visible view field
for its relation, plus a control case adding the same relations to
pre-existing objects in a second sync.
- Unit spec: the test that locked in the noop now asserts a visible view
field at the expected position for RELATION and MORPH_RELATION.
- Verified locally: all 62 metadata-side-effect unit tests, the new
integration spec, `successful-sync-application-workspace-migration` (4
snapshots), `relabel-onto-new-field-manifest-sync`,
`create-one-field-metadata-relation`, plus twenty-server typecheck and
lint.
This commit is contained in:
Paul Rastoin
2026-08-03 11:23:12 +02:00
committed by GitHub
parent c0efc1d897
commit 6afc3d33a4
6 changed files with 348 additions and 86 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/twenty-server/src/engine/metadata-modules/metadata-side-effect/handlers/field-metadata/services/__tests__/field-index-view-field-on-create-side-effect-handler.service.spec.ts
+46 -14
View File
@@ -312,22 +312,54 @@ describe('FieldIndexViewFieldOnCreateSideEffectHandlerService', () => {
expect(result.status).toBe('success');
});
it('should noop for a non-displayable field (relation) at object creation', () => {
const relationField = buildPendingFieldMetadata(
'assignee',
FieldMetadataType.RELATION,
);
// Parity with the existing-object path: a relation created in the same
// batch as its object gets a visible INDEX view field too, otherwise the
// same manifest yields different views depending on whether the object
// pre-existed (twentyhq/core-team-issues#2749).
it.each([
['relation', FieldMetadataType.RELATION],
['morph relation', FieldMetadataType.MORPH_RELATION],
])(
'should emit a visible view field for a %s field created in the same batch as its object',
(_label, fieldMetadataType) => {
const relationField = buildPendingFieldMetadata(
'assignee',
fieldMetadataType,
);
const result = handler.buildSideEffects(
buildArgs({
triggerFieldMetadata: relationField,
pendingFieldMetadatas: [NAME_FIELD, relationField],
objectMetadataCreatedInBatch: true,
}),
);
const result = handler.buildSideEffects(
buildArgs({
triggerFieldMetadata: relationField,
pendingFieldMetadatas: [NAME_FIELD, relationField],
objectMetadataCreatedInBatch: true,
}),
);
expect(result.status).toBe('noop');
});
expect(result.status).toBe('success');
if (result.status !== 'success') {
throw new Error('expected success');
}
const viewFields = Object.values(
result.operations.viewField?.flatEntityToCreate ?? {},
);
expect(viewFields).toHaveLength(1);
expect(viewFields[0].universalIdentifier).toBe(
computeViewFieldUniversalIdentifier({
viewUniversalIdentifier: DERIVED_INDEX_VIEW_UNIVERSAL_IDENTIFIER,
fieldMetadataUniversalIdentifier: relationField.universalIdentifier,
}),
);
expect(viewFields[0].viewUniversalIdentifier).toBe(
DERIVED_INDEX_VIEW_UNIVERSAL_IDENTIFIER,
);
expect(viewFields[0].position).toBe(1);
expect(viewFields[0].isVisible).toBe(true);
expect(viewFields[0].isSystemSideEffect).toBe(true);
},
);
});
describe('field created on an existing object (historical createOneField behavior)', () => {
packages/twenty-server/src/engine/metadata-modules/metadata-side-effect/handlers/field-metadata/services/field-index-view-field-on-create-side-effect-handler.service.ts
+35 -43
View File
@@ -17,8 +17,6 @@ import {
MetadataSideEffectHandler,
} from 'src/engine/metadata-modules/metadata-side-effect/interfaces/base-metadata-side-effect-handler.service';
import { type MetadataSideEffectResult } from 'src/engine/metadata-modules/metadata-side-effect/types/metadata-side-effect-result.type';
import { computeFlatViewFieldsToCreate } from 'src/engine/metadata-modules/object-metadata/utils/compute-flat-view-fields-to-create.util';
import { isFlatFieldMetadataDisplayableInDefaultView } from 'src/engine/metadata-modules/object-metadata/utils/is-flat-field-metadata-displayable-in-default-view.util';
import { type UniversalFlatFieldMetadata } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-field-metadata.type';
import { type UniversalFlatViewField } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-view-field.type';
@@ -29,7 +27,7 @@ export class FieldIndexViewFieldOnCreateSideEffectHandlerService extends Metadat
metadataName: 'fieldMetadata',
name: 'fieldIndexViewFieldOnCreate',
description:
'When a field is created, provision its visible view field on the parent object INDEX view. Owns the view fields of every caller-provided field; engine-emitted fields get theirs from the handler that emits them.',
'When a field is created, provision its visible view field on the parent object INDEX view. Owns the view fields of every caller-provided field, relations included; engine-emitted fields get theirs from the handler that emits them.',
},
) {
buildSideEffects({
@@ -111,27 +109,16 @@ export class FieldIndexViewFieldOnCreateSideEffectHandlerService extends Metadat
};
indexViewUniversalIdentifier: string;
allFlatEntityOperationRecordByMetadataName: BuildSideEffectsArgs<'fieldMetadata'>['allFlatEntityOperationRecordByMetadataName'];
}): UniversalFlatViewField | undefined {
}): UniversalFlatViewField {
const { labelIdentifierFieldMetadataUniversalIdentifier } =
parentFlatObjectMetadata;
if (
!isFlatFieldMetadataDisplayableInDefaultView({
flatFieldMetadata: sourceFlatFieldMetadata,
labelIdentifierFieldMetadataUniversalIdentifier,
})
) {
return undefined;
}
const displayableCallerFlatFieldMetadatas =
computeCallerFlatFieldMetadatasForObject({
objectMetadataUniversalIdentifier:
sourceFlatFieldMetadata.objectMetadataUniversalIdentifier,
labelIdentifierFieldMetadataUniversalIdentifier,
allFlatEntityOperationRecordByMetadataName,
displayableOnly: true,
});
const callerFlatFieldMetadatas = computeCallerFlatFieldMetadatasForObject({
objectMetadataUniversalIdentifier:
sourceFlatFieldMetadata.objectMetadataUniversalIdentifier,
labelIdentifierFieldMetadataUniversalIdentifier,
allFlatEntityOperationRecordByMetadataName,
});
const positionByFieldUniversalIdentifier =
computeDefaultIndexViewFieldPositionByFieldUniversalIdentifier({
@@ -140,7 +127,7 @@ export class FieldIndexViewFieldOnCreateSideEffectHandlerService extends Metadat
objectMetadataUniversalIdentifier:
sourceFlatFieldMetadata.objectMetadataUniversalIdentifier,
labelIdentifierFieldMetadataUniversalIdentifier,
displayableCallerFlatFieldMetadatas,
callerFlatFieldMetadatas,
});
const position =
@@ -148,16 +135,11 @@ export class FieldIndexViewFieldOnCreateSideEffectHandlerService extends Metadat
sourceFlatFieldMetadata.universalIdentifier,
) ?? 0;
const [flatViewFieldToCreate] = computeFlatViewFieldsToCreate({
objectFlatFieldMetadatas: [sourceFlatFieldMetadata],
viewUniversalIdentifier: indexViewUniversalIdentifier,
applicationUniversalIdentifier:
sourceFlatFieldMetadata.applicationUniversalIdentifier,
labelIdentifierFieldMetadataUniversalIdentifier,
startPosition: position,
return this.buildIndexFlatViewFieldToCreate({
sourceFlatFieldMetadata,
indexViewUniversalIdentifier,
position,
});
return flatViewFieldToCreate;
}
private buildViewFieldForExistingObject({
@@ -213,17 +195,12 @@ export class FieldIndexViewFieldOnCreateSideEffectHandlerService extends Metadat
existingActivePositions.length > 0
? Math.min(...existingActivePositions)
: 1;
const [flatLabelViewFieldToCreate] = computeFlatViewFieldsToCreate({
objectFlatFieldMetadatas: [sourceFlatFieldMetadata],
viewUniversalIdentifier: indexViewUniversalIdentifier,
applicationUniversalIdentifier:
sourceFlatFieldMetadata.applicationUniversalIdentifier,
labelIdentifierFieldMetadataUniversalIdentifier:
parentFlatObjectMetadata.labelIdentifierFieldMetadataUniversalIdentifier,
startPosition: lowestExistingPosition - 1,
});
return flatLabelViewFieldToCreate;
return this.buildIndexFlatViewFieldToCreate({
sourceFlatFieldMetadata,
indexViewUniversalIdentifier,
position: lowestExistingPosition - 1,
});
}
const appendBasePosition =
@@ -238,7 +215,6 @@ export class FieldIndexViewFieldOnCreateSideEffectHandlerService extends Metadat
labelIdentifierFieldMetadataUniversalIdentifier:
parentFlatObjectMetadata.labelIdentifierFieldMetadataUniversalIdentifier,
allFlatEntityOperationRecordByMetadataName,
displayableOnly: false,
});
const indexAmongCallerFlatFieldMetadatas = Math.max(
@@ -250,6 +226,22 @@ export class FieldIndexViewFieldOnCreateSideEffectHandlerService extends Metadat
0,
);
return this.buildIndexFlatViewFieldToCreate({
sourceFlatFieldMetadata,
indexViewUniversalIdentifier,
position: appendBasePosition + indexAmongCallerFlatFieldMetadatas,
});
}
private buildIndexFlatViewFieldToCreate({
sourceFlatFieldMetadata,
indexViewUniversalIdentifier,
position,
}: {
sourceFlatFieldMetadata: UniversalFlatFieldMetadata;
indexViewUniversalIdentifier: string;
position: number;
}): UniversalFlatViewField {
const createdAt = new Date().toISOString();
const { applicationUniversalIdentifier } = sourceFlatFieldMetadata;
@@ -268,7 +260,7 @@ export class FieldIndexViewFieldOnCreateSideEffectHandlerService extends Metadat
viewFieldGroupUniversalIdentifier: null,
isVisible: true,
size: DEFAULT_VIEW_FIELD_SIZE,
position: appendBasePosition + indexAmongCallerFlatFieldMetadatas,
position,
aggregateOperation: null,
isActive: true,
isSystemSideEffect: true,
packages/twenty-server/src/engine/metadata-modules/metadata-side-effect/handlers/object-metadata/services/object-system-fields-and-index-view-on-create-side-effect-handler.service.ts
+7 -9
View File
@@ -58,14 +58,12 @@ export class ObjectSystemFieldsAndIndexViewOnCreateSideEffectHandlerService exte
applicationUniversalIdentifier,
});
const displayableCallerFlatFieldMetadatas =
computeCallerFlatFieldMetadatasForObject({
objectMetadataUniversalIdentifier: universalIdentifier,
labelIdentifierFieldMetadataUniversalIdentifier:
sourceFlatObjectMetadata.labelIdentifierFieldMetadataUniversalIdentifier,
allFlatEntityOperationRecordByMetadataName,
displayableOnly: true,
});
const callerFlatFieldMetadatas = computeCallerFlatFieldMetadatasForObject({
objectMetadataUniversalIdentifier: universalIdentifier,
labelIdentifierFieldMetadataUniversalIdentifier:
sourceFlatObjectMetadata.labelIdentifierFieldMetadataUniversalIdentifier,
allFlatEntityOperationRecordByMetadataName,
});
const positionByFieldUniversalIdentifier =
computeDefaultIndexViewFieldPositionByFieldUniversalIdentifier({
@@ -73,7 +71,7 @@ export class ObjectSystemFieldsAndIndexViewOnCreateSideEffectHandlerService exte
objectMetadataUniversalIdentifier: universalIdentifier,
labelIdentifierFieldMetadataUniversalIdentifier:
sourceFlatObjectMetadata.labelIdentifierFieldMetadataUniversalIdentifier,
displayableCallerFlatFieldMetadatas,
callerFlatFieldMetadatas,
});
const flatViewFieldsToCreate = computeFlatViewFieldsToCreate({
packages/twenty-server/src/engine/metadata-modules/metadata-side-effect/handlers/utils/compute-caller-flat-field-metadatas-for-object.util.ts
+1 -9
View File
@@ -1,5 +1,4 @@
import { type AllFlatEntityOperationRecordByMetadataName } from 'src/engine/metadata-modules/flat-entity/types/all-flat-entity-operation-record-by-metadata-name.type';
import { isFlatFieldMetadataDisplayableInDefaultView } from 'src/engine/metadata-modules/object-metadata/utils/is-flat-field-metadata-displayable-in-default-view.util';
import { orderFlatFieldMetadatasForSystemIndexView } from 'src/engine/metadata-modules/object-metadata/utils/order-flat-field-metadatas-for-system-index-view.util';
import { type UniversalFlatFieldMetadata } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-field-metadata.type';
@@ -7,12 +6,10 @@ export const computeCallerFlatFieldMetadatasForObject = ({
objectMetadataUniversalIdentifier,
labelIdentifierFieldMetadataUniversalIdentifier,
allFlatEntityOperationRecordByMetadataName,
displayableOnly,
}: {
objectMetadataUniversalIdentifier: string;
labelIdentifierFieldMetadataUniversalIdentifier: string | null;
allFlatEntityOperationRecordByMetadataName: AllFlatEntityOperationRecordByMetadataName;
displayableOnly: boolean;
}): UniversalFlatFieldMetadata[] =>
orderFlatFieldMetadatasForSystemIndexView({
labelIdentifierFieldMetadataUniversalIdentifier,
@@ -25,11 +22,6 @@ export const computeCallerFlatFieldMetadatasForObject = ({
(flatFieldMetadata) =>
flatFieldMetadata.objectMetadataUniversalIdentifier ===
objectMetadataUniversalIdentifier &&
!flatFieldMetadata.isSystemSideEffect &&
(!displayableOnly ||
isFlatFieldMetadataDisplayableInDefaultView({
flatFieldMetadata,
labelIdentifierFieldMetadataUniversalIdentifier,
})),
!flatFieldMetadata.isSystemSideEffect,
),
});
packages/twenty-server/src/engine/metadata-modules/metadata-side-effect/handlers/utils/compute-default-index-view-field-position-by-field-universal-identifier.util.ts
+10 -11
View File
@@ -7,12 +7,12 @@ export const computeDefaultIndexViewFieldPositionByFieldUniversalIdentifier = ({
applicationUniversalIdentifier,
objectMetadataUniversalIdentifier,
labelIdentifierFieldMetadataUniversalIdentifier,
displayableCallerFlatFieldMetadatas,
callerFlatFieldMetadatas,
}: {
applicationUniversalIdentifier: string;
objectMetadataUniversalIdentifier: string;
labelIdentifierFieldMetadataUniversalIdentifier: string | null;
displayableCallerFlatFieldMetadatas: UniversalFlatFieldMetadata[];
callerFlatFieldMetadatas: UniversalFlatFieldMetadata[];
}): Map<string, number> => {
const displayableSystemFlatFieldMetadatas = Object.values(
buildReservedSystemFlatFieldMetadatasForCustomObject({
@@ -28,17 +28,16 @@ export const computeDefaultIndexViewFieldPositionByFieldUniversalIdentifier = ({
}),
);
const orderedDisplayableFlatFieldMetadatas =
orderFlatFieldMetadatasForSystemIndexView({
labelIdentifierFieldMetadataUniversalIdentifier,
flatFieldMetadatas: [
...displayableCallerFlatFieldMetadatas,
...displayableSystemFlatFieldMetadatas,
],
});
const orderedFlatFieldMetadatas = orderFlatFieldMetadatasForSystemIndexView({
labelIdentifierFieldMetadataUniversalIdentifier,
flatFieldMetadatas: [
...callerFlatFieldMetadatas,
...displayableSystemFlatFieldMetadatas,
],
});
return new Map(
orderedDisplayableFlatFieldMetadatas.map((flatFieldMetadata, position) => [
orderedFlatFieldMetadatas.map((flatFieldMetadata, position) => [
flatFieldMetadata.universalIdentifier,
position,
]),