bert.hausmans/crewli
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source 
- 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:
bert.hausmans
2026-04-25 22:47:06 +02:00
parent 0dd991c688
commit c5b0210ae7
6 changed files with 372 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
api/app/Models/FormBuilder/FormSubmission.php
View File

@@ -4,6 +4,7 @@ declare(strict_types=1);
namespace App\Models\FormBuilder;
use App\Enums\FormBuilder\ApplyStatus;
use App\Enums\FormBuilder\FormSubmissionReviewStatus;
use App\Enums\FormBuilder\FormSubmissionStatus;
use App\Models\Event;
@@ -12,6 +13,7 @@ use App\Models\Scopes\OrganisationScope;
use App\Models\User;
use Illuminate\Database\Eloquent\Concerns\HasUlids;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\HasMany;
@@ -76,6 +78,8 @@ final class FormSubmission extends Model
protected $casts = [
'status' => FormSubmissionStatus::class,
'review_status' => FormSubmissionReviewStatus::class,
'apply_status' => ApplyStatus::class,
'apply_completed_at' => 'datetime',
'schema_snapshot' => 'array',
'is_test' => 'bool',
'submitted_at' => 'datetime',
@@ -134,4 +138,22 @@ final class FormSubmission extends Model
{
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);
}
}

124
api/app/Models/FormBuilder/FormSubmissionActionFailure.php Normal file
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;
}
}