{"id":143,"date":"2020-05-25T14:39:26","date_gmt":"2020-05-25T19:39:26","guid":{"rendered":"https:\/\/80bits.blog\/?p=143"},"modified":"2020-05-25T14:52:25","modified_gmt":"2020-05-25T19:52:25","slug":"komodo-backend-en-nodejs-para-bot-de-telegram-y-algo-mas","status":"publish","type":"post","link":"https:\/\/80bits.blog\/index.php\/2020\/05\/25\/komodo-backend-en-nodejs-para-bot-de-telegram-y-algo-mas\/","title":{"rendered":"Komodo. Backend en NodeJS para bot de telegram y algo mas."},"content":{"rendered":"\n

Reciclando c\u00f3digo y salvando otros pedazos por ah\u00ed que tenia en nodejs, al final organic\u00e9 en un c\u00f3digo simple la implementaci\u00f3n de un bot para telegram.<\/p>\n\n\n\n

Para los que no conocen hay una aplicaci\u00f3n llamada Telegram<\/a>, parecida a WhatsApp, pero mejor!!!!.<\/p>\n\n\n\n

Pues bien dentro de esta aplicaci\u00f3n se pueden usar bots para distintos fines, los hay para buscar gif, videos, buscar en la wikipedia entre muchos otros, y lo mejor es que cualquiera y de manera muy sencilla puede crear su propio bot, para este fin es que he desarrollado este c\u00f3digo al que nombr\u00e9 komodo, (fue lo primero que se me vino a la mente).<\/p>\n\n\n\n

Como Crear un bot de telegram?<\/h2>\n\n\n\n

Para crear un bot que hay usar uno que en Telegram nos permite hacer bot, y se llama BotFather, este es muy f\u00e1cil de usar solo hay que interactuar con el y por medio de sus comandos es f\u00e1cil crear un nuevo bot, para no extender este post en este link<\/a> lo explican mejor.<\/p>\n\n\n\n

Lo m\u00e1s importante aqu\u00ed es que, para usar nuestro bot e interactuar con el necesitamos la url del bot que nos proporciona telegram y usar las apis<\/a> que se proporcionan en la web.<\/p>\n\n\n\n

Los bots de telegram tienen much\u00edsimas funcionalidades, desde el mas simple como interactuar con el usuario de uno a uno, hasta interactuar en grupos como por ejemplo moderador de textos o sugerir algo para los integrantes mientras se env\u00edan los textos.<\/p>\n\n\n\n

C\u00f3digo NodeJS<\/h2>\n\n\n\n

Clonar el c\u00f3digo<\/a><\/p>\n\n\n\n

git clone <\/pre>\n\n\n\n
Hay dos formas de que nuestro bot tenga interactividad o por lo menos reciba mensajes, uno es mediante un long polling, esto es que un proceso este cada cierto tiempo estar\u00e1 revisando los mensajes entrantes, mediante esta api<\/a>.<\/p>\n\n\n\n
Este proceso antes mencionado es un poco lento, y desde mi punto de vista complejo, ya que si el bot tiene muchos mensajes seguidos tendr\u00e1s que lidiar con un stream muy alto por cada request que le haces a la api, la mejor forma es la segunda opci\u00f3n que tiene telegram y es mediante un webhook<\/a>, esto una url donde montaras un servicio, en mi caso un servicio en nodejs y telegram redireccionara los mensajes hacia esa api.<\/p>\n\n\n\n
Para obtener un servicio donde ejecutar nodejs de forma gratuita, se puede usar por ejemplo azure web apps<\/a>, que te da una instancia gratis (hasta 10) para ejecutar servicios rest.<\/p>\n\n\n\n
Este c\u00f3digo de momento solo tiene una funcionalidad que espero poder ir extendiendo con el tiempo, puesto que aun necesito organizar mas c\u00f3digo revuelto que tengo por ah\u00ed, lo \u00fanico que hace es enviar mensajes a un chat o usuario especifico, basado en esta api<\/a>.<\/p>\n\n\n\n
Ejecutar el c\u00f3digo<\/h3>\n\n\n\n
El servicio tiene un dependencia con mongodb, que en este caso y para este release solo usa la base de datos para obtener el token que se env\u00eda en la cabecera authorization<\/em><\/strong>, esto fue con el fin de que en el futuro pueda dar acceso a mas usuarios y tener m\u00e9tricas de uso para no abusar de la api, si este llega a ser el caso.<\/p>\n\n\n\n
Para no usar mongodb, puse un feature flag muy simple en el archivo de configuraci\u00f3n, donde en lugar de usar mongodb para buscar el token valido, usa una variable de entorno donde puedes especificar tokens separados por comas, para que sea mas f\u00e1cil y r\u00e1pido de utilizar y sin depender de una base de datos.<\/p>\n\n\n\n
Esta validaci\u00f3n del token, ya se mediante la base de datos o la variable de tokens se eval\u00faa mediante un middleware que esta en la ruta:<\/p>\n\n\n\n
+ midlewares\/authorization.js<\/pre>\n\n\n\n
Dentro hay dos validaciones sencillas que no hacen uso de la autorizaci\u00f3n, uno es el path del \u00edndex y el otro el de telegram update, tal vez en el futuro genere un mejor modelo de validaci\u00f3n de estas rutas.<\/p>\n\n\n\n
El servicio en forma local se ejecuta en el puerto 3000.<\/p>\n\n\n\n
PM2 y nodemon<\/h3>\n\n\n\n
El servicio esta preparado para ejecutarse con el programa pm2<\/a>, si es el caso de que usaste un servicio de azure, entonces pm2 no es necesario puesto que las variables de entorno se pueden configurar de manera f\u00e1cil desde el portal del servicio.<\/p>\n\n\n\n
Las variables de entorno que se usan son las siguientes:<\/p>\n\n\n\n
Nombre<\/strong><\/td>Descripci\u00f3n<\/strong> <\/td><\/tr>
NODE_ENV<\/td>Entorno de ejecuci\u00f3n, puede ser development<\/em> o production<\/em><\/td><\/tr>
TELEGRAM_URL_BOT<\/td>La url del bot proporcionada por BotFather<\/td><\/tr>
MONGO_CS<\/td>La connexion de mongodb. Ejemplo: mongodb:\/\/localhost:27017<\/em><\/td><\/tr>
MONGO_USER<\/td>Usuario para la conexi\u00f3n de mongodb<\/td><\/tr>
MONGO_PASSWORD<\/td>Contrase\u00f1a de usuario para mongodb<\/td><\/tr>
MONGO_DBNAME<\/td>nombre de la base de datos en mongodb<\/td><\/tr>
MONGO_COLLECTION<\/td>nombre de la colecci\u00f3n mongodb<\/td><\/tr>
FIXED_TOKENS<\/td>tokens fijos en caso de no usar la conexi\u00f3n a la base de datos.<\/td><\/tr>
F_USE_MONGO<\/td>Puede tener los valores: true<\/em> para que se use la conexi\u00f3n mongodb, o false<\/em> para que se usen los tokens fijos<\/td><\/tr>
TG_UPDATE<\/td>path donde llegaran las actualizaciones de telegram, este debe ser secreto<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Ejecutar pm2:<\/p>\n\n\n\n
pm2 start ecosystem.config.js --env production<\/pre>\n\n\n\n
El comando anterior ejecutara el servicio en modo producci\u00f3n y el c\u00f3digo actual que no se conecta a ninguna base de datos. Es preciso que cambien los tokens que est\u00e1n fijos ya que son bastante simples y solo son para pruebas r\u00e1pidas.<\/p>\n\n\n\n
Ejecutar con nodemon:<\/p>\n\n\n\n
Nodemon<\/a> es un paquete muy \u00fatil para cuando quieres hacer pruebas locales ya que cualquier cambio que hagas en el c\u00f3digo lo detecta y reinicia el proceso nuevamente, puede ver m\u00e1s sobre \u00e9l en la pagina oficial del paquete.<\/p>\n\n\n\n
nodemon --config dev.config.json<\/pre>\n\n\n\n
En este caso tengo un archivo de configuraci\u00f3n para nodemon, este no existe en el repositorio de c\u00f3digo por que es solo para uso local y personal, pero pueden crear uno de manera muy sencilla copiando este texto.<\/p>\n\n\n\n
{\n\"env\": {\n\"TELEGRAM_URL_BOT\": \"\",\n\"MONGO_CS\": \"\",\n\"MONGO_USER\": \"\",\n\"MONGO_PASSWORD\": \"\",\n\"MONGO_DBNAME\": \"\",\n\"MONGO_COLLECTION\": \"\",\n\"FIXED_TOKENS\": \"abc,1abc\",\n\"F_USE_MONGO\": \"false\",\n\"TG_UPDATE\": \"update123\"\n}\n}<\/pre>\n\n\n\n
Este archivo lo \u00fanico que hace es facilitar escribir las variables de entorno antes mencionadas y ejecutar nodemon.<\/p>\n\n\n\n
Enviar mensajes a telegram<\/h3>\n\n\n\n
Para que el bot pueda enviarle un mensaje a un usuario de Telegram, se tienen que cumplir unas condiciones, la primera es que el usuario haga uso del bot, esto es que genere una conversaci\u00f3n con el dentro de la app, la segunda es que se necesita un c\u00f3digo de chat que este es dado por el bot y con el que telegram identifica la conversaci\u00f3n con el usuario.<\/p>\n\n\n\n
Ya mencione que el fin de este c\u00f3digo es no usar long polling y para ello se especifica a telegram el webhook hacia donde tiene que redirigir los mensajes, este webhook no es mas que la url del servicio a donde todo tiene que llegar, para el c\u00f3digo en cuesti\u00f3n la ruta del controlador es esta.<\/p>\n\n\n\n
{server}\/telegrambot\/update123<\/pre>\n\n\n\n
Esta ruta se genera con la variable de entorno TG_UPDATE<\/em> por seguridad, ya que nadie deber\u00eda saber esta ruta mas que telegram, as\u00ed desde la variable de entorno podr\u00e1n agregar un string aleatorio.<\/p>\n\n\n\n
El fichero se encuentra en:<\/p>\n\n\n\n
+ routes\/telegramUpdate.js<\/pre>\n\n\n\n
El archivo tiene un m\u00e9todo POST para obtener los datos que telegram env\u00eda, pueden ver el modelo de datos que telegram env\u00eda aqu\u00ed<\/a>.<\/p>\n\n\n\n
Hay unas lineas muy simples que lo unico que detecta es el comando de telegram \/code<\/em>, este comando lo que hace es que si en la conversaci\u00f3n el usuario escribe \/code<\/em>, el bot enviara el chatId de la conversaci\u00f3n, lo cual es importante para poder usarlo y despu\u00e9s enviar mensajes al usuario.<\/p>\n\n\n\n
+ routes\/telegramBot.js<\/pre>\n\n\n\n
En este archivo se encuentra el m\u00e9todo POST que enviara los mensajes al usuario, haciendo uso de chatId, la ruta en el api es la siguiente:<\/p>\n\n\n\n
{server}\/telegrambot\/sendMessage\/:chatId<\/pre>\n\n\n\n
El body del mensaje solo esta compuesto por dos variables: <\/p>\n\n\n\n
{\n\"header\": \"Titulo\",\n\"body\": \"Descripcion\"\n}<\/pre>\n\n\n\n
En este punto, se tiene que enviar la cabecera authorization<\/em> con el token valido, ya sea puesto en la variable de entorno o en una base de datos mongodb, de lo contrario se recibir\u00e1 un mensaje http 401 unauthorized.<\/p>\n\n\n\n
Script cURL, para enviar un mensaje al bot<\/h4>\n\n\n\n
Suponiendo que el chatId sea 123, si quieres tener un script que env\u00ede un mensaje y tal vez automatizarlo con alg\u00fan proceso como cron en linux un ejemplo podr\u00eda ser este:<\/p>\n\n\n\n
#!\/bin\/bash\ncurl --location --request POST 'http:\/\/localhost:3000\/telegrambot\/sendMessage\/123' \\\n--header 'Authorization: abc' \\\n--header 'Content-Type: application\/json' \\\n--data-raw '{\n\"header\": \"Titulo\",\n\"body\": \"Descripcion\"\n}'<\/pre>\n\n\n\n
Un mensaje se puede enviar en local siempre y cuando se cumplan las condiciones de tener la url del bot de telegram y el chatId, si no cuentas con un servidor en la nube y quieres saber el chatId, simplemente escribe algo en el chat y puede obtener el chatId mediante la api getUpdates<\/em><\/a> de telegram.<\/p>\n\n\n\n
Enviar mensajes a canales y grupos<\/h4>\n\n\n\n
Actualmente el c\u00f3digo soporta que un bot pueda enviar mensajes a canales y grupos, esto es muy \u00fatil si quieres automatizar el env\u00edo de mensajes a tu audiencia, solo hay que cumplir con los requisitos de telegram para esto.<\/p>\n\n\n\n
Para enviar mensajes a un canal, el bot tiene que estar dentro del canal y ser administrador y en lugar de un chatId, tienen que poner el nombre del canal, ejemplo:<\/p>\n\n\n\n
{server}\/telegrambot\/sendMessage\/nombredetucanal<\/pre>\n\n\n\n
Para enviar mensaje a un grupo el bot tiene que estar igual dentro del grupo, no es necesario que sea administrador pero si que pueda enviar mensajes, y tienen que saber el chatId del grupo, esto lo pueden obtener de la misma manera que en un chat, con el comando \/code<\/em>, y el bot les enviara el chatId del grupo que por lo general todos empiezan en negativo, ejemplo:<\/p>\n\n\n\n
{server}\/telegrambot\/sendMessage\/-1234<\/pre>\n\n\n\n
Por el momento el bot solo env\u00eda mensajes, en el futuro espero poder implementar otras opciones mas.<\/p>\n\n\n\n
WebHooks Gitlab<\/h2>\n\n\n\n
Como el bot, hace mucho tiempo lo escrib\u00ed por una simple raz\u00f3n, y este que necesitaba algo que me notificara los commits de un proyecto en gitlab, el c\u00f3digo tiene un controlador que hace precisamente eso, hace uso de los webhooks<\/a> de gitlab para enviar mensajes.<\/p>\n\n\n\n
Actualmente solo tiene dos implementados, Push Events<\/em> y Pipeline Events<\/em>, para hacer uso de ellos el servicio tiene la siguiente ruta:<\/p>\n\n\n\n
{server}\/gitlab\/webhooks\/:chatId<\/pre>\n\n\n\n
Para saber que tipo de hook es, gitlab env\u00eda una cabecera que se llama X-Gitlab-Event<\/em>:<\/p>\n\n\n\n
X-Gitlab-Event<\/td>Descripci\u00f3n <\/td><\/tr>
Push Hook<\/td>Eventos push, commit<\/td><\/tr>
Pipeline Hook<\/td>Evento pipeline<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Tambi\u00e9n env\u00eda una cabecera llamada X-Gitlab-Token<\/em>, esto es por si necesitas un token de autorizaci\u00f3n para el env\u00edo del hook, en este caso se usa el mismo que en la cabecera authorization, y el c\u00f3digo verifica si existe algo ah\u00ed o en la de gitlab y procede con el permiso si el token es valido.<\/p>\n\n\n\n
Y eso es todo.<\/p>\n\n\n\n
Pendientes a desarrollar<\/h2>\n\n\n\n