feat: Enhancements to MessageQueue Module with Decorators (#5657)

### Overview

This PR introduces significant enhancements to the MessageQueue module
by integrating `@Processor`, `@Process`, and `@InjectMessageQueue`
decorators. These changes streamline the process of defining and
managing queue processors and job handlers, and also allow for
request-scoped handlers, improving compatibility with services that rely
on scoped providers like TwentyORM repositories.

### Key Features

1. **Decorator-based Job Handling**: Use `@Processor` and `@Process`
decorators to define job handlers declaratively.
2. **Request Scope Support**: Job handlers can be scoped per request,
enhancing integration with request-scoped services.

### Usage

#### Defining Processors and Job Handlers

The `@Processor` decorator is used to define a class that processes jobs
for a specific queue. The `@Process` decorator is applied to methods
within this class to define specific job handlers.

##### Example 1: Specific Job Handlers

```typescript
import { Processor, Process, InjectMessageQueue } from 'src/engine/integrations/message-queue';

@Processor('taskQueue')
export class TaskProcessor {

  @Process('taskA')
  async handleTaskA(job: { id: string, data: any }) {
    console.log(`Handling task A with data:`, job.data);
    // Logic for task A
  }

  @Process('taskB')
  async handleTaskB(job: { id: string, data: any }) {
    console.log(`Handling task B with data:`, job.data);
    // Logic for task B
  }
}
```

In the example above, `TaskProcessor` is responsible for processing jobs
in the `taskQueue`. The `handleTaskA` method will only be called for
jobs with the name `taskA`, while `handleTaskB` will be called for
`taskB` jobs.

##### Example 2: General Job Handler

```typescript
import { Processor, Process, InjectMessageQueue } from 'src/engine/integrations/message-queue';

@Processor('generalQueue')
export class GeneralProcessor {

  @Process()
  async handleAnyJob(job: { id: string, name: string, data: any }) {
    console.log(`Handling job ${job.name} with data:`, job.data);
    // Logic for any job
  }
}
```

In this example, `GeneralProcessor` handles all jobs in the
`generalQueue`, regardless of the job name. The `handleAnyJob` method
will be invoked for every job added to the `generalQueue`.

#### Adding Jobs to a Queue

You can use the `@InjectMessageQueue` decorator to inject a queue into a
service and add jobs to it.

##### Example:

```typescript
import { Injectable } from '@nestjs/common';
import { InjectMessageQueue, MessageQueue } from 'src/engine/integrations/message-queue';

@Injectable()
export class TaskService {
  constructor(
    @InjectMessageQueue('taskQueue') private readonly taskQueue: MessageQueue,
  ) {}

  async addTaskA(data: any) {
    await this.taskQueue.add('taskA', data);
  }

  async addTaskB(data: any) {
    await this.taskQueue.add('taskB', data);
  }
}
```

In this example, `TaskService` adds jobs to the `taskQueue`. The
`addTaskA` and `addTaskB` methods add jobs named `taskA` and `taskB`,
respectively, to the queue.

#### Using Scoped Job Handlers

To utilize request-scoped job handlers, specify the scope in the
`@Processor` decorator. This is particularly useful for services that
use scoped repositories like those in TwentyORM.

##### Example:

```typescript
import { Processor, Process, InjectMessageQueue, Scope } from 'src/engine/integrations/message-queue';

@Processor({ name: 'scopedQueue', scope: Scope.REQUEST })
export class ScopedTaskProcessor {

  @Process('scopedTask')
  async handleScopedTask(job: { id: string, data: any }) {
    console.log(`Handling scoped task with data:`, job.data);
    // Logic for scoped task, which might use request-scoped services
  }
}
```

Here, the `ScopedTaskProcessor` is associated with `scopedQueue` and
operates with request scope. This setup is essential when the job
handler relies on services that need to be instantiated per request,
such as scoped repositories.

### Migration Notes

- **Decorators**: Refactor job handlers to use `@Processor` and
`@Process` decorators.
- **Request Scope**: Utilize the scope option in `@Processor` if your
job handlers depend on request-scoped services.

Fix #5628

---------

Co-authored-by: Weiko <corentin@twenty.com>

packages/twenty-server/src/modules/calendar/crons/commands/google-calendar-sync.cron.command.ts

@@ -1,7 +1,6 @@
-import { Inject } from '@nestjs/common';
-
 import { Command, CommandRunner } from 'nest-commander';
 
+import { InjectMessageQueue } from 'src/engine/integrations/message-queue/decorators/message-queue.decorator';
 import { MessageQueue } from 'src/engine/integrations/message-queue/message-queue.constants';
 import { MessageQueueService } from 'src/engine/integrations/message-queue/services/message-queue.service';
 import { GoogleCalendarSyncCronJob } from 'src/modules/calendar/crons/jobs/google-calendar-sync.cron.job';
@@ -14,7 +13,7 @@ const GOOGLE_CALENDAR_SYNC_CRON_PATTERN = '*/5 * * * *';
 })
 export class GoogleCalendarSyncCronCommand extends CommandRunner {
   constructor(
-    @Inject(MessageQueue.cronQueue)
+    @InjectMessageQueue(MessageQueue.cronQueue)
     private readonly messageQueueService: MessageQueueService,
   ) {
     super();

packages/twenty-server/src/modules/calendar/crons/jobs/calendar-cron-job.module.ts

@@ -13,11 +13,6 @@ import { WorkspaceGoogleCalendarSyncModule } from 'src/modules/calendar/services
     TypeOrmModule.forFeature([DataSourceEntity], 'metadata'),
     WorkspaceGoogleCalendarSyncModule,
   ],
-  providers: [
-    {
-      provide: GoogleCalendarSyncCronJob.name,
-      useClass: GoogleCalendarSyncCronJob,
-    },
-  ],
+  providers: [GoogleCalendarSyncCronJob],
 })
 export class CalendarCronJobModule {}

packages/twenty-server/src/modules/calendar/crons/jobs/google-calendar-sync.cron.job.ts

@@ -1,17 +1,17 @@
-import { Injectable } from '@nestjs/common';
 import { InjectRepository } from '@nestjs/typeorm';
 
 import { Repository, In } from 'typeorm';
 
-import { MessageQueueJob } from 'src/engine/integrations/message-queue/interfaces/message-queue-job.interface';
-
 import { Workspace } from 'src/engine/core-modules/workspace/workspace.entity';
 import { DataSourceEntity } from 'src/engine/metadata-modules/data-source/data-source.entity';
 import { WorkspaceGoogleCalendarSyncService } from 'src/modules/calendar/services/workspace-google-calendar-sync/workspace-google-calendar-sync.service';
 import { EnvironmentService } from 'src/engine/integrations/environment/environment.service';
+import { MessageQueue } from 'src/engine/integrations/message-queue/message-queue.constants';
+import { Processor } from 'src/engine/integrations/message-queue/decorators/processor.decorator';
+import { Process } from 'src/engine/integrations/message-queue/decorators/process.decorator';
 
-@Injectable()
-export class GoogleCalendarSyncCronJob implements MessageQueueJob<undefined> {
+@Processor(MessageQueue.cronQueue)
+export class GoogleCalendarSyncCronJob {
   constructor(
     @InjectRepository(Workspace, 'core')
     private readonly workspaceRepository: Repository<Workspace>,
@@ -21,6 +21,7 @@ export class GoogleCalendarSyncCronJob implements MessageQueueJob<undefined> {
     private readonly environmentService: EnvironmentService,
   ) {}
 
+  @Process(GoogleCalendarSyncCronJob.name)
   async handle(): Promise<void> {
     const workspaceIds = (
       await this.workspaceRepository.find({

packages/twenty-server/src/modules/calendar/jobs/blocklist-item-delete-calendar-events.job.ts

@@ -1,7 +1,7 @@
-import { Injectable, Logger } from '@nestjs/common';
-
-import { MessageQueueJob } from 'src/engine/integrations/message-queue/interfaces/message-queue-job.interface';
+import { Logger } from '@nestjs/common';
 
+import { Processor } from 'src/engine/integrations/message-queue/decorators/processor.decorator';
+import { MessageQueue } from 'src/engine/integrations/message-queue/message-queue.constants';
 import { InjectObjectMetadataRepository } from 'src/engine/object-metadata-repository/object-metadata-repository.decorator';
 import { CalendarChannelEventAssociationRepository } from 'src/modules/calendar/repositories/calendar-channel-event-association.repository';
 import { CalendarChannelRepository } from 'src/modules/calendar/repositories/calendar-channel.repository';
@@ -10,16 +10,15 @@ import { CalendarChannelEventAssociationWorkspaceEntity } from 'src/modules/cale
 import { CalendarChannelWorkspaceEntity } from 'src/modules/calendar/standard-objects/calendar-channel.workspace-entity';
 import { BlocklistRepository } from 'src/modules/connected-account/repositories/blocklist.repository';
 import { BlocklistWorkspaceEntity } from 'src/modules/connected-account/standard-objects/blocklist.workspace-entity';
+import { Process } from 'src/engine/integrations/message-queue/decorators/process.decorator';
 
 export type BlocklistItemDeleteCalendarEventsJobData = {
   workspaceId: string;
   blocklistItemId: string;
 };
 
-@Injectable()
-export class BlocklistItemDeleteCalendarEventsJob
-  implements MessageQueueJob<BlocklistItemDeleteCalendarEventsJobData>
-{
+@Processor(MessageQueue.calendarQueue)
+export class BlocklistItemDeleteCalendarEventsJob {
   private readonly logger = new Logger(
     BlocklistItemDeleteCalendarEventsJob.name,
   );
@@ -36,6 +35,7 @@ export class BlocklistItemDeleteCalendarEventsJob
     private readonly calendarEventCleanerService: CalendarEventCleanerService,
   ) {}
 
+  @Process(BlocklistItemDeleteCalendarEventsJob.name)
   async handle(data: BlocklistItemDeleteCalendarEventsJobData): Promise<void> {
     const { workspaceId, blocklistItemId } = data;
 

packages/twenty-server/src/modules/calendar/jobs/blocklist-reimport-calendar-events.job.ts

@@ -1,11 +1,12 @@
-import { Injectable, Logger } from '@nestjs/common';
-
-import { MessageQueueJob } from 'src/engine/integrations/message-queue/interfaces/message-queue-job.interface';
+import { Logger } from '@nestjs/common';
 
+import { Processor } from 'src/engine/integrations/message-queue/decorators/processor.decorator';
+import { MessageQueue } from 'src/engine/integrations/message-queue/message-queue.constants';
 import { InjectObjectMetadataRepository } from 'src/engine/object-metadata-repository/object-metadata-repository.decorator';
 import { GoogleCalendarSyncService } from 'src/modules/calendar/services/google-calendar-sync/google-calendar-sync.service';
 import { ConnectedAccountRepository } from 'src/modules/connected-account/repositories/connected-account.repository';
 import { ConnectedAccountWorkspaceEntity } from 'src/modules/connected-account/standard-objects/connected-account.workspace-entity';
+import { Process } from 'src/engine/integrations/message-queue/decorators/process.decorator';
 
 export type BlocklistReimportCalendarEventsJobData = {
   workspaceId: string;
@@ -13,10 +14,8 @@ export type BlocklistReimportCalendarEventsJobData = {
   handle: string;
 };
 
-@Injectable()
-export class BlocklistReimportCalendarEventsJob
-  implements MessageQueueJob<BlocklistReimportCalendarEventsJobData>
-{
+@Processor(MessageQueue.calendarQueue)
+export class BlocklistReimportCalendarEventsJob {
   private readonly logger = new Logger(BlocklistReimportCalendarEventsJob.name);
 
   constructor(
@@ -25,6 +24,7 @@ export class BlocklistReimportCalendarEventsJob
     private readonly googleCalendarSyncService: GoogleCalendarSyncService,
   ) {}
 
+  @Process(BlocklistReimportCalendarEventsJob.name)
   async handle(data: BlocklistReimportCalendarEventsJobData): Promise<void> {
     const { workspaceId, workspaceMemberId, handle } = data;
 

packages/twenty-server/src/modules/calendar/jobs/calendar-create-company-and-contact-after-sync.job.ts

@@ -1,7 +1,8 @@
-import { Injectable, Logger } from '@nestjs/common';
-
-import { MessageQueueJob } from 'src/engine/integrations/message-queue/interfaces/message-queue-job.interface';
+import { Logger } from '@nestjs/common';
 
+import { Process } from 'src/engine/integrations/message-queue/decorators/process.decorator';
+import { Processor } from 'src/engine/integrations/message-queue/decorators/processor.decorator';
+import { MessageQueue } from 'src/engine/integrations/message-queue/message-queue.constants';
 import { InjectObjectMetadataRepository } from 'src/engine/object-metadata-repository/object-metadata-repository.decorator';
 import { CalendarChannelRepository } from 'src/modules/calendar/repositories/calendar-channel.repository';
 import { CalendarEventParticipantRepository } from 'src/modules/calendar/repositories/calendar-event-participant.repository';
@@ -16,10 +17,8 @@ export type CalendarCreateCompanyAndContactAfterSyncJobData = {
   calendarChannelId: string;
 };
 
-@Injectable()
-export class CalendarCreateCompanyAndContactAfterSyncJob
-  implements MessageQueueJob<CalendarCreateCompanyAndContactAfterSyncJobData>
-{
+@Processor(MessageQueue.calendarQueue)
+export class CalendarCreateCompanyAndContactAfterSyncJob {
   private readonly logger = new Logger(
     CalendarCreateCompanyAndContactAfterSyncJob.name,
   );
@@ -33,6 +32,7 @@ export class CalendarCreateCompanyAndContactAfterSyncJob
     private readonly connectedAccountRepository: ConnectedAccountRepository,
   ) {}
 
+  @Process(CalendarCreateCompanyAndContactAfterSyncJob.name)
   async handle(
     data: CalendarCreateCompanyAndContactAfterSyncJobData,
   ): Promise<void> {

packages/twenty-server/src/modules/calendar/jobs/calendar-job.module.ts

@@ -32,26 +32,11 @@ import { ConnectedAccountWorkspaceEntity } from 'src/modules/connected-account/s
     GoogleCalendarSyncModule,
   ],
   providers: [
-    {
-      provide: BlocklistItemDeleteCalendarEventsJob.name,
-      useClass: BlocklistItemDeleteCalendarEventsJob,
-    },
-    {
-      provide: BlocklistReimportCalendarEventsJob.name,
-      useClass: BlocklistReimportCalendarEventsJob,
-    },
-    {
-      provide: GoogleCalendarSyncJob.name,
-      useClass: GoogleCalendarSyncJob,
-    },
-    {
-      provide: CalendarCreateCompanyAndContactAfterSyncJob.name,
-      useClass: CalendarCreateCompanyAndContactAfterSyncJob,
-    },
-    {
-      provide: DeleteConnectedAccountAssociatedCalendarDataJob.name,
-      useClass: DeleteConnectedAccountAssociatedCalendarDataJob,
-    },
+    BlocklistItemDeleteCalendarEventsJob,
+    BlocklistReimportCalendarEventsJob,
+    GoogleCalendarSyncJob,
+    CalendarCreateCompanyAndContactAfterSyncJob,
+    DeleteConnectedAccountAssociatedCalendarDataJob,
   ],
 })
 export class CalendarJobModule {}

packages/twenty-server/src/modules/calendar/jobs/delete-connected-account-associated-calendar-data.job.ts

@@ -1,7 +1,8 @@
-import { Injectable, Logger } from '@nestjs/common';
-
-import { MessageQueueJob } from 'src/engine/integrations/message-queue/interfaces/message-queue-job.interface';
+import { Logger } from '@nestjs/common';
 
+import { Process } from 'src/engine/integrations/message-queue/decorators/process.decorator';
+import { Processor } from 'src/engine/integrations/message-queue/decorators/processor.decorator';
+import { MessageQueue } from 'src/engine/integrations/message-queue/message-queue.constants';
 import { CalendarEventCleanerService } from 'src/modules/calendar/services/calendar-event-cleaner/calendar-event-cleaner.service';
 
 export type DeleteConnectedAccountAssociatedCalendarDataJobData = {
@@ -9,11 +10,8 @@ export type DeleteConnectedAccountAssociatedCalendarDataJobData = {
   connectedAccountId: string;
 };
 
-@Injectable()
-export class DeleteConnectedAccountAssociatedCalendarDataJob
-  implements
-    MessageQueueJob<DeleteConnectedAccountAssociatedCalendarDataJobData>
-{
+@Processor(MessageQueue.calendarQueue)
+export class DeleteConnectedAccountAssociatedCalendarDataJob {
   private readonly logger = new Logger(
     DeleteConnectedAccountAssociatedCalendarDataJob.name,
   );
@@ -22,6 +20,7 @@ export class DeleteConnectedAccountAssociatedCalendarDataJob
     private readonly calendarEventCleanerService: CalendarEventCleanerService,
   ) {}
 
+  @Process(DeleteConnectedAccountAssociatedCalendarDataJob.name)
   async handle(
     data: DeleteConnectedAccountAssociatedCalendarDataJobData,
   ): Promise<void> {

packages/twenty-server/src/modules/calendar/jobs/google-calendar-sync.job.ts

@@ -1,19 +1,18 @@
-import { Injectable, Logger } from '@nestjs/common';
-
-import { MessageQueueJob } from 'src/engine/integrations/message-queue/interfaces/message-queue-job.interface';
+import { Logger } from '@nestjs/common';
 
 import { GoogleAPIRefreshAccessTokenService } from 'src/modules/connected-account/services/google-api-refresh-access-token/google-api-refresh-access-token.service';
 import { GoogleCalendarSyncService } from 'src/modules/calendar/services/google-calendar-sync/google-calendar-sync.service';
+import { Processor } from 'src/engine/integrations/message-queue/decorators/processor.decorator';
+import { MessageQueue } from 'src/engine/integrations/message-queue/message-queue.constants';
+import { Process } from 'src/engine/integrations/message-queue/decorators/process.decorator';
 
 export type GoogleCalendarSyncJobData = {
   workspaceId: string;
   connectedAccountId: string;
 };
 
-@Injectable()
-export class GoogleCalendarSyncJob
-  implements MessageQueueJob<GoogleCalendarSyncJobData>
-{
+@Processor(MessageQueue.calendarQueue)
+export class GoogleCalendarSyncJob {
   private readonly logger = new Logger(GoogleCalendarSyncJob.name);
 
   constructor(
@@ -21,6 +20,7 @@ export class GoogleCalendarSyncJob
     private readonly googleCalendarSyncService: GoogleCalendarSyncService,
   ) {}
 
+  @Process(GoogleCalendarSyncJob.name)
   async handle(data: GoogleCalendarSyncJobData): Promise<void> {
     this.logger.log(
       `google calendar sync for workspace ${data.workspaceId} and account ${data.connectedAccountId}`,

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

@@ -1,9 +1,10 @@
-import { Inject, Injectable } from '@nestjs/common';
+import { 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 { ObjectRecordUpdateEvent } from 'src/engine/integrations/event-emitter/types/object-record-update.event';
+import { InjectMessageQueue } from 'src/engine/integrations/message-queue/decorators/message-queue.decorator';
 import { MessageQueue } from 'src/engine/integrations/message-queue/message-queue.constants';
 import { MessageQueueService } from 'src/engine/integrations/message-queue/services/message-queue.service';
 import {
@@ -19,7 +20,7 @@ import { BlocklistWorkspaceEntity } from 'src/modules/connected-account/standard
 @Injectable()
 export class CalendarBlocklistListener {
   constructor(
-    @Inject(MessageQueue.calendarQueue)
+    @InjectMessageQueue(MessageQueue.calendarQueue)
     private readonly messageQueueService: MessageQueueService,
   ) {}
 

packages/twenty-server/src/modules/calendar/listeners/calendar-channel.listener.ts

@@ -1,8 +1,9 @@
-import { Inject, Injectable } from '@nestjs/common';
+import { Injectable } from '@nestjs/common';
 import { OnEvent } from '@nestjs/event-emitter';
 
 import { ObjectRecordUpdateEvent } from 'src/engine/integrations/event-emitter/types/object-record-update.event';
 import { objectRecordChangedProperties } from 'src/engine/integrations/event-emitter/utils/object-record-changed-properties.util';
+import { InjectMessageQueue } from 'src/engine/integrations/message-queue/decorators/message-queue.decorator';
 import { MessageQueue } from 'src/engine/integrations/message-queue/message-queue.constants';
 import { MessageQueueService } from 'src/engine/integrations/message-queue/services/message-queue.service';
 import {
@@ -14,7 +15,7 @@ import { MessageChannelWorkspaceEntity } from 'src/modules/messaging/common/stan
 @Injectable()
 export class CalendarChannelListener {
   constructor(
-    @Inject(MessageQueue.calendarQueue)
+    @InjectMessageQueue(MessageQueue.calendarQueue)
     private readonly messageQueueService: MessageQueueService,
   ) {}
 

packages/twenty-server/src/modules/calendar/services/google-calendar-sync/google-calendar-sync.service.ts

@@ -64,7 +64,7 @@ export class GoogleCalendarSyncService {
     private readonly workspaceDataSourceService: WorkspaceDataSourceService,
     private readonly calendarEventCleanerService: CalendarEventCleanerService,
     private readonly calendarEventParticipantsService: CalendarEventParticipantService,
-    @InjectMessageQueue(MessageQueue.emailQueue)
+    @InjectMessageQueue(MessageQueue.contactCreationQueue)
     private readonly messageQueueService: MessageQueueService,
     private readonly eventEmitter: EventEmitter2,
   ) {}