Merge remote-tracking branch 'origin/1.20' into 1.21.1

Author: embeddedt

.github/workflows/gradle.yml

@@ -44,6 +44,8 @@ jobs:
         run: ./scripts/tagcleaner.sh
       - name: Build ModernFix using Gradle
         run: ./gradlew build
+      - name: Run mixin audit
+        run: timeout 60 xvfb-run ./gradlew runAuditClient
       - name: Publish mod to CurseForge & Modrinth
         if: steps.check_branch.outputs.is_release == 'true'
         run: ./gradlew publishMods copyJarToBin

build.gradle.kts

@@ -38,6 +38,10 @@ neoForge {
         create("server") {
             server()
         }
+        create("auditClient") {
+            client()
+            jvmArguments.addAll("-Dmodernfix.auditAndExit=true", "-Djava.awt.headless=true")
+        }
     }
 
     mods {

src/main/java/org/embeddedt/modernfix/ModernFix.java

@@ -12,6 +12,7 @@
 import org.embeddedt.modernfix.platform.ModernFixPlatformHooks;
 import org.embeddedt.modernfix.resources.ReloadExecutor;
 import org.embeddedt.modernfix.util.ClassInfoManager;
+import org.spongepowered.asm.mixin.MixinEnvironment;
 
 import java.lang.management.ManagementFactory;
 import java.util.concurrent.ExecutorService;
@@ -45,6 +46,15 @@ public static ExecutorService resourceReloadExecutor() {
         return resourceReloadService;
     }
 
+    public static void runAuditIfRequested() {
+        boolean auditAndExit = Boolean.getBoolean("modernfix.auditAndExit");
+        if (auditAndExit || Boolean.getBoolean("modernfix.auditMixinsAtStart")) {
+            MixinEnvironment.getCurrentEnvironment().audit();
+            if (auditAndExit) {
+                System.exit(0);
+            }
+        }
+    }
 
     public ModernFix() {
         INSTANCE = this;

src/main/java/org/embeddedt/modernfix/common/mixin/perf/dynamic_languages/ClientLanguageMixin.java

@@ -2,7 +2,8 @@
 
 import com.llamalad7.mixinextras.injector.wrapoperation.Operation;
 import com.llamalad7.mixinextras.injector.wrapoperation.WrapOperation;
-import com.llamalad7.mixinextras.sugar.Local;
+import com.llamalad7.mixinextras.sugar.Share;
+import com.llamalad7.mixinextras.sugar.ref.LocalRef;
 import net.minecraft.client.resources.language.ClientLanguage;
 import net.minecraft.server.packs.resources.Resource;
 import org.embeddedt.modernfix.annotation.ClientOnlyMixin;
@@ -11,47 +12,42 @@
 import org.spongepowered.asm.mixin.injection.At;
 import org.spongepowered.asm.mixin.injection.ModifyArg;
 
+import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
-import java.util.function.BiConsumer;
+import java.util.Objects;
 
 /**
  * Modifies the language system to load/unload the contents of language entries based on GC pressure.
  */
-@Mixin(ClientLanguage.class)
+@Mixin(value = ClientLanguage.class, priority = 2000)
 @ClientOnlyMixin
 public class ClientLanguageMixin {
-    private static final ThreadLocal<Boolean> MFIX_MODIFY_APPEND_SEMANTICS = ThreadLocal.withInitial(() -> Boolean.FALSE);
-
-    /**
-     * @author embeddedt
-     * @reason modify the semantics of appendFrom so that it's used to do a prepass
-     */
-    @ModifyArg(method = "appendFrom", at = @At(value = "INVOKE", target = "Lnet/minecraft/locale/Language;loadFromJson(Ljava/io/InputStream;Ljava/util/function/BiConsumer;)V"), index = 1)
-    private static BiConsumer<String, ?> changeSemanticsOfConsumer(BiConsumer<String, ?> consumer, @Local(ordinal = 0, argsOnly = true) Map<String, Object> destinationMap, @Local(ordinal = 0) Resource resource) {
-        return MFIX_MODIFY_APPEND_SEMANTICS.get() ? ((k, v) -> destinationMap.put(k, resource)) : consumer;
-    }
-
     /**
      * @author embeddedt
-     * @reason collect resources that own keys with a prepass
+     * @reason collect the list of all known language resources
      */
-    @WrapOperation(method = "loadFrom", at = @At(value = "INVOKE", target = "Lnet/minecraft/client/resources/language/ClientLanguage;appendFrom(Ljava/lang/String;Ljava/util/List;Ljava/util/Map;)V"))
-    private static void trackEntrySource(String languageName, List<Resource> resources, Map<String, String> destinationMap, Operation<Void> original) {
-        MFIX_MODIFY_APPEND_SEMANTICS.set(true);
-        try {
-            original.call(languageName, resources, destinationMap);
-        } finally {
-            MFIX_MODIFY_APPEND_SEMANTICS.remove();
+    @WrapOperation(method = "loadFrom", at = @At(value = "INVOKE",
+            target = "Lnet/minecraft/client/resources/language/ClientLanguage;appendFrom(Ljava/lang/String;Ljava/util/List;Ljava/util/Map;)V"))
+    private static void collectResources(String languageName, List<Resource> resources,
+                                              Map<String, String> destinationMap, Operation<Void> original,
+                                              @Share("usedResources") LocalRef<List<Resource>> usedResources) {
+        List<Resource> collected = usedResources.get();
+        if (collected == null) {
+            collected = new ArrayList<>();
+            usedResources.set(collected);
         }
+        collected.addAll(resources);
+        original.call(languageName, resources, destinationMap);
     }
 
     /**
      * @author embeddedt
      * @reason figure out which keys are dynamically loaded and which are injected by mixins
      */
     @ModifyArg(method = "loadFrom", at = @At(value = "INVOKE", target = "Lnet/minecraft/client/resources/language/ClientLanguage;<init>(Ljava/util/Map;Z)V"), index = 0)
-    private static Map<String, String> modifyLanguageMap(Map<String, ?> storage) {
-        return DynamicLanguageMap.forStorage(Map.copyOf(storage));
+    private static Map<String, String> modifyLanguageMap(Map<String, String> storage, @Share("usedResources") LocalRef<List<Resource>> usedResources) {
+        List<Resource> collected = Objects.requireNonNullElse(usedResources.get(), List.of());
+        return DynamicLanguageMap.forVanillaData(storage, collected);
     }
 }

src/main/java/org/embeddedt/modernfix/common/mixin/perf/optimize_surface_rules/SurfaceSystemMixin.java

@@ -26,7 +26,7 @@
 
 import java.util.function.Function;
 
-@Mixin(SurfaceSystem.class)
+@Mixin(value = SurfaceSystem.class, priority = 2000)
 public class SurfaceSystemMixin {
     private static final ThreadLocal<ChunkBiomeLookup> MFIX_LOOKUP_CACHE = ThreadLocal.withInitial(ChunkBiomeLookup::new);
     private static final ThreadLocal<PrefetchingBlockColumn> MFIX_BLOCK_COLUMN = new ThreadLocal<>();
@@ -43,7 +43,7 @@ private Function<BlockPos, Holder<Biome>> useFasterLookup(Function<BlockPos, Hol
         return lookup;
     }
 
-    @Inject(method = "buildSurface", at = @At("RETURN"))
+    @Inject(method = "buildSurface", at = @At("TAIL"))
     private void finishAndDisposeLookups(RandomState randomState, BiomeManager biomeManager, Registry<Biome> biomes, boolean p_224652_, WorldGenerationContext context, ChunkAccess chunk, NoiseChunk noiseChunk, SurfaceRules.RuleSource ruleSource, CallbackInfo ci) {
         MFIX_LOOKUP_CACHE.get().dispose();
         var column = MFIX_BLOCK_COLUMN.get();

src/main/java/org/embeddedt/modernfix/common/mixin/perf/suspend_integrated_server_during_load/IntegratedServerMixin.java

@@ -17,6 +17,8 @@
 import org.spongepowered.asm.mixin.Mixin;
 import org.spongepowered.asm.mixin.Shadow;
 import org.spongepowered.asm.mixin.injection.At;
+import org.spongepowered.asm.mixin.injection.Inject;
+import org.spongepowered.asm.mixin.injection.callback.CallbackInfo;
 
 import java.net.Proxy;
 import java.util.concurrent.atomic.AtomicBoolean;
@@ -28,6 +30,7 @@ public abstract class IntegratedServerMixin extends MinecraftServer implements I
     @Shadow
     private boolean paused;
 
+    private int mfix$numTickServerCalls = 0;
     private final AtomicBoolean mfix$hasPrimaryClientJoined = new AtomicBoolean(false);
 
     public IntegratedServerMixin(Thread serverThread, LevelStorageSource.LevelStorageAccess storageSource, PackRepository packRepository, WorldStem worldStem, Proxy proxy, DataFixer fixerUpper, Services services, ChunkProgressListenerFactory progressListenerFactory) {
@@ -44,14 +47,26 @@ private boolean preventTicks(Minecraft instance, Operation<Boolean> original) {
         return !mfix$hasPrimaryClientJoined.get() || original.call(instance);
     }
 
+    /**
+     * @author embeddedt
+     * @reason Keep our own tick count for the integrated server specifically, rather than relying on super
+     * to increment.
+     */
+    @Inject(method = "tickServer", at = @At("HEAD"))
+    private void mfix$countTicks(CallbackInfo ci) {
+        this.mfix$numTickServerCalls++;
+    }
+
     /**
      * @author embeddedt
      * @reason If waiting for a client connection to exist, we only need to tick the server connection,
-     * not the whole server as vanilla does.
+     * not the whole server as vanilla does. However, we must tick the whole server once to accommodate mods
+     * that rely on the first tick to initialize state as a side effect. Not doing this causes issues like
+     * <a href="https://github.com/embeddedt/ModernFix/issues/639">#639</a>.
      */
     @WrapWithCondition(method = "tickServer", at = @At(value = "INVOKE", target = "Lnet/minecraft/server/MinecraftServer;tickServer(Ljava/util/function/BooleanSupplier;)V", ordinal = 0))
     private boolean preventRunningFullServerTick(MinecraftServer server, BooleanSupplier hasTimeLeft) {
-        if (this.paused && !mfix$hasPrimaryClientJoined.get()) {
+        if (this.mfix$numTickServerCalls >= 2 && this.paused && !mfix$hasPrimaryClientJoined.get()) {
             var conn = this.getConnection();
             if (conn != null) {
                 conn.tick();

src/main/java/org/embeddedt/modernfix/dynamiclanguages/DynamicLanguageMap.java

@@ -10,10 +10,28 @@
 import org.embeddedt.modernfix.ModernFix;
 
 import java.io.IOException;
+import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 
 public class DynamicLanguageMap {
-    public static Map<String, String> forStorage(Map<String, ?> storage) {
+    private static Map<String, Object> createStorage(Map<String, String> rawLanguageContents, List<Resource> languageResources) {
+        Map<String, Object> storage = new HashMap<>(rawLanguageContents);
+        for (var resource : languageResources) {
+            try (var stream = resource.open()) {
+                Language.loadFromJson(stream, (key, value) -> {
+                    if (value != null && value.equals(storage.get(key))) {
+                        storage.put(key, resource);
+                    }
+                });
+            } catch (Exception ignored) {
+            }
+        }
+        return Map.copyOf(storage);
+    }
+
+    public static Map<String, String> forVanillaData(Map<String, String> rawLanguageContents, List<Resource> languageResources) {
+        Map<String, Object> storage = createStorage(rawLanguageContents, languageResources);
         LoadingCache<Resource, Map<String, String>> languageFileContents = CacheBuilder.newBuilder()
                 .softValues()
                 .build(new CacheLoader<>() {

src/main/java/org/embeddedt/modernfix/neoforge/init/ModernFixForge.java

@@ -81,6 +81,7 @@ public void commonSetup(FMLCommonSetupEvent event) {
                     ModLoader.addLoadingIssue(ModLoadingIssue.warning("modernfix.perf_mod_warning"));
             });
         }
+        event.enqueueWork(ModernFix::runAuditIfRequested);
     }
 
     private void registerNetworkChannel(final RegisterPayloadHandlersEvent event) {