Added relations to SSE events by lucasbordeau · Pull Request #17683 · twentyhq/twenty

lucasbordeau · 2026-02-03T16:50:32Z

This PR implements what is necessary to re-create the query that we build on the frontend to obtain the returned object record from a mutation, but on the backend, which was only partially implemented for REST API.

Usually we want to have relations with only their id and label identifier field to have lighter payloads.

In the event we only had depth 0 fields, with this PR we have all events with depth 1 relations.

We have depth 2 for many-to-many cases, like updateOne or updateMany result :

Junction tables
Activity target tables

packages/twenty-server/src/engine/workspace-event-emitter/workspace-event-emitter.service.ts

greptile-apps · 2026-02-03T16:55:36Z

Greptile Overview

Greptile Summary

This PR enhances event payloads with nested relation data to match frontend query patterns. Previously, mutation results only included depth-0 fields; now events include depth-1 relations with label/image identifier fields for lighter payloads.

Key changes:

Added enrichEventBatchWithNestedRelations method to WorkspaceEventEmitterService that enriches event records with nested relations before publishing to event streams
Extended RestToCommonSelectedFieldsHandler.computeFromDepth to support onlyUseLabelIdentifierFieldsInRelations flag, which filters relation fields to only id, label identifier, and image identifier fields
Implemented depth-2 support for special cases: junction tables (many-to-many relations) and activity target tables (noteTargets/taskTargets)
Created utility functions checkIfFieldIsLabelIdentifier and checkIfFieldIsImageIdentifier to identify essential fields for relation representation
Refactored UserWorkspaceRoleMap type into a separate file for better reusability across the codebase
Comprehensive test coverage added for all new functionality

Confidence Score: 4/5

Safe to merge with one minor syntax fix needed
Code is well-tested with comprehensive unit tests, clear architecture, and follows existing patterns. One loose equality operator needs fixing. The enrichment logic correctly handles permissions and RLS filtering.
packages/twenty-server/src/engine/api/rest/core/rest-to-common-args-handlers/selected-fields-handler.ts requires a syntax fix on line 102

Important Files Changed

Filename	Overview
packages/twenty-server/src/engine/workspace-event-emitter/workspace-event-emitter.service.ts	Added `enrichEventBatchWithNestedRelations` to populate depth-1 relations in event payloads using label/image identifiers only
packages/twenty-server/src/engine/api/rest/core/rest-to-common-args-handlers/selected-fields-handler.ts	Extended to support `onlyUseLabelIdentifierFieldsInRelations` flag and depth-2 handling for junction/activity target tables
packages/twenty-server/src/engine/api/rest/core/rest-to-common-args-handlers/utils/get-all-selectable-fields.util.ts	Added `onlyUseLabelIdentifierFieldsInRelations` parameter to filter fields to id, label, and image identifiers only
packages/twenty-server/src/engine/api/rest/core/rest-to-common-args-handlers/utils/check-if-field-is-label-identifier.util.ts	New utility to check if a field is the label identifier for an object
packages/twenty-server/src/engine/api/rest/core/rest-to-common-args-handlers/utils/check-if-field-is-image-identifier.util.ts	New utility to check if a field is the image identifier, with hardcoded company.domainName special case

Sequence Diagram

sequenceDiagram
    participant WEE as WorkspaceEventEmitter
    participant WEES as WorkspaceEventEmitterService
    participant RCSFH as RestToCommonSelectedFieldsHandler
    participant GASF as getAllSelectableFields
    participant PNRH as ProcessNestedRelationsHelper
    participant DB as Database

    WEE->>WEES: publish(workspaceEventBatch)
    WEES->>WEES: publishToEventStreams()
    
    alt Has Active Streams
        WEES->>WEES: processStreamEvents()
        
        loop For Each Event
            WEES->>WEES: Filter restricted fields
            WEES->>WEES: Match queries with RLS filters
        end
        
        alt Has Matched Events
            WEES->>WEES: enrichEventBatchWithNestedRelations()
            WEES->>RCSFH: computeFromDepth(depth=1, onlyUseLabelIdentifierFieldsInRelations=true)
            
            RCSFH->>GASF: getAllSelectableFields(onlyUseLabelIdentifierFieldsInRelations=true)
            GASF->>GASF: Filter to id, label, image identifier fields only
            GASF-->>RCSFH: Filtered fields
            
            RCSFH->>RCSFH: getRelationsAndRelationsSelectFields()
            
            alt Is Junction Table or Activity Target
                RCSFH->>RCSFH: Recurse with depth=1 for depth-2 relations
            end
            
            RCSFH-->>WEES: Selected fields structure
            
            WEES->>PNRH: processNestedRelations(parentObjectRecords, relations)
            PNRH->>DB: Query nested relations
            DB-->>PNRH: Relation data
            PNRH->>PNRH: Populate relations in records
            PNRH-->>WEES: Enriched records
            
            WEES->>WEES: publishToEventStream()
        end
    end

greptile-apps

_{5 files reviewed, 1 comment}

_{Edit Code Review Agent Settings | Greptile}

...enty-server/src/engine/api/rest/core/rest-to-common-args-handlers/selected-fields-handler.ts

cubic-dev-ai

No issues found across 16 files

thomtrp

LGTM but I think we need @Weiko feedbacks here

thomtrp · 2026-02-03T17:12:06Z

.../api/rest/core/rest-to-common-args-handlers/utils/check-if-field-is-image-identifier.util.ts

+    flatObjectMetadata.nameSingular === 'company' &&
+    flatField.name === 'domainName'
+  ) {
+    return true;


I am surprised we never need it before. Looks a bit hacky TBH. Don't we have a better way to retrieve the label identifier?

Indeed we already have it

We have isImageIdentifierField in the frontend indeed. This could live in twenty-shared maybe

packages/twenty-server/src/engine/metadata-modules/role-target/types/user-workspace-role-map.ts

packages/twenty-server/src/engine/workspace-event-emitter/workspace-event-emitter.service.ts

Weiko

Left some comments @lucasbordeau !

Weiko · 2026-02-04T12:49:11Z

.../api/rest/core/rest-to-common-args-handlers/utils/check-if-field-is-image-identifier.util.ts

+    flatObjectMetadata.nameSingular === 'company' &&
+    flatField.name === 'domainName'
+  ) {
+    return true;


We have isImageIdentifierField in the frontend indeed. This could live in twenty-shared maybe

Weiko · 2026-02-04T12:50:56Z

.../api/rest/core/rest-to-common-args-handlers/utils/check-if-field-is-label-identifier.util.ts

+import { type FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata.type';
+import { type FlatObjectMetadata } from 'src/engine/metadata-modules/flat-object-metadata/types/flat-object-metadata.type';
+
+export const checkIfFieldIsLabelIdentifier = (


Could you check in the server where we do
flatObjectMetadata.labelIdentifierFieldMetadataId === and use that new util? 🙂

could be in shared as well

packages/twenty-server/src/engine/workspace-event-emitter/workspace-event-emitter.service.ts

packages/twenty-server/src/engine/metadata-modules/role-target/types/user-workspace-role-map.ts

Weiko · 2026-02-04T13:16:04Z

...enty-server/src/engine/api/rest/core/rest-to-common-args-handlers/selected-fields-handler.ts

          ...relationFieldSelectFields,
          ...depth2RelationsSelectFields,
        };
+      } else if (flatFieldIsActivityTarget) {


Note: What about future many-to-many relations? I believe we are trying to achieve that very soon and the code is almost ready.
taskTarget/noteTarget are probably not migrated yet though but ideally this should be metadata driven instead of hardcoded

Ok I will abstract this into a util for now, as it will probably be easier to refactor once we are there.

...enty-server/src/engine/api/rest/core/rest-to-common-args-handlers/selected-fields-handler.ts

Copilot

Pull request overview

This PR enhances SSE (Server-Sent Events) to include related objects with their identifier fields, moving from depth-0 to depth-1 relations by default, with depth-2 for junction tables and activity targets.

Changes:

Implemented nested relation enrichment for SSE events to match frontend query structure
Refactored and consolidated field selection logic across REST and GraphQL APIs
Added support for label identifier field filtering in relation queries

Reviewed changes

Copilot reviewed 30 out of 31 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
packages/twenty-shared/src/metadata/index.ts	Exports new utilities for label and image identifier field checks
packages/twenty-shared/src/metadata/check-if-field-is-label-identifier.util.ts	New utility to check if a field is the label identifier
packages/twenty-shared/src/metadata/check-if-field-is-image-identifier.util.ts	New utility to check if a field is the image identifier
packages/twenty-server/src/engine/workspace-event-emitter/workspace-event-emitter.service.ts	Adds nested relations enrichment for SSE events
packages/twenty-server/src/engine/workspace-event-emitter/workspace-event-emitter.module.ts	Registers new dependencies for nested relation processing
packages/twenty-server/src/engine/workspace-event-emitter/tests/workspace-event-emitter.service.spec.ts	Comprehensive test coverage for nested relations enrichment
packages/twenty-server/src/engine/workspace-cache/types/workspace-cache-key.type.ts	Updates import path for UserWorkspaceRoleMap type
packages/twenty-server/src/engine/twenty-orm/storage/orm-workspace-context.storage.ts	Updates type reference for userWorkspaceRoleMap
packages/twenty-server/src/engine/twenty-orm/interfaces/workspace-internal-context.interface.ts	Updates type reference for userWorkspaceRoleMap
packages/twenty-server/src/engine/metadata-modules/role-target/types/user-workspace-role-map.ts	Creates shared type definition for UserWorkspaceRoleMap
packages/twenty-server/src/engine/metadata-modules/role-target/services/workspace-user-workspace-role-map-cache.service.ts	Imports UserWorkspaceRoleMap from shared location
packages/twenty-server/src/engine/core-modules/record-crud/services/common-api-context-builder.service.ts	Updates import path for getAllSelectableFields
packages/twenty-server/src/engine/api/rest/core/rest-to-common-args-handlers/utils/tests/get-all-selectable-fields.util.spec.ts	Removes old test file (moved)
packages/twenty-server/src/engine/api/rest/core/rest-to-common-args-handlers/rest-to-common-args-handlers.ts	Updates to use renamed CommonSelectFieldsHelper
packages/twenty-server/src/engine/api/rest/core/rest-to-common-args-handlers/tests/selected-fields-handler.spec.ts	Comprehensive tests for field selection with depth and relations
packages/twenty-server/src/engine/api/rest/core/handlers/rest-api-base.handler.ts	Updates to use renamed CommonSelectFieldsHelper
packages/twenty-server/src/engine/api/graphql/graphql-query-runner/group-by/services/group-by-with-records.service.ts	Updates import path for ProcessNestedRelationsHelper
packages/twenty-server/src/engine/api/graphql/graphql-query-runner/graphql-query-runner.module.ts	Updates import paths for relocated helpers
packages/twenty-server/src/engine/api/common/core-common-api.module.ts	Updates import paths for relocated helpers
packages/twenty-server/src/engine/api/common/common-select-fields/utils/get-should-recurse-into-relation.ts	New utility to determine if relation should be recursed
packages/twenty-server/src/engine/api/common/common-select-fields/utils/get-is-flat-field-a-junction-relation-field.ts	New utility to identify junction relation fields
packages/twenty-server/src/engine/api/common/common-select-fields/utils/get-is-flat-field-a-join-column.util.ts	New utility to identify join column fields
packages/twenty-server/src/engine/api/common/common-select-fields/utils/get-all-selectable-fields.util.ts	Enhanced with label identifier field filtering
packages/twenty-server/src/engine/api/common/common-select-fields/utils/tests/get-all-selectable-fields.util.spec.ts	Comprehensive tests for selectable fields logic
packages/twenty-server/src/engine/api/common/common-select-fields/common-select-fields-helper.ts	Renamed and enhanced with junction table handling
packages/twenty-server/src/engine/api/common/common-query-runners/common-base-query-runner.service.ts	Updates import path for ProcessNestedRelationsHelper
packages/twenty-server/src/engine/api/common/common-nested-relations-processor/process-nested-relations.helper.ts	Updates import path for V2 helper
packages/twenty-server/src/engine/api/common/common-args-handlers/common-query-selected-fields/common-selected-fields.handler.ts	Removed (functionality moved to common-select-fields-helper)
packages/twenty-front/src/modules/sse-db-event/hooks/useTriggerEventStreamCreation.ts	Improves error handling with try-catch wrapper
packages/twenty-front/src/modules/object-record/utils/computeOptimisticRecordFromInput.ts	Removes unnecessary error throwing for relation fields

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

Copilot · 2026-02-05T18:42:39Z

.../engine/api/common/common-select-fields/utils/get-is-flat-field-a-junction-relation-field.ts

+  const isActivityRelationField =
+    flatField.name === 'note' || flatField.name === 'task';


Hard-coded activity relation fields ('note', 'task') are duplicated across multiple utility functions. Consider extracting these to a shared constant to improve maintainability and reduce duplication.

Copilot · 2026-02-05T18:42:39Z

...ver/src/engine/api/common/common-select-fields/utils/get-is-flat-field-a-join-column.util.ts

+  const flatFieldIsActivityTarget =
+    flatField.name === 'noteTargets' || flatField.name === 'taskTargets';


Hard-coded activity target fields ('noteTargets', 'taskTargets') are duplicated. Consider extracting these to a shared constant to improve maintainability and reduce duplication.

Copilot · 2026-02-05T18:42:40Z

...-server/src/engine/api/common/common-select-fields/utils/get-should-recurse-into-relation.ts

+  const flatFieldIsActivityTarget =
+    flatField.name === 'noteTargets' || flatField.name === 'taskTargets';


Hard-coded activity target fields are duplicated across multiple files. Consider extracting these to a shared constant to improve maintainability.

Copilot · 2026-02-05T18:42:40Z

...ages/twenty-server/src/engine/api/common/common-select-fields/common-select-fields-helper.ts

+      if (
+        currentDepthLevelIsAJunctionTable &&
+        recurseIntoJunctionTableRelations
+      ) {
+        const fieldIsJunctionRelation = getIsFlatFieldAJunctionRelationField({
+          flatField,
+        });
+
+        if (!fieldIsJunctionRelation) {
+          continue;
+        }


The nested condition checks could be simplified by combining the logic. Consider checking both conditions at once or adding an early return when both conditions are true but the field is not a junction relation.

Suggested change

if (

currentDepthLevelIsAJunctionTable &&

recurseIntoJunctionTableRelations

) {

const fieldIsJunctionRelation = getIsFlatFieldAJunctionRelationField({

flatField,

});

if (!fieldIsJunctionRelation) {

continue;

}

const shouldFilterToJunctionRelations =

currentDepthLevelIsAJunctionTable && recurseIntoJunctionTableRelations;

if (

shouldFilterToJunctionRelations &&

!getIsFlatFieldAJunctionRelationField({ flatField })

) {

continue;

lucasbordeau · 2026-02-05T18:43:21Z

packages/twenty-front/src/modules/object-record/utils/computeOptimisticRecordFromInput.ts

        continue;
      }

-      if (!isUndefined(recordInputFieldValue)) {


@charlesBochet I removed this because it makes no sense to check that for SSE events. I saw no problem removing it because the optimistic logic shouldn't crash if there is "too much" data.

Also this was developed while taking for granted that we have all corresponding relations in the front cache, which is not the case for SSE events.

lucasbordeau · 2026-02-05T18:45:19Z

packages/twenty-front/src/modules/sse-db-event/hooks/useTriggerEventStreamCreation.ts

-                    case 'EVENT_STREAM_ALREADY_EXISTS': {
-                      set(shouldDestroyEventStreamState, true);
-                      break;
+              const result = data as ExecutionResult<{


@thomtrp I put everything into the message handler since this is the top-level handler that get called first.

Errors can be in the data normal flow, so we have to handle them here.

If an error happens during processing the data, that is not caught here, the SSE client silently crashed and don't recover, it took me some time to figure this out, so I put a top-level try/catch here.

lucasbordeau · 2026-02-05T18:46:42Z

...ages/twenty-server/src/engine/api/common/common-select-fields/common-select-fields-helper.ts


 @Injectable()
-export class RestToCommonSelectedFieldsHandler {
+export class CommonSelectFieldsHelper {


@Weiko For now I put it in api/common, but we could move it elsewhere (maybe in another PR though)

lucasbordeau · 2026-02-05T18:47:22Z

packages/twenty-shared/src/metadata/check-if-field-is-image-identifier.util.ts

@@ -0,0 +1,23 @@
+import { type Nullable } from '@/types';
+
+export const checkIfFieldIsImageIdentifier = (


I would replace this in twenty-front/ but in another PR to not bloat this one.

github-actions · 2026-02-05T18:53:15Z

🚀 Preview Environment Ready!

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

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

charlesBochet · 2026-02-09T21:49:43Z

@thomtrp could you take over this one? :)

thomtrp · 2026-02-10T15:26:37Z

Closing until @lucasbordeau's back from pto

lucasbordeau changed the title Ok Added relations to SSE events Feb 3, 2026

sentry bot reviewed Feb 3, 2026

View reviewed changes

packages/twenty-server/src/engine/workspace-event-emitter/workspace-event-emitter.service.ts Outdated Show resolved Hide resolved

greptile-apps bot reviewed Feb 3, 2026

View reviewed changes

...enty-server/src/engine/api/rest/core/rest-to-common-args-handlers/selected-fields-handler.ts Outdated Show resolved Hide resolved

cubic-dev-ai bot reviewed Feb 3, 2026

View reviewed changes

thomtrp reviewed Feb 3, 2026

View reviewed changes

Weiko reviewed Feb 4, 2026

View reviewed changes

Weiko added the -PR: awaiting author label Feb 4, 2026

Ok

ea9329b

Copilot AI review requested due to automatic review settings February 5, 2026 18:41

lucasbordeau force-pushed the feat/handle-relation-with-sse branch from b75f90b to ea9329b Compare February 5, 2026 18:41

Copilot AI reviewed Feb 5, 2026

View reviewed changes

lucasbordeau commented Feb 5, 2026

View reviewed changes

Fixed CI

430fc3b

charlesBochet assigned thomtrp Feb 9, 2026

charlesBochet added -PR: awaiting review -PR: awaiting author and removed -PR: awaiting author -PR: awaiting review labels Feb 9, 2026

thomtrp closed this Feb 10, 2026

		const isActivityRelationField =
		flatField.name === 'note' \|\| flatField.name === 'task';

		const flatFieldIsActivityTarget =
		flatField.name === 'noteTargets' \|\| flatField.name === 'taskTargets';

		@@ -0,0 +1,23 @@
		import { type Nullable } from '@/types';

		export const checkIfFieldIsImageIdentifier = (

Conversation

lucasbordeau commented Feb 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

greptile-apps bot commented Feb 3, 2026

Greptile Overview

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!

Uh oh!

cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

thomtrp left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Weiko left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lucasbordeau Feb 5, 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Feb 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

charlesBochet commented Feb 9, 2026

Uh oh!

lucasbordeau commented Feb 3, 2026 •

edited

Loading

lucasbordeau Feb 5, 2026 •

edited

Loading

github-actions bot commented Feb 5, 2026 •

edited

Loading