Wait till all dependencies are ready before running plugin instantiation tests

Author: hlxid

src/main/scala/org/codeoverflow/chatoverflow/framework/PluginFramework.scala

@@ -7,6 +7,10 @@ import org.codeoverflow.chatoverflow.framework.helper.PluginLoader
 import org.codeoverflow.chatoverflow.framework.manager.PluginManagerStub
 
 import scala.collection.mutable.ListBuffer
+import scala.concurrent.ExecutionContext.Implicits.global
+import scala.concurrent.duration._
+import scala.concurrent.{Await, Future}
+import scala.util.Success
 
 /**
   * The plugin framework holds all plugin types important from the jar files in the plugin folder.
@@ -62,6 +66,8 @@ class PluginFramework(pluginDirectoryPath: String) extends WithLogger {
       logger warn s"PluginType directory '$pluginDirectory' does not exist!"
     } else {
 
+      val futures = ListBuffer[Future[_]]()
+
       // Get (new) jar file urls
       val jarFiles = getNewJarFiles(pluginDirectory)
       logger info s"Found ${jarFiles.length} new plugins."
@@ -81,22 +87,27 @@ class PluginFramework(pluginDirectoryPath: String) extends WithLogger {
           } else {
 
             // Try to test the initiation of the plugin
-            try {
-              plugin.createPluginInstance(new PluginManagerStub)
-              logger info s"Successfully tested instantiation of plugin '${plugin.getName}'"
-              pluginTypes += plugin
-            } catch {
-              // Note that we catch not only exceptions, but also errors like NoSuchMethodError. Deep stuff
-              case _: Error => logger warn s"Error while test init of plugin '${plugin.getName}'."
-              case _: Exception => logger warn s"Exception while test init of plugin '${plugin.getName}'."
+            futures += plugin.getDependencyFuture andThen {
+              case Success(_) =>
+                try {
+                  plugin.createPluginInstance(new PluginManagerStub)
+                  logger info s"Successfully tested instantiation of plugin '${plugin.getName}'"
+                  pluginTypes += plugin
+                } catch {
+                  // Note that we catch not only exceptions, but also errors like NoSuchMethodError. Deep stuff
+                  case _: Error => logger warn s"Error while test init of plugin '${plugin.getName}'."
+                  case _: Exception => logger warn s"Exception while test init of plugin '${plugin.getName}'."
+                }
             }
           }
         }
       }
-    }
 
-    logger info s"Loaded ${pluginTypes.length} plugin types in total: " +
-      s"${pluginTypes.map(pt => s"${pt.getName} (${pt.getAuthor})").mkString(", ")}"
+      futures.foreach(f => Await.ready(f, 10.seconds))
+
+      logger info s"Loaded ${pluginTypes.length} plugin types in total: " +
+        s"${pluginTypes.map(pt => s"${pt.getName} (${pt.getAuthor})").mkString(", ")}"
+    }
   }
 
   /**

src/main/scala/org/codeoverflow/chatoverflow/instance/PluginInstance.scala

@@ -100,7 +100,7 @@ class PluginInstance(val instanceName: String, pluginType: PluginType) extends W
         } else {
 
           if (!areDependenciesAvailable) {
-            logger error "Dependencies have either failed to resolve and fetch or aren't done yet."
+            logger error "Dependencies have failed to resolve and fetch."
             return false
           }
 
@@ -230,9 +230,9 @@ class PluginInstance(val instanceName: String, pluginType: PluginType) extends W
   }
 
   /**
-   * Returns whether all dependencies are resolved and fetch which is required for the plugin to start.
+   * Returns whether all dependencies are resolved and fetched which is required for the plugin to start.
    *
-   * @return true if all dependencies are available, true if not done of failed.
+   * @return true if all dependencies are available, true if it has failed.
    */
   def areDependenciesAvailable: Boolean = {
     val opt = pluginType.getDependencyFuture.value

src/main/scala/org/codeoverflow/chatoverflow/ui/web/rest/plugin/PluginInstanceController.scala

@@ -47,7 +47,7 @@ class PluginInstanceController(implicit val swagger: Swagger) extends JsonServle
               ResultMessage(success = false, "Not all required requirements have been set.")
 
             } else if (!pluginInstance.get.areDependenciesAvailable) {
-              ResultMessage(success = false, "Dependencies have either failed to resolve and fetch or aren't done yet. Check logs for further information.")
+              ResultMessage(success = false, "Dependencies have failed to resolve and fetch. Check logs for further information.")
 
             } else if (!pluginInstance.get.start()) {
               ResultMessage(success = false, "Unable to start plugin.")