Organisation des Codes Sources du projet CiviKey

Nous avons vu dans un post précédant que le serveur SVN pour CiviKey était accessible via l’url http://svn.invenietis.com/svn/CK et que le serveur d’intégration continue était accessible à l’URL http://ci.civikey.invenietis.com/.

Dans ce post nous allons voir la gestion du repository SVN ainsi que de Cruise Control .NET pour le projet CiviKey. Ce qui est présenté ici n'est mis en place que pour la version 2.5 de CiviKey (celle sur laquelle nous concentrons actuellement nos efforts).

Le repository SVN

Le noyau de CiviKey est divisé en deux: le Core, qui contient le noyau proprement dit et Certified qui contient les plugins certifiés. L’architecture globale est la suivante :

Structure des fichiers de CiviKey

/CK Root du repository Svn de CiviKey
/CK/Core Projet CK.Core
/CK/Core/trunk Trunk des développements du projet CK.Core
/CK/Core/releases Dossier des releases de CK.Core (cf. ci-dessous)
/CK/Certified Projet CK.Certified
/CK/Certified/trunk Trunk des développements du projet CK.Certified
/CK/Certified/releases    Dossier des releases de CK.Certified
/CK/Document/trunk Ensemble des documents

Organisation des Versions

Les "releases" sont gérées à de la façon suivante. Le projet DEMO (qui est un projet similaire à Core) détaille l'organisation de l'arborescence des releases :

/trunk Trunk principale du Produit.
/releases Dossier contenant l’ensemble des versions du Produit.
/releases/VER Une des versions du Produit.
/releases/VER/trunk Trunk de développement permettant de corriger cette version.
/releases/VER/tags Dossier contenant l’ensemble des tags pour cette version du Produit.
/releases/VER/tags/TAGS Un tag contenant les sources a un certain stade.

Ce système nous permet de gérer au mieux la montée en version du projet tout en préservant la liberté du développeur. Et il y tient le développeur à sa liberté.

Une petite histoire

Les développeurs travaillent dans /trunk qui est l’espace de développement principal.
Ils font des évolutions, des changements dans l’API pour mettre en place les nouveautés, et, un jour une version est prête à voir le jour, les développeurs décident donc de créer une Version, disons la 2.5.0.

Un nouveau dossier est créé dans /releases : /releases/2.5.0/trunk. Une Version est née, elle n'est pas parfaite (elle va avoir besoin de quelques retouches pour être finalisée) et va donc évoluer et donner naissance à des Tags.

Le premier de ces tags s'appelle CTP (pour Community Technology Preview, il aurait pu s'appeler Alpha ou PreAlpha ou autre nom qui indique que ce n'est pas vraiment sec) : /releases/2.5.0/tags/CTP apparait dans l'arborescence. Noter que les codes sources dans /tags n'évoluent pas: ils représentent des clichés, des instantannés, du /releases/2.5.0/trunk qui leur a donné naissance. Le trunk bouge, les tags figent.

Cet espace permet aux développeurs de continuer à travailler dans /trunk et donc de continuer à faire évoluer le noyau, pendant que d’autres travaillent pour la Version /releases/2.5.0/trunk afin de régler les derniers bugs qui pourraient exister. Une fois les derniers bugs corrigés dans le /trunk les développeurs créent le tag /releases/2.5.0/tags/Final (et espèrent très fort éviter le petit frère /releases/2.5.0/tags/SP1).(Voir http://en.wikipedia.org/wiki/Software_release_life_cycle pour des exemples de noms de révision.)

Pendant ce temps les développeurs du /trunk se sont lancés dans la future version 2.5.1 et ont d'ores et déjà produit une release en Alpha ce qui signifie qu’un dossier /releases/2.5.1/trunk a été créé ainsi qu’un tag /releases/2.5.1/tags/Alpha.

Cette petite histoire nous amène au dépôt suivant :

Avec ce système la version d’un projet à une vraie existence : les corrections sont possibles sans (trop) d'interférences ce qui libère le développeur, qui sait clairement s’il peut imaginer de nouveaux bugs (/trunk) ou s’il doit réfréner sa créativité (/releases).

Infrastructure technique du projet CiviKey

Invenietis a mis en place, pour le projet open source CiviKey, une infrastructure complète de gestion de projet technique. Cette infrastructure va continuer d’évoluer dans le temps, mais la base décrite dans ce poste est en place. Un autre post sera dédié à la gestion du repository SVN (dépôt SVN en français) et du serveur d’intégration. Nous avons choisi de mettre en place un certain nombre de services que l’on retrouve dans un grand nombre de projets. Ces services ont été mis en place à l’aide d’autre projet Open Source et à des modules spécifiquement développés pour la problématique de CiviKey.

Gestion du projet

La gestion projet a été déléguée à un outil fonctionnant en Ruby, Redmine (http://www.redmine.org). Il est utilisé par Invenietis en interne pour la gestion de projet ainsi que pour le dialogue avec nos clients. Cet outil permet de gérer l’ensemble des tâches lié à un ou plusieurs projets en proposant une interface web simple et un environnement unique. (Pour ceux qui connaissent, c'est un Track simple, fonctionnel, et multi projet.)

Ce service est accessible via l’URL : http://civikey.invenietis.com/

Repository SVN

La gestion des sources a été déléguée à un serveur SVN sous Windows à l’aide de VisualSvn Server (http://www.visualsvn.com/server/). Ce serveur donne accès à l’ensemble des sources du projet CiviKey.

Compte tenu du refactoring (assez violent) en cours, les dépôts de la version 2.0 et 2.5 n’ont pas la même structure.

Version CiviKey 2.0 :

         Core : https://svn.invenietis.com/svn/CK/branches/Core-Summer09

         Contrib : https://svn.invenietis.com/svn/CK/trunk/Contrib

Version CiviKey 2.5 :

         CK.Core : https://svn.invenietis.com/svn/CK/Core/trunk

         CK.Certified : https://svn.invenietis.com/svn/CK/Certified/trunk

Un premier autre post sera dédié a la gestion du repository par rapport à la gestion des releases et des tags de version.

Service d’intégration continue

Pour garantir la qualité des éléments développée dans ce projet, nous avons mis en place un service d’intégration continue qui permet de faire un ensemble d’opérations à chaque commit de développeur. Ce service a été mis en place grâce à Cruise Control .NET (http://ccnet.thoughtworks.com/). Il permet entre autres de compiler en environnement contrôlé, de faire passer des tests unitaires plus spécialisés que sur les postes de développement ou encore de gérer les releases des projets.

Ce service est accessible via l’URL : http://ci.civikey.invenietis.com/

Cruise Control  génère aussi la documentation type MSDN pour chaque release taguée du projet. Elles sont disponibles ici : http://help.civikey.invenietis.com/.

Un deuxième autre post sera dédié à la gestion de Cruise Control par rapport à la gestion des releases.

 

Les modes de compatibilités d'Internet Explorer 8

IE8 intègre à présent un système de Mode permettant les évolutions futures des produits IE de Microsoft. Ces modes permettent de changer le comportement (et donc les fonctionnalités) du navigateur pour qu’il puisse afficher au mieux les pages des sites qui ne seraient pas prévus à l’origine pour IE8.

Tableau récapitulatif des modes supportés

IE5 Affiche le contenu comme le ferait IE7 en « Quirks Mode ». Ce mode est très similaire au fonctionnement de IE5 pour afficher les contenus. Utilisation du moteur JavaScript présent dans IE7 (JScript Engine Version 5.7 Quirks Mode).
IE7 Affiche le contenu comme le ferait IE7 en « Standard mode », que la page ait ou non une directive valide. Utilisation du moteur JavaScript présent dans IE7 (JScript Engine Version 5.7). Ce mode ne passe pas du tout l’Acid test 2 et arrive péniblement à 12% de l’Acid test 3.
IE8 Mode de fonctionnement proposant le plus haut support des standards sur Internet Explorer. W3C CSS 2.1, W3C Selectors API ainsi qu’un support limité du W3C CSS 3 (Working Draft). Utilisation du moteur JavaScript présent dans IE8 (JScript Engine Version 5.8). Ce mode passe l’Acid test 2 et a 20% à l’Acid test 3.
EmulateIE7      Affiche le contenu en utilisant le même principe que IE7 pour déterminer le choix de rendu entre le « Quirks Mode » et le « Standars Mode ». Suivant la directive présente dans le document, la page sera donc affichée à l’aide du mode IE5 (Quirks Mode) ou du mode IE7 (Standars Mode). Utilisation du moteur JavaScript présent dans IE7 (JScript Engine Version 5.7 ou 5.7 Quirks mode). Ce mode est le mode de compatibilité à préférer pour une très grande partie des sites.
EmulateIE8 Mode similaire à EmulateIE7. Internet Explorer utilise la directive présente dans le document pour choisir le mode de rendu entre le « Quirks Mode » et le « Standard Mode ». La page sera donc affichée à l’aide du mode IE5 (Quirks Mode) ou du mode IE8 (Standars Mode). Utilisation du moteur JavaScript présent dans IE8 (JScript Engine Version 5.8) ou du moteur JavaScript présent dans IE7 en Quirks Mode( JScript Engine Version 5.7 Quirks Mode).
Edge Mode de fonctionnement demandant d’utiliser le mode de compatibilité le plus haut possible. Si une nouvelle version de IE propose un nouveau mode, les pages en mode Edge utiliseront le nouveau mode du navigateur. Ce mode est déconseillé et n’est à utiliser que sur les environnements de test.

Attention ! Modes sauvages en liberté !

Par défaut, Internet Explorer utilise le mode EmulateIE8 pour afficher les pages qui viennent de la zone internet (« Internet Zone »). Par contre, les pages venant de la zone intranet (« Intranet Zone ») ou des contrôles WebBrowser utilisent le mode EmulateIE7 par défaut (par exemple, http://localhost/ vient de la zone intranet). Ces paramètres peuvent être changés.

Références :

Pour comparer avec les autres navigateurs (Acid test 3) :

Microsoft a mis en place un système de certification des sites pour le passage à IE8. Ce système permet au navigateur de savoir si le site sur lequel il va allé est validé pour IE8 ou pas et donc s’il faut proposer à l’utilisateur la possibilité de passé en mode compatibilité ou non. Les explications par rapport à ce système sont expliquées dans le lien suivant :

Le mode a un impact sur la chaine de caractère du « User Agent » de IE8 ainsi que sur les « Version Vector » qui servent aux codes conditionnels dans le JavaScript, dans les CSS ou dans les commentaires HTML. Normalement, ce changement n’a que peu d’impact sur un site web, cependant il est à prendre en compte.

Références :

Les arguments d’un évènement

Suite à une remarque d’Antoine, je me sens obligé aujourd’hui d’expliquer un point de conception lié à la modélisation des évènements dans CK.

Néanmoins, avant de plonger dans la technique, une remarque préliminaire s'impose:

L'Académie française, dans la neuvième édition de son Dictionnaire, écrit, en accord avec les recommandations du Conseil supérieur de la langue française de 1990, évènement. La graphie ancienne événement n'est cependant pas considérée comme fautive, encore que rien ne la justifie plus. Sa survivance s'explique par le fait que la régularisation de ce mot, ainsi que de quelques autres, d'abrègement à vènerie, avait été oubliée lors de la préparation tant de la septième édition (1878) que de la huitième (1935).
www.academie-francaise.fr/langue/rectifications_1990.pdf

Hériter… ou pas.

En règle générale, les concepteurs essayent d’éviter autant que possible les arbres d’héritage profonds : une structure d’héritage « flat » (et orthogonale) est toujours préférable (à une horreur de type MFC) car elle garantit à la fois une meilleure lisibilité (et donc maintenabilité) et réutilisabilité. Pourtant, dans CK, il existe un endroit où la structure d’héritage n’est pas du tout, mais alors vraiment pas, plate… Il s’agit des objets arguments d’évènements. Par exemple, l’argument de l’évènement correspondant à l’échange des modes de deux touches réelles. Cette classe s’appelle ActualKeyModeSwappedEventArgs et voici sa chaîne d’héritage:

ActualKeyModeSwappedEventArgs Les modes de deux touches ont été échangés.
 > ActualKeyModeChangedEventArgs  Le mode d’une touche a changé.
  > ActualKeyEventArgs L’évènement concerne une touche réelle.
   > KeyEventArgs L’évènement concerne une touche.
    > KeyboardEventArgs L’évènement concerne un clavier.
     > ContextEventArgs L’évènement concerne un contexte CK.
      > EventArgs Un évènement s’est produit.

Six classes de base !

Pourquoi les arguments d’évènements s’inscrivent-ils dans une chaîne d’héritage si profonde ? Le concepteur aurait-il abusé de substances illicites ? Que nenni (enfin si mais cela n’a pas eu d’impact sur ce qui nous occupe). Nous avons là une exception qui confirme la règle de la platitude (je ne sais pas si c’est la seule exception), car cette chaîne d’héritage permet aux évènements d’être interceptés à n’importe quel niveau de précision. Et c’est bien pratique.

Le bon héritage

Relevons d’abord un aspect important : cette conception respecte totalement la sémantique de la spécialisation et ne crée aucun des problèmes souvent rencontrés lorsque l’on abuse de l’héritage.

  • Sur le respect de la sémantique d’abord, analysons la chaîne présentée ci-dessus :
    Le fait d’échanger les modes de deux touches est un (is_a) changement de mode qui est un (is_a) évènement d’une touche réelle qui est un (is_a) évènement d’une touche qui est un (is_a) évènement d’un clavier qui est un (is_a) évènement d’un contexte qui est un (is_a) évènement.
    Ce respect de la règle est un (is a en anglais) est la règle fondamentale à respecter lorsque l’on spécialise une classe. Si on ne peut pas dire A est un B, alors A ne devrait pas hériter de B (les exceptions à cette règle existent - mixins et autres héritages de réutilisation – mais ne les commettez qu’en toute connaissance de causes et d’effets).
  • Sur la mise en œuvre d’autre part, il faut noter que ces « classes évènements » sont implémentées sans mettre en œuvre de propriétés ou méthodes protégées : ici, l’héritage ne peut « casser l’encapsulation » (chercher dans votre moteur préféré « inheritance breaks encapsulation » pour plus d’information sur ce sujet parfois un peu subtil). Chaque classe apporte des propriétés publiques qui décrivent, précisent, l’évènement correspondant : aucune réutilisation d’implémentation n’est faite ici, on est dans le cas d’un sous-typage (subtyping) plutôt que d’un héritage (inheritance).

Cet usage de l’héritage est donc correct en regard des canons de l’ingénierie logicielle. Mais à quoi cela sert ?

« Client side » : je consomme l’évènement

Comme je l’ai déjà écrit ci-dessus, l’intérêt est de faciliter la prise en compte de ces évènements au « niveau de détail » que l’on souhaite. Considérons l’évènement correspondant à un des arguments ci-dessus :

public interface IKey
{
   ...
   event EventHandler ActualKeyModeChanged;
   ...
}

En tant que client, je peux inscrire ces évènements auprès de n’importe quelle fonction dont la signature respecte le type de l’argument en tenant compte de l’héritage. Je peux, bien évidemment, m’inscrire ainsi à l’évènement :

   IKey k = ...;
   k.ActualKeyModeChanged += OnKeyModeChanged;
   ...

void OnKeyModeChanged( object source, ActualKeyModeChangedEventArgs e )
{
   ...
}

Mais, je peux aussi m’intéresser à ce même évènement ainsi :

   IKey k = ...;
   ...
   k.ActualKeyModeChanged += OnSomethingChangedInKey;
   k.KeyPropertyChanged += OnSomethingChangedInKey;
   ...

void OnSomethingChangedInKey( object source, KeyEventArgs e )
{
   ...
}

Ou même :

   IKey k = ...;
   ...
   k.ActualKeyModeChanged += OnSomethingHappened;
   k.Keyboard.AvailableModeChanged += OnSomethingHappened;
   k.Context.CurrentKeyboardChanged += OnSomethingHappened;
   ...

void OnSomethingHappened( object source, EventArgs e )
{
   ...
}

Vous voyez l’idée : comme le changement de mode d’une touche réelle est un (is_a) évènement, je peux y souscrire justement comme à un évènement quelconque, je ne suis pas contraint d’utiliser le type précis de l’argument.

« Server Side » : j’émets un évènement

Il existe une autre utilisation possible de cet héritage si l’on se place de l’autre coté de la barrière : celui où on émet l’évènement plutôt que de le recevoir. En l’occurrence, il se trouve que ActualKeyModeSwappedEventArgs et ActualKeyModeChangedEventArgs illustrent cette utilisation.

Le premier correspond à l’échange des modes de deux touches, le deuxième (qui généralise le premier) à un changement de mode d’une touche.
Les interfaces IKey et IKeyboard exposent toutes deux l’évènement ActualKeyModeChanged. Le fait que le changement soit dû à un échange plutôt qu’à un changement direct est un détail pour la grande majorité des clients (les plugins en l’occurrence), mais on souhaite quand même exposer la cause de l’évènement à ceux qui sont susceptibles de s’y intéresser. La première idée est d’exposer un deuxième évènement :

public interface IKey
{
   ...
   event EventHandler<ActualKeyModeChangedEventArgs> ActualKeyModeChanged;
   event EventHandler<ActualKeyModeSwappedEventArgs> ActualKeyModeSwapped;
   ...
}

Mais cela pose un vrai problème de conception : tout déclenchement de l’évènement Swapped doit être doublé d’un déclenchement de Changed sinon un client qui ne s’est inscrit qu’au premier ne verra jamais les changements causés par un échange de mode. Outre la pollution de l’interface IKey par un évènement peu utilisé, cela entraîne aussi le fait que le client qui s’intéresse aux deux devra dédoublonner les évènements pour éviter de les prendre en compte deux fois… Ce ne sera pas fait. Ou mal fait. C’est ce qu’on appelle une usine à bugs.

La bonne solution consiste à utiliser l’héritage dans l’autre sens. On ne publie qu’un seul évènement :

public interface IKey
{
   ...
   /// 
   /// Fires whenever the mode of one of our <see cref="ActualKeys"/> changed.
   /// The event argument may be an instance of the 
   /// <see cref="ActualKeyModeSwappedEventArgs"/> class if the change 
   /// is the result of a call to <see cref="IActualKey.SwapModes"/> 
   /// instead of <see cref="IActualKey.ChangeMode"/>.
   /// 
   event EventHandler<ActualKeyModeChangedEventArgs> ActualKeyModeChanged;
   ...
}

Et son argument sera du type ActualKeyModeSwappedEventArgs dans le cas du Swap, ce qui est facile à tester par les clients que cela intéresse :

void OnKeyModeChanged( object source, ActualKeyModeChangedEventArgs e )
{
   ActualKeyModeSwappedEventArgs eSwap = e as ActualKeyModeSwappedEventArgs;
   if( eSwap != null )
   {
      // The change is due to a swap. The event argument gives us the swapped key.
      IActualKey other = eSwap.SwappedKey;
      ...
   }
   else
   {
     // Handle ChangeMode event.
     ...
   }
}

En résumé, cette technique permet de ne pas polluer les interfaces avec des évènements rarement utilisés et de permettre une prise en compte simple et efficace de « sous-catégories » précises d’évènements.

Conclusion

Le modèle des évènements de .Net, qui repose sur les délégués (delegates) et la signature standard (object source, EventArgs e) est simple et puissant. A condition de l’exploiter correctement, et donc de l’avoir compris.

Cette discussion, qui nous a amené à traiter du bon usage de l’héritage, introduit deux aspects de l’utilisation de l’héritage en conception. Pour aller plus loin, je vous encourage à regarder du coté de la co-variance et de la contra-variance qui sont des notions très proches de ce que nous avons présenté ici.

Dans un prochain post traitant des évènements, j’aborderai de ce que je considère comme une des (rares) erreurs de conception du framework .Net : la classe EventArgs elle-même…

La roadmap de CiviKey : déjà une V2.5 ?

Le nom final du produit CVK a été trouvé et accepté lors d’une réunion des partenaires actuels : il s’agit de CiViKey (ou CiviKey ?). Compromis certes (l’historique est préservé) mais promesse d’une communication grand public facilitée.
 
C’est l’occasion pour moi de faire un petit point sur les aspects techniques : un état des lieux d’abord et un éclairage sur le futur ensuite.
 
Ce que l’on appelle aujourd’hui CiviKey a pour nom de code CVK-V2. A l’origine, ce projet n’était qu’un support de cours qui avait pour objectif :

  • D’effectuer une « Modélisation » en direct, « Les claviers » étant la réalité à modéliser.
    (Note : Le fait que des notions « irréelles », applicables uniquement à la modélisation était un aspect particulièrement intéressant n’a guère excité que moi… Solitude du pédagogue…
    Exercice : isoler ces aspects propres au modèle dans le code.)
  • De mettre en œuvre des collections, des accesseurs complexes, d’encapsuler, de sécuriser une API (au sens de limiter le développeur à des actions en accord avec la donnée), de couvrir autant de types de relations directs entre objets possibles (cycle de vie, attachement/détachement, unicité de nommage, multiplicité d’accesseurs), etc.
  • De réaliser une application graphique en .Net (un petit peu plus complexe que les applications scolaires traditionnelles).

Nous n’avons pas eu le temps, au moment où la décision a été prise d’utiliser cette base pour la V2, de revoir le noyau. De fait, la conception initiale du Contexte (Keyboard, Zone, Key, etc.) a couvert les besoins durant deux ans en supportant très correctement l’ajout des fonctionnalités : la gestion des plugins, des propriétés dynamiques (le Shared Dictionary), de la persistance, des éditeurs, etc.
 
Ayant relu attentivement le code dernièrement, j’ai néanmoins tiqué sur 2 aspects très discutables de l’implémentation actuelle car peu ou mal spécifié et réfléchis (ce qui est nettement plus grave J) que sont :

  1. la gestion des Modes du clavier (pour des raisons qui seraient un peu longue à détailler ici) ;
  2. le support du copier-coller, principalement car elle se contente d’utiliser « de l’extérieur » l’import/export xml original (destiné à la persistance) alors qu’il eut fallu une refonte/adaptation/extension de l’import afin de supporter naturellement le collage.

Nous avions par ailleurs pris la décision il y a quelques mois de masquer l’implémentation (absolument tous les objets d’implémentation) au profit d’un modèle public purement abstrait (constitué uniquement d’interfaces) et ce afin de maximiser les capacités d’évolutions du noyau. Ce travail de refactoring est un très classique processus de découplage que nous pensons nécessaire compte tenu des objectifs de pérennité de l’application.
 
Enfin, une évolution très importante en termes de fiabilité est actuellement en attente dans les cartons : la création dynamique de proxy d’interception des Services supportés par les Plugins qui ont pour objectifs :

  • d’isoler les plugins mal programmés (qui ne respectent pas les règles du jeu en terme d’appel des autres plugins ou d’émission d’événements selon l’état – Running/Stopped – des plugins) ;
  • de pouvoir éventuellement tracer tous les appels inter-plugins (idéalement, il est possible de décider des traces pour chaque méthode ou événements du système en cours d’exécution) ;
  • d’être une démonstration de la <pub>capacité de .Net à faire des trucs impressionnants et ce, tout bien pesé, assez facilement </pub>.

Le proxy (le modèle ainsi que la génération dynamique de code IL) est prêt. Il ne contient pas les fonctionnalités d’interception en tant que telle (et évidemment encore moins sa « configurabilité »). Il est maintenant nécessaire de l’intégrer et de fournir les objets proxy aux plugins plutôt que les objets Plugins eux-mêmes.

Regroupées, ces évolutions sont assez lourdes et nous avons donc décidé d’en faire une mile stone importante de release dans les prochains mois : CiviKey (CVK-V2) n’est pas encore (vraiment) sorti qu’une version 2.5 se profile déjà.