4747 create deleted listener on blocklist (#5067)

Closes #4747

packages/twenty-server/src/modules/messaging/jobs/blocklist-reimport-messages.job.ts

@@ -0,0 +1,59 @@
+import { Injectable, Logger } from '@nestjs/common';
+
+import { MessageQueueJob } from 'src/engine/integrations/message-queue/interfaces/message-queue-job.interface';
+
+import { InjectObjectMetadataRepository } from 'src/engine/object-metadata-repository/object-metadata-repository.decorator';
+import { ConnectedAccountRepository } from 'src/modules/connected-account/repositories/connected-account.repository';
+import { ConnectedAccountObjectMetadata } from 'src/modules/connected-account/standard-objects/connected-account.object-metadata';
+import { GmailFullSyncService } from 'src/modules/messaging/services/gmail-full-sync/gmail-full-sync.service';
+
+export type BlocklistReimportMessagesJobData = {
+  workspaceId: string;
+  workspaceMemberId: string;
+  handle: string;
+};
+
+@Injectable()
+export class BlocklistReimportMessagesJob
+  implements MessageQueueJob<BlocklistReimportMessagesJobData>
+{
+  private readonly logger = new Logger(BlocklistReimportMessagesJob.name);
+
+  constructor(
+    @InjectObjectMetadataRepository(ConnectedAccountObjectMetadata)
+    private readonly connectedAccountRepository: ConnectedAccountRepository,
+    private readonly gmailFullSyncService: GmailFullSyncService,
+  ) {}
+
+  async handle(data: BlocklistReimportMessagesJobData): Promise<void> {
+    const { workspaceId, workspaceMemberId, handle } = data;
+
+    this.logger.log(
+      `Reimporting messages from handle ${handle} in workspace ${workspaceId} for workspace member ${workspaceMemberId}`,
+    );
+
+    const connectedAccount =
+      await this.connectedAccountRepository.getAllByWorkspaceMemberId(
+        workspaceMemberId,
+        workspaceId,
+      );
+
+    if (!connectedAccount || connectedAccount.length === 0) {
+      this.logger.error(
+        `No connected account found for workspace member ${workspaceMemberId} in workspace ${workspaceId}`,
+      );
+
+      return;
+    }
+
+    await this.gmailFullSyncService.fetchConnectedAccountThreads(
+      workspaceId,
+      connectedAccount[0].id,
+      [handle],
+    );
+
+    this.logger.log(
+      `Reimporting messages from ${handle} in workspace ${workspaceId} for workspace member ${workspaceMemberId} done`,
+    );
+  }
+}

packages/twenty-server/src/modules/messaging/listeners/messaging-blocklist.listener.ts

@@ -2,9 +2,14 @@ import { Inject, Injectable } from '@nestjs/common';
 import { OnEvent } from '@nestjs/event-emitter';
 
 import { ObjectRecordCreateEvent } from 'src/engine/integrations/event-emitter/types/object-record-create.event';
+import { ObjectRecordDeleteEvent } from 'src/engine/integrations/event-emitter/types/object-record-delete.event';
 import { MessageQueue } from 'src/engine/integrations/message-queue/message-queue.constants';
 import { MessageQueueService } from 'src/engine/integrations/message-queue/services/message-queue.service';
 import { BlocklistObjectMetadata } from 'src/modules/connected-account/standard-objects/blocklist.object-metadata';
+import {
+  BlocklistReimportMessagesJob,
+  BlocklistReimportMessagesJobData,
+} from 'src/modules/messaging/jobs/blocklist-reimport-messages.job';
 import {
   BlocklistItemDeleteMessagesJobData,
   BlocklistItemDeleteMessagesJob,
@@ -18,10 +23,10 @@ export class MessagingBlocklistListener {
   ) {}
 
   @OnEvent('blocklist.created')
-  handleCreatedEvent(
+  async handleCreatedEvent(
     payload: ObjectRecordCreateEvent<BlocklistObjectMetadata>,
   ) {
-    this.messageQueueService.add<BlocklistItemDeleteMessagesJobData>(
+    await this.messageQueueService.add<BlocklistItemDeleteMessagesJobData>(
       BlocklistItemDeleteMessagesJob.name,
       {
         workspaceId: payload.workspaceId,
@@ -29,4 +34,18 @@ export class MessagingBlocklistListener {
       },
     );
   }
+
+  @OnEvent('blocklist.deleted')
+  async handleDeletedEvent(
+    payload: ObjectRecordDeleteEvent<BlocklistObjectMetadata>,
+  ) {
+    await this.messageQueueService.add<BlocklistReimportMessagesJobData>(
+      BlocklistReimportMessagesJob.name,
+      {
+        workspaceId: payload.workspaceId,
+        workspaceMemberId: payload.properties.before.workspaceMember.id,
+        handle: payload.properties.before.handle,
+      },
+    );
+  }
 }

packages/twenty-server/src/modules/messaging/services/gmail-full-sync/gmail-full-sync.service.ts

@@ -25,8 +25,8 @@ import {
   MessageChannelObjectMetadata,
   MessageChannelSyncStatus,
 } from 'src/modules/messaging/standard-objects/message-channel.object-metadata';
-import { gmailSearchFilterExcludeEmails } from 'src/modules/messaging/utils/gmail-search-filter.util';
 import { WorkspaceDataSourceService } from 'src/engine/workspace-datasource/workspace-datasource.service';
+import { gmailSearchFilterEmailAdresses } from 'src/modules/messaging/utils/gmail-search-filter.util';
 
 @Injectable()
 export class GmailFullSyncService {
@@ -54,6 +54,7 @@ export class GmailFullSyncService {
   public async fetchConnectedAccountThreads(
     workspaceId: string,
     connectedAccountId: string,
+    includedEmails?: string[],
   ) {
     const connectedAccount = await this.connectedAccountRepository.getById(
       connectedAccountId,
@@ -109,19 +110,20 @@ export class GmailFullSyncService {
         workspaceId,
       );
 
+    const gmailClient: gmail_v1.Gmail =
+      await this.gmailClientProvider.getGmailClient(refreshToken);
+
+    const blocklistedEmails = await this.fetchBlocklistEmails(
+      connectedAccount.accountOwnerId,
+      workspaceId,
+    );
+
     await workspaceDataSource
       ?.transaction(async (transactionManager) => {
-        const gmailClient: gmail_v1.Gmail =
-          await this.gmailClientProvider.getGmailClient(refreshToken);
-
-        const blocklistedEmails = await this.fetchBlocklistEmails(
-          connectedAccount.accountOwnerId,
-          workspaceId,
-        );
-
         await this.fetchAllMessageIdsFromGmailAndStoreInCache(
           gmailClient,
           gmailMessageChannel.id,
+          includedEmails || [],
           blocklistedEmails,
           workspaceId,
           transactionManager,
@@ -150,6 +152,7 @@ export class GmailFullSyncService {
   public async fetchAllMessageIdsFromGmailAndStoreInCache(
     gmailClient: gmail_v1.Gmail,
     messageChannelId: string,
+    includedEmails: string[],
     blocklistedEmails: string[],
     workspaceId: string,
     transactionManager?: EntityManager,
@@ -164,7 +167,7 @@ export class GmailFullSyncService {
         userId: 'me',
         maxResults: GMAIL_USERS_MESSAGES_LIST_MAX_RESULT,
         pageToken,
-        q: gmailSearchFilterExcludeEmails(blocklistedEmails),
+        q: gmailSearchFilterEmailAdresses(includedEmails, blocklistedEmails),
       });
 
       if (response.data?.messages) {

packages/twenty-server/src/modules/messaging/utils/__tests__/gmail-search-filter.util.spec.ts

@@ -0,0 +1,58 @@
+import {
+  excludedCategoriesAndFileTypesString,
+  gmailSearchFilterEmailAdresses,
+  gmailSearchFilterExcludeEmailAdresses,
+  gmailSearchFilterIncludeOnlyEmailAdresses,
+  gmailSearchFilterNonPersonalEmails,
+} from 'src/modules/messaging/utils/gmail-search-filter.util';
+
+describe('gmailSearchFilterExcludeEmailAdresses', () => {
+  it('should return correct search filter for excluding emails', () => {
+    const emails = ['hello@twenty.com', 'hey@twenty.com'];
+    const result = gmailSearchFilterExcludeEmailAdresses(emails);
+
+    expect(result).toBe(
+      `(in:inbox from:-(${gmailSearchFilterNonPersonalEmails}|hello@twenty.com|hey@twenty.com)|(in:sent to:-(${gmailSearchFilterNonPersonalEmails}|hello@twenty.com|hey@twenty.com)) ${excludedCategoriesAndFileTypesString}`,
+    );
+  });
+  it('should return correct search filter for excluding emails when no emails are provided', () => {
+    const result = gmailSearchFilterExcludeEmailAdresses();
+
+    expect(result).toBe(
+      `from:-(${gmailSearchFilterNonPersonalEmails}) ${excludedCategoriesAndFileTypesString}`,
+    );
+  });
+});
+
+describe('gmailSearchFilterIncludeOnlyEmailAdresses', () => {
+  it('should return correct search filter for including emails', () => {
+    const emails = ['hello@twenty.com', 'hey@twenty.com'];
+    const result = gmailSearchFilterIncludeOnlyEmailAdresses(emails);
+
+    expect(result).toBe(
+      `(in:inbox from:(hello@twenty.com|hey@twenty.com)|(in:sent to:(hello@twenty.com|hey@twenty.com)) ${excludedCategoriesAndFileTypesString}`,
+    );
+  });
+  it('should return undefined when no emails are provided', () => {
+    const result = gmailSearchFilterIncludeOnlyEmailAdresses();
+
+    expect(result).toBe(undefined);
+  });
+});
+
+describe('gmailSearchFilterEmailAdresses', () => {
+  it('should return correct search filter for including emails and excluding emails', () => {
+    const includedEmails = ['hello@twenty.com', 'hey@twenty.com'];
+
+    const excludedEmails = ['noreply@twenty.com', 'no-reply@twenty.com'];
+
+    const result = gmailSearchFilterEmailAdresses(
+      includedEmails,
+      excludedEmails,
+    );
+
+    expect(result).toBe(
+      `(in:inbox from:((hello@twenty.com|hey@twenty.com) -(${gmailSearchFilterNonPersonalEmails}|noreply@twenty.com|no-reply@twenty.com))|(in:sent to:((hello@twenty.com|hey@twenty.com) -(${gmailSearchFilterNonPersonalEmails}|noreply@twenty.com|no-reply@twenty.com)) ${excludedCategoriesAndFileTypesString}`,
+    );
+  });
+});

packages/twenty-server/src/modules/messaging/utils/gmail-search-filter.util.ts

@@ -1,14 +1,59 @@
 export const gmailSearchFilterNonPersonalEmails =
   '*noreply@|*no-reply@|*do_not_reply@|*no.reply@|*info@|*contact@|*hello@|*support@|*feedback@|*service@|*help@';
 
-export const gmailSearchFilterExcludeEmails = (emails: string[]): string => {
-  if (emails.length === 0) {
-    return `from:-(${gmailSearchFilterNonPersonalEmails}) -category:promotions -category:social -category:forums -filename:.ics`;
+export const excludedCategories = ['promotions', 'social', 'forums'];
+
+export const excludedFileTypes = ['.ics'];
+
+export const excludedCategoriesAndFileTypesString = `-category:${excludedCategories.join(
+  ' -category:',
+)} -filename:${excludedFileTypes.join(' -filename:')}`;
+
+export const gmailSearchFilterExcludeEmailAdresses = (
+  emails?: string[],
+): string => {
+  if (!emails || emails.length === 0) {
+    return `from:-(${gmailSearchFilterNonPersonalEmails}) ${excludedCategoriesAndFileTypesString}`;
   }
 
   return `(in:inbox from:-(${gmailSearchFilterNonPersonalEmails}|${emails.join(
     '|',
   )})|(in:sent to:-(${gmailSearchFilterNonPersonalEmails}|${emails.join(
     '|',
-  )})) -category:promotions -category:social -category:forums -filename:.ics`;
+  )})) ${excludedCategoriesAndFileTypesString}`;
+};
+
+export const gmailSearchFilterIncludeOnlyEmailAdresses = (
+  emails?: string[],
+): string | undefined => {
+  if (!emails || emails.length === 0) {
+    return undefined;
+  }
+
+  return `(in:inbox from:(${emails.join('|')})|(in:sent to:(${emails.join(
+    '|',
+  )})) ${excludedCategoriesAndFileTypesString}`;
+};
+
+export const gmailSearchFilterEmailAdresses = (
+  includedEmails?: string[] | undefined,
+  excludedEmails?: string[] | undefined,
+): string | undefined => {
+  if (!includedEmails || includedEmails.length === 0) {
+    return gmailSearchFilterExcludeEmailAdresses(excludedEmails);
+  }
+
+  if (!excludedEmails || excludedEmails.length === 0) {
+    return gmailSearchFilterIncludeOnlyEmailAdresses(includedEmails);
+  }
+
+  return `(in:inbox from:((${includedEmails.join(
+    '|',
+  )}) -(${gmailSearchFilterNonPersonalEmails}|${excludedEmails.join(
+    '|',
+  )}))|(in:sent to:((${includedEmails.join(
+    '|',
+  )}) -(${gmailSearchFilterNonPersonalEmails}|${excludedEmails.join(
+    '|',
+  )})) ${excludedCategoriesAndFileTypesString}`;
 };