The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
fix(server): scope personal favorite SSE events to their owner (#23712)
Thomas Trompette62c1cf78afe9
diff --git a/packages/twenty-server/src/engine/subscriptions/metadata-event/__tests__/metadata-event-publisher.spec.ts b/packages/twenty-server/src/engine/subscriptions/metadata-event/__tests__/metadata-event-publisher.spec.tsnew file mode 100644index 00000000000..76543f6c253--- /dev/null+++ b/packages/twenty-server/src/engine/subscriptions/metadata-event/__tests__/metadata-event-publisher.spec.ts@@ -0,0 +1,172 @@+import { Test, type TestingModule } from '@nestjs/testing';++import { I18nService } from 'src/engine/core-modules/i18n/i18n.service';+import { WorkspaceManyOrAllFlatEntityMapsCacheService } from 'src/engine/metadata-modules/flat-entity/services/workspace-many-or-all-flat-entity-maps-cache.service';+import { NavigationMenuItemRecordIdentifierService } from 'src/engine/metadata-modules/navigation-menu-item/services/navigation-menu-item-record-identifier.service';+import { MetadataEventPublisher } from 'src/engine/subscriptions/metadata-event/metadata-event-publisher';+import { type MetadataEventBatch } from 'src/engine/subscriptions/metadata-event/types/metadata-event-batch.type';+import { WorkspaceEventBroadcaster } from 'src/engine/subscriptions/workspace-event-broadcaster/workspace-event-broadcaster.service';++const OWNER_USER_WORKSPACE_ID = '20202020-0000-0000-0000-000000000001';++describe('MetadataEventPublisher', () => {+ let publisher: MetadataEventPublisher;+ const broadcast = jest.fn();++ beforeEach(async () => {+ jest.clearAllMocks();++ const module: TestingModule = await Test.createTestingModule({+ providers: [+ MetadataEventPublisher,+ { provide: WorkspaceEventBroadcaster, useValue: { broadcast } },+ {+ provide: WorkspaceManyOrAllFlatEntityMapsCacheService,+ useValue: {},+ },+ { provide: NavigationMenuItemRecordIdentifierService, useValue: {} },+ { provide: I18nService, useValue: {} },+ ],+ }).compile();++ publisher = module.get<MetadataEventPublisher>(MetadataEventPublisher);+ });++ const publishAndGetFirstEvent = async (batch: object) => {+ await publisher.publish(batch as unknown as MetadataEventBatch);++ return broadcast.mock.calls[0][0].events[0];+ };++ it('scopes a personal favorite create event to its owner', async () => {+ const event = await publishAndGetFirstEvent({+ name: 'metadata.navigationMenuItem.created',+ workspaceId: 'workspace-1',+ metadataName: 'navigationMenuItem',+ type: 'created',+ events: [+ {+ metadataName: 'navigationMenuItem',+ type: 'created',+ recordId: 'nav-1',+ properties: {+ after: { id: 'nav-1', userWorkspaceId: OWNER_USER_WORKSPACE_ID },+ },+ },+ ],+ });++ expect(event.recipientUserWorkspaceIds).toEqual([OWNER_USER_WORKSPACE_ID]);+ });++ it('scopes a personal favorite update event to its owner', async () => {+ const event = await publishAndGetFirstEvent({+ name: 'metadata.navigationMenuItem.updated',+ workspaceId: 'workspace-1',+ metadataName: 'navigationMenuItem',+ type: 'updated',+ events: [+ {+ metadataName: 'navigationMenuItem',+ type: 'updated',+ recordId: 'nav-1',+ properties: {+ updatedFields: ['name'],+ diff: {},+ before: { id: 'nav-1', userWorkspaceId: OWNER_USER_WORKSPACE_ID },+ after: { id: 'nav-1', userWorkspaceId: OWNER_USER_WORKSPACE_ID },+ },+ },+ ],+ });++ expect(event.recipientUserWorkspaceIds).toEqual([OWNER_USER_WORKSPACE_ID]);+ });++ it('scopes a personal favorite delete event to its owner using the pre-delete record', async () => {+ const event = await publishAndGetFirstEvent({+ name: 'metadata.navigationMenuItem.deleted',+ workspaceId: 'workspace-1',+ metadataName: 'navigationMenuItem',+ type: 'deleted',+ events: [+ {+ metadataName: 'navigationMenuItem',+ type: 'deleted',+ recordId: 'nav-1',+ properties: {+ before: { id: 'nav-1', userWorkspaceId: OWNER_USER_WORKSPACE_ID },+ },+ },+ ],+ });++ expect(event.recipientUserWorkspaceIds).toEqual([OWNER_USER_WORKSPACE_ID]);+ });++ it('broadcasts a workspace-level favorite (null owner) to everyone', async () => {+ const event = await publishAndGetFirstEvent({+ name: 'metadata.navigationMenuItem.created',+ workspaceId: 'workspace-1',+ metadataName: 'navigationMenuItem',+ type: 'created',+ events: [+ {+ metadataName: 'navigationMenuItem',+ type: 'created',+ recordId: 'nav-1',+ properties: {+ after: { id: 'nav-1', userWorkspaceId: null },+ },+ },+ ],+ });++ expect(event.recipientUserWorkspaceIds).toBeUndefined();+ });++ it('does not scope a favorite with an empty-string owner', async () => {+ const event = await publishAndGetFirstEvent({+ name: 'metadata.navigationMenuItem.created',+ workspaceId: 'workspace-1',+ metadataName: 'navigationMenuItem',+ type: 'created',+ events: [+ {+ metadataName: 'navigationMenuItem',+ type: 'created',+ recordId: 'nav-1',+ properties: {+ after: { id: 'nav-1', userWorkspaceId: '' },+ },+ },+ ],+ });++ expect(event.recipientUserWorkspaceIds).toBeUndefined();+ });++ it('does not scope unrelated metadata even when it carries a userWorkspaceId', async () => {+ const event = await publishAndGetFirstEvent({+ name: 'metadata.view.created',+ workspaceId: 'workspace-1',+ metadataName: 'view',+ type: 'created',+ events: [+ {+ metadataName: 'view',+ type: 'created',+ recordId: 'view-1',+ properties: {+ after: {+ id: 'view-1',+ createdByUserWorkspaceId: OWNER_USER_WORKSPACE_ID,+ },+ },+ },+ ],+ });++ expect(event.recipientUserWorkspaceIds).toBeUndefined();+ });+});diff --git a/packages/twenty-server/src/engine/subscriptions/metadata-event/metadata-event-publisher.ts b/packages/twenty-server/src/engine/subscriptions/metadata-event/metadata-event-publisher.tsindex e55ccce51c3..b35c365c54c 100644--- a/packages/twenty-server/src/engine/subscriptions/metadata-event/metadata-event-publisher.ts+++ b/packages/twenty-server/src/engine/subscriptions/metadata-event/metadata-event-publisher.ts@@ -1,5 +1,6 @@import { Injectable } from '@nestjs/common';+import { isNonEmptyString } from '@sniptt/guards';import { SOURCE_LOCALE } from 'twenty-shared/translations';import { isDefined, isNonEmptyArray } from 'twenty-shared/utils';@@ -34,15 +35,38 @@ export class MetadataEventPublisher {await this.workspaceEventBroadcaster.broadcast({workspaceId: enrichedBatch.workspaceId,updatedCollectionHash: enrichedBatch.updatedCollectionHash,- events: enrichedBatch.events.map((event) => ({- type: event.type,- entityName: event.metadataName,- recordId: event.recordId,- properties: event.properties as Record<string, unknown>,- })),+ events: enrichedBatch.events.map((event) => {+ const ownerUserWorkspaceId = this.resolveOwnerUserWorkspaceId(event);++ return {+ type: event.type,+ entityName: event.metadataName,+ recordId: event.recordId,+ properties: event.properties as Record<string, unknown>,+ recipientUserWorkspaceIds: isNonEmptyString(ownerUserWorkspaceId)+ ? [ownerUserWorkspaceId]+ : undefined,+ };+ }),});}+ private resolveOwnerUserWorkspaceId(+ event: MetadataEventBatch['events'][number],+ ): string | undefined {+ if (event.metadataName !== 'navigationMenuItem') {+ return undefined;+ }++ const record = (+ event.type === 'deleted'+ ? event.properties.before+ : event.properties.after+ ) as { userWorkspaceId?: string | null } | undefined;++ return record?.userWorkspaceId ?? undefined;+ }+private async enrichMetadataEventBatch(metadataEventBatch: MetadataEventBatch,): Promise<MetadataEventBatch> {