mirror of
https://github.com/twentyhq/twenty
synced 2026-04-21 13:37:22 +00:00
40ff109179
## Summary
Consolidates `objectMetadataItems` onto the metadata store as the
**single source of truth**, replacing the previous dual-store approach
(separate `objectMetadataItemsState` atom + untyped
`metadataStoreState`).
### Architecture: three-layer design
```
┌─────────────────────────────────────────────────────────┐
│ Store Layer (granular, typed) │
│ objectMetadataItems → FlatObjectMetadataItem[] │
│ fieldMetadataItems → FlatFieldMetadataItem[] │
│ indexMetadataItems → FlatIndexMetadataItem[] │
└────────────────┬────────────────────────────────────────┘
│ .current (never draft)
┌────────────────▼────────────────────────────────────────┐
│ Selectors (typed read-only) │
│ objectMetadataItemsSelector │
│ fieldMetadataItemsSelector │
│ indexMetadataItemsSelector │
│ metadataStoreStatusFamilySelector │
│ isSystemObjectByNameSingularFamilySelector (narrow) │
│ activeObjectNameSingularsSelector (narrow) │
└────────────────┬────────────────────────────────────────┘
│ joins objects + fields + indexes + permissions
┌────────────────▼────────────────────────────────────────┐
│ Joining Selector │
│ objectMetadataItemsWithFieldsSelector │
│ → produces full ObjectMetadataItem[] with │
│ readableFields / updatableFields from permissions │
│ → 12 existing selectors repointed here │
└─────────────────────────────────────────────────────────┘
```
### Key changes
- **Granular flat types** (`FlatObjectMetadataItem`,
`FlatFieldMetadataItem`, `FlatIndexMetadataItem`) — objects stored
without embedded fields/indexes, matching backend "Flat" naming
convention
- **Typed write API** — `updateDraft` is now generic via
`MetadataEntityTypeMap`, giving compile-time safety on what data shape
goes to each key
- **Write path refactored** — fetch → split into flat entities via
`splitObjectMetadataItemWithRelated` → write to metadata store directly.
No more dual-write through `objectMetadataItemsState`. Permissions
enrichment moved from write path into the joining selector.
- **SSE effects write directly** — `ObjectMetadataItemSSEEffect` and
`FieldMetadataSSEEffect` now patch the store from the SSE event payload
(create/update/delete) instead of triggering a full re-fetch
- **`objectMetadataItemsState` bridge** — converted from writable
`createAtomState` to read-only `createAtomSelector` that delegates to
the joining selector. All 100+ existing consumers continue to work
without code changes.
- **All selectors use Twenty state API** — `createAtomSelector` /
`createAtomFamilySelector` throughout, no raw `atom()`
- **Narrow selectors** for hot paths —
`isSystemObjectByNameSingularFamilySelector` and
`activeObjectNameSingularsSelector` read from flat objects only,
avoiding re-renders when fields/indexes/permissions change. Placed in
`object-metadata/states/` as higher-level business selectors.
- **Test helper** — `setTestObjectMetadataItemsInMetadataStore` for
tests that need to set up composite object metadata through the store
(clearly named as a testing utility)
### Naming conventions
- `ObjectMetadataItemWithRelated` — type for objects with embedded
fields/indexes (input to split utility)
- `FlatObjectMetadataItem` / `FlatFieldMetadataItem` /
`FlatIndexMetadataItem` — granular store types
- Selector names don't expose "Current" — that's an internal detail of
the metadata store API
### Future work
- Optimistic update API (`updateCurrentOptimistically` with rollback)
- Migrate remaining entities (views, pageLayouts, etc.) to the same
pattern
- Gradually remove `objectMetadataItemsState` bridge once all direct
imports are replaced
## Test plan
- [x] `npx nx typecheck twenty-front` passes
- [x] `npx nx lint:diff-with-main twenty-front` passes
- [ ] Verify app loads correctly with metadata from the store
- [ ] Verify SSE updates (object/field changes) propagate correctly
- [ ] Run existing test suites to confirm no regressions
73 lines
2.3 KiB
TypeScript
73 lines
2.3 KiB
TypeScript
import { useListenToMetadataOperationBrowserEvent } from '@/browser-event/hooks/useListenToMetadataOperationBrowserEvent';
|
|
import { metadataStoreState } from '@/metadata-store/states/metadataStoreState';
|
|
import { type FlatFieldMetadataItem } from '@/metadata-store/types/FlatFieldMetadataItem';
|
|
import { useListenToEventsForQuery } from '@/sse-db-event/hooks/useListenToEventsForQuery';
|
|
import { useStore } from 'jotai';
|
|
import { AllMetadataName } from '~/generated-metadata/graphql';
|
|
|
|
export const FieldMetadataSSEEffect = () => {
|
|
const queryId = 'field-metadata-sse-effect';
|
|
|
|
const store = useStore();
|
|
|
|
useListenToEventsForQuery({
|
|
queryId,
|
|
operationSignature: {
|
|
metadataName: AllMetadataName.fieldMetadata,
|
|
variables: {},
|
|
},
|
|
});
|
|
|
|
useListenToMetadataOperationBrowserEvent({
|
|
metadataName: AllMetadataName.fieldMetadata,
|
|
onMetadataOperationBrowserEvent: (eventDetail) => {
|
|
const entry = store.get(
|
|
metadataStoreState.atomFamily('fieldMetadataItems'),
|
|
);
|
|
const currentFields = entry.current as FlatFieldMetadataItem[];
|
|
|
|
switch (eventDetail.operation.type) {
|
|
case 'create': {
|
|
const createdField = eventDetail.operation
|
|
.createdRecord as unknown as FlatFieldMetadataItem;
|
|
|
|
store.set(metadataStoreState.atomFamily('fieldMetadataItems'), {
|
|
...entry,
|
|
current: [...currentFields, createdField],
|
|
});
|
|
break;
|
|
}
|
|
case 'update': {
|
|
const updatedField = eventDetail.operation
|
|
.updatedRecord as unknown as FlatFieldMetadataItem;
|
|
|
|
store.set(metadataStoreState.atomFamily('fieldMetadataItems'), {
|
|
...entry,
|
|
current: currentFields.map((field) =>
|
|
field.id === updatedField.id
|
|
? { ...field, ...updatedField }
|
|
: field,
|
|
),
|
|
});
|
|
break;
|
|
}
|
|
case 'delete': {
|
|
const deletedFieldId = eventDetail.operation
|
|
.deletedRecordId as string;
|
|
|
|
store.set(metadataStoreState.atomFamily('fieldMetadataItems'), {
|
|
...entry,
|
|
current: currentFields.filter(
|
|
(field) => field.id !== deletedFieldId,
|
|
),
|
|
});
|
|
break;
|
|
}
|
|
default:
|
|
return;
|
|
}
|
|
},
|
|
});
|
|
|
|
return null;
|
|
};
|