Files
crewli/api/tests/Feature/FormBuilder/Options/FormFieldResourceOptionsTest.php
bert.hausmans bb9242fd6e refactor(form-field): resources + snapshot + validator read form_field_options
Atomic reader switch. All call paths that previously read
form_fields.options / form_field_library.options from the JSON column
now read through FormFieldOptionService::toJsonShape() via the
morphMany relation:

  - FormFieldResource + FormFieldLibraryResource +
    PublicFormSchemaResource emit the rich-shape array
  - FilterRegistryController emits rich shape uniformly (no flat-array
    carve-out for filter-UI compatibility — preflight scan confirmed
    zero portal/app consumers, S5 territory)
  - FormFieldRuleBuilder plucks values from the relation for in:options
    rule construction
  - FormSubmissionService::buildSnapshot writes rich-shape options into
    snapshots and strips translations.{locale}.options from each field's
    translations bag (defensive — commit 2 backfill already did the
    bulk strip)
  - Four FormFieldRequest variants accept array-of-spec-objects,
    validate shape in after() via FormFieldOptionService::assertSpecsValid,
    and hand off to FormFieldOptionService::replaceOptions for writes
  - FormFieldService::create + update extract option specs from the
    request data and route through the service after the FormField row
    is persisted

FormField and FormFieldLibrary $casts no longer include 'options'; the
JSON column is no longer cast. Options removed from $fillable on both
models so ::create() / ::fill() / mass assignment can no longer touch
the legacy column. Both models gain a getOptionsAttribute() accessor
that resolves $model->options to the eager-loaded morphMany collection
— required because Eloquent's getAttribute() prefers a real DB column
over a relation method, and the JSON column lives on the table until
WS-5d commit 5 drops it.

Activity log — dual emit per §6.7 / §17.4.2 / §17.6.3:
  - field.updated carries old.options / new.options diff via
    toJsonShape() reconstruction, byte-equal JSON compare to avoid
    cosmetic false positives. Field updates that don't touch options
    omit the key entirely
  - field.options_replaced emits inside replaceOptions() on FormField
    subject only; library subject writes silent (mirrors the WS-5b /
    WS-5c convention)

JSON columns (form_fields.options, form_field_library.options) remain
present but unread — column drops land atomically in commit 5.

Two pre-existing test fixtures that seeded options via the JSON column
(FormFieldApiTest + PublicFormValidationTest) migrated to the
spec-array path: FormField::factory()->withOptions([...]) where the
options live on the field, or explicit spec-array request bodies for
HTTP tests.

Tests: 1193 → 1206 green (+13 tests / +28 assertions).

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

127 lines
4.6 KiB
PHP

<?php
declare(strict_types=1);
namespace Tests\Feature\FormBuilder\Options;
use App\Enums\FormBuilder\FormFieldType;
use App\Models\FormBuilder\FormField;
use App\Models\FormBuilder\FormFieldLibrary;
use App\Models\FormBuilder\FormSchema;
use App\Models\Organisation;
use App\Services\FormBuilder\FormFieldOptionService;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Tests\TestCase;
/**
* Resource-layer parity for the WS-5d rich-shape options array. Every
* resource that previously emitted flat-string-array options now emits
* the relational rich shape via FormFieldOptionService::toJsonShape().
*/
final class FormFieldResourceOptionsTest extends TestCase
{
use RefreshDatabase;
public function test_form_field_resource_emits_rich_shape_options(): void
{
$org = Organisation::factory()->create();
$admin = \App\Models\User::factory()->create();
$org->users()->attach($admin, ['role' => 'org_admin']);
$schema = FormSchema::factory()->create(['organisation_id' => $org->id]);
FormField::factory()
->withOptions([
['value' => 'red', 'label' => 'Red', 'sort_order' => 0, 'translations' => ['nl' => 'Rood']],
['value' => 'green', 'label' => 'Green', 'sort_order' => 1],
])
->create([
'form_schema_id' => $schema->id,
'field_type' => FormFieldType::SELECT->value,
'slug' => 'colour',
'label' => 'Colour',
]);
\Laravel\Sanctum\Sanctum::actingAs($admin);
$response = $this->getJson("/api/v1/organisations/{$org->id}/forms/schemas/{$schema->id}/fields");
$response->assertOk();
$emitted = collect($response->json('data'))->firstWhere('slug', 'colour');
$this->assertSame(
[
['value' => 'red', 'label' => 'Red', 'sort_order' => 0, 'translations' => ['nl' => 'Rood']],
['value' => 'green', 'label' => 'Green', 'sort_order' => 1],
],
$emitted['options'],
);
}
public function test_form_field_resource_emits_null_options_for_option_less_field_type(): void
{
$org = Organisation::factory()->create();
$admin = \App\Models\User::factory()->create();
$org->users()->attach($admin, ['role' => 'org_admin']);
$schema = FormSchema::factory()->create(['organisation_id' => $org->id]);
FormField::factory()->create([
'form_schema_id' => $schema->id,
'field_type' => FormFieldType::TEXT->value,
'slug' => 'name',
'label' => 'Name',
]);
\Laravel\Sanctum\Sanctum::actingAs($admin);
$response = $this->getJson("/api/v1/organisations/{$org->id}/forms/schemas/{$schema->id}/fields");
$response->assertOk();
$emitted = collect($response->json('data'))->firstWhere('slug', 'name');
$this->assertNull($emitted['options']);
}
public function test_library_resource_emits_rich_shape_options(): void
{
$org = Organisation::factory()->create();
$admin = \App\Models\User::factory()->create();
$org->users()->attach($admin, ['role' => 'org_admin']);
$library = FormFieldLibrary::factory()
->withOptions(['a', 'b'])
->create(['organisation_id' => $org->id]);
\Laravel\Sanctum\Sanctum::actingAs($admin);
$response = $this->getJson("/api/v1/organisations/{$org->id}/forms/field-library/{$library->id}");
$response->assertOk();
$this->assertSame(
[
['value' => 'a', 'label' => 'a', 'sort_order' => 0],
['value' => 'b', 'label' => 'b', 'sort_order' => 1],
],
$response->json('data.options'),
);
}
public function test_to_json_shape_is_byte_equal_to_resource_output(): void
{
$org = Organisation::factory()->create();
$schema = FormSchema::factory()->create(['organisation_id' => $org->id]);
$field = FormField::factory()
->withOptions(['x', 'y', 'z'])
->create([
'form_schema_id' => $schema->id,
'field_type' => FormFieldType::RADIO->value,
]);
$service = app(FormFieldOptionService::class);
$shape = $service->toJsonShape($service->optionsFor($field));
$this->assertSame(
[
['value' => 'x', 'label' => 'x', 'sort_order' => 0],
['value' => 'y', 'label' => 'y', 'sort_order' => 1],
['value' => 'z', 'label' => 'z', 'sort_order' => 2],
],
$shape,
);
}
}