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

231
api/tests/Feature/FormBuilder/ConditionalLogic/FormFieldConditionalLogicServiceTest.php Normal file
View File

@@ -0,0 +1,231 @@
<?php
declare(strict_types=1);
namespace Tests\Feature\FormBuilder\ConditionalLogic;
use App\Enums\FormBuilder\FormFieldConditionalLogicConditionOperator;
use App\Enums\FormBuilder\FormFieldConditionalLogicGroupOperator;
use App\Exceptions\FormBuilder\InvalidConditionalLogicSpecException;
use App\Models\FormBuilder\FormField;
use App\Models\FormBuilder\FormFieldConditionalLogicCondition;
use App\Models\FormBuilder\FormFieldConditionalLogicGroup;
use App\Models\FormBuilder\FormSchema;
use App\Models\Organisation;
use App\Services\FormBuilder\FormFieldConditionalLogicService;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Spatie\Activitylog\Models\Activity;
use Tests\TestCase;
final class FormFieldConditionalLogicServiceTest extends TestCase
{
use RefreshDatabase;
public function test_replace_logic_persists_tree_and_fires_activity_log(): void
{
$org = Organisation::factory()->create();
$schema = FormSchema::factory()->create(['organisation_id' => $org->id]);
$field = FormField::factory()->create(['form_schema_id' => $schema->id, 'slug' => 'subject']);
FormField::factory()->create(['form_schema_id' => $schema->id, 'slug' => 'gate']);
FormField::factory()->create(['form_schema_id' => $schema->id, 'slug' => 'region']);
$service = app(FormFieldConditionalLogicService::class);
$service->replaceLogic($field, [
'operator' => FormFieldConditionalLogicGroupOperator::All->value,
'children' => [
['field_slug' => 'gate', 'operator' => 'equals', 'value' => 'yes'],
[
'operator' => FormFieldConditionalLogicGroupOperator::Any->value,
'children' => [
['field_slug' => 'region', 'operator' => 'equals', 'value' => 'NL'],
['field_slug' => 'region', 'operator' => 'equals', 'value' => 'BE'],
],
],
],
]);
$this->assertSame(2, FormFieldConditionalLogicGroup::query()->count());
$this->assertSame(3, FormFieldConditionalLogicCondition::query()->count());
$this->assertDatabaseHas('activity_log', [
'description' => 'field.conditional_logic_replaced',
'subject_type' => 'form_field',
'subject_id' => $field->id,
]);
}
public function test_replace_logic_is_transactional_and_replaces_existing_tree(): void
{
$org = Organisation::factory()->create();
$schema = FormSchema::factory()->create(['organisation_id' => $org->id]);
$field = FormField::factory()->create(['form_schema_id' => $schema->id, 'slug' => 'subject']);
FormField::factory()->create(['form_schema_id' => $schema->id, 'slug' => 'gate']);
$service = app(FormFieldConditionalLogicService::class);
$service->replaceLogic($field, [
'operator' => 'all',
'children' => [
['field_slug' => 'gate', 'operator' => 'equals', 'value' => 'yes'],
],
]);
$this->assertSame(1, FormFieldConditionalLogicCondition::query()->count());
$service->replaceLogic($field, [
'operator' => 'any',
'children' => [
['field_slug' => 'gate', 'operator' => 'not_equals', 'value' => 'no'],
],
]);
// Full replacement — old rows gone, new rows in place.
$this->assertSame(1, FormFieldConditionalLogicGroup::query()->count());
$this->assertSame(1, FormFieldConditionalLogicCondition::query()->count());
$condition = FormFieldConditionalLogicCondition::query()->first();
$this->assertSame('not_equals', $condition->comparison_operator->value);
}
public function test_replace_logic_with_null_clears_tree(): void
{
$org = Organisation::factory()->create();
$schema = FormSchema::factory()->create(['organisation_id' => $org->id]);
$field = FormField::factory()->create(['form_schema_id' => $schema->id, 'slug' => 'subject']);
FormField::factory()->create(['form_schema_id' => $schema->id, 'slug' => 'gate']);
$service = app(FormFieldConditionalLogicService::class);
$service->replaceLogic($field, [
'operator' => 'all',
'children' => [
['field_slug' => 'gate', 'operator' => 'empty'],
],
]);
$service->replaceLogic($field, null);
$this->assertSame(0, FormFieldConditionalLogicGroup::query()->count());
$this->assertSame(0, FormFieldConditionalLogicCondition::query()->count());
}
public function test_assert_specs_valid_rejects_unknown_operator(): void
{
$service = app(FormFieldConditionalLogicService::class);
$this->expectException(InvalidConditionalLogicSpecException::class);
$service->assertSpecsValid([
'operator' => 'all',
'children' => [
['field_slug' => 'x', 'operator' => 'nonsense_op', 'value' => 1],
],
]);
}
public function test_assert_specs_valid_rejects_root_condition(): void
{
$service = app(FormFieldConditionalLogicService::class);
$this->expectException(InvalidConditionalLogicSpecException::class);
$service->assertSpecsValid([
'field_slug' => 'x',
'operator' => 'equals',
'value' => 'y',
]);
}
public function test_assert_specs_valid_rejects_empty_group(): void
{
$service = app(FormFieldConditionalLogicService::class);
$this->expectException(InvalidConditionalLogicSpecException::class);
$service->assertSpecsValid([
'operator' => 'all',
'children' => [],
]);
}
public function test_replace_logic_rejects_unknown_field_slug(): void
{
$org = Organisation::factory()->create();
$schema = FormSchema::factory()->create(['organisation_id' => $org->id]);
$field = FormField::factory()->create(['form_schema_id' => $schema->id, 'slug' => 'subject']);
$service = app(FormFieldConditionalLogicService::class);
$this->expectException(InvalidConditionalLogicSpecException::class);
$this->expectExceptionMessageMatches('/ghost_slug/');
$service->replaceLogic($field, [
'operator' => 'all',
'children' => [
['field_slug' => 'ghost_slug', 'operator' => 'equals', 'value' => 'x'],
],
]);
}
public function test_to_json_shape_reconstructs_canonical_show_when(): void
{
$org = Organisation::factory()->create();
$schema = FormSchema::factory()->create(['organisation_id' => $org->id]);
$field = FormField::factory()->create(['form_schema_id' => $schema->id, 'slug' => 'subject']);
FormField::factory()->create(['form_schema_id' => $schema->id, 'slug' => 'gate']);
FormField::factory()->create(['form_schema_id' => $schema->id, 'slug' => 'region']);
$service = app(FormFieldConditionalLogicService::class);
$service->replaceLogic($field, [
'operator' => 'all',
'children' => [
['field_slug' => 'gate', 'operator' => 'equals', 'value' => 'yes'],
[
'operator' => 'any',
'children' => [
['field_slug' => 'region', 'operator' => 'equals', 'value' => 'NL'],
['field_slug' => 'region', 'operator' => 'empty'],
],
],
],
]);
$shape = $service->toJsonShape($field->fresh()->rootConditionalLogicGroup());
$this->assertNotNull($shape);
$this->assertSame([
'show_when' => [
'all' => [
['field_slug' => 'gate', 'operator' => 'equals', 'value' => 'yes'],
[
'any' => [
['field_slug' => 'region', 'operator' => 'equals', 'value' => 'NL'],
['field_slug' => 'region', 'operator' => 'empty'],
],
],
],
],
], $shape);
}
public function test_to_json_shape_returns_null_when_no_logic(): void
{
$service = app(FormFieldConditionalLogicService::class);
$this->assertNull($service->toJsonShape(null));
}
public function test_valueless_condition_stores_null_and_omits_value_in_json(): void
{
$org = Organisation::factory()->create();
$schema = FormSchema::factory()->create(['organisation_id' => $org->id]);
$field = FormField::factory()->create(['form_schema_id' => $schema->id, 'slug' => 'subject']);
FormField::factory()->create(['form_schema_id' => $schema->id, 'slug' => 'gate']);
$service = app(FormFieldConditionalLogicService::class);
$service->replaceLogic($field, [
'operator' => 'all',
'children' => [
['field_slug' => 'gate', 'operator' => 'not_empty', 'value' => 'this_should_be_dropped'],
],
]);
$condition = FormFieldConditionalLogicCondition::query()->first();
$this->assertNull($condition->value);
$this->assertSame(FormFieldConditionalLogicConditionOperator::NotEmpty, $condition->comparison_operator);
$shape = $service->toJsonShape($field->fresh()->rootConditionalLogicGroup());
$this->assertSame([
'show_when' => [
'all' => [
['field_slug' => 'gate', 'operator' => 'not_empty'],
],
],
], $shape);
}
}