Ws poc

[martmull]

related to twentyhq/core-team-issues#601

Done

• add a onDbEvent Subscription graphql endpoint to listen to database_event using what we have done with webhooks:
  • you can subscribe to any action (created, updated, ...) for any objectNameSingular or a specific recordId. Parameters are nullable and treated as wildcards when null.
  • returns events with following shape

  @Field(() => String)
  eventId: string;

  @Field()
  emittedAt: string;

  @Field(() => DatabaseEventAction)
  action: DatabaseEventAction;

  @Field(() => String)
  objectNameSingular: string;

  @Field(() => GraphQLJSON)
  record: ObjectRecord;

  @Field(() => [String], { nullable: true })
  updatedFields?: string[];

• front provide a componentEffect <ListenRecordUpdatesEffect /> that listen for an objectNameSingular, a recordId and a list of listenedFields. It subscribes to record updates and updates its apollo cached value for specified listenedFields
• subscription is protected with credentials

Result

Here is an application with workflowRun

Enregistrement.de.l.ecran.2025-04-16.a.10.54.08.mov

[charlesBochet]

closing for now to keep the history of PR clean, let's re-open it once ready

[thomtrp]

Great work!! Looks really promising ❤️

[charlesBochet]

you are allowed this time because of the masterpiece!

[charlesBochet]

interesting, isn't there an apollo native integration?

[martmull]

Nope, not for sse

[charlesBochet]

is this needed?

[martmull]

Yes, it is needed so that databaseEventListener works also on the worker. Without that import, records created by a workflow action won't trigger webhooks for example
I have created a ticket to improve dbEventListener management -> twentyhq/core-team-issues#753

[charlesBochet]

is this the regular syntax?

[martmull]

It exists elsewhere, but
const { workspaceId, workspaceMetadataVersion, userWorkspaceId } = this.scopedWorkspaceContextFactory.create(); also exists

[charlesBochet]

what schema is this resolver part of?

[martmull]

/graphql

[charlesBochet]

Bravo, added questions but non merge blocker, this is a POC :)

[Weiko]

LGTM, great job! 👏