El microservicio de canciones (ms-songs) es un proyecto desarrollado para la aplicación FastMusik, por el equipo formado por Juan Carlos Cortés Muñoz y Mario Ruano Fernández, en el contexto de la asignatura Fundamentos de Ingeniería del Software (FIS) del Máster en Ingeniería del Software: Cloud, Datos y Gestión TI, de la Universidad de Sevilla (curso académico, 22-23).
Sirva este documento como manifiesto del trabajo realizado por este equipo.
El equipo se presenta al nivel de acabado correspondiente a la máxima calificación de 9, cumpliendo con los requisitos que se lista para tal fin:
- Implementación y cumplimiento de todos los requisitos de microservicio a nivel básico.
- Implementación de requisitos de microservicio a nivel avanzado:
- Implementar frontend con rutas y navegación.
- Implementar pruebas de interfaz de usuario.
- Usar Redux para gestionar el estado de los componentes de React correspondientes al microservicio.
- Consumo de una API externa a través del backend del microservicio (integración con API de Spotify).
- Implementar mecanismo de autenticación basado en JWT.
- Implementación de aplicación a nivel básico, cubriendo diferentes integraciones con otros microservicios:
- Realización de POST al microservicio de soporte ms-support.
- Realización de GET al microservicio de usuarios ms-users.
- Implementación de requisitos de aplicación a nivel avanzado:
- Frontend común
- Uso de API Gateway con funcionalidad avanzada (mecanismo de autenticación).
- Implementación de un mecanismo de autenticación homogéneo para todos los microservicios (a través de la API Gateway, mediante JWT).
Además, se incluye el diseño de un Customer Agreement y princing basado en el análisis de la capacidad realizado. También la documentación de la API REST del microservicio desplegada mediante Swagger, demostración del funcionamiento de la aplicación y presentación para la defensa en el aula.
De forma general, FastMusik es una aplicación de música.
FastMusik presenta gran parte de las características de las redes sociales y las aplicaciones colaborativas. A través de búsquedas en el sistema, los usuarios pueden ir añadiendo canciones a la aplicación, dar likes a aquellas que más les gustan y completar la información de estas añadiendo la letra y el videoclip. Como resultado de la navegación y de ir haciendo diferentes likes, los usuarios podrán comenzar a chatear con otros con sus mismas preferencias musicales.
Además, FastMusik es una aplicación que cuenta con el respaldo de un sistema de soporte, mediante el cual es posible el envío de tickets de incidencias o solicitudes de cambios, así como reportes de mensajes inadecuados que se envían por los chats.
FastMusik se divide en 5 microservicios: usuarios, canciones, mensajería, soporte y, por último, una API Gateway. Todos ellos se integran a través del backend para compartir y complementar la información. Estos se integran a su vez con APIs externas como DeepL, Spotify, SendGrid y PurgoMalum. Por otro lado, en la API Gateway se localizan funciones de centralización de operaciones, principalmente el mapeo de endpoints de los diferentes microservicios, para ser un único punto de consumo para el frontend, y para la autenticación de usuarios y generación de JWT.
El modelado de datos de este microservicio se basa en una única entidad, la que representa a los usuarios, que contiene toda la información necesaria para la gestión de los mismos. Con ella se presentan las siguientes funcionalidades: operaciones CRUD de la entidad, gestión de credenciales, registro y control de usuarios en los clientes y comprobación de texto ofensivo.
Como puntos destacables, está el uso de una API externa, PurgoMalum, para comprobar los textos que se introducen en el sistema; la autenticación que permite el control de la sesión del usuario y la centralización de la información de los usuarios.
Este es el microservicio implementado por Juan Carlos Cortés Muñoz y Mario Ruano Fernández, integrantes del ms-songs.
En lo que respecta a la funcionalidad que ofrece el microservicio ms-songs, en FastMusik, los usuarios podrán buscar canciones, tanto en el sistema como en Spotify, acceder a los videoclips y letras de estas y hacer like en aquellas canciones que más les gusten.
Otras funcionalidades que derivan de este microservicio son la de generar un listado de canciones favoritas de cada usuario, crear salas de chat entre usuarios con los mismos gustos musicales y notificar al servicio de soporte de incorrecciones en el videoclip de una canción.
El modelado de datos de este microservicio se basa en las entidades de Salas y Mensajes, las cuales contienen toda la información para posibilitar las conversaciones entre usuarios del sistema. Este servicio presenta funcionalidades como la recuperación de entidades con paginación, la traducción del texto de los mensajes, las operaciones CRUD de ambas entidades y el reporte de mensajes ofensivos.
Como puntos destacables, el uso de la API externa de DeepL para la traducción y la integración interna para los reportes usando mecanismos de rollback ante fallos.
El modelado de datos de este microservicio se basa en las entidades de Tickets y Reports, las cuales contienen toda la información necesaria para mantener el control y el buen funcionamiento del sistema. Este servicio presenta funcionalidades como el envío de notificaciones a los usuarios, las operaciones CRUD con las entidades y la gestión de incidencias.
Como puntos destacables están el uso de la API externa de SendGrid para enviar correos, la tolerancia a fallos desplegando un cliente adicional para la gestión de incidencias y el mecanismo de rollback incluido en la integración con los diferentes microservicios.
La documentación de la API REST de ms-songs está disponible en el siguiente enlace.
En función de las distintas entidades de dominio del microservicio ms-songs, los requisitos y la justificación de su implementación han sido los que se citan a continuación.
| Requisito | Justificación |
|---|---|
| Como usuario, quiero buscar canciones por su título para obtener un listado de estas. | Se implementa un buscador, mediante una barra de búsqueda, donde el usuario puede insertar el título de la canción que desea buscar. A nivel de microservicio, se ofrecen varios endpoints para esto: se pueden obtener todas las canciones de la aplicación, se puede realizar la búsqueda filtrando por el título de la canción o se puede aplicar la misma búsqueda pero a través del servicio de Spotify. |
| Como usuario, quiero acceder a una canción para ver su información, como la posible letra y el videoclip. | Se implementa la vista detalle de una canción, en la que se muestra toda la información de un tema concreto: carátula, artistas, videoclip o muestra mp3, y letra. Esto es posible a través de un endpoint para devolver una canción a partir de su identificador único (id). |
| Como usuario quiero editar la letra de una canción para colaborar con la comunidad de usuarios. | Simplemente se implementa la posibilidad de editar una canción, limitando esta edición solo a la letra de la canción y a la dirección de su videoclip en YouTube. La edición de la canción para asignarle un valor al atributo de dirección de videoclip (videoUrl) solo será posible en caso de que la canción no disponga de valor para este. |
| Como usuario quiero notificar acerca de un videoclip incorrecto para aportar la dirección correcta y que puedan modificarla. | Esta funcionalidad es posible mediante la integración con el microservicio de soporte (ms-support). El usuario hace envío de la URL nueva por la que debe ser sustituido el videoclip de una canción. Los responsables de soporte serán los responsables de valorar la petición y aprobar o rechazar dicho ticket que se hace envío por parte del usuario. De ser aceptado, entonces se actualiza el videoclip por la nueva dirección. |
| Como usuario, quiero añadir aquellas canciones que no se encuentran en FastMusik, pero que puedo encontrar en Spotify, para hacer más rico el catálogo de la aplicación. | Tras la búsqueda en Spotify, el usuario puede añadir a la base de datos de FastMusik cualquiera de los resultados, salvo que ya se encuentre en la aplicación. |
| Como administrador, quiero eliminar una canción que no deba estar en FastMusik para poder hacer mantenimiento del estado de la aplicación | Aquellos usuarios que tengan el rol de administrador podrán eliminar las canciones que deseen. Esta funcionalidad se implementa mediante la acción de borrado a través del identificador único (id) de la canción. |
| Requisito | Justificación |
|---|---|
| Como usuario, quiero hacer like en aquellas canciones que me gustan para contar con una colección de mis favoritas. | Se implementa la creación del like para una canción por parte de un usuario. Esta acción la desencadenará desde el frontend el equipo del microservicio de usuarios (ms-users). El like se realiza desde la vista detalle de una canción. La operación en el microservicio también hace una consulta al ms-users para obtener toda la información del usuario que hace like. |
| Como usuario, quiero deshacer un like en aquellas canciones que me gustan para que ya no aparezcan entre mis favoritas | Esta es la acción contraria a la de hacer like a una canción. Como condición, se requiere que el usuario haya hecho like previamente. Consiste en una acción de eliminación de like, por lo que se ha implementado con el verbo DELETE. Al igual que la acción de hacer like, esta también la desencadena desde la interfaz gráfica de usuario el equipo del microservicio de usuarios (ms-uses). |
| Como usuario, quiero conocer todos los usuarios que hacen like en una canción para poder saber quiénes tienen gustos musicales similares a los míos. | Esta acción se implementa como un GET con filtrado. El filtro se aplica mediante el identificador único (parámetro songId) de una canción, mostrándose un listado de los usuarios que han hecho like a la misma. |
| Como usuario, quiero ver el listado de likes que he otorgado para tener una colección de mis canciones favoritas. | En el caso de esta funcionalidad, se trata de aplicar un filtrado distinto al GET que devuelve todos los likes. Se filtra por el identificador único (parámetro userId) del usuario, mostrándose un listado de las canciones a las que ha hecho like. |
Se adjunta el informe final de esfuerzos, generado con Clockify, con el conteo de tiempo de dedicación para cada tarea del proyecto.