More entrypoints! (#198)

* Start on more entrypoints

* lowerCamelCase the entrypoint names

* Update documentation

* Checkstyle

* Remove comments because of Loader bug

Author: TheGlitch76

.github/workflows/build.yml

@@ -20,7 +20,7 @@ jobs:
       - uses: eskatos/gradle-command-action@v1
         with:
           gradle-version: wrapper
-          arguments: build -x check
+          arguments: remapAllJars
           dependencies-cache-enabled: true
           configuration-cache-enabled: false
       # Artifact publishing

gradle.properties

@@ -1,6 +1,6 @@
 # Gradle needs a lot of memory to build in parallel.
 # If you're starved, you can reduce this to 1G and disable parallel building.
-org.gradle.jvmargs=-Xmx3G
+org.gradle.jvmargs=-Xmx1G
 org.gradle.parallel=true
 org.gradle.daemon=false
 repoName=patchwork-api

patchwork-api-base/src/main/resources/fabric.mod.json

@@ -13,7 +13,6 @@
     "PatchworkMC"
   ],
   "depends": {
-    // This is mirrored in the top-level project because of a Loader issue
     "fabricloader": ">=0.10.0",
     "fabric": ">=0.15.1"
   },

patchwork-dispatcher/README.MD

@@ -0,0 +1,17 @@
+# Patchwork Dispatcher
+A sane and simple framework around FML for Patchwork.
+
+This document intends to (eventually) describe how mods are identified and loaded.
+## Custom block
+Patchwork Patcher will provide the following metadata at the root of the `custom` block:
+1. `patchwork:source`: An object with a member named `loader` of value `forge`.
+This is for ModMenu, and should not be considered a reliable or stable marker of a patched mod (it will be removed in 1.16)
+
+Additionally, the following metadata will be provided through the `patchwork:patcherMeta` object:
+1. `patchedOn`: An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date that shows when this file was patched.
+It should be in UTC time and have the format of the format `yyyy-MM-dd'T'HH:mm'Z'` (which results in something like `2020-10-10T22:03Z`)
+2. `patcherVersion`: The version of Patcher that this mod has been patched with.
+3. `annotations`:  Points to a json file somewhere in the JAR that holds the annotation metadata.
+ Must either be a valid SemVer version (i.e `1.0.0`), or `develop`. When checking if a Patcher version is recent enough for the current API version, `develop` will always be considered compatible.
+4. `parent`: If the mod is a skeleton mod (TODO: Describe in more detail), this tells the mod id of it's parent
+5. `children`: If the mod has children, this array lists all additional mod ids that were provided in the original Forge mod.

…et/patchworkmc/api/ForgeInitializer.java …ava/net/patchworkmc/api/ModInstance.javapatchwork-dispatcher/src/main/java/net/patchworkmc/api/ForgeInitializer.java renamed to patchwork-dispatcher/src/main/java/net/patchworkmc/api/ModInstance.java patchwork-dispatcher/src/main/java/net/patchworkmc/api/ForgeInitializer.java renamed to patchwork-dispatcher/src/main/java/net/patchworkmc/api/ModInstance.java

@@ -19,8 +19,5 @@
 
 package net.patchworkmc.api;
 
-public interface ForgeInitializer {
-	String getModId();
-
-	void onForgeInitialize();
+public interface ModInstance {
 }

patchwork-dispatcher/src/main/java/net/patchworkmc/impl/Patchwork.java

@@ -19,17 +19,15 @@
 
 package net.patchworkmc.impl;
 
+import java.util.ArrayList;
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.List;
-import java.util.Map;
 import java.util.function.Consumer;
 import java.util.function.Function;
 import java.util.function.Supplier;
 import java.util.stream.Collectors;
 
-import org.apache.logging.log4j.LogManager;
-import org.apache.logging.log4j.Logger;
 import net.minecraftforge.common.MinecraftForge;
 import net.minecraftforge.event.RegistryEvent;
 import net.minecraftforge.eventbus.api.Event;
@@ -44,12 +42,17 @@
 import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;
 import net.minecraftforge.fml.javafmlmod.FMLModContainer;
 import net.minecraftforge.registries.ForgeRegistries;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 
 import net.minecraft.server.dedicated.DedicatedServer;
+import net.minecraft.util.Pair;
 
+import net.fabricmc.api.ModInitializer;
 import net.fabricmc.loader.api.FabricLoader;
+import net.fabricmc.loader.api.metadata.CustomValue;
 
-import net.patchworkmc.api.ForgeInitializer;
+import net.patchworkmc.api.ModInstance;
 import net.patchworkmc.impl.registries.RegistryEventDispatcher;
 
 public class Patchwork {
@@ -78,29 +81,52 @@ private static void dispatch(Collection<FMLModContainer> mods, Function<ModConta
 	public static void gatherAndInitializeMods() {
 		ForgeRegistries.init();
 
-		Map<ForgeInitializer, FMLModContainer> mods = new HashMap<>();
-
+		List<FMLModContainer> mods = new ArrayList<>();
+		List<Pair<String, Supplier<ModInstance>>> modInitializers = new ArrayList<>();
 		// Construct forge mods
 
-		List<ForgeInitializer> entrypoints;
+		// TODO: https://github.com/FabricMC/fabric-loader/pull/313
+
+		for (net.fabricmc.loader.api.ModContainer mod : FabricLoader.getInstance().getAllMods()) {
+			String modId = mod.getMetadata().getId();
 
-		try {
-			entrypoints = FabricLoader.getInstance().getEntrypoints("patchwork", ForgeInitializer.class);
-		} catch (Throwable t) {
-			throw new PatchworkInitializationException("Failed to get Patchwork entrypoints!", t);
+			CustomValue meta = mod.getMetadata().getCustomValue("patchwork:patcher_meta");
+
+			if (meta != null && meta.getAsObject().get("parent") != null) {
+				// synthetic mods are unreliable; don't invoke their entrypoints here
+				continue;
+			}
+
+			modInitializers.add(new Pair<>(modId, () -> createModInstance(modId)));
+
+			if (meta != null) {
+				CustomValue children = meta.getAsObject().get("children");
+
+				if (children != null) {
+					for (CustomValue customValue : children.getAsArray()) {
+						String childId = customValue.getAsString();
+						modInitializers.add(new Pair<>(childId, () -> createModInstance(modId)));
+					}
+				}
+			}
 		}
 
 		PatchworkInitializationException error = null;
 
-		for (ForgeInitializer initializer : entrypoints) {
-			LOGGER.info("Constructing Patchwork mod: " + initializer.getModId());
+		for (Pair<String, Supplier<ModInstance>> pair : modInitializers) {
+			String modId = pair.getLeft();
+			FMLModContainer container = new FMLModContainer(modId);
+			boolean loaded = false;
 
-			FMLModContainer container = new FMLModContainer(initializer.getModId());
 			ModLoadingContext.get().setActiveContainer(container, new FMLJavaModLoadingContext(container));
 
 			try {
-				// TODO: Supposed to call "container.setMod()" here, but this requires a WIP Patchwork-Patcher feature.
-				initializer.onForgeInitialize();
+				ModInstance instance = pair.getRight().get();
+
+				if (instance != null) {
+					container.setMod(instance);
+					loaded = true;
+				}
 			} catch (Throwable t) {
 				if (error == null) {
 					error = new PatchworkInitializationException("Failed to construct Patchwork mods");
@@ -127,9 +153,9 @@ public static void gatherAndInitializeMods() {
 					}
 
 					if (unDefinedClass.startsWith("net.minecraft.") || (unDefinedClass.startsWith("net.minecraftforge.") && !unDefinedClass.startsWith("net.minecraftforge.lex."))) {
-						throw new PatchworkInitializationException("Patchwork mod " + initializer.getModId() + " tried to access an unimplemented " + type + ".", t);
+						throw new PatchworkInitializationException("Patchwork mod " + modId + " tried to access an unimplemented " + type + ".", t);
 					} else {
-						throw new PatchworkInitializationException("Patchwork mod " + initializer.getModId() + " tried to access a missing " + type + " from a missing and undeclared, or outdated dependency.", t);
+						throw new PatchworkInitializationException("Patchwork mod " + modId + " tried to access a missing " + type + " from a missing and undeclared, or outdated dependency.", t);
 					}
 				}
 
@@ -138,18 +164,24 @@ public static void gatherAndInitializeMods() {
 
 			ModLoadingContext.get().setActiveContainer(null, "minecraft");
 
-			mods.put(initializer, container);
+			if (loaded) {
+				mods.add(container);
+			}
 		}
 
 		if (error != null) {
 			throw error;
 		}
 
-		ModList.get().setLoadedMods(mods.values());
+		ModList.get().setLoadedMods(mods);
+		// note: forge fires this per-class when it is registered.
+		dispatchEntrypoint(mods, "patchwork:commonAutomaticSubscribers");
 		// Send initialization events
+		dispatch(mods, new RegistryEvent.NewRegistry());
+		dispatchEntrypoint("patchwork:objectHolders");
+		dispatchEntrypoint("patchwork:capabilityInject");
 
-		dispatch(mods.values(), new RegistryEvent.NewRegistry());
-		RegistryEventDispatcher.dispatchRegistryEvents(event -> dispatch(mods.values(), event));
+		RegistryEventDispatcher.dispatchRegistryEvents(event -> dispatch(mods, event));
 	}
 
 	/**
@@ -209,4 +241,39 @@ public static void endOfServerModLoading() {
 		// Assume there's no error.
 		MinecraftForge.EVENT_BUS.start();
 	}
+
+	private static ModInstance createModInstance(String modid) {
+		List<ModInstance> initializer = FabricLoader.getInstance().getEntrypoints("patchwork:modInstance:" + modid, ModInstance.class);
+
+		if (initializer.size() > 1) {
+			throw new AssertionError("Cannot have more than 1 mod_instance for a given modid! aborting!");
+		} else if (initializer.size() == 1) {
+			return initializer.get(0);
+		} else {
+			return null;
+		}
+	}
+
+	private static void dispatchEntrypoint(String name) {
+		FabricLoader.getInstance().getEntrypoints(name, ModInitializer.class).forEach(ModInitializer::onInitialize);
+	}
+
+	private static void dispatchEntrypoint(Collection<FMLModContainer> mods, String name) {
+		HashMap<String, List<ModInitializer>> map = new HashMap<>();
+		FabricLoader.getInstance().getEntrypointContainers(name, ModInitializer.class)
+				.forEach(container -> map.computeIfAbsent(container.getProvider().getMetadata().getId(),
+					id -> new ArrayList<>())
+						.add(container.getEntrypoint()));
+
+		for (FMLModContainer mod : mods) {
+			List<ModInitializer> inits = map.get(mod.getModId());
+
+			if (inits != null) {
+				ModLoadingContext.get().setActiveContainer(mod, new FMLJavaModLoadingContext(mod));
+				inits.forEach(ModInitializer::onInitialize);
+			}
+		}
+
+		ModLoadingContext.get().setActiveContainer(null, "minecraft");
+	}
 }

patchwork-fml/src/main/java/net/minecraftforge/fml/ModList.java

@@ -31,18 +31,18 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
+import com.google.common.collect.ImmutableList;
 import net.minecraftforge.fml.javafmlmod.FMLModContainer;
 import net.minecraftforge.fml.loading.moddiscovery.ModFile;
 import net.minecraftforge.fml.loading.moddiscovery.ModFileInfo;
 import net.minecraftforge.forgespi.language.ModFileScanData;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
-import com.google.common.collect.ImmutableList;
 
 import net.fabricmc.loader.api.FabricLoader;
 import net.fabricmc.loader.api.ModContainer;
 import net.fabricmc.loader.api.metadata.CustomValue;
-import net.fabricmc.loader.api.metadata.ModMetadata;
+import net.fabricmc.loader.api.metadata.CustomValue.CvObject;
 
 public class ModList {
 	private static final Logger LOGGER = LogManager.getLogger();
@@ -115,11 +115,10 @@ private ModFileInfo getModFileByContainer(ModContainer modContainer) {
 	}
 
 	private ModFileInfo createModFileInfo(ModContainer modContainer) {
-		ModMetadata metadata = modContainer.getMetadata();
-
-		// First try to find a patchwork:annotations entry for this file. If it exists, then this is the "primary" mod
+		CvObject patcherMeta = modContainer.getMetadata().getCustomValue("patchwork:patcher_meta").getAsObject();
+		// First try to find a patchwork:annotations entry in the patcher metadata. If it exists, then this is the "primary" mod
 		// for a given JAR file.
-		CustomValue annotations = metadata.getCustomValue("patchwork:annotations");
+		CustomValue annotations = patcherMeta.get("annotations");
 
 		if (annotations != null) {
 			String annotationJsonLocation = annotations.getAsString();
@@ -129,7 +128,7 @@ private ModFileInfo createModFileInfo(ModContainer modContainer) {
 
 		// If there is no annotation data indicative of a primary mod file, try to then find the parent (primary) mod ID.
 		// This indicates that this is a dummy JiJ mod created by Patchwork Patcher.
-		CustomValue parent = metadata.getCustomValue("patchwork:parent");
+		CustomValue parent = patcherMeta.get("parent");
 
 		if (parent != null) {
 			return getModFileById(parent.getAsString());
@@ -146,7 +145,7 @@ private ModFileInfo createModFileInfo(ModContainer modContainer) {
 
 			if (loader.equals("forge")) {
 				LOGGER.warn("A mod was patched with an old version of Patchwork Patcher, please re-patch it! "
-						+ "No annotation data is available for " + metadata.getId() + " (loaded from " + modContainer.getRootPath() + ")");
+						+ "No annotation data is available for " + modContainer.getMetadata().getId() + " (loaded from " + modContainer.getRootPath() + ")");
 			}
 		}
 

src/main/resources/fabric.mod.json

@@ -13,8 +13,6 @@
     "PatchworkMC"
   ],
   "depends": {
-    // This is copied over from patchwork-api-base until Loader/201 is resolved properly.
-    // Loader/204 exists as a bandage fix, but not a real solution.
     "fabricloader": ">=0.10.0",
     "fabric": ">=0.15.1"
   },