Use paths to identify when a rule fails #1507

henriquemoody · 2024-12-22T05:19:18Z

When nested-structural validation fails, it's challenging to identify which rule failed from the main exception message. A great example is the Issue796Test.php file. The exception message says:

host must be a string

But you're left unsure whether it's the host key from the mysql key or the postgresql key.

This commit changes that behaviour by introducing the concept of "Path." The path represents the path that a rule has taken, and we can use it in structural rules to identify the path of an array or object.

Here's what it looks like before and after:

-host must be a string
+`.mysql.host` must be a string

Because paths are a specific concept, I added a dot (.) at the beginning of all paths when displaying them. I was inspired by the jq syntax. I also added backticks around paths to distinguish them from any other value.

I didn't manage to fix a test, and I skipped it instead of fixing it because I want to make changes in how we display error messages as arrays, and it will be easier to fix it then.

library/Message/StandardRenderer.php

library/Rules/Lazy.php

library/Transformers/DeprecatedKeyValue.php

tests/feature/Issues/Issue1289Test.php

tests/feature/Issues/Issue1334Test.php

tests/feature/Issues/Issue796Test.php

tests/feature/Rules/EachTest.php

tests/feature/Rules/KeyOptionalTest.php

tests/feature/Issues/Issue1348Test.php

tests/feature/Rules/EachTest.php

library/Result.php

tests/feature/Transformers/DeprecatedKeyValueTest.php

library/Message/StandardFormatter.php

codecov · 2024-12-27T20:34:45Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.69%. Comparing base (a0d6355) to head (1915b6f).
Report is 1 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #1507      +/-   ##
============================================
+ Coverage     96.64%   96.69%   +0.04%     
- Complexity      999     1014      +15     
============================================
  Files           205      205              
  Lines          2477     2511      +34     
============================================
+ Hits           2394     2428      +34     
  Misses           83       83

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

When nested-structural validation fails, it's challenging to identify which rule failed from the main exception message. A great example is the `Issue796Test.php` file. The exception message says: host must be a string But you're left unsure whether it's the `host` key from the `mysql` key or the `postgresql` key. This commit changes that behaviour by introducing the concept of "Path." The `path` represents the path that a rule has taken, and we can use it in structural rules to identify the path of an array or object. Here's what it looks like before and after: ```diff -host must be a string +`.mysql.host` must be a string ``` Because paths are a specific concept, I added a dot (`.`) at the beginning of all paths when displaying them. I was inspired by the `jq` syntax. I also added backticks around paths to distinguish them from any other value. I didn't manage to fix a test, and I skipped it instead of fixing it because I want to make changes in how we display error messages as arrays, and it will be easier to fix it then.

henriquemoody added the Enhancement label Dec 22, 2024