fix: loading order issues on fabric

refinedmods · Jun 20, 2024 · f87e91d · f87e91d
1 parent b30f9cf
commit f87e91d
Show file tree

Hide file tree

Showing 14 changed files with 76 additions and 69 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,10 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+### Fixed
+
+-   Potential loading order issues on Fabric.
+
 ## [0.2.1] - 2024-06-16
 
 ### Fixed

diff --git a/config/checkstyle/checkstyle-suppressions.xml b/config/checkstyle/checkstyle-suppressions.xml
@@ -5,4 +5,5 @@
 <suppressions>
     <!-- Test directories don't need a package-info.java file -->
     <suppress checks="JavadocPackage" files="test[\\/].*.java"/>
+    <suppress checks="HideUtilityClassConstructor" files="ModInitializer.java"/>
 </suppressions>
diff --git a/refinedstorage-jei-integration-common/build.gradle b/refinedstorage-jei-integration-common/build.gradle
@@ -23,6 +23,7 @@ commonProject()
 dependencies {
     api "com.refinedmods.refinedstorage2:refinedstorage2-platform-common:${refinedstorageVersion}"
     api "mezz.jei:jei-${minecraftVersion}-common-api:${jeiVersion}"
+    api "mezz.jei:jei-${minecraftVersion}-common:${jeiVersion}"
 }
 
 enablePublishing()
diff --git a/...ei-integration-common/src/main/java/com/refinedmods/refinedstorage/jei/common/Common.java b/...ei-integration-common/src/main/java/com/refinedmods/refinedstorage/jei/common/Common.java
@@ -1,5 +1,8 @@
 package com.refinedmods.refinedstorage.jei.common;
 
+import com.refinedmods.refinedstorage2.platform.api.PlatformApi;
+import net.minecraft.resources.ResourceLocation;
+
 import static java.util.Objects.requireNonNull;
 
 public final class Common {
@@ -17,4 +20,16 @@ public static void setPlatform(final Platform platform) {
     public static Platform getPlatform() {
         return requireNonNull(platform, "Platform isn't set yet");
     }
+
+    public static void init(final PlatformApi platformApi) {
+        platformApi.addIngredientConverter(new JeiRecipeModIngredientConverter());
+        platformApi.getGridSynchronizerRegistry().register(
+            new ResourceLocation(Common.MOD_ID, "jei"),
+            new JeiGridSynchronizer(false)
+        );
+        platformApi.getGridSynchronizerRegistry().register(
+            new ResourceLocation(Common.MOD_ID, "jei_two_way"),
+            new JeiGridSynchronizer(true)
+        );
+    }
 }
diff --git a/...ommon/src/main/java/com/refinedmods/refinedstorage/jei/common/GhostIngredientHandler.java b/...ommon/src/main/java/com/refinedmods/refinedstorage/jei/common/GhostIngredientHandler.java
@@ -4,8 +4,8 @@
 import java.util.Collections;
 import java.util.List;
 
+import com.refinedmods.refinedstorage2.platform.api.PlatformApi;
 import com.refinedmods.refinedstorage2.platform.api.support.resource.PlatformResourceKey;
-import com.refinedmods.refinedstorage2.platform.api.support.resource.RecipeModIngredientConverter;
 import com.refinedmods.refinedstorage2.platform.common.Platform;
 import com.refinedmods.refinedstorage2.platform.common.support.AbstractBaseScreen;
 import com.refinedmods.refinedstorage2.platform.common.support.containermenu.AbstractResourceContainerMenu;
@@ -16,12 +16,6 @@
 
 @SuppressWarnings("rawtypes")
 class GhostIngredientHandler implements IGhostIngredientHandler<AbstractBaseScreen> {
-    private final RecipeModIngredientConverter ingredientConverter;
-
-    GhostIngredientHandler(final RecipeModIngredientConverter ingredientConverter) {
-        this.ingredientConverter = ingredientConverter;
-    }
-
     @Override
     public <I> List<Target<I>> getTargetsTyped(final AbstractBaseScreen screen,
                                                final ITypedIngredient<I> ingredient,
@@ -36,7 +30,7 @@ private <I> List<Target<I>> getTargets(final AbstractBaseScreen screen,
                                            final I ingredient,
                                            final AbstractResourceContainerMenu menu) {
         final List<Target<I>> targets = new ArrayList<>();
-        ingredientConverter.convertToResource(ingredient).ifPresent(resource -> {
+        PlatformApi.INSTANCE.getIngredientConverter().convertToResource(ingredient).ifPresent(resource -> {
             for (final ResourceSlot slot : menu.getResourceSlots()) {
                 if (slot.isFilter() && slot.isValid(resource)) {
                     final Rect2i bounds = getBounds(screen, slot);
@@ -72,7 +66,7 @@ public Rect2i getArea() {
 
         @Override
         public void accept(final I ingredient) {
-            ingredientConverter.convertToResource(ingredient).ifPresent(this::accept);
+            PlatformApi.INSTANCE.getIngredientConverter().convertToResource(ingredient).ifPresent(this::accept);
         }
 
         private void accept(final PlatformResourceKey resource) {

diff --git a/...mmon/src/main/java/com/refinedmods/refinedstorage/jei/common/GridGuiContainerHandler.java b/...mmon/src/main/java/com/refinedmods/refinedstorage/jei/common/GridGuiContainerHandler.java
@@ -2,9 +2,9 @@
 
 import java.util.Optional;
 
+import com.refinedmods.refinedstorage2.platform.api.PlatformApi;
 import com.refinedmods.refinedstorage2.platform.api.grid.view.PlatformGridResource;
 import com.refinedmods.refinedstorage2.platform.api.support.resource.PlatformResourceKey;
-import com.refinedmods.refinedstorage2.platform.api.support.resource.RecipeModIngredientConverter;
 import com.refinedmods.refinedstorage2.platform.common.grid.screen.AbstractGridScreen;
 import mezz.jei.api.gui.handlers.IGuiContainerHandler;
 import mezz.jei.api.ingredients.IIngredientHelper;
@@ -13,11 +13,9 @@
 import mezz.jei.api.runtime.IIngredientManager;
 
 class GridGuiContainerHandler implements IGuiContainerHandler<AbstractGridScreen<?>> {
-    private final RecipeModIngredientConverter converter;
     private final IIngredientManager ingredientManager;
 
-    GridGuiContainerHandler(final RecipeModIngredientConverter converter, final IIngredientManager ingredientManager) {
-        this.converter = converter;
+    GridGuiContainerHandler(final IIngredientManager ingredientManager) {
         this.ingredientManager = ingredientManager;
     }
 
@@ -35,7 +33,7 @@ public Optional<IClickableIngredient<?>> getClickableIngredientUnderMouse(
         if (underlyingResource == null) {
             return Optional.empty();
         }
-        return converter.convertToIngredient(underlyingResource).flatMap(
+        return PlatformApi.INSTANCE.getIngredientConverter().convertToIngredient(underlyingResource).flatMap(
             ingredient -> convertToClickableIngredient(mouseX, mouseY, ingredient)
         );
     }

diff --git a/...n-common/src/main/java/com/refinedmods/refinedstorage/jei/common/JeiGridSynchronizer.java b/...n-common/src/main/java/com/refinedmods/refinedstorage/jei/common/JeiGridSynchronizer.java
@@ -18,11 +18,9 @@ class JeiGridSynchronizer extends AbstractGridSynchronizer {
         "gui.%s.grid.synchronizer.two_way.help".formatted(MOD_ID)
     );
 
-    private final JeiProxy jeiProxy;
     private final boolean twoWay;
 
-    JeiGridSynchronizer(final JeiProxy jeiProxy, final boolean twoWay) {
-        this.jeiProxy = jeiProxy;
+    JeiGridSynchronizer(final boolean twoWay) {
         this.twoWay = twoWay;
     }
 
@@ -38,13 +36,13 @@ public Component getHelpText() {
 
     @Override
     public void synchronizeFromGrid(final String text) {
-        jeiProxy.setSearchFieldText(text);
+        JeiHelper.setSearchFieldText(text);
     }
 
     @Override
     @Nullable
     public String getTextToSynchronizeToGrid() {
-        return twoWay ? jeiProxy.getSearchFieldText() : null;
+        return twoWay ? JeiHelper.getSearchFieldText() : null;
     }
 
     @Override

diff --git a/...s/refinedstorage/jei/common/JeiProxy.java → .../refinedstorage/jei/common/JeiHelper.java b/...s/refinedstorage/jei/common/JeiProxy.java → .../refinedstorage/jei/common/JeiHelper.java
@@ -2,16 +2,19 @@
 
 import mezz.jei.api.runtime.IJeiRuntime;
 
-public class JeiProxy {
-    public String getSearchFieldText() {
+public final class JeiHelper {
+    private JeiHelper() {
+    }
+
+    public static String getSearchFieldText() {
         final IJeiRuntime runtime = RefinedStorageModPlugin.getRuntime();
         if (runtime == null) {
             return "";
         }
         return runtime.getIngredientFilter().getFilterText();
     }
 
-    public void setSearchFieldText(final String text) {
+    public static void setSearchFieldText(final String text) {
         final IJeiRuntime runtime = RefinedStorageModPlugin.getRuntime();
         if (runtime != null) {
             runtime.getIngredientFilter().setFilterText(text);

diff --git a/.../main/java/com/refinedmods/refinedstorage/jei/common/JeiRecipeModIngredientConverter.java b/.../main/java/com/refinedmods/refinedstorage/jei/common/JeiRecipeModIngredientConverter.java
@@ -7,15 +7,10 @@
 import com.refinedmods.refinedstorage2.platform.common.support.resource.FluidResource;
 import com.refinedmods.refinedstorage2.platform.common.support.resource.ItemResource;
 import mezz.jei.api.helpers.IPlatformFluidHelper;
+import mezz.jei.common.platform.Services;
 import net.minecraft.world.item.ItemStack;
 
 class JeiRecipeModIngredientConverter implements RecipeModIngredientConverter {
-    private final IPlatformFluidHelper<?> fluidHelper;
-
-    JeiRecipeModIngredientConverter(final IPlatformFluidHelper<?> fluidHelper) {
-        this.fluidHelper = fluidHelper;
-    }
-
     @Override
     public Optional<PlatformResourceKey> convertToResource(final Object ingredient) {
         final var fluid = Common.getPlatform().convertJeiIngredientToFluid(ingredient);
@@ -34,6 +29,7 @@ public Optional<Object> convertToIngredient(final PlatformResourceKey resource)
             return Optional.of(itemResource.toItemStack());
         }
         if (resource instanceof FluidResource fluidResource) {
+            final IPlatformFluidHelper<?> fluidHelper = Services.PLATFORM.getFluidHelper();
             return Optional.of(fluidHelper.create(
                 fluidResource.fluid(),
                 fluidHelper.bucketVolume(),

diff --git a/...mmon/src/main/java/com/refinedmods/refinedstorage/jei/common/RefinedStorageModPlugin.java b/...mmon/src/main/java/com/refinedmods/refinedstorage/jei/common/RefinedStorageModPlugin.java
@@ -2,25 +2,19 @@
 
 import javax.annotation.Nullable;
 
-import com.refinedmods.refinedstorage2.platform.api.PlatformApi;
-import com.refinedmods.refinedstorage2.platform.api.support.resource.RecipeModIngredientConverter;
 import com.refinedmods.refinedstorage2.platform.common.grid.screen.AbstractGridScreen;
 import com.refinedmods.refinedstorage2.platform.common.support.AbstractBaseScreen;
 import mezz.jei.api.IModPlugin;
 import mezz.jei.api.JeiPlugin;
 import mezz.jei.api.constants.RecipeTypes;
-import mezz.jei.api.helpers.IPlatformFluidHelper;
 import mezz.jei.api.registration.IGuiHandlerRegistration;
 import mezz.jei.api.registration.IRecipeTransferRegistration;
 import mezz.jei.api.runtime.IJeiRuntime;
 import net.minecraft.resources.ResourceLocation;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 @JeiPlugin
 public class RefinedStorageModPlugin implements IModPlugin {
     private static final ResourceLocation ID = new ResourceLocation(Common.MOD_ID, "plugin");
-    private static final Logger LOGGER = LoggerFactory.getLogger(RefinedStorageModPlugin.class);
     @Nullable
     private static IJeiRuntime runtime;
 
@@ -36,54 +30,33 @@ public void registerRecipeTransferHandlers(final IRecipeTransferRegistration reg
 
     @Override
     public void onRuntimeAvailable(final IJeiRuntime newRuntime) {
-        if (runtime == null) {
-            initializePlatform(newRuntime.getJeiHelpers().getPlatformFluidHelper());
-        }
         RefinedStorageModPlugin.runtime = newRuntime;
     }
 
+    @Override
+    public void onRuntimeUnavailable() {
+        RefinedStorageModPlugin.runtime = null;
+    }
+
     @Override
     public void registerGuiHandlers(final IGuiHandlerRegistration registration) {
-        final RecipeModIngredientConverter converter = PlatformApi.INSTANCE.getIngredientConverter();
         registration.addGenericGuiContainerHandler(
             AbstractBaseScreen.class,
-            new ResourceGuiContainerHandler(converter, registration.getJeiHelpers().getIngredientManager())
+            new ResourceGuiContainerHandler(registration.getJeiHelpers().getIngredientManager())
         );
         registration.addGenericGuiContainerHandler(
             AbstractGridScreen.class,
-            new GridGuiContainerHandler(converter, registration.getJeiHelpers().getIngredientManager())
+            new GridGuiContainerHandler(registration.getJeiHelpers().getIngredientManager())
         );
         registration.addGenericGuiContainerHandler(
             AbstractBaseScreen.class,
             new ExclusionZonesGuiContainerHandler()
         );
-        registration.addGhostIngredientHandler(AbstractBaseScreen.class, new GhostIngredientHandler(converter));
+        registration.addGhostIngredientHandler(AbstractBaseScreen.class, new GhostIngredientHandler());
     }
 
     @Nullable
     public static IJeiRuntime getRuntime() {
         return runtime;
     }
-
-    private void initializePlatform(final IPlatformFluidHelper<?> fluidHelper) {
-        LOGGER.debug("Enabling JEI integration");
-        registerIngredientConverters(fluidHelper);
-        registerGridSynchronizers();
-    }
-
-    private void registerGridSynchronizers() {
-        final JeiProxy jeiProxy = new JeiProxy();
-        PlatformApi.INSTANCE.getGridSynchronizerRegistry().register(
-            new ResourceLocation(Common.MOD_ID, "jei"),
-            new JeiGridSynchronizer(jeiProxy, false)
-        );
-        PlatformApi.INSTANCE.getGridSynchronizerRegistry().register(
-            new ResourceLocation(Common.MOD_ID, "jei_two_way"),
-            new JeiGridSynchronizer(jeiProxy, true)
-        );
-    }
-
-    private void registerIngredientConverters(final IPlatformFluidHelper<?> fluidHelper) {
-        PlatformApi.INSTANCE.addIngredientConverter(new JeiRecipeModIngredientConverter(fluidHelper));
-    }
 }
diff --git a/.../src/main/java/com/refinedmods/refinedstorage/jei/common/ResourceGuiContainerHandler.java b/.../src/main/java/com/refinedmods/refinedstorage/jei/common/ResourceGuiContainerHandler.java
@@ -3,8 +3,8 @@
 import java.util.Optional;
 import javax.annotation.Nullable;
 
+import com.refinedmods.refinedstorage2.platform.api.PlatformApi;
 import com.refinedmods.refinedstorage2.platform.api.support.resource.PlatformResourceKey;
-import com.refinedmods.refinedstorage2.platform.api.support.resource.RecipeModIngredientConverter;
 import com.refinedmods.refinedstorage2.platform.common.support.AbstractBaseScreen;
 import mezz.jei.api.gui.handlers.IGuiContainerHandler;
 import mezz.jei.api.ingredients.IIngredientHelper;
@@ -13,12 +13,9 @@
 import mezz.jei.api.runtime.IIngredientManager;
 
 class ResourceGuiContainerHandler implements IGuiContainerHandler<AbstractBaseScreen<?>> {
-    private final RecipeModIngredientConverter converter;
     private final IIngredientManager ingredientManager;
 
-    ResourceGuiContainerHandler(final RecipeModIngredientConverter converter,
-                                final IIngredientManager ingredientManager) {
-        this.converter = converter;
+    ResourceGuiContainerHandler(final IIngredientManager ingredientManager) {
         this.ingredientManager = ingredientManager;
     }
 
@@ -35,7 +32,7 @@ public Optional<Object> convertToIngredient(@Nullable final PlatformResourceKey
         if (resource == null) {
             return Optional.empty();
         }
-        return converter.convertToIngredient(resource);
+        return PlatformApi.INSTANCE.getIngredientConverter().convertToIngredient(resource);
     }
 
     private Optional<IClickableIngredient<?>> convertToClickableIngredient(final Object ingredient) {

diff --git a/...bric/src/main/java/com/refinedmods/refinedstorage/jei/fabric/JeiRefinedStoragePlugin.java b/...bric/src/main/java/com/refinedmods/refinedstorage/jei/fabric/JeiRefinedStoragePlugin.java
@@ -0,0 +1,13 @@
+package com.refinedmods.refinedstorage.jei.fabric;
+
+import com.refinedmods.refinedstorage2.platform.api.PlatformApi;
+import com.refinedmods.refinedstorage2.platform.api.RefinedStoragePlugin;
+
+import static com.refinedmods.refinedstorage.jei.common.Common.init;
+
+public class JeiRefinedStoragePlugin implements RefinedStoragePlugin {
+    @Override
+    public void onPlatformApiAvailable(final PlatformApi platformApi) {
+        init(platformApi);
+    }
+}
diff --git a/refinedstorage-jei-integration-fabric/src/main/resources/fabric.mod.json b/refinedstorage-jei-integration-fabric/src/main/resources/fabric.mod.json
@@ -19,6 +19,9 @@
     ],
     "jei_mod_plugin": [
       "com.refinedmods.refinedstorage.jei.common.RefinedStorageModPlugin"
+    ],
+    "refinedstorage_plugin": [
+      "com.refinedmods.refinedstorage.jei.fabric.JeiRefinedStoragePlugin"
     ]
   },
   "custom": {

diff --git a/...egration-forge/src/main/java/com/refinedmods/refinedstorage/jei/forge/ModInitializer.java b/...egration-forge/src/main/java/com/refinedmods/refinedstorage/jei/forge/ModInitializer.java
@@ -2,12 +2,23 @@
 
 import com.refinedmods.refinedstorage.jei.common.Common;
 
+import com.refinedmods.refinedstorage2.platform.api.PlatformApi;
 import net.neoforged.bus.api.IEventBus;
+import net.neoforged.bus.api.SubscribeEvent;
 import net.neoforged.fml.common.Mod;
+import net.neoforged.fml.event.lifecycle.FMLCommonSetupEvent;
+
+import static com.refinedmods.refinedstorage.jei.common.Common.init;
 
 @Mod(Common.MOD_ID)
 public class ModInitializer {
     public ModInitializer(final IEventBus eventBus) {
         Common.setPlatform(new ForgePlatform());
+        eventBus.addListener(ModInitializer::onCommonSetup);
+    }
+
+    @SubscribeEvent
+    public static void onCommonSetup(final FMLCommonSetupEvent e) {
+        init(PlatformApi.INSTANCE);
     }
 }