Українська
Події
Крок 1. Нижчий рівень, що має викликати вищий
Навіщо. Коли Аліса додає Боба до групи, браузер Боба має одразу показати групу, а список учасників у кожного члена групи – оновитися. Надсилати такі події браузерам – завдання SignalR, який живе в Chatex.Api (тема 14). Але рішення, що щось сталося, ухвалюється в Chatex.Core, посеред AddMembersAsync – а Chatex.Core не може посилатися на Chatex.Api.
Розв’язок – принцип інверсії залежностей, літера D в SOLID: бізнес-рівень оголошує інтерфейс, який йому потрібен, – IChatNotifier, а API його реалізує (рис. 10.2). Стрілка залежності в коді тепер спрямована вгору, проти потоку керування: від SignalRChatNotifier в API до інтерфейсу в Chatex.Core.
Рис. 10.2. Один інтерфейс, три реалізації
Є три реалізації: справжня (SignalR), Null Object, що нічого не робить (для будь-якого вузла без реального часу – і для Chatex.Core до теми 14), та підробка-записувач (fake) для тестів цієї теми.
Крок 2. Форми повідомлень і вкладень
Навіщо. Сповіщувач також оголошує нові й змінені повідомлення, і він надсилає повідомлення повністю, щоб клієнтам не доводилося завантажувати його знову. Тож його інтерфейсу потрібне DTO повідомлення, а DTO повідомлення потребує DTO вкладення. Обидва належать до теми 11, але сповіщувач потребує їх уже зараз; ми створюємо їх тут, а тема 11 їх завершить.
Що зробити. Створіть папку Attachments із DTO вкладення та його відображенням:
cs
using Chatex.Data.Entities;
namespace Chatex.Core.Attachments;
public sealed record AttachmentDto(Guid Id, string FileName, string ContentType, long SizeBytes);
internal static class AttachmentMappings
{
public static AttachmentDto ToDto(this Attachment attachment) =>
new(attachment.Id, attachment.FileName, attachment.ContentType, attachment.SizeBytes);
}Потім папку Messages із DTO повідомлень – цей файл завершений:
cs
using Chatex.Core.Attachments;
using Chatex.Core.Users;
using Chatex.Data.Entities;
namespace Chatex.Core.Messages;
/// <param name="Body">Null for deleted messages.</param>
public sealed record MessageDto(
Guid Id,
Guid ChatId,
UserSummaryDto Sender,
string? Body,
Guid? ReplyToMessageId,
DateTimeOffset CreatedAt,
DateTimeOffset? EditedAt,
bool IsDeleted,
IReadOnlyList<AttachmentDto> Attachments);
/// <param name="Body">May be empty when the message carries attachments.</param>
/// <param name="AttachmentIds">Ids returned by uploads that are not yet attached to a message.</param>
public sealed record SendMessageCommand(string? Body, Guid? ReplyToMessageId = null, IReadOnlyList<Guid>? AttachmentIds = null);
public sealed record EditMessageCommand(string Body);
internal static class MessageMappings
{
/// <summary>Needs <see cref="Message.Sender"/> with profile and <see cref="Message.Attachments"/> loaded.</summary>
public static MessageDto ToDto(this Message message)
{
var deleted = message.DeletedAt is not null;
return new MessageDto(
message.Id,
message.ChatId,
message.Sender.ToSummaryDto(),
deleted ? null : message.Body,
message.ReplyToMessageId,
message.CreatedAt,
message.EditedAt,
deleted,
deleted ? [] : message.Attachments.OrderBy(a => a.Id).Select(a => a.ToDto()).ToList());
}
}- Видалене повідомлення зберігає свій ідентифікатор, чат, відправника й час, але
Bodyдорівнюєnull,IsDeleted–true, а вкладень немає; клієнт показує заглушку. - Вкладення впорядковано за ідентифікатором, що (UUIDv7) відповідає порядку завантаження.
SendMessageCommandмає необов’язкові параметри: відповідь і вкладення трапляються рідко, тож достатньоnew SendMessageCommand("hi").
Сервісу чатів потрібна ще одна помилка повідомлень – message_not_found, для позначення прочитаним неіснуючого повідомлення. Створіть помилки повідомлень повністю:
cs
using Chatex.Core.Common;
namespace Chatex.Core.Messages;
public static class MessageErrors
{
public static Error NotFound { get; } = Error.NotFound("message_not_found", "The message does not exist.");
public static Error CannotPost { get; } =
Error.Forbidden("cannot_post", "Only the owner and admins can post in this channel.");
public static Error NotSender { get; } = Error.Forbidden("not_sender", "Only the sender can edit a message.");
public static Error ReplyNotFound { get; } =
Error.Validation("replyToMessageId", "reply_not_found", "The message you reply to is not in this chat.");
public static Error InvalidAttachments { get; } =
Error.Validation("attachmentIds", "invalid_attachments", "Some attachments do not exist, are not yours or are already sent.");
}
internal static class MessageLimits
{
public const int MaxBody = 4000;
public const int MaxAttachments = 10;
}Крок 3. Сповіщувач
Що зробити. Створіть папку Abstractions:
cs
using Chatex.Core.Messages;
namespace Chatex.Core.Abstractions;
/// <summary>
/// Pushes chat events to connected clients. Services call it only after the change is committed.
/// The Api implements it with SignalR; until then <see cref="NullChatNotifier"/> drops the events.
/// </summary>
public interface IChatNotifier
{
Task MessageCreatedAsync(MessageDto message, CancellationToken cancellationToken = default);
Task MessageUpdatedAsync(MessageDto message, CancellationToken cancellationToken = default);
Task MessageDeletedAsync(Guid chatId, Guid messageId, CancellationToken cancellationToken = default);
Task MessagesReadAsync(Guid chatId, Guid userId, Guid lastReadMessageId, CancellationToken cancellationToken = default);
/// <summary>Users joined or were added, including everyone in a newly created chat.</summary>
Task MembersAddedAsync(Guid chatId, IReadOnlyCollection<Guid> userIds, CancellationToken cancellationToken = default);
/// <summary>A user left or was removed.</summary>
Task MemberRemovedAsync(Guid chatId, Guid userId, CancellationToken cancellationToken = default);
/// <summary>Title, description, handle, avatar or member roles changed.</summary>
Task ChatUpdatedAsync(Guid chatId, CancellationToken cancellationToken = default);
Task ChatDeletedAsync(Guid chatId, CancellationToken cancellationToken = default);
}
public sealed class NullChatNotifier : IChatNotifier
{
public Task MessageCreatedAsync(MessageDto message, CancellationToken cancellationToken = default) => Task.CompletedTask;
public Task MessageUpdatedAsync(MessageDto message, CancellationToken cancellationToken = default) => Task.CompletedTask;
public Task MessageDeletedAsync(Guid chatId, Guid messageId, CancellationToken cancellationToken = default) => Task.CompletedTask;
public Task MessagesReadAsync(Guid chatId, Guid userId, Guid lastReadMessageId, CancellationToken cancellationToken = default) =>
Task.CompletedTask;
public Task MembersAddedAsync(Guid chatId, IReadOnlyCollection<Guid> userIds, CancellationToken cancellationToken = default) =>
Task.CompletedTask;
public Task MemberRemovedAsync(Guid chatId, Guid userId, CancellationToken cancellationToken = default) => Task.CompletedTask;
public Task ChatUpdatedAsync(Guid chatId, CancellationToken cancellationToken = default) => Task.CompletedTask;
public Task ChatDeletedAsync(Guid chatId, CancellationToken cancellationToken = default) => Task.CompletedTask;
}- Вісім подій, по одній на кожен вид змін: три для повідомлень, одна для позицій читання, дві для членства, дві для самого чату.
- «Лише після того, як зміну зафіксовано» (коментар до інтерфейсу) – найважливіше правило. Подія про повідомлення, яке потім скасовано, показала б іншим користувачам повідомлення, якого не існує. Кожен сервіс викликає сповіщувач після
SaveChangesAsyncабо після повернення з транзакції. - Події несуть ідентифікатори, а не стани, окрім повідомлень.
ChatUpdatedAsync(chatId)каже клієнтам «перезавантажте цей чат»; тоді вони звертаються до API, що застосовує дозволи кожного користувача. Надсилати весь чат означало б вирішувати тут, що може бачити кожен учасник. NullChatNotifier– це патерн Null Object: реалізація, що нічого не робить, тож сервіси ніколи не перевіряютьif (notifier is not null).
Перевірка
dotnet build завершується успішно.