task soft-failing and on-fail callbacks

Author: beanbag44

src/main/kotlin/com/lambda/command/commands/TaskCommand.kt

@@ -42,7 +42,6 @@ object TaskCommand : LambdaCommand(
             execute {
                 this@TaskCommand.info("Clearing all tasks")
                 RootTask.cancel()
-                RootTask.clear()
             }
         }
     }

src/main/kotlin/com/lambda/config/AutomationConfig.kt

@@ -33,63 +33,63 @@ import com.lambda.util.NamedEnum
 
 
 open class AutomationConfig(
-    override val name: String,
-    configuration: Configuration = AutomationConfigs
+	override val name: String,
+	configuration: Configuration = AutomationConfigs
 ) : Configurable(configuration), Automated {
-    enum class Group(override val displayName: String) : NamedEnum {
-        Build("Build"),
-        Break("Break"),
-        Interact("Interact"),
-        Rotation("Rotation"),
-        Inventory("Inventory"),
-        Hotbar("Hotbar"),
-        Eat("Eat"),
-        Render("Render"),
-        Debug("Debug")
-    }
+	enum class Group(override val displayName: String) : NamedEnum {
+		Build("Build"),
+		Break("Break"),
+		Interact("Interact"),
+		Rotation("Rotation"),
+		Inventory("Inventory"),
+		Hotbar("Hotbar"),
+		Eat("Eat"),
+		Render("Render"),
+		Debug("Debug")
+	}
 
-    override val buildConfig = BuildSettings(this, Group.Build)
-    override val breakConfig = BreakSettings(this, Group.Break)
-    override val interactConfig = InteractSettings(this, Group.Interact)
-    override val rotationConfig = RotationSettings(this, Group.Rotation)
-    override val inventoryConfig = InventorySettings(this, Group.Inventory)
-    override val hotbarConfig = HotbarSettings(this, Group.Hotbar)
-    override val eatConfig = EatSettings(this, Group.Eat)
+	override val buildConfig = BuildSettings(this, Group.Build)
+	override val breakConfig = BreakSettings(this, Group.Break)
+	override val interactConfig = InteractSettings(this, Group.Interact)
+	override val rotationConfig = RotationSettings(this, Group.Rotation)
+	override val inventoryConfig = InventorySettings(this, Group.Inventory)
+	override val hotbarConfig = HotbarSettings(this, Group.Hotbar)
+	override val eatConfig = EatSettings(this, Group.Eat)
 
-    companion object {
+	companion object {
 		context(module: Module)
-        fun MutableAutomationConfig.setDefaultAutomationConfig(
-	        name: String = module.name,
-	        edits: (AutomationConfig.() -> Unit)? = null
+		fun MutableAutomationConfig.setDefaultAutomationConfig(
+			name: String = module.name,
+			edits: (AutomationConfig.() -> Unit)? = null
 		) {
 			this.defaultAutomationConfig = AutomationConfig("$name Automation Config").apply { edits?.invoke(this) }
 		}
 
-        fun MutableAutomationConfig.setDefaultAutomationConfig(
-	        name: String,
-	        edits: (AutomationConfig.() -> Unit)? = null
+		fun MutableAutomationConfig.setDefaultAutomationConfig(
+			name: String,
+			edits: (AutomationConfig.() -> Unit)? = null
 		) {
 			defaultAutomationConfig = AutomationConfig("$name Automation Config").apply { edits?.invoke(this) }
 		}
 
-        object DEFAULT : AutomationConfig("Default") {
-            val renders by setting("Render", false).group(Group.Render)
-            val avoidDesync by setting("Avoid Desync", true, "Cancels incoming inventory update packets if they match previous actions").group(Group.Debug)
-            val desyncTimeout by setting("Desync Timeout", 30, 1..30, 1, unit = " ticks", description = "Time to store previous inventory actions before dropping the cache") { avoidDesync }.group(Group.Debug)
-            val showAllEntries by setting("Show All Entries", false, "Show all entries in the task tree").group(Group.Debug)
-            val shrinkFactor by setting("Shrink Factor", 0.001, 0.0..1.0, 0.001).group(Group.Debug)
-            val ignoreItemDropWarnings by setting("Ignore Drop Warnings", false, "Hides the item drop warnings from the break manager").group(Group.Debug)
+		object DEFAULT : AutomationConfig("Default") {
+			val renders by setting("Render", false).group(Group.Render)
+			val avoidDesync by setting("Avoid Desync", true, "Cancels incoming inventory update packets if they match previous actions").group(Group.Debug)
+			val desyncTimeout by setting("Desync Timeout", 30, 1..30, 1, unit = " ticks", description = "Time to store previous inventory actions before dropping the cache") { avoidDesync }.group(Group.Debug)
+			val showAllEntries by setting("Show All Entries", false, "Show all entries in the task tree").group(Group.Debug)
+			val shrinkFactor by setting("Shrink Factor", 0.001, 0.0..1.0, 0.001).group(Group.Debug)
+			val ignoreItemDropWarnings by setting("Ignore Drop Warnings", false, "Hides the item drop warnings from the break manager").group(Group.Debug)
 			val managerDebugLogs by setting("Manager Debug Logs", false, "Prints debug logs from managers into chat").group(Group.Debug)
 
-            @Volatile
-            var drawables = listOf<Drawable>()
+			@Volatile
+			var drawables = listOf<Drawable>()
 
-            init {
-                onStaticRender { esp ->
+			init {
+				onStaticRender { esp ->
 					if (renders)
 						drawables.forEach { it.render(esp) }
-                }
-            }
-        }
-    }
+				}
+			}
+		}
+	}
 }

src/main/kotlin/com/lambda/interaction/construction/simulation/result/results/BreakResult.kt

@@ -101,7 +101,7 @@ sealed class BreakResult : BuildResult() {
         override fun resolve() {
             selectStack {
                 isItem(badItem).not()
-            }.transferByTask(HotbarContainer)?.execute(task)
+            }.transferByTask(HotbarContainer)?.softFail()?.execute(task)
         }
 
         override fun compareResult(other: ComparableResult<Rank>) =

src/main/kotlin/com/lambda/interaction/construction/simulation/result/results/GenericResult.kt

@@ -99,7 +99,7 @@ sealed class GenericResult : BuildResult() {
 
         context(task: Task<*>, _: AutomatedSafeContext)
         override fun resolve() {
-            neededSelection.transferByTask(HotbarContainer)?.execute(task)
+            neededSelection.transferByTask(HotbarContainer)?.softFail()?.execute(task)
         }
 
         override fun render(esp: TransientRegionESP) {

src/main/kotlin/com/lambda/module/modules/player/Printer.kt

@@ -38,11 +38,6 @@ object Printer : Module(
 	description = "Automatically prints schematics",
 	tag = ModuleTag.PLAYER
 ) {
-	private fun isLitematicaAvailable(): Boolean = runCatching {
-		Class.forName("fi.dy.masa.litematica.Litematica")
-		true
-	}.getOrDefault(false)
-
 	private val range by setting("Range", 5, 1..7, 1)
 	private val air by setting("Air", false)
 
@@ -58,7 +53,7 @@ object Printer : Module(
 		}
 
 		onEnable {
-			if (!isLitematicaAvailable()) {
+			if (!litematicaAvailable()) {
 				logError("Litematica is not installed!")
 				disable()
 				return@onEnable
@@ -76,4 +71,9 @@ object Printer : Module(
 
 		onDisable { buildTask?.cancel(); buildTask = null }
 	}
+
+	private fun litematicaAvailable(): Boolean = runCatching {
+		Class.forName("fi.dy.masa.litematica.Litematica")
+		true
+	}.getOrDefault(false)
 }

src/main/kotlin/com/lambda/task/Task.kt

@@ -38,6 +38,7 @@ typealias TaskGeneratorUnit<R> = SafeContext.(R) -> Unit
 
 abstract class Task<Result> : Nameable, Muteable {
     var parent: Task<*>? = null
+    var parentPausing = false
     val subTasks = mutableListOf<Task<*>>()
     var state = State.Init
     override val isMuted: Boolean get() = state == State.Paused || state == State.Init
@@ -50,6 +51,10 @@ abstract class Task<Result> : Nameable, Muteable {
     private var nextTaskOrNull: TaskGeneratorOrNull<Result>? = null
     private var onFinish: TaskGeneratorUnit<Result>? = null
 
+    private var onFail: TaskGenerator<Unit>? = null
+    private var onFailOrNull: TaskGeneratorOrNull<Unit>? = null
+    private var softFail = false
+
     enum class State {
         Init,
         Running,
@@ -115,6 +120,7 @@ abstract class Task<Result> : Nameable, Muteable {
         parent = owner
         LOG.info("${owner.name} started $name")
         if (pauseParent) {
+            parentPausing = true
             LOG.info("$name pausing parent ${owner.name}")
             if (owner !is RootTask) owner.pause()
         }
@@ -165,9 +171,13 @@ abstract class Task<Result> : Nameable, Muteable {
     }
 
     @Ta5kBuilder
-    fun cancel() {
+    fun cancel() = internalCancel(true)
+
+    private fun internalCancel(removeFromParent: Boolean = true) {
         runSafe { onCancel() }
         cancelSubTasks()
+        if (removeFromParent) parent?.subTasks?.remove(this)
+        if (parentPausing) parent?.activate()
         if (this is RootTask) return
         if (state == State.Completed || state == State.Cancelled) return
         state = State.Cancelled
@@ -176,11 +186,7 @@ abstract class Task<Result> : Nameable, Muteable {
 
     @Ta5kBuilder
     fun cancelSubTasks() {
-        subTasks.forEach { it.cancel() }
-    }
-
-    fun clear() {
-        subTasks.forEach { it.clear() }
+        subTasks.forEach { it.internalCancel(removeFromParent = false) }
         subTasks.clear()
     }
 
@@ -192,10 +198,27 @@ abstract class Task<Result> : Nameable, Muteable {
         e: Throwable,
         stacktrace: MutableList<Task<*>> = mutableListOf(),
     ) {
+        if (softFail) {
+            cancelSubTasks()
+            parent?.subTasks?.remove(this)
+        }
         state = State.Failed
         unsubscribe()
         stacktrace.add(this)
-        parent?.failure(e, stacktrace) ?: run {
+        runSafe {
+            onFail?.let { taskGen ->
+                val task = taskGen(this, Unit)
+                onFail = null
+                parent?.let { owner -> task.execute(owner) }
+            } ?: onFailOrNull?.let { taskGen ->
+                val task = taskGen(this, Unit)
+                onFailOrNull = null
+                parent?.let { owner -> task?.execute(owner) }
+            }
+        } ?: if (softFail) {
+            if (parentPausing) parent?.activate()
+            return
+        } else parent?.failure(e, stacktrace) ?: run {
             val message = buildString {
                 stacktrace.firstOrNull()?.let { first ->
                     append("${first.name} failed: ${e.message}\n")
@@ -286,6 +309,28 @@ abstract class Task<Result> : Nameable, Muteable {
         return this
     }
 
+    @Ta5kBuilder
+    fun onFail(taskGenerator: TaskGenerator<Unit>): Task<Result> {
+        require(onFail == null) { "Cannot have multiple onFail callbacks on a single task" }
+        onFail = taskGenerator
+        softFail()
+        return this
+    }
+
+    @Ta5kBuilder
+    fun onFailOrNull(taskGenerator: TaskGeneratorOrNull<Unit>): Task<Result> {
+        require(onFailOrNull == null) { "Cannot have multiple onFailOrNull callbacks on a single task" }
+        onFailOrNull = taskGenerator
+        softFail()
+        return this
+    }
+
+    @Ta5kBuilder
+    fun softFail(): Task<Result> {
+        softFail = true
+        return this
+    }
+
     /**
      * Registers a finalization action to be executed after the current task completes.
      *