mirror of
https://github.com/plankanban/planka.git
synced 2025-07-19 05:09:43 +02:00
138 lines
3.6 KiB
JavaScript
138 lines
3.6 KiB
JavaScript
/*!
|
|
* Copyright (c) 2024 PLANKA Software GmbH
|
|
* Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
|
|
*/
|
|
|
|
const Webhook = require('../../models/Webhook');
|
|
|
|
/**
|
|
* @typedef {Object} Included
|
|
* @property {any[]} [users] - Array of users (optional).
|
|
* @property {any[]} [projects] - Array of projects (optional).
|
|
* @property {any[]} [baseCustomFieldGroups] - Array of base custom field groups (optional).
|
|
* @property {any[]} [boards] - Array of boards (optional).
|
|
* @property {any[]} [boardMemberships] - Array of board memberships (optional).
|
|
* @property {any[]} [labels] - Array of labels (optional).
|
|
* @property {any[]} [lists] - Array of lists (optional).
|
|
* @property {any[]} [cards] - Array of cards (optional).
|
|
* @property {any[]} [cardMemberships] - Array of card memberships (optional).
|
|
* @property {any[]} [taskLists] - Array of task lists (optional).
|
|
* @property {any[]} [customFieldGroups] - Array of custom field groups (optional).
|
|
* @property {any[]} [customFields] - Array of custom fields (optional).
|
|
* @property {any[]} [comments] - Array of comments (optional).
|
|
* @property {any[]} [actions] - Array of actions (optional).
|
|
*/
|
|
|
|
/**
|
|
* @typedef {Object} Data
|
|
* @property {any} item - Actual event data.
|
|
* @property {Included} [included] - Optional included data.
|
|
*/
|
|
|
|
/**
|
|
* Sends a webhook notification to a configured URL.
|
|
*
|
|
* @param {*} webhook - Webhook configuration.
|
|
* @param {string} event - The event.
|
|
* @param {Data} data - The data object containing event data and optionally included data.
|
|
* @param {Data} [prevData] - The data object containing previous state of data (optional).
|
|
* @param {ref} user - User object associated with the event.
|
|
* @returns {Promise<void>}
|
|
*/
|
|
async function sendWebhook(webhook, event, data, prevData, user) {
|
|
const headers = {
|
|
'Content-Type': 'application/json',
|
|
'User-Agent': `planka (+${sails.config.custom.baseUrl})`,
|
|
};
|
|
|
|
if (webhook.accessToken) {
|
|
headers.Authorization = `Bearer ${webhook.accessToken}`;
|
|
}
|
|
|
|
const body = JSON.stringify({
|
|
event,
|
|
data,
|
|
prevData,
|
|
user,
|
|
});
|
|
|
|
try {
|
|
const response = await fetch(webhook.url, {
|
|
headers,
|
|
body,
|
|
method: 'POST',
|
|
});
|
|
|
|
if (!response.ok) {
|
|
const message = await response.text();
|
|
|
|
sails.log.error(
|
|
`Webhook ${webhook.name} failed with status ${response.status} and message: ${message}`,
|
|
);
|
|
}
|
|
} catch (error) {
|
|
sails.log.error(`Webhook ${webhook.name} failed with error: ${error}`);
|
|
}
|
|
}
|
|
|
|
module.exports = {
|
|
sync: true,
|
|
|
|
inputs: {
|
|
webhooks: {
|
|
type: 'ref',
|
|
required: true,
|
|
},
|
|
event: {
|
|
type: 'string',
|
|
required: true,
|
|
isIn: Object.values(Webhook.Events),
|
|
},
|
|
buildData: {
|
|
type: 'ref',
|
|
required: true,
|
|
},
|
|
buildPrevData: {
|
|
type: 'ref',
|
|
},
|
|
user: {
|
|
type: 'ref',
|
|
required: true,
|
|
},
|
|
},
|
|
|
|
fn(inputs) {
|
|
const webhooks = inputs.webhooks.filter((webhook) => {
|
|
if (!webhook.url) {
|
|
return false;
|
|
}
|
|
|
|
if (webhook.excludedEvents && webhook.excludedEvents.includes(inputs.event)) {
|
|
return false;
|
|
}
|
|
|
|
if (webhook.events && !webhook.events.includes(inputs.event)) {
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
});
|
|
|
|
if (webhooks.length === 0) {
|
|
return;
|
|
}
|
|
|
|
const data = inputs.buildData();
|
|
const prevData = inputs.buildPrevData && inputs.buildPrevData();
|
|
|
|
webhooks.forEach((webhook) => {
|
|
sendWebhook(
|
|
webhook,
|
|
inputs.event,
|
|
data,
|
|
prevData,
|
|
sails.helpers.users.presentOne(inputs.user),
|
|
);
|
|
});
|
|
},
|
|
};
|