Files
Umbraco-CMS/src/Umbraco.Core/Configuration/Models/WebhookSettings.cs

67 lines
2.2 KiB
C#
Raw Normal View History

Webhooks administration from Backoffice (#15050) * Create webhook models * Define interfaces for service and repository * Create Webhook dto and corresponding factory * implement WebhookRepository.cs * Remove entity name from models, as that should be resolved in mapping instead * Add new table to schema creator * Register repo for DI * Remove more mentions of entityname * Refactor repository to guids * Implement WebhookService * Use scopes in service * Start creating tests for service * Refactor delete to use Id and not entire entity * Rework Webhooks to be able to have multiple entity keys * Implement GetAll functionality * Implement webhook controller * Imeplement get all events action * Add equalityComparer deletegate to Webhook * Add datacontract attirbutes to properties * Implement backoffice webhooks tree * Implement first webhooks menu * Make WebHookController authorized * Update to have tabs with webhooks and logs * Enable create overlay * Push to entityKeys array * Fix up pagination * Implement delete functionality * remove pagination * add log view * Fix create to be able to select more than one content type * implement type name resolving for content * Refactor to use less duplication * Implement update functionality in frontend * Rename database table * Make multiple events possible * create new event picker * Refactor to actually add new database table with proper name * Make it possible to select multiple events * Fix updating current items * Fix up update functionality after db rework * Add webhook icon * Switch to match heartcore icons * Refactor to use bases instead of Enum * Refactor to make IWebhookEvent to Collection, so it can be injected instead of using reflection * Fix up frontend to match new models * Fix integration tests * Remove obsolete entity key from webhookdto * Introduce constants instead of hard coded strings * Start implementation of firing mechanism * Add new GetByEventName method * Add 1 to many list on WebhookDto * Implement new repository pattern * Implement GetByEventName * Fix up repository to use all async * Refactor events to fire * Refactor WebhookEvents to be more DRY * Add custom header * Start implementing log repository * Implement GetPaged * Implement WebhookLogService * Implement GetLogs * Add url to webhook log * Implement log overview * Formatting * Implement details view * Refactor to get actual retry count * Refactor firing to fire only when Enabled * Add Status code to detailed view * Add configuration to disable webhooks entirely * Implement custom headers frontend * Implement persistence of custom headers * Refactor retry service to also retry on non success status codes. * Refactor registration of Webhooks, to also register as NotificationHandler * Add webhooks migration * Add key for adding webhook headers * Fix up test * Change event icon to flag * Remember event, when editing what events you have chosen * Refactor reflection to check if INotificationAsyncHandler instead * Formatting * Refactor webhook model to no longer derive from EntityBase * Rename entityKeys to content keys * Rename controller to lowercase H * Add null check before trying to access selectedEvents * Add configuration for maximum number of retries * Add index to date * Add webhook Key to logs * Check for SchedulingPublisher before sending webhooks * rename requestObject to payload * Refactor event to send appropriate payloads * Refactor logging to happen for every try. * Order date by descending * Add todo * Change firing service to use String not ByteContent * Update Headers to Interface instead of concrete implementation * Dont return if a table exists already * Rename updateModel to webhook * Annotate WebhookController.cs with PluginController attribute * Add danish translations * Do not check if fail * Dont filter when selecting custom items * Remove delay from WebhookFiringService --------- Co-authored-by: Zeegaan <nge@umbraco.dk>
2023-10-31 10:06:14 +01:00
using System.ComponentModel;
namespace Umbraco.Cms.Core.Configuration.Models;
[UmbracoOptions(Constants.Configuration.ConfigWebhook)]
public class WebhookSettings
{
private const bool StaticEnabled = true;
private const int StaticMaximumRetries = 5;
internal const string StaticPeriod = "00:00:10";
private const bool StaticEnableLoggingCleanup = true;
private const int StaticKeepLogsForDays = 30;
Webhooks administration from Backoffice (#15050) * Create webhook models * Define interfaces for service and repository * Create Webhook dto and corresponding factory * implement WebhookRepository.cs * Remove entity name from models, as that should be resolved in mapping instead * Add new table to schema creator * Register repo for DI * Remove more mentions of entityname * Refactor repository to guids * Implement WebhookService * Use scopes in service * Start creating tests for service * Refactor delete to use Id and not entire entity * Rework Webhooks to be able to have multiple entity keys * Implement GetAll functionality * Implement webhook controller * Imeplement get all events action * Add equalityComparer deletegate to Webhook * Add datacontract attirbutes to properties * Implement backoffice webhooks tree * Implement first webhooks menu * Make WebHookController authorized * Update to have tabs with webhooks and logs * Enable create overlay * Push to entityKeys array * Fix up pagination * Implement delete functionality * remove pagination * add log view * Fix create to be able to select more than one content type * implement type name resolving for content * Refactor to use less duplication * Implement update functionality in frontend * Rename database table * Make multiple events possible * create new event picker * Refactor to actually add new database table with proper name * Make it possible to select multiple events * Fix updating current items * Fix up update functionality after db rework * Add webhook icon * Switch to match heartcore icons * Refactor to use bases instead of Enum * Refactor to make IWebhookEvent to Collection, so it can be injected instead of using reflection * Fix up frontend to match new models * Fix integration tests * Remove obsolete entity key from webhookdto * Introduce constants instead of hard coded strings * Start implementation of firing mechanism * Add new GetByEventName method * Add 1 to many list on WebhookDto * Implement new repository pattern * Implement GetByEventName * Fix up repository to use all async * Refactor events to fire * Refactor WebhookEvents to be more DRY * Add custom header * Start implementing log repository * Implement GetPaged * Implement WebhookLogService * Implement GetLogs * Add url to webhook log * Implement log overview * Formatting * Implement details view * Refactor to get actual retry count * Refactor firing to fire only when Enabled * Add Status code to detailed view * Add configuration to disable webhooks entirely * Implement custom headers frontend * Implement persistence of custom headers * Refactor retry service to also retry on non success status codes. * Refactor registration of Webhooks, to also register as NotificationHandler * Add webhooks migration * Add key for adding webhook headers * Fix up test * Change event icon to flag * Remember event, when editing what events you have chosen * Refactor reflection to check if INotificationAsyncHandler instead * Formatting * Refactor webhook model to no longer derive from EntityBase * Rename entityKeys to content keys * Rename controller to lowercase H * Add null check before trying to access selectedEvents * Add configuration for maximum number of retries * Add index to date * Add webhook Key to logs * Check for SchedulingPublisher before sending webhooks * rename requestObject to payload * Refactor event to send appropriate payloads * Refactor logging to happen for every try. * Order date by descending * Add todo * Change firing service to use String not ByteContent * Update Headers to Interface instead of concrete implementation * Dont return if a table exists already * Rename updateModel to webhook * Annotate WebhookController.cs with PluginController attribute * Add danish translations * Do not check if fail * Dont filter when selecting custom items * Remove delay from WebhookFiringService --------- Co-authored-by: Zeegaan <nge@umbraco.dk>
2023-10-31 10:06:14 +01:00
/// <summary>
/// Gets or sets a value indicating whether webhooks are enabled.
/// </summary>
/// <remarks>
/// <para>
/// By default, webhooks are enabled.
/// If this option is set to <c>false</c> webhooks will no longer send web-requests.
/// </para>
/// </remarks>
[DefaultValue(StaticEnabled)]
public bool Enabled { get; set; } = StaticEnabled;
/// <summary>
/// Gets or sets a value indicating the maximum number of retries for all webhooks.
/// </summary>
/// <remarks>
/// <para>
/// By default, maximum number of retries is 5.
/// If this option is set to <c>0</c> webhooks will no longer retry.
/// </para>
/// </remarks>
[DefaultValue(StaticMaximumRetries)]
public int MaximumRetries { get; set; } = StaticMaximumRetries;
/// <summary>
/// Gets or sets a value for the period of the webhook firing.
/// </summary>
[DefaultValue(StaticPeriod)]
public TimeSpan Period { get; set; } = TimeSpan.Parse(StaticPeriod);
/// <summary>
/// Gets or sets a value indicating whether cleanup of webhook logs are enabled.
/// </summary>
/// <remarks>
/// <para>
/// By default, cleanup is enabled.
/// </para>
/// </remarks>
[DefaultValue(StaticEnableLoggingCleanup)]
public bool EnableLoggingCleanup { get; set; } = StaticEnableLoggingCleanup;
/// <summary>
/// Gets or sets a value indicating number of days to keep logs for.
/// </summary>
/// <remarks>
/// <para>
/// By default, logs are kept for 30 days.
/// </para>
/// </remarks>
[DefaultValue(StaticKeepLogsForDays)]
public int KeepLogsForDays { get; set; } = StaticKeepLogsForDays;
Webhooks administration from Backoffice (#15050) * Create webhook models * Define interfaces for service and repository * Create Webhook dto and corresponding factory * implement WebhookRepository.cs * Remove entity name from models, as that should be resolved in mapping instead * Add new table to schema creator * Register repo for DI * Remove more mentions of entityname * Refactor repository to guids * Implement WebhookService * Use scopes in service * Start creating tests for service * Refactor delete to use Id and not entire entity * Rework Webhooks to be able to have multiple entity keys * Implement GetAll functionality * Implement webhook controller * Imeplement get all events action * Add equalityComparer deletegate to Webhook * Add datacontract attirbutes to properties * Implement backoffice webhooks tree * Implement first webhooks menu * Make WebHookController authorized * Update to have tabs with webhooks and logs * Enable create overlay * Push to entityKeys array * Fix up pagination * Implement delete functionality * remove pagination * add log view * Fix create to be able to select more than one content type * implement type name resolving for content * Refactor to use less duplication * Implement update functionality in frontend * Rename database table * Make multiple events possible * create new event picker * Refactor to actually add new database table with proper name * Make it possible to select multiple events * Fix updating current items * Fix up update functionality after db rework * Add webhook icon * Switch to match heartcore icons * Refactor to use bases instead of Enum * Refactor to make IWebhookEvent to Collection, so it can be injected instead of using reflection * Fix up frontend to match new models * Fix integration tests * Remove obsolete entity key from webhookdto * Introduce constants instead of hard coded strings * Start implementation of firing mechanism * Add new GetByEventName method * Add 1 to many list on WebhookDto * Implement new repository pattern * Implement GetByEventName * Fix up repository to use all async * Refactor events to fire * Refactor WebhookEvents to be more DRY * Add custom header * Start implementing log repository * Implement GetPaged * Implement WebhookLogService * Implement GetLogs * Add url to webhook log * Implement log overview * Formatting * Implement details view * Refactor to get actual retry count * Refactor firing to fire only when Enabled * Add Status code to detailed view * Add configuration to disable webhooks entirely * Implement custom headers frontend * Implement persistence of custom headers * Refactor retry service to also retry on non success status codes. * Refactor registration of Webhooks, to also register as NotificationHandler * Add webhooks migration * Add key for adding webhook headers * Fix up test * Change event icon to flag * Remember event, when editing what events you have chosen * Refactor reflection to check if INotificationAsyncHandler instead * Formatting * Refactor webhook model to no longer derive from EntityBase * Rename entityKeys to content keys * Rename controller to lowercase H * Add null check before trying to access selectedEvents * Add configuration for maximum number of retries * Add index to date * Add webhook Key to logs * Check for SchedulingPublisher before sending webhooks * rename requestObject to payload * Refactor event to send appropriate payloads * Refactor logging to happen for every try. * Order date by descending * Add todo * Change firing service to use String not ByteContent * Update Headers to Interface instead of concrete implementation * Dont return if a table exists already * Rename updateModel to webhook * Annotate WebhookController.cs with PluginController attribute * Add danish translations * Do not check if fail * Dont filter when selecting custom items * Remove delay from WebhookFiringService --------- Co-authored-by: Zeegaan <nge@umbraco.dk>
2023-10-31 10:06:14 +01:00
}