[release-2.6] refactor: refresh the plugin wrapper when starting the …

…plugin (#4078) This is an automated cherry-pick of #4023 /assign ruibaby ```release-note 修复插件重启后 MainClass 对象缓存未清除的问题 ```
halo-dev · Jun 14, 2023 · 15433b5 · 15433b5
1 parent 262c1ac
commit 15433b5
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 8 deletions.
diff --git a/api/src/main/java/run/halo/app/plugin/BasePlugin.java b/api/src/main/java/run/halo/app/plugin/BasePlugin.java
@@ -2,7 +2,6 @@
 
 import lombok.extern.slf4j.Slf4j;
 import org.pf4j.Plugin;
-import org.pf4j.PluginManager;
 import org.pf4j.PluginWrapper;
 
 /**
@@ -15,12 +14,12 @@
 @Slf4j
 public class BasePlugin extends Plugin {
 
+    @Deprecated
     public BasePlugin(PluginWrapper wrapper) {
         super(wrapper);
         log.info("Initialized plugin {}", wrapper.getPluginId());
     }
 
-    private PluginManager getPluginManager() {
-        return getWrapper().getPluginManager();
+    public BasePlugin() {
     }
 }
diff --git a/application/src/main/java/run/halo/app/core/extension/reconciler/PluginReconciler.java b/application/src/main/java/run/halo/app/core/extension/reconciler/PluginReconciler.java
@@ -289,8 +289,7 @@ void stopAction(String name) {
 
     void stateTransition(String name, Function<PluginState, Boolean> stateAction,
         PluginState desiredState) {
-        PluginWrapper pluginWrapper = getPluginWrapper(name);
-        PluginState currentState = pluginWrapper.getPluginState();
+        PluginState currentState = getPluginWrapper(name).getPluginState();
         int maxRetries = PluginState.values().length;
         for (int i = 0; i < maxRetries && currentState != desiredState; i++) {
             try {
@@ -303,7 +302,7 @@ void stateTransition(String name, Function<PluginState, Boolean> stateAction,
                     break;
                 }
                 // update current state
-                currentState = pluginWrapper.getPluginState();
+                currentState = getPluginWrapper(name).getPluginState();
             } catch (Throwable e) {
                 persistenceFailureStatus(name, e);
                 throw e;

diff --git a/application/src/main/java/run/halo/app/plugin/BasePluginFactory.java b/application/src/main/java/run/halo/app/plugin/BasePluginFactory.java
@@ -29,7 +29,7 @@ public Plugin create(PluginWrapper pluginWrapper) {
                         "No bean named 'basePlugin' found in the context create default instance");
                     DefaultListableBeanFactory beanFactory =
                         context.getDefaultListableBeanFactory();
-                    BasePlugin pluginInstance = new BasePlugin(pluginWrapper);
+                    BasePlugin pluginInstance = new BasePlugin();
                     beanFactory.registerSingleton(Plugin.class.getName(), pluginInstance);
                     return pluginInstance;
                 }

diff --git a/application/src/main/java/run/halo/app/plugin/HaloPluginManager.java b/application/src/main/java/run/halo/app/plugin/HaloPluginManager.java
@@ -229,7 +229,11 @@ public boolean validatePluginVersion(PluginWrapper pluginWrapper) {
     private PluginState doStartPlugin(String pluginId) {
         checkPluginId(pluginId);
 
-        PluginWrapper pluginWrapper = getPlugin(pluginId);
+        // refresh plugin to ensure cache object of PluginWrapper.plugin is up-to-date
+        // see gh-4016 to know why we need this
+        // TODO if has a better way to do this?
+        PluginWrapper pluginWrapper = refreshPluginWrapper(pluginId);
+
         checkExtensionFinderReady(pluginWrapper);
 
         PluginDescriptor pluginDescriptor = pluginWrapper.getDescriptor();
@@ -423,6 +427,37 @@ private void removePluginComponentsCache(String pluginId) {
         }
     }
 
+    /**
+     * <p>Refresh plugin wrapper by plugin name.</p>
+     *
+     * <p>It will be create a new plugin wrapper and replace old plugin wrapper to clean
+     * {@link PluginWrapper#getPlugin()} cache object.</p>
+     *
+     * @param pluginName plugin name
+     * @return refreshed plugin wrapper instance, plugin cache object will be null
+     * @throws IllegalArgumentException if plugin not found
+     */
+    protected synchronized PluginWrapper refreshPluginWrapper(String pluginName) {
+        checkPluginId(pluginName);
+        // get old plugin wrapper
+        PluginWrapper pluginWrapper = getPlugin(pluginName);
+        // create new plugin wrapper to replace old plugin wrapper
+        PluginWrapper refreshed = copyPluginWrapper(pluginWrapper);
+        this.plugins.put(pluginName, refreshed);
+        return refreshed;
+    }
+
+    @NonNull
+    PluginWrapper copyPluginWrapper(@NonNull PluginWrapper pluginWrapper) {
+        PluginWrapper refreshed =
+            createPluginWrapper(pluginWrapper.getDescriptor(), pluginWrapper.getPluginPath(),
+                pluginWrapper.getPluginClassLoader());
+        refreshed.setPluginFactory(getPluginFactory());
+        refreshed.setPluginState(pluginWrapper.getPluginState());
+        refreshed.setFailedException(pluginWrapper.getFailedException());
+        return refreshed;
+    }
+
     @Override
     public void destroy() throws Exception {
         stopPlugins();