Default to ignoring decoration failures

Author: Aeltumn

interfaces/src/main/kotlin/com/noxcrew/interfaces/exception/StandardInterfacesExceptionHandler.kt

@@ -5,11 +5,21 @@ import net.kyori.adventure.text.Component
 import org.slf4j.LoggerFactory
 
 /** The standard implementation that handles an interfaces exception. */
-public object StandardInterfacesExceptionHandler : InterfacesExceptionHandler {
+public class StandardInterfacesExceptionHandler(
+    /** Whether decorations are allowed to fail gracefully. */
+    public val allowDecorationFailure: Boolean = true,
+) : InterfacesExceptionHandler {
     private val logger = LoggerFactory.getLogger(StandardInterfacesExceptionHandler::class.java)
 
-    override suspend fun handleException(exception: Exception, context: InterfacesExceptionContext): InterfacesExceptionResolution =
-        when (context.operation) {
+    override suspend fun handleException(exception: Exception, context: InterfacesExceptionContext): InterfacesExceptionResolution {
+        // Optionally gracefully let decorations fail without issue! This defaults to true because we also
+        // allow items to be clicked without their decorations.
+        if (allowDecorationFailure && context.operation == InterfacesOperation.DECORATING_ELEMENT) {
+            logger.warn("Failed to decorate interface elements for ${context.player.name}")
+            return InterfacesExceptionResolution.IGNORE
+        }
+
+        return when (context.operation) {
             InterfacesOperation.BUILDING_PLAYER -> {
                 if (context.retries < 3) {
                     // When building a player menu we absolutely do not want to fail as
@@ -19,7 +29,7 @@ public object StandardInterfacesExceptionHandler : InterfacesExceptionHandler {
                 } else {
                     // Ignore the drawing but kick the player off the server
                     logger.error(
-                        "Failed to build player inventory for ${context.player.name} 3 times, kicking player to prevent invalid state"
+                        "Failed to build player inventory for ${context.player.name} 3 times, kicking player to prevent invalid state",
                     )
                     InterfacesListeners.INSTANCE.runSync {
                         context.player.kick(Component.text("Unknown exception occurred while rendering GUI menus"))
@@ -37,4 +47,5 @@ public object StandardInterfacesExceptionHandler : InterfacesExceptionHandler {
                 InterfacesExceptionResolution.CLOSE
             }
         }
+    }
 }

interfaces/src/main/kotlin/com/noxcrew/interfaces/interfaces/InterfaceProperties.kt

@@ -79,7 +79,7 @@ public open class InterfaceProperties<P : Pane> {
     public var defaultTimeout: Duration = 2.5.seconds
 
     /** The exception handler to use for this interface. */
-    public var exceptionHandler: InterfacesExceptionHandler = StandardInterfacesExceptionHandler
+    public var exceptionHandler: InterfacesExceptionHandler = StandardInterfacesExceptionHandler()
 
     /** Adds a new close handler [closeHandler] that triggers whenever the inventory is closed for any of the given [reasons]. */
     public fun addCloseHandler(reasons: Collection<InventoryCloseEvent.Reason> = DEFAULT_REASONS, closeHandler: CloseHandler) {

interfaces/src/main/kotlin/com/noxcrew/interfaces/menu/PlayerInventoryMenu.kt

@@ -13,7 +13,7 @@ import org.bukkit.entity.Player
 /** The base for a menu that is applied on a player's whole inventory. */
 public abstract class PlayerInventoryMenu : BaseInventoryMenu {
     /** The exception handler to use for this menu. */
-    public open val exceptionHandler: InterfacesExceptionHandler = StandardInterfacesExceptionHandler
+    public open val exceptionHandler: InterfacesExceptionHandler = StandardInterfacesExceptionHandler()
 
     /** Configures the GUI for the given [player]. */
     protected abstract suspend fun PlayerInterfaceBuilder.configure(player: Player)

interfaces/src/main/kotlin/com/noxcrew/interfaces/menu/SimpleInventoryMenu.kt

@@ -13,7 +13,7 @@ import org.bukkit.entity.Player
 /** The base for a simple built menu. */
 public abstract class SimpleInventoryMenu<B : InterfaceBuilder<out Pane, *>> : BaseInventoryMenu {
     /** The exception handler to use for this menu. */
-    public open val exceptionHandler: InterfacesExceptionHandler = StandardInterfacesExceptionHandler
+    public open val exceptionHandler: InterfacesExceptionHandler = StandardInterfacesExceptionHandler()
 
     /** Builds the interface for this type using [configure]. */
     protected abstract suspend fun build(player: Player, configure: suspend B.() -> Unit): Interface<*, *>