Unhelpful error message with enumeration problem

Witht the merge request the error message will be:

Drupal\Core\Render\Component\Exception\InvalidComponentException: [foo:foo] [example] Does not have a value in the enumeration ["foo","bar"] in Drupal\Core\Theme\Component\ComponentValidator->validateProps() (line 203 of core/lib/Drupal/Core/Theme/Component/ComponentValidator.php).

Also tried to add a value provided, which will help to find an issue even faster:

Drupal\Core\Render\Component\Exception\InvalidComponentException: [foo:foo] [example] Does not have a value in the enumeration ["foo","bar"]. "baz" provided. in Drupal\Core\Theme\Component\ComponentValidator->validateProps() (line 203 of core/lib/Drupal/Core/Theme/Component/ComponentValidator.php).

Appears to have test failures.

Added condition to append information about value only if it is provided.

Also, I'm thinking, can this message be improved? I personally don't like the end result right now with [foo:foo] [example]. Maybe it is better to be something like: [provider:component/properties/property] — [foo:foo/properties/example]?

Unhelpful error message with enumeration problem

Thanks you for this proposal which is useful for all error messages, not only for enumeration problems.

Maybe it is better to be something like: [provider:component/properties/property]

No need for "/properties/" here. A 3 level structure seems to be enough: provider / component / prop.

If we add slots to the mix later, they are in the same "provider + component" namespace as props (you can't name a slot and a prop the same), so it will still work.

Changed message to be:

[foo:foo/example] Does not have a value in the enumeration ["foo","bar"]. "baz" provided

Believe feedback has been addressed and improved message definitely appears to be an improvement

RTBC++ … except this is missing test coverage in \Drupal\Tests\Core\Theme\Component\ComponentValidatorTest 😅

Basically, the validation itself is covered by \Drupal\Tests\Core\Theme\Component\ComponentValidatorTest::dataProviderValidatePropsInvalid and ctaTarget violates the allowed properties in the enum. What is not covered is the message itself.

Should it be a dedicated test method for that case or should the \Drupal\Tests\Core\Theme\Component\ComponentValidatorTest::testValidatePropsInvalid assert the exception message as well?

What is the best way to cover it?

I've added test coverage for this change, also found a nit issue while testing the error messages.

The newline separator was incorrect meaning `/n` was showing in the separated error messages - figured it was closely enough related to this issue to be included.

Believe the redesign of core/tests/Drupal/Tests/Core/Theme/Component/ComponentValidatorTest.php is out of scope for adding test coverage for a message.

@smustgrave reverted to array structure for dataprovider.

Thanks! Re-ran the unit failure and it was random.