auto generate sideOnly config

Author: brachy84

examples/sideOnly.json

@@ -0,0 +1,10 @@
+{
+  "ATTENTION": "This file is auto generated. Manual editing is not advised.",
+  "common": {},
+  "client": {
+    "net.minecraftforge.common.config.Configuration": [
+      "setCategoryConfigEntryClass()"
+    ]
+  },
+  "server": {}
+}

examples/sideOnlyGenerated.json

@@ -2,19 +2,19 @@
 
 import com.cleanroommc.groovyscript.GroovyScript;
 import com.cleanroommc.groovyscript.sandbox.SandboxData;
-import com.google.gson.JsonElement;
-import com.google.gson.JsonObject;
-import com.google.gson.JsonParser;
+import com.google.gson.*;
 import com.google.gson.stream.JsonReader;
 import it.unimi.dsi.fastutil.objects.Object2ObjectOpenHashMap;
 import it.unimi.dsi.fastutil.objects.ObjectOpenHashSet;
+import net.minecraftforge.fml.relauncher.FMLLaunchHandler;
 import net.minecraftforge.fml.relauncher.Side;
+import org.jetbrains.annotations.ApiStatus;
 
-import java.io.File;
-import java.io.FileInputStream;
-import java.io.InputStreamReader;
-import java.io.Reader;
+import java.io.*;
 import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.util.Collections;
+import java.util.List;
 import java.util.Map;
 import java.util.function.Function;
 
@@ -27,37 +27,102 @@ public class SideOnlyConfig {
     };
     private static final Map<String, MethodSet> clientRemovals = new Object2ObjectOpenHashMap<>();
     private static final Map<String, MethodSet> serverRemovals = new Object2ObjectOpenHashMap<>();
+    private static JsonObject generatedCfg;
+    private static JsonObject generatedClient;
+    private static JsonObject generatedServer;
 
     public static void clientOnly(String className, String member) {
-        serverRemovals.computeIfAbsent(className, DEFAULT_METHOD_SET).add(member);
+        addAutoDetectedFailingMembers(generatedClient, className, Collections.singletonList(member));
     }
 
     public static void serverOnly(String className, String member) {
-        clientRemovals.computeIfAbsent(className, DEFAULT_METHOD_SET).add(member);
+        addAutoDetectedFailingMembers(generatedServer, className, Collections.singletonList(member));
     }
 
     static void init() {
+        generatedCfg = readFile(SandboxData.getSideOnlyGeneratedFile());
+        if (generatedCfg == null) {
+            createGeneratedConfig();
+        } else {
+            generatedClient = generatedCfg.getAsJsonObject("client");
+            generatedServer = generatedCfg.getAsJsonObject("server");
+        }
+        readFile(new File(SandboxData.getScriptFile(), "sideOnly.json"));
+    }
+
+    private static void createGeneratedConfig() {
+        generatedCfg = new JsonObject();
+        generatedClient = new JsonObject();
+        generatedServer = new JsonObject();
+        generatedCfg.addProperty("ATTENTION", "This file is auto generated. Manual editing is not advised.");
+        generatedCfg.add("common", new JsonObject());
+        generatedCfg.add("client", generatedClient);
+        generatedCfg.add("server", generatedServer);
+
         clientOnly("net.minecraftforge.common.config.Configuration", "setCategoryConfigEntryClass()");
+        writeGeneratedConfig();
+    }
 
-        initConfig();
+    @ApiStatus.Internal
+    public static void addAutoDetectedFailingMembers(Class<?> c, List<String> members) {
+        // if the current side is server, it means its likely meant for client
+        addAutoDetectedFailingMembers(FMLLaunchHandler.side().isServer() ? generatedClient : generatedServer, c.getName(), members);
+    }
+
+    private static void addAutoDetectedFailingMembers(JsonObject sideJson, String className, List<String> members) {
+        JsonArray classJson = sideJson.getAsJsonArray(className);
+        if (classJson == null) {
+            classJson = new JsonArray();
+            sideJson.add(className, classJson);
+        }
+        main:
+        for (String member : members) {
+            for (JsonElement e : classJson) {
+                if (e.isJsonPrimitive() && e.getAsString().equals(member)) {
+                    continue main;
+                }
+            }
+            classJson.add(member);
+        }
+    }
+
+    public static void writeGeneratedConfig() {
+        File file = SandboxData.getSideOnlyGeneratedFile();
+        try {
+            if (file.exists()) {
+                file.delete();
+            } else {
+                file.getParentFile().mkdirs();
+            }
+
+            if (!file.getParentFile().isDirectory()) {
+                if (!file.getParentFile().mkdirs()) {
+                    GroovyScriptCore.LOG.error("Failed to create file dirs on path {}", file);
+                }
+            }
+            Writer writer = new OutputStreamWriter(Files.newOutputStream(file.toPath()), StandardCharsets.UTF_8);
+            writer.write(new GsonBuilder().setPrettyPrinting().create().toJson(generatedCfg));
+            writer.close();
+        } catch (Exception e) {
+            GroovyScriptCore.LOG.error("Failed to save file on path {}", file, e);
+        }
     }
 
-    private static void initConfig() {
-        File sideOnlyConfig = new File(SandboxData.getScriptFile(), "sideOnly.json");
+    private static JsonObject readFile(File sideOnlyConfig) {
         JsonObject json;
         try {
-            if (!sideOnlyConfig.isFile()) return;
+            if (!sideOnlyConfig.isFile()) return null;
             Reader reader = new InputStreamReader(new FileInputStream(sideOnlyConfig), StandardCharsets.UTF_8);
             JsonElement jsonElement = new JsonParser().parse(new JsonReader(reader));
             reader.close();
             if (jsonElement instanceof JsonObject jsonObject) {
                 json = jsonObject;
             } else {
-                return;
+                return null;
             }
         } catch (Exception e) {
             GroovyScript.LOGGER.error("Failed to read file on path {}", sideOnlyConfig, e);
-            return;
+            return null;
         }
         if (json.has("client")) {
             readConfig(serverRemovals, json.getAsJsonObject("client"));
@@ -81,6 +146,7 @@ private static void initConfig() {
                 break;
             }
         }
+        return json;
     }
 
     private static void readConfig(Map<String, MethodSet> removals, JsonObject json) {

src/main/java/com/cleanroommc/groovyscript/core/SideOnlyConfig.java

@@ -149,7 +149,7 @@ public void addProperties(Operation<Void> original) {
         try {
             original.call();
         } catch (Throwable t) {
-            throw new JavaBeanException(t, (MetaClassImpl) (Object) this);
+            throw JavaBeanException.of(t, (MetaClassImpl) (Object) this);
         }
     }
 }

src/main/java/com/cleanroommc/groovyscript/core/mixin/groovy/MetaClassImplMixin.java

@@ -129,7 +129,11 @@ public void run(LoadStage currentLoadStage) {
         try {
             load();
         } catch (ScriptRunException e) {
-            GroovyLog.get().exception("Script '" + e.script.name + "' ran into an issue while executing.", e.parent);
+            if (e.parent instanceof JavaBeanException jbe) {
+                jbe.logError(e.script.name);
+            } else {
+                GroovyLog.get().exception("Script '" + e.script.name + "' ran into an issue while executing.", e.parent);
+            }
         } catch (IOException | ScriptException | ResourceException e) {
             GroovyLog.get().exception("An exception occurred while trying to run groovy code! This is might be a internal groovy issue.", e);
         } catch (Throwable t) {

src/main/java/com/cleanroommc/groovyscript/sandbox/GroovyScriptSandbox.java

@@ -1,15 +1,91 @@
 package com.cleanroommc.groovyscript.sandbox;
 
+import com.cleanroommc.groovyscript.api.GroovyLog;
+import com.cleanroommc.groovyscript.core.SideOnlyConfig;
 import groovy.lang.MetaClassImpl;
+import io.github.classgraph.*;
+import net.minecraft.launchwrapper.Launch;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
 
 public class JavaBeanException extends RuntimeException {
 
     public final Throwable parent;
     public final MetaClassImpl metaClass;
+    public final List<String> failingMembers;
 
-    public JavaBeanException(Throwable parent, MetaClassImpl metaClass) {
+    private JavaBeanException(Throwable parent, MetaClassImpl metaClass, List<String> failingMembers) {
         super("An error occurred while trying to gather java properties for class " + metaClass.getTheClass().getName());
         this.parent = parent;
         this.metaClass = metaClass;
+        this.failingMembers = failingMembers;
+    }
+
+    public void logError(String script) {
+        GroovyLog.Msg msg = GroovyLog.msg("Script '{}' ran into an error while loading class '{}'", script, this.metaClass.getTheClass().getName())
+                .error();
+        if (this.failingMembers.isEmpty()) {
+            msg.add("no failing members could be found");
+        } else {
+            msg.add("Found {} failing members. GroovyScript will add these to sideOnlyGenerated.json to attempt to fix it.", this.failingMembers.size());
+            msg.add("Please restart the game. If the EXACT SAME ERROR still appears, report the issue to the mod authors.");
+            SideOnlyConfig.addAutoDetectedFailingMembers(this.metaClass.getTheClass(), this.failingMembers);
+            SideOnlyConfig.writeGeneratedConfig();
+        }
+        msg.post();
+    }
+
+    public static JavaBeanException of(Throwable parent, MetaClassImpl metaClass) {
+        return new JavaBeanException(parent, metaClass, findFailingMembers(metaClass.getTheClass()));
+    }
+
+    private static List<String> findFailingMembers(Class<?> c) {
+        ScanResult scanResult = new ClassGraph()
+                .enableClassInfo()
+                .enableMethodInfo()
+                .enableFieldInfo()
+                .enableSystemJarsAndModules()
+                .overrideClassLoaders(Launch.classLoader)
+                .acceptClasses(c.getName())
+                .scan();
+        ClassInfo ci = scanResult.getClassInfo(c.getName());
+
+        try {
+            ci.loadClass();
+        } catch (Throwable e) {
+            scanResult.close();
+            return Collections.emptyList();
+        }
+
+        List<String> failingMembers = new ArrayList<>();
+
+        for (MethodInfo mi : ci.getDeclaredConstructorInfo()) {
+            try {
+                mi.loadClassAndGetConstructor();
+            } catch (Throwable t) {
+                failingMembers.add(mi.getName() + "()");
+            }
+        }
+
+        for (MethodInfo mi : ci.getDeclaredMethodInfo()) {
+            try {
+                mi.loadClassAndGetMethod();
+            } catch (Throwable t) {
+                failingMembers.add(mi.getName() + "()");
+            }
+        }
+
+        for (FieldInfo fi : ci.getDeclaredFieldInfo()) {
+            try {
+                fi.loadClassAndGetField();
+            } catch (Throwable t) {
+                failingMembers.add(fi.getName());
+            }
+        }
+
+        scanResult.close();
+        return failingMembers;
     }
 }

src/main/java/com/cleanroommc/groovyscript/sandbox/JavaBeanException.java

@@ -38,6 +38,7 @@ public class SandboxData {
     private static File runConfigFile;
     private static File resourcesFile;
     private static File cachePath;
+    private static File sideOnlyGeneratedFile;
     private static URL rootUrl;
     private static URL[] rootUrls;
     private static boolean initialised = false;
@@ -69,6 +70,7 @@ public static void initialize(File minecraftHome, Logger log) {
         }
         runConfigFile = new File(scriptPath, "runConfig.json");
         resourcesFile = new File(scriptPath, "assets");
+        sideOnlyGeneratedFile = new File(scriptPath, "sideOnlyGenerated.json");
         try {
             rootUrl = scriptPath.toURI().toURL();
             rootUrls = new URL[]{
@@ -109,6 +111,11 @@ public static void initialize(File minecraftHome, Logger log) {
         return cachePath;
     }
 
+    public static File getSideOnlyGeneratedFile() {
+        ensureLoaded();
+        return sideOnlyGeneratedFile;
+    }
+
     public static @NotNull URL getRootUrl() {
         ensureLoaded();
         return rootUrl;