ServiceBricks Notification Microservice

Overview

This repository contains a notification microservice built using the ServiceBricks foundation. The notification microservice is responsible for send emails and SMS messages from the system. It provides a background task to process notify messages, along with retry, should external providers not be available. It also subscribes to service bus messages for email and sms broadcasts, so that the security microservice and others have a default mechanism to send notifications from the system.

Supported Providers

By default, dependency injection is registered with a dummy email and sms provider that does not send any message but simply logs them using an ILogger<> inteface. You must expliciting add a line of code to register the providers below.

View Source

Email

• SendGrid - Nuget Package - ServiceBricks.Notification.SendGrid

services.AddServiceBricksNotificationSendGrid();

• Smtp - Included in ServiceBricks.Notification

services.AddScoped<IEmailProvider, SmtpEmailProvider>();

SMS

Twilio Coming soon!

services.AddScoped<ISmsProvider, YourProviderHere>();

Data Transfer Objects

NotifyMessageDto - Admin Policy

Used to store a notification message. Contains properties from IDpProcessQueue for queue processng.

public class NotifyMessageDto : DataTransferObject
{
    public int SenderTypeKey { get; set; }
    public bool IsError { get; set; }
    public bool IsComplete { get; set; }
    public int RetryCount { get; set; }
    public DateTimeOffset FutureProcessDate { get; set; }
    public DateTimeOffset CreateDate { get; set; }
    public DateTimeOffset UpdateDate { get; set; }
    public DateTimeOffset ProcessDate { get; set; }
    public string ProcessResponse { get; set; }
    public bool IsProcessing { get; set; }

    public virtual bool IsHtml { get; set; }
    public virtual string Priority { get; set; }
    public virtual string Subject { get; set; }
    public virtual string BccAddress { get; set; }
    public virtual string CcAddress { get; set; }
    public virtual string ToAddress { get; set; }
    public virtual string FromAddress { get; set; }
    public virtual string Body { get; set; }
    public virtual string BodyHtml { get; set; }
}

Business Rules

• DomainCreateUpdateDateRule - CreateDate and UpdateDate property
• DomainDateTimeOffsetRule - FutureProcessDate, ProcessDate properties
• ApiConcurrencyByUpdateDateRule - UpdateDate property
• NotifyMessageDtoValidateSenderTypeRule - SendTypeKey property is a valid value

Background Tasks and Timers

NotificationSendTimer class

This background timer runs by default every 30 seconds, with an initial delay of 30 seconds. Executes the NotificationSendTask.

View Source

NotificationSendTask class

This background task invokes the INotifyMessageProcessQueueService

View Source

Events

None

Processes

SendNotificationProcess

This process is associated to the SendNotificationProcessRule Business Rule.

Supply a NotifyMessageDto as a parameter and the process will use the configured email or sms provider and attempt to send the message with them.

public class SendNotificationProcess : DomainProcess<NotifyMessageDto>
{
    public SendNotificationProcess(NotifyMessageDto message)
    {
        DomainObject = message;
    }
}

To execute this process, use the following code:

var businessRuleService = services.GetRequiredService<IBusinessRuleService>();
var process = new SendNotificationProcess(message);
var response = businessRuleService.ExecuteProcess(process);

Service Bus

CreateApplicationEmailBroadcast

This microservice subscribes to the CreateApplicationEmailBroadcast message. It is associated to the CreateApplicationEmailRule Business Rule. When receiving the message, it will simply create a record in storage and allow the background process to pick it up to process it.

    public class CreateApplicationEmailBroadcast : DomainBroadcast<ApplicationEmailDto>
    {
        public CreateApplicationEmailBroadcast(ApplicationEmailDto obj)
        {
            DomainObject = obj;
        }
    }

CreateApplicationSmsBroadcast

This microservice subscribes to the CreateApplicationSmsBroadcast message. It is associated to the CreateApplicationSmsRule Business Rule. When receiving the message, it will simply create a record in storage and allow the background process to pick it up to process it.

    public class CreateApplicationSmsBroadcast : DomainBroadcast<ApplicationSmsDto>
    {
        public CreateApplicationSmsBroadcast(ApplicationSmsDto obj)
        {
            DomainObject = obj;
        }
    }

Additional

Application Settings

{
  // ServiceBricks Settings
  "ServiceBricks":{

    // Notification Microservice Settings
    "Notification": {
      "Options": {
        // Default from address for email and sms, if not specified when created
        "EmailFromDefault": "support@servicebricks.com",
        "SmsFromDefault": "1234567890",
    
        // when in development mode, emails and sms messages will be sent to only these addresses
        "IsDevelopment": true,
        "DevelopmentEmailTo": "developer@servicebricks.com",
        "DevelopmentSmsTo": "1111111111"
      },
    
      // SMTP Email settings
      "Smtp": {
        "EmailServer": "yourserver.com",
        "EmailPort": 123,
        "EmailEnableSsl": true,
        "EmailUsername": "username",
        "EmailPassword": "password"
      },
    
      // SendGrid Integration
      "SendGrid": {
        "ApiKey": "SendGridApiKey"
      }
    }
  }
}

About ServiceBricks

ServiceBricks is the cornerstone for building a microservices foundation. Visit http://ServiceBricks.com to learn more.