Contrib.social

ComponentMetadataRequirementsChecker::check() should validate that the example(s) actually match the JSON schema

Open on Drupal.org →
Created on 24 February 2025, about 1 month ago

Overview

Broken out from 📌 ComponentMetadataRequirementsChecker::check() should validate that the example(s) actually match the JSON schema Active

\Drupal\experience_builder\ComponentMetadataRequirementsChecker::check() only checks for the presence of an examples[0], but it does not verify that it actually complies with the JSON Schema!

… because you'd reasonably expect that JSON Schema validates its examples, but … nope:

This keyword can be used to provide sample JSON values associated with a particular schema, for the purpose of illustrating usage. It is RECOMMENDED that these values be valid against the associated schema.

— https://json-schema.org/draft/2020-12/draft-bhutton-json-schema-validati... 🧟‍♀️😭

So it's up to either Drupal core's SDC subsystem to strictly validate this (it doesn't), or up to XB.

Conclusion: XB must do this, since for XB it is critical.

(For those of you wondering: — ignoring the fact that the SDC subsystem doesn't use this at all, the same "recommended to be valid" statement is present there: https://json-schema.org/draft/2020-12/draft-bhutton-json-schema-validati... 😬)

Proposed resolution

  1. Prevent Component config entities from being created for SDCs whose examples for SDC props do not validate against the prop's JSON Schema.
  2. Do this by making \Drupal\experience_builder\ComponentMetadataRequirementsChecker::check() more strict.
  3. Add explicit test coverage that detects this.

User interface changes

None.

📌 Task
Status

Active

Version

0.0

Component

Config management

Created by

🇬🇧United Kingdom longwave UK

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024