Deprecate InterruptManagerInterface::createInterrupt() and InterruptRequiredException::$interrupt (#3591539) · Issues · project / flowdrop

Deprecate InterruptManagerInterface::createInterrupt() and InterruptRequiredException::$interrupt

>>> [!note] Migrated issue   Reported by: [d34dman](https://www.drupal.org/user/751698) >>> <h2>Summary </h2> Two surfaces on <code>flowdrop_interrupt</code> are deprecated in <code>1.4.0</code> and will be removed in <code>2.0.0</code>: <ol> <li><code>\Drupal\flowdrop_interrupt\Service\InterruptManagerInterface::createInterrupt()</code></li> <li><code>\Drupal\flowdrop_interrupt\Exception\InterruptRequiredException::$interrupt</code> (public readonly property)</li> </ol> <h2>Why</h2> Interrupts now flow through a message bus. A node processor throws InterruptRequiredException with an InterruptMessage DTO, and the catch-side subscriber persists the entity and dispatches it on JobInterruptCaughtEvent. The synchronous createInterrupt() method and the entity-only $interrupt property predate that design. Before (1.3.x) <pre>// Creating an interrupt synchronously. $interrupt = $interruptManager->createInterrupt(   InterruptType::Confirmation,   $workflowId,   $nodeId,   'Approve?',   schema: ['type' => 'boolean', 'presentation' => 'confirmation'],   pipeline_id: $pipelineId, ); throw new InterruptRequiredException($interrupt); // Reading the entity off the exception. try {   // ... } catch (InterruptRequiredException $e) {   $entity = $e->interrupt; }</pre> After (1.4.x+) <pre>// Preferred: throw with a message DTO and let the bus persist it. throw new InterruptRequiredException(new HitlInterruptMessage(   message: 'Approve?',   schema: ['type' => 'boolean', 'presentation' => 'confirmation'], )); // Or, for code that must create synchronously, use the factory. $interrupt = $interruptFactory->create(new InterruptCreationData(   type: InterruptType::Confirmation,   workflowId: $workflowId,   nodeId: $nodeId,   message: 'Approve?',   schema: ['type' => 'boolean', 'presentation' => 'confirmation'],   pipelineId: $pipelineId, )); // Reading the entity off the exception. try {   // ... } catch (InterruptRequiredException $e) {   $entity = $e->getInterrupt();          // entity-shape, or NULL for message-shape   $message = $e->getInterruptMessage();  // message DTO, or NULL for entity-shape }</pre><h2>Notes</h2> <ul> <li>Calling createInterrupt() triggers E_USER_DEPRECATED. Reading $exception->interrupt does not (PHP can't intercept readonly property reads); rely on the @deprecated annotation and static analysis to surface it.</li> <li>The 1.3.0 createInterrupt() signature is preserved exactly, so call sites do not need updating to keep working in 1.4.x.</li> <li>Plan to migrate before 2.0.0.</li> </ul>

issue