Principes de conception
Une signature commune pour toutes les features
L’un des principes fondamentaux de OIP Features est que toutes les features doivent partager la même structure d’initialisation.
Cette homogénéité permet :
- de simplifier l’apprentissage
- de faciliter l’intégration
- d’éviter les implémentations ad hoc selon les projets
- de garantir une expérience développeur cohérente
Une logique centrée sur l’entité Project
La feature travaille toujours à partir de l’entité Project, qui constitue l’objet central manipulé dans OIP.
Le contrat est simple :
- la feature reçoit un Project
- elle exécute sa logique métier ou technique
- elle retourne ce Project, modifié ou non
- elle peut retourner des métadonnées supplémentaires si nécessaire
Ce principe permet de garder un mode d’intégration stable d’une feature à l’autre.
Une séparation claire entre initialisation et exécution
Une feature est d’abord initialisée avec des options de configuration. Cette étape prépare les handlers nécessaires, comme la mise à jour de task ou l’émission de messages.
Ensuite, les fonctions métier exposées par la feature peuvent être appelées avec leur contexte d’exécution propre :
- projectEntity
- args
- taskState
Cette séparation améliore la lisibilité et rend les features plus faciles à tester et à réutiliser.
Des conventions explicites
Pour renforcer la cohérence de l’écosystème, plusieurs conventions s’appliquent :
- le nom d’une feature est suffixé par Feature
- les APIs exposées doivent suivre un contrat homogène
- les données spécifiques à l’appel passent dans args
- les statuts de task sont transmis via taskState lorsqu’on est dans un contexte de task
Ces conventions sont essentielles pour faire de OIP Features une vraie bibliothèque industrielle et non une collection hétérogène de modules.