feat: Adds Redis Sentinel support. (#74)

Author: ryasmi

package-lock.json

@@ -37,7 +37,7 @@
     "@learninglocker/xapi-activities": "^4.0.2",
     "@learninglocker/xapi-agents": "^4.0.3",
     "@learninglocker/xapi-state": "^4.0.2",
-    "@learninglocker/xapi-statements": "^6.0.4",
+    "@learninglocker/xapi-statements": "^7.0.0",
     "boolean": "^0.1.2",
     "dotenv": "^5.0.0",
     "express": "^4.14.1",
@@ -54,6 +54,7 @@
     "@types/dotenv": "4.0.2",
     "@types/express": "4.11.1",
     "@types/google-cloud__storage": "1.1.7",
+    "@types/ioredis": "3.2.5",
     "@types/lodash": "4.14.104",
     "@types/mongodb": "3.0.5",
     "@types/node": "9.4.6",

package.json

@@ -1,4 +1,5 @@
 import { S3 } from 'aws-sdk';
+import { Redis } from 'ioredis';
 import Tracker from 'jscommons/dist/tracker/Tracker';
 import { Db } from 'mongodb';
 import { LoggerInstance } from 'winston';
@@ -35,7 +36,11 @@ export default interface AppConfig {
     };
     readonly redis: {
       readonly prefix: string;
-      readonly url: string;
+      readonly client: () => Promise<Redis>;
+    };
+    readonly sentinel: {
+      readonly prefix: string;
+      readonly client: () => Promise<Redis>;
     };
   };
   readonly service: {

src/apps/AppConfig.ts

@@ -78,6 +78,7 @@ export default (appConfig: AppConfig): Router => {
       mongo: appConfig.repo.mongo,
       redis: appConfig.repo.redis,
       s3: appConfig.repo.s3,
+      sentinel: appConfig.repo.sentinel,
       storageSubFolder: appConfig.repo.storageSubFolders.statements,
     },
     service: appConfig.service.statements,

src/apps/app.ts

@@ -1,4 +1,5 @@
 import * as S3 from 'aws-sdk/clients/s3';
+import { Redis } from 'ioredis';
 import Tracker from 'jscommons/dist/tracker/Tracker';
 import { Db } from 'mongodb';
 import { LoggerInstance } from 'winston';
@@ -51,7 +52,11 @@ export default interface AppConfig {
     };
     readonly redis: {
       readonly prefix: string;
-      readonly url: string;
+      readonly client: () => Promise<Redis>;
+    };
+    readonly sentinel: {
+      readonly prefix: string;
+      readonly client: () => Promise<Redis>;
     };
   };
 }

src/apps/statements/AppConfig.ts

@@ -18,8 +18,12 @@ export default (appConfig: AppConfig): Result => {
     events: {
       facade: appConfig.repo.factory.eventsRepoName,
       redis: {
+        client: appConfig.repo.redis.client,
         prefix: appConfig.repo.redis.prefix,
-        url: appConfig.repo.redis.url,
+      },
+      sentinel: {
+        client: appConfig.repo.sentinel.client,
+        prefix: appConfig.repo.sentinel.prefix,
       },
     },
     models: {

src/apps/statements/app.ts

@@ -10,6 +10,7 @@ import getDbFromUrl from 'jscommons/dist/mongoRepo/utils/getDbFromUrl';
 import { defaultTo } from 'lodash';
 import * as os from 'os';
 
+const DEFAULT_REDIS_PORT = 6379;
 const DEFAULT_EXPRESS_PORT = 8081;
 const DEFAULT_TIMEOUT_MS = 300000; // 5 minutes.
 
@@ -71,6 +72,16 @@ export default {
     } as S3.ClientConfiguration,
     bucketName: getStringOption(process.env.FS_S3_BUCKET, 'xapi-service'),
   },
+  sentinel: {
+    name: getStringOption(process.env.SENTINEL_NAME, 'mymaster'),
+    prefix: getStringOption(process.env.SENTINEL_PREFIX, 'LEARNINGLOCKER'),
+    sentinels: (
+      getStringOption(process.env.SENTINEL_CONNECTIONS, '127.0.0.1:6379').split(' ').map((conn) => {
+        const [host, port] = conn.split(':');
+        return { host, port: getNumberOption(port, DEFAULT_REDIS_PORT) };
+      })
+    ),
+  },
   statementsService: {
     awaitUpdates: getBooleanOption(defaultTo<any>(
       process.env.SERVICE_AWAIT_UPDATES,

src/config.ts

@@ -8,6 +8,8 @@ import app from './apps/app';
 import config from './config';
 import logger from './logger';
 import connectToMongoDb from './utils/connectToMongoDb';
+import connectToRedis from './utils/connectToRedis';
+import connectToSentinel from './utils/connectToSentinel';
 
 const expressApp = express();
 
@@ -20,9 +22,16 @@ expressApp.use(app({
     google: config.googleStorageRepo,
     local: config.localStorageRepo,
     mongo: { db: connectToMongoDb() },
-    redis: config.redis,
+    redis: {
+      client: connectToRedis(),
+      prefix: config.redis.prefix,
+    },
     repoFactory: config.repoFactory,
     s3: config.s3StorageRepo,
+    sentinel: {
+      client: connectToSentinel(),
+      prefix: config.redis.prefix,
+    },
     storageSubFolders: config.storageSubFolders,
   },
   service: {

src/server.ts

@@ -0,0 +1,13 @@
+import * as Ioredis from 'ioredis';
+import { defaultTo, once } from 'lodash';
+import config from '../config';
+import logger from '../logger';
+
+export default once((): () => Promise<Ioredis.Redis> => {
+  return once(async () => {
+    logger.info('Creating redis connection');
+    return new Ioredis(
+      defaultTo(config.redis.url, 'redis://127.0.0.1:6379/0'),
+    );
+  });
+});

src/utils/connectToRedis.ts

@@ -0,0 +1,14 @@
+import * as Ioredis from 'ioredis';
+import { defaultTo, once } from 'lodash';
+import config from '../config';
+import logger from '../logger';
+
+export default once((): () => Promise<Ioredis.Redis> => {
+  return once(async () => {
+    logger.info('Creating sentinel connection');
+    return new Ioredis({
+      name: defaultTo(config.sentinel.name, 'mymaster'),
+      sentinels: defaultTo(config.sentinel.sentinels, [{ host: '127.0.0.1', port: 6379 }]),
+    });
+  });
+});