| | | 1 | | using System.Threading; |
| | | 2 | | using System.Threading.Tasks; |
| | | 3 | | using OzonDomains.Models.OzonWebhook; |
| | | 4 | | using Services.OzonWebhookServices.Models; |
| | | 5 | | |
| | | 6 | | namespace Services.OzonWebhookServices.Handlers |
| | | 7 | | { |
| | | 8 | | /// <summary> |
| | | 9 | | /// Интерфейс обработчика конкретного типа push-уведомления Ozon. |
| | | 10 | | /// |
| | | 11 | | /// Паттерн: каждый новый тип уведомления (TYPE_POSTING_CANCELLED, TYPE_STOCKS_CHANGED и т.д.) |
| | | 12 | | /// реализуется в отдельном классе, без изменения <see cref="OzonWebhookService"/>. |
| | | 13 | | /// |
| | | 14 | | /// Регистрация в DI: все реализации добавляются как <c>IWebhookNotificationHandler</c>, |
| | | 15 | | /// и <see cref="OzonWebhookService"/> обходит их через <c>IEnumerable<IWebhookNotificationHandler></c>. |
| | | 16 | | /// </summary> |
| | | 17 | | public interface IWebhookNotificationHandler |
| | | 18 | | { |
| | | 19 | | /// <summary> |
| | | 20 | | /// Возвращает <c>true</c>, если данный обработчик умеет обрабатывать указанный тип уведомления. |
| | | 21 | | /// </summary> |
| | | 22 | | bool CanHandle(OzonMessageType messageType); |
| | | 23 | | |
| | | 24 | | /// <summary> |
| | | 25 | | /// Выполняет бизнес-логику обработки уведомления. |
| | | 26 | | /// </summary> |
| | | 27 | | /// <param name="notification">Типизированная модель уведомления.</param> |
| | | 28 | | /// <param name="ct">Токен отмены.</param> |
| | | 29 | | /// <returns> |
| | | 30 | | /// Описание выполненных действий (+ опционально картинка товара для Telegram-уведомления). |
| | | 31 | | /// Строковый литерал неявно приводится к <see cref="WebhookHandlingResult"/>, поэтому |
| | | 32 | | /// большинству обработчиков не нужно менять существующие <c>return msg;</c>. |
| | | 33 | | /// </returns> |
| | | 34 | | Task<WebhookHandlingResult> HandleAsync(IOzonWebhookMessage notification, CancellationToken ct); |
| | | 35 | | } |
| | | 36 | | |
| | | 37 | | /// <summary> |
| | | 38 | | /// Результат обработки push-уведомления Ozon одним из <see cref="IWebhookNotificationHandler"/>. |
| | | 39 | | /// </summary> |
| | | 40 | | public sealed class WebhookHandlingResult |
| | | 41 | | { |
| | | 42 | | /// <summary> |
| | | 43 | | /// Описание выполненных действий. Сохраняется в поле <c>ActionDetails</c> |
| | | 44 | | /// записи <see cref="OzonDomains.Models.OzonPushNotification"/>. |
| | | 45 | | /// Пример: "Обновлено 2 заказа. Новый статус: 'Доставлено'". |
| | | 46 | | /// </summary> |
| | 35 | 47 | | public required string ActionDetails { get; init; } |
| | | 48 | | |
| | | 49 | | /// <summary>Публичный URL картинки товара — прикладывается к уведомлению в Telegram, если задан.</summary> |
| | 0 | 50 | | public string? ImageUrl { get; init; } |
| | | 51 | | |
| | 18 | 52 | | public static implicit operator WebhookHandlingResult(string actionDetails) => new() { ActionDetails = actionDet |
| | | 53 | | } |
| | | 54 | | } |