Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Partial dump script #3370

Merged
merged 8 commits into from
Jul 23, 2024
Merged

Partial dump script #3370

merged 8 commits into from
Jul 23, 2024

Conversation

silto
Copy link
Collaborator

@silto silto commented Jun 2, 2024

Objectif

Lors d'un bug report lié à un BSD particulier, il peut être compliqué de reproduire localement, car il faut dump toute la db.
Ce script permet de dump un BSD spécifique et de reconstruire tous les objets qui y sont liés (company, user, ...).

Fonctionnement

init

Le script crée 2 clients Prisma, un pour la db "remote" (prod, recette,...) et un pour la db locale.

Récupération des objets

Le BSD d'origine (spécifié par une variable d'env ou lorsque le prompt le demande) est récupéré en premier, puis le script va "traverser" la db récursivement en fonction des relations entre objets qui sont énumérées dans le fichier traversals.ts. Les queries pour chaque type d'objet sont définies dans pipelines.ts (la plupart ont le même format mais certaines diffèrent, par exemple pour des relations many-to-many implicites).
Si lors de cette traversée un objet déjà récupéré est rencontré, il est ignoré (de façon à éviter les boucles infinies).
Une fois tous les chemins arrivés soit à des objets sans relations, soit où toutes les relations sont déjà récupérées, la phase de fetching est finie.

Ecriture des objets

Arrive ensuite la phase d'écriture dans la db locale. Certaines contraintes de foreign key empêchent l'écriture de certains objets tans que d'autres ne sont pas en db. Il est compliqué de définir ce qui doit être écrit en premier, ou de faire une traversée inverse en partant de toutes les branches, donc j'ai choisi une approche plus "brute" qui consiste à essayer d'écrire tous les objets, de retenir ceux qui ont été écrits avec succès, puis de refaire l'écriture en boucle avec les objets ayant échoués précédemment. Après un certain nombre d'itérations, tous les objets devraient pouvoir être écrits.
Dans certains cas (db pas vide, schema pas correct,...) l'écriture de certains objets peut échouer en boucle. Afin d'éviter une boucle infinie, le script vérifie qu'au moins un objet a été écrit en db à chaque tour de boucle. Si ce n'est pas le cas, il s'arrête et signale le problème.

Tests

SonacCloud flag le fichier traversals.ts A cause de la duplication de lignes, mais ça me semble inévitable puisque c'est une liste de relations entre objets. Je pense que ça peut être ignoré.

  • Mettre à jour la documentation
  • Mettre à jour le change log
  • Documenter les manipulations à faire lors de la mise en production (sur le ticket Favro de release)
  • S'assurer que la numérotation des nouvelles migrations est bien cohérente
  • Informer le data engineer de tout changement de schéma DB

Ticket Favro

@silto silto force-pushed the partial-dump branch 4 times, most recently from 15085f4 to 0df69ae Compare June 26, 2024 13:46
Copy link
Collaborator

@Riron Riron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stylé !

libs/back/partial-backup/src/main.ts Outdated Show resolved Hide resolved
libs/back/partial-backup/src/main.ts Show resolved Hide resolved
Copy link

sonarcloud bot commented Jul 23, 2024

Quality Gate Failed Quality Gate failed

Failed conditions
22.8% Duplication on New Code (required ≤ 3%)

See analysis details on SonarCloud

@silto silto merged commit 1a73a7a into dev Jul 23, 2024
16 of 17 checks passed
@silto silto deleted the partial-dump branch July 23, 2024 16:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants