fix: Ensures statement requests timeout (LLC-339) (#685)

Author: ryasmi

docker-compose.yml

@@ -0,0 +1,23 @@
+version: '3.6'
+services:
+  mongo:
+    container_name: ll_mongo
+    image: mongo:4.0
+    ports:
+    - 27017:27017
+    volumes:
+    - mongo-config:/data/configdb:rw
+    - mongo-data:/data/db:rw
+  redis:
+    # activate persistency
+    command: redis-server --appendonly yes
+    container_name: ll_redis
+    image: redis:4.0
+    ports:
+    - 6379:6379
+    volumes:
+    - redis-data:/data:rw
+volumes:
+  mongo-config: {}
+  mongo-data: {}
+  redis-data: {}

src/apps/AppConfig.ts

@@ -39,6 +39,7 @@ export default interface AppConfig {
     };
     readonly mongo: {
       readonly db: () => Promise<Db>;
+      readonly maxTimeMs: number;
     };
     readonly redis: {
       readonly prefix: string;

src/apps/statements/AppConfig.ts

@@ -55,6 +55,7 @@ export default interface AppConfig {
     };
     readonly mongo: {
       readonly db: () => Promise<Db>;
+      readonly maxTimeMs: number;
     };
     readonly redis: {
       readonly prefix: string;

src/apps/statements/app.ts

@@ -30,6 +30,7 @@ export default (appConfig: AppConfig): Result => {
       facade: appConfig.repo.factory.modelsRepoName,
       mongo: {
         db: appConfig.repo.mongo.db,
+        maxTimeMs: appConfig.repo.mongo.maxTimeMs,
       },
     },
     storage: {

src/apps/statements/errors/Timeout.ts

@@ -0,0 +1,9 @@
+import BaseError from 'jscommons/dist/errors/BaseError';
+
+// tslint:disable-next-line:no-class
+export default class extends BaseError {
+  // istanbul ignore next - Couldn't test without an unacceptable test duration.
+  constructor(public readonly timeoutMs: number) {
+    super();
+  }
+}

src/apps/statements/expressPresenter/utils/handleError.ts

@@ -27,6 +27,7 @@ import MissingLoadedId from '../../errors/MissingLoadedId';
 import MissingStatementId from '../../errors/MissingStatementId';
 import NoStatements from '../../errors/NoStatements';
 import QueryIds from '../../errors/QueryIds';
+import Timeout from '../../errors/Timeout';
 import UnequalStatementId from '../../errors/UnequalStatementId';
 import UnknownParams from '../../errors/UnknownParams';
 import UntrustedClientError from '../../errors/UntrustedClientError';
@@ -210,6 +211,11 @@ export default ({ config, errorId, res, err }: Options): Response => {
     const message = translator.untrustedClientError(err);
     return sendMessage({ res, code, errorId, message });
   }
+  if (err instanceof Timeout) {
+    const code = BAD_REQUEST;
+    const message = translator.timeoutError(err);
+    return sendMessage({ res, code, errorId, message });
+  }
   return commonErrorHandler({ config, errorId, res, err });
   // tslint:disable-next-line:max-file-line-count
 };

src/apps/statements/repo/index.ts

@@ -31,6 +31,7 @@ const repo: Repo = factory({
     facade: config.repoFactory.modelsRepoName,
     mongo: {
       db: connectToMongoDb(),
+      maxTimeMs: config.defaultTimeout,
     },
   },
   storage: {

src/apps/statements/repo/modelsRepo/getStatements/mongo/index.ts

@@ -1,4 +1,5 @@
 import { defaultTo } from 'lodash';
+import Timeout from '../../../../errors/Timeout';
 import StoredStatementModel from '../../../../models/StoredStatementModel';
 import { STATEMENTS_COLLECTION_NAME } from '../../utils/mongoModels/constants';
 import FacadeConfig from '../../utils/mongoModels/FacadeConfig';
@@ -44,18 +45,28 @@ export default (config: FacadeConfig): Signature => {
     const skip = defaultTo(opts.skip, 0);
     const limit = opts.limit;
 
-    const models = await collection
-      .find(query)
-      .sort(sort)
-      .skip(skip)
-      .limit(limit)
-      .toArray() as StoredStatementModel[];
+    try {
+      const models = await collection
+        .find(query)
+        .sort(sort)
+        .skip(skip)
+        .limit(limit)
+        .maxTimeMS(config.maxTimeMs)
+        .toArray() as StoredStatementModel[];
 
-    const decodedModels = models.map((model) => {
-      const statement = decodeDotsInStatement(model.statement);
-      return { ...model, statement };
-    });
+      const decodedModels = models.map((model) => {
+        const statement = decodeDotsInStatement(model.statement);
+        return { ...model, statement };
+      });
 
-    return decodedModels;
+      return decodedModels;
+    } catch (err) {
+      // istanbul ignore next - Couldn't test without an unacceptable test duration.
+      if (err?.code === 50) {
+        throw new Timeout(config.maxTimeMs);
+      }
+      // istanbul ignore next - Unexpected error.
+      throw err;
+    }
   };
 };

src/apps/statements/repo/modelsRepo/utils/mongoModels/FacadeConfig.ts

@@ -2,6 +2,7 @@ import { Db } from 'mongodb';
 
 interface Config {
   readonly db: () => Promise<Db>;
+  readonly maxTimeMs: number;
 }
 
 export default Config;

src/apps/statements/repo/modelsRepo/utils/mongoModels/factory.ts

@@ -18,11 +18,13 @@ import voidStatements from '../../voidStatements/mongo';
 import FacadeConfig from './FacadeConfig';
 import FactoryConfig from './FactoryConfig';
 
+const defaultMaxTimeMs = 300000; // 5 minutes.
+
 export default (factoryConfig?: FactoryConfig): Facade => {
   const facadeConfig: FacadeConfig = (
     factoryConfig !== undefined
       ? factoryConfig
-      : { db: connectToMongoDb() }
+      : { db: connectToMongoDb(), maxTimeMs: defaultMaxTimeMs }
   );
   return {
     clearRepo: async () => {