Українська
Правила чатів
Крок 1. Помилки й обмеження
Навіщо. Правила чатів із Docs/ChatRules.md породжують десяток різних відмов. Кожна має сталий код, тож клієнт Angular може реагувати точно: owner_must_transfer відкриває діалог «обрати нового власника», handle_taken позначає поле імені. Числові обмеження лежать поруч.
Що зробити. Створіть папку Chats:
cs
using Chatex.Core.Common;
namespace Chatex.Core.Chats;
public static class ChatErrors
{
/// <summary>Also returned for private chats the caller is not in, so their existence does not leak.</summary>
public static Error NotFound { get; } = Error.NotFound("chat_not_found", "The chat does not exist.");
public static Error NotAMember { get; } = Error.Forbidden("not_a_member", "Join the chat first.");
public static Error NotAllowed { get; } = Error.Forbidden("not_allowed", "You do not have permission to do this.");
public static Error MemberNotFound { get; } = Error.NotFound("member_not_found", "The user is not a member of this chat.");
public static Error DirectWithSelf { get; } =
Error.Validation("userId", "direct_with_self", "You cannot start a direct chat with yourself.");
public static Error NotForDirectChats { get; } =
Error.Validation("not_for_direct_chats", "This cannot be done in a direct chat.");
public static Error HandleTaken { get; } = Error.Conflict("handle_taken", "This public handle is already taken.");
public static Error OwnerMustTransfer { get; } =
Error.Conflict("owner_must_transfer", "Make someone else the owner before leaving.");
public static Error ChatFull { get; } =
Error.Conflict("chat_full", $"A group can have at most {ChatLimits.MaxGroupMembers} members.");
public static Error UnknownUsers { get; } =
Error.Validation("memberIds", "unknown_users", "Some of the users do not exist.");
public static Error InvalidRole { get; } =
Error.Validation("role", "invalid_role", "This role is not available in this chat.");
public static Error UseLeave { get; } =
Error.Validation("userId", "use_leave", "To remove yourself, leave the chat.");
}
internal static class ChatLimits
{
public const int MaxGroupMembers = 1000;
public const int MaxMembersPerRequest = 100;
public const int MaxTitle = 128;
public const int MaxDescription = 1000;
}Тут є три різні види «ні», і різниця важлива:
NotFound(404) – чату не існує, або він приватний, а викликач не є його учасником. Відповідь «403 заборонено» для приватного чату підтвердила б, що він існує.Forbidden(403) – викликач бачить чат, але не може цього робити:not_a_member(спершу приєднайтеся),not_allowed(бракує ролі).Validation(400) іConflict(409) – сам запит хибний або суперечить поточному стану (chat_full,handle_taken).
Крок 2. Дозволи як малі функції
Навіщо. Хто може змінити назву? Хто кого може вилучити? Такі правила зазвичай розсипаються по сервісу як оператори if і з часом розходяться. Chatex збирає їх в одному статичному класі з чистих функцій: вони приймають чат і учасника й повертають bool, нічого не читають із бази даних і нічого не змінюють. Їх легко читати поруч із таблицею дозволів і так само легко тестувати.
Що зробити.
cs
using Chatex.Data.Entities;
namespace Chatex.Core.Chats;
/// <summary>Who may do what in a chat. Posting rules live on <see cref="ChatMember.CanPost"/>.</summary>
public static class ChatPermissions
{
public static bool IsAdmin(ChatMember member) => member.Role is ChatMemberRole.Owner or ChatMemberRole.Admin;
public static bool CanEditInfo(Chat chat, ChatMember member) => chat.Type != ChatType.Direct && IsAdmin(member);
public static bool CanManageMembers(Chat chat, ChatMember member) => chat.Type != ChatType.Direct && IsAdmin(member);
public static bool CanDelete(Chat chat, ChatMember member) =>
chat.Type != ChatType.Direct && member.Role == ChatMemberRole.Owner;
/// <summary>Channel subscriber lists are visible to admins only.</summary>
public static bool CanListMembers(Chat chat, ChatMember member) => chat.Type != ChatType.Channel || IsAdmin(member);
/// <summary>The owner removes anyone else; an admin removes plain members and subscribers only.</summary>
public static bool CanRemove(ChatMember actor, ChatMember target) => actor.Role switch
{
ChatMemberRole.Owner => target.Role != ChatMemberRole.Owner,
ChatMemberRole.Admin => target.Role is ChatMemberRole.Member or ChatMemberRole.Subscriber,
_ => false,
};
public static bool CanDeleteMessage(ChatMember member, Message message) =>
message.SenderId == member.UserId || IsAdmin(member);
/// <summary>The role of a regular, non-admin member: groups have members, channels have subscribers.</summary>
public static ChatMemberRole RegularRole(ChatType type) =>
type == ChatType.Channel ? ChatMemberRole.Subscriber : ChatMemberRole.Member;
}Порівняйте код із правилами (табл. 10.1):
Таблиця 10.1. Дозволи та функції, що їх реалізують
| Правило | Функція |
|---|---|
| Власник і адміністратори змінюють назву, опис, ім’я, аватар – не в особистих чатах | CanEditInfo |
| Власник і адміністратори додають і вилучають учасників – не в особистих чатах | CanManageMembers |
| Лише власник видаляє групу або канал | CanDelete |
| Усі бачать учасників групи; лише адміністратори бачать підписників каналу | CanListMembers |
| Власник вилучає будь-кого іншого; адміністратор вилучає учасників і підписників | CanRemove |
| Відправник видаляє повідомлення, і так само власник та адміністратори | CanDeleteMessage |
| Приєднання до групи робить учасником, приєднання до каналу – підписником | RegularRole |
CanRemove – це вираз switch за роллю виконавця дії, зі шаблоном target.Role is … or … в одній гілці та відкиданням _ => false для кожної іншої ролі. Якщо додати роль до переліку й не вирішити, кого вона може вилучати, вона непомітно потрапить у false – безпечне значення за замовчуванням.
Крок 3. Видимість
Навіщо. Майже кожна операція над чатом починається однаково: завантажити чат, завантажити членство викликача, застосувати правило видимості. Приватний чат інших людей має виглядати точно так, як чат, якого не існує. Один невеликий клас робить це для всіх сервісів, тож правило не можна реалізувати по-різному у двох місцях.
Що зробити.
cs
using Chatex.Core.Common;
using Chatex.Data.Abstractions;
using Chatex.Data.Entities;
namespace Chatex.Core.Chats;
/// <summary>Loads a chat together with the caller's membership, applying the visibility rules.</summary>
internal sealed class ChatAccess(IChatRepository chats, IChatMemberRepository members)
{
/// <summary>
/// The chat if the caller is a member or the chat is public. <c>Member</c> is null for a public chat the caller has not joined.
/// Private chats of others are reported as not found.
/// </summary>
public async Task<Result<(Chat Chat, ChatMember? Member)>> GetVisibleAsync(
Guid userId, Guid chatId, CancellationToken cancellationToken)
{
var chat = await chats.GetByIdAsync(chatId, cancellationToken);
if (chat is null)
{
return ChatErrors.NotFound;
}
var member = await members.GetAsync(chatId, userId, cancellationToken);
if (member is null && chat.PublicHandle is null)
{
return ChatErrors.NotFound;
}
return (chat, member);
}
/// <summary>The chat and the caller's membership; fails unless the caller is a member.</summary>
public async Task<Result<(Chat Chat, ChatMember Member)>> GetMembershipAsync(
Guid userId, Guid chatId, CancellationToken cancellationToken)
{
var visible = await GetVisibleAsync(userId, chatId, cancellationToken);
if (!visible.IsSuccess)
{
return visible.Error;
}
var (chat, member) = visible.Value;
return member is null ? ChatErrors.NotAMember : (chat, member);
}
}GetVisibleAsync– читання: учасник може читати, а також будь-хто – для публічного чату (такого, що має псевдонім); тодіMemberдорівнюєnull. Приватний чат інших даєchat_not_found.GetMembershipAsync– дія: спирається на попередній метод і додатково вимагає членства, інакше повертаєnot_a_member.- Кортежі як результати.
Result<(Chat Chat, ChatMember? Member)>повертає два значення з іменами; викликач деконструює їх:var (chat, member) = access.Value;. - Повернення помилки іншого типу:
return visible.Error;перетворюєErrorнаResult<(Chat, ChatMember)>– типи успіху в обох результатів різні (ChatMember?іChatMember), але помилка підходить обом.
Перевірка
dotnet build завершується успішно.