Merge pull request #10 from Libertech-FR/8-rework-yup-validation

8 rework yup validation

Author: RICHARD-Quentin

.github/workflows/test.yml

@@ -7,7 +7,7 @@ on:
     branches: [main]
 
 jobs:
-  build:
+  test:
     runs-on: ubuntu-latest
 
     strategy:

Makefile

@@ -44,7 +44,7 @@ stop-dbs: ## Stop dependencies for development
 	@docker compose --project-directory docker rm -f $(APPNAME)-redis $(APPNAME)-mongo
 
 run-test: ## Run tests
-	act --container-architecture="linux/arm64"
+	act --container-architecture="linux/arm64" -j test
 
 gen-doc:
 	npx @compodoc/compodoc -p tsconfig.json -s -d docs --includes ./markdowns -n "Sesame Orchestrator"

docs/technical/IdentitiesValidation.md

@@ -1,18 +1,26 @@
 
-# Documentation Technique - Service de Validation des Identités
+# Documentation Technique - Service de Validation des Identités (Mise à Jour)
 
 ## Description
-Ce document décrit le fonctionnement du service de validation des identités dans une application NestJS, en utilisant `yup` pour la validation des données.
+Cette documentation mise à jour décrit les améliorations apportées au service de validation des identités dans une application NestJS. Ce service utilise `yup` pour la validation des données et `ajv` pour gérer la validation des schémas JSON et YML. Les fichiers de configuration YML sont chargés dynamiquement et convertis en schémas `yup` pour valider les données utilisateur.
 
 ## Services
 
 ### IdentitiesValidationService
 
+#### Modifications Clés
+- Extraction de la logique de validation d'attributs dans une méthode privée `validateAttribute`, améliorant la lisibilité et la maintenabilité.
+- Utilisation améliorée de la gestion des erreurs pour fournir des messages d'erreur spécifiques.
+- Commentaires et annotations de type TypeScript ajoutés pour une meilleure compréhension et utilisation du type checking de TypeScript.
+
 #### Méthodes
 - `validate(data: AdditionalFieldsPart): Promise<object>`
   - Valide les données fournies en utilisant des schémas de validation `yup`.
-  - Les schémas de validation sont chargés à partir de fichiers de configuration YAML spécifiques à chaque classe d'objet.
-  - En cas d'erreur de validation, une promesse rejetée est renvoyée avec les détails des erreurs.
+  - Les schémas sont chargés à partir de fichiers YAML spécifiques à chaque classe d'objet.
+  - Renvoie une promesse rejetée avec les détails des erreurs en cas d'échec de la validation.
+- `private validateAttribute(key: string, attribute: any): Promise<string | null>`
+  - Valide un attribut individuel.
+  - Renvoie un message d'erreur spécifique ou `null` si la validation réussit.
 
 #### Utilisation
 ```typescript
@@ -22,12 +30,8 @@ class IdentitiesValidationService {
     // ... Implémentation de la validation
   }
 
-  private getValidator(type, required = false): yup.AnyObject {
-    // ... Implémentation du sélecteur de validateur
-  }
-
-  async createSchema(attributes: ConfigObjectAttributeDTO[]): Promise<yup.ObjectSchema<any>> {
-    // ... Création du schéma yup
+  private async validateAttribute(key: string, attribute: any): Promise<string | null> {
+    // ... Implémentation de la validation d'un attribut individuel
   }
 }
 ```
@@ -38,21 +42,26 @@ class IdentitiesValidationService {
 - Représente les champs supplémentaires d'une identité.
 - Utilisé par `IdentitiesValidationService` pour la validation.
 
-### inetOrgPerson
-- Représente une personne dans l'organisation.
-- Défini avec des champs spécifiques comme `cn`, `sn`, `uid`, etc.
+### ConfigObjectSchemaDTO
+- Nouveau modèle ajouté pour représenter les schémas de configuration des objets.
 
 ## Configuration
 
 ### Fichiers YAML
 - Chaque classe d'objet a son fichier de configuration YAML correspondant.
-- Exemple : `supann.yml` contient la configuration pour la classe d'objet `supannPerson`.
+- Ces fichiers sont utilisés pour générer des schémas de validation `yup`.
+
+## Intégrations
+
+### Intégration avec AJV
+- AJV est utilisé pour compiler et valider les schémas JSON.
+- Amélioration de la gestion des erreurs et des validations de schémas.
 
-## Intégration avec Mongoose
-- Les schémas Mongoose sont utilisés pour définir le modèle de données.
-- Des hooks (`pre validate`, `pre save`) sont utilisés pour intégrer la validation `yup` dans le cycle de vie des documents Mongoose.
+### Intégration avec Mongoose
+- Les schémas Mongoose sont définis comme auparavant.
+- La validation `yup` est intégrée dans le cycle de vie des documents Mongoose via des hooks (`pre validate`, `pre save`).
 
 ## Module
 
 ### IdentitiesModule
-- Configure le schéma Mongoose et intègre le service de validation.
+- Configure le schéma Mongoose et intègre le service de validation avec les améliorations apportées.

docs/user/IdentitiesValidation.md

@@ -10,7 +10,7 @@ Le système de validation d'identité utilise des fichiers de configuration YAML
 Les champs de base de l'objet `inetOrgPerson` sont validés par défaut. 
 
 ### Champs obligatoires :
-- `cn` 
+- `cn`  
 - `sn`
 - `uid`
 
@@ -34,53 +34,212 @@ Les champs de base de l'objet `inetOrgPerson` sont validés par défaut.
 
 Le fichier de configuration YAML doit être nommé selon le nom de l'`objectClass` qu'il définit, par exemple `supann.yml` pour l'`objectClass` `supann`. Il doit être placé dans le dossier `TBD`.
 
+Vous pouvez vous baser sur le template si dessous pour créer votre fichier YAML. Les champs $schema, type, properties et required sont obligatoires. Vpis ajouterez le champs désirés dans properties. Pour les champs requis, vous les listerez dans required.
+
+#### Exemple Générique de Fichier YAML
+
+```yaml
+$schema: "http://json-schema.org/draft-07/schema#"
+type: "object"
+properties:
+    [Nom de l'attribut 1] :
+        description: "[Description de l'attribut]"
+        type: [Type de l'attribut]
+        [Autres options]
+    # plus de détails d'attributs...
+required:
+    - [Nom de l'attribut 1]
+    - [Nom de l'attribut 2]
+    # plus d'attributs requis...
+
+```
+
+
 #### Exemple de Fichier YAML (`supann.yml`)
 
 Ce fichier définit la structure et les attributs requis pour l'`objectClass` `supann`.
 
 ```yaml
-objectClasses:
-  - name: supann
-    desc: 'SUPANN person object class'
-    attributes:
-      - supannEmpId
-      - supannCivilite
-      - supannBirthName
-      # more attributes...
-
-attributes:
-  - name: supannEmpId
-    desc: 'Employee ID'
-    type: string
+$schema: "http://json-schema.org/draft-07/schema#"
+type: "object"
+properties:
+  supannEmpId:
+    type: "string"
+    description: "Employee ID"
+  supannCivilite:
+    type: "string"
+    description: "Title (Mr, Ms, etc.)"
+  supannBirthName:
+    type: "string"
+    description: "Birth name"
+  supannBirthDate:
+    type: "string"
+    format: "date"
+    description: "Date of birth"
+  # plus d'attributs...
+required:
+  - "supannEmpId"
+  - "supannCivilite"
+  - "supannBirthName"
+```
 
-  - name: supannCivilite
-    desc: 'Title (Mr, Ms, etc.)'
-    type: string
+### Options
 
-  - name: supannBirthName
-    desc: 'Birth name'
+Chaque attribut peut avoir des options supplémentaires pour définir des règles de validation spécifiques. Les options sont définies en tant que clés dans le fichier YAML.
+
+#### Array (Tableau)
+- **ensure**: Assure que la valeur est toujours un tableau.
+  ```yaml
+  type: array
+  ensure: true
+  ```
+- **compact**: Supprime les valeurs vides du tableau.
+  ```yaml
+  type: array
+  compact: true
+  ```
+- **items (of)** : Définit le type des éléments du tableau.
+
+  ```yaml
+  type: array
+  items: 
     type: string
-    # more attributes...
-```
+  ```
+- **maxItems (max)** : Définit le nombre maximum d'éléments du tableau.
+  ```yaml
+  type: array
+  maxItems: 5
+  ```
+- **minItems (min)** : Définit le nombre minimum d'éléments du tableau.
+  ```yaml
+  type: array
+  minItems: 2
+  ```
 
-#### Exemple Générique de Fichier YAML
+#### Boolean (Booléen) 
+- *Pas de clés spécifiques*
+  ```yaml
+  type: boolean
+  ```
+
+#### Date
+- **maxDate (max)**: Définit la date maximum.
+  ```yaml
+  type: date
+  maxDate: '2024-01-01'
+  ```
+- **minDate (min)**: Définit la date minimum.
+  ```yaml
+  type: date
+  minDate: '2020-01-01'
+  ```
+
+#### Number (Nombre)
+- **integer**: Définit que la valeur doit être un entier.
+  ```yaml
+  type: number
+  integer: true
+  ```
+- **moreThan (exclusiveMinimum)**: Définit la valeur minimum.
+  ```yaml
+  type: number
+  moreThan: 10
+  ```
+- **lessThan (exclusiveMaximum)**: Définit la valeur maximum.
+  ```yaml
+  type: number
+  lessThan: 20
+  ```
+- **positive**: Définit que la valeur doit être positive.
+  ```yaml
+  type: number
+  positive: true
+  ```
+- **negative**: Définit que la valeur doit être négative.
+  ```yaml
+  type: number
+  negative: true
+  ```
+- **min (minimum)**: Définit la valeur minimum.
+  ```yaml
+  type: number
+  min: 5
+  ```
+- **max (maximum)**: Définit la valeur maximum.
+  ```yaml
+  type: number
+  max: 100
+  ```
+- **truncate**: Tronque la valeur.
+  ```yaml
+  type: number
+  truncate: true
+  ```
+- **round**: Arrondi la valeur.
+  ```yaml
+  type: number
+  round: true
+  ```
+
+#### Object (Objet)
+- **camelCase**: Convertit les clés de l'objet en camelCase.
+  ```yaml
+  type: object
+  camelCase: true
+  ```
+- **constantCase**: Convertit les clés de l'objet en CONSTANT_CASE.
+  ```yaml
+  type: object
+  constantCase: true
+  ```
+- **noUnknown (propertyNames)**: Définit que l'objet ne peut pas contenir de clés non définies.
+  ```yaml
+  type: object
+  noUnknown: true
+  ```
+
+#### String (Chaîne de caractères)
+- **minLength (min)**: Définit la longueur minimum de la chaîne de caractères.
+  ```yaml
+  type: string
+  minLength: 5
+  ```
+- **maxLength (max)**: Définit la longueur maximum de la chaîne de caractères.
+  ```yaml
+  type: string
+  maxLength: 20
+  ```
+- **pattern (matches or regex)**: Définit une expression régulière à respecter.
+  ```yaml
+  type: string
+  pattern: '^[a-zA-Z]+$'
+  ```
+- **email (format: 'email')**: Définit que la chaîne de caractères doit être un email.
+  ```yaml
+  type: string
+  email: true
+  ```
+- **url (format: 'url')**: Définit que la chaîne de caractères doit être une URL.
+  ```yaml
+  type: string
+  url: true
+  ```
+- **lowercase**: Convertit la chaîne de caractères en minuscule.
+  ```yaml
+  type: string
+  lowercase: true
+  ```
+- **uppercase**: Convertit la chaîne de caractères en majuscule.
+  ```yaml
+  type: string
+  uppercase: true
+  ```
+- **trim**: Supprime les espaces en début et fin de chaîne de caractères.
+  ```yaml
+  type: string
+  trim: true
+  ```
 
-```yaml
-objectClasses:
-  - name: [Nom de l'ObjectClass]
-    desc: '[Description de l'ObjectClass]'
-    attributes:
-      - [Nom de l'attribut 1]
-      - [Nom de l'attribut 2]
-      # plus d'attributs...
-
-attributes:
-  - name: [Nom de l'attribut 1]
-    desc: '[Description de l'attribut]'
-    type: [Type de l'attribut]
-    required: [true/false]
-    # plus de détails d'attributs...
-```
 
 ### JSON de Validation
 

package.json

@@ -55,6 +55,8 @@
     "@nestjs/passport": "^10.0.2",
     "@nestjs/platform-express": "^10.0.0",
     "@streamkits/nestjs_module_scrud": "^0.0.16",
+    "ajv": "^8.12.0",
+    "ajv-errors": "^3.0.0",
     "bullmq": "^4.14.0",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.0",
@@ -69,6 +71,7 @@
     "reflect-metadata": "^0.1.13",
     "request-ip": "^3.3.0",
     "rxjs": "^7.8.1",
+    "schema-to-yup": "^1.12.18",
     "winston": "^3.11.0",
     "winston-mongodb": "^5.1.1",
     "winston-transport": "^4.6.0",
@@ -133,4 +136,4 @@
       "downloadUrl": "https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-debian10-5.0.22.tgz"
     }
   }
-}
+}