Fix jukebox state getting changed mid-transaction (#3693)

* fix jukebox state getting changed mid-transaction (#3517)

* fix mixin

---------

Co-authored-by: deirn <deirn@bai.lol>
This commit is contained in:
Syst3ms 2024-04-09 18:58:07 +02:00 committed by GitHub
parent 1098aed821
commit 8dd72ea3fa
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 82 additions and 0 deletions

View file

@ -0,0 +1,61 @@
/*
* Copyright (c) 2016, 2017, 2018, 2019 FabricMC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.fabricmc.fabric.mixin.transfer;
import org.spongepowered.asm.mixin.Final;
import org.spongepowered.asm.mixin.Mixin;
import org.spongepowered.asm.mixin.Shadow;
import org.spongepowered.asm.mixin.Unique;
import org.spongepowered.asm.mixin.injection.At;
import org.spongepowered.asm.mixin.injection.Inject;
import org.spongepowered.asm.mixin.injection.callback.CallbackInfo;
import net.minecraft.block.entity.JukeboxBlockEntity;
import net.minecraft.inventory.SingleStackInventory;
import net.minecraft.item.ItemStack;
import net.minecraft.util.collection.DefaultedList;
import net.fabricmc.fabric.impl.transfer.item.SpecialLogicInventory;
@Mixin(JukeboxBlockEntity.class)
abstract class JukeboxBlockEntityMixin implements SpecialLogicInventory, SingleStackInventory {
@Shadow
@Final
private DefaultedList<ItemStack> inventory;
@Unique
private boolean fabric_suppressSpecialLogic = false;
@Override
public void fabric_setSuppress(boolean suppress) {
fabric_suppressSpecialLogic = suppress;
}
@Inject(method = "setStack", at = @At("HEAD"), cancellable = true)
private void setStackBypass(int slot, ItemStack stack, CallbackInfo ci) {
if (fabric_suppressSpecialLogic) {
inventory.set(0, stack);
ci.cancel();
}
}
@Override
public void fabric_onFinalCommit(int slot, ItemStack oldStack, ItemStack newStack) {
// Call setStack again without suppressing vanilla logic,
// where now the record will actually getting played/stopped.
setStack(newStack);
}
}

View file

@ -12,6 +12,7 @@
"FluidMixin",
"HopperBlockEntityMixin",
"ItemMixin",
"JukeboxBlockEntityMixin",
"LootableContainerBlockEntityMixin",
"SimpleInventoryMixin"
]

View file

@ -23,6 +23,7 @@ import net.minecraft.block.BlockState;
import net.minecraft.block.Blocks;
import net.minecraft.block.ComparatorBlock;
import net.minecraft.block.ComposterBlock;
import net.minecraft.block.JukeboxBlock;
import net.minecraft.block.entity.BrewingStandBlockEntity;
import net.minecraft.block.entity.ChiseledBookshelfBlockEntity;
import net.minecraft.block.entity.FurnaceBlockEntity;
@ -356,4 +357,23 @@ public class VanillaStorageTests {
context.complete();
}
/**
* Regression test for <a href="https://github.com/FabricMC/fabric/issues/3485">jukeboxes having their state changed mid-transaction</a>.
*/
@GameTest(templateName = FabricGameTest.EMPTY_STRUCTURE)
public void testJukeboxState(TestContext context) {
BlockPos pos = new BlockPos(2, 2, 2);
context.setBlockState(pos, Blocks.JUKEBOX.getDefaultState());
Storage<ItemVariant> storage = ItemStorage.SIDED.find(context.getWorld(), context.getAbsolutePos(pos), Direction.UP);
try (Transaction tx = Transaction.openOuter()) {
storage.insert(ItemVariant.of(Items.MUSIC_DISC_11), 1, tx);
context.checkBlockState(pos, state -> !state.get(JukeboxBlock.HAS_RECORD), () -> "Jukebox should not have its state changed mid-transaction");
tx.commit();
}
context.checkBlockState(pos, state -> state.get(JukeboxBlock.HAS_RECORD), () -> "Jukebox should have its state changed");
context.complete();
}
}