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

feat(form-builder): form_field_validation_rules table + polymorphic owner + scope + cascade

Browse Source
This commit is contained in:
bert.hausmans
2026-04-24 22:01:36 +02:00
parent 87fc964ead
commit fedaed1b32
17 changed files with 798 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
api/app/Enums/FormBuilder/FormFieldValidationRuleType.php Normal file
View File

@@ -0,0 +1,36 @@
<?php
declare(strict_types=1);
namespace App\Enums\FormBuilder;
/**
* Canonical catalogue of validation rule types stored relationally in
* `form_field_validation_rules` (ARCH-FORM-BUILDER §17.4). One case per
* legacy top-level key in the pre-WS-5b `validation_rules` JSON, minus
* the non-validation entries (`tag_categories`, `storage_disk` — moved
* to `form_field_configs` under ARCH §17.5) and the column-duplicates
* (`required`, `unique` — source of truth is `is_required` / `is_unique`
* on the parent row).
*
* Per-case `parameters` shape is enforced at the service layer, not by
* the enum — see `FormFieldValidationRuleService::assertSpecValid()`.
*/
enum FormFieldValidationRuleType: string
{
case MinLength = 'min_length';
case MaxLength = 'max_length';
case MinValue = 'min_value';
case MaxValue = 'max_value';
case Regex = 'regex';
case EmailFormat = 'email_format';
case UrlFormat = 'url_format';
case PhoneE164 = 'phone_e164';
case AllowedMimeTypes = 'allowed_mime_types';
case MaxFileSize = 'max_file_size';
case MinSelected = 'min_selected';
case MaxSelected = 'max_selected';
case DateMin = 'date_min';
case DateMax = 'date_max';
case Callback = 'callback';
}

5
api/app/Models/FormBuilder/FormField.php
View File

@@ -111,6 +111,11 @@ final class FormField extends Model
return $this->morphMany(FormFieldBinding::class, 'owner');
}
public function validationRules(): MorphMany
{
return $this->morphMany(FormFieldValidationRule::class, 'owner');
}
/**
* Nuanced activity log (ARCH §17.1; S1 Phase 4b). Callers choose which
* events are worth logging — e.g. created/deleted/restored, field_type

5
api/app/Models/FormBuilder/FormFieldLibrary.php
View File

@@ -69,4 +69,9 @@ final class FormFieldLibrary extends Model
{
return $this->morphMany(FormFieldBinding::class, 'owner');
}
public function validationRules(): MorphMany
{
return $this->morphMany(FormFieldValidationRule::class, 'owner');
}
}

55
api/app/Models/FormBuilder/FormFieldValidationRule.php Normal file
View File

@@ -0,0 +1,55 @@
<?php
declare(strict_types=1);
namespace App\Models\FormBuilder;
use App\Enums\FormBuilder\FormFieldValidationRuleType;
use App\Models\Scopes\FormFieldValidationRuleScope;
use Illuminate\Database\Eloquent\Concerns\HasUlids;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\MorphTo;
/**
* Relational home for what was `form_fields.validation_rules` and
* `form_field_library.validation_rules` JSON. Polymorphic owner — morph
* aliases `form_field` and `form_field_library`. See ARCH-FORM-BUILDER
* §17.4 and ARCH-CONSOLIDATION-ADDENDUM-2026-04-24 §Q3.
*
* One row per (owner, rule_type). `parameters` JSON holds the rule-type-
* specific configuration (e.g. `{ "value": 3 }` for `min_length`, or
* `{ "mime_types": [...] }` for `allowed_mime_types`). Parameter shape
* validation lives in `FormFieldValidationRuleService`, not on the model.
*/
final class FormFieldValidationRule extends Model
{
use HasFactory;
use HasUlids;
protected $table = 'form_field_validation_rules';
protected static function booted(): void
{
static::addGlobalScope(new FormFieldValidationRuleScope());
}
protected $fillable = [
'owner_type',
'owner_id',
'rule_type',
'parameters',
'error_message_key',
];
/** @var array<string, string> */
protected $casts = [
'rule_type' => FormFieldValidationRuleType::class,
'parameters' => 'array',
];
public function owner(): MorphTo
{
return $this->morphTo('owner', 'owner_type', 'owner_id');
}
}

102
api/app/Models/Scopes/FormFieldValidationRuleScope.php Normal file
View File

@@ -0,0 +1,102 @@
<?php
declare(strict_types=1);
namespace App\Models\Scopes;
use App\Models\FormBuilder\FormField;
use App\Models\FormBuilder\FormFieldLibrary;
use App\Models\FormBuilder\FormSchema;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Scope;
/**
* Multi-tenant isolation for `form_field_validation_rules`. Sibling to
* `FormFieldBindingScope` — the two share the same UNION shape over the
* polymorphic owner's two possible parents (`form_field → form_schema →
* organisation_id` ∪ `form_field_library → organisation_id`).
*
* Duplicate code with `FormFieldBindingScope` is acknowledged; base-class
* extraction is deferred to WS-5d per the architect addendum Q3 decision:
* premature abstraction from two is still premature, and WS-5d adds a
* third sibling that will make what truly varies visible.
*
* Organisation context resolution mirrors `OrganisationScope` — explicit
* override via constructor, then `organisation` / `event` route parameter
* fallbacks. CLI, queues, and unauthenticated flows skip the scope.
*
* Escape hatch:
* `FormFieldValidationRule::withoutGlobalScope(FormFieldValidationRuleScope::class)`.
*/
final class FormFieldValidationRuleScope implements Scope
{
public function __construct(
private readonly ?string $organisationId = null,
) {}
public function apply(Builder $builder, Model $model): void
{
$orgId = $this->resolveOrganisationId();
if ($orgId === null) {
return;
}
$fieldIds = FormField::query()
->withoutGlobalScope(OrganisationScope::class)
->whereIn(
'form_schema_id',
FormSchema::query()
->withoutGlobalScope(OrganisationScope::class)
->where('organisation_id', $orgId)
->select('id'),
)
->select('id');
$libraryIds = FormFieldLibrary::query()
->withoutGlobalScope(OrganisationScope::class)
->where('organisation_id', $orgId)
->select('id');
$table = $model->getTable();
$builder->where(function (Builder $outer) use ($table, $fieldIds, $libraryIds): void {
$outer->where(function (Builder $q) use ($table, $fieldIds): void {
$q->where("$table.owner_type", 'form_field')
->whereIn("$table.owner_id", $fieldIds);
})->orWhere(function (Builder $q) use ($table, $libraryIds): void {
$q->where("$table.owner_type", 'form_field_library')
->whereIn("$table.owner_id", $libraryIds);
});
});
}
private function resolveOrganisationId(): ?string
{
if ($this->organisationId !== null) {
return $this->organisationId;
}
$route = request()->route();
if ($route === null) {
return null;
}
$org = $route->parameter('organisation');
if ($org instanceof \App\Models\Organisation) {
return $org->id;
}
if (is_string($org) && $org !== '') {
return $org;
}
$event = $route->parameter('event');
if ($event instanceof \App\Models\Event) {
return $event->organisation_id;
}
return null;
}
}

29
api/app/Observers/FormBuilder/FormFieldBindingsCascadeObserver.php
View File

@@ -1,29 +0,0 @@
<?php
declare(strict_types=1);
namespace App\Observers\FormBuilder;
use App\Models\FormBuilder\FormField;
use App\Models\FormBuilder\FormFieldLibrary;
use Illuminate\Support\Facades\DB;
/**
* Cascade deletion of `form_field_bindings` rows when their polymorphic
* owner is deleted. Bindings represent current state (not historical
* intent) — they are physically deleted even when the owner is only
* soft-deleted, which matches the Q3 decision that bindings have no
* soft-delete semantic of their own.
*/
final class FormFieldBindingsCascadeObserver
{
public function deleted(FormField|FormFieldLibrary $owner): void
{
$ownerType = $owner instanceof FormField ? 'form_field' : 'form_field_library';
DB::table('form_field_bindings')
->where('owner_type', $ownerType)
->where('owner_id', $owner->getKey())
->delete();
}
}

49
api/app/Observers/FormBuilder/FormFieldChildTablesCascadeObserver.php Normal file
View File

@@ -0,0 +1,49 @@
<?php
declare(strict_types=1);
namespace App\Observers\FormBuilder;
use App\Models\FormBuilder\FormField;
use App\Models\FormBuilder\FormFieldLibrary;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Schema;
/**
* Cascades physical deletion of child rows in the three relational tables
* that hang off `form_fields` / `form_field_library`:
*
* - `form_field_bindings` (WS-5a)
* - `form_field_validation_rules` (WS-5b)
* - `form_field_configs` (WS-5b expansion; added in commit 5)
*
* Children represent current state (not historical intent) — physically
* deleted even when the owner is only soft-deleted, per addendum Q3: no
* child table in this family carries a soft-delete semantic of its own.
*
* Renamed from `FormFieldBindingsCascadeObserver` during WS-5b commit 1.
* The `Schema::hasTable` guard on the validation-rules cleanup keeps the
* observer safe when this code runs against a database where commit 1's
* migration has not yet been applied (e.g. during the migration step
* itself, where the observer is registered before the table exists).
*/
final class FormFieldChildTablesCascadeObserver
{
public function deleted(FormField|FormFieldLibrary $owner): void
{
$ownerType = $owner instanceof FormField ? 'form_field' : 'form_field_library';
$ownerId = $owner->getKey();
DB::table('form_field_bindings')
->where('owner_type', $ownerType)
->where('owner_id', $ownerId)
->delete();
if (Schema::hasTable('form_field_validation_rules')) {
DB::table('form_field_validation_rules')
->where('owner_type', $ownerType)
->where('owner_id', $ownerId)
->delete();
}
}
}

12
api/app/Providers/AppServiceProvider.php
View File

@@ -48,7 +48,7 @@ use App\Models\VolunteerAvailability;
use App\Events\FormBuilder\FormSubmissionSubmitted;
use App\Listeners\FormBuilder\SyncTagPickerSelectionsOnSubmit;
use App\Listeners\FormBuilder\TriggerPersonIdentityMatchOnFormSubmit;
use App\Observers\FormBuilder\FormFieldBindingsCascadeObserver;
use App\Observers\FormBuilder\FormFieldChildTablesCascadeObserver;
use App\Observers\FormBuilder\FormSubmissionObserver;
use App\Observers\FormBuilder\FormValueObserver;
use App\Observers\PersonObserver;
@@ -95,10 +95,12 @@ class AppServiceProvider extends ServiceProvider
FormValue::observe(FormValueObserver::class);
\App\Models\FormBuilder\FormSubmission::observe(FormSubmissionObserver::class);
// Cascade binding rows on owner delete (WS-5a). Bindings are physical
// state; deleted on soft-delete as well as hard-delete of the owner.
FormField::observe(FormFieldBindingsCascadeObserver::class);
FormFieldLibrary::observe(FormFieldBindingsCascadeObserver::class);
// Cascade binding / validation-rule / config rows on owner delete.
// Children are physical state; deleted on soft-delete as well as
// hard-delete of the owner (WS-5a bindings, WS-5b validation rules
// + configs).
FormField::observe(FormFieldChildTablesCascadeObserver::class);
FormFieldLibrary::observe(FormFieldChildTablesCascadeObserver::class);
// ARCH §31.10 — FORM-02 TAG_PICKER sync listener.
\Illuminate\Support\Facades\Event::listen(

19
api/database/factories/FormBuilder/FormFieldFactory.php
View File

@@ -7,8 +7,10 @@ namespace Database\Factories\FormBuilder;
use App\Enums\FormBuilder\FormFieldBindingMode;
use App\Enums\FormBuilder\FormFieldDisplayWidth;
use App\Enums\FormBuilder\FormFieldType;
use App\Enums\FormBuilder\FormFieldValidationRuleType;
use App\Models\FormBuilder\FormField;
use App\Models\FormBuilder\FormFieldBinding;
use App\Models\FormBuilder\FormFieldValidationRule;
use App\Models\FormBuilder\FormSchema;
use Illuminate\Database\Eloquent\Factories\Factory;
use Illuminate\Support\Str;
@@ -100,4 +102,21 @@ final class FormFieldFactory extends Factory
->create();
});
}
/**
* Attach a validation-rule row in `form_field_validation_rules` after
* the field is persisted. Replaces populating the legacy
* `validation_rules` JSON column — which WS-5b commit 5 drops.
*
* @param array<string, mixed> $parameters
*/
public function withValidationRule(FormFieldValidationRuleType $type, array $parameters): static
{
return $this->afterCreating(function (FormField $field) use ($type, $parameters): void {
FormFieldValidationRule::factory()
->forField($field)
->ofType($type, $parameters)
->create();
});
}
}

19
api/database/factories/FormBuilder/FormFieldLibraryFactory.php
View File

@@ -6,8 +6,10 @@ namespace Database\Factories\FormBuilder;
use App\Enums\FormBuilder\FormFieldBindingMode;
use App\Enums\FormBuilder\FormFieldType;
use App\Enums\FormBuilder\FormFieldValidationRuleType;
use App\Models\FormBuilder\FormFieldBinding;
use App\Models\FormBuilder\FormFieldLibrary;
use App\Models\FormBuilder\FormFieldValidationRule;
use App\Models\Organisation;
use Illuminate\Database\Eloquent\Factories\Factory;
use Illuminate\Support\Str;
@@ -71,4 +73,21 @@ final class FormFieldLibraryFactory extends Factory
->create();
});
}
/**
* Attach a validation-rule row in `form_field_validation_rules` after
* the library entry is persisted. Replaces populating the legacy
* `validation_rules` JSON column — which WS-5b commit 5 drops.
*
* @param array<string, mixed> $parameters
*/
public function withValidationRule(FormFieldValidationRuleType $type, array $parameters): static
{
return $this->afterCreating(function (FormFieldLibrary $library) use ($type, $parameters): void {
FormFieldValidationRule::factory()
->forLibrary($library)
->ofType($type, $parameters)
->create();
});
}
}

56
api/database/factories/FormBuilder/FormFieldValidationRuleFactory.php Normal file
View File

@@ -0,0 +1,56 @@
<?php
declare(strict_types=1);
namespace Database\Factories\FormBuilder;
use App\Enums\FormBuilder\FormFieldValidationRuleType;
use App\Models\FormBuilder\FormField;
use App\Models\FormBuilder\FormFieldLibrary;
use App\Models\FormBuilder\FormFieldValidationRule;
use Illuminate\Database\Eloquent\Factories\Factory;
/** @extends Factory<FormFieldValidationRule> */
final class FormFieldValidationRuleFactory extends Factory
{
protected $model = FormFieldValidationRule::class;
/** @return array<string, mixed> */
public function definition(): array
{
return [
'owner_type' => 'form_field',
'owner_id' => FormField::factory(),
'rule_type' => FormFieldValidationRuleType::MinLength->value,
'parameters' => ['value' => 3],
'error_message_key' => null,
];
}
public function forField(FormField $field): static
{
return $this->state(fn () => [
'owner_type' => 'form_field',
'owner_id' => $field->id,
]);
}
public function forLibrary(FormFieldLibrary $library): static
{
return $this->state(fn () => [
'owner_type' => 'form_field_library',
'owner_id' => $library->id,
]);
}
/**
* @param array<string, mixed> $parameters
*/
public function ofType(FormFieldValidationRuleType $type, array $parameters): static
{
return $this->state(fn () => [
'rule_type' => $type->value,
'parameters' => $parameters,
]);
}
}

47
api/database/migrations/2026_04_25_110000_create_form_field_validation_rules_table.php Normal file
View File

@@ -0,0 +1,47 @@
<?php
declare(strict_types=1);
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
/**
* WS-5b commit 1 of 5 — relational home for what was `form_fields.validation_rules`
* and `form_field_library.validation_rules` JSON. Polymorphic owner (morph
* aliases `form_field` and `form_field_library`), one row per
* (owner, rule_type) with a typed `rule_type` column and a per-rule
* `parameters` JSON bag (ARCH-CONSOLIDATION-ADDENDUM-2026-04-24 §Q3,
* ARCH-FORM-BUILDER §17.4).
*
* This commit is pure infrastructure — no backfill. The legacy JSON bag
* is migrated to rows by commit 2's backfill migration so readers and
* writers can be switched over as a second atomic step.
*/
return new class extends Migration
{
public function up(): void
{
Schema::create('form_field_validation_rules', function (Blueprint $table) {
$table->ulid('id')->primary();
$table->string('owner_type', 40);
$table->ulid('owner_id');
$table->string('rule_type', 40);
$table->json('parameters');
$table->string('error_message_key', 100)->nullable();
$table->timestamps();
$table->unique(
['owner_type', 'owner_id', 'rule_type'],
'ffvr_owner_rule_unique',
);
$table->index('rule_type', 'ffvr_rule_idx');
$table->index(['owner_type', 'owner_id'], 'ffvr_owner_idx');
});
}
public function down(): void
{
Schema::dropIfExists('form_field_validation_rules');
}
};

15
api/tests/Feature/FormBuilder/Bindings/FormFieldBindingMigrationTest.php
View File

@@ -33,8 +33,9 @@ final class FormFieldBindingMigrationTest extends TestCase
public function test_forward_migrations_backfill_rows_from_both_json_sources(): void
{
// Roll back: drop_binding_json_columns → create_form_field_bindings.
$this->artisan('migrate:rollback', ['--step' => 2])->assertSuccessful();
// Roll back: create_form_field_validation_rules_table (WS-5b commit 1)
// → drop_binding_json_columns → create_form_field_bindings.
$this->artisan('migrate:rollback', ['--step' => 3])->assertSuccessful();
$this->assertFalse(Schema::hasTable('form_field_bindings'));
$this->assertTrue(Schema::hasColumn('form_fields', 'binding'));
$this->assertTrue(Schema::hasColumn('form_field_library', 'default_binding'));
@@ -95,7 +96,9 @@ final class FormFieldBindingMigrationTest extends TestCase
public function test_rollback_reconstructs_json_and_drops_table(): void
{
$this->artisan('migrate:rollback', ['--step' => 2])->assertSuccessful();
// Walk back: validation-rules table (WS-5b commit 1) →
// drop_binding_json_columns → create_form_field_bindings.
$this->artisan('migrate:rollback', ['--step' => 3])->assertSuccessful();
[$fieldAId, , ] = $this->seedFieldsWithBindingJson();
[$libAId, ] = $this->seedLibraryWithBindingJson();
@@ -105,6 +108,12 @@ final class FormFieldBindingMigrationTest extends TestCase
$this->assertFalse(Schema::hasColumn('form_fields', 'binding'));
$this->assertSame(5, DB::table('form_field_bindings')->count());
// Step back over WS-5b validation-rules table → irrelevant to the
// binding contract, but restores the pre-WS-5b state.
$this->artisan('migrate:rollback', ['--step' => 1])->assertSuccessful();
$this->assertFalse(Schema::hasTable('form_field_validation_rules'));
$this->assertTrue(Schema::hasTable('form_field_bindings'));
// Step back over drop_binding_json_columns → columns reappear empty.
$this->artisan('migrate:rollback', ['--step' => 1])->assertSuccessful();
$this->assertTrue(Schema::hasColumn('form_fields', 'binding'));

124
api/tests/Feature/FormBuilder/ValidationRules/FormFieldValidationRuleCascadeTest.php Normal file
View File

@@ -0,0 +1,124 @@
<?php
declare(strict_types=1);
namespace Tests\Feature\FormBuilder\ValidationRules;
use App\Models\FormBuilder\FormField;
use App\Models\FormBuilder\FormFieldBinding;
use App\Models\FormBuilder\FormFieldLibrary;
use App\Models\FormBuilder\FormFieldValidationRule;
use App\Models\FormBuilder\FormSchema;
use App\Models\Organisation;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Tests\TestCase;
/**
* Asserts that the renamed `FormFieldChildTablesCascadeObserver` cleans up
* validation-rule rows alongside binding rows when the owner is deleted.
*/
final class FormFieldValidationRuleCascadeTest extends TestCase
{
use RefreshDatabase;
public function test_soft_delete_of_field_cascades_validation_rules(): void
{
$org = Organisation::factory()->create();
$schema = FormSchema::factory()->create(['organisation_id' => $org->id]);
$field = FormField::factory()->create(['form_schema_id' => $schema->id]);
FormFieldValidationRule::factory()->forField($field)->create();
FormFieldValidationRule::factory()
->forField($field)
->ofType(\App\Enums\FormBuilder\FormFieldValidationRuleType::MaxLength, ['value' => 10])
->create();
$this->assertSame(2, FormFieldValidationRule::query()
->withoutGlobalScopes()
->where('owner_type', 'form_field')
->where('owner_id', $field->id)
->count(),
);
$field->delete(); // soft delete on FormField
$this->assertSame(0, FormFieldValidationRule::query()
->withoutGlobalScopes()
->where('owner_type', 'form_field')
->where('owner_id', $field->id)
->count(),
);
}
public function test_delete_of_library_entry_cascades_validation_rules(): void
{
$org = Organisation::factory()->create();
$library = FormFieldLibrary::factory()->create(['organisation_id' => $org->id]);
FormFieldValidationRule::factory()->forLibrary($library)->create();
$this->assertSame(1, FormFieldValidationRule::query()
->withoutGlobalScopes()
->where('owner_type', 'form_field_library')
->where('owner_id', $library->id)
->count(),
);
$library->delete();
$this->assertSame(0, FormFieldValidationRule::query()
->withoutGlobalScopes()
->where('owner_type', 'form_field_library')
->where('owner_id', $library->id)
->count(),
);
}
public function test_deleting_one_field_does_not_cascade_others(): void
{
$org = Organisation::factory()->create();
$schema = FormSchema::factory()->create(['organisation_id' => $org->id]);
$a = FormField::factory()->create(['form_schema_id' => $schema->id]);
$b = FormField::factory()->create(['form_schema_id' => $schema->id]);
FormFieldValidationRule::factory()->forField($a)->create();
FormFieldValidationRule::factory()->forField($b)->create();
$a->delete();
$this->assertSame(1, FormFieldValidationRule::query()
->withoutGlobalScopes()
->where('owner_type', 'form_field')
->where('owner_id', $b->id)
->count(),
);
}
public function test_cascade_observer_also_cleans_up_bindings_on_same_owner(): void
{
// Regression guard after renaming the observer: the combined
// observer must still clean up binding rows (WS-5a responsibility)
// not only validation rules (WS-5b addition).
$org = Organisation::factory()->create();
$schema = FormSchema::factory()->create(['organisation_id' => $org->id]);
$field = FormField::factory()->create(['form_schema_id' => $schema->id]);
FormFieldBinding::factory()->forField($field)->entityOwned('person', 'email')->create();
FormFieldValidationRule::factory()->forField($field)->create();
$field->delete();
$this->assertSame(0, FormFieldBinding::query()
->withoutGlobalScopes()
->where('owner_type', 'form_field')
->where('owner_id', $field->id)
->count(),
);
$this->assertSame(0, FormFieldValidationRule::query()
->withoutGlobalScopes()
->where('owner_type', 'form_field')
->where('owner_id', $field->id)
->count(),
);
}
}

111
api/tests/Feature/FormBuilder/ValidationRules/FormFieldValidationRuleRelationTest.php Normal file
View File

@@ -0,0 +1,111 @@
<?php
declare(strict_types=1);
namespace Tests\Feature\FormBuilder\ValidationRules;
use App\Enums\FormBuilder\FormFieldValidationRuleType;
use App\Models\FormBuilder\FormField;
use App\Models\FormBuilder\FormFieldLibrary;
use App\Models\FormBuilder\FormFieldValidationRule;
use App\Models\FormBuilder\FormSchema;
use App\Models\Organisation;
use Illuminate\Database\Eloquent\Relations\Relation;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Tests\TestCase;
final class FormFieldValidationRuleRelationTest extends TestCase
{
use RefreshDatabase;
public function test_field_morph_many_validation_rules_loads_all(): void
{
$org = Organisation::factory()->create();
$schema = FormSchema::factory()->create(['organisation_id' => $org->id]);
$field = FormField::factory()->create(['form_schema_id' => $schema->id]);
FormFieldValidationRule::factory()
->forField($field)
->ofType(FormFieldValidationRuleType::MinLength, ['value' => 2])
->create();
FormFieldValidationRule::factory()
->forField($field)
->ofType(FormFieldValidationRuleType::MaxLength, ['value' => 40])
->create();
$rules = $field->fresh()->validationRules;
$this->assertCount(2, $rules);
$types = $rules->pluck('rule_type.value')->sort()->values()->all();
$this->assertSame(['max_length', 'min_length'], $types);
}
public function test_library_morph_many_validation_rules_loads_all(): void
{
$org = Organisation::factory()->create();
$library = FormFieldLibrary::factory()->create(['organisation_id' => $org->id]);
FormFieldValidationRule::factory()
->forLibrary($library)
->ofType(FormFieldValidationRuleType::Regex, ['pattern' => '/^[0-9]+$/'])
->create();
$rules = $library->fresh()->validationRules;
$this->assertCount(1, $rules);
$this->assertSame(FormFieldValidationRuleType::Regex, $rules->first()->rule_type);
$this->assertSame(['pattern' => '/^[0-9]+$/'], $rules->first()->parameters);
}
public function test_owner_morphto_returns_correct_concrete_model(): void
{
$org = Organisation::factory()->create();
$schema = FormSchema::factory()->create(['organisation_id' => $org->id]);
$field = FormField::factory()->create(['form_schema_id' => $schema->id]);
$library = FormFieldLibrary::factory()->create(['organisation_id' => $org->id]);
$fieldRule = FormFieldValidationRule::factory()->forField($field)->create();
$libraryRule = FormFieldValidationRule::factory()->forLibrary($library)->create();
$this->assertInstanceOf(FormField::class, $fieldRule->fresh()->owner);
$this->assertSame($field->id, $fieldRule->fresh()->owner->id);
$this->assertInstanceOf(FormFieldLibrary::class, $libraryRule->fresh()->owner);
$this->assertSame($library->id, $libraryRule->fresh()->owner->id);
}
public function test_morph_aliases_form_field_and_form_field_library_are_registered(): void
{
// Morph-map alignment guard — both aliases need to resolve for the
// polymorphic `owner` relation on the validation-rule rows. Reuses
// the aliases WS-5a registered for bindings; this test protects
// against an accidental rename in AppServiceProvider.
$morphMap = Relation::morphMap();
$this->assertArrayHasKey('form_field', $morphMap);
$this->assertSame(FormField::class, $morphMap['form_field']);
$this->assertArrayHasKey('form_field_library', $morphMap);
$this->assertSame(FormFieldLibrary::class, $morphMap['form_field_library']);
}
public function test_parameters_roundtrip_through_json_cast(): void
{
$org = Organisation::factory()->create();
$schema = FormSchema::factory()->create(['organisation_id' => $org->id]);
$field = FormField::factory()->create(['form_schema_id' => $schema->id]);
$rule = FormFieldValidationRule::factory()
->forField($field)
->ofType(FormFieldValidationRuleType::AllowedMimeTypes, [
'mime_types' => ['image/jpeg', 'image/png'],
])
->create();
$fresh = $rule->fresh();
$this->assertSame(
['mime_types' => ['image/jpeg', 'image/png']],
$fresh->parameters,
);
$this->assertSame(
FormFieldValidationRuleType::AllowedMimeTypes,
$fresh->rule_type,
);
}
}

80
api/tests/Feature/FormBuilder/ValidationRules/FormFieldValidationRuleScopeTest.php Normal file
View File

@@ -0,0 +1,80 @@
<?php
declare(strict_types=1);
namespace Tests\Feature\FormBuilder\ValidationRules;
use App\Models\FormBuilder\FormField;
use App\Models\FormBuilder\FormFieldLibrary;
use App\Models\FormBuilder\FormFieldValidationRule;
use App\Models\FormBuilder\FormSchema;
use App\Models\Organisation;
use App\Models\Scopes\FormFieldValidationRuleScope;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Routing\Route;
use Tests\TestCase;
/**
* Asserts `FormFieldValidationRuleScope` isolates rules per organisation
* across both owner types (form_field and form_field_library) and that
* the `withoutGlobalScope` escape hatch exposes cross-org rows. Sibling
* coverage to `FormFieldBindingScopeTest`.
*/
final class FormFieldValidationRuleScopeTest extends TestCase
{
use RefreshDatabase;
public function test_scope_isolates_rules_per_organisation_for_both_owner_types(): void
{
[$orgA, $fieldA, $libraryA] = $this->seedOrgWithRules();
[$orgB, $fieldB, $libraryB] = $this->seedOrgWithRules();
$this->withOrgRoute($orgA);
$ownerIdsA = FormFieldValidationRule::query()->pluck('owner_id')->sort()->values()->all();
$expectedA = collect([$fieldA->id, $libraryA->id])->sort()->values()->all();
$this->assertSame($expectedA, $ownerIdsA);
$this->withOrgRoute($orgB);
$ownerIdsB = FormFieldValidationRule::query()->pluck('owner_id')->sort()->values()->all();
$expectedB = collect([$fieldB->id, $libraryB->id])->sort()->values()->all();
$this->assertSame($expectedB, $ownerIdsB);
}
public function test_without_global_scope_exposes_cross_org(): void
{
[$orgA, , ] = $this->seedOrgWithRules();
$this->seedOrgWithRules();
$this->withOrgRoute($orgA);
$this->assertSame(
4,
FormFieldValidationRule::query()
->withoutGlobalScope(FormFieldValidationRuleScope::class)
->count(),
);
$this->assertSame(2, FormFieldValidationRule::query()->count());
}
/** @return array{0:Organisation,1:FormField,2:FormFieldLibrary} */
private function seedOrgWithRules(): array
{
$org = Organisation::factory()->create();
$schema = FormSchema::factory()->create(['organisation_id' => $org->id]);
$field = FormField::factory()->create(['form_schema_id' => $schema->id]);
$library = FormFieldLibrary::factory()->create(['organisation_id' => $org->id]);
FormFieldValidationRule::factory()->forField($field)->create();
FormFieldValidationRule::factory()->forLibrary($library)->create();
return [$org, $field, $library];
}
private function withOrgRoute(Organisation $org): void
{
$route = new Route(['GET'], '/_test', static fn () => null);
$route->bind(request());
$route->setParameter('organisation', $org);
request()->setRouteResolver(static fn () => $route);
}
}

71
api/tests/Unit/Enums/FormBuilder/FormFieldValidationRuleTypeEnumTest.php Normal file
View File

@@ -0,0 +1,71 @@
<?php
declare(strict_types=1);
namespace Tests\Unit\Enums\FormBuilder;
use App\Enums\FormBuilder\FormFieldValidationRuleType;
use PHPUnit\Framework\TestCase;
/**
* Guard: the enum is the canonical catalogue. If a rule_type string is
* added to the catalogue in docs/code elsewhere, the corresponding case
* MUST exist here. New catalogue entries are reviewed architecturally —
* this test is the compile-time pairing.
*/
final class FormFieldValidationRuleTypeEnumTest extends TestCase
{
public function test_catalogue_contains_every_documented_case(): void
{
$expected = [
'min_length',
'max_length',
'min_value',
'max_value',
'regex',
'email_format',
'url_format',
'phone_e164',
'allowed_mime_types',
'max_file_size',
'min_selected',
'max_selected',
'date_min',
'date_max',
'callback',
];
$actual = array_map(
static fn (FormFieldValidationRuleType $c): string => $c->value,
FormFieldValidationRuleType::cases(),
);
sort($expected);
sort($actual);
$this->assertSame($expected, $actual);
}
public function test_from_string_roundtrip_matches_value(): void
{
foreach (FormFieldValidationRuleType::cases() as $case) {
$this->assertSame(
$case,
FormFieldValidationRuleType::from($case->value),
);
}
}
public function test_tryfrom_unknown_key_returns_null(): void
{
// Explicit: legacy keys that were NOT migrated to the enum must not
// silently resolve. These come from the Phase A seed scan.
$this->assertNull(FormFieldValidationRuleType::tryFrom('required'));
$this->assertNull(FormFieldValidationRuleType::tryFrom('unique'));
$this->assertNull(FormFieldValidationRuleType::tryFrom('max_priorities'));
$this->assertNull(FormFieldValidationRuleType::tryFrom('tag_categories'));
$this->assertNull(FormFieldValidationRuleType::tryFrom('storage_disk'));
// Legacy ambiguous keys that need field-type dispatch at backfill:
$this->assertNull(FormFieldValidationRuleType::tryFrom('min'));
$this->assertNull(FormFieldValidationRuleType::tryFrom('max'));
}
}