1
0
Fork 0
mirror of https://github.com/plankanban/planka.git synced 2025-08-10 07:55:27 +02:00

fix: Cleanup and refactoring

This commit is contained in:
Maksim Eltyshev 2024-03-22 00:11:24 +01:00
parent 80499e68d5
commit 44eb6f9c1f
12 changed files with 165 additions and 69 deletions

View file

@ -31,6 +31,14 @@ services:
# - DEFAULT_ADMIN_NAME=Demo Demo
# - DEFAULT_ADMIN_USERNAME=demo
# Email Notifications (https://nodemailer.com/smtp/)
# - SMTP_HOST=
# - SMTP_PORT=587
# - SMTP_SECURE=true
# - SMTP_USER=
# - SMTP_PASSWORD=
# - SMTP_FROM="Demo Demo" <demo@demo.demo>
# - OIDC_ISSUER=
# - OIDC_CLIENT_ID=
# - OIDC_CLIENT_SECRET=

View file

@ -31,6 +31,14 @@ services:
# - DEFAULT_ADMIN_NAME=Demo Demo
# - DEFAULT_ADMIN_USERNAME=demo
# Email Notifications (https://nodemailer.com/smtp/)
# - SMTP_HOST=
# - SMTP_PORT=587
# - SMTP_SECURE=true
# - SMTP_USER=
# - SMTP_PASSWORD=
# - SMTP_FROM="Demo Demo" <demo@demo.demo>
# - OIDC_ISSUER=
# - OIDC_CLIENT_ID=
# - OIDC_CLIENT_SECRET=

View file

@ -22,6 +22,14 @@ SECRET_KEY=notsecretkey
# DEFAULT_ADMIN_NAME=Demo Demo
# DEFAULT_ADMIN_USERNAME=demo
# Email Notifications (https://nodemailer.com/smtp/)
# SMTP_HOST=
# SMTP_PORT=587
# SMTP_SECURE=true
# SMTP_USER=
# SMTP_PASSWORD=
# SMTP_FROM="Demo Demo" <demo@demo.demo>
# OIDC_ISSUER=
# OIDC_CLIENT_ID=
# OIDC_CLIENT_SECRET=
@ -35,14 +43,6 @@ SECRET_KEY=notsecretkey
# OIDC_IGNORE_ROLES=true
# OIDC_ENFORCED=true
# Email Notifications (https://nodemailer.com/smtp/)
SMTP_HOST=
SMTP_USER=
SMTP_PASSWORD=
SMTP_PORT=587
SMTP_SECURE=
SMTP_FROM="Demo Demo" <demo@demo.demo>
## Do not edit this
TZ=UTC

View file

@ -78,12 +78,12 @@ module.exports = {
async fn(inputs) {
const { currentUser } = this.req;
const { list } = await sails.helpers.lists
const { board, list } = await sails.helpers.lists
.getProjectPath(inputs.listId)
.intercept('pathNotFound', () => Errors.LIST_NOT_FOUND);
const boardMembership = await BoardMembership.findOne({
boardId: list.boardId,
boardId: board.id,
userId: currentUser.id,
});
@ -99,6 +99,7 @@ module.exports = {
const card = await sails.helpers.cards.createOne
.with({
board,
values: {
...values,
list,

View file

@ -32,12 +32,12 @@ module.exports = {
async fn(inputs) {
const { currentUser } = this.req;
const { card } = await sails.helpers.cards
const { board, card } = await sails.helpers.cards
.getProjectPath(inputs.cardId)
.intercept('pathNotFound', () => Errors.CARD_NOT_FOUND);
const boardMembership = await BoardMembership.findOne({
boardId: card.boardId,
boardId: board.id,
userId: currentUser.id,
});
@ -55,6 +55,7 @@ module.exports = {
};
const action = await sails.helpers.actions.createOne.with({
board,
values: {
...values,
card,

View file

@ -21,6 +21,10 @@ module.exports = {
custom: valuesValidator,
required: true,
},
board: {
type: 'ref',
required: true,
},
request: {
type: 'ref',
},
@ -56,6 +60,9 @@ module.exports = {
userId,
action,
},
user: values.user,
board: inputs.board,
card: values.card,
}),
),
);

View file

@ -25,6 +25,10 @@ module.exports = {
custom: valuesValidator,
required: true,
},
board: {
type: 'ref',
required: true,
},
request: {
type: 'ref',
},
@ -104,6 +108,7 @@ module.exports = {
},
user: values.creatorUser,
},
board: inputs.board,
});
return card;

View file

@ -232,6 +232,7 @@ module.exports = {
toList: _.pick(values.list, ['id', 'name']),
},
},
board: inputs.board,
});
}

View file

@ -1,18 +1,3 @@
const nodemailer = require('nodemailer');
const emailTransporter =
process.env.SMTP_HOST &&
nodemailer.createTransport({
pool: true,
host: process.env.SMTP_HOST,
port: process.env.SMTP_PORT,
secure: process.env.SMTP_SECURE === 'true',
auth: {
user: process.env.SMTP_USER,
pass: process.env.SMTP_PASSWORD,
},
});
const valuesValidator = (value) => {
if (!_.isPlainObject(value)) {
return false;
@ -29,51 +14,39 @@ const valuesValidator = (value) => {
return true;
};
async function sendEmailNotification({ notification, action }) {
const actionUser = await sails.helpers.users.getOne(action.userId);
const actionCard = await Card.findOne(action.cardId);
const notificationUser = await sails.helpers.users.getOne(notification.userId);
const actionBoard = await Board.findOne(actionCard.boardId);
let email;
// TODO: use templates (views) to build html
const buildAndSendEmail = async (user, board, card, action, notifiableUser) => {
let emailData;
switch (action.type) {
case Action.Types.COMMENT_CARD:
email = {
subject: `${actionUser.name} commented the card ${actionCard.name} on ${actionBoard.name}`,
case Action.Types.MOVE_CARD:
emailData = {
subject: `${user.name} moved ${card.name} from ${action.data.fromList.name} to ${action.data.toList.name} on ${board.name}`,
html:
`<p>${actionUser.name} commented the card ` +
`<a href="${process.env.BASE_URL}/cards/${actionCard.id}">${actionCard.name}</a> ` +
`on <a href="${process.env.BASE_URL}/boards/${actionBoard.id}">${actionBoard.name}</a></p>` +
`<p>${user.name} moved ` +
`<a href="${process.env.BASE_URL}/cards/${card.id}">${card.name}</a> ` +
`from ${action.data.fromList.name} to ${action.data.toList.name} ` +
`on <a href="${process.env.BASE_URL}/boards/${board.id}">${board.name}</a></p>`,
};
break;
case Action.Types.COMMENT_CARD:
emailData = {
subject: `${user.name} left a new comment to ${card.name} on ${board.name}`,
html:
`<p>${user.name} left a new comment to ` +
`<a href="${process.env.BASE_URL}/cards/${card.id}">${card.name}</a> ` +
`on <a href="${process.env.BASE_URL}/boards/${board.id}">${board.name}</a></p>` +
`<p>${action.data.text}</p>`,
};
break;
case Action.Types.MOVE_CARD:
email = {
subject: `${actionUser.name} moved the card ${actionCard.name} from ${action.data.fromList.name} to ${action.data.toList.name} on ${actionBoard.name}`,
html:
`<p>${actionUser.name} moved the card ` +
`<a href="${process.env.BASE_URL}/cards/${actionCard.id}">${actionCard.name}</a> ` +
`from ${action.data.fromList.name} to ${action.data.toList.name} ` +
`on <a href="${process.env.BASE_URL}/boards/${actionBoard.id}">${actionBoard.name}</a></p>`,
};
break;
default:
break;
return;
}
if (!email) {
return;
}
emailTransporter.sendMail(
{ from: process.env.SMTP_FROM, to: notificationUser.email, ...email },
(error, info) => {
if (error) {
sails.log.error(error);
} else {
sails.log.info('Email sent: %s', info.messageId);
}
},
);
}
await sails.helpers.utils.sendEmail.with({
...emailData,
to: notifiableUser.email,
});
};
module.exports = {
inputs: {
@ -82,6 +55,18 @@ module.exports = {
custom: valuesValidator,
required: true,
},
user: {
type: 'ref',
required: true,
},
board: {
type: 'ref',
required: true,
},
card: {
type: 'ref',
required: true,
},
},
async fn(inputs) {
@ -97,14 +82,21 @@ module.exports = {
cardId: values.action.cardId,
}).fetch();
if (emailTransporter) {
sendEmailNotification({ notification, action: values.action });
}
sails.sockets.broadcast(`user:${notification.userId}`, 'notificationCreate', {
item: notification,
});
if (sails.hooks.smtp.isActive()) {
let notifiableUser;
if (values.user) {
notifiableUser = values.user;
} else {
notifiableUser = await sails.helpers.users.getOne(notification.userId);
}
buildAndSendEmail(inputs.user, inputs.board, inputs.card, values.action, notifiableUser);
}
return notification;
},
};

View file

@ -0,0 +1,31 @@
module.exports = {
inputs: {
to: {
type: 'string',
required: true,
},
subject: {
type: 'string',
required: true,
},
html: {
type: 'string',
required: true,
},
},
async fn(inputs) {
const transporter = sails.hooks.smtp.getTransporter(); // TODO: check if active?
try {
const info = await transporter.sendMail({
...inputs,
from: sails.config.custom.smtpFrom,
});
sails.log.info('Email sent: %s', info.messageId);
} catch (error) {
sails.log.error(error);
}
},
};

View file

@ -0,0 +1,35 @@
const nodemailer = require('nodemailer');
module.exports = function smtpServiceHook(sails) {
let transporter = null;
return {
/**
* Runs when this Sails app loads/lifts.
*/
async initialize() {
if (sails.config.custom.smtpHost) {
transporter = nodemailer.createTransport({
pool: true,
host: sails.config.custom.smtpHost,
port: sails.config.custom.smtpPort,
secure: sails.config.custom.smtpSecure,
auth: sails.config.custom.smtpUser && {
user: sails.config.custom.smtpUser,
pass: sails.config.custom.smtpPassword,
},
});
sails.log.info('SMTP hook has been loaded successfully');
}
},
getTransporter() {
return transporter;
},
isActive() {
return transporter !== null;
},
};
};

View file

@ -34,6 +34,13 @@ module.exports.custom = {
defaultAdminEmail:
process.env.DEFAULT_ADMIN_EMAIL && process.env.DEFAULT_ADMIN_EMAIL.toLowerCase(),
smtpHost: process.env.SMTP_HOST,
smtpPort: process.env.SMTP_PORT || 587,
smtpSecure: process.env.SMTP_SECURE === 'true',
smtpUser: process.env.SMTP_USER,
smtpPassword: process.env.SMTP_PASSWORD,
smtpFrom: process.env.SMTP_FROM,
oidcIssuer: process.env.OIDC_ISSUER,
oidcClientId: process.env.OIDC_CLIENT_ID,
oidcClientSecret: process.env.OIDC_CLIENT_SECRET,