back/methods/notification/clean.js

@@ -0,0 +1,46 @@
+module.exports = Self => {
+    Self.remoteMethod('clean', {
+        description: 'clean notifications from queue',
+        accessType: 'WRITE',
+        returns: {
+            type: 'object',
+            root: true
+        },
+        http: {
+            path: `/clean`,
+            verb: 'POST'
+        }
+    });
+
+    Self.clean = async options => {
+        const models = Self.app.models;
+        const status = ['sent', 'error'];
+
+        const myOptions = {};
+        let tx;
+
+        if (typeof options == 'object')
+            Object.assign(myOptions, options);
+
+        if (!myOptions.transaction) {
+            tx = await Self.beginTransaction({});
+            myOptions.transaction = tx;
+        }
+
+        try {
+            const config = await models.NotificationConfig.findOne({}, myOptions);
+            const cleanDate = new Date();
+            cleanDate.setDate(cleanDate.getDate() - config.cleanDays);
+
+            await models.NotificationQueue.destroyAll({
+                where: {status: {inq: status}},
+                created: {lt: cleanDate}
+            }, myOptions);
+
+            if (tx) await tx.commit();
+        } catch (e) {
+            if (tx) await tx.rollback();
+            throw e;
+        }
+    };
+};

back/methods/notification/send.js

@@ -0,0 +1,81 @@
+const {Email} = require('vn-print');
+const UserError = require('vn-loopback/util/user-error');
+
+module.exports = Self => {
+    Self.remoteMethod('send', {
+        description: 'Send notifications from queue',
+        accessType: 'WRITE',
+        returns: {
+            type: 'object',
+            root: true
+        },
+        http: {
+            path: `/send`,
+            verb: 'POST'
+        }
+    });
+
+    Self.send = async options => {
+        const models = Self.app.models;
+        const findStatus = 'pending';
+
+        const myOptions = {};
+        if (typeof options == 'object')
+            Object.assign(myOptions, options);
+
+        const notificationQueue = await models.NotificationQueue.find({
+            where: {status: findStatus},
+            include: [
+                {
+                    relation: 'notification',
+                    scope: {
+                        include: {
+                            relation: 'subscription',
+                            scope: {
+                                include: {
+                                    relation: 'user',
+                                    scope: {
+                                        fields: ['name', 'email', 'lang']
+                                    }
+                                }
+                            }
+                        }
+                    }
+
+                }
+            ]
+        }, myOptions);
+
+        const statusSent = 'sent';
+        const statusError = 'error';
+
+        for (const queue of notificationQueue) {
+            const queueName = queue.notification().name;
+            const queueParams = JSON.parse(queue.params);
+
+            for (const notificationUser of queue.notification().subscription()) {
+                try {
+                    const sendParams = {
+                        recipient: notificationUser.user().email,
+                        lang: notificationUser.user().lang
+                    };
+
+                    if (notificationUser.userFk == queue.authorFk) {
+                        await queue.updateAttribute('status', statusSent);
+                        continue;
+                    }
+
+                    const newParams = Object.assign({}, queueParams, sendParams);
+                    const email = new Email(queueName, newParams);
+
+                    if (process.env.NODE_ENV != 'test')
+                        await email.send();
+
+                    await queue.updateAttribute('status', statusSent);
+                } catch (error) {
+                    await queue.updateAttribute('status', statusError);
+                }
+            }
+        }
+    };
+};

back/methods/notification/specs/clean.spec.js

@@ -0,0 +1,42 @@
+const models = require('vn-loopback/server/server').models;
+
+describe('Notification Clean()', () => {
+    it('should delete old rows with error', async() => {
+        const userId = 9;
+        const status = 'error';
+        const tx = await models.NotificationQueue.beginTransaction({});
+        const options = {transaction: tx};
+
+        const notification = await models.Notification.findOne({}, options);
+        const notificationConfig = await models.NotificationConfig.findOne({});
+
+        const cleanDate = new Date();
+        cleanDate.setDate(cleanDate.getDate() - (notificationConfig.cleanDays + 1));
+
+        let before;
+        let after;
+
+        try {
+            const notificationDelete = await models.NotificationQueue.create({
+                notificationFk: notification.name,
+                authorFk: userId,
+                status: status,
+                created: cleanDate
+            }, options);
+
+            before = await models.NotificationQueue.findById(notificationDelete.id, null, options);
+
+            await models.Notification.clean(options);
+
+            after = await models.NotificationQueue.findById(notificationDelete.id, null, options);
+
+            await tx.rollback();
+        } catch (e) {
+            await tx.rollback();
+            throw e;
+        }
+
+        expect(before.notificationFk).toEqual(notification.name);
+        expect(after).toBe(null);
+    });
+});

back/methods/notification/specs/send.spec.js

@@ -0,0 +1,33 @@
+const models = require('vn-loopback/server/server').models;
+
+describe('Notification Send()', () => {
+    it('should send notification', async() => {
+        const statusPending = 'pending';
+        const tx = await models.NotificationQueue.beginTransaction({});
+        const options = {transaction: tx};
+        const filter = {
+            where: {
+                status: statusPending
+            }
+        };
+
+        let before;
+        let after;
+
+        try {
+            before = await models.NotificationQueue.find(filter, options);
+
+            await models.Notification.send(options);
+
+            after = await models.NotificationQueue.find(filter, options);
+
+            await tx.rollback();
+        } catch (e) {
+            await tx.rollback();
+            throw e;
+        }
+
+        expect(before.length).toEqual(3);
+        expect(after.length).toEqual(0);
+    });
+});

back/model-config.json

@@ -77,6 +77,21 @@
     "Module": {
         "dataSource": "vn"
     },
+    "Notification": {
+        "dataSource": "vn"
+    },
+    "NotificationAcl": {
+        "dataSource": "vn"
+    },
+    "NotificationConfig": {
+        "dataSource": "vn"
+    },
+    "NotificationQueue": {
+        "dataSource": "vn"
+    },
+    "NotificationSubscription": {
+        "dataSource": "vn"
+    },
     "Province": {
         "dataSource": "vn"
     },

back/models/notification.js

@@ -0,0 +1,4 @@
+module.exports = Self => {
+    require('../methods/notification/send')(Self);
+    require('../methods/notification/clean')(Self);
+};

back/models/notification.json

@@ -0,0 +1,30 @@
+{
+	"name": "Notification",
+	"base": "VnModel",
+	"options": {
+		"mysql": {
+			"table": "util.notification"
+		}
+	},
+	"properties": {
+        "id": {
+            "type": "number",
+            "id": true,
+            "description": "Identifier"
+        },
+        "name": {
+            "type": "string",
+            "required": true
+        },
+        "description": {
+            "type": "string"
+        }
+    },
+    "relations": {
+        "subscription": {
+            "type": "hasMany",
+            "model": "NotificationSubscription",
+            "foreignKey": "notificationFk"
+        }
+    }
+}

back/models/notificationAcl.json

@@ -0,0 +1,21 @@
+{
+	"name": "NotificationAcl",
+	"base": "VnModel",
+	"options": {
+		"mysql": {
+			"table": "util.notificationAcl"
+		}
+	},
+	"relations": {
+        "notification": {
+            "type": "belongsTo",
+            "model": "Notification",
+            "foreignKey": "notificationFk"
+        },
+        "role": {
+            "type": "belongsTo",
+            "model": "Role",
+            "foreignKey": "roleFk"
+        }
+    }
+}

back/models/notificationConfig.json

@@ -0,0 +1,19 @@
+{
+	"name": "NotificationConfig",
+	"base": "VnModel",
+	"options": {
+		"mysql": {
+			"table": "util.notificationConfig"
+		}
+	},
+	"properties": {
+        "id": {
+            "type": "number",
+            "id": true,
+            "description": "Identifier"
+        },
+        "cleanDays": {
+            "type": "number"
+        }
+    }
+}

back/models/notificationQueue.json

@@ -0,0 +1,38 @@
+{
+	"name": "NotificationQueue",
+	"base": "VnModel",
+	"options": {
+		"mysql": {
+			"table": "util.notificationQueue"
+		}
+	},
+	"properties": {
+        "id": {
+            "type": "number",
+            "id": true,
+            "description": "Identifier"
+        },
+        "params": {
+            "type": "string"
+        },
+        "status": {
+            "type": "string"
+        },
+        "created": {
+            "type": "date"
+        }
+    },
+    "relations": {
+        "notification": {
+            "type": "belongsTo",
+            "model": "Notification",
+            "foreignKey": "notificationFk",
+            "primaryKey": "name"
+        },
+        "author": {
+            "type": "belongsTo",
+            "model": "Account",
+            "foreignKey": "authorFk"
+        }
+    }
+}

back/models/notificationSubscription.json

@@ -0,0 +1,33 @@
+{
+	"name": "NotificationSubscription",
+	"base": "VnModel",
+	"options": {
+		"mysql": {
+			"table": "util.notificationSubscription"
+		}
+	},
+    "properties": {
+        "notificationFk": {
+            "type": "number",
+            "id": true,
+            "description": "Identifier"
+        },
+        "userFk": {
+            "type": "number",
+            "id": true,
+            "description": "Identifier"
+        }
+    },
+	"relations": {
+        "notification": {
+            "type": "belongsTo",
+            "model": "Notification",
+            "foreignKey": "notificationFk"
+        },
+        "user": {
+            "type": "belongsTo",
+            "model": "Account",
+            "foreignKey": "userFk"
+        }
+    }
+}

db/changes/10490-goldenSummer/00-aclNotification.sql

@@ -0,0 +1,3 @@
+INSERT INTO `salix`.`ACL` (`model`, `property`, `accessType`, `permission`, `principalType`, `principalId`)
+    VALUES
+        ('Notification', '*', 'WRITE', 'ALLOW', 'ROLE', 'developer');

db/changes/10491-august/00-notificationProc.sql

@@ -0,0 +1,28 @@
+DROP FUNCTION IF EXISTS `util`.`notification_send`;
+DELIMITER $$
+CREATE DEFINER=`root`@`localhost` FUNCTION `util`.`notification_send`(vNotificationName VARCHAR(255), vParams TEXT, vAuthorFk INT)
+	RETURNS INT
+    MODIFIES SQL DATA
+BEGIN
+/**
+ * Sends a notification.
+ *
+ * @param vNotificationName The notification name
+ * @param vParams The notification parameters formatted as JSON
+ * @param vAuthorFk The notification author or %NULL if there is no author
+ * @return The notification id
+ */
+    DECLARE vNotificationFk INT;
+
+	SELECT id INTO vNotificationFk
+		FROM `notification`
+		WHERE `name` = vNotificationName;
+
+	INSERT INTO notificationQueue
+		SET notificationFk = vNotificationFk,
+			params = vParams,
+			authorFk = vAuthorFk;
+
+	RETURN LAST_INSERT_ID();
+END$$
+DELIMITER ;

db/changes/10491-august/00-notificationTables.sql

@@ -0,0 +1,63 @@
+USE util;
+
+CREATE TABLE notification(
+    id INT PRIMARY KEY,
+    `name` VARCHAR(255) UNIQUE,
+    `description` VARCHAR(255)
+);
+
+CREATE TABLE notificationAcl(
+    notificationFk INT,
+    roleFk INT(10) unsigned,
+    PRIMARY KEY(notificationFk, roleFk)
+);
+
+ALTER TABLE `util`.`notificationAcl` ADD CONSTRAINT `notificationAcl_ibfk_1` FOREIGN KEY (`notificationFk`) REFERENCES `util`.`notification` (`id`)
+  ON DELETE CASCADE
+  ON UPDATE CASCADE;
+
+ALTER TABLE `util`.`notificationAcl` ADD CONSTRAINT `notificationAcl_ibfk_2` FOREIGN KEY (`roleFk`) REFERENCES `account`.`role`(`id`)
+  ON DELETE RESTRICT
+  ON UPDATE CASCADE;
+
+CREATE TABLE notificationSubscription(
+    notificationFk INT,
+    userFk INT(10) unsigned,
+    PRIMARY KEY(notificationFk, userFk)
+);
+
+ALTER TABLE `util`.`notificationSubscription` ADD CONSTRAINT `notificationSubscription_ibfk_1` FOREIGN KEY (`notificationFk`) REFERENCES `util`.`notification` (`id`)
+  ON DELETE CASCADE
+  ON UPDATE CASCADE;
+
+ALTER TABLE `util`.`notificationSubscription` ADD CONSTRAINT `notificationSubscription_ibfk_2` FOREIGN KEY (`userFk`) REFERENCES  `account`.`user`(`id`)
+  ON DELETE CASCADE
+  ON UPDATE CASCADE;
+
+CREATE TABLE notificationQueue(
+    id INT PRIMARY KEY AUTO_INCREMENT,
+    notificationFk VARCHAR(255),
+    params JSON,
+    authorFk INT(10) unsigned NULL,
+    `status` ENUM('pending', 'sent', 'error') NOT NULL DEFAULT 'pending',
+    created DATETIME DEFAULT CURRENT_TIMESTAMP,
+    INDEX(notificationFk),
+    INDEX(authorFk),
+    INDEX(status)
+);
+
+ALTER TABLE `util`.`notificationQueue` ADD CONSTRAINT `nnotificationQueue_ibfk_1` FOREIGN KEY (`notificationFk`) REFERENCES `util`.`notification` (`name`)
+  ON DELETE CASCADE
+  ON UPDATE CASCADE;
+
+ALTER TABLE `util`.`notificationQueue` ADD CONSTRAINT `notificationQueue_ibfk_2` FOREIGN KEY (`authorFk`) REFERENCES `account`.`user`(`id`)
+  ON DELETE CASCADE
+  ON UPDATE CASCADE;
+
+CREATE TABLE notificationConfig(
+    id INT PRIMARY KEY AUTO_INCREMENT,
+    cleanDays MEDIUMINT
+);
+
+INSERT INTO notificationConfig
+    SET cleanDays = 90;

db/dump/fixtures.sql

@@ -14,10 +14,10 @@ INSERT INTO `salix`.`AccessToken` (`id`, `ttl`, `created`, `userId`)
         ('DEFAULT_TOKEN', '1209600', util.VN_CURDATE(), 66);
 
 INSERT INTO `salix`.`printConfig` (`id`, `itRecipient`, `incidencesEmail`)
-    VALUES 
+    VALUES
         (1, 'it@gotamcity.com', 'incidences@gotamcity.com');
 
-INSERT INTO `vn`.`ticketConfig` (`id`, `scopeDays`) 
+INSERT INTO `vn`.`ticketConfig` (`id`, `scopeDays`)
     VALUES
         ('1', '6');
 
@@ -2658,6 +2658,28 @@ INSERT INTO `vn`.`workerTimeControlConfig` (`id`, `dayBreak`, `dayBreakDriver`,
     VALUES
         (1, 43200, 32400, 129600, 259200, 604800, '', '', 'Leidos.exito', 'Leidos.error', 'timeControl', 5.33, 0.33, 40, '22:00:00', '06:00:00', 57600, 1200, 18000, 57600, 6, 13);
 
+INSERT INTO `util`.`notificationConfig`
+	SET `cleanDays` = 90;
+
+INSERT INTO `util`.`notification` (`id`, `name`, `description`)
+    VALUES
+        (1, 'print-email', 'notification fixture one');
+
+INSERT INTO `util`.`notificationAcl` (`notificationFk`, `roleFk`)
+    VALUES
+        (1, 9);
+
+INSERT INTO `util`.`notificationQueue` (`id`, `notificationFk`, `params`, `authorFk`, `status`, `created`)
+    VALUES
+        (1, 'print-email', '{"id": "1"}', 9, 'pending', util.VN_CURDATE()),
+        (2, 'print-email', '{"id": "2"}', null, 'pending', util.VN_CURDATE()),
+        (3, 'print-email', null, null, 'pending', util.VN_CURDATE());
+
+INSERT INTO `util`.`notificationSubscription` (`notificationFk`, `userFk`)
+    VALUES
+        (1, 1109),
+        (1, 1110);
+
 INSERT INTO `vn`.`routeConfig` (`id`, `defaultWorkCenterFk`)
     VALUES
         (1, 9);