Refactor for ordered loading and prevention of tomcat loading before ready

mondain · mondain · commit eb75c1629481 · 2024-04-12T14:24:54.000-07:00
diff --git a/common/src/main/java/org/red5/server/api/Red5.java b/common/src/main/java/org/red5/server/api/Red5.java
@@ -96,6 +96,11 @@ public final class Red5 {
      */
     private static boolean debug = java.lang.management.ManagementFactory.getRuntimeMXBean().getInputArguments().toString().indexOf("jdwp") >= 0;
 
+    /**
+     * Plugins ready flag
+     */
+    private static boolean pluginsReady;
+
     /**
      * Create a new Red5 object using given connection.
      *
@@ -279,4 +284,15 @@ public static int getTargetChunkSize() {
         return targetChunkSize;
     }
 
+    /**
+     * Plugins ready flag. This is set to true when the PluginLauncher has completed loading all plugins.
+     */
+    public static void setPluginsReady(boolean pluginsReady) {
+        Red5.pluginsReady = pluginsReady;
+    }
+
+    public static boolean isPluginsReady() {
+        return pluginsReady;
+    }
+
 }
diff --git a/server/src/main/java/org/red5/server/Launcher.java b/server/src/main/java/org/red5/server/Launcher.java
@@ -10,6 +10,7 @@
 import org.red5.logging.Red5LoggerFactory;
 import org.red5.server.api.Red5;
 import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.slf4j.bridge.SLF4JBridgeHandler;
 import org.springframework.context.support.FileSystemXmlApplicationContext;
 
@@ -44,7 +45,7 @@ public void launch() throws Exception {
         // log stdout and stderr to slf4j
         //SysOutOverSLF4J.sendSystemOutAndErrToSLF4J();
         // get the first logger
-        Logger log = Red5LoggerFactory.getLogger(Launcher.class);
+        Logger log = LoggerFactory.getLogger(Launcher.class);
         // version info banner
         log.info("{} (https://github.com/Red5)", Red5.getVersion());
         if (log.isDebugEnabled()) {
diff --git a/server/src/main/java/org/red5/server/plugin/PluginLauncher.java b/server/src/main/java/org/red5/server/plugin/PluginLauncher.java
@@ -41,7 +41,7 @@ public void afterPropertiesSet() throws Exception {
         // get common context
         ApplicationContext common = (ApplicationContext) applicationContext.getBean("red5.common");
         Server server = (Server) common.getBean("red5.server");
-        //server should be up and running at this point so load any plug-ins now
+        // server should be up and running at this point so load any plug-ins now
 
         // get the plugins dir
         File pluginsDir = new File(System.getProperty("red5.root"), "plugins");
@@ -117,14 +117,13 @@ public boolean accept(File dir, String name) {
                     }
                     log.info("Loaded plugin: {}", pluginMainClass);
                 } catch (Throwable t) {
-                    log.warn("Error loading plugin: {}; Method: {}", pluginMainClass, pluginMainMethod);
-                    log.error("", t);
+                    log.warn("Error loading plugin: {}; Method: {}", pluginMainClass, pluginMainMethod, t);
                 }
             }
         } else {
             log.info("Plugins directory cannot be accessed or doesnt exist");
         }
-
+        //Red5.setPluginsReady(true);
     }
 
     @SuppressWarnings("null")
diff --git a/server/src/main/java/org/red5/server/tomcat/TomcatLoader.java b/server/src/main/java/org/red5/server/tomcat/TomcatLoader.java
@@ -42,18 +42,19 @@
 import org.apache.catalina.realm.JAASRealm;
 import org.apache.catalina.realm.NullRealm;
 import org.apache.catalina.realm.RealmBase;
-import org.red5.logging.Red5LoggerFactory;
 import org.red5.net.websocket.WebSocketPlugin;
 import org.red5.server.ContextLoader;
 import org.red5.server.LoaderBase;
 import org.red5.server.Server;
 import org.red5.server.api.IApplicationContext;
+import org.red5.server.api.Red5;
 import org.red5.server.jmx.mxbeans.ContextLoaderMXBean;
 import org.red5.server.jmx.mxbeans.LoaderMXBean;
 import org.red5.server.plugin.PluginRegistry;
 import org.red5.server.security.IRed5Realm;
 import org.red5.server.util.FileUtil;
 import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.DisposableBean;
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.context.ApplicationContext;
@@ -115,7 +116,7 @@ public boolean accept(File dir, String name) {
     private static final String CONTEXT_CLASS_PARAM = "contextClass";
 
     // Initialize Logging
-    private static Logger log = Red5LoggerFactory.getLogger(TomcatLoader.class);
+    private static Logger log = LoggerFactory.getLogger(TomcatLoader.class);
 
     public static final String defaultSpringConfigLocation = "/WEB-INF/red5-*.xml";
 
@@ -170,23 +171,43 @@ public boolean accept(File dir, String name) {
      */
     protected boolean websocketEnabled = true;
 
+    /**
+     * Flag to indicate if we should await plugin loading
+     */
+    protected boolean awaitPlugins = true;
+
+    private static ExecutorService executor;
+
     @Override
     public void afterPropertiesSet() throws Exception {
-        // if websockets are enabled, ensure the websocket plugin is loaded
-        if (websocketEnabled && PluginRegistry.getPlugin(WebSocketPlugin.NAME) == null) {
-            // get common context
-            ApplicationContext common = (ApplicationContext) applicationContext.getBean("red5.common");
-            Server server = (Server) common.getBean("red5.server");
-            // instance the plugin
-            WebSocketPlugin plugin = new WebSocketPlugin();
-            plugin.setApplicationContext(applicationContext);
-            plugin.setServer(server);
-            // register it
-            PluginRegistry.register(plugin);
-            // start it
-            plugin.doStart();
+        // if we are not awaiting plugins, start immediately
+        if (awaitPlugins) {
+            log.info("Awaiting plugin loading");
+            executor = Executors.newSingleThreadExecutor();
+            executor.submit(() -> {
+                final String oldName = Thread.currentThread().getName();
+                Thread.currentThread().setName("TomcatLoader-delayed-start");
+                try {
+                    while (!Red5.isPluginsReady()) {
+                        log.debug("Waiting for plugins to load");
+                        Thread.sleep(500L);
+                    }
+                    start();
+                } catch (ServletException e) {
+                    log.error("Error starting Tomcat", e);
+                } catch (InterruptedException e) {
+                    log.error("Error waiting for plugins", e);
+                } finally {
+                    Thread.currentThread().setName(oldName);
+                }
+            });
+        } else {
+            try {
+                start();
+            } catch (ServletException e) {
+                log.error("Error starting Tomcat", e);
+            }
         }
-        start();
     }
 
     /**
@@ -273,7 +294,11 @@ public void removeContext(String path) {
     @SuppressWarnings("null")
     public void start() throws ServletException {
         log.info("Loading Tomcat");
-        //get a reference to the current threads classloader
+        // if websockets are enabled, ensure the websocket plugin is loaded
+        if (websocketEnabled) {
+            checkWebsocketPlugin();
+        }
+        // get a reference to the current threads classloader
         final ClassLoader originalClassLoader = Thread.currentThread().getContextClassLoader();
         // root location for servlet container
         String serverRoot = System.getProperty("red5.root");
@@ -530,6 +555,27 @@ public void run() {
         log.debug("Tomcat load completed");
     }
 
+    private void checkWebsocketPlugin() {
+        // if websockets are enabled, ensure the websocket plugin is loaded
+        if (PluginRegistry.getPlugin(WebSocketPlugin.NAME) == null) {
+            // get common context
+            ApplicationContext common = (ApplicationContext) applicationContext.getBean("red5.common");
+            Server server = (Server) common.getBean("red5.server");
+            // instance the plugin
+            WebSocketPlugin plugin = new WebSocketPlugin();
+            plugin.setApplicationContext(applicationContext);
+            plugin.setServer(server);
+            // register it
+            PluginRegistry.register(plugin);
+            // start it
+            try {
+                plugin.doStart();
+            } catch (Exception e) {
+                log.warn("WebSocket plugin start, failed", e);
+            }
+        }
+    }
+
     /**
      * Starts a web application and its red5 (spring) component. This is basically a stripped down version of start().
      *
@@ -803,6 +849,15 @@ public void setWebsocketEnabled(boolean websocketEnabled) {
         this.websocketEnabled = websocketEnabled;
     }
 
+    /**
+     * Returns await plugin loading state.
+     *
+     * @return true if awaiting plugin loading and false otherwise
+     */
+    public void setAwaitPlugins(boolean awaitPlugins) {
+        this.awaitPlugins = awaitPlugins;
+    }
+
     /**
      * Returns a semi-unique id for this host based on its host values
      *
@@ -846,6 +901,9 @@ protected void unregisterJMX() {
     @Override
     public void destroy() throws Exception {
         log.info("Shutting down Tomcat context");
+        if (executor != null) {
+            executor.shutdown();
+        }
         // run through the applications and ensure that spring is told to commence shutdown / disposal
         AbstractApplicationContext absCtx = (AbstractApplicationContext) LoaderBase.getApplicationContext();
         if (absCtx != null) {
diff --git a/server/src/main/server/conf/jee-container.xml b/server/src/main/server/conf/jee-container.xml
@@ -22,6 +22,7 @@
      -->
     <!-- Tomcat without SSL enabled -->
     <bean id="tomcat.server" class="org.red5.server.tomcat.TomcatLoader" depends-on="context.loader" lazy-init="true">
+        <property name="awaitPlugins" value="false" />
         <property name="websocketEnabled" value="true" />
         <property name="webappFolder" value="${red5.root}/webapps" />
         <property name="connectors">

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public void afterPropertiesSet() throws Exception {`
`41`	`41`	`// get common context`
`42`	`42`	`ApplicationContext common = (ApplicationContext) applicationContext.getBean("red5.common");`
`43`	`43`	`Server server = (Server) common.getBean("red5.server");`
`44`		`- //server should be up and running at this point so load any plug-ins now`
	`44`	`+ // server should be up and running at this point so load any plug-ins now`
`45`	`45`
`46`	`46`	`// get the plugins dir`
`47`	`47`	`File pluginsDir = new File(System.getProperty("red5.root"), "plugins");`
`@@ -117,14 +117,13 @@ public boolean accept(File dir, String name) {`
`117`	`117`	`}`
`118`	`118`	`log.info("Loaded plugin: {}", pluginMainClass);`
`119`	`119`	`} catch (Throwable t) {`
`120`		`- log.warn("Error loading plugin: {}; Method: {}", pluginMainClass, pluginMainMethod);`
`121`		`- log.error("", t);`
	`120`	`+ log.warn("Error loading plugin: {}; Method: {}", pluginMainClass, pluginMainMethod, t);`
`122`	`121`	`}`
`123`	`122`	`}`
`124`	`123`	`} else {`
`125`	`124`	`log.info("Plugins directory cannot be accessed or doesnt exist");`
`126`	`125`	`}`
`127`		`-`
	`126`	`+ //Red5.setPluginsReady(true);`
`128`	`127`	`}`
`129`	`128`
`130`	`129`	`@SuppressWarnings("null")`