new: propagate plugin specific environment variables to plugins

ludomikula · ludomikula · commit 19b0c4d9c15d · 2023-11-24T20:03:52.000+01:00
diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/framework/plugin/LowcoderPluginManager.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/framework/plugin/LowcoderPluginManager.java
@@ -1,14 +1,23 @@
 package org.lowcoder.api.framework.plugin;
 
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Comparator;
+import java.util.HashMap;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.stream.Collectors;
+import java.util.stream.StreamSupport;
 
 import org.apache.commons.collections4.CollectionUtils;
+import org.apache.commons.lang3.StringUtils;
 import org.lowcoder.plugin.api.LowcoderPlugin;
 import org.lowcoder.plugin.api.LowcoderServices;
+import org.springframework.core.env.AbstractEnvironment;
+import org.springframework.core.env.EnumerablePropertySource;
+import org.springframework.core.env.Environment;
+import org.springframework.core.env.MutablePropertySources;
 import org.springframework.stereotype.Component;
 
 import jakarta.annotation.PostConstruct;
@@ -22,7 +31,8 @@
 public class LowcoderPluginManager
 {
 	private final LowcoderServices lowcoderServices;
-	private final PluginLoader pluginLoader;	
+	private final PluginLoader pluginLoader;
+	private final Environment environment;
 	
 	private Map<String, LowcoderPlugin> plugins = new LinkedHashMap<>();
 
@@ -35,7 +45,7 @@ private void loadPlugins()
 		
 		for (LowcoderPlugin plugin : sorted)
 		{
-			PluginExecutor executor = new PluginExecutor(plugin, lowcoderServices);
+			PluginExecutor executor = new PluginExecutor(plugin, getPluginEnvironmentVariables(plugin), lowcoderServices);
 			executor.start();
 		}
 	}
@@ -66,6 +76,29 @@ public List<PluginInfo> getLoadedPluginsInfo()
 		return infos;
 	}
 	
+	private Map<String, Object> getPluginEnvironmentVariables(LowcoderPlugin plugin)
+	{
+		Map<String, Object> env = new HashMap<>();
+		
+		String varPrefix = "PLUGIN_" + plugin.pluginId().toUpperCase().replaceAll("-", "_") + "_";
+		MutablePropertySources propertySources = ((AbstractEnvironment) environment).getPropertySources();
+        List<String> properties = StreamSupport.stream(propertySources.spliterator(), false)
+                .filter(propertySource -> propertySource instanceof EnumerablePropertySource)
+                .map(propertySource -> ((EnumerablePropertySource<?>) propertySource).getPropertyNames())
+                .flatMap(Arrays::<String> stream)
+                .distinct()
+                .sorted()
+                .filter(prop -> prop.startsWith(varPrefix))
+                .collect(Collectors.toList());
+        
+        for (String prop : properties)
+        {
+        	env.put(StringUtils.removeStart(prop, varPrefix), environment.getProperty(prop));
+        }
+        
+		return env;
+	}
+	
 	private void registerPlugins()
 	{
 		List<LowcoderPlugin> loaded = pluginLoader.loadPlugins();
diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/framework/plugin/PluginExecutor.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/framework/plugin/PluginExecutor.java
@@ -1,5 +1,7 @@
 package org.lowcoder.api.framework.plugin;
 
+import java.util.Map;
+
 import org.lowcoder.plugin.api.LowcoderPlugin;
 import org.lowcoder.plugin.api.LowcoderServices;
 
@@ -8,11 +10,13 @@
 @Slf4j
 public class PluginExecutor extends Thread
 {
+	private Map<String, Object> env;
 	private LowcoderPlugin plugin;
 	private LowcoderServices services;
 	
-	public PluginExecutor(LowcoderPlugin plugin, LowcoderServices services)
+	public PluginExecutor(LowcoderPlugin plugin, Map<String, Object> env, LowcoderServices services)
 	{
+		this.env = env;
 		this.plugin = plugin;
 		this.services = services;
 		this.setContextClassLoader(plugin.getClass().getClassLoader());
@@ -22,7 +26,7 @@ public PluginExecutor(LowcoderPlugin plugin, LowcoderServices services)
 	@Override
 	public void run() 
 	{
-		if (plugin.load(services))
+		if (plugin.load(env, services))
 		{
 			log.info("Plugin [{}] loaded and running.", plugin.pluginId());
 		}

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,7 @@`
`1`	`1`	`package org.lowcoder.api.framework.plugin;`
`2`	`2`
	`3`	`+import java.util.Map;`
	`4`	`+`
`3`	`5`	`import org.lowcoder.plugin.api.LowcoderPlugin;`
`4`	`6`	`import org.lowcoder.plugin.api.LowcoderServices;`
`5`	`7`
`@@ -8,11 +10,13 @@`
`8`	`10`	`@Slf4j`
`9`	`11`	`public class PluginExecutor extends Thread`
`10`	`12`	`{`
	`13`	`+ private Map<String, Object> env;`
`11`	`14`	`private LowcoderPlugin plugin;`
`12`	`15`	`private LowcoderServices services;`
`13`	`16`
`14`		`- public PluginExecutor(LowcoderPlugin plugin, LowcoderServices services)`
	`17`	`+ public PluginExecutor(LowcoderPlugin plugin, Map<String, Object> env, LowcoderServices services)`
`15`	`18`	`{`
	`19`	`+ this.env = env;`
`16`	`20`	`this.plugin = plugin;`
`17`	`21`	`this.services = services;`
`18`	`22`	`this.setContextClassLoader(plugin.getClass().getClassLoader());`
`@@ -22,7 +26,7 @@ public PluginExecutor(LowcoderPlugin plugin, LowcoderServices services)`
`22`	`26`	`@Override`
`23`	`27`	`public void run()`
`24`	`28`	`{`
`25`		`- if (plugin.load(services))`
	`29`	`+ if (plugin.load(env, services))`
`26`	`30`	`{`
`27`	`31`	`log.info("Plugin [{}] loaded and running.", plugin.pluginId());`
`28`	`32`	`}`