Merge pull request #104 from alkem-io/develop

Release: Refactored notifications builders

notifications.yml

@@ -163,3 +163,14 @@ recipients:
         - rule:
             type: HUB_MEMBER
             resource_id: <hubID>
+  community_review_submitted:
+    - name: admin
+      rules:
+        - rule:
+            type: CHALLENGE_ADMIN
+            resource_id: <challengeID>
+    - name: reviewer
+      rules:
+        - rule:
+            type: USER_SELF_MANAGEMENT
+            resource_id: <reviewerID>

package.json

@@ -1,6 +1,6 @@
 {
   "name": "alkemio-notifications",
-  "version": "0.5.1",
+  "version": "0.5.3",
   "description": "Alkemio notifications service",
   "author": "Alkemio Foundation",
   "private": false,
@@ -34,7 +34,7 @@
     "validate-connection": "ts-node src/utils/validate-connection.ts"
   },
   "dependencies": {
-    "@alkemio/client-lib": "^0.13.0",
+    "@alkemio/client-lib": "^0.13.1",
     "@nestjs/axios": "^0.0.1",
     "@nestjs/common": "^8.0.5",
     "@nestjs/config": "^1.0.1",

src/app.controller.ts

@@ -2,19 +2,24 @@ import { Controller, Inject, LoggerService } from '@nestjs/common';
 import { Ctx, EventPattern, Payload, RmqContext } from '@nestjs/microservices';
 import { WINSTON_MODULE_NEST_PROVIDER } from 'nest-winston';
 import { Channel, Message } from 'amqplib';
+import { NotificationStatus } from 'notifme-sdk';
 import {
   ALKEMIO_CLIENT_ADAPTER,
   COMMUNICATION_DISCUSSION_CREATED,
   COMMUNICATION_UPDATE_SENT,
   COMMUNITY_APPLICATION_CREATED,
+  COMMUNITY_CONTEXT_REVIEW_SUBMITTED,
   LogContext,
   USER_REGISTERED,
 } from './common';
 import { IFeatureFlagProvider } from '@core/contracts';
-import { ApplicationCreatedEventPayload } from '@src/types/application.created.event.payload';
-import { UserRegistrationEventPayload } from './types';
-import { CommunicationUpdateEventPayload } from './types/communication.update.event.payload';
-import { CommunicationDiscussionCreatedEventPayload } from './types/communication.discussion.created.event.payload';
+import {
+  ApplicationCreatedEventPayload,
+  CommunicationUpdateEventPayload,
+  CommunicationDiscussionCreatedEventPayload,
+  CommunityContextReviewSubmittedPayload,
+  UserRegistrationEventPayload,
+} from '@common/dto';
 import { NotificationService } from './services/domain/notification/notification.service';
 
 @Controller()
@@ -88,11 +93,25 @@ export class AppController {
     );
   }
 
+  @EventPattern(COMMUNITY_CONTEXT_REVIEW_SUBMITTED)
+  async sendCommunityContextFeedbackNotifications(
+    @Payload() eventPayload: CommunityContextReviewSubmittedPayload,
+    @Ctx() context: RmqContext
+  ) {
+    this.sendNotifications(
+      eventPayload,
+      context,
+      this.notificationService.sendCommunityContextFeedbackNotification(
+        eventPayload
+      ),
+      COMMUNITY_CONTEXT_REVIEW_SUBMITTED
+    );
+  }
+
   private async sendNotifications(
-    @Payload() eventPayload: any,
+    @Payload() eventPayload: Record<string, unknown>,
     @Ctx() context: RmqContext,
-    // notificationBuilder: any,
-    sendNotificationsImpl: any,
+    sentNotifications: Promise<PromiseSettledResult<NotificationStatus>[]>,
     eventName: string
   ) {
     this.logger.verbose?.(
@@ -109,8 +128,8 @@ export class AppController {
     }
 
     // https://www.squaremobius.net/amqp.node/channel_api.html#channel_nack
-    sendNotificationsImpl
-      .then((x: any[]) => {
+    sentNotifications
+      .then(x => {
         const nacked = x.filter(
           (y: { status: string }) => y.status === 'rejected'
         );
@@ -136,7 +155,7 @@ export class AppController {
           }
         }
       })
-      .catch((err: any) => {
+      .catch(err => {
         // if there is an unhandled bug in the flow, we reject the message but we make sure the message is
         // not discarded so we provide 'true' to requeue parameter
         // channel.reject(originalMsg, true);

src/app.module.ts

@@ -9,14 +9,18 @@ import { HttpExceptionsFilter } from './core';
 import {
   AlkemioClientAdapterModule,
   ApplicationCreatedNotificationBuilder,
+  NotificationRecipientsAdapterModule,
 } from '@src/services';
 import { AlkemioClientModule, NotifmeModule } from '@src/services/external';
-import { NotificationRecipientsAdapterModule } from './services/application/notification-recipients-adapter/notification.recipients.adapter.module';
-import { UserRegisteredNotificationBuilder } from './services/domain/builders/user-registered/user.registered.notification.builder';
-import { CommunicationUpdateNotificationBuilder } from './services/domain/builders/communication-updated/communication.updated.notification.builder';
-import { CommunicationDiscussionCreatedNotificationBuilder } from './services/domain/builders/communication-discussion-created/communication.discussion.created.notification.builder';
+import {
+  CommunicationDiscussionCreatedNotificationBuilder,
+  CommunicationUpdateNotificationBuilder,
+  CommunityContextReviewSubmittedNotificationBuilder,
+  UserRegisteredNotificationBuilder,
+} from './services/domain/builders';
 import { AlkemioUrlGeneratorModule } from './services/application/alkemio-url-generator';
 import { NotificationService } from './services/domain/notification/notification.service';
+import { NotificationBuilderFactoryProvider } from './services/application/notification-builder';
 
 @Module({
   imports: [
@@ -39,10 +43,12 @@ import { NotificationService } from './services/domain/notification/notification
       provide: APP_FILTER,
       useClass: HttpExceptionsFilter,
     },
+    NotificationBuilderFactoryProvider,
     ApplicationCreatedNotificationBuilder,
     UserRegisteredNotificationBuilder,
     CommunicationUpdateNotificationBuilder,
     CommunicationDiscussionCreatedNotificationBuilder,
+    CommunityContextReviewSubmittedNotificationBuilder,
     NotificationService,
   ],
   controllers: [AppController],

src/common/constants/events.ts

@@ -3,3 +3,5 @@ export const USER_REGISTERED = 'userRegistered';
 export const COMMUNICATION_UPDATE_SENT = 'communicationUpdateSent';
 export const COMMUNICATION_DISCUSSION_CREATED =
   'communicationDiscussionCreated';
+export const COMMUNITY_CONTEXT_REVIEW_SUBMITTED =
+  'communityContextReviewSubmitted';

src/types/application.created.event.payload.d.ts → src/common/dto/application.created.event.payload.ts

@@ -1,3 +1,5 @@
+import { HubPayload } from './hub.payload';
+
 export enum CommunityType {
   HUB = 'hub',
   CHALLENGE = 'challenge',

src/types/communication.discussion.created.event.payload.d.ts → src/common/dto/communication.discussion.created.event.payload.ts

@@ -1,3 +1,6 @@
+import { CommunityType } from './application.created.event.payload';
+import { HubPayload } from './hub.payload';
+
 export type CommunicationDiscussionCreatedEventPayload = {
   discussion: {
     id: string;

src/types/communication.update.event.payload.d.ts → src/common/dto/communication.update.event.payload.ts

@@ -1,4 +1,5 @@
 import { HubPayload } from './hub.payload';
+import { CommunityType } from './application.created.event.payload';
 
 export type CommunicationUpdateEventPayload = {
   update: {

src/common/dto/community.context.review.submitted.payload.ts

@@ -0,0 +1,12 @@
+export type CommunityContextReviewSubmittedPayload = {
+  userId: string;
+  challengeId: string;
+  community: { name: string };
+  questions: FeedbackQuestions[];
+};
+
+export type FeedbackQuestions = {
+  name: string;
+  value: string;
+  sortOrder: number;
+};

src/common/dto/index.ts

@@ -0,0 +1,6 @@
+export * from './application.created.event.payload';
+export * from './communication.discussion.created.event.payload';
+export * from './communication.update.event.payload';
+export * from './community.context.review.submitted.payload';
+export * from './user.registration.event.payload';
+export * from './hub.payload';

src/common/enums/alkemio.error.status.ts

@@ -1,3 +1,8 @@
 export enum AlkemioErrorStatus {
   NOT_SUPPORTED = 'NOT_SUPPORTED',
+  TEMPLATE_NOT_PROVIDED = 'TEMPLATE_NOT_PROVIDED',
+  PAYLOAD_NOT_PROVIDED = 'PAYLOAD_BUILDER_NOT_PROVIDED',
+  TEMPLATE_BUILDER_NOT_PROVIDED = 'TEMPLATE_BUILDER_NOT_PROVIDED',
+  ROLES_NOT_PROVIDED = 'ROLES_NOT_PROVIDED',
+  RULES_SET_NOT_FOUND = 'RULE_SET_NOT_FOUND',
 }

src/common/enums/email.template.ts

@@ -7,4 +7,6 @@ export enum EmailTemplate {
   COMMUNICATION_DISCUSSION_CREATED_MEMBER = 'communication.discussion.created.member',
   COMMUNICATION_UPDATE_ADMIN = 'communication.update.admin',
   COMMUNICATION_UPDATE_MEMBER = 'communication.update.member',
+  COMMUNITY_REVIEW_SUBMITTED_ADMIN = 'community.review.submitted.admin',
+  COMMUNITY_REVIEW_SUBMITTED_REVIEWER = 'community.review.submitted.reviewer',
 }

src/common/exceptions/index.ts

@@ -1,2 +1,3 @@
 export * from './not.supported.exception';
 export * from './base.exception';
+export * from './notification-builder';

src/common/exceptions/notification-builder/event.payload.not.provided.exception.ts

@@ -0,0 +1,8 @@
+import { LogContext, AlkemioErrorStatus } from '@common/enums';
+import { BaseException } from '../base.exception';
+
+export class EventPayloadNotProvidedException extends BaseException {
+  constructor(error: string, context = LogContext.NOTIFICATIONS) {
+    super(error, context, AlkemioErrorStatus.PAYLOAD_NOT_PROVIDED);
+  }
+}

src/common/exceptions/notification-builder/index.ts

@@ -0,0 +1,5 @@
+export * from './template.not.provided.exception';
+export * from './template.builder.fn.not.provided.exception';
+export * from './event.payload.not.provided.exception';
+export * from './roles.not.provided.exception';
+export * from './rule.set.not.found.exception';

src/common/exceptions/notification-builder/roles.not.provided.exception.ts

@@ -0,0 +1,8 @@
+import { LogContext, AlkemioErrorStatus } from '@common/enums';
+import { BaseException } from '../base.exception';
+
+export class RolesNotProvidedException extends BaseException {
+  constructor(error: string, context = LogContext.NOTIFICATIONS) {
+    super(error, context, AlkemioErrorStatus.ROLES_NOT_PROVIDED);
+  }
+}

src/common/exceptions/notification-builder/rule.set.not.found.exception.ts

@@ -0,0 +1,8 @@
+import { LogContext, AlkemioErrorStatus } from '@common/enums';
+import { BaseException } from '../base.exception';
+
+export class RuleSetNotFoundException extends BaseException {
+  constructor(error: string, context = LogContext.NOTIFICATIONS) {
+    super(error, context, AlkemioErrorStatus.RULES_SET_NOT_FOUND);
+  }
+}

src/common/exceptions/notification-builder/template.builder.fn.not.provided.exception.ts

@@ -0,0 +1,8 @@
+import { LogContext, AlkemioErrorStatus } from '@common/enums';
+import { BaseException } from '../base.exception';
+
+export class TemplateBuilderFnNotProvidedException extends BaseException {
+  constructor(error: string, context = LogContext.NOTIFICATIONS) {
+    super(error, context, AlkemioErrorStatus.TEMPLATE_BUILDER_NOT_PROVIDED);
+  }
+}

src/common/exceptions/notification-builder/template.not.provided.exception.ts

@@ -0,0 +1,8 @@
+import { LogContext, AlkemioErrorStatus } from '@common/enums';
+import { BaseException } from '../base.exception';
+
+export class TemplateNotProvidedException extends BaseException {
+  constructor(error: string, context = LogContext.NOTIFICATIONS) {
+    super(error, context, AlkemioErrorStatus.TEMPLATE_NOT_PROVIDED);
+  }
+}

src/core/contracts/index.ts

@@ -1,3 +1,4 @@
 export * from './notified.users.provider.interface';
 export * from './feature.flag.provider.interface';
 export * from './notification.recipient.template.provider.interface';
+export * from './notification.builder.interface';

src/core/contracts/notification.builder.interface.ts

@@ -0,0 +1,5 @@
+import { NotificationTemplateType } from '@src/types';
+
+export interface INotificationBuilder {
+  build(payload: Record<string, unknown>): Promise<NotificationTemplateType[]>;
+}

src/core/contracts/notification.recipient.template.provider.interface.ts

@@ -1,5 +1,5 @@
 import { AuthorizationCredential } from '@alkemio/client-lib';
-import { CredentialCriteria } from '../models/credential.criteria';
+import { CredentialCriterion } from '../models/credential.criterion';
 
 export type TemplateRule = {
   rule: {
@@ -18,14 +18,15 @@ export type TemplateConfig = {
   user_registered?: TemplateRuleSet[];
   communication_update_sent?: TemplateRuleSet[];
   communication_discussion_created?: TemplateRuleSet[];
+  community_review_submitted?: TemplateRuleSet[];
 };
 
 export interface INotificationRecipientTemplateProvider {
   getTemplate(): TemplateConfig;
 
-  getCredentialCriterias(
-    lookupMap: Map<string, string>,
-    templateRuleSets: TemplateRuleSet[] | undefined,
-    roleName: string
-  ): CredentialCriteria[];
+  getCredentialCriteria(
+    roleName: string,
+    lookupMap?: Map<string, string>,
+    templateRuleSets?: TemplateRuleSet[]
+  ): CredentialCriterion[];
 }

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

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

src/core/models/credential.criteria.ts → src/core/models/credential.criterion.ts

@@ -1,6 +1,6 @@
 import { AuthorizationCredential } from '@alkemio/client-lib';
 
-export type CredentialCriteria = {
+export type CredentialCriterion = {
   type: AuthorizationCredential;
   resourceID?: string;
 };

src/core/models/index.ts

@@ -1,2 +1,2 @@
 export * from './user';
-export * from './credential.criteria';
+export * from './credential.criterion';

src/services/application/alkemio-client-adapter/alkemio.client.adapter.ts

@@ -2,7 +2,7 @@ import { Inject, Injectable, LoggerService } from '@nestjs/common';
 import { AlkemioClient } from '@alkemio/client-lib';
 import { ALKEMIO_CLIENT_PROVIDER, LogContext } from '@src/common';
 import { IFeatureFlagProvider } from '@core/contracts';
-import { CredentialCriteria, User } from '@core/models';
+import { CredentialCriterion, User } from '@core/models';
 import { WINSTON_MODULE_NEST_PROVIDER } from 'nest-winston';
 
 @Injectable()
@@ -33,7 +33,7 @@ export class AlkemioClientAdapter implements IFeatureFlagProvider {
   }
 
   async getUsersMatchingCredentialCriteria(
-    credentialCriteria: CredentialCriteria
+    credentialCriteria: CredentialCriterion
   ): Promise<User[]> {
     let resourceID: string | undefined = undefined;
     if (credentialCriteria.resourceID)
@@ -49,12 +49,12 @@ export class AlkemioClientAdapter implements IFeatureFlagProvider {
   }
 
   async getUniqueUsersMatchingCredentialCriteria(
-    credentialCriterias: CredentialCriteria[]
+    credentialCriteria: CredentialCriterion[]
   ): Promise<User[]> {
     const users: User[] = [];
-    for (const criteria of credentialCriterias) {
+    for (const criterion of credentialCriteria) {
       const matchedUsers = await this.getUsersMatchingCredentialCriteria(
-        criteria
+        criterion
       );
       users.push(...matchedUsers);
     }

src/services/application/index.ts

@@ -0,0 +1,5 @@
+export * from './notification-builder';
+export * from './alkemio-client-adapter';
+export * from './alkemio-url-generator';
+export * from './notification-recipients-adapter';
+export * from './template-to-credential-mapper';

src/services/application/notification-builder/index.ts

@@ -0,0 +1,2 @@
+export * from './notification.builder';
+export * from './notification.builder.factory.provider';