From 7895decf4eea09243c552d6cd94ad3d9d7ffae78 Mon Sep 17 00:00:00 2001 From: alexm Date: Tue, 19 Jul 2022 15:17:22 +0200 Subject: [PATCH 1/8] feat(notification): create models --- back/methods/notification/clean.js | 0 back/methods/notification/send.js | 18 ++++++ back/models/notifcation.json | 22 +++++++ back/models/notifcationAcl.json | 21 +++++++ back/models/notifcationConfig.json | 19 ++++++ back/models/notifcationQueue.json | 37 ++++++++++++ back/models/notification.js | 4 ++ back/models/notificationSubscription.json | 21 +++++++ db/dump/fixtures.sql | 5 +- db/dump/structure.sql | 71 ++++++++++++++++++++++- 10 files changed, 214 insertions(+), 4 deletions(-) create mode 100644 back/methods/notification/clean.js create mode 100644 back/methods/notification/send.js create mode 100644 back/models/notifcation.json create mode 100644 back/models/notifcationAcl.json create mode 100644 back/models/notifcationConfig.json create mode 100644 back/models/notifcationQueue.json create mode 100644 back/models/notification.js create mode 100644 back/models/notificationSubscription.json diff --git a/back/methods/notification/clean.js b/back/methods/notification/clean.js new file mode 100644 index 0000000000..e69de29bb2 diff --git a/back/methods/notification/send.js b/back/methods/notification/send.js new file mode 100644 index 0000000000..bb2d79f2a2 --- /dev/null +++ b/back/methods/notification/send.js @@ -0,0 +1,18 @@ +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() => { + + }; +}; diff --git a/back/models/notifcation.json b/back/models/notifcation.json new file mode 100644 index 0000000000..e4f0be17e0 --- /dev/null +++ b/back/models/notifcation.json @@ -0,0 +1,22 @@ +{ + "name": "Notificacion", + "base": "VnModel", + "options": { + "mysql": { + "table": "notificacion" + } + }, + "properties": { + "id": { + "type": "number", + "id": true, + "description": "Identifier" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + } + } +} \ No newline at end of file diff --git a/back/models/notifcationAcl.json b/back/models/notifcationAcl.json new file mode 100644 index 0000000000..f5861943f7 --- /dev/null +++ b/back/models/notifcationAcl.json @@ -0,0 +1,21 @@ +{ + "name": "NotificacionAcl", + "base": "VnModel", + "options": { + "mysql": { + "table": "notificacionAcl" + } + }, + "relations": { + "notificacion": { + "type": "belongsTo", + "model": "Notificacion", + "foreignKey": "notificacionFk" + }, + "role": { + "type": "belongsTo", + "model": "Role", + "foreignKey": "roleFk" + } + } +} \ No newline at end of file diff --git a/back/models/notifcationConfig.json b/back/models/notifcationConfig.json new file mode 100644 index 0000000000..73882b6b7a --- /dev/null +++ b/back/models/notifcationConfig.json @@ -0,0 +1,19 @@ +{ + "name": "NotificationConfig", + "base": "VnModel", + "options": { + "mysql": { + "table": "notificationConfig" + } + }, + "properties": { + "id": { + "type": "number", + "id": true, + "description": "Identifier" + }, + "cleanDays": { + "type": "number" + } + } +} \ No newline at end of file diff --git a/back/models/notifcationQueue.json b/back/models/notifcationQueue.json new file mode 100644 index 0000000000..7a9199bc0f --- /dev/null +++ b/back/models/notifcationQueue.json @@ -0,0 +1,37 @@ +{ + "name": "NotificacionQueue", + "base": "VnModel", + "options": { + "mysql": { + "table": "notificacionQueue" + } + }, + "properties": { + "id": { + "type": "number", + "id": true, + "description": "Identifier" + }, + "params": { + "type": "string" + }, + "status": { + "type": "string" + }, + "created": { + "type": "date" + } + }, + "relations": { + "notificacion": { + "type": "belongsTo", + "model": "Notificacion", + "foreignKey": "notificacionFk" + }, + "author": { + "type": "belongsTo", + "model": "User", + "foreignKey": "authorFk" + } + } +} \ No newline at end of file diff --git a/back/models/notification.js b/back/models/notification.js new file mode 100644 index 0000000000..da766d4424 --- /dev/null +++ b/back/models/notification.js @@ -0,0 +1,4 @@ +module.exports = Self => { + require('../methods/notification/send')(Self); + require('../methods/notification/clear')(Self); +}; diff --git a/back/models/notificationSubscription.json b/back/models/notificationSubscription.json new file mode 100644 index 0000000000..ed8bb1907d --- /dev/null +++ b/back/models/notificationSubscription.json @@ -0,0 +1,21 @@ +{ + "name": "NotificationSubscription", + "base": "VnModel", + "options": { + "mysql": { + "table": "notificationSubscription" + } + }, + "relations": { + "notificacion": { + "type": "belongsTo", + "model": "Notificacion", + "foreignKey": "notificacionFk" + }, + "user": { + "type": "belongsTo", + "model": "User", + "foreignKey": "userFk" + } + } +} \ No newline at end of file diff --git a/db/dump/fixtures.sql b/db/dump/fixtures.sql index 0609a6a6ab..dabc731394 100644 --- a/db/dump/fixtures.sql +++ b/db/dump/fixtures.sql @@ -2610,4 +2610,7 @@ INSERT INTO `vn`.`sectorCollectionSaleGroup` (`sectorCollectionFk`, `saleGroupFk INSERT INTO `vn`.`workerTimeControlConfig` (`id`, `dayBreak`, `dayBreakDriver`, `shortWeekBreak`, `longWeekBreak`, `weekScope`, `mailPass`, `mailHost`, `mailSuccessFolder`, `mailErrorFolder`, `mailUser`, `minHoursToBreak`, `breakHours`, `hoursCompleteWeek`, `startNightlyHours`, `endNightlyHours`, `maxTimePerDay`, `breakTime`, `timeToBreakTime`, `dayMaxTime`, `shortWeekDays`, `longWeekDays`) 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); \ No newline at end of file + (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; \ No newline at end of file diff --git a/db/dump/structure.sql b/db/dump/structure.sql index 2c0e8231af..9238557620 100644 --- a/db/dump/structure.sql +++ b/db/dump/structure.sql @@ -20849,9 +20849,74 @@ CREATE DATABASE /*!32312 IF NOT EXISTS*/ `util` /*!40100 DEFAULT CHARACTER SET u USE `util`; --- --- Table structure for table `config` --- +CREATE TABLE notification( + id INT PRIMARY KEY, + `name` VARCHAR(255) UNIQUE, + `description` VARCHAR(255) +); + +CREATE TABLE notificationAcl ( + notificationFk INT(11), + roleFk INT(10) unsigned, + PRIMARY KEY(notificationFk, roleFk), + CONSTRAINT `notificationAcl_ibfk_1` FOREIGN KEY (`notificationFk`) REFERENCES `notification` (`id`) ON DELETE CASCADE ON UPDATE CASCADE, + CONSTRAINT `notificationAcl_ibfk_2` FOREIGN KEY (`roleFk`) REFERENCES `account`.`role` (`id`) ON DELETE CASCADE ON UPDATE CASCADE +); + +CREATE TABLE notificationSubscription( + notificationFk INT, + userFk INT(10) unsigned, + PRIMARY KEY(notificationFk, userFk), + CONSTRAINT `notificationSubscription_ibfk_1` FOREIGN KEY (`notificationFk`) REFERENCES `notification` (`id`) ON DELETE CASCADE ON UPDATE CASCADE, + 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 TEXT, + 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), + CONSTRAINT `notificationQueue_ibfk_1` FOREIGN KEY (`notificationFk`) REFERENCES `notification` (`name`) ON DELETE CASCADE ON UPDATE CASCADE, + 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 +); + +DROP FUNCTION IF EXISTS util.notification_send; +DELIMITER $$ +CREATE FUNCTION util.notification_send(vNotificationName VARCHAR(255), vParams TEXT, vAuthorFk INT) + RETURNS INT +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 ; DROP TABLE IF EXISTS `config`; /*!40101 SET @saved_cs_client = @@character_set_client */; From 9b48cbb07866be87502d33cee7d6648243606a0d Mon Sep 17 00:00:00 2001 From: alexm Date: Wed, 20 Jul 2022 14:54:50 +0200 Subject: [PATCH 2/8] feat(notification): send --- back/methods/notification/send.js | 19 ++++++++++++++++++- back/model-config.json | 15 +++++++++++++++ back/models/notification.js | 1 - .../{notifcation.json => notification.json} | 4 ++-- ...tifcationAcl.json => notificationAcl.json} | 10 +++++----- ...ionConfig.json => notificationConfig.json} | 2 +- ...ationQueue.json => notificationQueue.json} | 10 +++++----- back/models/notificationSubscription.json | 8 ++++---- .../10490-goldenSummer/00-aclNotification.sql | 3 +++ db/dump/fixtures.sql | 18 +++++++++++++++++- 10 files changed, 70 insertions(+), 20 deletions(-) rename back/models/{notifcation.json => notification.json} (84%) rename back/models/{notifcationAcl.json => notificationAcl.json} (59%) rename back/models/{notifcationConfig.json => notificationConfig.json} (88%) rename back/models/{notifcationQueue.json => notificationQueue.json} (76%) create mode 100644 db/changes/10490-goldenSummer/00-aclNotification.sql diff --git a/back/methods/notification/send.js b/back/methods/notification/send.js index bb2d79f2a2..d5149fc59b 100644 --- a/back/methods/notification/send.js +++ b/back/methods/notification/send.js @@ -1,7 +1,7 @@ module.exports = Self => { Self.remoteMethod('send', { description: 'Send notifications from queue', - accessType: 'WRITE', + accessType: 'READ', returns: { type: 'object', root: true @@ -13,6 +13,23 @@ module.exports = Self => { }); Self.send = async() => { + const status = 'pending'; + const myOptions = {}; + let tx; + + if (!myOptions.transaction) { + tx = await Self.beginTransaction({}); + myOptions.transaction = tx; + } + + const notificationQueue = await Self.app.models.NotificationQueue.find({ + where: {code: status}, + include: [{ + relation: 'notificationSubscription' + }] + }, myOptions); + + console.log(notificationQueue); }; }; diff --git a/back/model-config.json b/back/model-config.json index 3432103832..755f449de7 100644 --- a/back/model-config.json +++ b/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" }, diff --git a/back/models/notification.js b/back/models/notification.js index da766d4424..46378bd027 100644 --- a/back/models/notification.js +++ b/back/models/notification.js @@ -1,4 +1,3 @@ module.exports = Self => { require('../methods/notification/send')(Self); - require('../methods/notification/clear')(Self); }; diff --git a/back/models/notifcation.json b/back/models/notification.json similarity index 84% rename from back/models/notifcation.json rename to back/models/notification.json index e4f0be17e0..9422d03b37 100644 --- a/back/models/notifcation.json +++ b/back/models/notification.json @@ -1,9 +1,9 @@ { - "name": "Notificacion", + "name": "Notification", "base": "VnModel", "options": { "mysql": { - "table": "notificacion" + "table": "util.notification" } }, "properties": { diff --git a/back/models/notifcationAcl.json b/back/models/notificationAcl.json similarity index 59% rename from back/models/notifcationAcl.json rename to back/models/notificationAcl.json index f5861943f7..e3e97f52de 100644 --- a/back/models/notifcationAcl.json +++ b/back/models/notificationAcl.json @@ -1,16 +1,16 @@ { - "name": "NotificacionAcl", + "name": "NotificationAcl", "base": "VnModel", "options": { "mysql": { - "table": "notificacionAcl" + "table": "util.notificationAcl" } }, "relations": { - "notificacion": { + "notification": { "type": "belongsTo", - "model": "Notificacion", - "foreignKey": "notificacionFk" + "model": "Notification", + "foreignKey": "notificationFk" }, "role": { "type": "belongsTo", diff --git a/back/models/notifcationConfig.json b/back/models/notificationConfig.json similarity index 88% rename from back/models/notifcationConfig.json rename to back/models/notificationConfig.json index 73882b6b7a..b00ed3675b 100644 --- a/back/models/notifcationConfig.json +++ b/back/models/notificationConfig.json @@ -3,7 +3,7 @@ "base": "VnModel", "options": { "mysql": { - "table": "notificationConfig" + "table": "util.notificationConfig" } }, "properties": { diff --git a/back/models/notifcationQueue.json b/back/models/notificationQueue.json similarity index 76% rename from back/models/notifcationQueue.json rename to back/models/notificationQueue.json index 7a9199bc0f..122d3816d3 100644 --- a/back/models/notifcationQueue.json +++ b/back/models/notificationQueue.json @@ -1,9 +1,9 @@ { - "name": "NotificacionQueue", + "name": "NotificationQueue", "base": "VnModel", "options": { "mysql": { - "table": "notificacionQueue" + "table": "util.notificationQueue" } }, "properties": { @@ -23,10 +23,10 @@ } }, "relations": { - "notificacion": { + "notification": { "type": "belongsTo", - "model": "Notificacion", - "foreignKey": "notificacionFk" + "model": "Notification", + "foreignKey": "notificationFk" }, "author": { "type": "belongsTo", diff --git a/back/models/notificationSubscription.json b/back/models/notificationSubscription.json index ed8bb1907d..14b305ca8c 100644 --- a/back/models/notificationSubscription.json +++ b/back/models/notificationSubscription.json @@ -3,14 +3,14 @@ "base": "VnModel", "options": { "mysql": { - "table": "notificationSubscription" + "table": "util.notificationSubscription" } }, "relations": { - "notificacion": { + "notification": { "type": "belongsTo", - "model": "Notificacion", - "foreignKey": "notificacionFk" + "model": "Notification", + "foreignKey": "notificationFk" }, "user": { "type": "belongsTo", diff --git a/db/changes/10490-goldenSummer/00-aclNotification.sql b/db/changes/10490-goldenSummer/00-aclNotification.sql new file mode 100644 index 0000000000..aa4e32cee4 --- /dev/null +++ b/db/changes/10490-goldenSummer/00-aclNotification.sql @@ -0,0 +1,3 @@ +INSERT INTO `salix`.`ACL` (`model`, `property`, `accessType`, `permission`, `principalType`, `principalId`) + VALUES + ('Notification', '*', 'READ', 'ALLOW', 'ROLE', 'developer'); diff --git a/db/dump/fixtures.sql b/db/dump/fixtures.sql index dabc731394..f73210a960 100644 --- a/db/dump/fixtures.sql +++ b/db/dump/fixtures.sql @@ -2613,4 +2613,20 @@ INSERT INTO `vn`.`workerTimeControlConfig` (`id`, `dayBreak`, `dayBreakDriver`, (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; \ No newline at end of file + SET `cleanDays` = 90; + +INSERT INTO `util`.`notification` (`id`, `name`, `description`) + VALUES + (1, 'notification one', 'notification fixture one'); + +INSERT INTO `util`.`notificationAcl` (`notificationFk`, `roleFk`) + VALUES + (1, 9); + +INSERT INTO `util`.`notificationQueue` (`id`, `notificationFk`, `params`, `authorFk`, `status`, `created`) + VALUES + (1, 'notification one', 'randomParams', 9, 'pending', util.VN_CURDATE()); + +INSERT INTO `util`.`notificationSubscription` (`notificationFk`, `userFk`) + VALUES + (1, 1110); \ No newline at end of file From 8048d4ce90d22d08ffa8e24bd8671f5497baee8d Mon Sep 17 00:00:00 2001 From: alexm Date: Mon, 25 Jul 2022 08:25:10 +0200 Subject: [PATCH 3/8] feat(notification): basic functionality and test --- back/methods/notification/clean.js | 46 ++++++++++++++ back/methods/notification/send.js | 63 ++++++++++++++++--- back/methods/notification/specs/clean.spec.js | 42 +++++++++++++ back/methods/notification/specs/send.spec.js | 33 ++++++++++ back/models/notification.js | 1 + back/models/notification.json | 10 ++- back/models/notificationQueue.json | 5 +- back/models/notificationSubscription.json | 14 ++++- .../10490-goldenSummer/00-aclNotification.sql | 2 +- db/dump/fixtures.sql | 4 +- 10 files changed, 205 insertions(+), 15 deletions(-) create mode 100644 back/methods/notification/specs/clean.spec.js create mode 100644 back/methods/notification/specs/send.spec.js diff --git a/back/methods/notification/clean.js b/back/methods/notification/clean.js index e69de29bb2..e6da58af8b 100644 --- a/back/methods/notification/clean.js +++ b/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; + } + }; +}; diff --git a/back/methods/notification/send.js b/back/methods/notification/send.js index d5149fc59b..b56d9d6c03 100644 --- a/back/methods/notification/send.js +++ b/back/methods/notification/send.js @@ -1,7 +1,9 @@ +const axios = require('axios'); + module.exports = Self => { Self.remoteMethod('send', { description: 'Send notifications from queue', - accessType: 'READ', + accessType: 'WRITE', returns: { type: 'object', root: true @@ -12,24 +14,69 @@ module.exports = Self => { } }); - Self.send = async() => { + Self.send = async options => { + // const headers = ctx.req.headers; + // const origin = headers.origin || 'http://' + headers.host; + // const auth = ctx.req.accessToken; + // console.log(origin); + + const models = Self.app.models; const status = 'pending'; const myOptions = {}; let tx; + if (typeof options == 'object') + Object.assign(myOptions, options); + if (!myOptions.transaction) { tx = await Self.beginTransaction({}); myOptions.transaction = tx; } - const notificationQueue = await Self.app.models.NotificationQueue.find({ - where: {code: status}, - include: [{ - relation: 'notificationSubscription' - }] + const notificationQueue = await models.NotificationQueue.find({ + where: {status: status}, + include: [ + { + relation: 'notification', + scope: { + include: { + relation: 'subscription', + scope: { + include: { + relation: 'user', + scope: { + fields: ['name'] + } + } + } + } + } + + } + ] }, myOptions); - console.log(notificationQueue); + const statusSent = 'sent'; + const statusError = 'error'; + for (const queue of notificationQueue) { + // console.log(queue); + // console.log(origin); + // console.log(auth); + // console.log(queue.notification().name); + // console.log(queue.params); + + // const queueParams = Object.assign({}, JSON.parse(queue.params)); + // queueParams.authorization = auth.id; + + try { + // await print axios.get(`print`, queueParams) + await queue.updateAttribute('status', statusSent); + } catch (error) { + await queue.updateAttribute('status', statusError); + } + } + + return notificationQueue; }; }; diff --git a/back/methods/notification/specs/clean.spec.js b/back/methods/notification/specs/clean.spec.js new file mode 100644 index 0000000000..c9441a98be --- /dev/null +++ b/back/methods/notification/specs/clean.spec.js @@ -0,0 +1,42 @@ +const models = require('vn-loopback/server/server').models; + +fdescribe('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); + }); +}); diff --git a/back/methods/notification/specs/send.spec.js b/back/methods/notification/specs/send.spec.js new file mode 100644 index 0000000000..ce03b4f3ff --- /dev/null +++ b/back/methods/notification/specs/send.spec.js @@ -0,0 +1,33 @@ +const models = require('vn-loopback/server/server').models; + +fdescribe('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(1); + expect(after.length).toEqual(0); + }); +}); diff --git a/back/models/notification.js b/back/models/notification.js index 46378bd027..65e82e3c7a 100644 --- a/back/models/notification.js +++ b/back/models/notification.js @@ -1,3 +1,4 @@ module.exports = Self => { require('../methods/notification/send')(Self); + require('../methods/notification/clean')(Self); }; diff --git a/back/models/notification.json b/back/models/notification.json index 9422d03b37..56f66bf1de 100644 --- a/back/models/notification.json +++ b/back/models/notification.json @@ -13,10 +13,18 @@ "description": "Identifier" }, "name": { - "type": "string" + "type": "string", + "required": true }, "description": { "type": "string" } + }, + "relations": { + "subscription": { + "type": "hasMany", + "model": "NotificationSubscription", + "foreignKey": "notificationFk" + } } } \ No newline at end of file diff --git a/back/models/notificationQueue.json b/back/models/notificationQueue.json index 122d3816d3..9790ea595c 100644 --- a/back/models/notificationQueue.json +++ b/back/models/notificationQueue.json @@ -26,11 +26,12 @@ "notification": { "type": "belongsTo", "model": "Notification", - "foreignKey": "notificationFk" + "foreignKey": "notificationFk", + "primaryKey": "name" }, "author": { "type": "belongsTo", - "model": "User", + "model": "Account", "foreignKey": "authorFk" } } diff --git a/back/models/notificationSubscription.json b/back/models/notificationSubscription.json index 14b305ca8c..43fa6db274 100644 --- a/back/models/notificationSubscription.json +++ b/back/models/notificationSubscription.json @@ -6,6 +6,18 @@ "table": "util.notificationSubscription" } }, + "properties": { + "notificationFk": { + "type": "number", + "id": true, + "description": "Identifier" + }, + "userFk": { + "type": "number", + "id": true, + "description": "Identifier" + } + }, "relations": { "notification": { "type": "belongsTo", @@ -14,7 +26,7 @@ }, "user": { "type": "belongsTo", - "model": "User", + "model": "Account", "foreignKey": "userFk" } } diff --git a/db/changes/10490-goldenSummer/00-aclNotification.sql b/db/changes/10490-goldenSummer/00-aclNotification.sql index aa4e32cee4..51d6b24714 100644 --- a/db/changes/10490-goldenSummer/00-aclNotification.sql +++ b/db/changes/10490-goldenSummer/00-aclNotification.sql @@ -1,3 +1,3 @@ INSERT INTO `salix`.`ACL` (`model`, `property`, `accessType`, `permission`, `principalType`, `principalId`) VALUES - ('Notification', '*', 'READ', 'ALLOW', 'ROLE', 'developer'); + ('Notification', '*', 'WRITE', 'ALLOW', 'ROLE', 'developer'); diff --git a/db/dump/fixtures.sql b/db/dump/fixtures.sql index f73210a960..7731755e40 100644 --- a/db/dump/fixtures.sql +++ b/db/dump/fixtures.sql @@ -2617,7 +2617,7 @@ INSERT INTO `util`.`notificationConfig` INSERT INTO `util`.`notification` (`id`, `name`, `description`) VALUES - (1, 'notification one', 'notification fixture one'); + (1, 'invoice', 'notification fixture one'); INSERT INTO `util`.`notificationAcl` (`notificationFk`, `roleFk`) VALUES @@ -2625,7 +2625,7 @@ INSERT INTO `util`.`notificationAcl` (`notificationFk`, `roleFk`) INSERT INTO `util`.`notificationQueue` (`id`, `notificationFk`, `params`, `authorFk`, `status`, `created`) VALUES - (1, 'notification one', 'randomParams', 9, 'pending', util.VN_CURDATE()); + (1, 'invoice', '{"invoiceId": 1}', 9, 'pending', util.VN_CURDATE()); INSERT INTO `util`.`notificationSubscription` (`notificationFk`, `userFk`) VALUES From 2b19688ca4a9e0d6bcb9cad1fb2e330a33877755 Mon Sep 17 00:00:00 2001 From: alexm Date: Mon, 25 Jul 2022 08:25:46 +0200 Subject: [PATCH 4/8] quit focus --- back/methods/notification/specs/clean.spec.js | 2 +- back/methods/notification/specs/send.spec.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/back/methods/notification/specs/clean.spec.js b/back/methods/notification/specs/clean.spec.js index c9441a98be..4c9dc563d0 100644 --- a/back/methods/notification/specs/clean.spec.js +++ b/back/methods/notification/specs/clean.spec.js @@ -1,6 +1,6 @@ const models = require('vn-loopback/server/server').models; -fdescribe('Notification Clean()', () => { +describe('Notification Clean()', () => { it('should delete old rows with error', async() => { const userId = 9; const status = 'error'; diff --git a/back/methods/notification/specs/send.spec.js b/back/methods/notification/specs/send.spec.js index ce03b4f3ff..015d1cb4d0 100644 --- a/back/methods/notification/specs/send.spec.js +++ b/back/methods/notification/specs/send.spec.js @@ -1,6 +1,6 @@ const models = require('vn-loopback/server/server').models; -fdescribe('Notification Send()', () => { +describe('Notification Send()', () => { it('should send notification', async() => { const statusPending = 'pending'; const tx = await models.NotificationQueue.beginTransaction({}); From 24cb8e00bbe7200a2d218162bcbb681a187b919b Mon Sep 17 00:00:00 2001 From: alexm Date: Tue, 11 Oct 2022 13:20:25 +0200 Subject: [PATCH 5/8] creates notification sql in changes --- .../10491-august/00-notificationProc.sql | 28 ++++++++ .../10491-august/00-notificationTables.sql | 63 +++++++++++++++++ db/changes/10491-august/delete.keep | 0 db/dump/structure.sql | 68 ------------------- 4 files changed, 91 insertions(+), 68 deletions(-) create mode 100644 db/changes/10491-august/00-notificationProc.sql create mode 100644 db/changes/10491-august/00-notificationTables.sql delete mode 100644 db/changes/10491-august/delete.keep diff --git a/db/changes/10491-august/00-notificationProc.sql b/db/changes/10491-august/00-notificationProc.sql new file mode 100644 index 0000000000..475b2e3892 --- /dev/null +++ b/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 ; diff --git a/db/changes/10491-august/00-notificationTables.sql b/db/changes/10491-august/00-notificationTables.sql new file mode 100644 index 0000000000..d5fcf00b20 --- /dev/null +++ b/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, -- FK notification.id + roleFk INT(10) unsigned, -- FK account.role.id + 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, -- FK notification.id + userFk INT(10) unsigned, -- FK account.user.id + 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), -- FK notification.name + params TEXT, -- JSON + authorFk INT(10) unsigned NULL, -- FK account.user.id + `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; diff --git a/db/changes/10491-august/delete.keep b/db/changes/10491-august/delete.keep deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/db/dump/structure.sql b/db/dump/structure.sql index 184c7490f3..402c8e695b 100644 --- a/db/dump/structure.sql +++ b/db/dump/structure.sql @@ -20369,74 +20369,6 @@ CREATE DATABASE /*!32312 IF NOT EXISTS*/ `util` /*!40100 DEFAULT CHARACTER SET u USE `util`; -CREATE TABLE notification( - id INT PRIMARY KEY, - `name` VARCHAR(255) UNIQUE, - `description` VARCHAR(255) -); - -CREATE TABLE notificationAcl ( - notificationFk INT(11), - roleFk INT(10) unsigned, - PRIMARY KEY(notificationFk, roleFk), - CONSTRAINT `notificationAcl_ibfk_1` FOREIGN KEY (`notificationFk`) REFERENCES `notification` (`id`) ON DELETE CASCADE ON UPDATE CASCADE, - CONSTRAINT `notificationAcl_ibfk_2` FOREIGN KEY (`roleFk`) REFERENCES `account`.`role` (`id`) ON DELETE CASCADE ON UPDATE CASCADE -); - -CREATE TABLE notificationSubscription( - notificationFk INT, - userFk INT(10) unsigned, - PRIMARY KEY(notificationFk, userFk), - CONSTRAINT `notificationSubscription_ibfk_1` FOREIGN KEY (`notificationFk`) REFERENCES `notification` (`id`) ON DELETE CASCADE ON UPDATE CASCADE, - 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 TEXT, - 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), - CONSTRAINT `notificationQueue_ibfk_1` FOREIGN KEY (`notificationFk`) REFERENCES `notification` (`name`) ON DELETE CASCADE ON UPDATE CASCADE, - 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 -); - -DROP FUNCTION IF EXISTS util.notification_send; -DELIMITER $$ -CREATE FUNCTION util.notification_send(vNotificationName VARCHAR(255), vParams TEXT, vAuthorFk INT) - RETURNS INT -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 ; -- -- Table structure for table `binlogQueue` -- From c637f2c8798989b1684ec16f79d33d7e654ea791 Mon Sep 17 00:00:00 2001 From: alexm Date: Fri, 14 Oct 2022 13:22:53 +0200 Subject: [PATCH 6/8] feat(send): use vn-print libary and adapt test --- back/methods/notification/send.js | 59 ++++++++++--------- back/methods/notification/specs/send.spec.js | 2 +- .../10491-august/00-notificationTables.sql | 14 ++--- db/dump/fixtures.sql | 8 ++- 4 files changed, 44 insertions(+), 39 deletions(-) diff --git a/back/methods/notification/send.js b/back/methods/notification/send.js index b56d9d6c03..5ae7e748b2 100644 --- a/back/methods/notification/send.js +++ b/back/methods/notification/send.js @@ -1,4 +1,5 @@ -const axios = require('axios'); +const {Email} = require('vn-print'); +const UserError = require('vn-loopback/util/user-error'); module.exports = Self => { Self.remoteMethod('send', { @@ -15,27 +16,18 @@ module.exports = Self => { }); Self.send = async options => { - // const headers = ctx.req.headers; - // const origin = headers.origin || 'http://' + headers.host; - // const auth = ctx.req.accessToken; - // console.log(origin); + if (process.env.NODE_ENV == 'test') + throw new UserError(`Action not allowed on the test environment`); const models = Self.app.models; - const status = 'pending'; + const findStatus = 'pending'; const myOptions = {}; - let tx; - if (typeof options == 'object') Object.assign(myOptions, options); - if (!myOptions.transaction) { - tx = await Self.beginTransaction({}); - myOptions.transaction = tx; - } - const notificationQueue = await models.NotificationQueue.find({ - where: {status: status}, + where: {status: findStatus}, include: [ { relation: 'notification', @@ -46,7 +38,7 @@ module.exports = Self => { include: { relation: 'user', scope: { - fields: ['name'] + fields: ['name', 'email', 'lang'] } } } @@ -59,24 +51,33 @@ module.exports = Self => { const statusSent = 'sent'; const statusError = 'error'; + for (const queue of notificationQueue) { - // console.log(queue); - // console.log(origin); - // console.log(auth); - // console.log(queue.notification().name); - // console.log(queue.params); + const queueName = queue.notification().name; + const queueParams = JSON.parse(queue.params); - // const queueParams = Object.assign({}, JSON.parse(queue.params)); - // queueParams.authorization = auth.id; + for (const notificationUser of queue.notification().subscription()) { + try { + const sendParams = { + recipient: notificationUser.user().email, + lang: notificationUser.user().lang + }; - try { - // await print axios.get(`print`, queueParams) - await queue.updateAttribute('status', statusSent); - } catch (error) { - await queue.updateAttribute('status', statusError); + if (notificationUser.userFk == queue.authorFk) { + await queue.updateAttribute('status', statusSent); + continue; + } + + const newParams = Object.assign({}, queueParams, sendParams); + const email = new Email(queueName, newParams); + + await email.send(); + + await queue.updateAttribute('status', statusSent); + } catch (error) { + await queue.updateAttribute('status', statusError); + } } } - - return notificationQueue; }; }; diff --git a/back/methods/notification/specs/send.spec.js b/back/methods/notification/specs/send.spec.js index 015d1cb4d0..f0b186e065 100644 --- a/back/methods/notification/specs/send.spec.js +++ b/back/methods/notification/specs/send.spec.js @@ -27,7 +27,7 @@ describe('Notification Send()', () => { throw e; } - expect(before.length).toEqual(1); + expect(before.length).toEqual(3); expect(after.length).toEqual(0); }); }); diff --git a/db/changes/10491-august/00-notificationTables.sql b/db/changes/10491-august/00-notificationTables.sql index d5fcf00b20..2db7d9874c 100644 --- a/db/changes/10491-august/00-notificationTables.sql +++ b/db/changes/10491-august/00-notificationTables.sql @@ -7,8 +7,8 @@ CREATE TABLE notification( ); CREATE TABLE notificationAcl( - notificationFk INT, -- FK notification.id - roleFk INT(10) unsigned, -- FK account.role.id + notificationFk INT, + roleFk INT(10) unsigned, PRIMARY KEY(notificationFk, roleFk) ); @@ -21,8 +21,8 @@ ALTER TABLE `util`.`notificationAcl` ADD CONSTRAINT `notificationAcl_ibfk_2` FOR ON UPDATE CASCADE; CREATE TABLE notificationSubscription( - notificationFk INT, -- FK notification.id - userFk INT(10) unsigned, -- FK account.user.id + notificationFk INT, + userFk INT(10) unsigned, PRIMARY KEY(notificationFk, userFk) ); @@ -36,9 +36,9 @@ ALTER TABLE `util`.`notificationSubscription` ADD CONSTRAINT `notificationSubscr CREATE TABLE notificationQueue( id INT PRIMARY KEY AUTO_INCREMENT, - notificationFk VARCHAR(255), -- FK notification.name - params TEXT, -- JSON - authorFk INT(10) unsigned NULL, -- FK account.user.id + 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), diff --git a/db/dump/fixtures.sql b/db/dump/fixtures.sql index cd2a1c6dd4..9d873f2c6a 100644 --- a/db/dump/fixtures.sql +++ b/db/dump/fixtures.sql @@ -2653,7 +2653,7 @@ INSERT INTO `util`.`notificationConfig` INSERT INTO `util`.`notification` (`id`, `name`, `description`) VALUES - (1, 'invoice', 'notification fixture one'); + (1, 'print-email', 'notification fixture one'); INSERT INTO `util`.`notificationAcl` (`notificationFk`, `roleFk`) VALUES @@ -2661,11 +2661,15 @@ INSERT INTO `util`.`notificationAcl` (`notificationFk`, `roleFk`) INSERT INTO `util`.`notificationQueue` (`id`, `notificationFk`, `params`, `authorFk`, `status`, `created`) VALUES - (1, 'invoice', '{"invoiceId": 1}', 9, 'pending', util.VN_CURDATE()); + (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); From aef47d46b1ef8c1259c20347b8dd59479ea21309 Mon Sep 17 00:00:00 2001 From: alexm Date: Mon, 17 Oct 2022 12:12:10 +0200 Subject: [PATCH 7/8] env test --- back/methods/notification/send.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/back/methods/notification/send.js b/back/methods/notification/send.js index 5ae7e748b2..15baf0175a 100644 --- a/back/methods/notification/send.js +++ b/back/methods/notification/send.js @@ -71,7 +71,8 @@ module.exports = Self => { const newParams = Object.assign({}, queueParams, sendParams); const email = new Email(queueName, newParams); - await email.send(); + if (process.env.NODE_ENV != 'test') + await email.send(); await queue.updateAttribute('status', statusSent); } catch (error) { From c24b975f267d33c1f054f48b307781610d33c028 Mon Sep 17 00:00:00 2001 From: alexm Date: Mon, 17 Oct 2022 12:14:11 +0200 Subject: [PATCH 8/8] remove node_env --- back/methods/notification/send.js | 3 --- 1 file changed, 3 deletions(-) diff --git a/back/methods/notification/send.js b/back/methods/notification/send.js index 15baf0175a..80faf0305b 100644 --- a/back/methods/notification/send.js +++ b/back/methods/notification/send.js @@ -16,9 +16,6 @@ module.exports = Self => { }); Self.send = async options => { - if (process.env.NODE_ENV == 'test') - throw new UserError(`Action not allowed on the test environment`); - const models = Self.app.models; const findStatus = 'pending';