fix(*): Fix bug where text channel names are automatically lowercased by Discord so couldn't be deleted if the username had capital letters

config.json

@@ -2,6 +2,11 @@
   "channeldeletetimeinminutes": 30,
   "deletecommandstoggle": false,
   "maxqueuesize": 4,
+  "elasticsearch" : {
+    "elasticsearch_address" : "http://jcreek.ddns.net:9200",
+    "elasticsearch_index_pattern" : "[logs-denbot-]YYYY.MM.DD"
+  },
   "prefix": "!",
+  "token-dev": "Nzc4MDI2MTE1NDkwOTA2MTYz.X7L_SA.bNzC1kQUpBSwEsjp_cDGwR62Soo",
 	"token": "NzcwMDQyMDEzMjY5NDkxNzUy.X5Xzgg.kcr_51g95iUvEcYCfbQvG1Sx8ao"
 }

index.js

@@ -1,22 +1,69 @@
 const Discord = require('discord.js');
 const winston = require('winston');
+const Elasticsearch = require('winston-elasticsearch');
 const config = require('./config.json');
 const client = new Discord.Client();
 
+const { format } = winston;
+const { combine, timestamp } = format;
+
+let env = 'dev';
+if (process.env.NODE_ENV === 'production') {
+  env = 'prod';
+}
+
+// Custom format function that will look for an error object and log out the stack and if
+// its not production, the error itself
+const myFormat = format.printf((info) => {
+  const { timestamp: tmsmp, level, message, error, ...rest } = info;
+  let log = `${tmsmp} - ${level}:\t${message}`;
+  // Only if there is an error
+  if ( error ) {
+    if ( error.stack) log = `${log}\n${error.stack}`;
+    if (process.env.NODE_ENV !== 'production') log = `${log}\n${JSON.stringify(error, null, 2)}`;
+  }
+  // Check if rest is object
+  if ( !( Object.keys(rest).length === 0 && rest.constructor === Object ) ) {
+    log = `${log}\n${JSON.stringify(rest, null, 2)}`;
+  }
+  return log;
+});
+
+const esTransportOpts = {
+  level: 'info',
+  indexPrefix: 'logs_denbot',
+  clientOpts: {
+      host: config.elasticsearch.elasticsearch_address,
+      log: 'info'
+  },
+  transformer: logData => {
+      return {
+        timestamp: new Date().toISOString(),
+        severity: logData.level,
+        message: logData.message,
+        meta: {
+          app: 'denBot',
+          env: env,
+          stack: logData.meta.stack
+        }
+      }
+  }
+};
+
 const logger = winston.createLogger({
   level: 'info',
-  format: winston.format.combine(
+  format: combine(
+    winston.format.errors({ stack: true }), // <-- use errors format
     winston.format.timestamp(),
+    winston.format.prettyPrint(),
+    myFormat,
     winston.format.json()
   ),
   defaultMeta: { service: 'user-service' },
   transports: [
-    //
-    // - Write all logs with level `error` and below to `error.log`
-    // - Write all logs with level `info` and below to `combined.log`
-    //
     new winston.transports.File({ filename: 'error.log', level: 'error' }),
     new winston.transports.File({ filename: 'combined.log' }),
+    new Elasticsearch(esTransportOpts)
   ],
 });
 
@@ -24,18 +71,19 @@ const logger = winston.createLogger({
 // If we're not in production then log to the `console` with the format:
 // `${info.level}: ${info.message} JSON.stringify({ ...rest }) `
 //
-if (process.env.NODE_ENV !== 'production') {
+//if (process.env.NODE_ENV !== 'production') {
   logger.add(new winston.transports.Console({
     format: winston.format.simple(),
   }));
-}
+//}
+
 let playerQueue = [];
 let pokemonName = '';
 let captainInGameName = '';
 
 client.login(config.token);
 client.once('ready', () =>{
-	logger.log('info', 'denBot logged in successfully!');
+  logger.info('denBot logged in successfully!');
 })
 
 /*
@@ -81,7 +129,7 @@ function checkQueue(message) {
         client.users.cache.get(player.id).send(adventureMessage);
       });
     } catch (error) {
-      logger.log('error', error);
+      logger.error('Tried to DM users: ', error);
       message.channel.send(`There was an error, please let an admin know!\n${error}`);
     }
 
@@ -108,6 +156,7 @@ function checkQueue(message) {
 }
 
 function getUserFromMention(mention) {
+	try {
     if (!mention) return;
 
     if (mention.startsWith('<@') && mention.endsWith('>')) {
@@ -119,6 +168,9 @@ function getUserFromMention(mention) {
 
       return client.users.cache.get(mention);
     }
+  } catch (error) {
+    logger.error('Tried to get users from mention: ', error);
+  }
 }
 
 function getChannelName(username) {
@@ -155,19 +207,29 @@ function makeTempChannel(message, adventureMessage) {
   })
     .catch(logger.error);
 
+  try {
     // Delete the channel after the configured amount of minutes
     setTimeout(function(){ deleteChannel(message, channelName); }, (config.channeldeletetimeinminutes * 1000 * 60) );
+  } catch (error) {
+    logger.error(`Tried to delete channel ${channelName} after timeout: `, error);
+  }
 }
 
 function deleteChannel(message, channelName) {
   try {
     // Get a Channel by Name
-    const fetchedChannel = message.guild.channels.cache.find(channel => channel.name === channelName);
+    const fetchedChannel = message.guild.channels.cache.find(channel => channel.name.toLowerCase() == channelName.toLowerCase());
 
     logger.info(`Deleting temp channel ${channelName}`)
     fetchedChannel.delete();
   } catch (error) {
-    logger.error(error);
+    logger.error(`Tried to delete channel ${channelName}: `, error);
+
+    let names = [];
+    message.guild.channels.cache.forEach(channel => {
+      names.push(channel.name);
+    });
+    logger.info(`Channel names in cache: ${names}`);
   }
 }
 
@@ -188,6 +250,8 @@ client.on('message', function (message) {
       message.delete();
     }
 
+    logger.info(`${message.author.username} used command q in ${message.channel.name}`);
+
 		logger.log('info', `${message.author.username} joined the queue.`);
 		message.channel.send(`=====\n${message.author.username} joined the queue.`);
 
@@ -206,6 +270,9 @@ client.on('message', function (message) {
 		if (config.deletecommandstoggle) {
       message.delete();
     }
+
+    logger.info(`${message.author.username} used command q in ${message.channel.name}`);
+
 		message.channel.send(`${message.author.username} is too keen, you're already in the queue mate!`);
   }
 
@@ -216,6 +283,8 @@ client.on('message', function (message) {
       message.delete();
     }
 
+    logger.info(`${message.author.username} used command lq in ${message.channel.name}`);
+
 		logger.log('info', `${message.author.username} left the queue.`);
 		message.channel.send(`${message.author.username} left the queue.`);
 
@@ -233,6 +302,9 @@ client.on('message', function (message) {
 		if (config.deletecommandstoggle) {
       message.delete();
     }
+
+    logger.info(`${message.author.username} used command lq in ${message.channel.name}`);
+
 		message.channel.send(`${message.author.username} you can't leave the queue before you've joined it!`);
   }
 
@@ -242,6 +314,9 @@ client.on('message', function (message) {
 		if (config.deletecommandstoggle) {
       message.delete();
     }
+
+    logger.info(`${message.author.username} used command sq in ${message.channel.name}`);
+
 		checkQueue(message);
 	}
 
@@ -252,6 +327,8 @@ client.on('message', function (message) {
       message.delete();
     }
 
+    logger.info(`${message.author.username} used command cq in ${message.channel.name}`);
+
     if (playerQueue.length === 0) {
       message.channel.send(`The queue is already empty...`);
       logger.log('info', `${message.author.username} attempted to clear the queue but it was already empty.`);
@@ -272,6 +349,8 @@ client.on('message', function (message) {
       message.delete();
     }
 
+    logger.info(`${message.author.username} used command ru in ${message.channel.name}`);
+
     if ((playerQueue.includes(user))) {
 
       // Search for the user
@@ -294,14 +373,16 @@ client.on('message', function (message) {
   }
 
   if (command === 'dc') {
-    // todo - add logic here to determine if they can delete the channel (i.e. it's their temporary one) - compare the name
+    logger.info(`${message.author.username} used command dc in ${message.channel.name}`);
+
+    // Determine if they can delete the channel (i.e. it's their temporary one) - compare the name
     if (message.channel.name === getChannelName(message.author.username)) {
       deleteChannel(message, message.channel.name)
       logger.log('info', `${message.author.username} deleted their adventure channel.`);
     }
     else {
       message.channel.send(`${message.author.username} is not allowed to delete this channel.`);
-      logger.log('info', `${message.author.username} attempted to delete channel ${message.channel.id} but it's not their adventure channel.`);
+      logger.log('info', `${message.author.username} attempted to delete channel ${message.channel.name} but it's not their adventure channel.`);
     }
   }
 

package-lock.json

@@ -37,6 +37,29 @@
         "event-target-shim": "^5.0.0"
       }
     },
+    "agentkeepalive": {
+      "version": "3.5.2",
+      "resolved": "https://registry.npmjs.org/agentkeepalive/-/agentkeepalive-3.5.2.tgz",
+      "integrity": "sha512-e0L/HNe6qkQ7H19kTlRRqUibEAwDK5AFk6y3PtMsuut2VAH6+Q4xZml1tNDJD7kSAyqmbG/K08K5WEJYtUrSlQ==",
+      "requires": {
+        "humanize-ms": "^1.2.1"
+      }
+    },
+    "ansi-regex": {
+      "version": "2.1.1",
+      "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-2.1.1.tgz",
+      "integrity": "sha1-w7M6te42DYbg5ijwRorn7yfWVN8="
+    },
+    "ansi-styles": {
+      "version": "2.2.1",
+      "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-2.2.1.tgz",
+      "integrity": "sha1-tDLdM1i2NM914eRmQ2gkBTPB3b4="
+    },
+    "asap": {
+      "version": "2.0.6",
+      "resolved": "https://registry.npmjs.org/asap/-/asap-2.0.6.tgz",
+      "integrity": "sha1-5QNHYR1+aQlDIIu9r+vLwvuGbUY="
+    },
     "async": {
       "version": "3.2.0",
       "resolved": "https://registry.npmjs.org/async/-/async-3.2.0.tgz",
@@ -47,6 +70,18 @@
       "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz",
       "integrity": "sha1-x57Zf380y48robyXkLzDZkdLS3k="
     },
+    "chalk": {
+      "version": "1.1.3",
+      "resolved": "https://registry.npmjs.org/chalk/-/chalk-1.1.3.tgz",
+      "integrity": "sha1-qBFcVeSnAv5NFQq9OHKCKn4J/Jg=",
+      "requires": {
+        "ansi-styles": "^2.2.1",
+        "escape-string-regexp": "^1.0.2",
+        "has-ansi": "^2.0.0",
+        "strip-ansi": "^3.0.0",
+        "supports-color": "^2.0.0"
+      }
+    },
     "color": {
       "version": "3.0.0",
       "resolved": "https://registry.npmjs.org/color/-/color-3.0.0.tgz",
@@ -105,6 +140,14 @@
       "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.2.tgz",
       "integrity": "sha1-tf1UIgqivFq1eqtxQMlAdUUDwac="
     },
+    "debug": {
+      "version": "4.1.1",
+      "resolved": "https://registry.npmjs.org/debug/-/debug-4.1.1.tgz",
+      "integrity": "sha512-pYAIzeRo8J6KPEaJ0VWOh5Pzkbw/RetuzehGM7QRRX5he4fPHx2rdKMB256ehJCkX+XRQm16eZLqLNS8RSZXZw==",
+      "requires": {
+        "ms": "^2.1.1"
+      }
+    },
     "delayed-stream": {
       "version": "1.0.0",
       "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz",
@@ -125,11 +168,26 @@
         "ws": "^7.3.1"
       }
     },
+    "elasticsearch": {
+      "version": "16.7.1",
+      "resolved": "https://registry.npmjs.org/elasticsearch/-/elasticsearch-16.7.1.tgz",
+      "integrity": "sha512-PL/BxB03VGbbghJwISYvVcrR9KbSSkuQ7OM//jHJg/End/uC2fvXg4QI7RXLvCGbhBuNQ8dPue7DOOPra73PCw==",
+      "requires": {
+        "agentkeepalive": "^3.4.1",
+        "chalk": "^1.0.0",
+        "lodash": "^4.17.10"
+      }
+    },
     "enabled": {
       "version": "2.0.0",
       "resolved": "https://registry.npmjs.org/enabled/-/enabled-2.0.0.tgz",
       "integrity": "sha512-AKrN98kuwOzMIdAizXGI86UFBoo26CL21UM763y1h/GMSJ4/OHU9k2YlsmBpyScFo/wbLzWQJBMCW4+IO3/+OQ=="
     },
+    "escape-string-regexp": {
+      "version": "1.0.5",
+      "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz",
+      "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ="
+    },
     "event-target-shim": {
       "version": "5.0.1",
       "resolved": "https://registry.npmjs.org/event-target-shim/-/event-target-shim-5.0.1.tgz",
@@ -150,6 +208,22 @@
       "resolved": "https://registry.npmjs.org/fn.name/-/fn.name-1.1.0.tgz",
       "integrity": "sha512-GRnmB5gPyJpAhTQdSZTSp9uaPSvl09KoYcMQtsB9rQoOmzs9dH6ffeccH+Z+cv6P68Hu5bC6JjRh4Ah/mHSNRw=="
     },
+    "has-ansi": {
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/has-ansi/-/has-ansi-2.0.0.tgz",
+      "integrity": "sha1-NPUEnOHs3ysGSa8+8k5F7TVBbZE=",
+      "requires": {
+        "ansi-regex": "^2.0.0"
+      }
+    },
+    "humanize-ms": {
+      "version": "1.2.1",
+      "resolved": "https://registry.npmjs.org/humanize-ms/-/humanize-ms-1.2.1.tgz",
+      "integrity": "sha1-xG4xWaKT9riW2ikxbYtv6Lt5u+0=",
+      "requires": {
+        "ms": "^2.0.0"
+      }
+    },
     "inherits": {
       "version": "2.0.4",
       "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz",
@@ -175,6 +249,11 @@
       "resolved": "https://registry.npmjs.org/kuler/-/kuler-2.0.0.tgz",
       "integrity": "sha512-Xq9nH7KlWZmXAtodXDDRE7vs6DU1gTU8zYDHDiWLSip45Egwq3plLHzPn27NgvzL2r1LMPC1vdqh98sQxtqj4A=="
     },
+    "lodash": {
+      "version": "4.17.20",
+      "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.20.tgz",
+      "integrity": "sha512-PlhdFcillOINfeV7Ni6oF1TAEayyZBoZ8bcshTHqOYJYlrqzRK5hagpagky5o4HfCzzd1TRkXPMFq6cKk9rGmA=="
+    },
     "logform": {
       "version": "2.2.0",
       "resolved": "https://registry.npmjs.org/logform/-/logform-2.2.0.tgz",
@@ -200,6 +279,11 @@
         "mime-db": "1.44.0"
       }
     },
+    "moment": {
+      "version": "2.29.1",
+      "resolved": "https://registry.npmjs.org/moment/-/moment-2.29.1.tgz",
+      "integrity": "sha512-kHmoybcPV8Sqy59DwNDY3Jefr64lK/by/da0ViFcuA4DH0vQg5Q6Ze5VimxkfQNSC+Mls/Kx53s7TjP1RhFEDQ=="
+    },
     "ms": {
       "version": "2.1.2",
       "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz",
@@ -228,6 +312,14 @@
       "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.1.tgz",
       "integrity": "sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag=="
     },
+    "promise": {
+      "version": "8.1.0",
+      "resolved": "https://registry.npmjs.org/promise/-/promise-8.1.0.tgz",
+      "integrity": "sha512-W04AqnILOL/sPRXziNicCjSNRruLAuIHEOVBazepu0545DDNGYHz7ar9ZgZ1fMU8/MA4mVxp5rkBWRi6OXIy3Q==",
+      "requires": {
+        "asap": "~2.0.6"
+      }
+    },
     "readable-stream": {
       "version": "3.6.0",
       "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.0.tgz",
@@ -238,6 +330,11 @@
         "util-deprecate": "^1.0.1"
       }
     },
+    "retry": {
+      "version": "0.12.0",
+      "resolved": "https://registry.npmjs.org/retry/-/retry-0.12.0.tgz",
+      "integrity": "sha1-G0KmJmoh8HQh0bC1S33BZ7AcATs="
+    },
     "safe-buffer": {
       "version": "5.2.1",
       "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz",
@@ -269,6 +366,19 @@
         "safe-buffer": "~5.2.0"
       }
     },
+    "strip-ansi": {
+      "version": "3.0.1",
+      "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-3.0.1.tgz",
+      "integrity": "sha1-ajhfuIU9lS1f8F0Oiq+UJ43GPc8=",
+      "requires": {
+        "ansi-regex": "^2.0.0"
+      }
+    },
+    "supports-color": {
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-2.0.0.tgz",
+      "integrity": "sha1-U10EXOa2Nj+kARcIRimZXp3zJMc="
+    },
     "text-hex": {
       "version": "1.0.0",
       "resolved": "https://registry.npmjs.org/text-hex/-/text-hex-1.0.0.tgz",
@@ -305,6 +415,60 @@
         "winston-transport": "^4.4.0"
       }
     },
+    "winston-elasticsearch": {
+      "version": "0.7.12",
+      "resolved": "https://registry.npmjs.org/winston-elasticsearch/-/winston-elasticsearch-0.7.12.tgz",
+      "integrity": "sha512-nH35GlCD/vIFKNFUQSTd16esNKqLgaQgMvCoz3amXNNf8LWq4lYejTWhDQQpKQr+8EA2NOWfSGa2hYECQm/bGA==",
+      "requires": {
+        "debug": "4.1.1",
+        "elasticsearch": "^16.0.0",
+        "lodash": "^4.17.11",
+        "moment": "^2.24.0",
+        "promise": "^8.0.3",
+        "retry": "^0.12.0",
+        "triple-beam": "^1.3.0",
+        "winston": "^3.2.1",
+        "winston-transport": "4.3.0"
+      },
+      "dependencies": {
+        "readable-stream": {
+          "version": "2.3.7",
+          "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.7.tgz",
+          "integrity": "sha512-Ebho8K4jIbHAxnuxi7o42OrZgF/ZTNcsZj6nRKyUmkhLFq8CHItp/fy6hQZuZmP/n3yZ9VBUbp4zz/mX8hmYPw==",
+          "requires": {
+            "core-util-is": "~1.0.0",
+            "inherits": "~2.0.3",
+            "isarray": "~1.0.0",
+            "process-nextick-args": "~2.0.0",
+            "safe-buffer": "~5.1.1",
+            "string_decoder": "~1.1.1",
+            "util-deprecate": "~1.0.1"
+          }
+        },
+        "safe-buffer": {
+          "version": "5.1.2",
+          "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz",
+          "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g=="
+        },
+        "string_decoder": {
+          "version": "1.1.1",
+          "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz",
+          "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==",
+          "requires": {
+            "safe-buffer": "~5.1.0"
+          }
+        },
+        "winston-transport": {
+          "version": "4.3.0",
+          "resolved": "https://registry.npmjs.org/winston-transport/-/winston-transport-4.3.0.tgz",
+          "integrity": "sha512-B2wPuwUi3vhzn/51Uukcao4dIduEiPOcOt9HJ3QeaXgkJ5Z7UwpBzxS4ZGNHtrxrUvTwemsQiSys0ihOf8Mp1A==",
+          "requires": {
+            "readable-stream": "^2.3.6",
+            "triple-beam": "^1.2.0"
+          }
+        }
+      }
+    },
     "winston-transport": {
       "version": "4.4.0",
       "resolved": "https://registry.npmjs.org/winston-transport/-/winston-transport-4.4.0.tgz",

package.json

@@ -10,6 +10,7 @@
   "license": "ISC",
   "dependencies": {
     "discord.js": "12.4.1",
-    "winston": "3.3.3"
+    "winston": "3.3.3",
+    "winston-elasticsearch": "^0.7.12"
   }
 }