Feature #15500
ferméUnifier le mécanisme de notification aux abonnements
100%
Description
- la notification aux abonnés des changements de contributions
- la notification aux abonnés à des positions sur le Pdc
Notification aux abonnés des changements de contribution¶
Ce mécanisme s'articule autour de trois axes fonctionnels :- des utilisateurs s'abonnent à une application, à un thème (dossier, album, catégorie) ou à une contribution
- tout changement qui s'opère sur une ressource d'abonnement conduit à notifier les abonnés au sujet du changement :
- une contribution a été publiée dans une application ou un thème
- une contribution dans une application ou thème abonné a été modifiée
- une contribution abonnée a été modifiée
- les notifications sont envoyées groupée sous forme de synthèse si l'abonné préfère les envois retardés par mail selon une périodicité définie par lui (les envois retardés ne peuvent être que par mail).
Les messages des notifications sont définis au niveau de chaque application. Le contenu des synthèses, quant à elles, sont gérées directement par le mécanisme de notification (le sous-mécanisme de notification retardée/synthèse de notifications)
Notification aux abonnés à des positions sur le Pdc¶
Ce mécanisme s'articule autour de deux axes fonctionnels :- des utilisateurs définissent des centres d'intérêts pour lesquels ils souhaitent être informés ; ces centres d'intérêts sont définis par des positions sur le Pdc.
- le classement d'une contribution sur le Pdc ou la modification d'une contribution conduit à notifier les abonnés aux positions du Pdc sur lesquelles la contribution est classée.
Les messages des notifications sont gérés directement par le mécanisme.
Le problème¶
Ces deux mécanismes s'ignorent. Ce qui fait que, par exemple, si un abonné est abonné à un thème et qu'une publication dans ce thème est classée sur des positions sur Pdc pour lesquelles l'abonné est aussi abonné, alors tout changement dans la publication va produire deux notifications, l'une par le mécanisme d'abonnement aux contributions, l'autre par le mécanisme d'abonnement au Pdc.
De plus, parce que ce sont deux mécanismes disjoints, des améliorations dans l'un sont souvent oubliés dans le second. C'est ainsi que la fonctionnalité de synthèse de notifications (notification retardée) n'a pas été portée dans le mécanisme de notification d'abonnement au Pdc.
Nous avons donc ici une duplication du mécanisme de notification d'abonnement qui n'est pas souhaitable. Certes, ces deux mécanismes recouvrent deux couvertures fonctionnelles différentes, mais les attendus sont les mêmes : être notifié de toute modification d'une contribution liée à la source d'un abonnement, quelque soit la nature de celle-ci : un thème, une application, la contribution même, ou un centre d'intérêt (un ou des positions sur le Pdc).
Objectif¶
N'avoir plus qu'un seul mécanisme de notification des abonnés, que l'abonnement porte sur une ressource (application, dossier, contribution) ou sur des critères de classement du PdC, afin qu'une amélioration apportée aux notifications d'abonnement profite d'office aux deux.
Ceci est la continuité de l'existant :- Le stockage est déjà unifié. Depuis la Feature #15409, un abonnement PdC est un abonnement comme les autres :
PdcSubscriptionPositionCriteriaest uneSubscriptionResourcede typePDC, enregistrée dans laSubscriptionFactory, et ses abonnés s'obtiennent parSubscriptionService.getSubscribers(...). Il ne reste à unifier que la notification - Côté contributions, il n'y a qu'une porte d'entrée pour connaître les abonnés :
ResourceSubscriptionProvider, et qu'un seul socle de construction des notifications :AbstractUserNotificationBuilder, qui reconnaît déjà les notifications d'abonnement par l'interface @UserSubscriptionNotificationBehavior@adelaide.lenogues@o2.fr - Le passage contribution → classement existe déjà dans core-library :
ContentManagementEngine.getSilverContentId(idContribution, idInstance)
Mis à jour par Miguel Moquillon il y a environ 2 mois
- Lié à Support #5450: Erreur 403 sur l'application flux rss ajouté
Mis à jour par Miguel Moquillon il y a environ 2 mois
- Lié à Support #5450: Erreur 403 sur l'application flux rss supprimé
Mis à jour par Miguel Moquillon il y a environ 2 mois
- Lié à Feature #15410: Enrichissement des notifications d’abonnement ajouté
Mis à jour par Miguel Moquillon il y a environ 2 mois
- Statut changé de New à In progress...
Mis à jour par Miguel Moquillon il y a environ 2 mois
- Statut changé de In progress... à Resolved
- % réalisé changé de 0 à 100
Unification des notifications d'abonnement¶
Jusqu'ici, deux mécanismes distincts notifiaient les abonnés : celui des abonnements aux ressources (application, dossier, forum…) et celui des abonnements aux positions du plan de classement (PdC). Le second n'avait pas suivi les évolutions du premier : message générique, envoi toujours immédiat, doublons. Les deux mécanismes n'en font désormais plus qu'un.
Demande d'origine¶
Un abonné ayant choisi une réception différée de ses notifications (synthèse quotidienne) recevait malgré tout un mail immédiat pour une actualité classée sur le PdC. La cause : les notifications destinées aux abonnés du PdC étaient forcées en envoi immédiat. Ce n'est plus le cas.
Avec l'évolution #15410, les vignettes des contributions sont incluses dans les messages de notification aux abonnés. Seuls les messages aux abonnés à des positions du Pdc n'avaient pas ces vignettes. Ce n'est là aussi plus le cas.
Ce qui change pour les utilisateurs¶
Abonnés à une position du PdC
- À la création, la modification ou la publication d'une contribution classée, ils reçoivent désormais le message de l'application, le même que les abonnés de l'application ou du dossier, à la place du message générique « classée ». Ils le reçoivent même s'ils ne sont abonnés ni à l'application ni au dossier.
- Une seule notification par événement : un utilisateur abonné à la fois au dossier et à une position du PdC ne reçoit plus deux messages. Une contribution classée dès sa création ne donne lieu qu'à la notification de création.
- La fréquence de réception est respectée : ces notifications suivent la fréquence choisie par l'utilisateur et apparaissent dans ses synthèses.
- Pour un classement seul (contribution existante classée, ou position modifiée), le message PdC est conservé mais réécrit : il nomme la contribution et le centre d'intérêt concerné, a pour expéditeur l'auteur du classement, porte la vignette de la contribution, et n'est reçu qu'une fois même si plusieurs abonnements de l'utilisateur correspondent.
- Un abonné PdC n'est notifié que s'il satisfait le contrôle d'accès de l'application pour la contribution (dans la GED, les droits sur le dossier).
Contributeurs
- La boîte de confirmation « des abonnés vont être notifiés », affichée à la modification d'une contribution, tient compte des abonnés du PdC.
- Elle ne s'affiche plus quand aucun des abonnés n'a accès à l'application.
Abonnés de la GED
- La notification de création d'une publication porte désormais sa vignette. Celle-ci était enregistrée après l'envoi de la notification, qui partait donc sans elle quand la publication était valide dès sa création.
Par application¶
| Application | Comportement |
|---|---|
| GED, actualités, blog | Les abonnés PdC reçoivent le message de l'application à la création, la modification et la publication. |
| Forums | Les abonnés PdC reçoivent le message de l'application à la création et à la modification d'un forum classé. Les notifications de messages ne changent pas. |
| Lettre d'information | Les abonnés PdC ayant accès à l'application reçoivent la lettre à son envoi, y compris quand elle est envoyée par mail. |
| Questions/réponses | Le classement d'une nouvelle question n'alerte plus les abonnés PdC : comme les abonnés de l'application, ils sont notifiés des réponses publiques. |
| Médiathèque | Inchangé sur le principe : les abonnés PdC reçoivent le message PdC « classée » pour chaque média (nouvelle rédaction, envoi différable). |
| Applications sans abonnement (enquêtes, quizz, annuaire d'experts…) | Inchangé : message PdC « classée » au classement. |
Ce qui change pour l'exploitation¶
- Nouveaux modèles de message
StringTemplates/core/pdcSubscription/classified_{fr,en,de}.st: le message PdC, jusqu'ici construit en dur, devient personnalisable comme les autres modèles de notification. - Nouveaux libellés de synthèse dans
notificationManagerBundle*.properties:resourceActionCLASSIFIED,resourceActionDECLASSIFIED,resourceActionRESPONSEetresourceActionCANCELED. Les installations qui surchargent ces fichiers doivent les reprendre. - Aucune migration de données, aucun paramètre nouveau.
Ce qui change pour le code¶
Nouveautés
ContributionSubscribersProvider: point d'extension qui fournit les abonnés concernés par une contribution pour une autre raison qu'un abonnement à la ressource qui la contient. Le PdC en est la première implémentation (PdcContributionSubscribersProvider).ResourceSubscriptionProvider.getSubscribersConcernedBy(ContributionIdentifier): réunit les abonnés rendus par tous les fournisseurs.AbstractUserNotificationBuilder.getSubscribedContribution(): désigne la contribution dont les abonnés concernés s'ajoutent aux destinataires d'une notification d'abonnement. À surcharger quand la contribution classée n'est pas la ressource notifiée.- Service REST
subscriptions/{componentId}/{type}/subscribers/inheritance: nouveaux paramètres optionnelscontributionIdetcontributionType. KmeliaService.createPublicationIntoTopicaccepte une étape de complétion, exécutée une fois la publication créée et avant toute notification (elle sert à enregistrer la vignette).ManagedContributionexpose la vignette de la contribution qu'il enveloppe.
Changements incompatibles
| Avant | Après |
|---|---|
PdcSubscriptionManager (façade) |
Supprimée. Injecter PdcSubscriptionService. |
PdcSubscriptionService.checkSubscriptions(...) |
notifyClassification(...) |
PdcResourceClassificationUserNotification : message en dur |
Message produit par modèle ; constructeur (critère, destinataires, contribution, auteur) |
subscribers/inheritance rend tous les abonnés |
Ne rend que les abonnés ayant accès à l'application |
Pour une application qui notifie elle-même ses abonnés
- Ne plus appeler le service d'abonnement du PdC : les abonnés PdC sont ajoutés par le socle des constructeurs de notification.
- Classer la contribution avant de notifier, et sans alerte :
classifyContent(contribution, false). - Si la contribution classée n'a pas l'identifiant de la ressource notifiée (cas d'une actualité et de sa publication), surcharger
getSubscribedContribution()et fournir unContributionSubscribersProvider.
Une application qui ne notifie pas ses abonnés n'a rien à changer.
Tests et recette¶
- Tests unitaires et d'intégration ajoutés avec chaque modification, y compris dans des modules qui n'en avaient pas (blog, forums, lettre d'information, questions/réponses).
- Tests d'intégration des modules touchés passés sous WildFly, dans le Core et dans les composants.
- Recette sur l'instance de test : 36 cas, 34 conformes, 1 sans objet, 1 écart non imputable à l'évolution (voir ci-dessous).
Limites connues¶
- Alias dans la GED : l'ajout d'un alias depuis la page ne notifie pas les abonnés du dossier de l'alias. Comportement antérieur, identique en 6.4, laissé en l'état.
- Boîte de confirmation : le contrôle porte sur l'accès à l'application, pas sur les droits plus fins (dossier, publication) vérifiés à l'envoi. Les abonnés PdC ne sont pas pris en compte pour une publication modifiée depuis un alias situé dans une autre application.
- Médiathèque : le message PdC « classée » part au classement de chaque média, alors que la notification de l'application aux abonnés de l'album est regroupée et différée.
- Lettre d'information et questions/réponses : leurs notifications d'abonnement sont envoyées en immédiat à tous leurs destinataires, abonnés PdC compris (choix de ces applications).
- Le canal « boîte de notification » reste instantané par conception : la fréquence de réception ne s'applique qu'au canal messagerie.
- Les libellés de synthèse en allemand (
resourceAction*) restent à relire.
Mis à jour par Miguel Moquillon il y a environ un mois
- Statut changé de Resolved à Closed
Évolution intégrée dans master