Make InterfaceView#close non-suspending so it can be safely used in non-suspending logic

Author: Aeltumn

build.gradle.kts

@@ -15,7 +15,7 @@ val javaVersion: Int = 21
 
 allprojects {
     group = "com.noxcrew.interfaces"
-    version = "1.3.1-SNAPSHOT"
+    version = "1.3.2-SNAPSHOT"
 
     tasks.withType<JavaCompile> {
         sourceCompatibility = javaVersion.toString()

interfaces/src/main/kotlin/com/noxcrew/interfaces/view/AbstractInterfaceView.kt

@@ -16,6 +16,7 @@ import com.noxcrew.interfaces.transform.AppliedTransform
 import com.noxcrew.interfaces.utilities.CollapsablePaneMap
 import com.noxcrew.interfaces.utilities.InterfacesCoroutineDetails
 import com.noxcrew.interfaces.utilities.forEachInGrid
+import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Job
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.sync.Mutex
@@ -103,7 +104,8 @@ public abstract class AbstractInterfaceView<I : InterfacesInventory, T : Interfa
      * Marks this menu as closed and processes it. This does not actually perform
      * closing the menu, this method only handles the closing.
      */
-    internal suspend fun markClosed(
+    internal fun markClosed(
+        coroutineScope: CoroutineScope,
         reason: InventoryCloseEvent.Reason = InventoryCloseEvent.Reason.UNKNOWN,
         changingView: Boolean = reason == InventoryCloseEvent.Reason.OPEN_NEW
     ) {
@@ -120,7 +122,11 @@ public abstract class AbstractInterfaceView<I : InterfacesInventory, T : Interfa
             (!changingView || builder.callCloseHandlerOnViewSwitch) &&
             ::currentInventory.isInitialized
         ) {
-            builder.closeHandlers[reason]?.invoke(reason, this)
+            builder.closeHandlers[reason]?.also {
+                coroutineScope.launch {
+                    it.invoke(reason, this@AbstractInterfaceView)
+                }
+            }
         }
 
         // Don't close children when changing views!
@@ -132,7 +138,7 @@ public abstract class AbstractInterfaceView<I : InterfacesInventory, T : Interfa
             // properly.
             for ((child) in children) {
                 if (child.shouldBeOpened.get()) {
-                    child.close(reason, false)
+                    child.close(coroutineScope, reason, false)
                 }
             }
         }
@@ -196,8 +202,8 @@ public abstract class AbstractInterfaceView<I : InterfacesInventory, T : Interfa
         }
     }
 
-    override suspend fun close(reason: InventoryCloseEvent.Reason, changingView: Boolean) {
-        markClosed(reason, changingView)
+    override fun close(coroutineScope: CoroutineScope, reason: InventoryCloseEvent.Reason, changingView: Boolean) {
+        markClosed(coroutineScope, reason, changingView)
 
         // Ensure we always close on the main thread! Don't close if we are
         // changing views though.

interfaces/src/main/kotlin/com/noxcrew/interfaces/view/InterfaceView.kt

@@ -1,5 +1,8 @@
 package com.noxcrew.interfaces.view
 
+import com.noxcrew.interfaces.InterfacesConstants
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.currentCoroutineContext
 import net.kyori.adventure.text.Component
 import org.bukkit.entity.Player
 import org.bukkit.event.inventory.InventoryCloseEvent
@@ -40,6 +43,13 @@ public interface InterfaceView {
     public suspend fun close(
         reason: InventoryCloseEvent.Reason = InventoryCloseEvent.Reason.UNKNOWN,
         changingView: Boolean = reason == InventoryCloseEvent.Reason.OPEN_NEW
+    ): Unit = close(CoroutineScope(currentCoroutineContext()), reason, changingView)
+
+    /** Closes this view immediately, running any closing handling on [coroutineScope]. */
+    public fun close(
+        coroutineScope: CoroutineScope,
+        reason: InventoryCloseEvent.Reason = InventoryCloseEvent.Reason.UNKNOWN,
+        changingView: Boolean = reason == InventoryCloseEvent.Reason.OPEN_NEW
     )
 
     /** Returns whether this view is opened based on the player's current shown inventory. */

interfaces/src/main/kotlin/com/noxcrew/interfaces/view/PlayerInterfaceView.kt

@@ -4,6 +4,7 @@ import com.noxcrew.interfaces.InterfacesListeners
 import com.noxcrew.interfaces.interfaces.PlayerInterface
 import com.noxcrew.interfaces.inventory.PlayerInterfacesInventory
 import com.noxcrew.interfaces.pane.PlayerPane
+import kotlinx.coroutines.CoroutineScope
 import net.kyori.adventure.text.Component
 import org.bukkit.entity.Player
 import org.bukkit.event.inventory.InventoryCloseEvent
@@ -59,8 +60,8 @@ public class PlayerInterfaceView internal constructor(
         onOpen()
     }
 
-    override suspend fun close(reason: InventoryCloseEvent.Reason, changingView: Boolean) {
-        markClosed(reason, changingView)
+    override fun close(coroutineScope: CoroutineScope, reason: InventoryCloseEvent.Reason, changingView: Boolean) {
+        markClosed(coroutineScope, reason, changingView)
 
         // Ensure we update the interface state in the main thread!
         // Even if the menu is not currently on the screen.