Added ability to use redis datastores for session data

config/default.json

@@ -6,5 +6,10 @@
   "database": {
     "driver": "sqlite",
     "connection_string": "data/overseer.db"
+  },
+  "redis": {
+    "host": "192.168.1.10",
+    "port": 6379,
+    "number": "0"
   }
 }

index.js

@@ -1,5 +1,6 @@
 const express = require('express');
 const session = require('express-session');
+const RedisStore = require('connect-redis')(session);
 // const flash = require('express-flasher');
 
 // instantiate new express.js app
@@ -14,8 +15,14 @@ const config = require('config');
   });
 })();
 
-// initialize express.js session
+// initialize Redis store for session data
+const redisClient = require('./src/redis');
+
+// initialize express.js session w/ Redis datastore
 app.use(session({
+  store: new RedisStore({
+    client: redisClient,
+  }), // use Redis datastore
   resave: false, // don't save session if unmodified
   saveUninitialized: false, // don't create session until something stored
   secret: 'lord of the rings',

package-lock.json

@@ -10,12 +10,14 @@
       "license": "BSD-2-Clause",
       "dependencies": {
         "config": "^3.3.8",
+        "connect-redis": "^6.1.3",
         "express": "^4.18.2",
         "express-session": "^1.17.3",
         "mariadb": "^3.0.2",
         "mysql2": "^2.3.3",
         "pg": "^8.8.0",
         "pg-hstore": "^2.3.4",
+        "redis": "^4.4.0",
         "sequelize": "^6.25.3",
         "sqlite3": "^5.1.2",
         "twig": "^1.15.4"
@@ -258,6 +260,59 @@
         "node": ">=10"
       }
     },
+    "node_modules/@redis/bloom": {
+      "version": "1.1.0",
+      "resolved": "https://registry.npmjs.org/@redis/bloom/-/bloom-1.1.0.tgz",
+      "integrity": "sha512-9QovlxmpRtvxVbN0UBcv8WfdSMudNZZTFqCsnBszcQXqaZb/TVe30ScgGEO7u1EAIacTPAo7/oCYjYAxiHLanQ==",
+      "peerDependencies": {
+        "@redis/client": "^1.0.0"
+      }
+    },
+    "node_modules/@redis/client": {
+      "version": "1.3.1",
+      "resolved": "https://registry.npmjs.org/@redis/client/-/client-1.3.1.tgz",
+      "integrity": "sha512-FKEHpOu7Q4+cuM6VWjA54988K5jkqOxvhvj2hEGSx086lvKwXyjzO7Lya7hcirZ0/Db8FLBJN7UXsJuyoNWPJg==",
+      "dependencies": {
+        "cluster-key-slot": "1.1.1",
+        "generic-pool": "3.9.0",
+        "yallist": "4.0.0"
+      },
+      "engines": {
+        "node": ">=14"
+      }
+    },
+    "node_modules/@redis/graph": {
+      "version": "1.1.0",
+      "resolved": "https://registry.npmjs.org/@redis/graph/-/graph-1.1.0.tgz",
+      "integrity": "sha512-16yZWngxyXPd+MJxeSr0dqh2AIOi8j9yXKcKCwVaKDbH3HTuETpDVPcLujhFYVPtYrngSco31BUcSa9TH31Gqg==",
+      "peerDependencies": {
+        "@redis/client": "^1.0.0"
+      }
+    },
+    "node_modules/@redis/json": {
+      "version": "1.0.4",
+      "resolved": "https://registry.npmjs.org/@redis/json/-/json-1.0.4.tgz",
+      "integrity": "sha512-LUZE2Gdrhg0Rx7AN+cZkb1e6HjoSKaeeW8rYnt89Tly13GBI5eP4CwDVr+MY8BAYfCg4/N15OUrtLoona9uSgw==",
+      "peerDependencies": {
+        "@redis/client": "^1.0.0"
+      }
+    },
+    "node_modules/@redis/search": {
+      "version": "1.1.0",
+      "resolved": "https://registry.npmjs.org/@redis/search/-/search-1.1.0.tgz",
+      "integrity": "sha512-NyFZEVnxIJEybpy+YskjgOJRNsfTYqaPbK/Buv6W2kmFNaRk85JiqjJZA5QkRmWvGbyQYwoO5QfDi2wHskKrQQ==",
+      "peerDependencies": {
+        "@redis/client": "^1.0.0"
+      }
+    },
+    "node_modules/@redis/time-series": {
+      "version": "1.0.3",
+      "resolved": "https://registry.npmjs.org/@redis/time-series/-/time-series-1.0.3.tgz",
+      "integrity": "sha512-OFp0q4SGrTH0Mruf6oFsHGea58u8vS/iI5+NpYdicaM+7BgqBZH8FFvNZ8rYYLrUO/QRqMq72NpXmxLVNcdmjA==",
+      "peerDependencies": {
+        "@redis/client": "^1.0.0"
+      }
+    },
     "node_modules/@tootallnate/once": {
       "version": "1.1.2",
       "resolved": "https://registry.npmjs.org/@tootallnate/once/-/once-1.1.2.tgz",
@@ -738,6 +793,14 @@
         "node": ">=6"
       }
     },
+    "node_modules/cluster-key-slot": {
+      "version": "1.1.1",
+      "resolved": "https://registry.npmjs.org/cluster-key-slot/-/cluster-key-slot-1.1.1.tgz",
+      "integrity": "sha512-rwHwUfXL40Chm1r08yrhU3qpUvdVlgkKNeyeGPOxnW8/SyVDvgRaed/Uz54AqWNaTCAThlj6QAs3TZcKI0xDEw==",
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
     "node_modules/code-point-at": {
       "version": "1.1.0",
       "resolved": "https://registry.npmjs.org/code-point-at/-/code-point-at-1.1.0.tgz",
@@ -797,6 +860,14 @@
         "node": ">= 10.0.0"
       }
     },
+    "node_modules/connect-redis": {
+      "version": "6.1.3",
+      "resolved": "https://registry.npmjs.org/connect-redis/-/connect-redis-6.1.3.tgz",
+      "integrity": "sha512-aaNluLlAn/3JPxRwdzw7lhvEoU6Enb+d83xnokUNhC9dktqBoawKWL+WuxinxvBLTz6q9vReTnUDnUslaz74aw==",
+      "engines": {
+        "node": ">=12"
+      }
+    },
     "node_modules/console-control-strings": {
       "version": "1.1.0",
       "resolved": "https://registry.npmjs.org/console-control-strings/-/console-control-strings-1.1.0.tgz",
@@ -1982,6 +2053,14 @@
         "is-property": "^1.0.2"
       }
     },
+    "node_modules/generic-pool": {
+      "version": "3.9.0",
+      "resolved": "https://registry.npmjs.org/generic-pool/-/generic-pool-3.9.0.tgz",
+      "integrity": "sha512-hymDOu5B53XvN4QT9dBmZxPX4CWhBPPLguTZ9MMFeFa/Kg0xWVfylOVNlJji/E7yTZWFd/q9GO5TxDLq156D7g==",
+      "engines": {
+        "node": ">= 4"
+      }
+    },
     "node_modules/get-intrinsic": {
       "version": "1.1.3",
       "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.1.3.tgz",
@@ -4711,6 +4790,19 @@
         "node": ">= 0.8"
       }
     },
+    "node_modules/redis": {
+      "version": "4.4.0",
+      "resolved": "https://registry.npmjs.org/redis/-/redis-4.4.0.tgz",
+      "integrity": "sha512-tQyFG6O9iewLxxHYRyirJNklhe2QI7M/0o8q0jk7D9Z/Cxh/7oZrQyHKyjWz0TkkCls8ool/xvhL9K8zRnkaYQ==",
+      "dependencies": {
+        "@redis/bloom": "1.1.0",
+        "@redis/client": "1.3.1",
+        "@redis/graph": "1.1.0",
+        "@redis/json": "1.0.4",
+        "@redis/search": "1.1.0",
+        "@redis/time-series": "1.0.3"
+      }
+    },
     "node_modules/regenerator-runtime": {
       "version": "0.13.10",
       "resolved": "https://registry.npmjs.org/regenerator-runtime/-/regenerator-runtime-0.13.10.tgz",
@@ -6062,6 +6154,46 @@
         "rimraf": "^3.0.2"
       }
     },
+    "@redis/bloom": {
+      "version": "1.1.0",
+      "resolved": "https://registry.npmjs.org/@redis/bloom/-/bloom-1.1.0.tgz",
+      "integrity": "sha512-9QovlxmpRtvxVbN0UBcv8WfdSMudNZZTFqCsnBszcQXqaZb/TVe30ScgGEO7u1EAIacTPAo7/oCYjYAxiHLanQ==",
+      "requires": {}
+    },
+    "@redis/client": {
+      "version": "1.3.1",
+      "resolved": "https://registry.npmjs.org/@redis/client/-/client-1.3.1.tgz",
+      "integrity": "sha512-FKEHpOu7Q4+cuM6VWjA54988K5jkqOxvhvj2hEGSx086lvKwXyjzO7Lya7hcirZ0/Db8FLBJN7UXsJuyoNWPJg==",
+      "requires": {
+        "cluster-key-slot": "1.1.1",
+        "generic-pool": "3.9.0",
+        "yallist": "4.0.0"
+      }
+    },
+    "@redis/graph": {
+      "version": "1.1.0",
+      "resolved": "https://registry.npmjs.org/@redis/graph/-/graph-1.1.0.tgz",
+      "integrity": "sha512-16yZWngxyXPd+MJxeSr0dqh2AIOi8j9yXKcKCwVaKDbH3HTuETpDVPcLujhFYVPtYrngSco31BUcSa9TH31Gqg==",
+      "requires": {}
+    },
+    "@redis/json": {
+      "version": "1.0.4",
+      "resolved": "https://registry.npmjs.org/@redis/json/-/json-1.0.4.tgz",
+      "integrity": "sha512-LUZE2Gdrhg0Rx7AN+cZkb1e6HjoSKaeeW8rYnt89Tly13GBI5eP4CwDVr+MY8BAYfCg4/N15OUrtLoona9uSgw==",
+      "requires": {}
+    },
+    "@redis/search": {
+      "version": "1.1.0",
+      "resolved": "https://registry.npmjs.org/@redis/search/-/search-1.1.0.tgz",
+      "integrity": "sha512-NyFZEVnxIJEybpy+YskjgOJRNsfTYqaPbK/Buv6W2kmFNaRk85JiqjJZA5QkRmWvGbyQYwoO5QfDi2wHskKrQQ==",
+      "requires": {}
+    },
+    "@redis/time-series": {
+      "version": "1.0.3",
+      "resolved": "https://registry.npmjs.org/@redis/time-series/-/time-series-1.0.3.tgz",
+      "integrity": "sha512-OFp0q4SGrTH0Mruf6oFsHGea58u8vS/iI5+NpYdicaM+7BgqBZH8FFvNZ8rYYLrUO/QRqMq72NpXmxLVNcdmjA==",
+      "requires": {}
+    },
     "@tootallnate/once": {
       "version": "1.1.2",
       "resolved": "https://registry.npmjs.org/@tootallnate/once/-/once-1.1.2.tgz",
@@ -6442,6 +6574,11 @@
       "integrity": "sha512-4diC9HaTE+KRAMWhDhrGOECgWZxoevMc5TlkObMqNSsVU62PYzXZ/SMTjzyGAFF1YusgxGcSWTEXBhp0CPwQ1A==",
       "optional": true
     },
+    "cluster-key-slot": {
+      "version": "1.1.1",
+      "resolved": "https://registry.npmjs.org/cluster-key-slot/-/cluster-key-slot-1.1.1.tgz",
+      "integrity": "sha512-rwHwUfXL40Chm1r08yrhU3qpUvdVlgkKNeyeGPOxnW8/SyVDvgRaed/Uz54AqWNaTCAThlj6QAs3TZcKI0xDEw=="
+    },
     "code-point-at": {
       "version": "1.1.0",
       "resolved": "https://registry.npmjs.org/code-point-at/-/code-point-at-1.1.0.tgz",
@@ -6486,6 +6623,11 @@
         "json5": "^2.2.1"
       }
     },
+    "connect-redis": {
+      "version": "6.1.3",
+      "resolved": "https://registry.npmjs.org/connect-redis/-/connect-redis-6.1.3.tgz",
+      "integrity": "sha512-aaNluLlAn/3JPxRwdzw7lhvEoU6Enb+d83xnokUNhC9dktqBoawKWL+WuxinxvBLTz6q9vReTnUDnUslaz74aw=="
+    },
     "console-control-strings": {
       "version": "1.1.0",
       "resolved": "https://registry.npmjs.org/console-control-strings/-/console-control-strings-1.1.0.tgz",
@@ -7393,6 +7535,11 @@
         "is-property": "^1.0.2"
       }
     },
+    "generic-pool": {
+      "version": "3.9.0",
+      "resolved": "https://registry.npmjs.org/generic-pool/-/generic-pool-3.9.0.tgz",
+      "integrity": "sha512-hymDOu5B53XvN4QT9dBmZxPX4CWhBPPLguTZ9MMFeFa/Kg0xWVfylOVNlJji/E7yTZWFd/q9GO5TxDLq156D7g=="
+    },
     "get-intrinsic": {
       "version": "1.1.3",
       "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.1.3.tgz",
@@ -9468,6 +9615,19 @@
         "unpipe": "1.0.0"
       }
     },
+    "redis": {
+      "version": "4.4.0",
+      "resolved": "https://registry.npmjs.org/redis/-/redis-4.4.0.tgz",
+      "integrity": "sha512-tQyFG6O9iewLxxHYRyirJNklhe2QI7M/0o8q0jk7D9Z/Cxh/7oZrQyHKyjWz0TkkCls8ool/xvhL9K8zRnkaYQ==",
+      "requires": {
+        "@redis/bloom": "1.1.0",
+        "@redis/client": "1.3.1",
+        "@redis/graph": "1.1.0",
+        "@redis/json": "1.0.4",
+        "@redis/search": "1.1.0",
+        "@redis/time-series": "1.0.3"
+      }
+    },
     "regenerator-runtime": {
       "version": "0.13.10",
       "resolved": "https://registry.npmjs.org/regenerator-runtime/-/regenerator-runtime-0.13.10.tgz",

package.json

@@ -40,12 +40,14 @@
   },
   "dependencies": {
     "config": "^3.3.8",
+    "connect-redis": "^6.1.3",
     "express": "^4.18.2",
     "express-session": "^1.17.3",
     "mariadb": "^3.0.2",
     "mysql2": "^2.3.3",
     "pg": "^8.8.0",
     "pg-hstore": "^2.3.4",
+    "redis": "^4.4.0",
     "sequelize": "^6.25.3",
     "sqlite3": "^5.1.2",
     "twig": "^1.15.4"

src/redis.js

@@ -0,0 +1,31 @@
+const redisConfig = require('config').get('redis');
+
+exports.default = function() {
+  let redisUrl = 'redis://';
+
+  // add the redis username if defined
+  if (typeof redisConfig.get('username') !== 'undefined') {
+    redisUrl += redisConfig.get('username');
+  }
+  // add the user password if defined
+  if (typeof redisConfig.get('password') !== 'undefined') {
+    redisUrl += ':' + redisConfig.get('password') + '@';
+  }
+  // add redis host URL
+  redisUrl += redisConfig.get('host');
+  // add redis host port
+  redisUrl += ':' + redisConfig.get('port');
+  // add redis database number if defined
+  if (typeof redisConfig.get('number') !== 'undefined') {
+    redisUrl += redisConfig.get('number');
+  }
+
+  const { createClient } = require("redis");
+  let redisClient = createClient({
+    url: redisUrl,
+    legacyMode: true,
+  });
+  redisClient.connect().catch(console.error);
+
+  return redisClient;
+};