- Documentation
- Paquet Laravel · Version 0.1
- Adopter le paquet sur une base existante
Adopter le paquet sur une base existante
Sur cette page
À lire avant d'ajouter PublishesToSocial à un modèle qui a déjà des lignes : sans la commande social:baseline, le premier enregistrement de chaque modèle existant publie son post, et un vieil article dont on corrige une coquille partirait le jour même sur vos réseaux.
Ce que fait la commande
social:baseline enregistre le post que décrit aujourd'hui chaque modèle existant, sans rien envoyer : aucun appel n'atteint l'API. Ensuite, un modèle n'est publié que lorsque son post change, ou quand publishToSocial() le demande.
php artisan social:baseline "App\Models\Article" "App\Models\Event" --chunk=500
Elle prend une ou plusieurs classes, ou des alias de morph. Elle lit les modèles sans portée globale, --chunk à la fois (200 par défaut), et pour chacun :
- un modèle dont la condition est vraie (
when,skip,shouldPublishSocially()) et qui n'a encore aucun post de la synchronisation reçoit un lienbaseline: l'empreinte de son post, jamais envoyé ; - un modèle dont la condition est fausse est laissé de côté : il sera publié le jour où sa condition deviendra vraie, comme un nouveau post doit l'être ;
- un modèle dont la date de publication est encore à venir est laissé de côté, compté « scheduled in the future » : il doit partir à sa date, et son prochain enregistrement (ou
publishToSocial()) l'envoie ; - un modèle à la corbeille (suppression douce) est laissé de côté ;
- un modèle dont la synchronisation tourne à cet instant est laissé de côté, compté « being synchronised » : la commande prend le même verrou que la synchronisation, et l'attend
lock_waitsecondes ; - un modèle qui a déjà un post de la synchronisation est laissé de côté : la commande peut tourner deux fois ;
- un modèle qui décrit un post invalide est laissé de côté, avec un avertissement.
Elle affiche une ligne par classe, et échoue pour une classe qui n'est pas un modèle Eloquent utilisant PublishesToSocial :
App\Models\Article: 120 recorded, 3 scheduled in the future, 0 being synchronised, 7 left out.
La procédure recommandée
- Couper la synchronisation le temps du déploiement :
QUIET_SOCIAL_SYNC_ENABLED=false. - Déployer le code qui ajoute
PublishesToSocialet sa description, puis lancerphp artisan migrate. - Enregistrer les modèles existants avec
php artisan social:baseline, classe par classe ou toutes à la fois. - Rallumer la synchronisation (retirer la variable ou la passer à
true), rafraîchir une configuration en cache avecphp artisan config:cache, et redémarrer les workers avecphp artisan queue:restart.
La commande peut aussi tourner synchronisation allumée : un modèle enregistré entre-temps est alors publié, comme il se doit, et la commande le laisse de côté.
Ce qui protège sans la commande
La limite ignore_older_than (un jour par défaut) empêche d'envoyer automatiquement un modèle dont la date de publication est ancienne. C'est un second filet, pas un substitut : un modèle sans date de publication n'est jamais trop ancien, et un modèle daté de moins d'un jour part encore.
Après la commande, publishToSocial() envoie quand même un post enregistré comme baseline : c'est le moyen de republier volontairement un modèle ancien.