Merge pull request #87 from alkem-io/develop

Release: Notifications Flag

package.json

@@ -1,8 +1,8 @@
 {
   "name": "alkemio-notifications",
-  "version": "0.4.5",
+  "version": "0.4.6",
   "description": "Alkemio notifications service",
-  "author": "Cherrytwist Foundation",
+  "author": "Alkemio Foundation",
   "private": false,
   "license": "EUPL-1.2",
   "main": "src/main.ts",

src/app.controller.ts

@@ -92,7 +92,7 @@ export class AppController {
     @Payload() eventPayload: any,
     @Ctx() context: RmqContext,
     // notificationBuilder: any,
-    sendNotifications: any,
+    sendNotificationsImpl: any,
     eventName: string
   ) {
     this.logger.verbose?.(
@@ -109,7 +109,7 @@ export class AppController {
     }
 
     // https://www.squaremobius.net/amqp.node/channel_api.html#channel_nack
-    sendNotifications
+    sendNotificationsImpl
       .then((x: any[]) => {
         const nacked = x.filter(
           (y: { status: string }) => y.status === 'rejected'

src/core/contracts/notified.users.provider.interface.ts

@@ -1,7 +1,8 @@
 import { User } from '../models';
 import { CredentialCriteria } from '../models/credential.criteria';
+import { IFeatureFlagProvider } from './feature.flag.provider.interface';
 
-export interface INotifiedUsersProvider {
+export interface INotifiedUsersProvider extends IFeatureFlagProvider {
   getUser(userID: string): Promise<User>;
   getUniqueUsersMatchingCredentialCriteria(
     credentialCriterias: CredentialCriteria[]

src/services/domain/notification/notification.service.spec.ts

@@ -59,6 +59,7 @@ describe('NotificationService', () => {
         {
           provide: ALKEMIO_CLIENT_ADAPTER,
           useValue: {
+            areNotificationsEnabled: jest.fn(),
             getUser: jest.fn(),
             getApplicationCreator: jest.fn(),
             getUsersMatchingCredentialCriteria: jest.fn(),
@@ -108,6 +109,10 @@ describe('NotificationService', () => {
         ...testData.opportunityAdmins,
       ];
 
+      jest
+        .spyOn(alkemioAdapter, 'areNotificationsEnabled')
+        .mockResolvedValue(true);
+
       jest
         .spyOn(alkemioAdapter, 'getUniqueUsersMatchingCredentialCriteria')
         .mockResolvedValue(admins);
@@ -140,5 +145,17 @@ describe('NotificationService', () => {
         )
       ).rejects.toThrow();
     });
+
+    it('Should not send notifications when notifications are disabled', async () => {
+      jest
+        .spyOn(alkemioAdapter, 'areNotificationsEnabled')
+        .mockResolvedValue(false);
+
+      const res = await notificationService.sendApplicationCreatedNotifications(
+        testData.data as ApplicationCreatedEventPayload
+      );
+
+      expect(res.length).toBe(0); //shouldn't have any notifications sent
+    });
   });
 });

src/services/domain/notification/notification.service.ts

@@ -1,7 +1,11 @@
 import { Injectable, Inject, LoggerService } from '@nestjs/common';
 import { WINSTON_MODULE_NEST_PROVIDER } from 'nest-winston';
 import NotifmeSdk, { NotificationStatus } from 'notifme-sdk';
-import { LogContext, NOTIFICATIONS_PROVIDER } from '@src/common';
+import {
+  ALKEMIO_CLIENT_ADAPTER,
+  LogContext,
+  NOTIFICATIONS_PROVIDER,
+} from '@src/common';
 import { ApplicationCreatedEventPayload } from '@src/types/application.created.event.payload';
 import { ApplicationCreatedNotificationBuilder } from '@src/services';
 import { CommunicationDiscussionCreatedNotificationBuilder } from '../builders/communication-discussion-created/communication.discussion.created.notification.builder';
@@ -10,12 +14,15 @@ import { UserRegisteredNotificationBuilder } from '../builders/user-registered/u
 import { UserRegistrationEventPayload } from '@src/types';
 import { CommunicationUpdateEventPayload } from '@src/types/communication.update.event.payload';
 import { CommunicationDiscussionCreatedEventPayload } from '@src/types/communication.discussion.created.event.payload';
+import { AlkemioClientAdapter } from '@src/services/application/alkemio-client-adapter';
 
 @Injectable()
 export class NotificationService {
   constructor(
     @Inject(WINSTON_MODULE_NEST_PROVIDER)
     private readonly logger: LoggerService,
+    @Inject(ALKEMIO_CLIENT_ADAPTER)
+    private readonly alkemioClientAdapter: AlkemioClientAdapter,
     @Inject(NOTIFICATIONS_PROVIDER)
     private readonly notifmeService: NotifmeSdk,
     private applicationCreatedNotificationBuilder: ApplicationCreatedNotificationBuilder,
@@ -28,6 +35,17 @@ export class NotificationService {
     payload: any,
     notificationBuilder: any
   ): Promise<PromiseSettledResult<NotificationStatus>[]> {
+    const notificationsEnabled =
+      await this.alkemioClientAdapter.areNotificationsEnabled();
+    if (!notificationsEnabled) {
+      this.logger.verbose?.(
+        'Notification disabled. No notifications are going to be built.',
+        LogContext.NOTIFICATIONS
+      );
+
+      return [];
+    }
+
     return notificationBuilder
       .buildNotifications(payload)
       .then((x: any[]) => x.map((x: any) => this.sendNotification(x)))