Dms-game-client NPM

Práctica DMS curso 2019-2020

Práctica obligatoria de la asignatura Diseño y Mantenimiento del Software de 4º del Grado de Ingeniería en Informática de la Universidad de Burgos para el curso 2019-2020.

Instalación

La solución soporta plataformas Unix y Windows.

Requisitos

Los servicios servidor (hub, auth-server, y game-server) requieren python 3.6 o superior.

Para el cliente web, se requiere Node.js versión 10.9 o superior.

Librerias y paquetes

En caso de no utilizar docker, los tres servicios servidor requieren los paquetes python detallados en requirements.txt. Esta operación se puede automatizar con pip:

Windows:

pip install -r .\requirements.txt

Linux / macOS:

python3 -m pip install -r ./requirements.txt

El cliente web requiere navegar a src/web/dms-front y ejecutar el siguiente comando para instalar los paquetes necesarios:

npm install

Construcción y uso

Docker

Para construir las imágenes de los servicios utilizando docker-compose, ejecutar el siguiente comando:

docker-compose -f docker/config/base.yml build

La configuración también permite levantar los servicios de un modo similar:

docker-compose -f docker/config/base.yml up -d

Para detener y borrar los servicios, podemos usar el siguiente comando:

docker-compose -f docker/config/base.yml rm -sfv

La configuración por defecto creará los siguientes servicios:

dms1920-auth-server: El servidor de autenticación y usuarios, escuchando en el puerto 1234 con un API REST (ver más abajo)
dms1920-hub: El punto de acceso a los servidores de juego registrados, escuchando en el puerto 4444 con un API REST (ver más abajo)
dms1920-game-server: El punto de acceso a los servidores de juego registrados, escuchando en el puerto 2222 con un API REST (ver más abajo)

Windows

Se proporciona un archivo rest-server.bat en cada componente en la carpeta bin, de tal manera que si se desea ejecutar el game-server:

.\src\components\game-server\bin\rest-server.bat

Estos ejecutables admiten un parametro adicional que cambia el puerto del servicio, con rango 0, 65535. Por ejemplo para ejecutar el hub con puerto 5932:

.\src\components\hub\bin\rest-server.bat 5932

Linux / macOS

Se proporciona un archivo rest-server.sh en cada componente en la carpeta bin, de tal manera que si se desea ejecutar el game-server:

./src/components/game-server/bin/rest-server.sh

Cliente web

El cliente web se puede ejecutar por medio de npm, navegando previamente a src/web/dms-front. Existen dos maneras de ejecutar el cliente, una es ejecutando un servidor de desarrollo en local, y crear archivos compilados en modo producción. Asegurarse de haber ejecutado npm install antes de continuar.

Ejecutar en modo desarrollo / debug:

npm start

Una vez terminada la compilación abre automaticamente una página web (localhost:4200) con el cliente.

Compilar versión de producción:

npm run build

Una vez terminada la compilación se crea una carpeta dist con los todos los archivos requeridos para ser ejecutado en cualquier motor http.

Cliente del juego

El cliente web utiliza como cliente de juego los scripts compilados del proyecto encontrado en src/web/dms-game-client, para poder ejecutar y compilar este proyecto utilizar las mismas instrucciones del Cliente web.

Para poder cambiar el juego dentro del propio cliente web se puede hacer de las siguientes maneras:

Compilar game-client y ejecutar npm publish, requiere permisos de edición en el paquete npm dms-game-client. Despues ejecutar npm update dms-game-client en el cliente web.
Crear un nuevo paquete npm, cambiar la propiedad name de src/web/dms-game-client/package.json, cambiar el nombre de la dependencia dms-game-client en src/web/dms-front/package.json, despues ejecutar los comandos vistos del punto anterior.
Utilizar archivos compilados en lugar de paquetes npm, en el archivo src/web/dms-front/angular.json sustituir todas las ocurrencias de ./node_modules/dms-game-client/ por ../dms-game-client/.
Cambiar manualmente los archivos:
- Copiar todos los archivos .js a la carpeta src/web/dms-front/gameclient (crear en caso de que no exista).
- Copiar todos los archivos de la carpeta dist/assets a la carpeta src/web/dms-front/assets.
- En el archivo src/web/dms-front/angular.json eliminar todas las ocurrencias de las siguientes lineas:

{
    "glob": "*.js",
    "input": "./node_modules/dms-game-client/dist",
    "output": "./gameclient/"
},
{
    "glob": "**/*",
    "input": "./node_modules/dms-game-client/dist/assets",
    "output": "./assets/"
}

Documentacion de uso

Documentacion de diseño

Servicios

dms1920-auth-server

Es el servidor de autenticación y gestión de usuarios.

Se trata de un servicio sencillo de solo dos capas (presentación a través de un API REST y acceso a datos a través de un ORM con una base de datos SQLite)

API REST

La comunicación con el servicio se realiza a través de un API REST:

/: Verificación del estado del servidor. No realiza ninguna operación, pero permite conocer si el servidor está funcionando sin miedo a alterar su estado en modo alguno.
- Método: GET
- Respuesta:
  - 200: El servidor está funcionando correctamente.
/user/create: Endpoint de creación de usuarios.
- Método: POST
- Parámetros:
  - username: El nombre de usuario (debe ser único en el servidor). 32 caracteres máximo.
  - password: La clave del nuevo usuario.
- Respuesta:
  - 200: El usuario fue creado con éxito.
  - 500: El usuario no pudo ser creado (probablemente por existir uno con un mismo nombre)
/user/login: Endpoint de login de usuarios.
- Método: POST
- Parámetros:
  - username: El nombre de usuario.
  - password: La clave del usuario.
- Respuesta:
  - 200: El usuario se autenticó con éxito. El contenido de la respuesta es el token de autenticación.
  - 401: Las credenciales eran incorrectas.
/user/info: Endpoint de información de usuario.
- Método: GET
- Parámetros:
  - username: (Opcional) El nombre de usuario del cual obtener información, no es necesario pasar el token.
  - token: (Opcional) El token que identifica al usuario, username debe estar vacío.
- Respuesta:
  - 200: La sesión o el usuario existen. El contenido de la respuesta es un objeto JSON con información sobre el usuario.
  - 401: El token es incorrecto.
  - 404: El username no se corresponde con ningún usuario existente.
/token/check: Endpoint de validación de tokens.
- Método: GET
- Parámetros:
  - token: El token a validar.
- Respuesta:
  - 200: El token es correcto y pertenece a un usuario autenticado.
  - 401: El token dado es incorrecto.
/score: Endpoint de listado de puntuaciones ordenadas descendentemente.
- Método: GET
- Respuesta:
  - 200: El listado de puntuaciones codificado en JSON en el contenido de la respuesta.
/score/add: Endpoint de incremento de puntiuaciones de un usuario autenticado.
- Método: POST
- Parámetros:
  - username: El nombre del usuario cuya puntuación se va a actualizar.
  - secret_code: Una contraseña única que valida que la llamada a este método la realiza el servidor de juego.
  - games_lost: (Opcional) El incremento (o decremento si es negativo) en el número de partidas perdidas por el usuario.
  - score: (Opcional) El incremento (o decremento si es negativo) en la puntuación del usuario.
- Respuesta:
  - 200: La puntuación fue actualizada con éxito.
  - 400: Falta alguno de los parametros.
  - 401: El código secreto es incorrecto.
  - 404: No existe ningun usuario con ese nombre.

Configuración

El servidor usa las siguientes variables de entorno para su configuración:

AUTH_SERVER_PORT: El puerto en el que publicará su API REST.
AUTH_SERVER_DATABASE_PATH: La ruta del fichero de base de datos para el servidor de autenticación.

dms1920-hub

Es el servidor de acceso centralizado a los servidores de juego registrados.

Se trata de un servicio sencillo de solo dos capas (presentación a través de un API REST y socket, y acceso a datos a través de una capa de comunicaciones REST hacia el servidor de autenticación y un modelo interno)

API REST

La comunicación con el servicio se realiza a través de un API REST:

/: Verificación del estado del servidor. No realiza ninguna operación, pero permite conocer si el servidor está funcionando sin miedo a alterar su estado en modo alguno.
- Método: GET
- Respuesta:
  - 200: El servidor está funcionando correctamente.
/server: Obtener el listado de servidores actualmente registrados.
- Método: GET
- Parámetros:
  - token: El token de autenticación del usuario que solicita el listado.
- Respuesta:
  - 200: El listado de servidores registrados serializado en JSON en el contenido de la respuesta.
  - 401: El token no se corresponde con un usuario autenticado.
/server/register: Registra un nuevo servidor de juego.
- Método: POST
- Parámetros:
  - name: El nombre del servidor.
  - host: El host donde se encuentra el servidor de juego.
  - port: El puerto por el que comunicarse con el API REST del servidor de juego.
  - token: El token de autenticación del usuario que solicita registrar el servidor.
- Respuesta:
  - 200: El servidor se registró correctamente.
  - 401: El token no se corresponde con un usuario autenticado.
  - 403: Un servidor ya existe con este nombre y el usuario autenticado no es el dueño de este.
  - 500: Algún error sucedió al intentar registrar el servidor.
/server/unregister: Da de baja un servidor de juego.
- Método: POST
- Parámetros:
  - name: El nombre del servidor.
  - token: El token de autenticación del usuario que solicita dar de baja el servidor.
- Respuesta:
  - 200: El servidor se dio de baja correctamente.
  - 401: El token no se corresponde con un usuario autenticado.
  - 403: El usuario autenticado no es el dueño del servidor.
: Accede a un servidor de juego.
- Método: POST
- Parámetros:
  - token: El token de autenticación del usuario que solicita unirse al servidor.
  - client: El identificador del usuario socket utilizado para ser identificado en el chat.
  - server: El nombre del servidor.
- Respuesta:
  - 200: El usuario se ha unido al servidor, obtiene la información de este último.
  - 400: El parametro client o server está vacío.
  - 401: El token no se corresponde con un usuario autenticado.
  - 404: No existe un servidor con el nombre especificado.

Socket

El socket se utiliza para el chat de cada servidor, tiene los siguientes eventos como API:

login: Autentica al cliente para poder acceder al resto de métodos del socket.
- Parámetros:
  - Un string, el token de autenticación del usuario que solicita dar de baja el servidor.
- Respuesta: Un json con la siguiente informacion (evento login_res):
  - ok: Booleano que índica si se ha autenticado correctamente.
  - username: Un string que indica el nombre de usuario.
join: Accede al chat de un servidor, es necesario haber realizado previamente la llamada API REST /server/join.
- Parámetros:
  - Un string, el nombre del servidor.
- Respuesta: Un json con la siguiente informacion (evento join_server_res):
  - ok: Booleano que índica si se ha unido correctamente.
  - error: Un string que indica el problema ocurrido en caso de que ok sea falso:
    - server_not_exists: No existe un servidor con el nombre especificado.
    - not_authenticated: El cliente no se ha autenticado.
leave: Sale del chat de un servidor.
- Parámetros:
  - Un string, el nombre del servidor.
- Respuesta: Un json con la siguiente informacion (evento leave_server_res):
  - ok: Booleano que índica si se ha abandonado el servidor correctamente.
disconnect: Sale de todos los chats a los que esté conectado el cliente.
- Parámetros:
- Respuesta:
chat: Envia un mensaje al chat de un servidor al que se ha unido previamente.
- Parámetros:
  - Un json con los siguientes atributos:
    - server: El nombre del servidor.
    - message: El mensaje a ser enviado.
- Respuesta: Un json con la siguiente informacion (evento send_chat_res):
  - ok: Booleano que índica si se ha unido correctamente.
  - error: Un string que indica el problema ocurrido en caso de que ok sea falso:
    - empty_arg_server: El parámetro server está vacío.
    - empty_arg_message: El parámetro message está vacío.
    - not_authenticated: El cliente no se ha autenticado.
    - unknown_server: No existe un servidor con el nombre especificado.

Además, el socket emite los siguientes eventos:

send_chat: Un nuevo mensaje de chat de uno de los servidores a los que está unido el cliente. Es un json con los siguientes atributos:
- user: El nombre del usuario del emisor del mensaje.
- time: El instante en el que se envió el mensaje, formato unix timestamp (segundos desde 1970).
- message: El contenido del mensaje.
- server: El nombre del servidor en el que se ha enviado el mensaje.

Configuración

El servidor usa las siguientes variables de entorno para su configuración:

HUB_SERVER_PORT: El puerto en el que publicará su API REST.
AUTH_SERVER_HOST: El host en el que se encuentra el servidor de autenticación.
AUTH_SERVER_PORT: El puerto en el que está publicado el API REST del servidor de autenticación.

dms1920-game-server

Es el servidor donde se realiza una partida.

Se trata de un servicio sencillo de solo dos capas (presentación a través de un API REST y acceso a datos a través de una capa de comunicaciones REST hacia el servidor de autenticación y un modelo interno)

API REST

La comunicación con el servicio se realiza a través de un API REST:

/: Verificación del estado del servidor. No realiza ninguna operación, pero permite conocer si el servidor está funcionando sin miedo a alterar su estado en modo alguno.
- Método: GET
- Respuesta:
  - 200: El servidor está funcionando correctamente.
/join: Unirse al juego.
- Método: POST
- Parámetros:
  - token: El token de autenticación del usuario que solicita el listado.
- Respuesta:
  - 200: El identificador único de usuario usado para el resto de métodos.
  - 401: El token no se corresponde con un usuario autenticado.
  - 404: El juego ya está lleno, no caben más jugadores.
/play/place: Colocar una pieza.
- Método: PUT
- Parámetros:
  - client_id: El identificador único de usuario.
  - x: La componente horizontal de la coordenada donde se coloca la pieza.
  - y: La componente vertical de la coordenada donde se coloca la pieza.
- Respuesta:
  - 200: la pieza se coloco correctamente, devuelve información sobre el resultado de la acción.
  - 401: El identificador único de usuario no se corresponde con un jugador activo en la partida.
  - 403: El juego no ha empezado o no el turno no le corresponde a el usuario solicitante.
  - 404: La coordenada no es válida.
  - 500: Un error especifico del juego ha ocurrido.
/play/status: Obtiene información sobre el estado del juego.
- Método: PUT
- Parámetros:
  - client_id: El identificador único de usuario, opcional.
- Respuesta:
  - 200: Información sobre el estado actual de la partida.
/play/status/brief: Obtiene información reducida sobre el estado del juego.
- Método: PUT
- Parámetros:
  - client_id: El identificador único de usuario, opcional.
- Respuesta:
  - 200: Información abreviada sobre el estado actual de la partida.

Configuración

El servidor usa las siguientes variables de entorno para su configuración:

GAME_SERVER_PORT: El puerto en el que publicará su API REST.
AUTH_SERVER_HOST: El host en el que se encuentra el servidor de autenticación.
AUTH_SERVER_PORT: El puerto en el que está publicado el API REST del servidor de autenticación.
GAME_SERVER_GAME: El juego que será ejecutado, opcional, puede ser tictactoe o go, por defecto es tictactoe.
GAME_SERVER_BOARD_SIZE: El tamaño del tablero, opcional, depende de cada juego:
- En Atari: Un número entero positivo indicando el tamaño del lado del tablero cuadrado (por defecto 3), y opcionalmente otro número de las mismas caractísticas separado por una coma que indica el número de piezas adyacentes requeridas para ganar (por defecto 3). Por ejemplo:
  - 4 equivale a un tablero 4x4 que requiere 3 piezas seguidas para ganar.
  - 5,2 equivale a un tablero 5x5 que requiere 2 piezas seguidas para ganar.
- En Go: Un número entero positivo indicando el tamaño del lado del tablero cuadrado (por defecto es 9). Por ejemplo:
  - 9 equivale a un tablero 9x9.
  - 13 equivale a un tablero 13x13.