Compare commits

...
1 Commits
Author SHA1 Message Date
dmg 14fc0dbde0 feat(crafting): deliver saved sheets to fixed destinations
Release / release (push) Successful in 5m10s
CI / build (push) Successful in 3m15s
2026-09-17 23:30:27 -04:00
5 changed files with 321 additions and 5 deletions

No files matched your search

+8
View File
@@ -55,6 +55,14 @@ The `fantasystick:character_sheet` shapeless recipe definition contains one stic
This is **not a transaction commit**. Ten native planner/composition tests use actual 2×2/3×3 crafting containers, player storage, menu-carried stacks and recipe holders, with the absent player/network boundary stubbed. They do not execute packet dispatch or vanilla result consumption. A controller still needs one-use lifecycle tokens (a native menu may be reused after close/reopen), wiring of name/ID allocation and asynchronous persistence, reentrant matrix-update handling and delivery. Drop intent is not proof that a cancellable native drop succeeds. No recipe/listener registration, recovery policy or cross-save atomicity is added by this planner.
## Fixed-destination craft delivery (not registered)
`ManualCraftDelivery` can apply a validated plan and exact-sized saved batch to the cursor, selected hotbar/offhand slot or bulk storage destinations. It rechecks current contents before claiming delivery, constructs all sheets first, then debits fresh native input mirrors and places all outputs before triggering one matrix recomputation. This deliberately relies on the pinned Purpur 2618 mirror/count/setter behavior. No further adapter-planned writes occur after the prepare-callback boundary. Existing native setters may send packets; this is not packet-silent or exception/crash-atomic.
Nine native delivery tests cover normal/right-click, bulk and exact-slot delivery, partial ingredient metadata, empty first matrix cells, stale context refusal, mismatched/abandoned/reused batches, reentrancy, callback item changes, new-menu cursor safety and post-callback exceptions. The fixture uses actual containers/cursor stacks and intercepts `slotsChanged`; it does not execute a listening server's recipe manager or event dispatch. A mismatch refuses before consuming cleanup authority; an exception after claiming delivery conservatively retains records rather than replaying or rolling back.
The caller still must contain vanilla consumption, validate a one-use lifecycle/attempt token, schedule on the server thread, pass the player's actual current view and synchronize the appropriate client menu afterward. World-drop plans return `UNSUPPORTED_ROUTE` unchanged in this component; that is not a registered gameplay policy. No completed-craft listener or recipe is exposed yet.
## Native equipment adapter
`EquipmentStorage` preflights and moves nine hotbar/four armor slots into an actual named shulker in one free main-inventory slot. Item counts, metadata/damage/enchantments and legal nested contents remain native item data, accessible without this plugin. Eligibility is tested against the real vanilla shulker slot for every nonlegacy native item material; a main-inventory shulker does not prevent entry. Oversized or ineligible equipment and missing space produce unchanged refusals.
@@ -0,0 +1,39 @@
package games.dmg.fantasystick.crafting;
import games.dmg.fantasystick.items.CharacterSheets;
import games.dmg.fantasystick.persistence.CharacterStorage;
import org.bukkit.inventory.CraftingInventory;
import org.bukkit.inventory.InventoryView;
/**
* Fixed-destination adapter for the pinned Purpur runtime, not a listener or a portable transaction API.
* Call on the server thread after event containment/lifecycle authorization. Supply the player's actual
* current open view, never a retained event's view. Close/reopen generations remain the caller's duty.
* World drops are deliberately unsupported here. The caller synchronizes the client after completion.
*/
public final class ManualCraftDelivery {
public enum Result { DELIVERED, STALE, UNAVAILABLE, UNSUPPORTED_ROUTE }
private ManualCraftDelivery() { }
public static Result commit(ManualCraftPlan plan, CharacterStorage.CraftBatch batch, InventoryView current) {
if (plan.route() == ManualCraftPlan.Route.DROP) return Result.UNSUPPORTED_ROUTE;
if (!plan.matches(current)) return Result.STALE;
var records = batch.claimForDelivery(plan.quantity());
if (records.isEmpty()) return Result.UNAVAILABLE;
var sheets = new CharacterSheets();
var outputs = records.orElseThrow().stream().map(sheets::create).toList();
var grid = (CraftingInventory) current.getTopInventory();
var inputs = grid.getMatrix();
// Purpur 2618: these are native mirrors; count changes do not call slotsChanged.
for (var item : inputs) if (item != null && !item.isEmpty()) item.setAmount(item.getAmount() - plan.quantity());
if (plan.route() == ManualCraftPlan.Route.CURSOR) current.setCursor(outputs.getFirst());
else for (int index = 0; index < outputs.size(); index++) {
current.getBottomInventory().setItem(plan.inventorySlots().get(index), outputs.get(index));
}
// One adapter-triggered recomputation after ALL debits and placements, including exhausted cells.
// Do not make further planned inventory writes after this synchronous callback boundary.
grid.setItem(1, inputs[0]);
return Result.DELIVERED;
}
}
@@ -143,6 +143,12 @@ public final class CharacterStorage implements AutoCloseable {
this.records = created.stream().map(creation -> creation.record).toList();
}
/** Reject a wrong-sized batch before giving up its never-issued cleanup proof. */
public synchronized Optional<List<CharacterRecord>> claimForDelivery(int expectedQuantity) {
if (expectedQuantity < 1 || records.size() != expectedQuantity) return Optional.empty();
return claimForDelivery();
}
/** One-use handoff immediately before native delivery; an exception afterward cannot authorize deletion. */
public synchronized Optional<List<CharacterRecord>> claimForDelivery() {
if (resolved || owner.abandoned) return Optional.empty();
@@ -0,0 +1,261 @@
package games.dmg.fantasystick;
import static org.junit.jupiter.api.Assertions.*;
import games.dmg.fantasystick.crafting.CharacterFactory;
import games.dmg.fantasystick.crafting.ManualCraftDelivery;
import games.dmg.fantasystick.crafting.ManualCraftPlan;
import games.dmg.fantasystick.items.CharacterSheets;
import games.dmg.fantasystick.persistence.CharacterStorage;
import games.dmg.fantasystick.persistence.YamlCharacterRepository;
import games.dmg.fantasystick.progression.ProgressionRules;
import java.nio.file.Path;
import java.time.Clock;
import java.util.List;
import java.util.concurrent.atomic.AtomicInteger;
import org.bukkit.event.inventory.ClickType;
import org.bukkit.event.inventory.InventoryAction;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
class ManualCraftDeliveryNativeTest {
@Test
void shiftCraftPlacesDistinctSheetsInPlannedSlotsAndPreservesPartialInputMetadataAndCursor() throws Exception {
for (int width : new int[] {2, 3}) {
var fixture = new ManualCraftPlanNativeTest.Fixture(width, 4);
var inputs = fixture.grid.getMatrix();
var arranged = new org.bukkit.inventory.ItemStack[width * width];
for (int index = 0; index < 4; index++) {
var meta = inputs[index].getItemMeta();
meta.displayName(net.kyori.adventure.text.Component.text("Named ingredient"));
inputs[index].setItemMeta(meta);
arranged[width == 2 ? index : 8 - index * 2] = inputs[index];
}
fixture.grid.setMatrix(arranged);
for (int slot = 0; slot < 36; slot++) fixture.inventory.setItem(slot,
new org.bukkit.inventory.ItemStack(org.bukkit.Material.COBBLESTONE, 64));
fixture.inventory.setItem(8, null);
fixture.inventory.setItem(33, null);
fixture.view.setCursor(new org.bukkit.inventory.ItemStack(org.bukkit.Material.DIAMOND, 29));
var plan = ManualCraftPlan.capture(fixture.event(ClickType.SHIFT_LEFT,
InventoryAction.MOVE_TO_OTHER_INVENTORY)).orElseThrow();
assertEquals(List.of(8, 33), plan.inventorySlots());
var factory = new CharacterFactory();
var records = java.util.stream.IntStream.range(0, plan.quantity())
.mapToObj(index -> factory.create(ProgressionRules.defaults())).toList();
try (var storage = new CharacterStorage(new YamlCharacterRepository(data), Clock.systemUTC())) {
var batch = storage.prepareCraft(records).ready().join();
var changes = new AtomicInteger();
fixture.menu.onChange = () -> {
changes.incrementAndGet();
for (var item : fixture.grid.getMatrix()) if (item != null && !item.isEmpty()) {
assertEquals(2, item.getAmount());
assertEquals(net.kyori.adventure.text.Component.text("Named ingredient"), item.getItemMeta().displayName());
}
for (int index = 0; index < records.size(); index++) assertEquals(records.get(index).id(),
new CharacterSheets().identify(fixture.inventory.getItem(plan.inventorySlots().get(index))).orElseThrow());
};
assertEquals(ManualCraftDelivery.Result.DELIVERED, ManualCraftDelivery.commit(plan, batch, fixture.view));
assertEquals(1, changes.get());
assertFalse(fixture.inventory.getItem(8).isSimilar(fixture.inventory.getItem(33)));
assertEquals(64, fixture.inventory.getItem(12).getAmount());
assertEquals(org.bukkit.Material.COBBLESTONE, fixture.inventory.getItem(12).getType());
assertEquals(org.bukkit.Material.DIAMOND, fixture.view.getCursor().getType());
assertEquals(29, fixture.view.getCursor().getAmount());
}
}
}
@Test
void mismatchedSavedBatchDoesNotConsumeAnythingOrClaimDelivery() throws Exception {
for (int quantity : new int[] {1, 3}) {
var fixture = new ManualCraftPlanNativeTest.Fixture(2, 2);
var plan = ManualCraftPlan.capture(fixture.event(ClickType.SHIFT_LEFT,
InventoryAction.MOVE_TO_OTHER_INVENTORY)).orElseThrow();
var factory = new CharacterFactory();
var records = java.util.stream.IntStream.range(0, quantity)
.mapToObj(index -> factory.create(ProgressionRules.defaults())).toList();
try (var storage = new CharacterStorage(new YamlCharacterRepository(data), Clock.systemUTC())) {
var attempt = storage.prepareCraft(records);
var batch = attempt.ready().join();
assertEquals(ManualCraftDelivery.Result.UNAVAILABLE, ManualCraftDelivery.commit(plan, batch, fixture.view));
assertEquals(2, fixture.grid.getMatrix()[0].getAmount());
assertNull(fixture.inventory.getItem(8));
assertEquals(quantity, attempt.abandon().join().removed().size(),
"An invalid batch must remain provably unissued and cleanable");
}
}
}
@Test
void numberAndOffhandDeliveryChangeOnlyTheExactDestinationAndPreserveTheCursor() throws Exception {
for (int slot : new int[] {0, 8, 40}) {
var fixture = new ManualCraftPlanNativeTest.Fixture(3, 2);
fixture.view.setCursor(new org.bukkit.inventory.ItemStack(org.bukkit.Material.DIAMOND, 3));
var event = new org.bukkit.event.inventory.CraftItemEvent(new CharacterSheets().recipe(), fixture.view,
org.bukkit.event.inventory.InventoryType.SlotType.RESULT, 0,
slot == 40 ? ClickType.SWAP_OFFHAND : ClickType.NUMBER_KEY, InventoryAction.HOTBAR_SWAP,
slot == 40 ? -1 : slot);
var plan = ManualCraftPlan.capture(event).orElseThrow();
var record = new CharacterFactory().create(ProgressionRules.defaults());
try (var storage = new CharacterStorage(new YamlCharacterRepository(data), Clock.systemUTC())) {
var batch = storage.prepareCraft(List.of(record)).ready().join();
assertEquals(ManualCraftDelivery.Result.DELIVERED, ManualCraftDelivery.commit(plan, batch, fixture.view));
assertEquals(record.id(), new CharacterSheets().identify(fixture.inventory.getItem(slot)).orElseThrow());
assertEquals(1, fixture.grid.getMatrix()[0].getAmount());
assertEquals(org.bukkit.Material.DIAMOND, fixture.view.getCursor().getType());
assertEquals(3, fixture.view.getCursor().getAmount());
}
}
}
@Test
void staleInputsDestinationsRecipeCursorOrViewLeaveAllCurrentItemsAndCleanupProofUntouched() throws Exception {
for (int scenario = 0; scenario < 5; scenario++) {
var fixture = new ManualCraftPlanNativeTest.Fixture(2, 2);
var plan = ManualCraftPlan.capture(fixture.event(ClickType.SHIFT_LEFT,
InventoryAction.MOVE_TO_OTHER_INVENTORY)).orElseThrow();
var factory = new CharacterFactory();
var records = List.of(factory.create(ProgressionRules.defaults()), factory.create(ProgressionRules.defaults()));
try (var storage = new CharacterStorage(new YamlCharacterRepository(data), Clock.systemUTC())) {
var attempt = storage.prepareCraft(records);
var batch = attempt.ready().join();
if (scenario == 0) fixture.grid.getMatrix()[0].setAmount(7);
if (scenario == 1) fixture.inventory.setItem(8, new org.bukkit.inventory.ItemStack(org.bukkit.Material.DIAMOND));
if (scenario == 2) fixture.matrix.setCurrentRecipe(null);
if (scenario == 3) fixture.view.setCursor(new org.bukkit.inventory.ItemStack(org.bukkit.Material.GOLD_INGOT));
var current = scenario == 4 ? new ManualCraftPlanNativeTest.Fixture(2, 2).view : fixture.view;
var inputBefore = copy(fixture.grid.getMatrix());
var inventoryBefore = copy(fixture.inventory.getContents());
var cursorBefore = fixture.view.getCursor().clone();
fixture.menu.onChange = () -> fail("A refused craft must not recompute or mutate");
assertEquals(ManualCraftDelivery.Result.STALE, ManualCraftDelivery.commit(plan, batch, current));
assertArrayEquals(inputBefore, fixture.grid.getMatrix());
assertArrayEquals(inventoryBefore, fixture.inventory.getContents());
assertEquals(cursorBefore, fixture.view.getCursor());
assertEquals(2, attempt.abandon().join().removed().size());
}
}
}
@Test
void recomputationCanReenterAndChangeItemsWithoutASecondDeliveryOrLaterOverwrite() throws Exception {
var fixture = new ManualCraftPlanNativeTest.Fixture(2, 2);
var plan = ManualCraftPlan.capture(new org.bukkit.event.inventory.CraftItemEvent(new CharacterSheets().recipe(),
fixture.view, org.bukkit.event.inventory.InventoryType.SlotType.RESULT, 0, ClickType.NUMBER_KEY,
InventoryAction.HOTBAR_SWAP, 8)).orElseThrow();
var record = new CharacterFactory().create(ProgressionRules.defaults());
try (var storage = new CharacterStorage(new YamlCharacterRepository(data), Clock.systemUTC())) {
var attempt = storage.prepareCraft(List.of(record));
var batch = attempt.ready().join();
var changes = new AtomicInteger();
fixture.menu.onChange = () -> {
assertEquals(1, changes.incrementAndGet());
assertEquals(record.id(), new CharacterSheets().identify(fixture.inventory.getItem(8)).orElseThrow());
var repeat = ManualCraftPlan.capture(new org.bukkit.event.inventory.CraftItemEvent(new CharacterSheets().recipe(),
fixture.view, org.bukkit.event.inventory.InventoryType.SlotType.RESULT, 0, ClickType.NUMBER_KEY,
InventoryAction.HOTBAR_SWAP, 7)).orElseThrow();
assertEquals(ManualCraftDelivery.Result.UNAVAILABLE, ManualCraftDelivery.commit(repeat, batch, fixture.view));
assertNull(fixture.inventory.getItem(7));
// A post-commit listener owns these later changes; never rewrite a stored snapshot over them.
fixture.inventory.setItem(8, new org.bukkit.inventory.ItemStack(org.bukkit.Material.DIAMOND));
fixture.grid.getMatrix()[2].setAmount(22);
};
assertEquals(ManualCraftDelivery.Result.DELIVERED, ManualCraftDelivery.commit(plan, batch, fixture.view));
assertEquals(org.bukkit.Material.DIAMOND, fixture.inventory.getItem(8).getType());
assertEquals(22, fixture.grid.getMatrix()[2].getAmount());
assertEquals(1, changes.get());
assertEquals(java.util.Set.of(record.id()), attempt.abandon().join().retained());
}
}
@Test
void abandonedBatchAndUnsupportedWorldDropDoNotChangeInputsOrDestinations() throws Exception {
for (boolean drop : new boolean[] {false, true}) {
var fixture = new ManualCraftPlanNativeTest.Fixture(2, 1);
var plan = ManualCraftPlan.capture(fixture.event(drop ? ClickType.DROP : ClickType.LEFT,
drop ? InventoryAction.DROP_ONE_SLOT : InventoryAction.PICKUP_ALL)).orElseThrow();
var record = new CharacterFactory().create(ProgressionRules.defaults());
try (var storage = new CharacterStorage(new YamlCharacterRepository(data), Clock.systemUTC())) {
var attempt = storage.prepareCraft(List.of(record));
var batch = attempt.ready().join();
if (!drop) attempt.abandon();
assertEquals(drop ? ManualCraftDelivery.Result.UNSUPPORTED_ROUTE : ManualCraftDelivery.Result.UNAVAILABLE,
ManualCraftDelivery.commit(plan, batch, fixture.view));
assertEquals(1, fixture.grid.getMatrix()[0].getAmount());
assertTrue(fixture.view.getCursor().isEmpty());
assertEquals(java.util.Set.of(record.id()), attempt.abandon().join().removed());
}
}
}
@Test
void aMenuChangeDuringRecomputationDoesNotWriteIntoTheNewMenusCursor() throws Exception {
var fixture = new ManualCraftPlanNativeTest.Fixture(2, 1);
var plan = ManualCraftPlan.capture(fixture.event(ClickType.RIGHT, InventoryAction.PICKUP_HALF)).orElseThrow();
var record = new CharacterFactory().create(ProgressionRules.defaults());
try (var storage = new CharacterStorage(new YamlCharacterRepository(data), Clock.systemUTC())) {
var batch = storage.prepareCraft(List.of(record)).ready().join();
fixture.menu.onChange = () -> {
fixture.activeMenu = new ManualCraftPlanNativeTest.Menu();
fixture.view.setCursor(new org.bukkit.inventory.ItemStack(org.bukkit.Material.DIAMOND));
};
assertEquals(ManualCraftDelivery.Result.DELIVERED, ManualCraftDelivery.commit(plan, batch, fixture.view));
assertEquals(org.bukkit.Material.DIAMOND, fixture.view.getCursor().getType());
assertEquals(record.id(), new CharacterSheets().identify(
org.bukkit.craftbukkit.inventory.CraftItemStack.asCraftMirror(fixture.menu.getCarried())).orElseThrow());
}
}
@Test
void anExceptionAfterRecomputationBeginsNeverAuthorizesDeletionOrInventoryRollback() throws Exception {
var fixture = new ManualCraftPlanNativeTest.Fixture(2, 1);
var plan = ManualCraftPlan.capture(fixture.event(ClickType.LEFT, InventoryAction.PICKUP_ALL)).orElseThrow();
var record = new CharacterFactory().create(ProgressionRules.defaults());
try (var storage = new CharacterStorage(new YamlCharacterRepository(data), Clock.systemUTC())) {
var attempt = storage.prepareCraft(List.of(record));
var batch = attempt.ready().join();
fixture.menu.onChange = () -> { throw new IllegalStateException("Simulated post-commit callback failure"); };
assertThrows(IllegalStateException.class, () -> ManualCraftDelivery.commit(plan, batch, fixture.view));
assertEquals(record.id(), new CharacterSheets().identify(fixture.view.getCursor()).orElseThrow());
assertTrue(fixture.grid.getMatrix()[0] == null || fixture.grid.getMatrix()[0].isEmpty());
assertEquals(java.util.Set.of(record.id()), attempt.abandon().join().retained());
assertEquals(record, storage.find(record.id()).join().orElseThrow());
}
}
private static org.bukkit.inventory.ItemStack[] copy(org.bukkit.inventory.ItemStack[] items) {
return java.util.Arrays.stream(items).map(item -> item == null ? null : item.clone())
.toArray(org.bukkit.inventory.ItemStack[]::new);
}
@TempDir Path data;
@BeforeAll static void bootstrap() throws Exception { NativeRuntime.bootstrap(); }
@Test
void cursorCraftDebitsOneIngredientSetAndDeliversTheSavedSheetBeforeOneRecomputation() throws Exception {
for (int width : new int[] {2, 3}) {
var fixture = new ManualCraftPlanNativeTest.Fixture(width, 1);
var plan = ManualCraftPlan.capture(fixture.event(ClickType.LEFT, InventoryAction.PICKUP_ALL)).orElseThrow();
var character = new CharacterFactory().create(ProgressionRules.defaults());
try (var storage = new CharacterStorage(new YamlCharacterRepository(data), Clock.systemUTC())) {
var batch = storage.prepareCraft(List.of(character)).ready().join();
var changes = new AtomicInteger();
fixture.menu.onChange = () -> {
changes.incrementAndGet();
assertTrue(java.util.Arrays.stream(fixture.grid.getMatrix()).allMatch(item -> item == null || item.isEmpty()),
"A prepare callback must not observe a partially debited ingredient set");
assertEquals(character.id(), new CharacterSheets().identify(fixture.view.getCursor()).orElseThrow(),
"The final output must exist before recomputation callbacks run");
};
assertEquals(ManualCraftDelivery.Result.DELIVERED, ManualCraftDelivery.commit(plan, batch, fixture.view));
assertEquals(1, changes.get());
assertEquals(character.id(), new CharacterSheets().identify(fixture.view.getCursor()).orElseThrow());
assertEquals(character, storage.find(character.id()).join().orElseThrow());
assertNotEquals(ManualCraftDelivery.Result.DELIVERED, ManualCraftDelivery.commit(plan, batch, fixture.view));
assertEquals(1, changes.get(), "Duplicate completion must not debit or notify again");
}
}
}
}
@@ -261,8 +261,9 @@ class ManualCraftPlanNativeTest {
}
}
private static final class Fixture {
static final class Fixture {
final Menu menu = new Menu();
Menu activeMenu = menu;
final TransientCraftingContainer matrix;
final CraftInventoryCrafting grid;
final CraftInventoryPlayer inventory = new CraftInventoryPlayer(
@@ -281,8 +282,8 @@ class ManualCraftPlanNativeTest {
@Override public CraftInventoryPlayer getBottomInventory() { return inventory; }
@Override public HumanEntity getPlayer() { throw new AssertionError("Unexpected player/network access"); }
@Override public InventoryType getType() { return grid.getType(); }
@Override public ItemStack getCursor() { return CraftItemStack.asCraftMirror(menu.getCarried()); }
@Override public void setCursor(ItemStack item) { menu.setCarried(CraftItemStack.asNMSCopy(item)); }
@Override public ItemStack getCursor() { return CraftItemStack.asCraftMirror(activeMenu.getCarried()); }
@Override public void setCursor(ItemStack item) { activeMenu.setCarried(CraftItemStack.asNMSCopy(item)); }
@Override public String getTitle() { return "Crafting fixture"; }
@Override public String getOriginalTitle() { return getTitle(); }
@Override public void setTitle(String title) { throw new AssertionError("Unexpected title change"); }
@@ -314,14 +315,15 @@ class ManualCraftPlanNativeTest {
}
}
private static final class Menu extends AbstractContainerMenu {
static final class Menu extends AbstractContainerMenu {
InventoryView view;
Runnable onChange = () -> { };
Menu() { super(null, 0); }
@Override public InventoryView getBukkitView() { return view; }
@Override public boolean stillValid(net.minecraft.world.entity.player.Player player) { return true; }
@Override public net.minecraft.world.item.ItemStack quickMoveStack(net.minecraft.world.entity.player.Player player, int slot) {
throw new AssertionError("This fixture does not execute vanilla result consumption");
}
@Override public void slotsChanged(net.minecraft.world.Container inventory) { }
@Override public void slotsChanged(net.minecraft.world.Container inventory) { onChange.run(); }
}
}