PM-1073 - rework structure for webhooks

Author: vas3a

src/api/webhooks/trolley/handlers/index.ts

@@ -0,0 +1,17 @@
+import { Provider } from '@nestjs/common';
+import { PaymentHandler } from './payment.handler';
+import { getWebhooksEventHandlersProvider } from '../../webhooks.event-handlers.provider';
+
+export const TrolleyWebhookHandlers: Provider[] = [
+  getWebhooksEventHandlersProvider(
+    'trolleyHandlerFns',
+    'TrolleyWebhookHandlers',
+  ),
+
+  PaymentHandler,
+  {
+    provide: 'TrolleyWebhookHandlers',
+    useFactory: (paymentHandler: PaymentHandler) => [paymentHandler],
+    inject: [PaymentHandler],
+  },
+];

src/api/webhooks/trolley-handlers/payment.handler.ts renamed to src/api/webhooks/trolley/handlers/payment.handler.ts

@@ -1,6 +1,6 @@
 import { Injectable } from '@nestjs/common';
-import { TrolleyWebhookEvent } from '../webhooks.types';
-import { WebhookEvent } from './decorators';
+import { WebhookEvent } from '../../webhooks.decorators';
+import { TrolleyWebhookEvent } from '../trolley.types';
 
 @Injectable()
 export class PaymentHandler {

src/api/webhooks/trolley.service.ts renamed to src/api/webhooks/trolley/trolley.service.ts

@@ -120,7 +120,7 @@ export class TrolleyService {
       const { model, action, body } = payload;
       const handler = this.handlers.get(`${model}.${action}`);
       if (!handler) {
-        throw new Error('Webhook event handler not found!');
+        throw new Error('Event handler not found!');
       }
 
       await handler(body);

src/api/webhooks/webhooks.types.ts renamed to src/api/webhooks/trolley/trolley.types.ts

@@ -8,7 +8,7 @@ import {
   ConflictException,
 } from '@nestjs/common';
 import { ApiTags } from '@nestjs/swagger';
-import { TrolleyService } from './trolley.service';
+import { TrolleyService } from './trolley/trolley.service';
 import { Public } from 'src/core/auth/decorators';
 
 @Public()

src/api/webhooks/webhooks.controller.ts

@@ -1,8 +1,5 @@
-import { Provider } from '@nestjs/common';
-import { PaymentHandler } from './payment.handler';
-import { TrolleyWebhookEvent } from '../webhooks.types';
 import { Reflector } from '@nestjs/core';
-import { WEBHOOK_EVENT_METADATA_KEY } from './decorators';
+import { WEBHOOK_EVENT_METADATA_KEY } from './webhooks.decorators';
 
 /**
  * Factory function to create a map of Trolley webhook event handlers.
@@ -18,8 +15,8 @@ import { WEBHOOK_EVENT_METADATA_KEY } from './decorators';
  * @returns A `Map` where the keys are `TrolleyWebhookEvent` types and the values are
  *          bound handler functions for those events.
  */
-const trolleyHandlerFnsFactory = (reflector: Reflector, handlerClasses) => {
-  const handlersMap = new Map<TrolleyWebhookEvent, () => void>();
+const whEventHandlersFactory = (reflector: Reflector, handlerClasses) => {
+  const handlersMap = new Map<string, () => void>();
 
   for (const handlerClass of handlerClasses) {
     const prototype = Object.getPrototypeOf(handlerClass);
@@ -29,7 +26,7 @@ const trolleyHandlerFnsFactory = (reflector: Reflector, handlerClasses) => {
         continue;
       }
 
-      const eventTypes = reflector.get<TrolleyWebhookEvent[]>(
+      const eventTypes = reflector.get<string[]>(
         WEBHOOK_EVENT_METADATA_KEY,
         method,
       );
@@ -46,16 +43,18 @@ const trolleyHandlerFnsFactory = (reflector: Reflector, handlerClasses) => {
   return handlersMap;
 };
 
-export const TrolleyWebhookHandlersProviders: Provider[] = [
-  PaymentHandler,
-  {
-    provide: 'TrolleyWebhookHandlers',
-    useFactory: (paymentHandler: PaymentHandler) => [paymentHandler],
-    inject: [PaymentHandler],
-  },
-  {
-    provide: 'trolleyHandlerFns',
-    useFactory: trolleyHandlerFnsFactory,
-    inject: [Reflector, 'TrolleyWebhookHandlers'],
-  },
-];
+/**
+ * Creates a provider object for webhook event handlers.
+ *
+ * @param provide - The token that will be used to provide the dependency.
+ * @param handlersKey - The key used to identify the specific handlers to inject.
+ * @returns An object defining the provider with a factory function and its dependencies.
+ */
+export const getWebhooksEventHandlersProvider = (
+  provide: string,
+  handlersKey: string,
+) => ({
+  provide,
+  useFactory: whEventHandlersFactory,
+  inject: [Reflector, handlersKey],
+});

src/api/webhooks/trolley-handlers/decorators.ts renamed to src/api/webhooks/webhooks.decorators.ts

@@ -1,11 +1,11 @@
 import { Module } from '@nestjs/common';
-import { TrolleyService } from './trolley.service';
 import { WebhooksController } from './webhooks.controller';
-import { TrolleyWebhookHandlersProviders } from './trolley-handlers';
+import { TrolleyService } from './trolley/trolley.service';
+import { TrolleyWebhookHandlers } from './trolley/handlers';
 
 @Module({
   imports: [],
   controllers: [WebhooksController],
-  providers: [...TrolleyWebhookHandlersProviders, TrolleyService],
+  providers: [...TrolleyWebhookHandlers, TrolleyService],
 })
 export class WebhooksModule {}