diff --git a/build.gradle b/build.gradle index e57a16f..443fc39 100644 --- a/build.gradle +++ b/build.gradle @@ -3,3 +3,7 @@ plugins { id 'com.gtnewhorizons.gtnhconvention' } + +test { + useJUnitPlatform() +} diff --git a/dependencies.gradle b/dependencies.gradle index 61a6d2a..f6c7d7c 100644 --- a/dependencies.gradle +++ b/dependencies.gradle @@ -5,4 +5,10 @@ dependencies { compileOnly('com.falsepattern:chunkapi-mc1.7.10:0.8.2:dev') compileOnly('com.falsepattern:endlessids-mc1.7.10:1.7.1:dev') compileOnly("com.github.GTNewHorizons:NotEnoughItems:2.8.75-GTNH:dev") { transitive = false } + + testImplementation(platform('org.junit:junit-bom:5.11.4')) + testImplementation('org.junit.jupiter:junit-jupiter') + testRuntimeOnly('org.junit.platform:junit-platform-launcher') + // fastutil is only on the compile/runtime classpath via the patched Minecraft jar, not the plain test JVM. + testRuntimeOnly('it.unimi.dsi:fastutil:8.5.18') } diff --git a/src/main/java/com/gtnewhorizons/postea/Postea.java b/src/main/java/com/gtnewhorizons/postea/Postea.java index 59ca3ae..6a7a6f2 100644 --- a/src/main/java/com/gtnewhorizons/postea/Postea.java +++ b/src/main/java/com/gtnewhorizons/postea/Postea.java @@ -3,6 +3,9 @@ package com.gtnewhorizons.postea; import net.minecraftforge.common.MinecraftForge; import net.minecraftforge.event.world.ChunkEvent; +import org.apache.logging.log4j.LogManager; +import org.apache.logging.log4j.Logger; + import com.gtnewhorizons.postea.utility.ChunkFixerUtility; import com.gtnewhorizons.postea.utility.IDRegistry; import com.gtnewhorizons.postea.utility.MissingMappingHandler; @@ -29,6 +32,8 @@ public class Postea { public static final String MODID = "postea"; public static final String MODNAME = "Postea"; + public static final Logger LOG = LogManager.getLogger(MODNAME); + @Mod.EventHandler public void preInit(FMLPreInitializationEvent event) { MinecraftForge.EVENT_BUS.register(this); diff --git a/src/main/java/com/gtnewhorizons/postea/api/ChunkTransformContext.java b/src/main/java/com/gtnewhorizons/postea/api/ChunkTransformContext.java new file mode 100644 index 0000000..9b8a46f --- /dev/null +++ b/src/main/java/com/gtnewhorizons/postea/api/ChunkTransformContext.java @@ -0,0 +1,8 @@ +package com.gtnewhorizons.postea.api; + +import com.gtnewhorizons.postea.utility.VersionStamps; + +public final class ChunkTransformContext { + + public static final int UNSTAMPED = VersionStamps.UNSTAMPED; +} diff --git a/src/main/java/com/gtnewhorizons/postea/api/IVersionedTransformer.java b/src/main/java/com/gtnewhorizons/postea/api/IVersionedTransformer.java new file mode 100644 index 0000000..9efa934 --- /dev/null +++ b/src/main/java/com/gtnewhorizons/postea/api/IVersionedTransformer.java @@ -0,0 +1,40 @@ +package com.gtnewhorizons.postea.api; + +/** + * A transformer that brings saved data written under an older version of its owner's content up to the current + * version. Postea stamps every chunk and every player it saves with {@link #currentVersion()} under {@link #key()} + * and, when reading, invokes the transformer only for data whose stamp differs, so each chunk and player is seen + * exactly once per version change no matter how many sessions passed in between. Data saved before the transformer + * existed reads as {@link ChunkTransformContext#UNSTAMPED}; the transformer decides what that means. + *
+ * Register through {@link VersionedReplacementManager#register(IVersionedTransformer)} during mod loading, postInit + * at the latest. Transformers run in registration order and before every other Postea pass, so a transformer whose + * output depends on another mod's versioned data (for example one that writes that mod's indices) must register + * after that mod; FML's dependency ordering guarantees this when both register in the same lifecycle phase. + *
+ * Chunk transformers may run on a chunk I/O thread, several concurrently for different chunks. They must not touch
+ * world state beyond the context and their own state must be safe to read concurrently.
+ */
+public interface IVersionedTransformer {
+
+ /**
+ * The stamp key, unique across all registered transformers, e.g. {@code "materiallib:idList"}.
+ */
+ String key();
+
+ /**
+ * The version the transformer's output is written under. Sampled at every read and every save.
+ */
+ int currentVersion();
+
+ /**
+ * Brings a chunk stamped at {@link ChunkTransformContext#storedVersion()} to {@link #currentVersion()}.
+ */
+ default void transformChunk(ChunkTransformContext ctx) {}
+
+ /**
+ * Brings a player's saved data stamped at {@link PlayerDataTransformContext#storedVersion()} to
+ * {@link #currentVersion()}.
+ */
+ default void transformPlayer(PlayerDataTransformContext ctx) {}
+}
diff --git a/src/main/java/com/gtnewhorizons/postea/api/PlayerDataTransformContext.java b/src/main/java/com/gtnewhorizons/postea/api/PlayerDataTransformContext.java
new file mode 100644
index 0000000..61e19f4
--- /dev/null
+++ b/src/main/java/com/gtnewhorizons/postea/api/PlayerDataTransformContext.java
@@ -0,0 +1,8 @@
+package com.gtnewhorizons.postea.api;
+
+import com.gtnewhorizons.postea.utility.VersionStamps;
+
+public final class PlayerDataTransformContext {
+
+ public static final int UNSTAMPED = VersionStamps.UNSTAMPED;
+}
diff --git a/src/main/java/com/gtnewhorizons/postea/api/VersionedReplacementManager.java b/src/main/java/com/gtnewhorizons/postea/api/VersionedReplacementManager.java
new file mode 100644
index 0000000..d56f3d8
--- /dev/null
+++ b/src/main/java/com/gtnewhorizons/postea/api/VersionedReplacementManager.java
@@ -0,0 +1,36 @@
+package com.gtnewhorizons.postea.api;
+
+import java.util.Collections;
+import java.util.List;
+import java.util.Objects;
+import java.util.concurrent.CopyOnWriteArrayList;
+
+/**
+ * Registration of {@link IVersionedTransformer}s. See that interface for the execution contract.
+ */
+public abstract class VersionedReplacementManager {
+
+ private static final List