Minestom/src/test/java/net/minestom/server/event/EventNodeTest.java

package net.minestom.server.event;

import net.minestom.server.entity.Entity;
import net.minestom.server.event.trait.CancellableEvent;
import net.minestom.server.event.trait.EntityEvent;
import net.minestom.server.event.trait.ItemEvent;
import net.minestom.server.event.trait.RecursiveEvent;
import net.minestom.server.item.ItemStack;
import net.minestom.server.item.Material;
import org.jetbrains.annotations.NotNull;
import org.junit.jupiter.api.Test;

import java.lang.ref.WeakReference;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicInteger;

import static net.minestom.testing.TestUtils.waitUntilCleared;
import static org.junit.jupiter.api.Assertions.*;

public class EventNodeTest {

    static class EventTest implements Event {
    }

    static class CancellableTest implements CancellableEvent {
        private boolean cancelled = false;

        @Override
        public boolean isCancelled() {
            return cancelled;
        }

        @Override
        public void setCancelled(boolean cancel) {
            this.cancelled = cancel;
        }
    }

    static class Recursive1 implements RecursiveEvent {
    }

    static class Recursive2 extends Recursive1 {
    }

    record ItemTestEvent(ItemStack item) implements ItemEvent {
        @Override
        public @NotNull ItemStack getItemStack() {
            return item;
        }
    }

    record EntityTestEvent(Entity entity) implements EntityEvent {
        @Override
        public @NotNull Entity getEntity() {
            return entity;
        }
    }

    @Test
    public void testCall() {
        var node = EventNode.all("main");
        AtomicBoolean result = new AtomicBoolean(false);
        var listener = EventListener.of(EventTest.class, eventTest -> result.set(true));
        node.addListener(listener);
        assertFalse(result.get(), "The event should not be called before the call");
        node.call(new EventTest());
        assertTrue(result.get(), "The event should be called after the call");

        // Test removal
        result.set(false);
        node.removeListener(listener);
        node.call(new EventTest());
        assertFalse(result.get(), "The event should not be called after the removal");
    }

    @Test
    public void testHandle() {
        var node = EventNode.all("main");
        var handle = node.getHandle(EventTest.class);
        assertSame(handle, node.getHandle(EventTest.class));

        var handle1 = node.getHandle(CancellableTest.class);
        assertSame(handle1, node.getHandle(CancellableTest.class));
    }

    @Test
    public void testCancellable() {
        var node = EventNode.all("main");
        AtomicBoolean result = new AtomicBoolean(false);
        var listener = EventListener.builder(CancellableTest.class)
                .handler(event -> {
                    event.setCancelled(true);
                    result.set(true);
                    assertTrue(event.isCancelled(), "The event should be cancelled");
                }).build();
        node.addListener(listener);
        node.call(new CancellableTest());
        assertTrue(result.get(), "The event should be called after the call");

        // Test cancelling
        node.addListener(CancellableTest.class, event -> fail("The event must have been cancelled"));
        node.call(new CancellableTest());
    }

    @Test
    public void recursiveSub() {
        var node = EventNode.all("main");
        AtomicBoolean result1 = new AtomicBoolean(false);
        AtomicBoolean result2 = new AtomicBoolean(false);
        var listener1 = EventListener.of(Recursive1.class, event -> result1.set(true));
        var listener2 = EventListener.of(Recursive2.class, event -> result2.set(true));
        node.addListener(listener1);
        node.addListener(listener2);
        node.call(new Recursive2());
        assertTrue(result2.get(), "Recursive2 should have been called directly");
        assertTrue(result1.get(), "Recursive1 should be called due to the RecursiveEvent interface");

        // Remove the direct listener
        result1.set(false);
        result2.set(false);
        node.removeListener(listener2);
        node.call(new Recursive2());
        assertFalse(result2.get(), "There is no listener for Recursive2");
        assertTrue(result1.get(), "Recursive1 should be called due to the RecursiveEvent interface");
    }

    // FIXME: nodes are currently unable to retrieve sub handles
    //@Test
    //public void recursiveSuper() {
    //    var node = EventNode.all("main");
    //    AtomicBoolean result2 = new AtomicBoolean(false);
    //    var listener2 = EventListener.of(Recursive2.class, event -> result2.set(true));
    //    node.addListener(listener2);
    //    node.call(new Recursive2());
    //    assertTrue(result2.get(), "The event should be called after the call");
    //
    //    AtomicBoolean result1 = new AtomicBoolean(false);
    //    var listener1 = EventListener.of(Recursive1.class, event -> result1.set(true));
    //    node.addListener(listener1);
    //    result2.set(false);
    //    node.call(new Recursive2());
    //    assertTrue(result2.get(), "Recursive2 should have been called directly");
    //    assertTrue(result1.get(), "Recursive1 should be called due to the RecursiveEvent interface");
    //}

    @Test
    public void testChildren() {
        var node = EventNode.all("main");
        AtomicInteger result = new AtomicInteger(0);
        var child1 = EventNode.all("child1").setPriority(1)
                .addListener(EventTest.class, eventTest -> {
                    assertEquals(0, result.get(), "child1 should be called before child2");
                    result.set(1);
                });
        var child2 = EventNode.all("child2").setPriority(2)
                .addListener(EventTest.class, eventTest -> {
                    assertEquals(1, result.get(), "child2 should be called after child1");
                    result.set(2);
                });
        node.addChild(child1);
        node.addChild(child2);
        assertEquals(node.getChildren().size(), 2, "The node should have 2 children");
        node.call(new EventTest());
        assertEquals(2, result.get(), "The event should be called after the call");

        // Test removal
        result.set(0);
        node.removeChild(child2);
        assertEquals(node.getChildren().size(), 1, "The node should have 1 child");
        node.call(new EventTest());
        assertEquals(1, result.get(), "child2 should has been removed");

        result.set(0);
        node.removeChild(child1);
        node.call(new EventTest());
        assertTrue(node.getChildren().isEmpty(), "The node should have no child left");
        assertEquals(0, result.get(), "The event should not be called after the removal");
    }

    @Test
    public void testFiltering() {
        AtomicBoolean result = new AtomicBoolean(false);
        AtomicBoolean childResult = new AtomicBoolean(false);

        var node = EventNode.type("item_node", EventFilter.ITEM,
                (event, item) -> item.material() == Material.DIAMOND);
        var child = EventNode.type("item_node2", EventFilter.ITEM)
                .addListener(ItemTestEvent.class, event -> childResult.set(true));
        node.addChild(child);

        var listener = EventListener.of(ItemTestEvent.class, event -> fail("The event should not be called"));
        node.addListener(listener);
        node.call(new ItemTestEvent(ItemStack.of(Material.GOLD_BLOCK)));
        assertFalse(childResult.get());

        node.removeListener(listener);
        listener = EventListener.of(ItemTestEvent.class, event -> result.set(true));
        node.addListener(listener);
        node.call(new ItemTestEvent(ItemStack.of(Material.DIAMOND)));
        assertTrue(result.get(), "The event should be called");
        assertTrue(childResult.get(), "The child event should be called");
    }

    @Test
    public void testBinding() {
        var node = EventNode.all("main");

        AtomicBoolean result = new AtomicBoolean(false);
        var binding = EventBinding.filtered(EventFilter.ITEM, itemStack -> itemStack.material() == Material.DIAMOND)
                .map(ItemTestEvent.class, (itemStack, itemTestEvent) -> result.set(true))
                .build();
        node.register(binding);
        node.call(new ItemTestEvent(ItemStack.of(Material.GOLD_BLOCK)));
        assertFalse(result.get());

        result.set(false);
        node.call(new ItemTestEvent(ItemStack.of(Material.DIAMOND)));
        assertTrue(result.get());

        result.set(false);
        node.unregister(binding);
        node.call(new ItemTestEvent(ItemStack.of(Material.DIAMOND)));
        assertFalse(result.get());
    }

    @Test
    public void nodeEmptyGC() {
        var node = EventNode.all("main");
        var ref = new WeakReference<>(node);

        //noinspection UnusedAssignment
        node = null;
        waitUntilCleared(ref);
    }

    @Test
    public void nodeGC() {
        var node = EventNode.all("main");
        var ref = new WeakReference<>(node);
        node.addListener(EventTest.class, event -> {
        });

        //noinspection UnusedAssignment
        node = null;
        waitUntilCleared(ref);
    }

    @Test
    public void nodeChildGC() {
        var node = EventNode.all("main");

        var child = EventNode.all("child");
        var ref = new WeakReference<>(child);
        child.addListener(EventTest.class, event -> {
        });
        node.addChild(child);

        //noinspection UnusedAssignment
        child = null;
        waitUntilCleared(ref);
    }

    @Test
    public void nodeMapGC() {
        var node = EventNode.all("main");

        var handler = ItemStack.AIR;
        var mapped = node.map(handler, EventFilter.ITEM);
        var ref = new WeakReference<>(mapped);
        mapped.addListener(ItemTestEvent.class, event -> {
        });

        //noinspection UnusedAssignment
        mapped = null;
        waitUntilCleared(ref);
    }
}