Migration des clients en base de donnée

[tmerlier]

Contexte

Les clients et leurs informations sont actuellement stockés dans un fichier clients.yml.

Évolutions

• Le fichier clients.yml a été remplacé la collection mongo clients.
• Le paramètre {clients} envoyé au serveur a été supprimé. Ce paramètre était utile aux tests unitaire, ce n'est plus nécessaire maintenant.
• Le modèle habilitation et revision ne stock plus leur client sous forme d'objet, mais uniquement son _id

Routes

Toutes les routes /clients nécéssitent une authentification administrateur

/clients

• Créer un client : POST /clients/
• Récupérer un client : GET /clients/:clientId
• Modifier un client : PUT /clients/:clientId

Modèles

Client

 {
  _id: '6051dae287088f21afd00c53', // Identifiant Mongo
  id: 'identifiant-nom-client', // Identifiant manuelle (legacy)
  mandataire: '7n51dae287088f21afd07c580', // Identifiant Mongo
  chefDeFile: '7501dae287088f21afd00b76', // Identifiant Mongo
  nom: 'Nom du client',
  active: true,
  token: 'xxxxxxxxxxxxxxxxxx',
  authorizationStrategy: 'habilitation' || 'chef-de-file' || 'internal',
  options: {
    relaxMode: false
  },
  _createdAt: '1970-01-01',
  _updatedAt: '1970-01-01',
}

Legacy

Afin d'éviter un "breaking change", deux comportements ont été gardé :

• La propriété id qui était attribué manuellement à chaque client peut désormais être remplacé par l'identifiant mongo _id. Cependant, cet id sert toujours aux utilisateurs de l'API et doit donc être conservé. Les futurs clients ne disposeront alors pas de ce champ id.
• L’objet client précédemment enregistré dans les modèles Revisions et Habilitation a été conservé plutôt que d'être remplacé par un simple _id. Celui-ci est restitué par la méthode Client.exposedFields() qui isole les champs déjà présents et qui peuvent être publique.

---

Migration

 ⚠️ La migration se base sur une version modifiée et complétée du fichier clients.yml existant. Cette nouvelle version devra remplacer l'existante en production avant de lancer la migration.

[jdesboeufs]

La fichier de migration n'a pas encore été revu de mon côté ⚠️

[tmerlier]

Les derniers changements apportés sont concentrés sur l'utilisation des deux champs _id et id.

• _id identifiant mongo
• id identifiant attribué manuellement avant la sauvegarde en base de donnée des clients.

Le champ id ne sera donc plus attribué pour les futurs clients, mais restera conservé pour ceux qui le possèdent.

Pour les documents habilitations et revisions, le client n'est plus stocké sous forme d'objet, mais uniquement avec l'_id mongo.
Afin de ne pas casser le comportement initiale de l'API, la méthode computePublicClient a été ajoutée dans le but de récupérer un objet client identique à ce qui était précédemment envoyé (l'_id en plus).

[tmerlier]

Le dernier commit ajout un script de migration dédié à la version de démonstration de l'API.

Ce script va, entre autres, s'occuper de créer un mandataire de démonstration sur lequel tous les clients seront rattachés.