Merge pull request #67 from hmrc/BDOG-144-allow-configuring-mongo-timeout

BDOG-114 make it possible to configure the default 10s timeout

Author: bennetimo

README.md

@@ -164,6 +164,15 @@ class SimpleTestRepository @Inject()(mongoComponent: ReactiveMongoComponent)
 
 Formats for BSONObjectId and Joda time classes are implemented (see [ReactiveMongoFormats](https://github.com/hmrc/simple-reactivemongo/blob/master/src/main/scala/uk/gov/hmrc/mongo/ReactiveMongoFormats.scala))
 
+#### Configuration Options
+
+There is a default timeout of 10 seconds when making connections with Mongo. This value is 
+configurable by setting the key:
+
+`mongodb.dbTimeoutMsecs=10000`
+
+Within your application.conf
+
 #### Configure underlying Akka system
 
 ReactiveMongo loads it's configuration from the key `mongo-async-driver`

project/LibraryDependencies.scala

@@ -11,22 +11,22 @@ object LibraryDependencies {
       "org.reactivemongo"      %% "reactivemongo" % "0.16.1"
     ),
     play25 = Seq(
-      "org.slf4j"         % "slf4j-api"                % "1.7.21",
-      "org.slf4j"         % "log4j-over-slf4j"         % "1.7.21",
+      "org.slf4j"         % "slf4j-api"                % "1.7.26",
+      "org.slf4j"         % "log4j-over-slf4j"         % "1.7.26",
       "com.typesafe.play" %% "play"                    % play25Version,
       "org.reactivemongo" %% "reactivemongo-play-json" % "0.16.0-play25",
       // force dependencies due to security flaws found in jackson-databind < 2.9.x using XRay
-      "com.fasterxml.jackson.core"     % "jackson-core"            % "2.9.7",
-      "com.fasterxml.jackson.core"     % "jackson-databind"        % "2.9.7",
-      "com.fasterxml.jackson.core"     % "jackson-annotations"     % "2.9.7",
-      "com.fasterxml.jackson.datatype" % "jackson-datatype-jdk8"   % "2.9.7",
-      "com.fasterxml.jackson.datatype" % "jackson-datatype-jsr310" % "2.9.7",
+      "com.fasterxml.jackson.core"     % "jackson-core"            % "2.9.8",
+      "com.fasterxml.jackson.core"     % "jackson-databind"        % "2.9.8",
+      "com.fasterxml.jackson.core"     % "jackson-annotations"     % "2.9.8",
+      "com.fasterxml.jackson.datatype" % "jackson-datatype-jdk8"   % "2.9.8",
+      "com.fasterxml.jackson.datatype" % "jackson-datatype-jsr310" % "2.9.8",
       // force dependencies due to security flaws found in xercesImpl 2.11.0
       "xerces" % "xercesImpl" % "2.12.0"
     ),
     play26 = Seq(
-      "org.slf4j"         % "slf4j-api"                % "1.7.25",
-      "org.slf4j"         % "log4j-over-slf4j"         % "1.7.25",
+      "org.slf4j"         % "slf4j-api"                % "1.7.26",
+      "org.slf4j"         % "log4j-over-slf4j"         % "1.7.26",
       "com.typesafe.play" %% "play"                    % play26Version,
       "com.typesafe.play" %% "play-guice"              % play26Version,
       "org.reactivemongo" %% "reactivemongo-play-json" % "0.16.0-play26"
@@ -37,9 +37,9 @@ object LibraryDependencies {
     shared = Seq(
       "com.outworkers" %% "util-samplers"  % "0.40.0" % Test,
       "org.pegdown"    % "pegdown"         % "1.6.0"  % Test,
-      "org.scalacheck" %% "scalacheck"     % "1.13.4" % Test,
+      "org.scalacheck" %% "scalacheck"     % "1.13.5" % Test,
       "org.scalamock"  %% "scalamock"      % "4.1.0"  % Test,
-      "org.scalatest"  %% "scalatest"      % "3.0.5"  % Test,
+      "org.scalatest"  %% "scalatest"      % "3.0.6"  % Test,
       "ch.qos.logback" % "logback-classic" % "1.2.3"  % Test
     ),
     play25 = Seq(

src/main/scala/play/modules/reactivemongo/MongoConfig.scala

@@ -58,6 +58,10 @@ class MongoConfig(
       case _ => None
     }
 
+  lazy val dbTimeout: Option[FiniteDuration] =
+    mongoConfig.getOptional[Long]("dbTimeoutMsecs")
+        .map(dbTimeout => new FiniteDuration(dbTimeout, TimeUnit.MILLISECONDS))
+
   private lazy val mongoConfig: Configuration = configuration
     .getOptional[Configuration]("mongodb")
     .orElse(configuration.getOptional[Configuration](s"${environment.mode}.mongodb"))

src/main/scala/play/modules/reactivemongo/ReactiveMongoHmrcModule.scala

@@ -52,9 +52,12 @@ class ReactiveMongoComponentImpl @Inject()(
 
   lazy val mongoConnector: MongoConnector = MongoConnector(
     mongoConfig.uri,
-    mongoConfig.maybeFailoverStrategy
+    mongoConfig.maybeFailoverStrategy,
+    mongoConfig.dbTimeout
   )
 
+  Logger.debug(s"ReactiveMongoPlugin: MongoConnector configuration being used: $mongoConnector")
+
   lifecycle.addStopHook { () =>
     Future.successful {
       Logger.info("ReactiveMongoPlugin stops, closing connections...")

src/main/scala/reactivemongo/ReactiveMongoHelper.scala

@@ -21,10 +21,13 @@ import reactivemongo.core.nodeset.Authenticate
 import scala.concurrent.{Await, ExecutionContext, Future}
 import reactivemongo.api._
 
+import scala.concurrent.duration._
 import scala.language.postfixOps
 
 object ReactiveMongoHelper {
 
+  val DEFAULT_DB_TIMEOUT = 10 seconds
+
   @deprecated(message = "Use case class constructor that takes MongoConnectionOptions", "7.0.0")
   def apply(
     dbName: String,
@@ -46,7 +49,8 @@ case class ReactiveMongoHelper(
   servers: Seq[String],
   auth: Seq[Authenticate],
   failoverStrategy: Option[FailoverStrategy],
-  connectionOptions: MongoConnectionOptions = MongoConnectionOptions()) {
+  connectionOptions: MongoConnectionOptions = MongoConnectionOptions(),
+  dbTimeout: Option[FiniteDuration] = None) {
 
   implicit val ec: ExecutionContext = ExecutionContext.Implicits.global
   lazy val driver                   = new MongoDriver
@@ -57,9 +61,8 @@ case class ReactiveMongoHelper(
     options         = connectionOptions
   )
 
-  import scala.concurrent.duration._
   lazy val db: DefaultDB = failoverStrategy match {
-    case Some(fs: FailoverStrategy) => Await.result(connection.database(dbName, fs), 10 seconds)
-    case None                       => Await.result(connection.database(dbName), 10 seconds)
+    case Some(fs: FailoverStrategy) => Await.result(connection.database(dbName, fs), dbTimeout.getOrElse(ReactiveMongoHelper.DEFAULT_DB_TIMEOUT))
+    case None                       => Await.result(connection.database(dbName), dbTimeout.getOrElse(ReactiveMongoHelper.DEFAULT_DB_TIMEOUT))
   }
 }

src/main/scala/uk/gov/hmrc/mongo/SimpleMongoConnection.scala

@@ -18,6 +18,7 @@ package uk.gov.hmrc.mongo
 
 import reactivemongo.api.FailoverStrategy
 
+import scala.concurrent.duration.FiniteDuration
 import scala.language.postfixOps
 
 trait SimpleMongoConnection {
@@ -30,6 +31,7 @@ trait SimpleMongoConnection {
 
   val mongoConnectionUri: String
   val failoverStrategy: Option[FailoverStrategy]
+  val dbTimeout: Option[FiniteDuration]
 
   implicit def db: () => DefaultDB = () => mongoDb
 
@@ -39,18 +41,18 @@ trait SimpleMongoConnection {
 
   lazy val helper: ReactiveMongoHelper = MongoConnection.parseURI(mongoConnectionUri) match {
     case Success(MongoConnection.ParsedURI(hosts, options, ignoreOptions, Some(db), auth)) =>
-      ReactiveMongoHelper(db, hosts.map(h => h._1 + ":" + h._2), auth.toList, failoverStrategy, options)
+      ReactiveMongoHelper(db, hosts.map(h => h._1 + ":" + h._2), auth.toList, failoverStrategy, options, dbTimeout)
     case Success(MongoConnection.ParsedURI(_, _, _, None, _)) =>
       throw new Exception(s"Missing database name in mongodb.uri '$mongoConnectionUri'")
     case Failure(e) => throw new Exception(s"Invalid mongodb.uri '$mongoConnectionUri'", e)
   }
 
   def close() {
-    val f = helper.connection.askClose()(10 seconds)
-    Await.ready(f, 10 seconds)
+    val f = helper.connection.askClose()(dbTimeout.getOrElse(ReactiveMongoHelper.DEFAULT_DB_TIMEOUT))
+    Await.ready(f, dbTimeout.getOrElse(ReactiveMongoHelper.DEFAULT_DB_TIMEOUT))
   }
 
 }
 
-case class MongoConnector(mongoConnectionUri: String, failoverStrategy: Option[FailoverStrategy] = None)
+case class MongoConnector(mongoConnectionUri: String, failoverStrategy: Option[FailoverStrategy] = None, dbTimeout: Option[FiniteDuration] = None)
     extends SimpleMongoConnection

src/test/scala/play/modules/reactivemongo/MongoConfigSpec.scala

@@ -99,6 +99,15 @@ class MongoConfigSpec extends WordSpec with MockFactory with PropertyChecks {
       s"return None for 'maybeFailoverStrategy' if '$mongodbConfigKey.failoverStrategy' not present in config" in new Setup {
         mongoConfig(mongodbConfigKey -> Map.empty).maybeFailoverStrategy shouldBe None
       }
+
+      s"return None for 'dbTimeoutMsecs' if '$mongodbConfigKey.dbTimeoutMsecs' not present in config" in new Setup {
+        mongoConfig(mongodbConfigKey -> Map.empty).dbTimeout shouldBe None
+      }
+
+      s"override 'dbTimeoutMsecs' if specified under '$mongodbConfigKey.dbTimeoutMsecs'" in new Setup {
+        val dbTimeout = mongoConfig(s"$mongodbConfigKey.dbTimeoutMsecs" -> dbTimeoutMsecs).dbTimeout
+        dbTimeout shouldBe Some(new FiniteDuration(dbTimeoutMsecs, MILLISECONDS))
+      }
     }
   }
 
@@ -108,6 +117,7 @@ class MongoConfigSpec extends WordSpec with MockFactory with PropertyChecks {
     val uri                       = "mongouri"
     val channels                  = 1
     val initialDelayMsecs         = 1234
+    val dbTimeoutMsecs            = 1234
     val retries                   = 5
 
     def mongoConfig(configEntries: (String, Any)*): MongoConfig =