[2.0.0-beta2] Attributes normalization

pdureau → credited g4mbini → .

pdureau → credited grimreaper → .

pdureau → credited smustgrave → .

Let's do the early alteration in ComponentPluginManager::annotateProps().

📌 [2.0.0-beta2] Expose default attributes prop in forms Closed: duplicate is now obsolete and can be closed

We have this PHP Unit error in the pipeline: Drupal\Core\Render\Component\Exception\InvalidComponentException: [attributes] String value found, but an object is required

It may be related to 🐛 [2.0.0-beta2] Check PropTypeInterface::normalize() Active

pdureau → credited just_like_good_vibes → .

Checked with Mikael

It is SDC's ComponentValidator::validateProps() which is calling a dependency method which is executing json_encode() which is casting the attribute object into a string.

So, we may need 2 different methods:

• keep PropTypeInterface::normalize() before the ComponentValidator, which is always returning data conform to JSON Schema, so which is keeping the associative array for attributes
• add a new method (PropTypeInterface::preprocess() ?) in between the ComponentValidator and the injection to Twig template, which is instantiating the Attribute object

Unfortunately, ComponentValidator may be executed very late, from a Twig extension, so we may need to add our own Twig extension to be executed after.

SDC implementation looks a bit messy IMHO:

ComponentsTwigExtension is adding 2 twig functions:

• add_component_context which is adding the attribute Attribute object if missing
• validate_component_props which is executing the JSON schema validator

Why are they Twig functions instead of living in the rendering process? Who will ever use them in the template? I don't know

Then, ComponentNodeVisitor is ever more problematic, because it prints those Twig functions on every template, which will be executed on rendering:

• attach_library
• add_component_context
• validate_component_props

And this is making all the mess. What we are paying here is the cost of the use of "template to template" Twig functions or tags (include and embed) instead of a dedicated mechanism which is loading the Render API and leveraging the render element. For example, attach_library is used here because #attached is not executed.

All this part of SDC would be to be removed and redone, but it will take time.

What can we do now, in this ticket, to overcome this?

DRAFT - WORK IN PROGRESS: WILL BE UPDATED WITH BETTER INFO

So, let's see every possible situation.

No attribute in template context

No attribute in JSON schema

1. add_component_context is adding an Attribute object
2. validate_component_props is skipping the validation, so it is OK ✅

Attribute as a namespaced PHP class in JSON schema

The same:

1. add_component_context is adding an Attribute object
2. validate_component_props is skipping the validation, so it is OK ✅

Attribute as a proper JSON schema definition (the UI Patterns 2.x way)

1. add_component_context is adding an Attribute object
2. validate_component_props is doing the validation, and it is supposed to be KO ❌

attribute as a PHP object in template context

No attribute in JSON schema

1. add_component_context is altering the Attribute object
2. validate_component_props is skipping the validation, so it is OK ✅

attribute as a namespaced PHP class in JSON schema

The same:

1. add_component_context is altering the Attribute object
2. validate_component_props is skipping the validation, so it is OK ✅

Attribute as a proper JSON schema definition (the UI Patterns 2.x way)

1. add_component_context is doing nothing
2. validate_component_props is doing the validation, because a ❌

attribute as a PHP array in template context

This will be the situation if we remove AttributePropType::normalize()

No attribute in JSON schema

1. add_component_context is doing nothing
2. validate_component_props is skipping the validation, so it is OK ✅

Attribute as a namespaced PHP class in JSON schema

The same:

1. add_component_context is doing nothing
2. validate_component_props is skipping the validation, so it is OK ✅

Attribute as a proper JSON schema definition (the UI Patterns 2.x way)

1. add_component_context is doing nothing
2. validate_component_props is doing the validation, and it i supposed to be KO because a ❌