issue #1335 Upgrade to ArangoDB 3.11

AbsaOSS · Jul 8, 2024 · 0e05272 · 0e05272
1 parent fcc2f96
commit 0e05272
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 90 deletions.
diff --git a/admin/src/main/scala/za/co/absa/spline/admin/AdminCLI.scala b/admin/src/main/scala/za/co/absa/spline/admin/AdminCLI.scala
@@ -59,7 +59,7 @@ object AdminCLI extends App {
     )
   }
 
-  private val dbManagerFactory = new ArangoManagerFactoryImpl(activeFailover = false)
+  private val dbManagerFactory = new ArangoManagerFactoryImpl
   private val maybeConsole = InputConsole.systemConsoleIfAvailable()
 
   new AdminCLI(dbManagerFactory, maybeConsole).exec(args)

diff --git a/admin/src/main/scala/za/co/absa/spline/arango/ArangoManagerFactory.scala b/admin/src/main/scala/za/co/absa/spline/arango/ArangoManagerFactory.scala
@@ -30,7 +30,7 @@ trait ArangoManagerFactory {
   def create(connectionURL: ArangoConnectionURL, maybeSSLContext: Option[SSLContext], dryRun: Boolean): ArangoManager
 }
 
-class ArangoManagerFactoryImpl(activeFailover: Boolean)(implicit ec: ExecutionContext) extends ArangoManagerFactory {
+class ArangoManagerFactoryImpl(implicit ec: ExecutionContext) extends ArangoManagerFactory {
 
   override def create(connectionURL: ArangoConnectionURL, maybeSSLContext: Option[SSLContext], dryRun: Boolean): ArangoManager = {
     val scriptRepo = MigrationScriptRepository
@@ -54,7 +54,7 @@ class ArangoManagerFactoryImpl(activeFailover: Boolean)(implicit ec: ExecutionCo
     }
 
     def dbFacade(): ArangoDatabaseFacade =
-      new ArangoDatabaseFacade(connectionURL, maybeSSLContext, activeFailover)
+      new ArangoDatabaseFacade(connectionURL, maybeSSLContext, activeFailover = false)
 
     AutoClosingArangoManagerProxy.create(dbManager, dbFacade)
   }

diff --git a/arangodb-foxx-services/package-lock.json b/arangodb-foxx-services/package-lock.json
diff --git a/integration-tests/src/main/scala/za/co/absa/spline/test/fixture/ArangoDbFixtureLike.scala b/integration-tests/src/main/scala/za/co/absa/spline/test/fixture/ArangoDbFixtureLike.scala
@@ -18,7 +18,7 @@ package za.co.absa.spline.test.fixture
 
 import com.arangodb.async.ArangoDatabaseAsync
 import io.testcontainers.arangodb.containers.ArangoContainer
-import za.co.absa.spline.persistence.ArangoDatabaseFacade.MinArangoVerRecommended
+import za.co.absa.commons.version.Version._
 import za.co.absa.spline.persistence.{ArangoConnectionURL, ArangoDatabaseFacade}
 
 trait ArangoDbFixtureLike {
@@ -42,6 +42,6 @@ trait ArangoDbFixtureLike {
 }
 
 object ArangoDbFixtureLike {
-  private val ArangoDbVersion = MinArangoVerRecommended
+  private val ArangoDbVersion = ver"3.11"
   private val ArangoDbContainer: ArangoContainer = new ArangoContainer(ArangoDbVersion.asString).withoutAuth()
 }
diff --git a/persistence/src/main/scala/za/co/absa/spline/persistence/ArangoDatabaseFacade.scala b/persistence/src/main/scala/za/co/absa/spline/persistence/ArangoDatabaseFacade.scala
@@ -79,8 +79,8 @@ object ArangoDatabaseFacade extends LazyLogging {
 
   import za.co.absa.commons.version.Version._
 
-  val MinArangoVerRequired: Version = semver"3.6.0"
-  val MinArangoVerRecommended: Version = ver"3.10"
+  private val ArangoDBVerMinIncluding = semver"3.9.0"
+  private val ArangoDBVerMaxExcluding = Option(semver"3.12.0")
 
   private def warmUpDb(db: ArangoDatabaseAsync): Unit = {
     val verStr = try {
@@ -98,16 +98,10 @@ object ArangoDatabaseFacade extends LazyLogging {
     val arangoVer = Version.asSemVer(verStr)
 
     // check ArangoDb server version requirements
-    if (arangoVer < MinArangoVerRequired)
+    if (arangoVer < ArangoDBVerMinIncluding || ArangoDBVerMaxExcluding.exists(arangoVer.>=))
       sys.error(s"" +
-        s"Unsupported ArangoDB server version ${arangoVer.asString}. " +
-        s"Required version: ${MinArangoVerRequired.asString} or later. " +
-        s"Recommended version: ${MinArangoVerRecommended.asString} or later.")
-
-    if (arangoVer < MinArangoVerRecommended)
-      logger.warn(s"WARNING: " +
-        s"The ArangoDB server version ${arangoVer.asString} might contain a bug that can cause Spline malfunction. " +
-        s"It's highly recommended to upgrade to ArangoDB ${MinArangoVerRecommended.asString} or later. " +
-        s"See: https://github.com/arangodb/arangodb/issues/12693")
+        s"Unsupported ArangoDB server version detected: ${arangoVer.asString}. " +
+        s"Please upgrade ArangoDB to version ${ArangoDBVerMinIncluding.asString} or higher" +
+        (ArangoDBVerMaxExcluding.map(v => s" (but less than ${v.asString} which is currently not supported).") getOrElse "."))
   }
 }
diff --git a/persistence/src/main/scala/za/co/absa/spline/persistence/ArangoRepoConfig.scala b/persistence/src/main/scala/za/co/absa/spline/persistence/ArangoRepoConfig.scala
@@ -49,7 +49,7 @@ class ArangoRepoConfig extends InitializingBean with LazyLogging {
   @Bean def databaseVersionChecker: DatabaseVersionChecker = new DatabaseVersionChecker(databaseVersionManager)
 }
 
-object ArangoRepoConfig extends DefaultConfigurationStack with ConfTyped {
+object ArangoRepoConfig extends DefaultConfigurationStack with ConfTyped with LazyLogging {
 
   import za.co.absa.commons.config.ConfigurationImplicits._
 
@@ -67,8 +67,15 @@ object ArangoRepoConfig extends DefaultConfigurationStack with ConfTyped {
     val DisableSSLValidation: Boolean =
       conf.getBoolean(Prop("disableSslValidation"), false)
 
-    val ActiveFailoverMode: Boolean =
-      conf.getBoolean(Prop("activeFailover"), false)
+    val ActiveFailoverMode: Boolean = {
+      val enabled = conf.getBoolean(Prop("activeFailover"), false)
+      if (enabled) {
+        // Active failover mode is deprecated in Arango ver 3.11, and to be removed in ver 3.12.
+        // See https://docs.arangodb.com/3.11/release-notes/version-3.11/incompatible-changes-in-3-11/#active-failover-deployment-mode-deprecation
+        logger.warn("Active failover mode is deprecated and will be removed in the future versions.")
+      }
+      enabled
+    }
   }
 
 }