Merge pull request #19 from opensource254/dev

Notifications

Author: StanleyMasinde

.env.example

@@ -1,3 +1,15 @@
 PORT=3232
 SECRET_TOKEM=
-ALLOWED_HOSTS="github.com,bitbucket.org,gitlab.com"
+SLACK_WEBHOOK_URL=
+
+SMTP_HOST=smtp.mailtrap.io
+SMTP_PORT=2525
+SMTP_USERNAME=
+SMTP_PASSWORD=
+
+NOTIFICATION_EMAIL=
+NOTIFICATION_FROM=
+
+ALLOW_NOTIFiCATIONS=true
+SUCCESS_NOTIFICATIONS=false
+ERROR_NOTIFICATIONS=false

README.md

@@ -53,6 +53,40 @@ SECRET=<your-secret>
 Add this secret to your webhook secret too.
 * If a security check fails, the endpoint will respond with error 403
 
+## Notifications
+Two notifications channels are currently supported.
+* Email (The current supported protocal is SMTP)
+* Slack
+Turning notifications on
+```env
+ALLOW_NOTIFICATIONS=true
+// Notify on successful deployment
+SUCCESS_NOTIFICATIONS=false
+// Notify on failures/warnings
+ERROR_NOTIFICATIONS=false
+```
+
+### Email Configuration
+Add the config details in the .env file.
+example
+```env
+SMTP_HOST=smtp.mailtrap.io
+SMTP_PORT=2525
+SMTP_USERNAME=
+SMTP_PASSWORD=
+
+// The email to send notifications to
+NOTIFICATION_EMAIL=
+// The from address that will be shown in the email
+NOTIFICATION_FROM=
+```
+### Slack Configuration
+Slack config is as simple as adding the webhook config.
+Create a Slack app and add the webhook url for the app to `.env` like below
+```env
+SLACK_WEBHOOK_URL=
+```
+
 ## Debugging
 Configuration erros are logged in the error.log file. This file is not version controlled.
 ```log
@@ -65,8 +99,8 @@ Sat, 13 Jun 2020 10:01:58 GMT Config: your-awesome-config, Error: /bin/sh: 1: ks
 - [x] Basic functionality
 - [x] Refactor
 - [x] Webhook Security
+- [x] Notifications
 - [ ] Web interface
-- [ ] Notifications
 
 ## Contributing
 Please visit our [guidelines](https://opensource254.github.io/guidelines)

config/mail.js

@@ -0,0 +1,9 @@
+const mail = {
+    /**The email host */
+    SMTP_HOST: process.env.SMTP_HOST || 'smtp.mailtrap.io',
+    SMTP_PORT: process.env.SMTP_PORT || 25,
+    SMTP_USERNAME: process.env.SMTP_USERNAME || '',
+    SMTP_PASSWORD: process.env.SMTP_PASSWORD || ''
+}
+
+module.exports = Object.freeze(mail)

config/notifications.js

@@ -0,0 +1,54 @@
+/**
+ * -------------------------------------------------------------------
+ * This is where th notification config lives. 
+ * All these values can be overwritten by the environment variables
+ * -------------------------------------------------------------------
+ */
+const notificationConfig = {
+    /**This is used to determine if notifications are enabled */
+    allowNotifications: process.env.ALLOW_NOTIFICATIONS || false,
+
+
+    /** 
+     * Your Slack webhook URL. If empty Slack notifications will be off 
+     * This is the URL you received when creating a Slack APP
+     * Slack is ignored if this is null or false
+     * 
+    */
+    slackWebhookURL: process.env.SLACK_WEBHOOK_URL,
+
+
+    /** 
+     * Notification Email 
+     * An email will be send to this email(s) according to 
+     * Your config
+     * */
+    notificationEmail: process.env.NOTIFICATION_EMAIL,
+
+    /**
+     * Notification from email
+     * The From adress that will be shown in the email
+     */
+    notificationFrom: process.env.NOTIFICATION_FROM,
+
+
+    /**
+     * Get notifications on errors that occour 
+     * during deployment
+     */
+    notifyOnErrors: process.env.ERROR_NOTIFICATIONS || true,
+
+    /**
+     * 
+     * This is used to set notification on successful deployments
+     */
+    notifyOnSucess: process.env.SUCCESS_NOTIFICATIONS || true
+
+    /**
+     * Telegram
+     * Coming Soon
+     */
+    // TODO Add telegram
+}
+
+module.exports = Object.freeze(notificationConfig)

package-lock.json

@@ -11,7 +11,8 @@
     "debug": "~2.6.9",
     "dotenv": "^8.2.0",
     "express": "~4.16.1",
-    "morgan": "~1.9.1"
+    "morgan": "~1.9.1",
+    "nodemailer": "^6.4.10"
   },
   "devDependencies": {
     "nodemon": "^2.0.4"

package.json

@@ -1,22 +1,57 @@
 const fs = require('fs')
 const { exec } = require('child_process')
+const NotificationService = require('./notifications')
 
 /**
  * Handle deployment
  * @param {Array} Config 
  */
 const deployment = (Config = []) => {
     exec(`${Config.command}`, (_err, stdout, stderr) => {
+        /**The output logged during the command excecution */
         if (stdout) {
-            // TODO Make this available to the user
+            const slack = (`
+            *Deployment for _${Config.name}_ was successful 😃* \n*Output*: \`\`\`${stdout.trim()}\`\`\`
+            `)
+
+            const mail = {
+                subject: `Deployment for ${Config.name} was successfull ✅`,
+                data: (`
+            <h3>Deployment for <i>${Config.name}</i> was successful 😃</h3> <br/>
+            <b>Output:</b> <code color="green">${stdout.trim()}</code>
+            `)
+            }
+            new NotificationService({ slack, mail }, 'success').sendNotifications()
         }
+        /** If an error occoured */
         if (stderr) {
-            fs.writeFileSync('error.log', `${new Date().toUTCString()}, Config: ${Config.name}, Error: ${stderr}`, {
+            const slack = (`
+                *Deployment for * _${Config.name}_ failed 😢 \n*Date* \`${new Date().toUTCString()}\` \n*The following error was logged:* \`\`\`${stderr.trim()}\`\`\`
+            `)
+
+            const mail = {
+                subject: `Deployment for ${Config.name} failed ❌`,
+                data: (`
+            <h3>Deployment for ${Config.name} failed 😢 </h3>
+            <br/>
+            <b>Date</b> <date>${new Date().toUTCString()}</date> <br/>
+            <b>The following error was logged:</b> <code color="red">${stderr.trim()}</code>
+            `)
+            }
+
+            /** Send error notification */
+            new NotificationService({ slack, mail }, 'error').sendNotifications()
+
+            /**
+             * Write error log
+             */
+            fs.writeFileSync('error.log', `${new Date().toUTCString()}, Config: ${Config.name}, Error: ${stderr.trim()}`, {
                 encoding: 'utf-8',
                 flag: 'a',
             })
         }
     })
 }
 
+
 module.exports = deployment

services/deployment.js

@@ -0,0 +1,12 @@
+const mailer = require('nodemailer')
+const mail = require('../config/mail')
+const transport = mailer.createTransport({
+    host: mail.SMTP_HOST,
+    port: mail.SMTP_PORT,
+    auth: {
+        user: mail.SMTP_USERNAME,
+        pass: mail.SMTP_PASSWORD
+    }
+})
+
+module.exports = transport

services/mail.js

@@ -0,0 +1,151 @@
+/**
+ * ------------------------------------------------------------------------
+ * This file contains the notification services that are supported
+ * This includes Slack,Email,Telegram
+ * ------------------------------------------------------------------------
+ */
+const config = require('../config/notifications')
+const https = require('https')
+const transport = require('./mail')
+
+class NotificationService {
+    /**
+     * Notification service is enabled
+     */
+    notificationEnabled = Boolean
+    /**
+     * The Slack Webhook URL
+     */
+    slackURL = String
+    /**
+     * Successful build notification
+     */
+    notifyOnSuccess = Boolean
+    /**
+     * Error Notifications
+     */
+    notifyOnError = Boolean
+    /**
+     * The email for notifications
+     */
+    notificationEmail = String
+
+    /**
+     * The notification payload
+     */
+    notificationData = String
+
+    /**
+     * The notification type
+     */
+    notificationType = Boolean
+
+    /**
+     * initialise the service
+     * @param {Array} data 
+     * @param {String} type 
+     */
+    constructor(data = {}, type = '') {
+        this.notificationEnabled = config.allowNotifications
+        this.slackURL = config.slackWebhookURL
+        this.notifyOnError = config.notifyOnErrors
+        this.notifyOnSuccess = config.notifyOnSucess
+        this.notificationEmail = config.notificationEmail
+        this.notificationData = data
+        this.notificationType = type
+    }
+
+    /**
+     * Send notifications
+     * @param {Array} services 
+     * @returns void
+     */
+    sendNotifications() {
+        if (!this.notificationEnabled) {
+            return
+        }
+        if (this.notificationType === 'success' && this.notifyOnSuccess === 'false') {
+            return
+        }
+        if (this.notificationType === 'error' && this.notifyOnError === 'false') {
+            return
+        }
+        const services = this.getSupportedServices()
+        services.forEach((service) => {
+            switch (service.name) {
+                case 'Slack':
+                    this.sendSlackWebhook(service.value)
+                    break;
+                case 'email':
+                    this.sendEmails()
+                    break;
+                default:
+                    break;
+            }
+        })
+    }
+
+    /**
+     * Get the supported services
+     * @returns Array []
+     */
+    getSupportedServices() {
+        const supportedServices = []
+        if (this.slackURL) {
+            supportedServices.push({
+                name: 'Slack',
+                value: this.slackURL
+            })
+        }
+        if (this.notificationEmail) {
+            supportedServices.push({
+                name: 'email', value: this.notificationEmail
+            })
+        }
+        return supportedServices
+    }
+
+    /**
+     * Send slack webhook
+     * @param {String} url 
+     * @returns Boolean
+     */
+    sendSlackWebhook(url = '') {
+        const fullURL = new URL(url)
+        const payload = Buffer.from(JSON.stringify({
+            text: this.notificationData.slack,
+            mrkdwn: true
+        }))
+        const request = https.request({
+            host: fullURL.host,
+            path: fullURL.pathname,
+            method: 'POST',
+            port: 443,
+            protocol: 'https:'
+        }, (res) => {
+            res.setEncoding('utf-8');
+        })
+        request.on('error', (err) => {
+            throw err
+        })
+        request.write(payload)
+        request.end()
+    }
+
+    /**
+     * Send Email(s)
+     * @param {String} emails 
+     * @returns Boolean
+     */
+    sendEmails() {
+        transport.sendMail({
+            from: config.notificationFrom,
+            to: config.notificationEmail,
+            subject: this.notificationData.mail.subject,
+            html: this.notificationData.mail.data,
+        });
+        return true
+    }
+}
+
+module.exports = NotificationService