Variables de entorno

Las variables de entorno le permiten agregar variables al proceso de la aplicación que se ejecute en un entorno, sin tener que cambiar el código. Las variables de entorno se almacenan de forma segura, lo que hace que sean ideales casos de uso como los siguientes:

• Claves API para integraciones de terceros
• Indicadores de características para lógica de la aplicación
• Configuración que difiere entre entornos o que puede no ser secreta

Siga estos tutoriales para establecer variables de entorno y, a continuación, implementar código en el sitio de PWA Kit para usar las variables. Puede personalizar el código de acuerdo con sus requisitos específicos. En los tutoriales se muestra cómo:

• Acceso a recursos protegidos con variables de entorno
• Uso de variables de entorno en React.js

Se recomienda probar los pasos en el equipo local y, a continuación, en un entorno que no sea de producción antes de implementar los cambios en producción. Para obtener más instrucciones, consulte Mejores prácticas Solución de problemas de variables de entorno, y Depuración local.

Variables de entorno

• Se puede administrar mediante la API Managed Runtime o Runtime Admin
• Se accede a ellos en Node.js usando process.env

Cuando introduzca una nueva variable de entorno, primero configúrela a través de la API o el administrador del tiempo de ejecución. Espere hasta que se complete la reimplementación y, a continuación, implemente un nuevo paquete que lo use.

Establecer, actualizar y anular la configuración de variables de entorno

Use projects_target_env_var_partial_update:

Para desconfigurar una variable de entorno existente, establezca su valor como null.

Al modificar las variables de entorno, se vuelve a implementar el entorno. Los valores actualizados están disponibles cuando se completa la implementación.

Obtener todas las variables de entorno

Use projects_target_env_var_list:

Para crear, actualizar, eliminar o ver variables de entorno:

1. Inicie sesión en Runtime Admin. Para obtener acceso a Runtime Admin, consulte Administraciónde tiempo de ejecución administrado.
2. Vaya a la página Overview (Visión general) del proyecto.
3. Haga clic en el nombre del entorno para el que desea administrar las variables de entorno.
4. Haga clic en Variables de entorno en el panel de navegación izquierdo.

• Seleccione nombres de variables de entorno que tengan sentido para su aplicación. Usa nombres descriptivos: Elija nombres claros y concisos para las variables de entorno para que sean fácilmente comprensibles para su equipo.
• Evite codificar información confidencial, como claves de API, en su código. Use variables de entorno para mantenerlas seguras.
• No pase variables de entorno a datos que se serializarán en la página. Considere la posibilidad de agregar una prueba para asegurarse de que no está filtrando datos de variables de entorno.
• No devuelva variables de entorno de enlaces react-query getProps o react-query.
• Use variables de entorno solo del lado del servidor. De forma predeterminada, las variables de entorno no se exponen del lado del cliente. Puede optar por exponerlos del lado del cliente (por ejemplo, en el archivo de configuración), pero asegúrese de que exponer los valores cumpla con sus prácticas de seguridad.
• Pruebe las variables de entorno en el equipo local y, a continuación, en un entorno que no sea de producción antes de implementarlas en producción. Esto ayuda a garantizar que pueda resolver rápidamente los problemas a nivel local y, a continuación, simular el comportamiento del sitio, validar la funcionalidad y realizar pruebas de aceptación del usuario antes de implementarlos en producción.
• Incluya el control de errores en el código que usa variables de entorno para evitar errores debidos a variables de entorno indefinidas.
• Controle el acceso a las variables de entorno para evitar modificaciones no autorizadas.
• Documente el propósito y la configuración de cada variable de entorno. Esto ayuda a incorporar nuevos desarrolladores y solucionar problemas.

El uso de las variables de entorno está sujeto a las siguientes restricciones:

• Los valores de las variables de entorno deben ser cadenas. Para almacenar valores complejos, codifique JSON en una cadena.
• Cada entorno tiene un límite de 100 variables de entorno.
• El tamaño máximo de los valores de las variables de entorno configuradas para un entorno es 32 kb.
• Los nombres de las variables de entorno deben tener 512 caracteres o menos, y no pueden comenzar con los prefijos reservados: AWS, MRT, X_MRT, MOBIFY, X_MOBIFY, SSR_PROXY, NODE.
• Los nombres de las variables de entorno no pueden utilizar ningún nombre reservado: 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.

En esta sección se proporcionan soluciones sugeridas para errores comunes que pueden surgir al usar variables de entorno.

El código arroja una Error indicación de que falta una variable.

Causa: La variable de entorno a la que llama el código no está establecida.

Solución sugerida: Llame al punto de conexión de la projects_target_env_var_partial_update API para establecer la variable de entorno aplicable.

El código registra un mensaje de error que indica que no se encontró la variable de entorno.

Causa: El código no pudo encontrar la variable de entorno porque hay un error tipográfico en el código o se usa un nombre de variable de entorno incorrecto.

Solución sugerida: Confirme que ha escrito correctamente el nombre de la variable de entorno en el código y que ha utilizado el nombre de la variable de entorno deseado. Compruebe el nombre de la variable de entorno llamando al punto de conexión de la projects_target_env_var_list API para ver la lista completa de variables establecidas.

Se produce un error en la llamada a la API para establecer una variable de entorno.

Causa: Es posible que el nombre de la variable de entorno no cumpla con las restricciones. Por ejemplo, el tamaño del valor de una variable de entorno es superior a 32 KB.

Solución sugerida: Confirme que la variable de entorno cumple con las restricciones.

Los errores de autenticación se producen cuando se ejecuta código que implica el uso de una clave de API.

Causa: La clave de API que utilizó al establecer la variable de entorno no tiene el formato esperado o no está en el formato esperado.

Solución sugerida: Confirme que la clave de API almacenada por una variable de entorno sea correcta. Si es necesario, llame al punto de conexión de la projects_target_env_var_partial_update API para corregir la clave de la API.

Se produce un error de red en una fetch solicitud.

Causa: Es posible que una URL para cualquier punto de conexión de API llamado en su código no se haya definido correctamente o no sea válida. Por ejemplo, la URL de un punto de conexión del sistema de administración de contenido (CMS) es incorrecta.

Solución sugerida: Confirme que las URL de los puntos de conexión de la API en el código sean correctas.