Files
crewli/api/app/Console/Commands/RetryFormSubmissionActionFailures.php
bert.hausmans b47e096a55 feat(form-builder): retry history table + integration (WS-6)
Per-attempt retry history (timestamp, user, outcome, exception detail
if failed) replaces the counter-only retry_count tracking.

Changes:

- New `form_submission_action_failure_retry_attempts` table (cascade on
  parent delete, nullOnDelete on user). Explicit short FK names
  (`fsafra_failure_fk`, `fsafra_user_fk`) — auto-generated names exceed
  MySQL's 64-char identifier limit.
- New FormSubmissionActionFailureRetryAttempt model + factory +
  succeeded() state.
- Parent FormSubmissionActionFailure gets retryAttempts() HasMany
  relation (latest('attempted_at')).
- New FormFailureRetryService centralises the retry-flow logic. Both
  the API controller and the artisan command delegate to it. Service
  writes a retry_attempt record per attempt; parent's retry_count
  stays as denormalised cache for index-view performance.
- Successful retry: attempt(succeeded) + parent.retry_count++ +
  parent.resolved_at + parent.resolved_by_user_id + parent.resolved_note
  ("Geslaagde retry door {actor.name}" or "Geslaagde retry
  (geautomatiseerd)" for command-line invocation without an actor).
- Failed retry: attempt(failed) with NEW exception details +
  parent.retry_count++. Parent's exception_class/_message stay
  audit-immutable — they represent the FIRST failure.
- canBeRetried() now correctly checks both resolved_at AND
  dismissed_at (sessie 2's open question Q2 closure).
- New FailureNotRetriableException (controller → 422) and
  ParentSubmissionGoneException (controller → 410) for cleaner
  flow control.

12 new tests:
- FormSubmissionActionFailureRetryAttemptTest (5 unit tests)
- RetryFlowProducesRetryAttemptsTest (7 integration tests covering
  succeeded path, failed path, resolved/dismissed blocking,
  multiple-retries chronological ordering, canBeRetried truth tables)

Pre-existing tests touched:
- FormSubmissionActionFailureTest::test_can_be_retried_only_for_open_state
  — updated to reflect Q2 closure (resolved now blocks too).
- Ws6FoundationMigrationTest::test_down_methods_clean_up_columns_and_table
  — child table must drop before parent (FK constraint).
- 5 backfill test step-counts bumped +1 (new migration sits at top).

SCHEMA.md → v2.9. Schema dump regenerated.

Refs: RFC-WS-6.md §3 Q5 addendum, sessie 2 Q2

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-29 00:14:19 +02:00

122 lines
4.0 KiB
PHP

<?php
declare(strict_types=1);
namespace App\Console\Commands;
use App\Exceptions\FormBuilder\FailureNotRetriableException;
use App\Exceptions\FormBuilder\ParentSubmissionGoneException;
use App\Models\FormBuilder\FormSubmissionActionFailure;
use App\Services\FormBuilder\FormFailureRetryService;
use Illuminate\Console\Command;
use Illuminate\Database\Eloquent\Builder;
/**
* RFC-WS-6 §3 (Q5) — replay open failures via the applicator.
* Mirrors the API endpoint (Task 9). Cross-tenant safety via FK chain
* to form_submissions.organisation_id.
*/
final class RetryFormSubmissionActionFailures extends Command
{
protected $signature = 'form-failures:retry
{--id= : Specific FormSubmissionActionFailure ULID}
{--submission= : Retry all open failures for a submission}
{--org= : Retry all open failures across an organisation}
{--listener= : Filter by listener_class FQCN}
{--dry-run : List what would be retried without doing it}';
protected $description = 'Replay open FormSubmissionActionFailure rows via the applicator';
public function handle(FormFailureRetryService $retryService): int
{
if (
$this->option('id') === null
&& $this->option('submission') === null
&& $this->option('org') === null
) {
$this->error('At least one of --id, --submission, or --org is required.');
return self::FAILURE;
}
$query = $this->buildQuery();
$failures = $query->get();
if ($failures->isEmpty()) {
$this->info('No matching open failures.');
return self::SUCCESS;
}
$rows = [];
foreach ($failures as $failure) {
if ($this->option('dry-run')) {
$rows[] = ['id' => (string) $failure->id, 'submission' => (string) $failure->form_submission_id, 'result' => 'would-retry'];
continue;
}
$rows[] = $this->retryOne($failure, $retryService);
}
$this->table(['id', 'submission', 'result'], $rows);
return self::SUCCESS;
}
/**
* @return Builder<FormSubmissionActionFailure>
*/
private function buildQuery(): Builder
{
$query = FormSubmissionActionFailure::query()->open();
if (($id = $this->option('id')) !== null) {
$query->where('id', $id);
}
if (($submissionId = $this->option('submission')) !== null) {
$query->where('form_submission_id', $submissionId);
}
if (($listener = $this->option('listener')) !== null) {
$query->where('listener_class', $listener);
}
if (($org = $this->option('org')) !== null) {
// FK chain: failure → submission → organisation.
$query->whereHas('submission', function (Builder $q) use ($org): void {
/** @var Builder<\App\Models\FormBuilder\FormSubmission> $q */
$q->where('organisation_id', $org);
});
}
return $query;
}
/**
* @return array{id:string, submission:string, result:string}
*/
private function retryOne(FormSubmissionActionFailure $failure, FormFailureRetryService $retryService): array
{
try {
$result = $retryService->retry($failure);
return [
'id' => (string) $failure->id,
'submission' => (string) $failure->form_submission_id,
'result' => $result['outcome'] === 'succeeded' ? 'succeeded' : 'failed-again',
];
} catch (FailureNotRetriableException $e) {
return [
'id' => (string) $failure->id,
'submission' => (string) $failure->form_submission_id,
'result' => "skipped-{$e->reason}",
];
} catch (ParentSubmissionGoneException) {
return [
'id' => (string) $failure->id,
'submission' => (string) $failure->form_submission_id,
'result' => 'submission-gone',
];
}
}
}