Handle ObjectMetadataItem, FieldMetadataItem and NavigationMenuItem with SSE events by lucasbordeau · Pull Request #18235 · twentyhq/twenty

lucasbordeau · 2026-02-25T17:24:46Z

This PR allows to handle ObjectMetadataItem, FieldMetadataItem and NavigationMenuItem SSE events.

sentry · 2026-02-25T17:28:11Z

packages/twenty-front/src/modules/navigation-menu-item/utils/sortNavigationMenuItems.ts

+          if (!isDefined(objectMetadataItem)) {
+            return null;
+          }
+
+          const namePlural = objectMetadataItem?.namePlural;


Bug: The NavigationMenuItemSSEEffect component imports refreshObjectMetadataItems but never calls it, leading to potential state inconsistencies when handling SSE updates for navigation items.
_{Severity: MEDIUM}

Suggested Fix

In NavigationMenuItemSSEEffect.tsx, call await refreshObjectMetadataItems() before refetching the navigation menu items. This will ensure that the object metadata is up-to-date when processing navigation item SSE events, preventing items from being silently filtered due to stale state.

Prompt for AI Agent

Review the code at the location below. A potential bug has been identified by an AI agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not valid. Location: packages/twenty-front/src/modules/navigation-menu-item/utils/sortNavigationMenuItems.ts#L39-L43 Potential issue: When a `navigationMenuItem` Server-Sent Event (SSE) is processed by `NavigationMenuItemSSEEffect`, it updates the navigation menu items but fails to refresh the associated object metadata. This is because the `refreshObjectMetadataItems` function is imported but never called. Consequently, if a new navigation item references object metadata that is not yet present in the client's state, the `sortNavigationMenuItems` function will silently filter it out. This can cause navigation items to temporarily disappear from the UI until the object metadata is updated through other means.

_{Did we get this right? 👍 / 👎 to inform future reviews.}

Copilot

Pull request overview

This pull request enhances the SSE (Server-Sent Events) handling infrastructure by adding support for ObjectMetadataItem, FieldMetadataItem, and NavigationMenuItem entities. The changes enable real-time synchronization of metadata changes across the application by listening to SSE events and updating the application state accordingly.

Changes:

Renamed existing SSE effect components (ViewMetadataSSEEffect → ViewSSEEffect, ViewFieldMetadataSSEEffect → ViewFieldSSEEffect) for naming consistency
Added three new SSE effect components: ObjectMetadataItemSSEEffect, FieldMetadataSSEEffect, and NavigationMenuItemSSEEffect to handle real-time updates
Extended the metadata store state to include navigationMenuItems as a tracked entity
Refactored sortNavigationMenuItems to handle missing object metadata items gracefully by returning null instead of throwing errors

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
packages/twenty-front/src/modules/sse-db-event/components/SSEProvider.tsx	Updated imports and component references to use renamed components and added new SSE effect components
packages/twenty-front/src/modules/navigation-menu-item/utils/sortNavigationMenuItems.ts	Refactored to inline object metadata lookup logic and handle missing items gracefully
packages/twenty-front/src/modules/metadata-store/states/metadataStoreState.ts	Added 'navigationMenuItems' to the list of tracked metadata entities
packages/twenty-front/src/modules/metadata-store/effect-components/ViewSSEEffect.tsx	Renamed from ViewMetadataSSEEffect for consistency
packages/twenty-front/src/modules/metadata-store/effect-components/ViewFieldSSEEffect.tsx	Renamed from ViewFieldMetadataSSEEffect for consistency
packages/twenty-front/src/modules/metadata-store/effect-components/ObjectMetadataItemSSEEffect.tsx	New component to handle ObjectMetadataItem SSE events and refresh navigation menu items
packages/twenty-front/src/modules/metadata-store/effect-components/NavigationMenuItemSSEEffect.tsx	New component to handle NavigationMenuItem SSE events
packages/twenty-front/src/modules/metadata-store/effect-components/FieldMetadataSSEEffect.tsx	New component to handle FieldMetadata SSE events

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

packages/twenty-front/src/modules/navigation-menu-item/utils/sortNavigationMenuItems.ts

...es/twenty-front/src/modules/metadata-store/effect-components/NavigationMenuItemSSEEffect.tsx

Copilot · 2026-02-25T17:28:41Z

...es/twenty-front/src/modules/metadata-store/effect-components/ObjectMetadataItemSSEEffect.tsx

+        store.set(
+          prefetchNavigationMenuItemsState.atom,
+          navigationMenuItemsResult.data?.navigationMenuItems ?? [],
+        );


After updating the navigation menu items state, the metadata store should also be updated for consistency with the NavigationMenuItemSSEEffect implementation. The updateDraft and applyChanges methods should be called with the new navigation menu items data to keep the metadata store in sync.

Suggested change

store.set(

prefetchNavigationMenuItemsState.atom,

navigationMenuItemsResult.data?.navigationMenuItems ?? [],

);

const newNavigationMenuItems =

navigationMenuItemsResult.data?.navigationMenuItems ?? [];

store.set(prefetchNavigationMenuItemsState.atom, newNavigationMenuItems);

updateDraft('navigationMenuItems', newNavigationMenuItems);

applyChanges();

greptile-apps · 2026-02-25T17:28:58Z

Greptile Summary

This PR adds Server-Sent Events (SSE) handling for ObjectMetadataItem, FieldMetadataItem, and NavigationMenuItem to enable real-time updates when metadata changes occur.

Key Changes:

Added three new SSE effect components (FieldMetadataSSEEffect, ObjectMetadataItemSSEEffect, NavigationMenuItemSSEEffect) following the existing pattern established by ViewFieldSSEEffect and ViewSSEEffect
Renamed ViewFieldMetadataSSEEffect to ViewFieldSSEEffect and ViewMetadataSSEEffect to ViewSSEEffect for consistent naming
Added navigationMenuItems to the metadata store state to support SSE synchronization
Simplified sortNavigationMenuItems by removing the getObjectMetadataNamePluralFromViewId utility and implementing the logic inline with proper null checks

Minor Issues:

NavigationMenuItemSSEEffect.tsx:19 has an unused import refreshObjectMetadataItems

Confidence Score: 4/5

This PR is safe to merge with only minor style issues
The implementation follows established patterns consistently, includes proper null checks and deep equality comparisons. The only issue is a minor unused import that doesn't affect functionality.
No files require special attention - the unused import in NavigationMenuItemSSEEffect.tsx is a trivial cleanup

Important Files Changed

Filename	Overview
packages/twenty-front/src/modules/metadata-store/effect-components/FieldMetadataSSEEffect.tsx	New SSE effect component for handling field metadata events, follows existing pattern consistently
packages/twenty-front/src/modules/metadata-store/effect-components/NavigationMenuItemSSEEffect.tsx	New SSE effect for navigation menu items with proper deep equality checks and state updates
packages/twenty-front/src/modules/metadata-store/effect-components/ObjectMetadataItemSSEEffect.tsx	SSE effect for object metadata that also refreshes navigation menu items when objects change

Sequence Diagram

sequenceDiagram
    participant SSE as SSE Server
    participant Provider as SSEProvider
    participant FieldEffect as FieldMetadataSSEEffect
    participant ObjEffect as ObjectMetadataItemSSEEffect
    participant NavEffect as NavigationMenuItemSSEEffect
    participant Store as Jotai Store
    participant MetaStore as MetadataStore

    SSE->>Provider: SSE Event Stream
    
    rect rgb(200, 220, 250)
        Note over FieldEffect: Field Metadata Changed
        FieldEffect->>FieldEffect: Listen to fieldMetadata events
        SSE->>FieldEffect: fieldMetadata event
        FieldEffect->>FieldEffect: refreshObjectMetadataItems()
        FieldEffect->>Store: get objectMetadataItemsState
        FieldEffect->>MetaStore: updateDraft('objectMetadataItems')
        FieldEffect->>MetaStore: applyChanges()
    end

    rect rgb(220, 250, 200)
        Note over ObjEffect: Object Metadata Changed
        ObjEffect->>ObjEffect: Listen to objectMetadata events
        SSE->>ObjEffect: objectMetadata event
        ObjEffect->>ObjEffect: refreshObjectMetadataItems()
        ObjEffect->>Store: get objectMetadataItemsState
        ObjEffect->>MetaStore: updateDraft('objectMetadataItems')
        ObjEffect->>MetaStore: applyChanges()
        ObjEffect->>ObjEffect: findManyNavigationMenuItemsLazy()
        ObjEffect->>Store: Check with isDeeplyEqual
        ObjEffect->>Store: set prefetchNavigationMenuItemsState (if changed)
    end

    rect rgb(250, 220, 200)
        Note over NavEffect: Navigation Menu Changed
        NavEffect->>NavEffect: Listen to navigationMenuItem events
        SSE->>NavEffect: navigationMenuItem event
        NavEffect->>NavEffect: findManyNavigationMenuItemsLazy()
        NavEffect->>Store: get prefetchNavigationMenuItemsState
        NavEffect->>Store: Check with isDeeplyEqual
        NavEffect->>Store: set prefetchNavigationMenuItemsState (if changed)
        NavEffect->>MetaStore: updateDraft('navigationMenuItems')
        NavEffect->>MetaStore: applyChanges()
    end

_{Last reviewed commit: 20fc48d}

greptile-apps

_{8 files reviewed, 1 comment}

_{Edit Code Review Agent Settings | Greptile}

greptile-apps · 2026-02-25T17:29:01Z

...es/twenty-front/src/modules/metadata-store/effect-components/NavigationMenuItemSSEEffect.tsx

+
+  const store = useStore();
+
+  const { refreshObjectMetadataItems } = useRefreshObjectMetadataItems();


Unused import - refreshObjectMetadataItems is destructured but never called in this component

Suggested change

const { refreshObjectMetadataItems } = useRefreshObjectMetadataItems();

const { updateDraft, applyChanges } = useMetadataStore();

cubic-dev-ai

1 issue found across 8 files

Prompt for AI agents (unresolved issues)


Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="packages/twenty-front/src/modules/metadata-store/effect-components/ObjectMetadataItemSSEEffect.tsx">

<violation number="1" location="packages/twenty-front/src/modules/metadata-store/effect-components/ObjectMetadataItemSSEEffect.tsx:58">
P2: Guard against undefined navigation menu query results before overwriting the prefetch state; otherwise a failed/empty query will clear existing items to `[]`.</violation>
</file>

_{Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.}

cubic-dev-ai · 2026-02-25T17:30:11Z

...es/twenty-front/src/modules/metadata-store/effect-components/ObjectMetadataItemSSEEffect.tsx

+      ) {
+        store.set(
+          prefetchNavigationMenuItemsState.atom,
+          navigationMenuItemsResult.data?.navigationMenuItems ?? [],


P2: Guard against undefined navigation menu query results before overwriting the prefetch state; otherwise a failed/empty query will clear existing items to [].

Prompt for AI agents

Check if this issue is valid — if so, understand the root cause and fix it. At packages/twenty-front/src/modules/metadata-store/effect-components/ObjectMetadataItemSSEEffect.tsx, line 58: <comment>Guard against undefined navigation menu query results before overwriting the prefetch state; otherwise a failed/empty query will clear existing items to `[]`.</comment> <file context> @@ -0,0 +1,65 @@ + ) { + store.set( + prefetchNavigationMenuItemsState.atom, + navigationMenuItemsResult.data?.navigationMenuItems ?? [], + ); + } </file context>

…ortNavigationMenuItems.ts Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

...es/twenty-front/src/modules/metadata-store/effect-components/ObjectMetadataItemSSEEffect.tsx

sentry · 2026-02-25T20:41:42Z

...es/twenty-front/src/modules/metadata-store/effect-components/ObjectMetadataItemSSEEffect.tsx

+      if (
+        !isDeeplyEqual(
+          existingNavigationMenuItems,
+          navigationMenuItemsResult.data?.navigationMenuItems,
+        )
+      ) {
+        store.set(
+          prefetchNavigationMenuItemsState.atom,
+          navigationMenuItemsResult.data?.navigationMenuItems ?? [],
+        );
+      }


Bug: If the findManyNavigationMenuItemsLazy query fails, the navigation menu items state is incorrectly cleared, causing the navigation menu to disappear from the UI.
_{Severity: HIGH}

Suggested Fix

Add a guard to check if navigationMenuItemsResult.data?.navigationMenuItems is defined before performing the isDeeplyEqual comparison and subsequent state update. This will prevent clearing the state on a query error. For example: if (!isDefined(navigationMenuItemsResult.data?.navigationMenuItems)) { return; }.

Prompt for AI Agent

Review the code at the location below. A potential bug has been identified by an AI agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not valid. Location: packages/twenty-front/src/modules/metadata-store/effect-components/ObjectMetadataItemSSEEffect.tsx#L42-L60 Potential issue: In `ObjectMetadataItemSSEEffect`, if the `findManyNavigationMenuItemsLazy` query returns an error (e.g., due to a network issue), `navigationMenuItemsResult.data` will be `undefined`. The code proceeds to compare the existing state with `undefined` using `isDeeplyEqual`, which returns `false`. This incorrectly triggers a state update, `store.set(..., navigationMenuItemsResult.data?.navigationMenuItems ?? [])`, which resolves to setting the navigation menu items to an empty array. This causes the navigation menu to disappear from the UI until the data is successfully refetched. A similar component, `NavigationMenuItemSSEEffect`, correctly handles this case with a guard.

twenty-eng-sync · 2026-02-25T22:19:10Z

Hey @lucasbordeau! After you've done the QA of your Pull Request, you can mark it as done here. Thank you!

lucasbordeau added 2 commits February 25, 2026 18:04

Ok

a42e2ea

Ok

20fc48d

lucasbordeau requested review from charlesBochet and Copilot February 25, 2026 17:24

Copilot started reviewing on behalf of lucasbordeau February 25, 2026 17:25 View session

sentry bot reviewed Feb 25, 2026

View reviewed changes

Copilot AI reviewed Feb 25, 2026

View reviewed changes

greptile-apps bot reviewed Feb 25, 2026

View reviewed changes

cubic-dev-ai bot reviewed Feb 25, 2026

View reviewed changes

charlesBochet approved these changes Feb 25, 2026

View reviewed changes

Update packages/twenty-front/src/modules/navigation-menu-item/utils/s…

00fbd01

…ortNavigationMenuItems.ts Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

sentry bot reviewed Feb 25, 2026

View reviewed changes

...es/twenty-front/src/modules/metadata-store/effect-components/ObjectMetadataItemSSEEffect.tsx Show resolved Hide resolved

Fixed lint

b0e76db

sentry bot reviewed Feb 25, 2026

View reviewed changes

charlesBochet merged commit 0fa8063 into main Feb 25, 2026
64 of 71 checks passed

charlesBochet deleted the feat/sse-for-object-metadata-item branch February 25, 2026 22:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Handle ObjectMetadataItem, FieldMetadataItem and NavigationMenuItem with SSE events#18235

Handle ObjectMetadataItem, FieldMetadataItem and NavigationMenuItem with SSE events#18235
charlesBochet merged 4 commits intomainfrom
feat/sse-for-object-metadata-item

lucasbordeau commented Feb 25, 2026

Uh oh!

sentry bot Feb 25, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI Feb 25, 2026

Uh oh!

greptile-apps bot commented Feb 25, 2026

Uh oh!

greptile-apps bot left a comment

Uh oh!

greptile-apps bot Feb 25, 2026

Uh oh!

cubic-dev-ai bot left a comment

Uh oh!

cubic-dev-ai bot Feb 25, 2026 •

edited

Loading

Uh oh!

Uh oh!

sentry bot Feb 25, 2026

Uh oh!

Uh oh!

twenty-eng-sync bot commented Feb 25, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

-        store.set(
-          prefetchNavigationMenuItemsState.atom,
-          navigationMenuItemsResult.data?.navigationMenuItems ?? [],
-        );
+        const newNavigationMenuItems =
+          navigationMenuItemsResult.data?.navigationMenuItems ?? [];
+        store.set(prefetchNavigationMenuItemsState.atom, newNavigationMenuItems);
+        updateDraft('navigationMenuItems', newNavigationMenuItems);
+        applyChanges();


		const store = useStore();

		const { refreshObjectMetadataItems } = useRefreshObjectMetadataItems();

	const { refreshObjectMetadataItems } = useRefreshObjectMetadataItems();
	const { updateDraft, applyChanges } = useMetadataStore();

Conversation

lucasbordeau commented Feb 25, 2026

Uh oh!

sentry bot Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot commented Feb 25, 2026

Greptile Summary

Confidence Score: 4/5

Important Files Changed

Sequence Diagram

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai bot Feb 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sentry bot Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

twenty-eng-sync bot commented Feb 25, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

cubic-dev-ai bot Feb 25, 2026 •

edited

Loading