Variables d’environnement

Les variables d’environnement vous permettent d’ajouter des variables dans le processus d’application exécuté dans un environnement, sans avoir à modifier le code. Les variables d’environnement sont stockées de façon sécurisée. Elles sont donc idéales pour des cas d’utilisation tels que :

Clés API pour les intégrations de tierces parties
Indicateurs de fonctionnalités pour la logique d’application
Configuration qui diffère d’un environnement à l’autre ou qui n’est peut-être pas secrète

Les variables d’environnement ne sont accessibles que dans le serveur d’applications. Elles ne peuvent pas modifier le comportement des services périphériques, y compris les proxys et les fonctions périphériques.

Note

Prérequis

Vous devez avoir un rôle de développeur ou d’administrateur sur le projet pour lequel vous gérez les variables d’environnement. Si vous n’y avez pas accès, demandez à quelqu’un disposant du rôle d’administrateur Managed Runtime (MRT) de vous aider.

Tutoriels

Suivez ces tutoriels pour définir les variables d’environnement, puis implémentez le code de votre site PWA Kit pour utiliser les variables. Vous pouvez personnaliser le code en fonction de vos besoins spécifiques. Les tutoriels vous montrent comment :

Nous vous recommandons de tester les étapes sur votre ordinateur local, puis dans un environnement hors production avant de déployer vos modifications en production. Pour plus d’informations, consultez Meilleures pratiques, Résoudre les problèmes liés aux variables d’environnement et Débogage local.

Gérer les variables d’environnement

Variables d’environnement :

Peut être géré à l’aide de l’API Managed Runtime ou de Runtime Admin
Sont accessibles dans Node.js à l’aide de process.env

Lorsque vous introduisez une nouvelle variable d’environnement, définissez-la d’abord via l’API ou Runtime Admin. Attendez la fin du redéploiement, puis déployez un nouveau paquet qui l’utilise.

Utiliser l’API Managed Runtime

Définir, mettre à jour et annuler les variables d’environnement

Utilisez projects_target_env_var_partial_update :

1curl "https://cloud.mobify.com/api/projects/$PROJECT/target/$ENVIRONMENT/env-var/" \
2  --request 'PATCH' \
3  --header 'Content-Type: application/json' \
4  --header 'Accept: application/json' \
5  --header "Authorization: Bearer $MOBIFY_API_KEY" \
6  --data '{
7    "API_KEY": {"value": "b3Blbi1zZXNhbWU="},
8    "STOREFRONT_CONFIG": {"value": "{\"showBuyNowButton\": false}"},
9    "SLAS_CLIENT_ID": {"value": "da422690-7800-41d1-8ee4-3ce983961078"}
10}'

Pour supprimer une variable d’environnement, définissez sa valeur sur null.

La modification des variables d’environnement redéploie l’environnement. Les valeurs mises à jour sont disponibles à la fin du déploiement.

Obtenir toutes les variables d’environnement

Utilisez projects_target_env_var_list :

1curl "https://cloud.mobify.com/api/projects/$PROJECT/target/$ENVIRONMENT/env-var/" \
2  --header "Authorization: Bearer $MOBIFY_API_KEY" \
3  --header 'Accept: application/json'

Utiliser Runtime Admin

Pour créer, mettre à jour, supprimer ou afficher des variables d’environnement :

Connectez-vous à Runtime Admin. Pour accéder à Runtime Admin, reportez-vous à la section Managed Runtime.
Accédez à la page Overview d’un projet.
Cliquez sur le nom de l’environnement pour lequel vous souhaitez gérer les variables d’environnement.
Cliquez sur Environment Variables dans le volet de navigation de gauche.

Meilleures pratiques

Choisissez des noms de variables d’environnement logiques dans le contexte de votre application. Utilisez des noms descriptifs : choisissez des noms clairs et concis pour vos variables d’environnement afin de les rendre facilement compréhensibles pour votre équipe.
Évitez de coder en dur des informations sensibles telles que des clés API dans votre code. Utilisez des variables d’environnement pour assurer leur sécurité.
Ne transmettez pas les variables d’environnement dans des données qui seront sérialisées sur la page. Envisagez d’ajouter un test pour vous assurer que vous ne divulguez pas de données variables d’environnement.
Ne renvoyez pas de variables d’environnement à partir de hooks getProps react-query.
N’utilisez les variables d’environnement que côté serveur. Par défaut, les variables d’environnement ne sont pas exposées côté client. Vous pouvez choisir de les exposer côté client (par exemple, dans votre fichier de configuration), mais assurez-vous que l’exposition des valeurs est conforme à vos pratiques de sécurité.
Testez vos variables d’environnement sur votre machine locale, puis dans un environnement hors production avant de les déployer en production. Cela vous permet de vous assurer que vous pouvez résoudre rapidement les problèmes localement, puis simuler le comportement du site, valider les fonctionnalités et effectuer des tests d’acceptation par les utilisateurs avant le déploiement en production.
Incluez la gestion des erreurs dans votre code qui utilise des variables d’environnement pour éviter les défaillances dues à des variables d’environnement non définies.
Contrôlez l’accès aux variables d’environnement pour éviter toute modification non autorisée.
Documentez l’objectif et la configuration de chaque variable d’environnement. Cela facilite l’intégration des nouveaux développeurs et le dépannage des problèmes.

Contraintes

L’utilisation des variables d’environnement est soumise aux contraintes suivantes :

Chaque environnement comporte une limite de 100 variables d’environnement.
Les noms de variables d’environnement ne peuvent contenir que des caractères alphanumériques, des traits de soulignement ( _ ) et des tirets ( - ).
Les noms de variables d’environnement ne peuvent pas comporter plus de 512 caractères et ne peuvent pas commencer par des préfixes réservés : AWS, MRT, X_MRT, MOBIFY, X_MOBIFY, SSR_PROXY, NODE.
Les noms de variables d’environnement ne peuvent pas utiliser les noms réservés : BUNDLE_ID, DEPLOY_ID, DEPLOY_TARGET, EXTERNAL_DOMAIN_NAME, HANDLER, LAMBDA_RUNTIME_DIR, LAMBDA_TASK_ROOT, NODE_ENV, REDIRECT_BUCKET, REDIRECT_KEY, REDIRECT_UPDATE, REMOTE, X_AMZN_TRACE_ID.
Les valeurs des variables d’environnement doivent être des chaînes. Pour stocker des valeurs complexes, encodez JSON dans une chaîne.
La taille des valeurs des variables d’environnement définies pour un environnement ne peut pas dépasser 32 Ko.

Résoudre les problèmes liés aux variables d’environnement

Cette section propose des solutions pour les erreurs courantes que vous pouvez rencontrer lors de l’utilisation de variables d’environnement.

La variable d’environnement n’est pas définie

Votre code génère une Error indiquant qu’une variable est manquante.

Cause : la variable d’environnement appelée par le code n’est pas définie.

Solution suggérée : Appelez le point de terminaison d’API projects_target_env_var_partial_update pour définir la variable d’environnement applicable.

Nom de variable d’environnement incorrect

Votre code consigne un message d’erreur indiquant que la variable d’environnement est introuvable.

Cause : le code n’a pas pu trouver la variable d’environnement car il contient une faute de frappe ou un nom de variable d’environnement incorrect est utilisé.

Solution suggérée : vérifiez que vous avez correctement orthographié le nom de la variable d’environnement dans votre code et que vous avez utilisé le nom de variable d’environnement souhaité. Vérifiez le nom de la variable d’environnement en appelant le point de terminaison d’API projects_target_env_var_list pour afficher la liste complète des variables définies.

Nom de variable d’environnement non pris en charge

Votre appel d’API pour définir une variable d’environnement échoue.

Cause : Le nom de la variable d’environnement peut ne pas respecter les contraintes. Par exemple, la taille de la valeur d’une variable d’environnement est supérieure à 32 Ko.

Solution suggérée : Vérifiez que votre variable d’environnement est conforme aux contraintes.

Format de clé d’API non valide

Des erreurs d’authentification se produisent lorsque vous exécutez du code impliquant l’utilisation d’une clé d’API.

Cause : la clé d’API que vous avez utilisée lors de la définition de la variable d’environnement n’est pas au format attendu ou est manquante.

Solution suggérée : vérifiez que la clé d’API stockée par une variable d’environnement est correcte. Si nécessaire, appelez le point de terminaison d’API projects_target_env_var_partial_update pour corriger la clé d’API.

URL non valide pour un point de terminaison d’API

Une request fetch échoue avec une erreur réseau.

Cause : il est possible que l’URL d’un point de terminaison d’API appelé dans votre code n’ait pas été correctement définie ou qu’elle ne soit pas valide. Par exemple, l’URL d’un point de terminaison de système de gestion de contenu (CMS) est incorrecte.

Solution suggérée : vérifiez que les URL de votre code pour les points de terminaison d’API sont correctes.