- Documentation
- Paquet Laravel · Version 0.1
- Synchronisation automatique
Synchronisation automatique
Sur cette page
Chaque enregistrement ou suppression d'un modèle met en file un job qui aligne le post distant sur le modèle : il l'envoie, le remplace tant qu'il n'est pas parti, l'annule, ou ne fait rien si le post n'a pas changé.
Ce qui la déclenche
Chaque enregistrement ou suppression du modèle (suppression douce comprise) met en file un job SyncSocialPost, sur queue.connection et queue.name, une fois la transaction validée, sauf si sync vaut false. Le job porte le type et la clé du modèle, jamais le modèle : il lit le modèle tel qu'il est au moment où il tourne, sans portée globale, et un modèle supprimé en douceur compte comme supprimé.
Seuls les événements Eloquent la déclenchent : Article::query()->update([...]) ou une suppression en masse ne synchronisent rien.
Le tableau de décision
Le job compare le post que décrit le modèle à ce qu'il a déjà envoyé, par une empreinte du post. Le tableau se lit de haut en bas : la première ligne qui s'applique décide. « Forcé » désigne publishToSocial() ; « même post » signifie une empreinte inchangée.
| Situation | Effet |
|---|---|
| modèle supprimé, ou condition fausse (sauf forcé) | le post actif est annulé s'il n'est pas parti |
| données invalides (lien, tag, couverture, texte…) | lien rejected et SocialPostRejected, une fois par erreur |
| erreur de configuration, ou refus qu'un nouvel essai ne réglera pas | SocialPostFailed, signalé par report() |
date de publication plus ancienne que ignore_older_than (sauf forcé) |
rien, journalisé |
| tous les réseaux sautés | le post actif est annulé s'il n'est pas parti |
| aucun réseau avec une destination capable de publier | rien, journalisé ; le post actif est laissé |
modèle supprimé ou condition fausse, avec un lien creating |
recherché par sa référence : annulé s'il est trouvé, sinon fermé (superseded) |
un lien creating, même post, horaire à venir, moins de 23 heures |
la tentative est renvoyée avec sa propre clé |
un lien creating dans les autres cas (post changé, horaire passé, clé expirée) |
recherché par sa référence : complété s'il est trouvé, sinon fermé (superseded) et le post envoyé à nouveau |
| post actif, même post (non forcé) | rien |
| post actif, même post, forcé | renvoyé seulement s'il a été annulé ou a échoué dans Quiet Social |
| post actif pas encore parti, post changé | il est annulé, le nouveau est envoyé |
| post actif annulé, échoué ou supprimé dans Quiet Social, post changé | un nouveau est envoyé |
| post actif parti (ou en partance), post changé | rien n'est envoyé ; SocialPostOutdated |
dernier lien rejected, même post (non forcé) |
rien : il serait refusé de nouveau |
| dernier lien annulé dans Quiet Social, même post (non forcé) | rien : quelqu'un en a décidé ainsi |
dernier lien baseline, même post (non forcé) |
rien : le post existait déjà à l'arrivée du paquet |
| trois échecs de suite, même post (non forcé) | rien, journalisé |
| sinon | le post est envoyé (tout de suite, ou programmé) |
Un post « n'est pas parti » tant que Quiet Social le tient en draft, pending_approval, approved ou scheduled. Il est « en partance » en queued ou processing, et « parti » une fois published ou partially_published.
L'empreinte couvre ce que décrit le modèle : textes, titres, lien, tags, image et texte alternatif, marque, mode, cibles déclarées (réseaux sautés retirés) et date de publication telle qu'elle est écrite. Une couverture en fichier y entre par son chemin, sa taille et sa date de modification. Une connexion qui revient ne change pas l'empreinte : elle porte sur les cibles déclarées, pas sur les destinations disponibles à cet instant.
Envoyer sans publier deux fois
Envoyer écrit d'abord le lien (creating, avec une clé d'idempotence, l'horaire effectif et la marque), puis interroge l'API, puis complète le lien avec sa réponse. Un lien creating est une tentative restée sans réponse : une réponse perdue, un plantage.
- Le nouvel essai d'un même post, encore programmé à venir et dans les 23 heures, renvoie la même clé et le même corps : l'API répond par la publication qu'elle a déjà créée au lieu d'en créer une seconde.
- Sinon (le post a changé, l'horaire de la tentative est passé, ou l'API, qui garde une clé 24 heures, a pu l'oublier), renvoyer la clé risquerait un second post : la publication est recherchée par sa référence, dans la marque pour laquelle la tentative est partie. Trouvée, elle complète le lien ; introuvable, le lien est fermé (
superseded) et le post repart.
Les dates des liens sont rangées dans le fuseau de votre application, quel que soit celui de la réponse de l'API.
Chaque nouveau lien reçoit une nouvelle clé : un post annulé puis renvoyé à l'identique est bien créé de nouveau.
Les publications manuelles
Les publications envoyées à la main (le constructeur manuel, un écran du plugin Filament) sont liées sans empreinte. La synchronisation ne les annule ni ne les remplace jamais.
Le verrou et le cache
Chaque synchronisation prend un verrou sur son modèle (social:sync:{type}:{key}) dans votre cache par défaut, l'attend lock_wait secondes, et se remet en file quand elle ne l'obtient pas. Ce cache doit gérer les verrous et être partagé par tous les processus, serveurs web comme workers : Redis, Memcached ou le cache en base de données. Le cache array, ou un cache file sur plusieurs serveurs, laisse deux synchronisations du même modèle écrire en même temps.
Une rafale d'enregistrements met plusieurs jobs en file : ils tournent un par un, et l'empreinte fait finir tous les suivants sans aucun appel à l'API.
La file d'attente
La file sync fonctionne, mais ne peut pas retenter un échec passager : il est journalisé en avertissement, et le post attend le prochain enregistrement. En production, prenez une vraie file :
- un worker n'arrête un job au bout de 120 secondes qu'avec l'extension
pcntl; - donnez à la connexion de file un
retry_afterde 150 secondes ou plus : plus court, il confie le job à un second worker pendant que le premier le traite encore ; - un échec passager (limite de débit, indisponibilité, verrou du modèle déjà pris) est retenté pendant 12 heures, après le
Retry-Afterde l'API quand elle en donne un, sinon après 10 s, 30 s, 1 min, 5 min, puis 15 min.
Quand toutes les tentatives ont échoué, SocialPostFailed est levé et le post attend la prochaine modification du modèle.
Les modèles anciens
Un modèle dont la date de publication remonte à plus de ignore_older_than minutes (1440, un jour, par défaut) n'est pas envoyé automatiquement : l'enregistrement est journalisé, rien d'autre. publishToSocial() l'envoie quand même. Un modèle sans date de publication n'est jamais trop ancien : sur une base de modèles existants, servez-vous de social:baseline.
Couper la synchronisation
QUIET_SOCIAL_SYNC_ENABLED=false (la clé sync) coupe la synchronisation partout : les enregistrements ne mettent plus rien en file, et les jobs déjà en file s'arrêtent sans rien faire. C'est utile le temps d'un import ou d'un seeder. publishToSocial() fonctionne toujours.