Weather Predictor 🌦️

Descripción del ejercicio 🪐

En una galaxia lejana, existen tres civilizaciones. Vulcanos, Ferengis y Betasoides. Cada civilización vive en paz en su respectivo planeta.

Dominan la predicción del clima mediante un complejo sistema informático.

A continuación el diagrama del sistema solar.

Premisas

• El planeta Ferengi se desplaza con una velocidad angular de 1 grados/día en sentido horario. Su distancia con respecto al sol es de 500Km.

• El planeta Vulcano se desplaza con una velocidad angular de 5 grados/día en sentido anti­horario. Su distancia con respecto al sol es de 1000Km.

• El planeta Betasoide se desplaza con una velocidad angular de 3 grados/día en sentido horario. Su distancia con respecto al sol es de 2000Km.

• Todas las órbitas son circulares.

Cuando los tres planetas están alineados entre sí y a su vez alineados con respecto al sol, el sistema solar experimenta un período de sequía.

Cuando los tres planetas no están alineados, forman entre sí un triángulo. Es sabido que en el momento en el que el sol se encuentra dentro del triángulo, el sistema solar experimenta un período de lluvia, teniendo éste, un pico de intensidad cuando el perímetro del triángulo está en su máximo.

Las condiciones óptimas de presión y temperatura se dan cuando los tres planetas están alineados entre sí pero no están alineados con el sol.

Se debe desarrollar un programa que pueda predecir la siguiente información en los próximos 10 años:

1. ¿Cuántos períodos de sequía habrá?
2. ¿Cuántos períodos de lluvia habrá y qué día será el pico máximo de lluvia?
3. ¿Cuántos períodos de condiciones óptimas de presión y temperatura habrá?

Para poder utilizar el sistema como un servicio a las otras civilizaciones, los Vulcanos requieren tener una base de datos con las condiciones meteorológicas de todos los días y brindar una API REST de consulta sobre las condiciones de un día en particular.

¿Cómo pruebo la solución de este repositorio? 🤔︎

El proyecto consta de 2 carpetas de aplicación (functions y test-server) y una carpeta para los recursos de esta documentación (assets).

Una vez se clona o descarga el proyecto, se deben seguir los comandos a continuación.

Prerrequisitos: Tener instalado npm. Clic aquí para ver cómo.

1. Preparación de proyecto functions.

   • Ubicar la consola en la carpeta functions:

     ~\weather-predictor> cd functions

   • Instalar dependencias:

     ~\weather-predictor\functions> npm install

   • Transpilar el código de Typescript a Javascript:

     ~\weather-predictor\functions> npm run build

2. Preparación de proyecto test-server.

   • Ubicar la consola en la carpeta test-server:

     ~\weather-predictor\functions> cd ..\test-server

   • Instalar dependencias:

     ~\weather-predictor\test-server> npm install

   • Subir el servidor express:

     ~\weather-predictor\test-server> node app.js

     Esto creará un servidor node js que se encuentra corriendo en http://localhost:1234/. En la consola se muestra un mensaje así:

     ~\weather-predictor\test-server> node app.js
     Corriendo en 1234!
     inMemory

     La palabra inMemory significa que el servidor guardará la información que se genere en memoria. Esta configuración se encuentra en el archivo .env, el cual una vez se despliegue functions a Google Cloud Platform, éste no estará configurado y la información se almacenará en Firestore.

   Una vez levantado el servidor, éste tendrá 2 endpoints, los cuales estarán utilizando las clases generadas en el proyecto functions.

3. La aplicación que se encuentra en ejecución en http://localhost:1234/ contiene los siguientes endpoints:

   • Generación de los datos. Es importante ejecutar este endpoint para generar y almacenar todas las predicciones.

     • Método HTTP: GET

     • Url: http://localhost:1234/generar-prediccion

     • Controlador: CreateSolarSystemController

     • Método: generatePredictions

     • Códigos de respuesta:

       201 Created: El sistema solar y los datos del clima de 10 años han sido cargados correctamente.

       {
           "created": true,
           "data": {
               "aysWithMaxRain": [
                   2808,
                   2952,
                   3492
               ],
               "dryDays": 21,
               "maxPerimeter": 6262.300354242005,
               "normalDays": 2389,
               "optimalDays": 40,
               "rainyDays": 1202
           }
       }

       200 OK: El sistema solar y los datos del clima de 10 años ya se han cargado con anterioridad.

       {
           "message": "The solar system was already created. Congrats!"
       }

       500 Internal Server Error: Ocurrió un error en el cargue de datos. El cuerpo de respuesta varía dependiendo del error. Se puede deber a conexión con la base de datos u otros procesos que no fueron controlados.

   • Consulta de los datos.

     • Método HTTP: GET

     • Url: http://localhost:1234/clima?dia=n

     • Controlador: QueryWeatherController

     • Método: getSpecificDayWeather

     • Códigos de respuesta:

       200 OK: El día solicitado en el Query String fue encontrado exitosamente y se envía el estado del clima en el cuerpo. Ejemplo: http://localhost:1234/clima?dia=566

       {
           "dia": 566,
           "clima": "lluvia"
       }

       401 Unathorized: El código de respuesta se debe a que la petición fue realizada sin el parámetro ?dia=n. Ejemplo: http://localhost:1234/clima

       404 Not Found: El código de respuesta se debe a que la petición fue realizada con un número de día que no se encuentra en la base de datos o la información aún no se ha cargado con el endpoint anterior. Ejemplo: http://localhost:1234/clima?dia=6000

       {
           "message": "The day does not exist!"
       }

       500 Internal Server Error: Ocurrió un error en la consulta del dato. El cuerpo de respuesta varía dependiendo del error. Se puede deber a conexión con la base de datos u otros procesos que no fueron controlados.

   NOTA: Para probar los endpoints en Google Cloud Platform, es necesario cambiar el dominio de los endpoints en el navegador, así:

   • https://us-central1-august-period-284822.cloudfunctions.net/generar-predicciones
   • https://us-central1-august-period-284822.cloudfunctions.net/clima?dia=566

Arquitectura implementada 🌇

Hablando de código... 💻

• ☕ Arquitectura... se implementó la arquitectura Hexagonal de la mano de DDD, CQRS sin olvidar los principios SOLID.

• ✍️ Lenguaje/tecnología... todo esto fue desarrollado en Typescript y desplegado en servidor Node.js 10.

Y la base de datos... ¿qué? ⛅

Una vez la carpeta dist del proyecto functions es montada en Google Cloud Platform, la información es almacenada en Firestore.

La gestión del repositorio se realiza en la clase FirestoreSolarSystemRepository.

Esta base de datos es documental y se ve de la siguiente forma:

• Colección weather-predictions:

• Documento predictions:

  Los campos son:

  • daysWithMaxRain: corresponde a los números de día en los 10 años de predicción los cuales presentan un pico de intensidad en la lluvia.

  • dryDays: corresponde a la cantidad de días que presentan sequía en los 10 años de predicción.

  • normalDays: corresponde a la cantidad de días que presentan normalidad en los 10 años de predicción.

  • optimalDays: corresponde a la cantidad de días que presentan condiciones óptimas de presión y temperatura en los 10 años de predicción.

  • rainyDays: corresponde a la cantidad de días que presentan lluvias (incluyendo los días con pico de intensidad) en los 10 años de predicción.

  • maxPerimeter: corresponde al valor del mayor perímetro encontrado a partir del triángulo formado entre los 3 planetas (Vulcano, Ferengi y Betasoide).

• Colección days:

  En esta colección se almacenan los documentos correspondientes a todos los días calculados (10 años de predicciones).

• Documento N:

  Cada documento está identificado con el número de día correspondiente, empezando por el número 0.

  Los campos de cada documento son (reemplazar [planeta] por vulcano, ferengi o betasoide):

  • [planeta]Clockwise: define si el planeta realiza su movimiento de traslación con respecto a las manecillas del reloj.

  • [planeta]PolarG: corresponde a los grados en los que se encuentra el planeta con respecto al valor inicial 0°. Si el valor es negativo, quiere decir que [planeta]Clockwise está en true.

  • [planeta]PolarR: define la distancia en la que se encuentra el planeta con respecto al sol.

    Nota: Las propiedades [planeta]PolarG y [planeta]PolarR forman la coordenada Polar del planeta en un día específico.

  • perimeter: corresponde al valor del cálculo del perímetro del triángulo formado por los planetas en ese día (si están alineados, éste valor será 0).

  • weatherCondition: corresponde a la condición climática de ese día.