Skip to content

Handle workflow step handler exceptions #337

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chubes4 merged 2 commits into from
Jun 18, 2026
+50 −4
Merged

Handle workflow step handler exceptions #337

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d91d36b
Handle workflow step handler exceptions
chubes4 Jun 18, 2026
eb9f4da
Fix workflow smoke ability stub metadata
chubes4 Jun 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 19 additions & 4 deletions src/Workflows/class-wp-agent-workflow-step-executor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,25 @@ public function execute( array $step, WP_Agent_Workflow_Run_Context $context ):
}

$context_array = $context->to_array();
$resolved = 'foreach' === $type
? self::expand_foreach_outer_step( $step, $context_array )
: WP_Agent_Workflow_Bindings::expand( $step, $context_array );
$step_output = call_user_func( $handler, $resolved, $context_array );
try {
$resolved = 'foreach' === $type
? self::expand_foreach_outer_step( $step, $context_array )
: WP_Agent_Workflow_Bindings::expand( $step, $context_array );
$step_output = call_user_func( $handler, $resolved, $context_array );
} catch ( \Throwable $throwable ) {
$record['status'] = WP_Agent_Workflow_Run_Result::STATUS_FAILED;
$record['ended_at'] = time();
$record['error'] = array(
'code' => 'handler_exception',
'error_type' => 'handler_exception',
'message' => $throwable->getMessage(),
'data' => array(
'exception' => get_class( $throwable ),
),
);

return $record;
}

if ( is_wp_error( $step_output ) ) {
$record['status'] = WP_Agent_Workflow_Run_Result::STATUS_FAILED;
Expand Down
31 changes: 31 additions & 0 deletions tests/workflow-runner-smoke.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ function workflow_runner_smoke_register_ability( string $name, \Closure $handler
$GLOBALS['__abilities'][ $name ] = new WP_Ability(
$name,
array(
'label' => $name,
'description' => 'Workflow runner smoke stub.',
'input_schema' => array( 'type' => 'object' ),
'execute_callback' => $handler,
)
Expand Down Expand Up @@ -331,6 +333,35 @@ static function ( array $input ): \WP_Error {
smoke_assert( 1, count( $result2->get_steps() ), 'short-circuit stops at first failure', $failures, $passes );
smoke_assert( 'demo_bang', $result2->get_error()['code'], 'top-level error carries failed step code', $failures, $passes );

// ─── Throwing step handlers become failed terminal run records ─────────

add_filter( 'wp_agent_workflow_known_step_types', static fn( $types ) => array_merge( (array) $types, array( 'throwing' ) ) );

$throwing_spec = WP_Agent_Workflow_Spec::from_array(
array(
'id' => 'demo/throwing-handler',
'steps' => array(
array( 'id' => 'explode', 'type' => 'throwing' ),
),
)
);

$throwing_recorder = new Capture_Recorder();
$throwing_result = ( new WP_Agent_Workflow_Runner(
$throwing_recorder,
array(
'throwing' => static function (): array {
throw new \RuntimeException( 'handler exploded' );
},
)
) )->run( $throwing_spec );
$throwing_last = end( $throwing_recorder->writes );

smoke_assert( WP_Agent_Workflow_Run_Result::STATUS_FAILED, $throwing_result->get_status(), 'handler exception fails run', $failures, $passes );
smoke_assert( 'handler_exception', $throwing_result->get_error()['code'] ?? '', 'handler exception uses expected error code', $failures, $passes );
smoke_assert( 'handler_exception', $throwing_result->get_steps()[0]['error']['error_type'] ?? '', 'handler exception records expected error_type', $failures, $passes );
smoke_assert( WP_Agent_Workflow_Run_Result::STATUS_FAILED, $throwing_last['status'] ?? '', 'recorder receives terminal failed update for handler exception', $failures, $passes );

// ─── continue_on_error keeps running ─────────────────────────────────

$result3 = ( new WP_Agent_Workflow_Runner( null ) )->run( $bad_spec, array(), array( 'continue_on_error' => true ) );
Expand Down
Loading