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

feat(form-builder): FormFieldConditionalLogicService + cycle detection + legacy backfill + snapshot

Browse Source 
WS-5c commit 2 of 4 — the service layer, backfill migration, and
read-path switch. Per addendum Q3, conditional_logic applies to
FormField only — no library mirror and no copyLogic on
FormFieldService::insertFromLibrary.

FormFieldConditionalLogicService owns every write:
  - logicFor(field): depth-limited eager-load of the tree
  - replaceLogic(field, tree): transactional structure + operator +
    field_slug validation + cycle check + activity-log emit
    (field.conditional_logic_replaced)
  - toJsonShape(root): reconstructs the canonical ARCH §8
    `{show_when: {...}}` shape — single source of truth for the
    snapshot writer + API resources
  - assertSpecsValid(tree): public boundary guard for the FormRequest
    strict validator (WS-5c commit 3 wires this up)
  - assertNoCycles(field, tree): contract preserved from
    FormFieldService::assertNoConditionalCycle, implementation now
    reads the relational adjacency.

Backfill migration translates pre-WS-5c conditional_logic JSON to
rows. Strict dispatch: unknown operators / unknown top-level keys /
malformed groups FAIL the migration — Phase A seed-scan confirmed
the catalogue parity, so any drift is a data bug to fix at source,
not silently absorb. Rollback rebuilds canonical JSON and clears
the relational tree.

FormFieldService.create/update route `conditional_logic` through
the new service (matching the extract-and-delegate pattern from
WS-5a bindings and WS-5b validation rules). Snapshot writer + both
resources (FormFieldResource, PublicFormSchemaResource) read via
`toJsonShape(rootConditionalLogicGroup())` — byte-for-byte parity
with the pre-WS-5c JSON contract.

InvalidConditionalLogicSpecException handled in FormFieldController
as 422, same as FrozenSchemaException / CyclicDependencyException.

Tests: 20 new under tests/Feature/FormBuilder/ConditionalLogic/
(service, cycle detection, backfill forward+rollback+failure cases,
snapshot + resource parity). FormFieldApiTest cyclic rejection test
rewritten to use the new factory state. Rollback step counts in
WS-5a/b migration tests bumped +1 for the new backfill migration.
Baseline 1122 → 1142 green (3032 → 3085 assertions).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
bert.hausmans
2026-04-24 23:56:39 +02:00
parent 2064b9901e
commit d06ea01b09
16 changed files with 1514 additions and 96 deletions
Download Patch File Download Diff File Expand all files Collapse all files

228
api/tests/Feature/FormBuilder/ConditionalLogic/ConditionalLogicBackfillTest.php Normal file
View File

@@ -0,0 +1,228 @@
<?php
declare(strict_types=1);
namespace Tests\Feature\FormBuilder\ConditionalLogic;
use App\Models\FormBuilder\FormSchema;
use App\Models\Organisation;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Schema;
use Illuminate\Support\Str;
use Tests\TestCase;
/**
* Rolls back just the WS-5c backfill migration, seeds pre-WS-5c JSON into
* `form_fields.conditional_logic`, then migrates forward and backward,
* asserting:
*
* - Forward: relational rows mirror the tree shape (groups + conditions
* + parent links + sort_order).
* - Rollback: JSON reconstructed byte-accurate for the ARCH §8 shape.
*
* Cross-field cycle detection does NOT run on backfill — pre-WS-5c data
* is assumed acyclic (the JSON-era check enforced on save). Post-backfill
* the service enforces on every write.
*/
final class ConditionalLogicBackfillTest extends TestCase
{
use RefreshDatabase;
public function test_forward_backfill_builds_nested_tree_from_legacy_json(): void
{
// Roll back only the backfill migration (latest WS-5c step).
$this->artisan('migrate:rollback', ['--step' => 1])->assertSuccessful();
$this->assertTrue(Schema::hasColumn('form_fields', 'conditional_logic'));
$fieldId = $this->seedFieldWithJson([
'show_when' => [
'all' => [
['field_slug' => 'gate', 'operator' => 'equals', 'value' => 'yes'],
[
'any' => [
['field_slug' => 'region', 'operator' => 'equals', 'value' => 'NL'],
['field_slug' => 'region', 'operator' => 'equals', 'value' => 'BE'],
],
],
['field_slug' => 'status', 'operator' => 'empty'],
],
],
]);
$this->artisan('migrate')->assertSuccessful();
// Root group: `all`, no parent, 2 conditions + 1 subgroup.
$rootGroup = DB::table('form_field_conditional_logic_groups')
->where('form_field_id', $fieldId)
->whereNull('parent_group_id')
->first();
$this->assertNotNull($rootGroup);
$this->assertSame('all', $rootGroup->operator);
$conditions = DB::table('form_field_conditional_logic_conditions')
->where('group_id', $rootGroup->id)
->orderBy('sort_order')
->get();
$this->assertCount(2, $conditions);
$this->assertSame('gate', $conditions[0]->field_slug);
$this->assertSame('equals', $conditions[0]->comparison_operator);
$this->assertSame('yes', json_decode((string) $conditions[0]->value, true));
$this->assertSame('status', $conditions[1]->field_slug);
$this->assertSame('empty', $conditions[1]->comparison_operator);
$this->assertNull($conditions[1]->value, 'valueless operator stores null');
// Subgroup: `any`, 2 conditions.
$subGroup = DB::table('form_field_conditional_logic_groups')
->where('parent_group_id', $rootGroup->id)
->first();
$this->assertNotNull($subGroup);
$this->assertSame('any', $subGroup->operator);
$subConditions = DB::table('form_field_conditional_logic_conditions')
->where('group_id', $subGroup->id)
->orderBy('sort_order')
->get();
$this->assertCount(2, $subConditions);
$this->assertSame('region', $subConditions[0]->field_slug);
$this->assertSame('NL', json_decode((string) $subConditions[0]->value, true));
}
public function test_rollback_reconstructs_canonical_json(): void
{
// Starting state: fully migrated. Seed relational rows bypassing the
// service, then roll back one step (backfill) — it should repopulate
// the JSON column.
$org = Organisation::factory()->create();
$schema = FormSchema::factory()->create(['organisation_id' => $org->id]);
$fieldId = (string) Str::ulid();
DB::table('form_fields')->insert([
'id' => $fieldId,
'form_schema_id' => $schema->id,
'field_type' => 'TEXT',
'slug' => 'subject',
'label' => 'Subject',
'value_storage_hint' => 'json',
'sort_order' => 0,
'conditional_logic' => null,
'created_at' => now(),
'updated_at' => now(),
]);
$rootId = (string) Str::ulid();
DB::table('form_field_conditional_logic_groups')->insert([
'id' => $rootId,
'form_field_id' => $fieldId,
'parent_group_id' => null,
'operator' => 'all',
'sort_order' => 0,
'created_at' => now(),
'updated_at' => now(),
]);
DB::table('form_field_conditional_logic_conditions')->insert([
'id' => (string) Str::ulid(),
'group_id' => $rootId,
'field_slug' => 'gate',
'comparison_operator' => 'equals',
'value' => json_encode('yes'),
'sort_order' => 0,
'created_at' => now(),
'updated_at' => now(),
]);
$subGroupId = (string) Str::ulid();
DB::table('form_field_conditional_logic_groups')->insert([
'id' => $subGroupId,
'form_field_id' => $fieldId,
'parent_group_id' => $rootId,
'operator' => 'any',
'sort_order' => 1,
'created_at' => now(),
'updated_at' => now(),
]);
DB::table('form_field_conditional_logic_conditions')->insert([
'id' => (string) Str::ulid(),
'group_id' => $subGroupId,
'field_slug' => 'region',
'comparison_operator' => 'equals',
'value' => json_encode('NL'),
'sort_order' => 0,
'created_at' => now(),
'updated_at' => now(),
]);
// Roll back only the backfill migration — writes the JSON back.
$this->artisan('migrate:rollback', ['--step' => 1])->assertSuccessful();
$reconstructed = DB::table('form_fields')
->where('id', $fieldId)
->value('conditional_logic');
$this->assertNotNull($reconstructed);
$json = json_decode((string) $reconstructed, true);
$this->assertSame([
'show_when' => [
'all' => [
['field_slug' => 'gate', 'operator' => 'equals', 'value' => 'yes'],
[
'any' => [
['field_slug' => 'region', 'operator' => 'equals', 'value' => 'NL'],
],
],
],
],
], $json);
// Relational tables cleared after reconstruction.
$this->assertSame(0, DB::table('form_field_conditional_logic_groups')->count());
$this->assertSame(0, DB::table('form_field_conditional_logic_conditions')->count());
}
public function test_unknown_top_level_key_fails_migration(): void
{
$this->artisan('migrate:rollback', ['--step' => 1])->assertSuccessful();
$this->seedFieldWithJson([
'hide_when' => ['all' => [['field_slug' => 'x', 'operator' => 'equals', 'value' => 1]]],
]);
$this->expectException(\RuntimeException::class);
$this->expectExceptionMessageMatches('/hide_when/');
$this->artisan('migrate');
}
public function test_unknown_comparison_operator_fails_migration(): void
{
$this->artisan('migrate:rollback', ['--step' => 1])->assertSuccessful();
$this->seedFieldWithJson([
'show_when' => ['all' => [['field_slug' => 'x', 'operator' => 'matches_regex', 'value' => 'y']]],
]);
$this->expectException(\RuntimeException::class);
$this->expectExceptionMessageMatches('/matches_regex/');
$this->artisan('migrate');
}
/** @param array<string, mixed> $json */
private function seedFieldWithJson(array $json): string
{
$org = Organisation::factory()->create();
$schema = FormSchema::factory()->create(['organisation_id' => $org->id]);
$id = (string) Str::ulid();
DB::table('form_fields')->insert([
'id' => $id,
'form_schema_id' => $schema->id,
'field_type' => 'TEXT',
'slug' => 'f-'.Str::lower(Str::random(4)),
'label' => 'field',
'value_storage_hint' => 'json',
'sort_order' => 0,
'conditional_logic' => json_encode($json),
'created_at' => now(),
'updated_at' => now(),
]);
return $id;
}
}