Fixed the AttachedEjector component causing crashes when attempting to be serialized due to null colors

Author: pupnewfster

src/api/java/mekanism/api/text/EnumColor.java

@@ -2,6 +2,7 @@
 
 import com.mojang.serialization.Codec;
 import io.netty.buffer.ByteBuf;
+import java.util.Optional;
 import java.util.function.IntFunction;
 import mekanism.api.IIncrementalEnum;
 import mekanism.api.SupportsColorMap;
@@ -61,6 +62,12 @@ public enum EnumColor implements IIncrementalEnum<EnumColor>, SupportsColorMap,
      * @since 10.6.0
      */
     public static final StreamCodec<ByteBuf, EnumColor> STREAM_CODEC = ByteBufCodecs.idMapper(BY_ID, EnumColor::ordinal);
+    /**
+     * Stream codec for syncing optional colors by index.
+     *
+     * @since 10.6.0
+     */
+    public static final StreamCodec<ByteBuf, Optional<EnumColor>> OPTIONAL_STREAM_CODEC = ByteBufCodecs.optional(STREAM_CODEC);
     /**
      * The color code that will be displayed
      */

src/main/java/mekanism/common/attachments/component/AttachedEjector.java

@@ -3,6 +3,7 @@
 import com.mojang.serialization.Codec;
 import com.mojang.serialization.codecs.RecordCodecBuilder;
 import io.netty.buffer.ByteBuf;
+import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
 import java.util.Optional;
@@ -12,22 +13,33 @@
 import mekanism.common.util.EnumUtils;
 import net.minecraft.network.codec.ByteBufCodecs;
 import net.minecraft.network.codec.StreamCodec;
+import net.minecraft.util.ExtraCodecs;
+import org.jetbrains.annotations.Nullable;
 
+//TODO - 1.20.5: Try to make the version be what is attached to things that support ejectors so that if nothing is set it doesn't end up in the component patch
 @NothingNullByDefault
-public record AttachedEjector(List<EnumColor> inputColors, boolean strictInput, Optional<EnumColor> outputColor) {
+public record AttachedEjector(List<Optional<EnumColor>> inputColors, boolean strictInput, Optional<EnumColor> outputColor) {
 
     public static final Codec<AttachedEjector> CODEC = RecordCodecBuilder.create(instance -> instance.group(
-          EnumColor.CODEC.listOf(EnumUtils.SIDES.length, EnumUtils.SIDES.length).fieldOf(NBTConstants.INPUT_COLOR).forGetter(AttachedEjector::inputColors),
+          ExtraCodecs.optionalEmptyMap(EnumColor.CODEC).listOf(EnumUtils.SIDES.length, EnumUtils.SIDES.length).fieldOf(NBTConstants.INPUT_COLOR).forGetter(AttachedEjector::inputColors),
           Codec.BOOL.fieldOf(NBTConstants.STRICT_INPUT).forGetter(AttachedEjector::strictInput),
           EnumColor.CODEC.optionalFieldOf(NBTConstants.QIO_META_TYPES).forGetter(AttachedEjector::outputColor)
     ).apply(instance, AttachedEjector::new));
     public static final StreamCodec<ByteBuf, AttachedEjector> STREAM_CODEC = StreamCodec.composite(
-          EnumColor.STREAM_CODEC.apply(ByteBufCodecs.list(EnumUtils.SIDES.length)), AttachedEjector::inputColors,
+          EnumColor.OPTIONAL_STREAM_CODEC.apply(ByteBufCodecs.list(EnumUtils.SIDES.length)), AttachedEjector::inputColors,
           ByteBufCodecs.BOOL, AttachedEjector::strictInput,
-          ByteBufCodecs.optional(EnumColor.STREAM_CODEC), AttachedEjector::outputColor,
+          EnumColor.OPTIONAL_STREAM_CODEC, AttachedEjector::outputColor,
           AttachedEjector::new
     );
 
+    public static AttachedEjector create(EnumColor[] inputColors, boolean strictInput, @Nullable EnumColor outputColor) {
+        List<Optional<EnumColor>> inputs = new ArrayList<>(inputColors.length);
+        for (EnumColor inputColor : inputColors) {
+            inputs.add(Optional.ofNullable(inputColor));
+        }
+        return new AttachedEjector(inputs, strictInput, Optional.ofNullable(outputColor));
+    }
+
     public AttachedEjector {
         if (inputColors.size() != EnumUtils.SIDES.length) {
             throw new IllegalArgumentException("Expected there to be an input color for each side");

src/main/java/mekanism/common/attachments/component/AttachedSideConfig.java

@@ -21,6 +21,7 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+//TODO - 1.20.5: Should we set the defaults for things via the default attached components so that then if it is equal to the default on break it doesn't get applied?
 @NothingNullByDefault
 public record AttachedSideConfig(Map<TransmissionType, LightConfigInfo> configInfo) {
 

src/main/java/mekanism/common/content/transporter/SorterFilter.java

@@ -44,7 +44,7 @@ protected static <FILTER extends SorterFilter<FILTER>> StreamCodec<ByteBuf, FILT
               ByteBufCodecs.BOOL, filter -> filter.sizeMode,
               ByteBufCodecs.VAR_INT, filter -> filter.min,
               ByteBufCodecs.VAR_INT, filter -> filter.max,
-              ByteBufCodecs.optional(EnumColor.STREAM_CODEC), filter -> Optional.ofNullable(filter.color),
+              EnumColor.OPTIONAL_STREAM_CODEC, filter -> Optional.ofNullable(filter.color),
               (filter, allowDefault, sizeMode, min, max, color) -> {
                   filter.allowDefault = allowDefault;
                   filter.color = color.orElse(null);

src/main/java/mekanism/common/content/transporter/TransporterStack.java

@@ -41,7 +41,7 @@ public class TransporterStack {
 
     //Make sure to call updateForPos before calling this method
     public static StreamCodec<RegistryFriendlyByteBuf, TransporterStack> STREAM_CODEC = NeoForgeStreamCodecs.composite(
-          ByteBufCodecs.optional(EnumColor.STREAM_CODEC), stack -> Optional.ofNullable(stack.color),
+          EnumColor.OPTIONAL_STREAM_CODEC, stack -> Optional.ofNullable(stack.color),
           ByteBufCodecs.VAR_INT, stack -> stack.progress,
           BlockPos.STREAM_CODEC, stack -> stack.originalLocation,
           Path.STREAM_CODEC, TransporterStack::getPathType,

src/main/java/mekanism/common/tile/component/TileComponentEjector.java

@@ -9,7 +9,6 @@
 import java.util.IdentityHashMap;
 import java.util.List;
 import java.util.Map;
-import java.util.Optional;
 import java.util.Set;
 import java.util.function.Consumer;
 import java.util.function.Function;
@@ -406,7 +405,7 @@ public void applyImplicitComponents(@NotNull BlockEntity.DataComponentInput inpu
         AttachedEjector ejector = input.get(MekanismDataComponents.EJECTOR);
         if (ejector != null) {
             for (int i = 0; i < inputColors.length; i++) {
-                inputColors[i] = ejector.inputColors().get(i);
+                inputColors[i] = ejector.inputColors().get(i).orElse(null);
             }
             strictInput = ejector.strictInput();
             outputColor = ejector.outputColor().orElse(null);
@@ -415,8 +414,7 @@ public void applyImplicitComponents(@NotNull BlockEntity.DataComponentInput inpu
 
     @Override
     public void collectImplicitComponents(DataComponentMap.Builder builder) {
-        //Note: We have to use Arrays#asList instead of List#of as our inputColors can contain null elements
-        builder.set(MekanismDataComponents.EJECTOR, new AttachedEjector(Arrays.asList(inputColors), strictInput, Optional.ofNullable(outputColor)));
+        builder.set(MekanismDataComponents.EJECTOR, AttachedEjector.create(inputColors, strictInput, outputColor));
     }
 
     @Override