yv01p/Umbraco-CMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

New WebhookEventBase class (#15129)

Browse Source
This commit is contained in:
Kevin Jump
2023-11-03 13:30:13 +00:00
committed by GitHub
parent b11e13f8cd
commit 145107be45
7 changed files with 105 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/Umbraco.Core/Webhooks/Events/ContentDeleteWebhookEvent.cs
View File

@@ -7,7 +7,7 @@ using Umbraco.Cms.Core.Sync;
namespace Umbraco.Cms.Core.Webhooks.Events;
public class ContentDeleteWebhookEvent : WebhookEventBase<ContentDeletedNotification, IContent>
public class ContentDeleteWebhookEvent : WebhookEventContentBase<ContentDeletedNotification, IContent>
{
public ContentDeleteWebhookEvent(
IWebhookFiringService webhookFiringService,

2
src/Umbraco.Core/Webhooks/Events/ContentPublishWebhookEvent.cs
View File

@@ -10,7 +10,7 @@ using Umbraco.Cms.Core.Sync;
namespace Umbraco.Cms.Core.Webhooks.Events;
public class ContentPublishWebhookEvent : WebhookEventBase<ContentPublishedNotification, IContent>
public class ContentPublishWebhookEvent : WebhookEventContentBase<ContentPublishedNotification, IContent>
{
private readonly IPublishedSnapshotAccessor _publishedSnapshotAccessor;
private readonly IApiContentBuilder _apiContentBuilder;

2
src/Umbraco.Core/Webhooks/Events/ContentUnpublishWebhookEvent.cs
View File

@@ -7,7 +7,7 @@ using Umbraco.Cms.Core.Sync;
namespace Umbraco.Cms.Core.Webhooks.Events;
public class ContentUnpublishWebhookEvent : WebhookEventBase<ContentUnpublishedNotification, IContent>
public class ContentUnpublishWebhookEvent : WebhookEventContentBase<ContentUnpublishedNotification, IContent>
{
public ContentUnpublishWebhookEvent(
IWebhookFiringService webhookFiringService,

2
src/Umbraco.Core/Webhooks/Events/MediaDeleteWebhookEvent.cs
View File

@@ -7,7 +7,7 @@ using Umbraco.Cms.Core.Sync;
namespace Umbraco.Cms.Core.Webhooks.Events;
public class MediaDeleteWebhookEvent : WebhookEventBase<MediaDeletedNotification, IMedia>
public class MediaDeleteWebhookEvent : WebhookEventContentBase<MediaDeletedNotification, IMedia>
{
public MediaDeleteWebhookEvent(
IWebhookFiringService webhookFiringService,

2
src/Umbraco.Core/Webhooks/Events/MediaSaveWebhookEvent.cs
View File

@@ -10,7 +10,7 @@ using Umbraco.Cms.Core.Sync;
namespace Umbraco.Cms.Core.Webhooks.Events;
public class MediaSaveWebhookEvent : WebhookEventBase<MediaSavedNotification, IMedia>
public class MediaSaveWebhookEvent : WebhookEventContentBase<MediaSavedNotification, IMedia>
{
private readonly IPublishedSnapshotAccessor _publishedSnapshotAccessor;
private readonly IApiMediaBuilder _apiMediaBuilder;

89
src/Umbraco.Core/Webhooks/WebhookEventBase.cs
View File

@@ -1,4 +1,5 @@
using Microsoft.Extensions.Options;
using Microsoft.Extensions.Options;
using Umbraco.Cms.Core.Configuration.Models;
using Umbraco.Cms.Core.Events;
using Umbraco.Cms.Core.Models;
@@ -8,14 +9,17 @@ using Umbraco.Cms.Core.Sync;
namespace Umbraco.Cms.Core.Webhooks;
public abstract class WebhookEventBase<TNotification, TEntity> : IWebhookEvent, INotificationAsyncHandler<TNotification>
public abstract class WebhookEventBase<TNotification> : IWebhookEvent, INotificationAsyncHandler<TNotification>
where TNotification : INotification
where TEntity : IContentBase
{
private readonly IWebhookFiringService _webhookFiringService;
private readonly IWebHookService _webHookService;
private readonly IServerRoleAccessor _serverRoleAccessor;
private WebhookSettings _webhookSettings;
/// <InheritDoc />
public string EventName { get; set; }
protected IWebhookFiringService WebhookFiringService { get; }
protected IWebHookService WebHookService { get; }
protected WebhookSettings WebhookSettings { get; private set; }
protected WebhookEventBase(
IWebhookFiringService webhookFiringService,
@@ -24,50 +28,59 @@ public abstract class WebhookEventBase<TNotification, TEntity> : IWebhookEvent,
IServerRoleAccessor serverRoleAccessor,
string eventName)
{
_webhookFiringService = webhookFiringService;
_webHookService = webHookService;
_serverRoleAccessor = serverRoleAccessor;
EventName = eventName;
_webhookSettings = webhookSettings.CurrentValue;
webhookSettings.OnChange(x => _webhookSettings = x);
WebhookFiringService = webhookFiringService;
WebHookService = webHookService;
_serverRoleAccessor = serverRoleAccessor;
WebhookSettings = webhookSettings.CurrentValue;
webhookSettings.OnChange(x => WebhookSettings = x);
}
public string EventName { get; set; }
public virtual async Task HandleAsync(TNotification notification, CancellationToken cancellationToken)
/// <summary>
/// Process the webhooks for the given notification.
/// </summary>
public virtual async Task ProcessWebhooks(TNotification notification, IEnumerable<Webhook> webhooks, CancellationToken cancellationToken)
{
if (_serverRoleAccessor.CurrentServerRole is not ServerRole.Single && _serverRoleAccessor.CurrentServerRole is not ServerRole.SchedulingPublisher)
{
return;
}
if (_webhookSettings.Enabled is false)
{
return;
}
IEnumerable<Webhook> webhooks = await _webHookService.GetByEventNameAsync(EventName);
foreach (Webhook webhook in webhooks)
{
if (!webhook.Enabled)
if (webhook.Enabled is false)
{
continue;
}
foreach (TEntity entity in GetEntitiesFromNotification(notification))
{
if (webhook.ContentTypeKeys.Any() && !webhook.ContentTypeKeys.Contains(entity.ContentType.Key))
{
continue;
}
await _webhookFiringService.FireAsync(webhook, EventName, ConvertEntityToRequestPayload(entity), cancellationToken);
}
await WebhookFiringService.FireAsync(webhook, EventName, notification, cancellationToken);
}
}
protected abstract IEnumerable<TEntity> GetEntitiesFromNotification(TNotification notification);
/// <summary>
/// should webhooks fire for this notification.
/// </summary>
/// <returns>true if webhooks should be fired.</returns>
public virtual bool ShouldFireWebhookForNotification(TNotification notificationObject)
=> true;
protected abstract object? ConvertEntityToRequestPayload(TEntity entity);
public async Task HandleAsync(TNotification notification, CancellationToken cancellationToken)
{
if (WebhookSettings.Enabled is false)
{
return;
}
if (_serverRoleAccessor.CurrentServerRole is not ServerRole.Single
&& _serverRoleAccessor.CurrentServerRole is not ServerRole.SchedulingPublisher)
{
return;
}
if (ShouldFireWebhookForNotification(notification) is false)
{
return;
}
IEnumerable<Webhook> webhooks = await WebHookService.GetByEventNameAsync(EventName);
await ProcessWebhooks(notification, webhooks, cancellationToken);
}
}

49
src/Umbraco.Core/Webhooks/WebhookEventContentBase.cs Normal file
View File

@@ -0,0 +1,49 @@
using Microsoft.Extensions.Options;
using Umbraco.Cms.Core.Configuration.Models;
using Umbraco.Cms.Core.Models;
using Umbraco.Cms.Core.Notifications;
using Umbraco.Cms.Core.Services;
using Umbraco.Cms.Core.Sync;
namespace Umbraco.Cms.Core.Webhooks;
public abstract class WebhookEventContentBase<TNotification, TEntity> : WebhookEventBase<TNotification>
where TNotification : INotification
where TEntity : IContentBase
{
protected WebhookEventContentBase(
IWebhookFiringService webhookFiringService,
IWebHookService webHookService,
IOptionsMonitor<WebhookSettings> webhookSettings,
IServerRoleAccessor serverRoleAccessor,
string eventName)
: base(webhookFiringService, webHookService, webhookSettings, serverRoleAccessor, eventName)
{
}
public override async Task ProcessWebhooks(TNotification notification, IEnumerable<Webhook> webhooks, CancellationToken cancellationToken)
{
foreach (Webhook webhook in webhooks)
{
if (!webhook.Enabled)
{
continue;
}
foreach (TEntity entity in GetEntitiesFromNotification(notification))
{
if (webhook.ContentTypeKeys.Any() && !webhook.ContentTypeKeys.Contains(entity.ContentType.Key))
{
continue;
}
await WebhookFiringService.FireAsync(webhook, EventName, ConvertEntityToRequestPayload(entity), cancellationToken);
}
}
}
protected abstract IEnumerable<TEntity> GetEntitiesFromNotification(TNotification notification);
protected abstract object? ConvertEntityToRequestPayload(TEntity entity);
}