Refacto de l'alert-cli

[m-maillot]

Problématique

Le projet est actuellement en node 14. On souhaite le passer en node 20. Un projet pose problème pour la migration, le projet alert-cli et la dépendance nodegit qui n'est plus mise à jour.

L'objectif ici est de comprendre son utilité et d'identifier les alternatives.

Pourquoi nodegit ?

Voici le workflow d'alert-cli :

• Pour chaque repo dans la table sources, on va effectuer un git clone et récupérer les tags (via nodegit).
• On va ensuite récupérer pour chaque tag, le commit associé (via nodegit)
• On va récupérer les nouveaux tags depuis la version contenu dans la BDD. Par exemple, on a en BDD la version 1.0.0 et on récupère les tags 0.0.9, 1.0.0, 1.0.1 et 1.0.2, on va garder les tags 1.0.1 et 1.0.2.
• Pour chaque tag, on va faire un diff avec le tag précédent.

Pour faire la diff, on va procéder comme suit :

• on fait un diff avec nodegit entre les 2 commits
• on va ensuite récupérer les patches sur le diff

A diff shows the differences between two files, or snapshots, and can be quite minimal in doing so. A patch is an extension of a diff, augmented with further information such as context lines and filenames, which allow it to be applied more widely. It is a text document that describes how to alter an existing file or codebase.

• A partir des patches, on va itérer et utiliser le patch pour savoir si c'est un ajout, suppression ou modification de fichier.

Ensuite, on charge le fichier en json via le path fournit dans le patch et on utilise les json pour détecter les modifications entre les fichiers sans avoir besoin de nodegit.

Donc nodegit est utilisé pour détecter entre 2 tags, les fichiers modifiés et si c'est un ajout, modification ou suppression.

[m-maillot]

Alternative à nodegit

La première idée est de trouver une librairie permettant de réaliser les mêmes opérations que nodegit.

Une rapide recherche montre très peu d'alternatives disponibles et maintenues. Il y a https://github.com/isomorphic-git/isomorphic-git mais il ne supporte pas la méthode diff qui est celle qui nous intéresse.

[m-maillot]

Utilisation de l'API github

L'idée est d'utiliser l'API github pour récupérer la diff entre les tags. On va s'appuyer sur ce type de résultat : SocialGouv/kali-data@v2.563.0...v2.564.0

On peut récupérer le tags ici : https://api.github.com/repos/SocialGouv/kali-data/tags?per_page=30&page=1

Ensuite, on peut obtenir la diff ici : https://api.github.com/repos/SocialGouv/kali-data/compare/v2.563.0...v2.564.0?per_page=30&page=1

on retrouve donc les informations nécessaires pour reproduire le comportement d'aujourd'hui sans nodegit.

[m-maillot]

Utilisation d'un changelog

On utilise actuellement la lib semantic-release. Cette dernière permet de faire un Changelog mais il ne contient que la liste des commits inclues dans la release et non la diff des fichiers.

Semantic-release accepte des plugins dont un qui permet l'exécution de commande (@semantic-release/exec). On pourrait utiliser ces fonctionnalités pour générer un fichier de diff qui serait inclu dans le repo.

Par contre, il faut trouver le moyen de générer une sortie du git diff avec tous les éléments dont on a besoin dans le format JSON. Cela semble assez complexe, j'ai trouvé un exemple pour faire un git log en json : https://gist.github.com/dmegorov/b64dcea2eed31e02c916fc6ed9111f4f#file-git-log2json-sh

[m-maillot]

Ne pas utiliser de diff

Dans cette solution, on va retirer la logique de faire un diff pour récupérer la liste des fichiers modifiés. On va le faire manuellement.

On peut utiliser une lib comme https://www.npmjs.com/package/dir-compare qui va permettre de reproduire une sortie similaire à ce que fait un git diff patch. (https://gliviu.github.io/dc-api/interfaces/Difference.html)