Share the chat transport between UI, calls and an opt-in background service. Restore account rooms and attempt boot restart, keeping event alerts independent from connection permissions. Document Android limits and add lifecycle regressions. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
18 KiB
Notifications Yavsc : serveur, Web et PostIt
Ce document décrit les mécanismes de notification actuellement présents dans le dépôt. Le terme « notification » recouvre plusieurs flux distincts :
- les annonces persistées en base, affichées dans le site Web et sur l'accueil de PostIt ;
- les messages temporaires de l'interface Web, attachés à une réponse
MVC par
ViewBag.Notify; - les événements temps réel du chat et les événements métier diffusés par SignalR.
Ces flux n'ont ni le même stockage, ni le même cycle de vie, ni les mêmes clients.
Vue d'ensemble
| Flux | Serveur / transport | Web | PostIt |
|---|---|---|---|
| Annonce persistée | Entité Notification en base, API HTTP |
Affichée dans le layout et masquable | Liste sur HomePage, chargée par HTTP et masquable |
| Message d'interface | Liste de portée requête dans ViewBag.Notify |
Affichée comme alerte dans le layout | Non consommé |
| Événement de chat | Hub SignalR authentifié à /chathub |
Le site Web n'en consomme pas dans ses vues MVC | notifyUser et notifyRoom alimentent les journaux du chat |
Événement métier push |
SignalR vers les connexions actives, plus e-mail | Pas de consommateur identifié dans les vues Web | Alerte native par le service Android ; liste persistée sur l'accueil via HTTP |
| Alerte native Android | Connexion SignalR existante | Sans objet | Service de fond facultatif ; notification seulement à réception d'un événement |
Les notifications persistées sont donc différentes d'une notification système native (notification du navigateur ou du système d'exploitation). Le client PostIt affiche une liste dans sa page d'accueil. Sur Android, le service de messagerie peut aussi afficher des notifications natives, après autorisation.
1. Annonces persistées
Modèle et stockage
L'entité partagée Notification
est enregistrée dans la table Notification via ApplicationDbContext.
Elle contient :
Id, identifiant généré ;titleetbody, obligatoires, limités respectivement à 1 024 et 512 caractères ;icon,sound,tag,color, propriétés optionnelles ;click_action, obligatoire, utilisé comme libellé d'action dans les interfaces ;Target, chaîne de ciblage. Les valeurs documentées par le modèle sontnull(tout le monde),user/{UserId},pub/{topic}etadministration.
Le masquage d'une annonce pour un utilisateur connecté est stocké dans
DismissClicked, avec une clé composée de l'identifiant utilisateur et de
l'identifiant de notification. Le même avis peut ainsi être masqué
indépendamment par chaque utilisateur.
API
NotificationsApiController
expose les deux routes GET suivantes, sous le préfixe /api/v1 :
| Route | Accès | Résultat |
|---|---|---|
GET /api/v1/notifications |
Anonyme ou authentifié | Notifications visibles à l'appelant, non masquées |
GET /api/v1/notifications/me |
Anonyme ou authentifié | Même action et mêmes règles que la route sans suffixe |
La réponse est une liste JSON triée par Id décroissant. L'API exclut les
notifications masquées par l'utilisateur authentifié, puis applique les
règles d'audience : cible vide, cible pub/…, cible correspondant à
user/{identifiant courant}, ou cible administration pour un administrateur.
Une requête anonyme n'a ni identifiant utilisateur ni rôle administrateur.
DismissClicksApiController
est réservé aux utilisateurs authentifiés :
| Route | Effet |
|---|---|
GET /api/v1/dismiss |
Liste les identifiants masqués par l'utilisateur |
POST /api/v1/dismiss/click/{notificationId} |
Masque l'avis pour l'utilisateur ; l'opération est idempotente |
DELETE /api/v1/dismiss/click/{notificationId} |
Rétablit l'avis s'il était masqué ; renvoie 404 sinon |
Le POST renvoie 404 si l'identifiant de notification n'existe pas. Le modèle
de réponse est DismissedNotification.
Création et notifications métier
Le contrôleur MVC
NotificationsController
permet la gestion CRUD des enregistrements de notification.
Le service YavscMessageSender
crée aussi une notification persistée, ciblée sur user/{id}, pour les
événements RdvQueryEvent et ClientEstimateSignedEvent. L'enregistrement
est effectué avant l'envoi d'e-mail. Le même service tente ensuite d'envoyer
un e-mail si l'adresse est disponible et confirmée, puis diffuse l'événement
push aux connexions SignalR actives de l'utilisateur.
Cette diffusion push est conditionnée par la présence de connexions actives ;
l'avis stocké en base reste, lui, disponible lors d'une récupération ultérieure
par l'API.
2. Site Web
Annonces persistées sur l'accueil
HomeController.Index
charge les notifications non masquées et les place dans ViewBag.Notify.
_Layout.cshtml les rend
comme des alertes Bootstrap avec icône, titre, corps et action. Le titre et le
corps passent par les composants Markdown du site.
Le clic sur l'action appelle POST /Home/DismissNotification/{id} via
site.js :
- pour un utilisateur connecté, le masquage est enregistré dans
DismissClicked; - pour un visiteur anonyme, les identifiants sont conservés dans la session
Web (
clicked).
La route renvoie 404 si l'avis n'existe pas et 204 après le masquage.
Comme l'API, l'accueil Web filtre Target : les cibles user/{id} ne sont
visibles qu'à l'utilisateur correspondant, et la cible administration
uniquement aux administrateurs. Un visiteur anonyme ne reçoit que les
notifications publiques (Target vide ou préfixe pub/).
Messages temporaires par requête
Les helpers NotifyInfo, NotifyWarning et Notify
ajoutent des objets à ViewBag.Notify. Ce mécanisme n'écrit pas en base :
il ne vit que dans la réponse MVC qui rend le layout. Les méthodes
NotifyInfo et NotifyWarning partagent actuellement le même rendu générique
alert-info.
3. PostIt
NotificationsApiClient
construit les routes à partir de la base d'API de l'hôte métier configuré.
Il fournit les méthodes de lecture publique et authentifiée, ainsi que les
opérations de lecture, masquage et restauration.
Sur HomePage,
HomePageViewModel
charge la liste :
- sans session valide, il appelle la route publique
GET /api/v1/notifications; - avec une session valide, il appelle
GET /api/v1/notifications/meavec le client HTTP authentifié.
Le chargement est lancé à l'ouverture de la page et relancé lorsque l'état de connexion change. Un compteur de version ignore les réponses obsolètes si un chargement plus récent a déjà commencé. L'interface distingue l'état de chargement, la liste vide et l'erreur de chargement ; l'utilisateur peut aussi actualiser manuellement.
Le bouton d'une notification utilise click_action comme libellé et masque
l'élément. En session authentifiée, PostIt appelle
POST /api/v1/dismiss/click/{id} avant de retirer l'élément de la liste. Si
l'appel échoue, l'élément reste affiché et une erreur est présentée. Sans
session, l'élément est retiré de la liste locale, sans persistance du
masquage côté serveur.
4. Événements temps réel
Hub du chat
Le hub ChatHub est publié par
Yavsc.Api à la racine sous /chathub (et non sous /api/v1) et porte
[Authorize]. Il s'appuie sur SignalR et sur IConnexionManager pour suivre
les utilisateurs et les salons.
Les événements de notification émis par le hub comprennent notamment :
| Événement SignalR | Données | Utilisation PostIt |
|---|---|---|
notifyUser |
type, identifiant ou nom cible, message |
Ajout au journal système |
notifyRoom |
type, salon, utilisateur ou détail |
Ajout au journal du salon ; met à jour la liste d'utilisateurs sur UserJoin |
joint |
ChatRoomInfo |
Initialise la vue du salon rejoint |
ReceiveMessage |
message avec nom, salon et corps | Ajoute le message à l'historique du salon |
addPV |
expéditeur, texte privé | Ajoute le message privé au journal système ; alerte native Android en arrière-plan |
notifyUserInRoom |
type, salon, message |
Pas de gestionnaire correspondant dans ChatViewModel actuellement |
Les constantes de types du chat sont déclarées dans
NotificationTypes.
Les messages notifyUser et notifyRoom ne sont pas enregistrés en base :
ils décrivent l'état temps réel de connexion, de salon ou les erreurs de
conversation.
Le singleton
ChatHubConnection
ouvre le hub avec le jeton d'accès PostIt, tente un renouvellement silencieux
du jeton et active la reconnexion automatique. Il est partagé par le service
Android, le
ChatViewModel
et la signalisation des appels : ouvrir la page ne crée pas une seconde
connexion.
Le transport conserve en mémoire les 500 dernières livraisons de messages privés et de salon pour les présenter si l'interface s'ouvre après le démarrage du service. Ce tampon est borné, non persisté sur disque et vidé à l'arrêt de la connexion ou au changement de compte. Il ne permet pas de récupérer les messages envoyés lorsque le socket était déconnecté.
Les salons sont mémorisés localement, par hôte et compte, dans
Settings.ChatRoomsByAccount. Le transport les rejoint à nouveau après une
reconnexion ou un redémarrage du processus, sans dépendre de l'interface
Avalonia. « Quitter le salon » supprime cette mémorisation. Cela n'ajoute pas
d'abonnement serveur hors ligne ni d'historique des messages manqués.
Les callbacks destinés aux collections de l'interface sont dispatchés sur
le thread UI et les callbacks obsolètes sont ignorés après déconnexion.
Événement métier push
En plus des événements du chat, YavscMessageSender utilise le même contexte
SignalR pour émettre push avec le topic et une charge utile sérialisée. Ce
nom d'événement est distinct de notifyUser et notifyRoom. Le service
Android peut en afficher une alerte native ; les annonces métier persistées
restent visibles dans PostIt lors du prochain chargement ou rafraîchissement
HTTP.
5. Android : connexion SignalR en arrière-plan
Réglage utilisateur et durée de vie
AndroidKeepChatConnected, désactivé par défaut, est éditable dans les
paramètres Android :
« Garder la connexion au serveur active et la reprendre au démarrage du
téléphone ». Enregistrer les paramètres pour appliquer le changement.
- Désactivé : le chat reste connecté pendant la vie du processus PostIt, même si l'activité est masquée, mais rien ne garantit que ce processus survive en arrière-plan. Les messages alimentent le journal ; les alertes natives en arrière-plan nécessitent le service activé.
- Activé : un service Android ordinaire héberge la même connexion
SignalR, sans notification permanente. Un récepteur
BOOT_COMPLETEDtente de reprendre ce service si l'option et une session enregistrée sont encore disponibles. - La fermeture d'une page ou de l'activité ne ferme pas la messagerie. La déconnexion du compte arrête le service et la connexion avant la suppression des jetons. Les appels et captures caméra/micro restent soumis à leur propre cycle de vie.
- Le service peut démarrer sans construire l'interface Avalonia. L'ouverture ultérieure de l'application réutilise le même conteneur et le même transport, sans connexion doublonnée.
Le service n'appelle ni StartForegroundService ni StartForeground et ne
publie aucune notification de connexion/reconnexion. Pour l'arrêter,
désactiver l'option et enregistrer les paramètres, ou déconnecter le compte.
Les notifications ne sont créées que lors de nouveaux messages ou événements ;
elles disparaissent à leur ouverture et ne sont pas marquées permanentes.
Android 13+ demande l'autorisation POST_NOTIFICATIONS pour ces alertes
visibles. Un refus empêche les alertes, pas la connexion SignalR.
Les échecs de démarrage sont signalés, sans basculer silencieusement vers
un service de premier plan et sans répéter une permission refusée.
Notifications et limites
Le service écoute les messages privés, les messages des salons rejoints et
l'événement métier SignalR push. En arrière-plan, il affiche des alertes
locales génériques pour ne pas exposer de contenu privé sur l'écran
verrouillé. Il ne faut pas confondre cet événement SignalR nommé push avec
un service de push externe.
Aucun Firebase/FCM, serveur Google de notifications, jeton d'appareil, configuration de projet ou migration push n'est requis. Les API métier et le ChatHub existants restent les seuls services réseau utilisés pour la messagerie.
Cette solution est de type best effort, pas une connexion immortelle :
- Android, Doze, l'absence de réseau et les politiques des constructeurs peuvent interrompre le socket ou empêcher le redémarrage du service. Autoriser les données en arrière-plan permet le trafic réseau ; désactiver manuellement l'optimisation de batterie pour PostIt assouplit les limites de Doze. Ces réglages ne garantissent pas la survie du processus ou du service et ne suppriment pas les autres limites d'exécution Android.
- Android 8+ peut arrêter un service ordinaire lorsque l'application reste
en arrière-plan, ou refuser
StartServicedepuis le récepteur de démarrage. Dans ce cas, PostIt signale le refus et attend une nouvelle ouverture de l'application ; aucune tentative de contournement par service de premier plan, tâche périodique ou exemption automatique n'est ajoutée. - Après un arrêt forcé par l'utilisateur, rouvrir PostIt ; le démarrage du téléphone n'est pas un contournement de cet arrêt.
- Le renouvellement nécessite une session encore valide. Une session révoquée ou sans jeton de renouvellement exige une reconnexion.
- Les messages de chat sont éphémères : les messages envoyés pendant une interruption ne sont pas récupérés par cette fonctionnalité. Les notifications métier persistées restent accessibles par l'API.
- Aucun type
specialUseni permissionFOREGROUND_SERVICE_SPECIAL_USEn'est déclaré pour la messagerie. Les services de premier plan des appels et captures caméra/micro restent inchangés : ils ne sont pas utilisés pour maintenir le chat.
Validation sur téléphone
Les tests locaux vérifient le partage de connexion, la restauration des salons et le nettoyage de session. Ils ne remplacent pas une validation Android réelle : absence de notification lors de l'activation et des reconnexions, notification seulement à réception d'un événement activité masquée, retour dans l'interface sans second socket, désactivation dans les paramètres, déconnexion/reconnexion, coupure et retour réseau, veille prolongée, redémarrage du téléphone et refus de permission sans arrêt du chat.
Une activité de vérification est incluse uniquement dans l'APK Debug :
fr.pschneider.postit.ChatServiceTestActivity. Son résultat est écrit dans
le fichier privé de l'application files/chat-service-test-result.txt.
Elle vérifie la composition du conteneur partagé, pas la réception réelle
après un démarrage ou une longue veille.
6. Points d'attention pour les évolutions
- Conserver les règles d'audience alignées entre l'API et le site Web ; en
particulier, appliquer un filtrage
Targetcôté Web avant d'exposer les avis dans le layout. - Ne pas confondre masquage utilisateur (
DismissClicked) et suppression globale de la notification : le masquage API est par utilisateur. - Les sessions anonymes du site Web et PostIt n'ont pas le même comportement : le site Web conserve le masquage en session, tandis que PostIt ne le garde que dans la liste affichée jusqu'au prochain rechargement.
- Ajouter un nouveau type de cible ou un nouvel événement temps réel implique d'examiner séparément son filtrage, son transport et les clients qui l'écoutent.
- Les références à GCM et le nom historique de
YavscMessageSenderne signifient pas que PostIt reçoit une notification native hors ligne : le chemin observé ici est l'e-mail, l'événement SignalR temps réel et la notification persistée récupérée par HTTP.