fix(redis): Show a warning on the dashboard if Amazon ElastiCache is …

…used as the database
postalsys · Dec 12, 2023 · 814e724 · 814e724
1 parent 086f1c6
commit 814e724
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 1 deletion.
diff --git a/lib/routes-ui.js b/lib/routes-ui.js
@@ -837,6 +837,9 @@ function applyRoutes(server, call) {
                     stats,
                     counterList,
                     hasAccounts,
+
+                    isElastiCache: ['elasticache'].includes(stats.redisSoftware),
+
                     redisPing: {
                         key: 'redisPing',
                         title: 'Redis Latency',

diff --git a/lib/tools.js b/lib/tools.js
@@ -1125,6 +1125,7 @@ MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEV3QUiYsp13nD9suD1/ZkEXnuMoSg
 
         let redisVersion;
         let softwareDetails;
+        let redisSoftware;
         try {
             let redisInfo = await module.exports.getRedisStats(redis);
             if (!redisInfo || typeof redisInfo.redis_version !== 'string') {
@@ -1135,21 +1136,31 @@ MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEV3QUiYsp13nD9suD1/ZkEXnuMoSg
             // Detect Dragonfly
             if (typeof redisInfo.dragonfly_version === 'string') {
                 softwareDetails = `Dragonfly v${redisInfo.dragonfly_version.replace(/^[^\d]*/, '')}`;
+                redisSoftware = 'dragonfly';
             }
 
             // Detect KeyDB
             if (typeof redisInfo.mvcc_depth === 'number') {
                 softwareDetails = `KeyDB`;
+                redisSoftware = 'keydb';
             }
 
             // Detect Upstash
             if (typeof redisInfo.upstash_version === 'string') {
                 softwareDetails = `Upstash Redis v${redisInfo.upstash_version.replace(/^[^\d]*/, '')}`;
+                redisSoftware = 'upstash';
             }
 
             // Detect Memurai
             if (typeof redisInfo.memurai_version === 'string') {
                 softwareDetails = `${redisInfo.memurai_edition || 'Memurai'} v${redisInfo.memurai_version.replace(/^[^\d]*/, '')}`;
+                redisSoftware = 'memurai';
+            }
+
+            // Detect ElastiCache
+            if (/Amazon ElastiCache/i.test(redisInfo.os)) {
+                softwareDetails = `Amazon ElastiCache`;
+                redisSoftware = 'elasticache';
             }
         } catch (err) {
             console.log(err);
@@ -1193,6 +1204,7 @@ MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEV3QUiYsp13nD9suD1/ZkEXnuMoSg
                 accounts: await redis.scard(`${REDIS_PREFIX}ia:accounts`),
                 node: process.versions.node,
                 redis: `${redisVersion}${softwareDetails ? ` (${softwareDetails})` : ''}`,
+                redisSoftware,
                 imapflow: ImapFlow.version || 'please upgrade',
                 bullmq: bullmqPackage.version,
                 arch: process.arch,

diff --git a/views/dashboard.hbs b/views/dashboard.hbs
@@ -5,14 +5,33 @@
     </div>
 
 
+    {{#if isElastiCache}}
+    <div class="card border-left-danger mt-4">
+        <div class="card-body">
+            <div class="row no-gutters align-items-center">
+                <div class="col mr-2">
+                    <div class="text-xs font-weight-bold text-danger text-uppercase mb-1">Compatiblity warning
+                    </div>
+                    <p>EmailEngine is incompatible with Amazon ElastiCache as the database backend.</p>
+                    <p>Please switch to a standard Redis instance. Using ElastiCache with EmailEngine can result in data
+                        loss and several functionalities may not work.</p>
+                </div>
+                <div class="col-auto">
+                    <i class="fas fa-exclamation-circle fa-2x text-gray-300"></i>
+                </div>
+            </div>
+        </div>
+    </div>
+    {{/if}}
+
 
     {{#unless hasAccounts}}
 
     <div class="card border-left-success mt-4">
         <div class="card-body">
             <div class="row no-gutters align-items-center">
                 <div class="col mr-2">
-                    <div class="text-xs font-weight-bold text-danger text-uppercase mb-1">Welcome to EmailEngine!
+                    <div class="text-xs font-weight-bold text-success text-uppercase mb-1">Welcome to EmailEngine!
                     </div>
                     <p>To start using EmailEngine, add an email account to the <a href="/admin/accounts">account
                             registry</a>. Once registered, you can access this account to send