Target .NET 8, rewrite webhook controller #113
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,64 +1,151 @@ | ||
| using System; | ||
| using System.Linq; | ||
| using Microsoft.AspNetCore.Mvc; | ||
| using Kontent.Ai.Delivery.Abstractions; | ||
| using Kontent.Ai.Delivery.Caching; | ||
| using Kontent.Ai.AspNetCore.Webhooks.Models; | ||
| using System.Threading.Tasks; | ||
| using System.Collections.Generic; | ||
|
|
||
| namespace Kontent.Ai.Boilerplate.Areas.WebHooks.Controllers | ||
| { | ||
| [Area("WebHooks")] | ||
| public class WebhooksController : Controller | ||
| { | ||
| public WebhooksController(IDeliveryCacheManager cacheManager, IDeliveryClient deliveryClient) | ||
| { | ||
| _cacheManager = cacheManager ?? throw new ArgumentNullException(nameof(cacheManager)); | ||
| _deliveryClient = deliveryClient ?? throw new ArgumentNullException(nameof(deliveryClient)); | ||
| } | ||
|
|
||
| private readonly IDeliveryCacheManager _cacheManager; | ||
| private readonly IDeliveryClient _deliveryClient; | ||
|
|
||
| [HttpPost] | ||
| public async Task<IActionResult> Index([FromBody] WebhookNotification? webhook) | ||
|
There was a problem hiding this comment. shouldn't we support both until the 1.11.? or is it ok to cause this breaking now? There was a problem hiding this comment. the underlying package is https://github.com/kontent-ai/aspnetcore-extensions and it still supports legacy webhooks as well. the boilerplate should ideally use the most up-to-date approach and since we'll be removing legacy webhooks soon, I don't see a problem with adopting the new webhooks (wouldn't want users to scaffold a new project with webhooks that won't be a thing in a month). |
||
| { | ||
| if (webhook is null) | ||
| { | ||
| return Ok(); | ||
| } | ||
|
|
||
|
There was a problem hiding this comment. What about items dependencyKey? There was a problem hiding this comment. yes, this was way too simple. I added more complex logic with pattern matching to wipe the keys of (potentially) dependent entities |
||
| var dependencies = new HashSet<string>(StringComparer.Ordinal); | ||
| var usedInFetchTasks = new List<Task<IEnumerable<string>>>(); | ||
|
|
||
| foreach (var notification in webhook.Notifications ?? Enumerable.Empty<WebhookModel>()) | ||
| { | ||
| ProcessNotification(notification, dependencies, usedInFetchTasks); | ||
| } | ||
|
|
||
| await CollectUsedInDependencies(usedInFetchTasks, dependencies); | ||
| await InvalidateCacheDependencies(dependencies); | ||
|
|
||
| return Ok(); | ||
| } | ||
|
|
||
| private void ProcessNotification(WebhookModel notification, HashSet<string> dependencies, List<Task<IEnumerable<string>>> usedInFetchTasks) | ||
| { | ||
| switch (notification) | ||
| { | ||
| // Content item variant: invalidate the item and listing; on publish/unpublish also invalidate items that reference it | ||
| case { Message.ObjectType: "content_item", Data.System.Codename: var codename, Message.Action: var action }: | ||
| ProcessContentItemNotification(codename, action, dependencies, usedInFetchTasks); | ||
| break; | ||
|
|
||
| // Taxonomy change: for created, invalidate the specific taxonomy and listing, otherwise also invalidate items and type listings | ||
| case { Message.ObjectType: "taxonomy", Data.System.Codename: var codename, Message.Action: var action }: | ||
| ProcessTaxonomyNotification(codename, action, dependencies); | ||
| break; | ||
|
|
||
| // Content type change: invalidate types listing and items listing | ||
| case { Message.ObjectType: "content_type" }: | ||
| ProcessContentTypeNotification(dependencies); | ||
| break; | ||
|
|
||
| // Language change: invalidate languages listing | ||
| case { Message.ObjectType: "language" }: | ||
| ProcessLanguageNotification(dependencies); | ||
| break; | ||
|
|
||
| // Asset and unknown types: no Delivery SDK dependency helpers; skip | ||
| } | ||
| } | ||
|
|
||
| private void ProcessContentItemNotification(string codename, string action, HashSet<string> dependencies, List<Task<IEnumerable<string>>> usedInFetchTasks) | ||
| { | ||
| dependencies.Add(CacheHelpers.GetItemDependencyKey(codename)); | ||
| dependencies.Add(CacheHelpers.GetItemsDependencyKey()); | ||
|
|
||
| if (IsPublishOrUnpublishAction(action)) | ||
| { | ||
| usedInFetchTasks.Add(GetItemUsedInDependencyKeys(codename)); | ||
| } | ||
| } | ||
|
|
||
| private static void ProcessTaxonomyNotification(string codename, string action, HashSet<string> dependencies) | ||
| { | ||
| dependencies.Add(CacheHelpers.GetTaxonomyDependencyKey(codename)); | ||
| dependencies.Add(CacheHelpers.GetTaxonomiesDependencyKey()); | ||
|
|
||
| if (!IsCreatedAction(action)) | ||
| { | ||
| dependencies.Add(CacheHelpers.GetItemsDependencyKey()); | ||
| dependencies.Add(CacheHelpers.GetTypesDependencyKey()); | ||
| } | ||
| } | ||
|
|
||
| private static void ProcessContentTypeNotification(HashSet<string> dependencies) | ||
| { | ||
| dependencies.Add(CacheHelpers.GetTypesDependencyKey()); | ||
| dependencies.Add(CacheHelpers.GetItemsDependencyKey()); | ||
| } | ||
|
|
||
| private static void ProcessLanguageNotification(HashSet<string> dependencies) | ||
| { | ||
| dependencies.Add(CacheHelpers.GetLanguagesDependencyKey()); | ||
| } | ||
|
|
||
| private static bool IsPublishOrUnpublishAction(string action) => | ||
| string.Equals(action, "published", StringComparison.OrdinalIgnoreCase) || | ||
| string.Equals(action, "unpublished", StringComparison.OrdinalIgnoreCase); | ||
|
|
||
| private static bool IsCreatedAction(string action) => | ||
| string.Equals(action, "created", StringComparison.OrdinalIgnoreCase); | ||
|
|
||
| private static async Task CollectUsedInDependencies(List<Task<IEnumerable<string>>> usedInFetchTasks, HashSet<string> dependencies) | ||
| { | ||
| if (usedInFetchTasks.Count == 0) return; | ||
|
|
||
| var usedInResults = await Task.WhenAll(usedInFetchTasks); | ||
| foreach (var key in usedInResults.SelectMany(result => result)) | ||
| { | ||
| dependencies.Add(key); | ||
| } | ||
| } | ||
|
|
||
| private async Task InvalidateCacheDependencies(HashSet<string> dependencies) | ||
| { | ||
| if (dependencies.Count == 0) return; | ||
|
|
||
| var invalidations = dependencies.Select(key => _cacheManager.InvalidateDependencyAsync(key)); | ||
| await Task.WhenAll(invalidations); | ||
| } | ||
|
|
||
| private async Task<IEnumerable<string>> GetItemUsedInDependencyKeys(string codename) | ||
| { | ||
| List<string> dependencyKeys = []; | ||
| var feed = _deliveryClient.GetItemUsedIn(codename); | ||
|
|
||
| while (feed.HasMoreResults) | ||
| { | ||
| IDeliveryItemsFeedResponse<IUsedInItem> response = await feed.FetchNextBatchAsync(); | ||
|
|
||
| foreach (IUsedInItem item in response.Items) | ||
| { | ||
| dependencyKeys.Add(CacheHelpers.GetItemDependencyKey(item.System.Codename)); | ||
| } | ||
| } | ||
| return dependencyKeys; | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would keep the original constructor, rather then using this hybrid solution for field validation. but it is up to your decision.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you might be right, especially since rest of the project doesn't use primary constructors either. reverting.