fix: move webhook form validation to webhook-store

This commit is contained in:
Jamie Howard 2023-05-25 13:07:06 +01:00
parent 14ff035647
commit aac731d7a0
2 changed files with 40 additions and 40 deletions

View File

@ -1,38 +1,5 @@
'use strict';
const _ = require('lodash');
const { yup, validateYupSchema } = require('@strapi/utils');
const urlRegex =
/^(?:([a-z0-9+.-]+):\/\/)(?:\S+(?::\S*)?@)?(?:(?:[1-9]\d?|1\d\d|2[01]\d|22[0-3])(?:\.(?:1?\d{1,2}|2[0-4]\d|25[0-5])){2}(?:\.(?:[1-9]\d?|1\d\d|2[0-4]\d|25[0-4]))|(?:(?:[a-z\u00a1-\uffff0-9_]-*)*[a-z\u00a1-\uffff0-9_]+)(?:\.(?:[a-z\u00a1-\uffff0-9_]-*)*[a-z\u00a1-\uffff0-9_]+)*\.?)(?::\d{2,5})?(?:[/?#]\S*)?$/;
const webhookValidator = yup
.object({
name: yup.string().required(),
url: yup.string().matches(urlRegex, 'url must be a valid URL').required(),
headers: yup.lazy((data) => {
if (typeof data !== 'object') {
return yup.object().required();
}
return yup
.object(
_.mapValues(data, () => {
yup.string().min(1).required();
})
)
.required();
}),
events: yup
.array()
.of(yup.string().oneOf(Array.from(strapi.webhookStore.allowedEvents.values())).required()),
})
.noUnknown();
const updateWebhookValidator = webhookValidator.shape({
isEnabled: yup.boolean(),
});
module.exports = {
async listWebhooks(ctx) {
const webhooks = await strapi.webhookStore.findWebhooks();
@ -53,8 +20,6 @@ module.exports = {
async createWebhook(ctx) {
const { body } = ctx.request;
await validateYupSchema(webhookValidator)(body);
const webhook = await strapi.webhookStore.createWebhook(body);
strapi.webhookRunner.add(webhook);
@ -66,8 +31,6 @@ module.exports = {
const { id } = ctx.params;
const { body } = ctx.request;
await validateYupSchema(updateWebhookValidator)(body);
const webhook = await strapi.webhookStore.findWebhook(id);
if (!webhook) {
@ -113,6 +76,7 @@ module.exports = {
for (const id of ids) {
const webhook = await strapi.webhookStore.findWebhook(id);
// eslint-disable-next-line no-continue
if (!webhook) continue;
await strapi.webhookStore.deleteWebhook(id);

View File

@ -4,6 +4,9 @@
'use strict';
const { mapValues } = require('lodash/fp');
const { yup, validateYupSchema } = require('@strapi/utils');
const webhookModel = {
uid: 'webhook',
collectionName: 'strapi_webhooks',
@ -47,6 +50,37 @@ const fromDBObject = (row) => {
};
};
const urlRegex =
/^(?:([a-z0-9+.-]+):\/\/)(?:\S+(?::\S*)?@)?(?:(?:[1-9]\d?|1\d\d|2[01]\d|22[0-3])(?:\.(?:1?\d{1,2}|2[0-4]\d|25[0-5])){2}(?:\.(?:[1-9]\d?|1\d\d|2[0-4]\d|25[0-4]))|(?:(?:[a-z\u00a1-\uffff0-9_]-*)*[a-z\u00a1-\uffff0-9_]+)(?:\.(?:[a-z\u00a1-\uffff0-9_]-*)*[a-z\u00a1-\uffff0-9_]+)*\.?)(?::\d{2,5})?(?:[/?#]\S*)?$/;
const webhookValidator = (allowedEvents) =>
yup
.object({
name: yup.string().required(),
url: yup.string().matches(urlRegex, 'url must be a valid URL').required(),
headers: yup.lazy((data) => {
if (typeof data !== 'object') {
return yup.object().required();
}
return yup
.object(
mapValues(() => {
yup.string().min(1).required();
}, data)
)
.required();
}),
events: yup.array().of(yup.string().oneOf(Array.from(allowedEvents.values())).required()),
})
.noUnknown();
const updateWebhookValidator = (allowedEvents) =>
webhookValidator(allowedEvents).shape({
id: yup.number().required(),
isEnabled: yup.boolean().required(),
});
const createWebhookStore = ({ db }) => {
const webhookQueries = db.query('webhook');
@ -71,8 +105,9 @@ const createWebhookStore = ({ db }) => {
return result ? fromDBObject(result) : null;
},
createWebhook(data) {
// TODO: Validate webhook event
async createWebhook(data) {
await validateYupSchema(webhookValidator(allowedEvents))(data);
return webhookQueries
.create({
data: toDBObject({ ...data, isEnabled: true }),
@ -81,7 +116,8 @@ const createWebhookStore = ({ db }) => {
},
async updateWebhook(id, data) {
// TODO: Validate webhook event
await validateYupSchema(updateWebhookValidator(allowedEvents))(data);
const webhook = await webhookQueries.update({
where: { id },
data: toDBObject(data),