Skip to content

✨ feat: use .env file for API url#100

Merged
caverav merged 5 commits intodevelopmentfrom
feature/99-dotenv
Sep 21, 2024
Merged

✨ feat: use .env file for API url#100
caverav merged 5 commits intodevelopmentfrom
feature/99-dotenv

Conversation

@caverav
Copy link
Copy Markdown
Owner

@caverav caverav commented Sep 17, 2024

Descripción

Se agrega el uso de variables de entorno para las URLs de la API

Motivación y Contexto

Está mal hardcodear las URLs, fixes #99

¿Cómo ha sido probado?

Probar el flujo de la aplicación, funcionando correctamente las llamadas a la API

Tipos de cambios

  • Bugfix (cambio que no interrumpe el funcionamiento y que soluciona un problema)
  • New feature (cambio que no interrumpe el funcionamiento y que añade funcionalidad)
  • Breaking change (corrección o funcionalidad que podría causar que la funcionalidad existente cambie)

Lista de verificación:

  • Mi código sigue el estilo de código de este proyecto.
  • Mi cambio requiere una modificación en la documentación.
  • He actualizado la documentación en consecuencia.
  • Requiere nuevos tests.

Summary by CodeRabbit

  • Nuevas Funciones

    • Se ha añadido un archivo .env.example que proporciona una plantilla de configuración para las variables de entorno, facilitando la configuración del entorno de desarrollo.
    • Se ha mejorado la integración con Docker al incluir el archivo .env en el proceso de construcción del contenedor.
  • Mejoras

    • Se han actualizado múltiples archivos para utilizar variables de entorno en lugar de URLs codificadas, mejorando la flexibilidad y la capacidad de adaptación a diferentes entornos (desarrollo, staging, producción).
  • Correcciones

    • Se han realizado ajustes de formato para mejorar la legibilidad del código en varias funciones.

@caverav caverav added the enhancement New feature or request label Sep 17, 2024
@caverav caverav self-assigned this Sep 17, 2024
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Sep 18, 2024

Walkthrough

Walkthrough

Se han realizado cambios significativos en el código del frontend para implementar el uso de variables de entorno, específicamente para la configuración de URLs de servicios. Se ha añadido un archivo .env.example como plantilla, y se ha modificado el Dockerfile para incluir el archivo .env. Además, se han actualizado múltiples archivos para que utilicen variables de entorno en lugar de URLs codificadas, mejorando así la flexibilidad del entorno de desarrollo y despliegue.

Changes

Archivos Resumen de cambios
.gitignore, frontend/.env.example, frontend/Dockerfile Se añadió .env al .gitignore, se creó un archivo .env.example con la variable API_URL, y se actualizó el Dockerfile para copiar el archivo .env en la imagen de Docker.
frontend/src/hooks/useAuth.tsx, frontend/src/routes/audits/edit/AuditRoot.tsx, frontend/src/services/audits.ts, frontend/src/services/data.ts, frontend/src/services/settings.ts, frontend/src/services/vulnerabilities.ts Se modificaron las constantes API_URL y se reemplazaron las URLs codificadas por referencias a import.meta.env.VITE_API_URL, mejorando la adaptabilidad del código a diferentes entornos.

Assessment against linked issues

Objetivo Abordado Explicación
Uso de variables de entorno para IP's/puertos (#[99])
Implementación de un archivo .env en el frontend (#[99])
Modificación del endpoint en la función de logout (#[99]) No se menciona un cambio específico en la función de logout.

Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 24a75e8 and 314aaf1.

Files selected for processing (1)
  • frontend/src/routes/profile/profile.tsx (1 hunks)
Additional comments not posted (2)
frontend/src/routes/profile/profile.tsx (2)

50-50: Excelente uso de variables de entorno para la URL de la API

El cambio a import.meta.env.VITE_API_URL mejora la flexibilidad y facilita la configuración en diferentes entornos. ¡Buen trabajo!


50-50: Asegurar la definición de VITE_API_URL en todos los entornos

Es importante confirmar que la variable de entorno VITE_API_URL esté definida en todos los entornos de ejecución para evitar errores en tiempo de ejecución.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    -- @coderabbitai generate unit testing code for this file.
    -- @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    -- @coderabbitai generate interesting stats about this repository and render them as a table.
    -- @coderabbitai read src/utils.ts and generate unit testing code.
    -- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    -- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.
Early access features: enabled

We are currently testing the following features in early access:

  • OpenAI o1 for code reviews: OpenAI's new o1 model is being tested for code reviews. This model has advanced reasoning capabilities and can provide more detailed feedback on your code.

Note:

  • You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 1a41b84 and 24a75e8.

Files selected for processing (9)
  • .gitignore (1 hunks)
  • frontend/.env.example (1 hunks)
  • frontend/Dockerfile (1 hunks)
  • frontend/src/hooks/useAuth.tsx (3 hunks)
  • frontend/src/routes/audits/edit/AuditRoot.tsx (4 hunks)
  • frontend/src/services/audits.ts (1 hunks)
  • frontend/src/services/data.ts (2 hunks)
  • frontend/src/services/settings.ts (1 hunks)
  • frontend/src/services/vulnerabilities.ts (1 hunks)
Additional comments not posted (9)
frontend/.env.example (1)

1-1: Archivo de ejemplo .env.example agregado correctamente

La inclusión del archivo de ejemplo .env.example facilita la configuración del entorno para otros desarrolladores. Buen trabajo al proporcionar una plantilla clara.

.gitignore (1)

12-12: Se agregó .env al .gitignore

Es una buena práctica excluir el archivo .env del control de versiones para proteger información sensible. Bien hecho.

frontend/src/services/settings.ts (1)

1-1: Uso adecuado de variables de entorno para API_URL

La actualización permite configurar la URL de la API según el entorno, lo cual mejora la flexibilidad de la aplicación. Excelente implementación.

frontend/src/hooks/useAuth.tsx (1)

4-5: Actualización de endpoints para usar variables de entorno

Las modificaciones reemplazan URLs hardcodeadas con variables de entorno, mejorando la configurabilidad y el mantenimiento del código. Buen trabajo al asegurar que las llamadas a la API utilicen VITE_API_URL.

Also applies to: 39-46, 61-67

frontend/src/routes/audits/edit/AuditRoot.tsx (1)

79-81: Actualización de rutas de generación de documentos con variables de entorno

Has reemplazado correctamente las URLs directas con variables de entorno, permitiendo mayor flexibilidad en diferentes entornos. Bien hecho.

Also applies to: 89-91, 99-101, 109-111

frontend/src/services/vulnerabilities.ts (1)

1-1: Excelente implementación de variables de entorno para el API_URL.

Esto mejora la flexibilidad y facilita la configuración en diferentes entornos.

frontend/src/services/data.ts (2)

1-1: Buena práctica al utilizar variables de entorno para API_URL.

Esto permite una configuración más flexible entre diferentes entornos.


428-428: Buen ajuste al utilizar API_URL en la función downloadTemplate.

Esto asegura que la URL de descarga también sea configurable según el entorno.

frontend/src/services/audits.ts (1)

1-1: Excelente actualización al utilizar variables de entorno para API_URL.

Esto mejora la flexibilidad y facilita el despliegue en múltiples entornos.

Comment thread frontend/Dockerfile
@jllanosg
Copy link
Copy Markdown
Collaborator

xq la url debe ir con el nombre VITE_API_URL?

Copy link
Copy Markdown
Collaborator

@jllanosg jllanosg left a comment

Choose a reason for hiding this comment

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

funca

@caverav
Copy link
Copy Markdown
Owner Author

caverav commented Sep 21, 2024

xq la url debe ir con el nombre VITE_API_URL?

Se explica bien en la documentación (https://vitejs.dev/guide/env-and-mode) pero básicamente las variables iniciadas en VITE_ se exponen al cliente, cualquier otra no

@caverav caverav merged commit b1dc052 into development Sep 21, 2024
@coderabbitai coderabbitai Bot mentioned this pull request Sep 23, 2024
7 tasks
@iTzGooDLife iTzGooDLife deleted the feature/99-dotenv branch September 24, 2024 03:26
@coderabbitai coderabbitai Bot mentioned this pull request Sep 24, 2024
7 tasks
This was referenced Oct 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants