mirror of
https://github.com/Govor-team/Govor.git
synced 2026-11-18 21:34:56 +00:00
Document SignalR and session key APIs
Add the experimental session-key API notes and reorganize the SignalR FriendsHub docs under docs/signalr/friendshub. The updates include front matter metadata, corrected caveats about current implementation behavior, and links to the relevant source files for verification.
This commit is contained in:
@@ -0,0 +1,51 @@
|
||||
---
|
||||
description: >-
|
||||
Description: SignalR hub for managing real-time friend request operations,
|
||||
including sending, accepting, and rejecting friend requests.
|
||||
icon: wifi
|
||||
---
|
||||
|
||||
# FriendsHub — заявки
|
||||
|
||||
Подключение: /hubs/friends с access token, содержащим userId. Атрибут Authorize у класса отсутствует; HubUserAccessor читает claim и бросает исключение при его отсутствии. Это не следует считать полноценной endpoint-политикой авторизации: её нужно добавить явно.
|
||||
|
||||
## Команды
|
||||
|
||||
| Команда | Аргумент | Успех |
|
||||
| ------------- | ----------------- | ----------------------- |
|
||||
| SendRequest | Guid targetUserId | status 201, result null |
|
||||
| AcceptRequest | Guid friendshipId | status 200, result null |
|
||||
| RejectRequest | Guid friendshipId | status 200, result null |
|
||||
|
||||
SendRequest запрещает заявку себе и повтор при Pending/Accepted/Blocked. После Rejected запись переиспользуется. Accept разрешён только адресату и только Pending; после сохранения дружбы создаётся личный чат. Reject разрешён адресату для Pending/Rejected.
|
||||
|
||||
## Все события
|
||||
|
||||
| Событие | Кому |
|
||||
| ------------------------- | --------------------------- |
|
||||
| FriendRequestReceived | Адресату новой заявки |
|
||||
| YourFriendRequestReceived | Отправителю |
|
||||
| FriendRequestAccepted | Принимающему адресату |
|
||||
| YourFriendRequestAccepted | Отправителю исходной заявки |
|
||||
| FriendRequestRejected | Отклоняющему адресату |
|
||||
| YourFriendRequestRejected | Отправителю исходной заявки |
|
||||
|
||||
Каждое событие передаёт **FriendshipDto**, не строку Guid:
|
||||
|
||||
```json
|
||||
{"id":"11111111-1111-1111-1111-111111111111","requesterId":"22222222-2222-2222-2222-222222222222","addresseeId":"33333333-3333-3333-3333-333333333333","status":0}
|
||||
```
|
||||
|
||||
Status: Pending=0, Accepted=1, Rejected=2, Blocked=3.
|
||||
|
||||
## Ошибки и восстановление
|
||||
|
||||
Сервисные Failure в SendRequest преобразуются в status 500; Accept/Reject — в 400. Поэтому не обещайте 409/403/404 для всех соответствующих бизнес-ошибок.
|
||||
|
||||
Дружба сохраняется до создания чата/рассылки; сбой может оставить частично завершённый сценарий. На reconnect перечитывайте /api/friends, /requests, /responses и /api/user/private-chats. Клиенту нужны дедупликация и обновление cache по id.
|
||||
|
||||
***
|
||||
|
||||
Проверено по исходникам на 03.10.2026, commit `4603be9`. Описано текущее поведение; сервер с БД и Firebase в рамках диагностики не запускался.
|
||||
|
||||
Источник: [Govor.API/Hubs/FriendsHub.cs](https://github.com/Govor-team/Govor/blob/4603be9f714135e0af72d505d17f3d1709834bea/Govor.API/Hubs/FriendsHub.cs).
|
||||
@@ -0,0 +1,67 @@
|
||||
---
|
||||
description: >-
|
||||
Description: This sub-documentation provides example Java client code for
|
||||
interacting with the FriendsHub SignalR hub using the microsoft/signalr
|
||||
library. It covers connecting to the hub, handling con
|
||||
icon: java
|
||||
---
|
||||
|
||||
# Клиент SignalR на C# для MAUI
|
||||
|
||||
Эта страница заменяет устаревший Java-пример: он принимал FriendshipDto как String и не соответствовал серверу. Ниже минимальный пример подключения C#; это пример интеграции, а не проверенный end-to-end тест.
|
||||
|
||||
Используйте Microsoft.AspNetCore.SignalR.Client и Govor.Contracts либо эквивалентные DTO с теми же полями.
|
||||
|
||||
```csharp
|
||||
using Govor.Contracts.DTOs;
|
||||
using Govor.Contracts.Responses.SignalR;
|
||||
using Microsoft.AspNetCore.SignalR.Client;
|
||||
|
||||
var connection = new HubConnectionBuilder()
|
||||
.WithUrl($"{baseUrl.TrimEnd('/')}/hubs/friends", options =>
|
||||
{
|
||||
options.AccessTokenProvider = async () =>
|
||||
await jwtProvider.GetAccessTokenAsync();
|
||||
})
|
||||
.WithAutomaticReconnect()
|
||||
.Build();
|
||||
|
||||
using var received = connection.On<FriendshipDto>(
|
||||
"FriendRequestReceived", dto =>
|
||||
{
|
||||
MainThread.BeginInvokeOnMainThread(() => ApplyFriendship(dto));
|
||||
});
|
||||
|
||||
using var accepted = connection.On<FriendshipDto>(
|
||||
"YourFriendRequestAccepted", dto =>
|
||||
{
|
||||
MainThread.BeginInvokeOnMainThread(() => ApplyFriendship(dto));
|
||||
});
|
||||
|
||||
await connection.StartAsync();
|
||||
|
||||
var response = await connection.InvokeAsync<HubResult<object>>(
|
||||
"SendRequest", targetUserId);
|
||||
|
||||
if (response.Status != HubResultStatus.Created)
|
||||
ShowError(response.ErrorMessage);
|
||||
```
|
||||
|
||||
baseUrl, jwtProvider, ApplyFriendship, ShowError и targetUserId предоставляет приложение. Зарегистрируйте остальные четыре события аналогично с FriendshipDto. AcceptRequest/RejectRequest получают friendshipId.
|
||||
|
||||
## Жизненный цикл MAUI
|
||||
|
||||
1. Подпишитесь на события до подключения.
|
||||
2. Первоначальный StartAsync требует собственной обработки повторов; automatic reconnect относится к потерянному соединению.
|
||||
3. После Reconnected перечитайте HTTP-списки, чтобы восстановить пропущенные события.
|
||||
4. Изменяйте ObservableCollection на MainThread.
|
||||
5. Отменяйте повторные попытки при logout и DisposeAsync; не запускайте бесконечный StartAsync из Closed после намеренного StopAsync.
|
||||
6. AccessTokenProvider должен получать актуальный access token; refresh должен быть сериализован.
|
||||
|
||||
В текущем Govor.Mobile ChatHub фильтрует ReceiveMessage по непустому encryptedContent, поэтому сообщение только с вложением может игнорироваться. Closed пытается перезапуститься даже после намеренного DisconnectAsync. JwtProviderService очищает токены при любом неуспешном HTTP-refresh, включая временную ошибку сервера: это следует исправить отдельно.
|
||||
|
||||
***
|
||||
|
||||
Проверено по исходникам на 03.10.2026, commit `4603be9`. Описано текущее поведение; сервер с БД и Firebase в рамках диагностики не запускался.
|
||||
|
||||
Источник: [Govor.API/Hubs/FriendsHub.cs](https://github.com/Govor-team/Govor/blob/4603be9f714135e0af72d505d17f3d1709834bea/Govor.API/Hubs/FriendsHub.cs).
|
||||
Reference in New Issue
Block a user