initial commit

Author: awesomelike

.eslintrc.js

@@ -0,0 +1,16 @@
+module.exports = {
+  env: {
+    browser: true,
+    commonjs: true,
+    es2021: true,
+  },
+  extends: [
+    'airbnb-base',
+  ],
+  parserOptions: {
+    ecmaVersion: 12,
+  },
+  rules: {
+    'linebreak-style': 0
+  },
+};

.gitignore

@@ -0,0 +1,3 @@
+node_modules
+.env
+package-lock.json

index.js

@@ -0,0 +1,51 @@
+/* eslint-disable no-console */
+/* eslint-disable no-unused-vars */
+/* eslint-disable no-param-reassign */
+const querify = require('querystring').stringify;
+const onFinished = require('on-finished');
+const template = require('./src/templates/default');
+const sendMessage = require('./src/sendMessage');
+const { printWarning } = require('./src/utils/print');
+
+/**
+ * @param options Middleware's options
+ * @param options.botToken Bot's token, sent by BotFather
+ * @param options.chatId ChatID of a Telegram chat to send notifications to
+ */
+const telegramMiddleware = (options) => (req, res, next) => {
+  if (!options) options = {};
+  const { botToken } = options;
+  const { chatId } = options;
+
+  if (!botToken) printWarning('botToken not provided, errors get ignored');
+  if (!chatId) printWarning('chatId not provided, errors get ignored');
+
+  if (botToken && chatId) {
+    onFinished(res, (err, _) => {
+      if (err || res.statusCode >= 400) {
+        const text = template(req, res, options);
+
+        let query = {
+          text,
+          chat_id: chatId,
+          parse_mode: 'Markdown',
+        };
+
+        // If statusCode is less than 500, then this error is not critical, we disable notification
+        if (res.statusCode < 500) query.disable_notification = true;
+
+        query = querify(query);
+
+        try {
+          sendMessage(botToken, query);
+        } catch (e) {
+          console.log(e);
+          next(e);
+        }
+      }
+    });
+  }
+  next();
+};
+
+module.exports = telegramMiddleware;

package.json

@@ -0,0 +1,24 @@
+{
+  "name": "express-notify-telegram",
+  "version": "1.0.0",
+  "description": "A simple Express middleware to notify errors into Telegram",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "telegram",
+    "express",
+    "errors"
+  ],
+  "author": "Azamat Abdullaev",
+  "license": "MIT",
+  "devDependencies": {
+    "eslint": "^7.11.0",
+    "eslint-config-airbnb-base": "^14.2.0",
+    "eslint-plugin-import": "^2.22.1"
+  },
+  "dependencies": {
+    "on-finished": "^2.3.0"
+  }
+}

src/sendMessage.js

@@ -0,0 +1,8 @@
+const https = require('https');
+
+const sendMessage = (botToken, query) => {
+  const API = `https://api.telegram.org/bot${botToken}/sendMessage?${query}`;
+  https.get(API);
+};
+
+module.exports = sendMessage;

src/templates/default.js

@@ -0,0 +1,23 @@
+const escape = require('../utils/escaper');
+
+module.exports = (req, res, options) => {
+  const notificationTitle = res.statusCode < 500 ? '⚠️⚠️⚠️ SERVER WARNING ⚠️⚠️⚠️' : '⛔️⛔️⛔️ SERVER ERROR ⛔️⛔️⛔️';
+  const endpoint = `\`${req.method}\` ${`${req.protocol}://${req.get('host')}${req.originalUrl}`}`;
+  const appName = options.appName || process.env.APP_NAME || 'Unknown application';
+
+  const message = `
+  *${notificationTitle}*
+    
+*🔺 APPLICATION:* ${escape(appName)}
+    
+*🔺 ENDPOINT:* ${endpoint}
+*🔺 STATUS_CODE:* ${res.statusCode}
+    
+*🔺 ERROR_MESSAGE:* ${escape(req.errorMessage || 'Unknown')}
+    
+*🔺 IP_ADDRESS:* ${escape(req.ip)}
+    
+*🔺REQUEST_BODY:* \`\`\`${JSON.stringify(req.body || {}, null, 2)}\`\`\`
+  `;
+  return message;
+};

src/utils/escaper.js

@@ -0,0 +1,9 @@
+/* eslint-disable no-useless-escape */
+module.exports = (string) => (
+  typeof string === 'string'
+    ? string
+      .replace(/[\*]/g, '\\*')
+      .replace(/[_]/g, '\\_')
+      .replace(/[\[]/g, '\\[')
+      .replace(/[`]/g, '\\`')
+    : string);

src/utils/print.js

@@ -0,0 +1,8 @@
+/* eslint-disable no-console */
+
+const printWarning = (text) => console.warn(
+  '\x1b[33m', 'express-notify-telegram ==>',
+  '\x1b[0m', text,
+);
+
+module.exports = { printWarning };