Aller au contenu

Les plugins

Étendre un module pour une société, sans copier le code du produit.

Voir en Markdown

Un plugin étend un module pour un besoin particulier d’une société. Il vit hors du dépôt du produit. Un besoin propre à une entreprise ne se code ni dans le module ni dans le cœur : personne n’a à garder une copie modifiée du produit.

Ordre d’essai : d’abord un réglage, sans code. Puis un plugin pour ce que le réglage ne sait pas dire (un calcul, un import, un document).

Un plugin gère la météo d’une opération. S’il pleut, il marque le jour « on n’y va pas ». Pour cela il lui faut, sur l’opération :

  • un bloc sur sa fiche ;
  • ses propres données, dans une table plugin_meteo_… qui garde l’identifiant de l’opération ;
  • une tâche planifiée qui lit la météo ;
  • une marque d’information sur le planning ;
  • un réglage par société.

Aucune ligne du cœur ne change. Retirer le plugin laisse le cœur intact.

Pluginmétéo d'une opération• Entrée de menu• Bloc sur la fiche• Données propres• Tâche planifiée• Marque au planning• Réglage par sociétéMenuBloc de ficheMarques du planningContrôlesSources de donnéesTâches planifiéesRéglagesÉvénementsDonnéesCœuropération, planning9 portesPleines : utilisées par le plugin météo.Aucune ligne du cœur ne change.

Ironlane propose neuf portes aux plugins. Un plugin utilise celles dont il a besoin, et peut mettre plusieurs éléments dans une même porte. Il ne parle au produit que par ces portes.

Porte Ce qu’un module ou un plugin y met
Menu Une entrée d’écran.
Bloc de fiche Un bloc sur la fiche d’un employé, d’une opération, d’un client ou d’une intervention.
Marques du planning Une information sur une personne ou un jour.
Contrôles Une règle qui lève une alerte.
Sources et destinations de données Un import, un export, un connecteur.
Tâches planifiées Un travail qui tourne à heure fixe : lire une donnée, relancer, synchroniser.
Réglages Une page de réglages par société.
Événements Être prévenu quand quelque chose arrive : une opération posée au planning, une facture émise.
Données Ses propres tables, liées par l’identifiant d’un objet du cœur.

Seules quatre de ces portes (menu, droits, bloc de fiche, marques) sont posées aujourd’hui. Les autres sont décidées et restent à construire.

  • Chaque module qui peut être étendu publie ses emplacements, typés et documentés. Ce qui n’est pas une porte n’est pas ouvert.
  • Chaque fiche d’identité porte une version des portes (api: "1"). L’application refuse de charger un plugin dont la version n’est pas la sienne, avec un message clair.
  • Une porte ne change pas sans que sa version change. L’ancienne reste servie un temps.
  • Un plugin n’ira jamais chercher dans les fichiers internes d’un module.

Son propre dépôt, sa fiche d’identité, ses écrans, ses tests.

  • Il crée ses propres tables, nommées plugin_<nom>_<objet>. Il ne modifie jamais celles du cœur ni d’un module.
  • Ses migrations vivent chez lui. Un contrôle refuse une migration de plugin qui fait ALTER ou DROP sur une table qui n’est pas la sienne.
  • Chaque table porte une règle d’accès, comme celles du produit.
  • Il lit les données d’un module par des vues et des fonctions publiques et versionnées, jamais dans ses tables internes.
  • Retirer un plugin laisse ses tables : les données d’un client ne se jettent pas.
Mode Règle
Installation chez un client, ou plugin écrit par l’éditeur Le code du plugin tourne dans l’application. Celui qui installe en répond.
Hébergement partagé de plusieurs sociétés Le code libre d’un tiers n’est pas chargé. Un plugin y est soit déclaratif (des réglages et des modèles), soit audité et livré par l’éditeur.

Même idée : un cœur qui ne change pas, des plugins à côté qui se retirent sans dégât. Deux différences voulues. WordPress laisse un plugin tout modifier ; ici seules les portes annoncées sont ouvertes. Et WordPress sert un site par client, alors qu’ici plusieurs sociétés partagent une base : la règle d’accès par société est obligatoire dans chaque table de plugin.

Un registre public de plugins, leur signature et leur vente ne sont pas prévus pour l’instant. Un banc d’essai de compatibilité (des tests qu’un plugin lance contre une version du produit) est à construire.