Adds name and description to webhooks (#18217)

* Model, service, test and migration updates to add name and description to webhook.

* Update typed client models.

* Fixed migration.

* Front-end rendering and update of name and description.

* Updated OpenApi.json

* Reworked integration tests to avoid breaking change.

* add name and description to editor header

* remove name and description properties

* render name as first column in the table

* remove focus from url

* remove required from name

* add parentheses to align UX

* add webhook paths

* use edit path const in collection

* add paths for root

* remove unused

* remove unused state

---------

Co-authored-by: Mads Rasmussen <[email protected]>

Author: AndyButland

src/Umbraco.Cms.Api.Management/Factories/WebhookPresentationFactory.cs

@@ -29,6 +29,8 @@ public WebhookResponseModel CreateResponseModel(IWebhook webhook)
         var target = new WebhookResponseModel
         {
             Events = webhook.Events.Select(Create).ToArray(),
+            Name = webhook.Name,
+            Description = webhook.Description,
             Url = webhook.Url,
             Enabled = webhook.Enabled,
             Id = webhook.Key,
@@ -44,6 +46,8 @@ public IWebhook CreateWebhook(CreateWebhookRequestModel webhookRequestModel)
         var target = new Webhook(webhookRequestModel.Url, webhookRequestModel.Enabled, webhookRequestModel.ContentTypeKeys, webhookRequestModel.Events, webhookRequestModel.Headers)
         {
             Key = webhookRequestModel.Id ?? Guid.NewGuid(),
+            Name = webhookRequestModel.Name,
+            Description = webhookRequestModel.Description,
         };
         return target;
     }
@@ -53,6 +57,8 @@ public IWebhook CreateWebhook(UpdateWebhookRequestModel webhookRequestModel, Gui
         var target = new Webhook(webhookRequestModel.Url, webhookRequestModel.Enabled, webhookRequestModel.ContentTypeKeys, webhookRequestModel.Events, webhookRequestModel.Headers)
         {
             Key = existingWebhookkey,
+            Name = webhookRequestModel.Name,
+            Description = webhookRequestModel.Description,
         };
         return target;
     }

src/Umbraco.Cms.Api.Management/Mapping/Item/ItemTypeMapDefinition.cs

@@ -120,7 +120,7 @@ private static void Map(IUserGroup source, UserGroupItemResponseModel target, Ma
     // Umbraco.Code.MapAll
     private static void Map(IWebhook source, WebhookItemResponseModel target, MapperContext context)
     {
-        target.Name = string.Empty; //source.Name;
+        target.Name = source.Name ?? source.Url;
         target.Url = source.Url;
         target.Enabled = source.Enabled;
         target.Events = string.Join(",", source.Events);

src/Umbraco.Cms.Api.Management/OpenApi.json

@@ -35940,6 +35940,14 @@
           "enabled": {
             "type": "boolean"
           },
+          "name": {
+            "type": "string",
+            "nullable": true
+          },
+          "description": {
+            "type": "string",
+            "nullable": true
+          },
           "url": {
             "minLength": 1,
             "type": "string"
@@ -45448,6 +45456,14 @@
           "enabled": {
             "type": "boolean"
           },
+          "name": {
+            "type": "string",
+            "nullable": true
+          },
+          "description": {
+            "type": "string",
+            "nullable": true
+          },
           "url": {
             "minLength": 1,
             "type": "string"
@@ -46339,6 +46355,14 @@
           "enabled": {
             "type": "boolean"
           },
+          "name": {
+            "type": "string",
+            "nullable": true
+          },
+          "description": {
+            "type": "string",
+            "nullable": true
+          },
           "url": {
             "minLength": 1,
             "type": "string"

src/Umbraco.Cms.Api.Management/ViewModels/Webhook/WebhookModelBase.cs

@@ -6,6 +6,10 @@ public class WebhookModelBase
 {
     public bool Enabled { get; set; } = true;
 
+    public string? Name { get; set; }
+
+    public string? Description { get; set; }
+
     [Required]
     public string Url { get; set; } = string.Empty;
 

src/Umbraco.Core/Models/IWebhook.cs

@@ -1,9 +1,22 @@
-using Umbraco.Cms.Core.Models.Entities;
+using Umbraco.Cms.Core.Models.Entities;
 
 namespace Umbraco.Cms.Core.Models;
 
 public interface IWebhook : IEntity
 {
+    // TODO (V16): Remove the default implementations from this interface.
+    string? Name
+    {
+        get { return null; }
+        set { }
+    }
+
+    string? Description
+    {
+        get { return null; }
+        set { }
+    }
+
     string Url { get; set; }
 
     string[] Events { get; set; }

src/Umbraco.Core/Models/Webhook.cs

@@ -1,4 +1,4 @@
-using Umbraco.Cms.Core.Models.Entities;
+using Umbraco.Cms.Core.Models.Entities;
 using Umbraco.Extensions;
 
 namespace Umbraco.Cms.Core.Models;
@@ -24,6 +24,8 @@ private static readonly DelegateEqualityComparer<IDictionary<string, string>>
                 (enumerable, translations) => enumerable.UnsortedSequenceEqual(translations),
                 enumerable => enumerable.GetHashCode());
 
+    private string? _name;
+    private string? _description;
     private string _url;
     private string[] _events;
     private Guid[] _contentTypeKeys;
@@ -39,6 +41,18 @@ public Webhook(string url, bool? enabled = null, Guid[]? entityKeys = null, stri
         _enabled = enabled ?? false;
     }
 
+    public string? Name
+    {
+        get => _name;
+        set => SetPropertyValueAndDetectChanges(value, ref _name!, nameof(Name));
+    }
+
+    public string? Description
+    {
+        get => _description;
+        set => SetPropertyValueAndDetectChanges(value, ref _description!, nameof(Description));
+    }
+
     public string Url
     {
         get => _url;

src/Umbraco.Core/Services/WebhookService.cs

@@ -88,6 +88,8 @@ public async Task<Attempt<IWebhook, WebhookOperationStatus>> UpdateAsync(IWebhoo
         currentWebhook.Enabled = webhook.Enabled;
         currentWebhook.ContentTypeKeys = webhook.ContentTypeKeys;
         currentWebhook.Events = webhook.Events;
+        currentWebhook.Name = webhook.Name;
+        currentWebhook.Description = webhook.Description;
         currentWebhook.Url = webhook.Url;
         currentWebhook.Headers = webhook.Headers;
 

src/Umbraco.Infrastructure/Migrations/Upgrade/UmbracoPlan.cs

@@ -104,7 +104,12 @@ protected virtual void DefinePlan()
         To<V_15_0_0.ConvertBlockGridEditorProperties>("{9D3CE7D4-4884-41D4-98E8-302EB6CB0CF6}");
         To<V_15_0_0.ConvertRichTextEditorProperties>("{37875E80-5CDD-42FF-A21A-7D4E3E23E0ED}");
         To<V_15_0_0.ConvertLocalLinks>("{42E44F9E-7262-4269-922D-7310CB48E724}");
+
+        // To 15.1.0
         To<V_15_1_0.RebuildCacheMigration>("{7B51B4DE-5574-4484-993E-05D12D9ED703}");
         To<V_15_1_0.FixConvertLocalLinks>("{F3D3EF46-1B1F-47DB-B437-7D573EEDEB98}");
+
+        // To 15.3.0
+        To<V_15_3_0.AddNameAndDescriptionToWebhooks>("{7B11F01E-EE33-4B0B-81A1-F78F834CA45B}");
     }
 }

src/Umbraco.Infrastructure/Migrations/Upgrade/V_15_3_0/AddNameAndDescriptionToWebhooks.cs

@@ -0,0 +1,43 @@
+using Microsoft.Extensions.Logging;
+using Umbraco.Cms.Core;
+using Umbraco.Cms.Infrastructure.Persistence.Dtos;
+using Umbraco.Extensions;
+
+namespace Umbraco.Cms.Infrastructure.Migrations.Upgrade.V_15_3_0;
+
+public class AddNameAndDescriptionToWebhooks : MigrationBase
+{
+    private readonly ILogger<AddNameAndDescriptionToWebhooks> _logger;
+
+    public AddNameAndDescriptionToWebhooks(IMigrationContext context, ILogger<AddNameAndDescriptionToWebhooks> logger)
+        : base(context)
+    {
+        _logger = logger;
+    }
+
+    protected override void Migrate()
+    {
+        Logger.LogDebug("Adding name and description columns to webhooks.");
+
+        if (TableExists(Constants.DatabaseSchema.Tables.Webhook))
+        {
+            var columns = Context.SqlContext.SqlSyntax.GetColumnsInSchema(Context.Database).ToList();
+
+            AddColumn(columns, "name");
+            AddColumn(columns, "description");
+        }
+        else
+        {
+            Logger.LogWarning($"Table {Constants.DatabaseSchema.Tables.Webhook} does not exist so the addition of the name and description by columnss in migration {nameof(AddNameAndDescriptionToWebhooks)} cannot be completed.");
+        }
+    }
+
+    private void AddColumn(List<Persistence.SqlSyntax.ColumnInfo> columns, string column)
+    {
+        if (columns
+            .SingleOrDefault(x => x.TableName == Constants.DatabaseSchema.Tables.Webhook && x.ColumnName == column) is null)
+        {
+            AddColumn<WebhookDto>(Constants.DatabaseSchema.Tables.Webhook, column);
+        }
+    }
+}

src/Umbraco.Infrastructure/Persistence/Dtos/WebhookDto.cs

@@ -1,4 +1,4 @@
-using NPoco;
+using NPoco;
 using Umbraco.Cms.Core;
 using Umbraco.Cms.Infrastructure.Persistence.DatabaseAnnotations;
 
@@ -18,6 +18,15 @@ internal class WebhookDto
     [NullSetting(NullSetting = NullSettings.NotNull)]
     public Guid Key { get; set; }
 
+    [Column(Name = "name")]
+    [NullSetting(NullSetting = NullSettings.Null)]
+    public string? Name { get; set; }
+
+    [Column(Name = "description")]
+    [SpecialDbType(SpecialDbTypes.NVARCHARMAX)]
+    [NullSetting(NullSetting = NullSettings.Null)]
+    public string? Description { get; set; }
+
     [Column(Name = "url")]
     [SpecialDbType(SpecialDbTypes.NVARCHARMAX)]
     [NullSetting(NullSetting = NullSettings.NotNull)]