[#34] Better Notification System

demo/src/main/java/net/minestom/demo/PlayerInit.java

@@ -3,8 +3,6 @@
 import net.kyori.adventure.text.Component;
 import net.minestom.server.MinecraftServer;
 import net.minestom.server.advancements.FrameType;
-import net.minestom.server.advancements.notifications.Notification;
-import net.minestom.server.advancements.notifications.NotificationCenter;
 import net.minestom.server.adventure.MinestomAdventure;
 import net.minestom.server.adventure.audience.Audiences;
 import net.minestom.server.coordinate.Pos;
@@ -19,7 +17,15 @@
 import net.minestom.server.event.entity.EntityAttackEvent;
 import net.minestom.server.event.item.ItemDropEvent;
 import net.minestom.server.event.item.PickupItemEvent;
-import net.minestom.server.event.player.*;
+import net.minestom.server.event.player.AsyncPlayerConfigurationEvent;
+import net.minestom.server.event.player.PlayerBlockInteractEvent;
+import net.minestom.server.event.player.PlayerBlockPlaceEvent;
+import net.minestom.server.event.player.PlayerDeathEvent;
+import net.minestom.server.event.player.PlayerDisconnectEvent;
+import net.minestom.server.event.player.PlayerPacketEvent;
+import net.minestom.server.event.player.PlayerPacketOutEvent;
+import net.minestom.server.event.player.PlayerSpawnEvent;
+import net.minestom.server.event.player.PlayerUseItemOnBlockEvent;
 import net.minestom.server.event.server.ServerTickMonitorEvent;
 import net.minestom.server.instance.Instance;
 import net.minestom.server.instance.InstanceContainer;
@@ -33,6 +39,7 @@
 import net.minestom.server.item.metadata.BundleMeta;
 import net.minestom.server.monitoring.BenchmarkManager;
 import net.minestom.server.monitoring.TickMonitor;
+import net.minestom.server.notifications.Notification;
 import net.minestom.server.utils.MathUtils;
 import net.minestom.server.utils.time.TimeUnit;
 import net.minestom.server.world.DimensionType;
@@ -115,12 +122,11 @@ public class PlayerInit {
                 player.getInventory().addItemStack(bundle);
 
                 if (event.isFirstSpawn()) {
-                    Notification notification = new Notification(
-                            Component.text("Welcome!"),
-                            FrameType.TASK,
-                            Material.IRON_SWORD
-                    );
-                    NotificationCenter.send(notification, event.getPlayer());
+                    Notification notification = Notification.builder()
+                            .frameType(FrameType.TASK)
+                            .title(Component.text("Welcome!"))
+                            .icon(Material.IRON_SWORD).build();
+                    notification.send(player);
                 }
             })
             .addListener(PlayerPacketOutEvent.class, event -> {

demo/src/main/java/net/minestom/demo/commands/NotificationCommand.java

@@ -2,22 +2,22 @@
 
 import net.kyori.adventure.text.Component;
 import net.minestom.server.advancements.FrameType;
-import net.minestom.server.advancements.notifications.Notification;
-import net.minestom.server.advancements.notifications.NotificationCenter;
 import net.minestom.server.command.builder.Command;
 import net.minestom.server.entity.Player;
 import net.minestom.server.item.Material;
-import org.jetbrains.annotations.NotNull;
 
 public class NotificationCommand extends Command {
     public NotificationCommand() {
         super("notification");
 
         setDefaultExecutor((sender, context) -> {
             var player = (Player) sender;
-
-            var notification = new Notification(Component.text("Hello World!"), FrameType.GOAL, Material.DIAMOND_AXE);
-            NotificationCenter.send(notification, player);
+            var notification = net.minestom.server.notifications.Notification.builder()
+                    .title(Component.text("Hello World!"))
+                    .frameType(FrameType.GOAL)
+                    .icon(Material.DIAMOND_AXE)
+                    .build();
+            notification.send(player);
         });
     }
 }

src/main/java/net/minestom/server/advancements/AdvancementTab.java

@@ -155,10 +155,8 @@ private void addPlayer(@NotNull Player player) {
      */
     private void removePlayer(@NotNull Player player) {
         final UUID uuid = player.getUuid();
-        if (!PLAYER_TAB_MAP.containsKey(uuid)) {
-            return;
-        }
         Set<AdvancementTab> tabs = PLAYER_TAB_MAP.get(uuid);
+        if (tabs == null) return;
         tabs.remove(this);
         if (tabs.isEmpty()) {
             PLAYER_TAB_MAP.remove(uuid);

src/main/java/net/minestom/server/advancements/notifications/Notification.java

@@ -8,7 +8,11 @@
 
 /**
  * Represents a message which can be sent using the {@link NotificationCenter}.
+ * @since 1.0.0
+ * @deprecated As of Minestom 22a8ccabfae38c53df0605000aa7eed49765c1ab, because the Maintainability is very hard and
+ *      can break everytime from Mojang side because bad api design use {@link net.minestom.server.notifications.Notification#builder()} instead.
  */
+@Deprecated(since = "1.4.1", forRemoval = true)
 public record Notification(@NotNull Component title, @NotNull FrameType frameType, @NotNull ItemStack icon) {
     public Notification(@NotNull Component title, @NotNull FrameType frameType, @NotNull Material icon) {
         this(title, frameType, ItemStack.of(icon));

src/main/java/net/minestom/server/advancements/notifications/NotificationCenter.java

@@ -9,12 +9,16 @@
 import java.util.List;
 
 /**
+ * @since 1.0.0
  * Used to send one or multiples {@link Notification}.
  * <p>
  * Works by sending a completed advancement and remove it immediately.
  * <p>
  * You can simply create a {@link Notification} object and call {@link #send(Notification, Player)}.
+ * @deprecated As of Minestom 22a8ccabfae38c53df0605000aa7eed49765c1ab, because the Maintainability is very hard and
+ *      can break everytime from Mojang side because bad api design use {@link net.minestom.server.notifications.Notification#builder()} instead.
  */
+@Deprecated(since = "1.4.1", forRemoval = true)
 public final class NotificationCenter {
     private static final String IDENTIFIER = "minestom:notification";
     private static final AdvancementsPacket REMOVE_PACKET = new AdvancementsPacket(false, List.of(), List.of(IDENTIFIER), List.of());

src/main/java/net/minestom/server/notifications/Notification.java

@@ -0,0 +1,117 @@
+package net.minestom.server.notifications;
+
+import net.kyori.adventure.text.Component;
+import net.minestom.server.advancements.FrameType;
+import net.minestom.server.entity.Player;
+import net.minestom.server.item.ItemStack;
+import net.minestom.server.item.Material;
+import net.minestom.server.network.packet.server.play.AdvancementsPacket;
+import org.jetbrains.annotations.Contract;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.Collection;
+import java.util.List;
+
+/**
+ * Is used to send temporary advancements to the client, which are called notifications.
+ * <br>
+ * Here is an example of its use:
+ * <pre><code>
+ * Notification notification = Notification.builder()
+ *  .frameType(FrameType.TASK)
+ *  .title(Component.text("Welcome!"))
+ *  .icon(Material.IRON_SWORD).build();
+ * notification.send(player);
+ * </code></pre>
+ *
+ * The constant {@link #IDENTIFIER} is used for the advancement packet
+ * The constant {@link #REMOVE_PACKET} is used to remove previous notifications
+ * @since 1.4.1
+ */
+public sealed interface Notification permits NotificationImpl {
+
+    String IDENTIFIER = "minestom:notification";
+    AdvancementsPacket REMOVE_PACKET = new AdvancementsPacket(false, List.of(), List.of(IDENTIFIER), List.of());
+
+    /**
+     * Creates a new builder instance
+     * @return an instance of the builder
+     */
+    @Contract(pure = true)
+    static @NotNull Builder builder() {
+        return new NotificationBuilder();
+    }
+
+    /**
+     * Send the notification to the client
+     * @param player to get be sent
+     */
+    void send(@NotNull Player player);
+
+    /**
+     * Send the notification to a collection of clients
+     * @param players to get be sent
+     */
+    void send(@NotNull Collection<@NotNull Player> players);
+
+    /**
+     * Gets the title of the notification as a {@link Component}
+     * @return the title {@link Component}
+     */
+    @NotNull Component title();
+
+    /**
+     * Get the {@link FrameType} of the notification
+     * @return the type
+     */
+    @NotNull FrameType type();
+
+    /**
+     * Get the displayed icon of the notification as {@link ItemStack}
+     * @return the {@link ItemStack}
+     */
+    @NotNull ItemStack icon();
+
+    /**
+     * @since 1.4.1
+     */
+    sealed interface Builder permits NotificationBuilder {
+
+        /**
+         * Set the title for a notification as component.
+         *
+         * If you're using a resource pack you can use {@link Component#translatable(String)}
+         *
+         * @param component to get send to the client
+         * @return the builder
+         */
+        Builder title(@NotNull Component component);
+
+        /**
+         * Set the frame typ of the notification
+         * @param frameType to showed for the client
+         * @return the builder
+         */
+        Builder frameType(@NotNull FrameType frameType);
+
+        /**
+         * Set the {@link Material} for the icon
+         * @param material to be shown to the client
+         * @return the builder
+         */
+        Builder icon(@NotNull Material material);
+
+        /**
+         * Set the {@link ItemStack} for the icon
+         * @param itemStack to be shown to the client
+         * @return the builder
+         */
+        Builder icon(@NotNull ItemStack itemStack);
+
+        /**
+         * Returns an instance of the creation notification
+         * @return the instance
+         */
+        Notification build();
+    }
+}

src/main/java/net/minestom/server/notifications/NotificationBuilder.java

@@ -0,0 +1,60 @@
+package net.minestom.server.notifications;
+
+import net.kyori.adventure.text.Component;
+import net.minestom.server.advancements.FrameType;
+import net.minestom.server.item.ItemStack;
+import net.minestom.server.item.Material;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * {@inheritDoc}
+ */
+final class NotificationBuilder implements Notification.Builder {
+    private Component title;
+    private FrameType type;
+    private ItemStack icon;
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public Notification.Builder title(@NotNull Component component) {
+        this.title = component;
+        return this;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public Notification.Builder frameType(@NotNull FrameType frameType) {
+        this.type = frameType;
+        return this;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public Notification.Builder icon(@NotNull Material material) {
+        this.icon = ItemStack.of(material);
+        return this;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public Notification.Builder icon(@NotNull ItemStack itemStack) {
+        this.icon = itemStack;
+        return this;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public Notification build() {
+        return new NotificationImpl(title, type, icon);
+    }
+}

src/main/java/net/minestom/server/notifications/NotificationImpl.java

@@ -0,0 +1,58 @@
+package net.minestom.server.notifications;
+
+import net.kyori.adventure.text.Component;
+import net.minestom.server.advancements.FrameType;
+import net.minestom.server.entity.Player;
+import net.minestom.server.item.ItemStack;
+import net.minestom.server.network.packet.server.play.AdvancementsPacket;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.Collection;
+import java.util.List;
+
+/**
+ * {@inheritDoc}
+ */
+record NotificationImpl(@NotNull Component title, @NotNull FrameType type,
+                        @NotNull ItemStack icon) implements Notification {
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public void send(@NotNull Player player) {
+        player.sendPacket(createPacket());
+        player.sendPacket(REMOVE_PACKET);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public void send(@NotNull Collection<@NotNull Player> players) {
+        players.forEach(this::send);
+    }
+
+    /**
+     * Create the advancement packet that simulates the notification.
+     * It's not private because integration tests
+     * @return the packet
+     */
+    @NotNull AdvancementsPacket createPacket() {
+        final var displayData = new AdvancementsPacket.DisplayData(
+                title(), Component.empty(),
+                icon(), type(),
+                0x6, null, 0f, 0f);
+
+        final var criteria = new AdvancementsPacket.Criteria("minestom:some_criteria",
+                new AdvancementsPacket.CriterionProgress(System.currentTimeMillis()));
+
+        final var advancement = new AdvancementsPacket.Advancement(null, displayData,
+                List.of(new AdvancementsPacket.Requirement(List.of(criteria.criterionIdentifier()))),
+                false);
+
+        final var mapping = new AdvancementsPacket.AdvancementMapping(IDENTIFIER, advancement);
+        final var progressMapping = new AdvancementsPacket.ProgressMapping(IDENTIFIER,
+                new AdvancementsPacket.AdvancementProgress(List.of(criteria)));
+        return new AdvancementsPacket(false, List.of(mapping), List.of(), List.of(progressMapping));
+    }
+}

src/main/java/net/minestom/server/notifications/package-info.java

@@ -0,0 +1,12 @@
+/**
+ * This module contains logic about notification system for the minecraft client.
+ * <p>
+ * It allows developers to show a toast in the right upper corner with 3 different frame types:
+ * {@link net.minestom.server.advancements.FrameType#GOAL}, {@link net.minestom.server.advancements.FrameType#TASK} or {@link net.minestom.server.advancements.FrameType#CHALLENGE}
+ * </p>
+ *
+ * @since 1.4.1
+ * @author TheMeinerLP
+ * @version 1.0
+ */
+package net.minestom.server.notifications;