JS-2156 Rename OrderInstructionReset as OrderStateReset

js7-data/shared/src/main/scala/js7/data/order/Order.scala

@@ -278,7 +278,7 @@ final case class Order[+S <: Order.State](
       case OrderCancellationMarkedOnAgent =>
         Right(this)
 
-      case OrderInstructionReset =>
+      case OrderStateReset =>
         // Event precedes OrderCancelled in the same transaction,
         // maybe before some block-leaving events which rely on state == Ready.
         check(state.isInstanceOf[Resettable] && isStarted,
@@ -951,7 +951,7 @@ object Order:
 
   sealed trait Resettable extends State:
     private[Order] final def reset: List[OrderActorEvent] =
-      OrderInstructionReset :: Nil
+      OrderStateReset :: Nil
 
 
   transparent sealed trait NotTransferable extends State:

js7-data/shared/src/main/scala/js7/data/order/OrderEvent.scala

@@ -477,8 +477,8 @@ object OrderEvent extends Event.CompanionForKey[OrderId, OrderEvent]:
   /** No other use than notifying an external user. */
   case object OrderCancellationMarkedOnAgent extends OrderActorEvent
 
-  type OrderInstructionReset = OrderInstructionReset.type
-  case object OrderInstructionReset extends OrderActorEvent
+  type OrderStateReset = OrderStateReset.type
+  case object OrderStateReset extends OrderActorEvent
 
   type OrderCancelled = OrderCancelled.type
   case object OrderCancelled extends OrderActorEvent, OrderTerminated
@@ -654,7 +654,7 @@ object OrderEvent extends Event.CompanionForKey[OrderId, OrderEvent]:
     Subtype(deriveCodec[OrderFailed]),
     Subtype(deriveCodec[OrderFailedInFork]),
     Subtype(deriveConfiguredCodec[OrderCancellationMarked]),
-    Subtype.singleton(OrderInstructionReset, aliases = Seq(
+    Subtype.singleton(OrderStateReset, aliases = Seq(
       "OrderOperationCancelled", "OrderLocksDequeued", "OrderLockDequeued")),
     Subtype(OrderCancellationMarkedOnAgent),
     Subtype(OrderCancelled),

js7-data/shared/src/main/scala/js7/data/state/EventDrivenStateView.scala

@@ -7,7 +7,7 @@ import js7.data.board.BoardState
 import js7.data.event.{Event, EventDrivenState}
 import js7.data.item.{UnsignedSimpleItemPath, UnsignedSimpleItemState}
 import js7.data.order.Order.{ExpectingNotices, WaitingForLock}
-import js7.data.order.OrderEvent.{OrderAdded, OrderCancelled, OrderCoreEvent, OrderDeleted, OrderDeletionMarked, OrderDetached, OrderForked, OrderInstructionReset, OrderJoined, OrderLockEvent, OrderLocksAcquired, OrderLocksQueued, OrderLocksReleased, OrderNoticeEvent, OrderNoticeExpected, OrderNoticePosted, OrderNoticePostedV2_3, OrderNoticesConsumed, OrderNoticesConsumptionStarted, OrderNoticesExpected, OrderNoticesRead, OrderOrderAdded, OrderStdWritten}
+import js7.data.order.OrderEvent.{OrderAdded, OrderCancelled, OrderCoreEvent, OrderDeleted, OrderDeletionMarked, OrderDetached, OrderForked, OrderJoined, OrderLockEvent, OrderLocksAcquired, OrderLocksQueued, OrderLocksReleased, OrderNoticeEvent, OrderNoticeExpected, OrderNoticePosted, OrderNoticePostedV2_3, OrderNoticesConsumed, OrderNoticesConsumptionStarted, OrderNoticesExpected, OrderNoticesRead, OrderOrderAdded, OrderStateReset, OrderStdWritten}
 import js7.data.order.{Order, OrderEvent, OrderId}
 import js7.data.workflow.Instruction
 import js7.data.workflow.instructions.{ConsumeNotices, LockInstruction}
@@ -96,7 +96,7 @@ extends EventDrivenState[Self, E], StateView:
           applyOrderNoticeEvent(previousOrder, event)
             .flatMap(_.update(addOrders = updatedOrder :: Nil))
 
-        case OrderInstructionReset =>
+        case OrderStateReset =>
           previousOrder.ifState[WaitingForLock].map: order =>
             val instr = instruction_[LockInstruction](order.workflowPosition).orThrow
             foreachLock(instr.lockPaths): lockState =>
@@ -117,7 +117,7 @@ extends EventDrivenState[Self, E], StateView:
 
         case _: OrderCancelled =>
           previousOrder
-            // COMPATIBLE Since v2.7.2 an OrderInstructionReset is emitted and the
+            // COMPATIBLE Since v2.7.2 an OrderStateReset is emitted and the
             // following code is superfluous (but still needed for old journals)
             .ifState[ExpectingNotices]
             .fold(update(addOrders = updatedOrder :: Nil)): order =>

js7-data/shared/src/test/scala/js7/data/order/OrderEventTest.scala

@@ -733,24 +733,24 @@ final class OrderEventTest extends OurTestSuite:
       }""".checkedAs[OrderEvent] == Left(Problem(
         "JSON DecodingFailure at : LockDemand.count must not be below 1 for Lock:LOCK")))
 
-  "OrderInstructionReset" in :
-    testJson[OrderEvent](OrderInstructionReset,
+  "OrderStateReset" in :
+    testJson[OrderEvent](OrderStateReset,
       json"""
       {
-        "TYPE": "OrderInstructionReset"
+        "TYPE": "OrderStateReset"
       }""")
 
   // COMPATIBLE with v2.7.1
   "OrderLocksDequeued" in:
-    testJsonDecoder[OrderEvent](OrderInstructionReset, json"""
+    testJsonDecoder[OrderEvent](OrderStateReset, json"""
       {
         "TYPE": "OrderLocksDequeued",
         "lockPaths": [ "LOCK" ]
       }""")
 
   // COMPATIBLE with v2.4
   "OrderLockDequeued" in:
-    testJsonDecoder[OrderEvent](OrderInstructionReset,
+    testJsonDecoder[OrderEvent](OrderStateReset,
       json"""
       {
         "TYPE": "OrderLockDequeued",

js7-data/shared/src/test/scala/js7/data/order/OrderTest.scala

@@ -15,7 +15,7 @@ import js7.data.command.{CancellationMode, SuspensionMode}
 import js7.data.job.{InternalExecutable, JobKey}
 import js7.data.lock.LockPath
 import js7.data.order.Order.{Attached, AttachedState, Attaching, BetweenCycles, Broken, Cancelled, DelayedAfterError, Deleted, Detaching, ExpectingNotice, ExpectingNotices, Failed, FailedInFork, FailedWhileFresh, Finished, Forked, Fresh, InapplicableOrderEventProblem, IsFreshOrReady, Processed, Processing, ProcessingKilled, Prompting, Ready, State, Stopped, StoppedWhileFresh, WaitingForLock}
-import js7.data.order.OrderEvent.{LegacyOrderLockEvent, LockDemand, OrderAdded, OrderAttachable, OrderAttached, OrderAttachedToAgent, OrderAwoke, OrderBroken, OrderCancellationMarked, OrderCancellationMarkedOnAgent, OrderCancelled, OrderCatched, OrderCaught, OrderCoreEvent, OrderCycleFinished, OrderCycleStarted, OrderCyclingPrepared, OrderDeleted, OrderDeletionMarked, OrderDetachable, OrderDetached, OrderFailed, OrderFailedInFork, OrderFinished, OrderForked, OrderGoMarked, OrderGoes, OrderInstructionReset, OrderJoined, OrderLocksAcquired, OrderLocksQueued, OrderLocksReleased, OrderMoved, OrderNoticeExpected, OrderNoticePosted, OrderNoticePostedV2_3, OrderNoticesConsumed, OrderNoticesConsumptionStarted, OrderNoticesExpected, OrderNoticesRead, OrderOrderAdded, OrderOutcomeAdded, OrderProcessed, OrderProcessingKilled, OrderProcessingStarted, OrderPromptAnswered, OrderPrompted, OrderResumed, OrderResumptionMarked, OrderRetrying, OrderStarted, OrderStickySubagentEntered, OrderStickySubagentLeaved, OrderStopped, OrderSuspended, OrderSuspensionMarked, OrderSuspensionMarkedOnAgent, OrderTransferred}
+import js7.data.order.OrderEvent.{LegacyOrderLockEvent, LockDemand, OrderAdded, OrderAttachable, OrderAttached, OrderAttachedToAgent, OrderAwoke, OrderBroken, OrderCancellationMarked, OrderCancellationMarkedOnAgent, OrderCancelled, OrderCatched, OrderCaught, OrderCoreEvent, OrderCycleFinished, OrderCycleStarted, OrderCyclingPrepared, OrderDeleted, OrderDeletionMarked, OrderDetachable, OrderDetached, OrderFailed, OrderFailedInFork, OrderFinished, OrderForked, OrderGoMarked, OrderGoes, OrderJoined, OrderLocksAcquired, OrderLocksQueued, OrderLocksReleased, OrderMoved, OrderNoticeExpected, OrderNoticePosted, OrderNoticePostedV2_3, OrderNoticesConsumed, OrderNoticesConsumptionStarted, OrderNoticesExpected, OrderNoticesRead, OrderOrderAdded, OrderOutcomeAdded, OrderProcessed, OrderProcessingKilled, OrderProcessingStarted, OrderPromptAnswered, OrderPrompted, OrderResumed, OrderResumptionMarked, OrderRetrying, OrderStarted, OrderStateReset, OrderStickySubagentEntered, OrderStickySubagentLeaved, OrderStopped, OrderSuspended, OrderSuspensionMarked, OrderSuspensionMarkedOnAgent, OrderTransferred}
 import js7.data.subagent.{SubagentId, SubagentSelectionId}
 import js7.data.value.{NamedValues, NumberValue, StringValue, Value}
 import js7.data.workflow.instructions.executable.WorkflowJob
@@ -406,7 +406,7 @@ final class OrderTest extends OurTestSuite:
       OrderCancellationMarked(CancellationMode.FreshOnly),
       OrderCancellationMarkedOnAgent,
       OrderCancelled,
-      OrderInstructionReset,
+      OrderStateReset,
       OrderSuspensionMarked(),
       OrderSuspensionMarkedOnAgent,
       OrderSuspended,
@@ -543,7 +543,7 @@ final class OrderTest extends OurTestSuite:
         cancelMarkedAllowed[WaitingForLock] orElse
         suspendMarkedAllowed[WaitingForLock] orElse {
           case (_: OrderLocksAcquired, _, _, IsDetached) => _.isInstanceOf[Ready]
-          case (_: OrderInstructionReset, _, _, _      ) => _.isInstanceOf[Ready]
+          case (_: OrderStateReset, _, _, _      ) => _.isInstanceOf[Ready]
           case (_: OrderCancelled    , _, _, IsDetached) => _.isInstanceOf[Cancelled]
           case (_: OrderOutcomeAdded , _, _, _         ) => _.isInstanceOf[WaitingForLock]
           case (_: OrderTransferred  , _, _, IsDetached) => _.isInstanceOf[WaitingForLock]
@@ -562,7 +562,7 @@ final class OrderTest extends OurTestSuite:
           case (_: OrderNoticesConsumptionStarted, IsSuspended(false), _, IsDetached) => _.isInstanceOf[Ready]
           case (_: OrderCancelled   , _, _, IsDetached) => _.isInstanceOf[Cancelled]
           case (_: OrderOutcomeAdded, _, _, _         ) => _.isInstanceOf[ExpectingNotices]
-          case (_: OrderInstructionReset  , _, _, _   ) => _.isInstanceOf[Ready]
+          case (_: OrderStateReset  , _, _, _   ) => _.isInstanceOf[Ready]
           case (_: OrderTransferred , _, _, IsDetached) => _.isInstanceOf[ExpectingNotices]
           case (_: OrderBroken      , _, _, _         ) => _.isInstanceOf[Broken]
         })
@@ -628,7 +628,7 @@ final class OrderTest extends OurTestSuite:
         suspendMarkedAllowed[Prompting] orElse {
           case (_: OrderPromptAnswered, _, _, IsDetached) => _.isInstanceOf[Ready]
           case (OrderCancelled        , _, _, IsDetached) => _.isInstanceOf[Cancelled]  // COMPATIBLE with v2.4
-          case (OrderInstructionReset , _, _,          _) => _.isInstanceOf[Ready]
+          case (OrderStateReset , _, _,          _) => _.isInstanceOf[Ready]
           case (_: OrderOutcomeAdded  , _, _, _         ) => _.isInstanceOf[Prompting]
           case (_: OrderTransferred   , _, _, IsDetached) => _.isInstanceOf[Prompting]
           case (_: OrderBroken        , _, _, _         ) => _.isInstanceOf[Broken]
@@ -648,7 +648,7 @@ final class OrderTest extends OurTestSuite:
           case (OrderCancelled         , _                 , _, IsDetached             ) => _.isInstanceOf[Cancelled]
           case (_: OrderOutcomeAdded   , _                 , _, _                      ) => _.isInstanceOf[BetweenCycles]
           case (_: OrderTransferred    , _                 , _, IsDetached             ) => _.isInstanceOf[BetweenCycles]
-          case (OrderInstructionReset  , _                 , _, _                      ) => _.isInstanceOf[Ready]
+          case (OrderStateReset  , _                 , _, _                      ) => _.isInstanceOf[Ready]
           case (_: OrderGoMarked       , _                 , _, IsAttached             ) => _.isInstanceOf[BetweenCycles]
           case (_: OrderGoes           , _                 , _, IsDetached | IsAttached) => _.isInstanceOf[BetweenCycles]
           case (_: OrderFailed         , _                 , _, IsDetached             ) => _.isInstanceOf[Failed]

js7-tests/src/test/scala/js7/tests/CancelOrdersTest.scala

@@ -28,7 +28,7 @@ import js7.data.event.{KeyedEvent, Stamped}
 import js7.data.item.ItemOperation.{AddOrChangeSigned, AddVersion}
 import js7.data.item.VersionId
 import js7.data.job.ShellScriptExecutable
-import js7.data.order.OrderEvent.{OrderAdded, OrderAttachable, OrderAttached, OrderBroken, OrderCancellationMarked, OrderCancellationMarkedOnAgent, OrderCancelled, OrderCaught, OrderDeleted, OrderDetachable, OrderDetached, OrderFailed, OrderFinished, OrderForked, OrderInstructionReset, OrderJoined, OrderMoved, OrderProcessed, OrderProcessingKilled, OrderProcessingStarted, OrderPrompted, OrderRetrying, OrderStarted, OrderStdWritten, OrderStdoutWritten, OrderSuspended, OrderTerminated}
+import js7.data.order.OrderEvent.{OrderAdded, OrderAttachable, OrderAttached, OrderBroken, OrderCancellationMarked, OrderCancellationMarkedOnAgent, OrderCancelled, OrderCaught, OrderDeleted, OrderDetachable, OrderDetached, OrderFailed, OrderFinished, OrderForked, OrderJoined, OrderMoved, OrderProcessed, OrderProcessingKilled, OrderProcessingStarted, OrderPrompted, OrderRetrying, OrderStarted, OrderStateReset, OrderStdWritten, OrderStdoutWritten, OrderSuspended, OrderTerminated}
 import js7.data.order.{FreshOrder, Order, OrderEvent, OrderId, OrderOutcome}
 import js7.data.problems.CannotResumeOrderProblem
 import js7.data.value.Value.convenience.*
@@ -320,7 +320,7 @@ final class CancelOrdersTest
       OrderAdded(promptingWorkflow.id, order.arguments, order.scheduledFor),
       OrderStarted,
       OrderPrompted(StringValue("PROMPT")),
-      OrderInstructionReset,
+      OrderStateReset,
       OrderCancelled))
 
   private def testCancel(order: FreshOrder, workflowPosition: Option[WorkflowPosition],

js7-tests/src/test/scala/js7/tests/CycleTest.scala

@@ -25,7 +25,7 @@ import js7.data.execution.workflow.instructions.ScheduleTester
 import js7.data.item.ItemOperation.{AddOrChangeSigned, AddVersion}
 import js7.data.item.VersionId
 import js7.data.lock.{Lock, LockPath}
-import js7.data.order.OrderEvent.{LockDemand, OrderAdded, OrderAttachable, OrderAttached, OrderBroken, OrderCancellationMarked, OrderCancelled, OrderCaught, OrderCycleFinished, OrderCycleStarted, OrderCyclingPrepared, OrderDeleted, OrderDetachable, OrderDetached, OrderFailed, OrderFinished, OrderGoMarked, OrderGoes, OrderInstructionReset, OrderLocksAcquired, OrderLocksReleased, OrderMoved, OrderOutcomeAdded, OrderProcessed, OrderProcessingStarted, OrderResumed, OrderStarted, OrderStopped, OrderTerminated}
+import js7.data.order.OrderEvent.{LockDemand, OrderAdded, OrderAttachable, OrderAttached, OrderBroken, OrderCancellationMarked, OrderCancelled, OrderCaught, OrderCycleFinished, OrderCycleStarted, OrderCyclingPrepared, OrderDeleted, OrderDetachable, OrderDetached, OrderFailed, OrderFinished, OrderGoMarked, OrderGoes, OrderLocksAcquired, OrderLocksReleased, OrderMoved, OrderOutcomeAdded, OrderProcessed, OrderProcessingStarted, OrderResumed, OrderStarted, OrderStateReset, OrderStopped, OrderTerminated}
 import js7.data.order.OrderObstacle.WaitingForOtherTime
 import js7.data.order.{CycleState, FreshOrder, Order, OrderEvent, OrderId, OrderObstacle, OrderOutcome}
 import js7.data.value.expression.ExpressionParser.expr
@@ -241,7 +241,7 @@ with ControllerAgentForScalaTest with ScheduleTester with BlockingItemUpdater:
         end = local("2021-10-02T00:00"),
         index = 1,
         next = local("2021-10-01T18:00"))),
-      OrderInstructionReset,
+      OrderStateReset,
       OrderCancelled))
 
 /*
@@ -883,7 +883,7 @@ with ControllerAgentForScalaTest with ScheduleTester with BlockingItemUpdater:
           OrderResumed(Some(resumePosition)),
           OrderMoved(Position(0) / Then % 0 / resumeBranchId % 1),
           OrderCycleFinished(Some(CycleState(cycleEnd + 1.minute, index = 3, next = clock.now() + 1.s))),
-          OrderInstructionReset,
+          OrderStateReset,
           OrderCancelled,
           OrderDeleted))
     }
@@ -939,7 +939,7 @@ with ControllerAgentForScalaTest with ScheduleTester with BlockingItemUpdater:
         OrderCycleStarted,
         OrderCycleFinished(Some(CycleState(cycleEnd, index = 5, next = clock.now() + 1.h))),
 
-        OrderInstructionReset,
+        OrderStateReset,
         OrderCancelled,
         OrderDeleted))
 
@@ -1020,7 +1020,7 @@ with ControllerAgentForScalaTest with ScheduleTester with BlockingItemUpdater:
         OrderDetachable,
         //OrderCancellationMarkedOnAgent,
         OrderDetached,
-        OrderInstructionReset,
+        OrderStateReset,
         OrderCancelled,
         OrderDeleted))
 

js7-tests/src/test/scala/js7/tests/LockTest.scala

@@ -773,7 +773,7 @@ final class LockTest extends OurTestSuite, ControllerAgentForScalaTest, Blocking
       OrderAdded(queueingWorkflow.id, deleteWhenTerminated = true),
       OrderStarted,
       OrderLocksQueued(List(LockDemand(lockPath))),
-      OrderInstructionReset,
+      OrderStateReset,
       OrderCancelled,
       OrderDeleted))
 
@@ -814,7 +814,7 @@ final class LockTest extends OurTestSuite, ControllerAgentForScalaTest, Blocking
       OrderStarted,
       OrderLocksAcquired(List(LockDemand(lockPath))),
       OrderPrompted(StringValue("PROMPT")),
-      OrderInstructionReset,
+      OrderStateReset,
       OrderLocksReleased(List(lockPath)),
       OrderCancelled,
       OrderDeleted))
@@ -1095,7 +1095,7 @@ final class LockTest extends OurTestSuite, ControllerAgentForScalaTest, Blocking
             OrderStarted,
             OrderLocksAcquired(List(LockDemand(lockPath))),
             OrderPrompted(StringValue("PROMPT")),
-            OrderInstructionReset,
+            OrderStateReset,
             OrderLocksReleased(List(lockPath)),
             OrderCancelled,
             OrderDeleted))
@@ -1114,7 +1114,7 @@ final class LockTest extends OurTestSuite, ControllerAgentForScalaTest, Blocking
             OrderLocksQueued(List(LockDemand(lockPath))),
             OrderLocksAcquired(List(LockDemand(lockPath))),
             OrderPrompted(StringValue("PROMPT")),
-            OrderInstructionReset,
+            OrderStateReset,
             OrderLocksReleased(List(lockPath)),
             OrderCancelled,
             OrderDeleted))
@@ -1232,7 +1232,7 @@ final class LockTest extends OurTestSuite, ControllerAgentForScalaTest, Blocking
         OrderStarted,
         OrderLocksQueued(List(LockDemand(lock1.path))),
 
-        OrderInstructionReset,
+        OrderStateReset,
         OrderTransferred(bWorkflow2.id /: Position(0)),
         OrderLocksQueued(List(LockDemand(lock2.path))),
 

js7-tests/src/test/scala/js7/tests/TransferOrderTest.scala

@@ -14,7 +14,7 @@ import js7.data.command.SuspensionMode
 import js7.data.controller.ControllerCommand.{AnswerOrderPrompt, PostNotice, ResumeOrder, SuspendOrders, TransferOrders}
 import js7.data.item.BasicItemEvent.ItemDeleted
 import js7.data.order.OrderEvent.OrderNoticesExpected.Expected
-import js7.data.order.OrderEvent.{OrderAdded, OrderAttachable, OrderAttached, OrderDeleted, OrderDetachable, OrderDetached, OrderFinished, OrderInstructionReset, OrderMoved, OrderNoticesConsumed, OrderNoticesConsumptionStarted, OrderNoticesExpected, OrderProcessed, OrderProcessingStarted, OrderPromptAnswered, OrderPrompted, OrderStarted, OrderStdoutWritten, OrderSuspended, OrderSuspensionMarked, OrderSuspensionMarkedOnAgent, OrderTerminated, OrderTransferred}
+import js7.data.order.OrderEvent.{OrderAdded, OrderAttachable, OrderAttached, OrderDeleted, OrderDetachable, OrderDetached, OrderFinished, OrderMoved, OrderNoticesConsumed, OrderNoticesConsumptionStarted, OrderNoticesExpected, OrderProcessed, OrderProcessingStarted, OrderPromptAnswered, OrderPrompted, OrderStarted, OrderStateReset, OrderStdoutWritten, OrderSuspended, OrderSuspensionMarked, OrderSuspensionMarkedOnAgent, OrderTerminated, OrderTransferred}
 import js7.data.order.{FreshOrder, OrderEvent, OrderId, OrderOutcome}
 import js7.data.value.StringValue
 import js7.data.value.expression.ExpressionParser.expr
@@ -202,7 +202,7 @@ extends OurTestSuite, ControllerAgentForScalaTest, BlockingItemUpdater:
         OrderNoticesExpected(Vector(Expected(aBoard.path, noticeId))),
         OrderNoticesConsumptionStarted(Vector(Expected(aBoard.path, noticeId))),
         OrderPrompted(StringValue("PROMPT-1")),
-        OrderInstructionReset,
+        OrderStateReset,
         OrderTransferred(workflow3.id /: (Position(0) / "consumeNotices" % 0)),
         OrderPromptAnswered(),
         OrderMoved(Position(0) / "consumeNotices" % 1),