Partage simplifié

Pré-requis

NodeJs 16
Yarn
Docker & Docker-compose

Présentation

Ce repository contient l'application partage simplifié.

! La documentation est à mettre à jour

Infrastructure & Déploiement

Ce projet fonctionne de manière autonome en local avec des conteneurs docker.

Pour déployer et faire fonctionner l'application sur un server dédié il faut récupérer le contenu du repository partage-simplifie-infra.

Le repository partage-simplifie-infra est lui, privé car il est utilisé pour contenir l'ensemble des données sensibles (Clés SSH, mots de passes ...) nécessaires à la mise en place de l' application, merci de suivre sa documentation dédiée pour déployer l'application.

Organisation des dossiers

Ce repository est organisé de la manière suivante :

    |-- .github
    |-- reverse_proxy
        |-- app
            |-- logrotate.d
                |-- logrotate.conf
            |-- nginx
                |-- conf.d
                  |-- locations
                    |-- api.inc
                  |-- default.conf
                |-- nginx.conf
            |-- start.sh
        |-- Dockerfile
    |-- server
        |-- assets
        |-- config
          |-- index.js
        |-- data
        |-- src
        |-- tests
          |-- integration
            |-- ...
          |-- unit
            |-- ...
          |-- utils
            |-- ...
    |-- .gitattributes
    |-- .gitignore
    |-- docker-compose.yml
    |-- docker-compose.override.yml

Le dossier /.github va contenir l'ensemble des Github Actions.
Le dossier /reverse_proxy va contenir le serveur Nginx et sa configuration en tant que reverse_proxy.
Le dossier /server va contenir l'ensemble de l'application coté serveur, à savoir l'API Node Express.
Le dossier /ui va contenir l'ensemble de l'application coté front, à savoir une application React implémentant le design system de l'État (https://www.gouvernement.fr/charte/charte-graphique-les-fondamentaux/introduction) grâce à ChakraUI.
Le fichier /docker-compose.yml va définir la configuration des conteneurs de l'application, pour plus d'informations sur Docker cf: https://docs.docker.com/
Le fichier /docker-compose.override.yml va définir la configuration Docker spécifique à l'environnement local de développement. :warning: ce fichier est ignoré lors des commits (cf .gitignore) afin d'éviter la divulgation de secrets/tokens

Gestion de la configuration

La gestion de la configuration se fait via bibliothèque env-var et le fichier docker-compose.override.yml

La configuration est gérée exclusivement via variables d'environnement pour des raisons de sécurité et de cohérence entre environnements.

Le module /server/config/index.js expose un objet mappant les variables d'environnements nécessaires au fonctionnement de l'application. Il se charge également de parser les variables grâce à env-var afin de les rendre exploitable en javascript (la valeur "true" est convertie en boolean, 1234 en number etc...).

Chaque environnement possède son propre fichier d'override afin d'isoler les différentes configurations.

Pour la gestion et l'execution locale de l'application nous utilisons la bibliothèque dotenv et en local un fichier .env à placer dans le dossier /server.

Ce fichier est privé et n'est pas disponible dans le repository.

Un fichier .env.test peut être placé dans le même dossier pour charger une configuration spécifique à l'exécution des tests.

Conteneurs Docker

Présentation de la configuration Docker

Pour fonctionner ce projet a besoin des éléments dockérisés suivants :

Un serveur Web Nginx jouant le role de reverse proxy, _défini dans le service reverse_proxy du docker-compose_.
Un serveur Node Express, défini dans le service server du docker-compose.
Un réseau _défini dans partage_simplifie_network du docker-compose_.
Une base de donnée mongoDb définie dans le service mongodb du docker-compose.
Une interface Web en React, définie dans le service ui du docker-compose.

Serveur Nodes & Nginx - Reverse Proxy

Le serveur nginx joue le role de reverse proxy sur le port 80.

Le serveur Web Node Express utilise le port 5000.

Dans la configuration de nginx, on fait référence au fichier /reverse_proxy/app/nginx/conf.d/locations/api.inc qui définir la gestion de l'API Node Express.

Base de données MongoDb

Le base de données est une MongoDb et utilise le port par défaut 27017.

Ui - React

L'interface web est une application React crée à partir du cli create-react-app (cf: https://create-react-app.dev/)

L'application implémente le design system de l'État Français https://gouvfr.atlassian.net/wiki/spaces/DB/overview?homepageId=145359476 grâce à un theme propagé par ChakraUI (https://chakra-ui.com/docs/theming/customize-theme).

Ajout d'un fichier d'environnement .env

Pour créer la stack et monter l'environnement il est nécessaire de disposer d'un fichier d'environnement .env à la racine du projet /server. Il est possible de créer ce fichier à partir du fichier exemple : .env.example et en remplissant les données propres à votre environnement local.

Démarrage de la stack

Pour créer la stack et monter l'environnement il suffit de lancer la commande suivante depuis le répertoire /server :

yarn docker:start

Arret de la stack

Il est possible de stopper les conteneur en lancant la commande suivante depuis le répertoire /server :

yarn docker:stop

Suppression de la stack

Pour supprimer l'ensemble de la stack et tuer tous les conteneurs il suffit de lancer la commande suivante depuis le répertoire /server :

yarn docker:clean

Vérification du montage de la stack

Aprés avoir créé la stack pour vérifier que les conteneurs sont bien présents vous pouvez lancer la commande suivante depuis le répertoire /server :

docker exec -t -i partage_simplifie_server /bin/bash

De même pour consulter la liste des fichiers dans le docker :

docker exec partage_simplifie_server bash -c 'ls'

Migrations

Le projet utilise migrate-mongo. Les migrations se trouvent dans le répertoire /server/src/migrations

Pour créer une migration :

yarn migration:create ma-nouvelle-migration

Pour jouer les migrations :

yarn migration:up

Après chaque migration réussie migrate-mongo stocke dans la collection Mongo changelog une référence permettant de versionner le processus et ne pas rejouer à chaque fois toutes les migrations.

Les nouvelles migrations sont exécutées automatiquement à chaque déploiement.

Linter

Un linter (via ESLint) est mis en place dans le projet, pour le lancer :

yarn lint

Tests

Des tests sont mis en place en utilisant le framework Mocha.

Pour en savoir plus sur Mocha : https://mochajs.org/

Les tests sont en règle général découpés en 3 dossiers :

Le dossier /server/tests/unit contient la liste des tests unitaires.
Le dossier /server/tests/integration contient la liste des tests d'intégration
Le dossier /server/tests/utils contient la liste des utilitaires communs de test.

Server Node Express

Http

La structure principale du serveur Node Express est définie dans /server/src/http et contient :

La liste des middlewares express à appliquer
La liste des routes d'API
Le point d'entrée principal du serveur : /server/src/http/server.js

Logger

Pour la gestion des logs nous utilisons la librairie bunyan cf : https://www.npmjs.com/package/bunyan

Par défaut 3 stream sont configurés :

Dans la console.
Dans un fichier JSON.
Dans une chaine Slack.

Pour mettre en place les notifications Slack il est nécessaire d'utiliser les Webhooks et de créer une chaine dédiée dans votre espace de travail Slack.

Il vous faudra créer une application dans Slack et récupérer le lien de la Webhook, pour en savoir plus : https://api.slack.com/messaging/webhooks.

Utilitaires

Certains modules utilitaires sont présents dans /server/src/common/utils

Composants injectables

Un module permettant de contenir des composants "communs" et injectable dans les routes est proposé dans le fichier /server/src/common/components/components.js

Vous pouvez ajouter dans ce fichier des élements communs à réexploiter dans l'API.

Debugger sous VSCode

Il est possible de débugger facilement le serveur Express contenu dans le Docker local sous VSCode en utilisant la configuration suivante _a placer dans le fichier /.vscode/launch.json :

{
  "version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "attach",
      "name": "Debug Express in docker",
      "address": "127.0.0.1",
      "port": 9229,
      "localRoot": "${workspaceFolder}/server/src",
      "remoteRoot": "/app/src",
      "skipFiles": ["<node_internals>/**"]
    }
  ]
}

Cette configuration va utiliser la commande debug définie dans le fichier /server/package.json :

{
  "scripts": {
    "debug": "nodemon --inspect=0.0.0.0 --signal SIGINT --ignore tests/ src/index.js"
  }
}

Workflows & CI / CD

Dans le repertoire /.github/workflows sont définie les Github actions à mettre en place sur le repository.

Le workflow principal est définie dans /.github/workflows/yarn-ci.yml et se charge à chaque push sur une branche de :

Vérifier l'installation des dépendances
Lancer le linter
Exécuter les tests unitaires.

Jobs & Procédure de déploiement de l'application

Pour executer un job, que ce soit en local ou sur un des environnement (production / recette) il est recommandé d'executer les commandes dans le conteneur docker partage_simplifie_server.

Jobs de suppression des données

Il est possible de supprimer les données en base de plusieurs manières :

Pour supprimer toutes les données en base :

docker exec -t -i partage_simplifie_server bash -c 'yarn clear:all'

Pour supprimer uniquement les documents dossiersApprenants en base :

docker exec -t -i partage_simplifie_server bash -c 'yarn clear:dossiersApprenants'

Pour supprimer uniquement les logs (+usersEvents) en base :

docker exec -t -i partage_simplifie_server bash -c 'yarn clear:logs'

Pour supprimer uniquement les users (+ usersEvents) en base :

docker exec -t -i partage_simplifie_server bash -c 'yarn clear:users'

Jobs d'alimentation des données

Il est possible d'alimenter la base de donneés avec des données de réferences / test :

Pour ajouter les users par défaut :

docker exec -t -i partage_simplifie_server bash -c 'yarn seed:users'

Pour ajouter des documents dossiersApprenants de test en base :

docker exec -t -i partage_simplifie_server bash -c 'yarn seed:sample'

Pour ajouter des dossiersApprenants randomisés en base :

docker exec -t -i partage_simplifie_server bash -c 'yarn seed:randomizedSample'

Pour ajouter les données de reférences des CFAs et leurs réseaux :

docker exec -t -i partage_simplifie_server bash -c 'yarn seed:referentielCfas'

Jobs de vérification et clean des données

Pour valider et marquer les SIRET des dossiersApprenants en base :

docker exec -t -i partage_simplifie_server bash -c 'yarn siret:check-validity'

Pour valider et marquer les UAI des dossiersApprenants en base :

docker exec -t -i partage_simplifie_server bash -c 'yarn uai:check-validity'

Pour clean les SIRET invalides (comportant espaces et points) en base :

docker exec -t -i partage_simplifie_server bash -c 'yarn siret:sanitize'

Pour tenter de retrouver les SIRET manquants grâce à une table de correspondance UAI/SIRET fournie par Gesti en base :

docker exec -t -i partage_simplifie_server bash -c 'yarn siret:retrieve-gesti'

Pour tenter de retrouver les SIRET manquants sur les dossiersApprenants provenant de Ymag grâce aux UAI déjà présents en base :

docker exec -t -i partage_simplifie_server bash -c 'yarn siret:retrieve-ymag'

Pour tenter de retrouver les infos de localisation des établissements en base grâce au SIRET et à l'API Tables Correspondances :

docker exec -t -i partage_simplifie_server bash -c 'yarn etablissements-location:retrieve'

Pour tenter de retrouver les infos de réseau des établissements en base grâce au SIRET ou les UAI via la collection referentiel des cfas :

docker exec -t -i partage_simplifie_server bash -c 'yarn etablissements-networks:retrieve'

Procédure à suivre au premier déploiement

Dès le premier déploiement de l'application est recommandé de suivre la procédure suivante :

Affichage des stats pour vérifier que la base de données est vide.
Seed des users défaut si pas déja fait
Run des migration 'yarn migration:up' si non fait par Ansible
Création des indexs 'yarn indexes:create' si non fait par Ansible
Lancement des jobs : 5.1 - Création du référentiel des cfas :
```
docker exec -ti partage_simplifie_server bash -c 'yarn seed:referentielCfas'
```
5.2 - Récupération des sirets depuis Gesti 'yarn siret:retrieve-gesti'
```
docker exec -ti partage_simplifie_server bash -c 'yarn siret:retrieve-gesti'
```
5.3 - Récupération des sirets depuis YMag 'yarn siret:retrieve-ymag'
```
docker exec -ti partage_simplifie_server bash -c 'yarn siret:retrieve-ymag'
```
5.4 - Sanitize des sirets 'yarn siret:sanitize'
```
docker exec -ti partage_simplifie_server bash -c 'yarn siret:sanitize'
```
5.5 - Vérification des validité de siret 'yarn siret-uai:check-validity'
```
docker exec -ti partage_simplifie_server bash -c 'yarn siret-uai:check-validity'
```
5.6 - Recherche des infos de localisation des établissements 'yarn dossiersApprenants:retrieve-location'
```
docker exec -ti partage_simplifie_server bash -c 'yarn dossiersApprenants:retrieve-location'
```
5.7 - Recherche des infos de réseaux des établissements 'yarn dossiersApprenants:retrieve-networks'
```
docker exec -ti partage_simplifie_server bash -c 'yarn dossiersApprenants:retrieve-networks'
```
5.8 - Recherche des codes CFD des formations 'yarn formation:retrieve-from-cfd'
```
docker exec -ti partage_simplifie_server bash -c 'yarn formation:retrieve-from-cfd'
```
5.9 - Mise à jour des niveau des dossiersApprenants - dépend des codes CFD des formations (5.8) 'yarn dossiersApprenants:retrieve-niveaux'
```
docker exec -ti partage_simplifie_server bash -c 'yarn dossiersApprenants:retrieve-niveaux'
```
5.10 - Mise à jour des branchements des données des CFAs 'yarn cfas:retrieve-data-connection'
```
docker exec -ti partage_simplifie_server bash -c 'yarn cfas:retrieve-data-connection'
```

Script d'identification des doublons

Il est possible de lancer un script d'identification de différents types de doublons.

Ce script prend en arguments :

duplicatesTypeCode : types de doublons à identifier : 1/2/3/4
mode : forAll / forUai le script va se lancer pour toute la base ou un uai
uai : si mode forUai actif, permet de préciser l'uai souhaité
allowDiskUseMode : si mode allowDiskUseMode actif, permet d'utiliser l'option d'aggregation MongoDb allowDiskUse https://docs.mongodb.com/manual/reference/method/db.collection.aggregate/

Exemple, identifier les doublons de type 1 (même combinaison prenom_apprenant/nom_apprenant/uai_etablissement/formation_cfd) sur toute la base :

docker exec -ti partage_simplifie_server bash -c 'yarn support:identify-dossiersApprenants-duplicates --duplicatesTypeCode 1 --mode forAll'

Exemple, identifier les doublons de type 2 (même combinaison prenom_apprenant/nom_apprenant/uai_etablissement mais formation_cfd différent) sur l'UAI 1234X avec l'utilisation d'allowDiskUse :

docker exec -ti partage_simplifie_server bash -c 'yarn support:identify-dossiersApprenants-duplicates --duplicatesTypeCode 2 --mode forUai --uai 1234X --allowDiskUse'

Script de suppression des doublons

Il est possible de lancer un script de suppression de différents types de doublons. Les dossiersApprenants en doublons les moins récents seront supprimés et archivés dans la collection dossiersApprenantsDuplicatesRemoved

Ce script prend les mêmes arguments que le script d'identification :

duplicatesTypeCode : types de doublons à identifier : 1/2/3/4
mode : forAll / forUai le script va se lancer pour toute la base ou un uai
uai : si mode forUai actif, permet de préciser l'uai souhaité
allowDiskUseMode : si mode allowDiskUseMode actif, permet d'utiliser l'option d'aggregation MongoDb allowDiskUse https://docs.mongodb.com/manual/reference/method/db.collection.aggregate/

Exemple, supprimer les doublons de type 1 (même combinaison prenom_apprenant/nom_apprenant/uai_etablissement/formation_cfd) sur toute la base :

docker exec -ti partage_simplifie_server bash -c 'yarn support:remove-dossiersApprenants-duplicates --duplicatesTypeCode 1 --mode forAll'

mission-apprentissage / partage-simplifie

readme