feat(form-builder): add FormSubmissionActionFailure model + apply_status casts (WS-6)

- FormSubmissionActionFailure: audit model, no organisation_id (FK-chain
  tenancy per RFC V3), open/resolved/dismissed scopes, canBeRetried()
  helper. Morph alias 'form_submission_action_failure' registered for
  future activity-log subject references.
- FormSubmission: apply_status (ApplyStatus enum cast),
  apply_completed_at (datetime), actionFailures() HasMany,
  scopePendingApply().

Refs: RFC-WS-6.md §3 (Q5), §4 (V3)

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
2026-04-25 22:47:06 +02:00
parent 0dd991c688
commit c5b0210ae7
6 changed files with 372 additions and 0 deletions

View File

@@ -4,6 +4,7 @@ declare(strict_types=1);
namespace App\Models\FormBuilder; namespace App\Models\FormBuilder;
use App\Enums\FormBuilder\ApplyStatus;
use App\Enums\FormBuilder\FormSubmissionReviewStatus; use App\Enums\FormBuilder\FormSubmissionReviewStatus;
use App\Enums\FormBuilder\FormSubmissionStatus; use App\Enums\FormBuilder\FormSubmissionStatus;
use App\Models\Event; use App\Models\Event;
@@ -12,6 +13,7 @@ use App\Models\Scopes\OrganisationScope;
use App\Models\User; use App\Models\User;
use Illuminate\Database\Eloquent\Concerns\HasUlids; use Illuminate\Database\Eloquent\Concerns\HasUlids;
use Illuminate\Database\Eloquent\Factories\HasFactory; use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model; use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo; use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\HasMany; use Illuminate\Database\Eloquent\Relations\HasMany;
@@ -76,6 +78,8 @@ final class FormSubmission extends Model
protected $casts = [ protected $casts = [
'status' => FormSubmissionStatus::class, 'status' => FormSubmissionStatus::class,
'review_status' => FormSubmissionReviewStatus::class, 'review_status' => FormSubmissionReviewStatus::class,
'apply_status' => ApplyStatus::class,
'apply_completed_at' => 'datetime',
'schema_snapshot' => 'array', 'schema_snapshot' => 'array',
'is_test' => 'bool', 'is_test' => 'bool',
'submitted_at' => 'datetime', 'submitted_at' => 'datetime',
@@ -134,4 +138,22 @@ final class FormSubmission extends Model
{ {
return $this->hasMany(FormSubmissionDelegation::class); return $this->hasMany(FormSubmissionDelegation::class);
} }
/** @return HasMany<FormSubmissionActionFailure, $this> */
public function actionFailures(): HasMany
{
return $this->hasMany(FormSubmissionActionFailure::class);
}
/**
* RFC-WS-6 §3 (Q4) submissions awaiting an applicator pass. Excludes
* NULL apply_status legacy rows by design (RFC O1).
*
* @param Builder<FormSubmission> $query
* @return Builder<FormSubmission>
*/
protected function scopePendingApply(Builder $query): Builder
{
return $query->where('apply_status', ApplyStatus::PENDING->value);
}
} }

View File

@@ -0,0 +1,124 @@
<?php
declare(strict_types=1);
namespace App\Models\FormBuilder;
use App\Enums\FormBuilder\DismissalReasonType;
use App\Models\User;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Concerns\HasUlids;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
/**
* RFC-WS-6 §3 (Q5) audit table for binding-pipeline failures.
*
* Audit model with no `organisation_id` column. Tenant scope flows via
* the FK chain to `form_submissions.organisation_id`. The
* {@see \App\Policies\FormBuilder\FormSubmissionActionFailurePolicy}
* enforces this at access time per RFC §4 V3 (IDOR-class FK-chain
* pattern). Do NOT register `OrganisationScope` directly on this model.
*
* Resolve and Dismiss are mutually exclusive workflows (RFC V2):
* - Resolved succeeded via another path (resolved_at + resolved_note)
* - Dismissed will not be replayed (dismissed_at + reason_type/note)
*/
final class FormSubmissionActionFailure extends Model
{
/** @use HasFactory<\Database\Factories\FormBuilder\FormSubmissionActionFailureFactory> */
use HasFactory;
use HasUlids;
protected $table = 'form_submission_action_failures';
protected $fillable = [
'form_submission_id',
'listener_class',
'binding_id',
'failed_at',
'exception_class',
'exception_message',
'context',
'retry_count',
'resolved_at',
'resolved_by_user_id',
'resolved_note',
'dismissed_at',
'dismissed_by_user_id',
'dismissed_reason_type',
'dismissed_reason_note',
];
/** @var array<string, string> */
protected $casts = [
'failed_at' => 'datetime',
'resolved_at' => 'datetime',
'dismissed_at' => 'datetime',
'context' => 'array',
'retry_count' => 'int',
'dismissed_reason_type' => DismissalReasonType::class,
];
/** @return BelongsTo<FormSubmission, $this> */
public function submission(): BelongsTo
{
return $this->belongsTo(FormSubmission::class, 'form_submission_id');
}
/** @return BelongsTo<FormFieldBinding, $this> */
public function binding(): BelongsTo
{
return $this->belongsTo(FormFieldBinding::class, 'binding_id');
}
/** @return BelongsTo<User, $this> */
public function resolvedBy(): BelongsTo
{
return $this->belongsTo(User::class, 'resolved_by_user_id');
}
/** @return BelongsTo<User, $this> */
public function dismissedBy(): BelongsTo
{
return $this->belongsTo(User::class, 'dismissed_by_user_id');
}
/**
* @param Builder<FormSubmissionActionFailure> $query
* @return Builder<FormSubmissionActionFailure>
*/
protected function scopeOpen(Builder $query): Builder
{
return $query->whereNull('resolved_at')->whereNull('dismissed_at');
}
/**
* @param Builder<FormSubmissionActionFailure> $query
* @return Builder<FormSubmissionActionFailure>
*/
protected function scopeResolved(Builder $query): Builder
{
return $query->whereNotNull('resolved_at');
}
/**
* @param Builder<FormSubmissionActionFailure> $query
* @return Builder<FormSubmissionActionFailure>
*/
protected function scopeDismissed(Builder $query): Builder
{
return $query->whereNotNull('dismissed_at');
}
public function isOpen(): bool
{
return $this->resolved_at === null && $this->dismissed_at === null;
}
public function canBeRetried(): bool
{
return $this->dismissed_at === null;
}
}

View File

@@ -230,6 +230,7 @@ class AppServiceProvider extends ServiceProvider
'form_submission' => FormSubmission::class, 'form_submission' => FormSubmission::class,
'form_submission_section_status' => FormSubmissionSectionStatus::class, 'form_submission_section_status' => FormSubmissionSectionStatus::class,
'form_submission_delegation' => FormSubmissionDelegation::class, 'form_submission_delegation' => FormSubmissionDelegation::class,
'form_submission_action_failure' => \App\Models\FormBuilder\FormSubmissionActionFailure::class,
'form_value' => FormValue::class, 'form_value' => FormValue::class,
'form_value_option' => FormValueOption::class, 'form_value_option' => FormValueOption::class,
'form_template' => FormTemplate::class, 'form_template' => FormTemplate::class,

View File

@@ -0,0 +1,56 @@
<?php
declare(strict_types=1);
namespace Database\Factories\FormBuilder;
use App\Models\FormBuilder\FormSubmission;
use App\Models\FormBuilder\FormSubmissionActionFailure;
use Illuminate\Database\Eloquent\Factories\Factory;
/** @extends Factory<FormSubmissionActionFailure> */
final class FormSubmissionActionFailureFactory extends Factory
{
protected $model = FormSubmissionActionFailure::class;
/** @return array<model-property<FormSubmissionActionFailure>, mixed> */
public function definition(): array
{
return [
'form_submission_id' => FormSubmission::factory(),
'listener_class' => 'App\\Listeners\\FormBuilder\\ApplyBindingsOnFormSubmit',
'binding_id' => null,
'failed_at' => now(),
'exception_class' => \RuntimeException::class,
'exception_message' => 'Simulated apply failure',
'context' => [
'target_entity' => 'person',
'target_attribute' => 'email',
],
'retry_count' => 0,
'resolved_at' => null,
'resolved_by_user_id' => null,
'resolved_note' => null,
'dismissed_at' => null,
'dismissed_by_user_id' => null,
'dismissed_reason_type' => null,
'dismissed_reason_note' => null,
];
}
public function resolved(): static
{
return $this->state(fn (): array => [
'resolved_at' => now(),
'resolved_note' => 'Resolved via direct edit',
]);
}
public function dismissed(): static
{
return $this->state(fn (): array => [
'dismissed_at' => now(),
'dismissed_reason_type' => \App\Enums\FormBuilder\DismissalReasonType::SCHEMA_DELETED,
]);
}
}

View File

@@ -0,0 +1,74 @@
<?php
declare(strict_types=1);
namespace Tests\Feature\FormBuilder;
use App\Enums\FormBuilder\ApplyStatus;
use App\Models\FormBuilder\FormSchema;
use App\Models\FormBuilder\FormSubmission;
use App\Models\Organisation;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Str;
use Tests\TestCase;
final class FormSubmissionApplyStatusCastTest extends TestCase
{
use RefreshDatabase;
public function test_apply_status_round_trips_as_enum(): void
{
$submission = FormSubmission::factory()->create();
$submission->apply_status = ApplyStatus::COMPLETED;
$submission->save();
$reloaded = FormSubmission::query()->find($submission->id);
$this->assertSame(ApplyStatus::COMPLETED, $reloaded->apply_status);
}
public function test_apply_status_null_round_trip(): void
{
$submission = FormSubmission::factory()->create();
$this->assertNull($submission->apply_status);
$submission->apply_status = null;
$submission->save();
$reloaded = FormSubmission::query()->find($submission->id);
$this->assertNull($reloaded->apply_status);
}
public function test_legacy_seed_row_without_apply_status_remains_null(): void
{
$organisation = Organisation::factory()->create();
$schema = FormSchema::factory()->for($organisation)->create();
$id = (string) Str::ulid();
DB::table('form_submissions')->insert([
'id' => $id,
'form_schema_id' => $schema->id,
'organisation_id' => $organisation->id,
'status' => 'submitted',
'is_test' => false,
'auto_save_count' => 0,
'created_at' => now(),
'updated_at' => now(),
]);
$reloaded = FormSubmission::query()->find($id);
$this->assertNull($reloaded->apply_status);
}
public function test_pending_apply_scope_filters_correctly(): void
{
FormSubmission::factory()->create(['apply_status' => ApplyStatus::PENDING]);
FormSubmission::factory()->create(['apply_status' => ApplyStatus::COMPLETED]);
FormSubmission::factory()->create(['apply_status' => ApplyStatus::FAILED]);
FormSubmission::factory()->create(); // null
$pending = FormSubmission::query()->pendingApply()->get();
$this->assertCount(1, $pending);
$this->assertSame(ApplyStatus::PENDING, $pending->first()->apply_status);
}
}

View File

@@ -0,0 +1,95 @@
<?php
declare(strict_types=1);
namespace Tests\Unit\Models\FormBuilder;
use App\Enums\FormBuilder\DismissalReasonType;
use App\Models\FormBuilder\FormSubmission;
use App\Models\FormBuilder\FormSubmissionActionFailure;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Support\Facades\Schema;
use Tests\TestCase;
final class FormSubmissionActionFailureTest extends TestCase
{
use RefreshDatabase;
public function test_factory_creates_row_with_sensible_defaults(): void
{
$failure = FormSubmissionActionFailure::factory()->create();
$this->assertNotEmpty($failure->id);
$this->assertSame(0, $failure->retry_count);
$this->assertNull($failure->resolved_at);
$this->assertNull($failure->dismissed_at);
$this->assertNotEmpty($failure->context);
}
public function test_submission_relation_returns_parent(): void
{
$submission = FormSubmission::factory()->create();
$failure = FormSubmissionActionFailure::factory()
->for($submission, 'submission')
->create();
$this->assertSame($submission->id, $failure->submission->id);
}
public function test_binding_relation_is_nullable(): void
{
$failure = FormSubmissionActionFailure::factory()->create();
$this->assertNull($failure->binding);
}
public function test_open_scope_excludes_resolved_and_dismissed(): void
{
FormSubmissionActionFailure::factory()->create();
FormSubmissionActionFailure::factory()->resolved()->create();
FormSubmissionActionFailure::factory()->dismissed()->create();
$this->assertSame(1, FormSubmissionActionFailure::query()->open()->count());
$this->assertSame(1, FormSubmissionActionFailure::query()->resolved()->count());
$this->assertSame(1, FormSubmissionActionFailure::query()->dismissed()->count());
}
public function test_dismissed_reason_type_round_trips_as_enum(): void
{
$failure = FormSubmissionActionFailure::factory()->create([
'dismissed_reason_type' => DismissalReasonType::DATA_QUALITY_ISSUE,
'dismissed_at' => now(),
]);
$reloaded = FormSubmissionActionFailure::query()->find($failure->id);
$this->assertSame(DismissalReasonType::DATA_QUALITY_ISSUE, $reloaded->dismissed_reason_type);
}
public function test_context_round_trips_as_array(): void
{
$failure = FormSubmissionActionFailure::factory()->create([
'context' => ['target_entity' => 'company', 'target_attribute' => 'kvk_number'],
]);
$reloaded = FormSubmissionActionFailure::query()->find($failure->id);
$this->assertSame('company', $reloaded->context['target_entity']);
}
public function test_can_be_retried_false_when_dismissed(): void
{
$open = FormSubmissionActionFailure::factory()->create();
$resolved = FormSubmissionActionFailure::factory()->resolved()->create();
$dismissed = FormSubmissionActionFailure::factory()->dismissed()->create();
$this->assertTrue($open->canBeRetried());
$this->assertTrue($resolved->canBeRetried());
$this->assertFalse($dismissed->canBeRetried());
}
public function test_table_has_no_organisation_id_column_per_rfc_v3(): void
{
$this->assertFalse(
Schema::hasColumn('form_submission_action_failures', 'organisation_id'),
'Tenant scope must flow via FK chain to form_submissions.organisation_id (RFC V3)',
);
}
}