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

Suppression de MODULE_URL de la configuration frontend des modules #2165

Open
bouttier opened this issue Nov 25, 2022 · 1 comment
Open

Suppression de MODULE_URL de la configuration frontend des modules #2165

bouttier opened this issue Nov 25, 2022 · 1 comment
Labels
breaking change refactorisation Retravailler du code pour l’améliorer en profondeur, sans pour autant lui ajouter de nouveautés.
Milestone

Comments

@bouttier
Copy link
Contributor

bouttier commented Nov 25, 2022

En 2.10, la configuration frontend des modules est générée par le backend. Celui-ci reprend le schéma de configuration du module, et y rajoute dynamiquement plusieurs clefs conçu à partir du module issue de la base de données :

  "ID_MODULE": module_object.id_module,
  "MODULE_CODE": module_object.module_code,
  "MODULE_URL": "/" + module_object.module_path.replace(" ", ""),
  "FRONTEND_PATH": str(module_dir / "frontend"),

En 2.11, la configuration frontend est généré sans appelle à la base de données (de manière à pouvoir builder le frontend avant même l’installation de la base de données – utile notamment dans un contexte Docker). De ce fait, les clefs ci-dessus sont supprimée de la configuration frontend générée.

Si vous utilisiez une de ces valeurs dans votre code :

  • ID_MODULE, FRONTEND_PATH : peu probable que vous l’utilisiez, mais usage à supprimer si tel était le cas
  • MODULE_CODE : paramètre toujours disponible, mais voué à disparaître avec la fin de la génération de la config
  • MODULE_URL :
    • Correction rapide : le rajouter dans votre schéma de configuration (exemple de l’import : PnX-SI/gn_module_import@9a2b821)
    • La bonne méthode : le récupérer à partir du ModuleService qui permet d’accéder à l’objet Module et son champs module_path
@bouttier bouttier added refactorisation Retravailler du code pour l’améliorer en profondeur, sans pour autant lui ajouter de nouveautés. breaking change labels Nov 25, 2022
@bouttier bouttier changed the title Suppression de MODULE_URL Suppression de MODULE_URL de la configuration frontend des modules Nov 25, 2022
@bouttier
Copy link
Contributor Author

Une rétro-compatibilité a été introduite pour le paramètre MODULE_URL, celui-ci étant encore très utilisé par les modules : 6f0eec3
Attention : MODULE_URL est définie à "/{module_code.lower()}", et n’est pas récupéré depuis la colonne module_path de l’entrée en bdd comme avant. Si cette valeur ne vous convient pas, il vous faut définir une valeur correcte dans votre config, ou supprimer ce paramètre.

@camillemonchicourt camillemonchicourt added this to the 2.12 milestone Dec 21, 2022
@bouttier bouttier modified the milestones: 2.12, 2.13 Mar 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change refactorisation Retravailler du code pour l’améliorer en profondeur, sans pour autant lui ajouter de nouveautés.
Projects
None yet
Development

No branches or pull requests

2 participants