jbruned / poll-app Goto Github PK

• #2
• Recoger buenas prácticas
  • Gestión de ramas, tags (releases), etc.

Si se activa PostgreSQL no se pueden mostrar las opciones ni votar.
Es por los group by, al parecer no se puede hacer lo mismo en SQLite que en Postgre.

Error mostrado en el contenedor postgres al obtener polls:

poll-app-database-1  | 2023-03-26 11:46:58.150 UTC [43] ERROR:  column "answers.id" must appear in the GROUP BY clause or be used in an aggregate function at character 42
poll-app-database-1  | 2023-03-26 11:46:58.150 UTC [43] STATEMENT:  SELECT count(*) AS count_1
poll-app-database-1  |  FROM (SELECT answers.id AS answers_id, answers.option_id AS answers_option_id, answers.session_id AS answers_session_id, answers.timestamp AS answers_timestamp
poll-app-database-1  |  FROM answers JOIN options ON options.id = answers.option_id
poll-app-database-1  |  WHERE options.poll_id = 1 GROUP BY options.id) AS anon_1
poll-app-database-1  | 2023-03-26 11:46:58.154 UTC [43] ERROR:  column "answers.id" must appear in the GROUP BY clause or be used in an aggregate function at character 42
poll-app-database-1  | 2023-03-26 11:46:58.154 UTC [43] STATEMENT:  SELECT count(*) AS count_1
poll-app-database-1  |  FROM (SELECT answers.id AS answers_id, answers.option_id AS answers_option_id, answers.session_id AS answers_session_id, answers.timestamp AS answers_timestamp
poll-app-database-1  |  FROM answers JOIN options ON options.id = answers.option_id
poll-app-database-1  |  WHERE options.poll_id = 1 GROUP BY options.id) AS anon_1

Enlaces relacionados:

• https://stackoverflow.com/questions/74568753/the-sqliite-db-query-is-not-working-in-postgresql-db
• https://stackoverflow.com/questions/70658424/sqlite-query-not-working-when-trying-to-run-the-same-query-in-postgresql
• https://stackoverflow.com/questions/62140252/sqlalchemy-query-works-on-sqlite-but-gives-error-on-postgresql-column-must-appe
• https://stackoverflow.com/questions/6005417/sql-query-with-group-by-works-on-sqlite-and-not-on-postgresql
• https://stackoverflow.com/questions/66497741/sql-group-by-that-works-in-sqlite-does-not-work-in-postgres

Importante: no poner API key en HTML ni siquiera para RFI II

Comunicar los Dockers principales de la aplicación: back y BDD

• Crear Docker Compose que construya y levante todos los contenedores
• Permitir la comunicación entre los contenedores
• Utilizar variables de entorno

Tareas:

• Crear fase de test en el pipeline
• Implementar funcionalidad de testing

Configurar pipelines básicas que se lancen de forma automática.
Posteriormente se añadirán fases como linting, testing, build...

Tareas:

• Habilitar CORS. Como ahora no todo está en localhost se obtienen errores CORS al comunicar el front con el back en Docker.
• Utilizar variables de entorno en el front y en la app de Flask
• Probar front con back en Docker

Tareas:

• Crear md RFI III que servirá de apoyo en la presentación
• Dejar AWS funcionando para la demo

• Crear pdf a partir del md del RFI II
• Generar fichero zip con la documentación relativa al RFI II y la release correspondiente

Tareas:

• ADR arquitectura (capas, aplicaciones, etc.)
• ADR microservicios (contenedores creados, qué hay en ellos, comunicación y uso en entorno local)
• ADR seguridad (autenticación)

• Servidor básico que muestre una página estática
• Implementacion de los endpoints definidos en #3

Tareas:

• Investigar Linters
• Crear una Github Action para aplicar el linting. Alcance: push y pull request a main.
• Asegurar la instalación local de linters para minimizar errores
• Configurar linters

Preparar la presentación del RFI II

Tareas:

• Crear documento .md que servirá como soporte para exponer el RFI II
• Preparar lo necesario para la demo del sistema

Crear Dockers independientes para:

• BDD PostgreSQL
• Aplicación Flask
• API Gateway Kong

• Crear proyecto de React vacío
• Diseñar página básica
• Llamadas a API endpoints (v1)

• Sustituir SQLite por PostgreSQL

Un script podría ser útil para generar las tablas de contenido (TOC en inglés) de forma automática para los ficheros Markdown. He aquí un ejemplo:
Script de ejemplo

Otra opción podría ser su conversión a PDF.

• Terminar colecciones Postman
• Exportar, por ejemplo en formato JSON

Blocked by #47, #48, #11, #50

Implementar un sistema de login y gestión de sesiones. Tareas:

• Registro de usuarios
• Login con usuario y contraseña
• Uso de tokens para gestionar la sesión
• Logout
• Implementación mediante librerías como pyJWT, Flask-JWT, Flask-JWT-Extended, etc.

Enlaces de interés:

• https://geekflare.com/securing-flask-api-with-jwt/
• https://blog.teclado.com/api-key-authentication-with-flask/
• https://realpython.com/token-based-authentication-with-flask/
• https://www.loginradius.com/blog/engineering/guest-post/securing-flask-api-with-jwt/

• Crear Workspace compartida en Postman
• Crear una colección Postman de la API (v1) del proyecto
• Posible automatización utilizando flask2postman Descartada de momento

Importante: las variables de entorno necesitan tener valor actual

Crear una poll por JSON da error en postman.
Si se crea con form-data da error como respuesta pero se crea.

El cliente React da error en consola constantemente en Home.
Pese a ello, funciona correctamente.

• Definir API utilizando Swagger, Postman o similar

Crear ADRs de:

• CI/CD
• Infraestructura AWS + presupuesto

Requerir API token para algunos endpoints (por ejemplo, crear/borrar encuestas o añadir opciones). Aspectos a tener en cuenta:

• Probablemente pueda hacerse con el plugin de Key Authentication Plugin

• Podría ser necesario cambiar del modo DB-Less al modo con BDD. Ya hemos sido capaces de ejecutar Kong en este modo, por lo que no debería ser complicado si se diera el caso.

• Descargar e instalar Kong
• Configurar Kong
• Implementar Autenticación
• Implementar Autorización
• Implementar Logging
• Probar funcionamiento

• Analizar requisitos del sistema solicitado para el RFI II
• Diseñar arquitectura del sistema. Microservicios.

Cuando se obtienen las opciones de BDD no se está devolviendo JSON, con lo que la API no es coherente en todos los endpoints.
Probar con Postman para replicarlo.