feat(form-builder): retry/resolve/dismiss artisan commands (WS-6)
Three CLI commands for ops use, mirroring the API endpoints in Task 9: - form-failures:retry (id|submission|org filter, --dry-run) - form-failures:resolve (single id, optional note) - form-failures:dismiss (single id, DismissalReasonType + note) Cross-tenant isolation enforced via form_submissions.organisation_id FK chain (RFC V3). retry_count incremented on retry; failure history preserved (new row on repeat failure, not in-place mutation). Refs: RFC-WS-6.md §3 (Q5), §4 (V2, V3) Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,77 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Console\Commands;
|
||||
|
||||
use App\Enums\FormBuilder\DismissalReasonType;
|
||||
use App\Models\FormBuilder\FormSubmissionActionFailure;
|
||||
use Illuminate\Console\Command;
|
||||
|
||||
/**
|
||||
* RFC-WS-6 §3 (Q5) + §4 (V2) — typed-reason dismiss action.
|
||||
* Bulk dismiss via API only.
|
||||
*/
|
||||
final class DismissFormSubmissionActionFailures extends Command
|
||||
{
|
||||
protected $signature = 'form-failures:dismiss
|
||||
{id : FormSubmissionActionFailure ULID}
|
||||
{--reason= : DismissalReasonType value (e.g. schema_deleted, other)}
|
||||
{--note= : Required when --reason=other}';
|
||||
|
||||
protected $description = 'Dismiss a single FormSubmissionActionFailure with a typed reason';
|
||||
|
||||
public function handle(): int
|
||||
{
|
||||
$id = (string) $this->argument('id');
|
||||
$reasonInput = $this->option('reason');
|
||||
$note = $this->option('note');
|
||||
|
||||
if ($reasonInput === null) {
|
||||
$this->error('--reason is required. Allowed: ' . implode(', ', array_map(static fn (DismissalReasonType $r): string => $r->value, DismissalReasonType::cases())));
|
||||
|
||||
return self::FAILURE;
|
||||
}
|
||||
|
||||
$reason = DismissalReasonType::tryFrom((string) $reasonInput);
|
||||
if ($reason === null) {
|
||||
$this->error("Unknown reason '{$reasonInput}'.");
|
||||
|
||||
return self::FAILURE;
|
||||
}
|
||||
|
||||
if ($reason->requiresNote() && empty($note)) {
|
||||
$this->error("--note is required when --reason={$reason->value}.");
|
||||
|
||||
return self::FAILURE;
|
||||
}
|
||||
|
||||
$failure = FormSubmissionActionFailure::query()->withoutGlobalScopes()->find($id);
|
||||
if ($failure === null) {
|
||||
$this->error("Failure {$id} not found.");
|
||||
|
||||
return self::FAILURE;
|
||||
}
|
||||
|
||||
if ($failure->resolved_at !== null) {
|
||||
$this->warn("Failure {$id} already resolved; cannot dismiss.");
|
||||
|
||||
return self::SUCCESS;
|
||||
}
|
||||
|
||||
if ($failure->dismissed_at !== null) {
|
||||
$this->warn("Failure {$id} already dismissed; no-op.");
|
||||
|
||||
return self::SUCCESS;
|
||||
}
|
||||
|
||||
$failure->dismissed_at = now();
|
||||
$failure->dismissed_reason_type = $reason;
|
||||
$failure->dismissed_reason_note = $note !== null ? (string) $note : null;
|
||||
$failure->save();
|
||||
|
||||
$this->info("Dismissed failure {$id} ({$reason->value}).");
|
||||
|
||||
return self::SUCCESS;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,58 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Console\Commands;
|
||||
|
||||
use App\Models\FormBuilder\FormSubmissionActionFailure;
|
||||
use Illuminate\Console\Command;
|
||||
|
||||
/**
|
||||
* RFC-WS-6 §3 (Q5) + §4 (V2) — single-id resolve action.
|
||||
* Bulk resolve via API only (audit-trail concern).
|
||||
*/
|
||||
final class ResolveFormSubmissionActionFailures extends Command
|
||||
{
|
||||
protected $signature = 'form-failures:resolve
|
||||
{id : FormSubmissionActionFailure ULID}
|
||||
{--note= : Optional resolution note}';
|
||||
|
||||
protected $description = 'Mark a single FormSubmissionActionFailure as resolved';
|
||||
|
||||
public function handle(): int
|
||||
{
|
||||
$id = (string) $this->argument('id');
|
||||
$note = $this->option('note');
|
||||
|
||||
$failure = FormSubmissionActionFailure::query()->withoutGlobalScopes()->find($id);
|
||||
if ($failure === null) {
|
||||
$this->error("Failure {$id} not found.");
|
||||
|
||||
return self::FAILURE;
|
||||
}
|
||||
|
||||
if ($failure->resolved_at !== null) {
|
||||
$this->warn("Failure {$id} already resolved at {$failure->resolved_at}; no-op.");
|
||||
|
||||
return self::SUCCESS;
|
||||
}
|
||||
|
||||
if ($failure->dismissed_at !== null) {
|
||||
$this->warn("Failure {$id} already dismissed at {$failure->dismissed_at}; cannot resolve.");
|
||||
|
||||
return self::SUCCESS;
|
||||
}
|
||||
|
||||
if (! $this->confirm("Resolve failure {$id}?", true)) {
|
||||
return self::SUCCESS;
|
||||
}
|
||||
|
||||
$failure->resolved_at = now();
|
||||
$failure->resolved_note = $note !== null ? (string) $note : null;
|
||||
$failure->save();
|
||||
|
||||
$this->info("Resolved failure {$id}.");
|
||||
|
||||
return self::SUCCESS;
|
||||
}
|
||||
}
|
||||
142
api/app/Console/Commands/RetryFormSubmissionActionFailures.php
Normal file
142
api/app/Console/Commands/RetryFormSubmissionActionFailures.php
Normal file
@@ -0,0 +1,142 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Console\Commands;
|
||||
|
||||
use App\Enums\FormBuilder\ApplyStatus;
|
||||
use App\FormBuilder\Bindings\FormBindingApplicator;
|
||||
use App\Models\FormBuilder\FormSubmission;
|
||||
use App\Models\FormBuilder\FormSubmissionActionFailure;
|
||||
use Illuminate\Console\Command;
|
||||
use Illuminate\Database\Eloquent\Builder;
|
||||
use Illuminate\Support\Facades\DB;
|
||||
use Throwable;
|
||||
|
||||
/**
|
||||
* 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(FormBindingApplicator $applicator): 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, $applicator);
|
||||
}
|
||||
|
||||
$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, FormBindingApplicator $applicator): array
|
||||
{
|
||||
$submission = FormSubmission::query()->withoutGlobalScopes()->find($failure->form_submission_id);
|
||||
if ($submission === null) {
|
||||
return ['id' => (string) $failure->id, 'submission' => (string) $failure->form_submission_id, 'result' => 'submission-gone'];
|
||||
}
|
||||
|
||||
try {
|
||||
DB::transaction(function () use ($applicator, $submission): void {
|
||||
$result = $applicator->apply($submission);
|
||||
FormSubmission::query()
|
||||
->whereKey($submission->id)
|
||||
->update([
|
||||
'apply_status' => $result->applyStatus()->value,
|
||||
'apply_completed_at' => now(),
|
||||
]);
|
||||
});
|
||||
$failure->retry_count = (int) $failure->retry_count + 1;
|
||||
$failure->resolved_at = now();
|
||||
$failure->save();
|
||||
|
||||
return ['id' => (string) $failure->id, 'submission' => (string) $submission->id, 'result' => 'succeeded'];
|
||||
} catch (Throwable $e) {
|
||||
// Append a NEW row preserving history, increment retry_count on original.
|
||||
DB::transaction(function () use ($failure, $submission, $e): void {
|
||||
FormSubmissionActionFailure::query()->create([
|
||||
'form_submission_id' => $submission->id,
|
||||
'listener_class' => $failure->listener_class,
|
||||
'failed_at' => now(),
|
||||
'exception_class' => $e::class,
|
||||
'exception_message' => $e->getMessage(),
|
||||
'context' => ['retry_of' => (string) $failure->id],
|
||||
]);
|
||||
FormSubmissionActionFailure::query()
|
||||
->whereKey($failure->id)
|
||||
->update(['retry_count' => (int) $failure->retry_count + 1]);
|
||||
FormSubmission::query()
|
||||
->whereKey($submission->id)
|
||||
->update(['apply_status' => ApplyStatus::FAILED->value]);
|
||||
});
|
||||
|
||||
return ['id' => (string) $failure->id, 'submission' => (string) $submission->id, 'result' => 'failed-again'];
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user