[META] Maintainable client-side data model + internal HTTP API (#3521002) · Issues · project / canvas

[META] Maintainable client-side data model + internal HTTP API

>>> [!note] Migrated issue   Reported by: [wim leers](https://www.drupal.org/user/99777) >>> <h3 id="overview">Overview</h3> XB was originally developed in parallel: <ul> <li>one pure client-side PoC</li> <li>one pure server-side PoC</li> </ul> Then we got the two talking to each other. XB was originally developed with support SDCs, exclusively, and this is still visible in the metadata about components (the <code>/xb/api/config/component</code> route's response): they're highly SDC-specific. Then in December 2024, we overhauled it significantly in <a href="https://www.drupal.org/project/experience_builder/issues/3491013" title="Status: Closed (fixed)">#3491013: Rework layout API to separate components and slots</a> and introduced multiple "node types" in the JSON tree structure the client expects. But virtually everything here has been demo-driven development. There's lots of loose ends, duplication, imprecise OpenAPI specs, etc. <h2 id="beta">Beta blockers (July 2025)</h2> Beta blockers (tag: <code>beta blocker</code>) MUST happen before <a href="https://git.drupalcode.org/project/canvas/-/work_items/3515932" class="drupalorg-gitlab-link">https://git.drupalcode.org/project/canvas/-/work_items/3515932</a>. (Numbered lists must happen one after the other, bulleted lists can happen in parallel.) <ul> <li>Permissions: <a href="https://www.drupal.org/project/experience_builder/issues/3452581" title="Status: Closed (fixed)">#3452581: [META] XB Permissions</a></li> <li>Layout + model bugs and reliability: <ul> <li>✅ <a href="https://www.drupal.org/project/experience_builder/issues/3520662" title="Status: Closed (fixed)">#3520662: Empty slot not visible — client expects "slot node" for every *possible* slot, not for every *populated* slot</a> </li><li>✅ Missing "node type" in <code>docs/data-model.md</code>'s <code>3.4 UI Data Model: communicating a `component tree` to the front end</code>: a node type for exposed <code>ContentTemplate</code> slots: <a href="https://www.drupal.org/project/experience_builder/issues/3519352" title="Status: Closed (fixed)">#3519352: Content templates, part 3b: store exposed slot subtrees on individual entities</a> </li></ul> </li> <li>XB config entities bugs and reliability: <ul> <li>✅ <a href="https://www.drupal.org/project/experience_builder/issues/3518808" title="Status: Closed (fixed)">#3518808: XbConfigEntityHttpApiTest::testJavaScriptComponent test comments are incorrect regarding status updating</a> </li><li>✅ <a href="https://www.drupal.org/project/experience_builder/issues/3519634" title="Status: Closed (fixed)">#3519634: Modifying a XB config entity's `status` or `label` should update the auto-save entry too, rather than delete it</a> </li></ul> </li> <li>High-impact bugs <ul> <li>✅ <a href="https://www.drupal.org/project/experience_builder/issues/3525130" title="Status: Closed (fixed)">#3525130: Never show any messages in XB's previews</a> </li></ul> </li> </ul> <h2 id="stable">Stable blockers (October 2025)</h2> Stable blockers (tag: <code>stable blocker</code>) do not block <a href="https://git.drupalcode.org/project/canvas/-/work_items/3515932" class="drupalorg-gitlab-link">https://git.drupalcode.org/project/canvas/-/work_items/3515932</a>, but would be nice-to-have at that point in time. They MUST happen before <a href="https://git.drupalcode.org/project/canvas/-/work_items/3517885" class="drupalorg-gitlab-link">https://git.drupalcode.org/project/canvas/-/work_items/3517885</a>. (Numbered lists must happen one after the other, bulleted lists can happen in parallel.) <ul> <li>XB-eligible content entities functionality: <ul> <li><a href="https://www.drupal.org/project/experience_builder/issues/3518292" title="Status: Closed (fixed)">#3518292: Allow searching for content in the navigator, via `/xb/api/v0/content/{entity_type}`</a> </li></ul> </li> <li>Finalize and de-SDC-ify component metadata (<code>/xb/api/config/component</code>): <ul> <li>✅ <a href="https://www.drupal.org/project/experience_builder/issues/3504421" title="Status: Closed (fixed)">#3504421: Rename `PropSourceComponent.field_data` to `.propSources`</a> </li><li>✅ <a href="https://www.drupal.org/project/experience_builder/issues/3515629" title="Status: Closed (fixed)">#3515629: FieldWidget's XB transforms must be bubbled by the Field Widget rendering to inform the client</a> </li><li>✅ <a href="https://www.drupal.org/project/experience_builder/issues/3516705" title="Status: Closed (fixed)">#3516705: Auto-saved changes to code components are not visible in preview-on-hover-component-list until published</a> </li><li><a href="https://www.drupal.org/project/experience_builder/issues/3510896" title="Status: Closed (fixed)">#3510896: Add a new internal HTTP API for candidate `DynamicPropSource`s to enable a `ContentTemplate` UI</a> </li><li><a href="https://www.drupal.org/project/canvas/issues/3521041" title="Status: Active">#3521041: [META] Refactor the organically grown Component metadata mess in PHP (`::getClientSideInfo()`) and JS (`BaseComponent`, `DynamicComponent`, `PropSourceComponent` etc.)</a> </li></ul> </li> <li>Layout + model maintainability/completeness: <ul> <li><a href="https://git.drupalcode.org/project/canvas/-/work_items/3499632" class="drupalorg-gitlab-link">https://git.drupalcode.org/project/canvas/-/work_items/3499632</a> </li><li><a href="https://git.drupalcode.org/project/canvas/-/work_items/3491701" class="drupalorg-gitlab-link">https://git.drupalcode.org/project/canvas/-/work_items/3491701</a> </li><li><a href="https://www.drupal.org/project/experience_builder/issues/3510892" title="Status: Closed (cannot reproduce)">#3510892: Allow XB to be gradually adopted: make XB's viewing (formatter) and editing (`ApiLayoutController::get()`) work with an empty XB field</a> </li><li><del>Missing "node type" in <code>docs/data-model.md</code>'s <code>3.4 UI Data Model: communicating a `component tree` to the front end</code>: a node type for overrides/personalization variants</del> <del>Probably actually additional metadata on the existing <code>nodeType: slot</code> would be sufficient, for example <code>mutuallyExclusive: true|false</code> to indicate only one variant can be visible at a time, and perhaps some extra metadata for additional UI affordances</del> Introduce <code>nodeType: switch</code> → PoC'd by @penyaskito at <a href="https://www.drupal.org/project/experience_builder/issues/3525565" title="Status: Closed (outdated)">#3525565: Personalization ComponentSource PoC</a> </li></ul> </li> <li>Back-end changes to improve front-end performance <ul> <li><a href="https://git.drupalcode.org/project/canvas/-/work_items/3505018" class="drupalorg-gitlab-link">https://git.drupalcode.org/project/canvas/-/work_items/3505018</a> </li><li><a href="https://www.drupal.org/project/canvas/issues/3528847" title="Status: Needs work">#3528847: Implement `lookup_keys` in Component for optimized queries</a> </li></ul> </li> <li>OpenAPI/DX <ul> <li>✅ <a href="https://www.drupal.org/project/experience_builder/issues/3471884" title="Status: Closed (fixed)">#3471884: Rename all XB internal HTTP API routes from `/xb/api/…` to `/xb/api/v0/…`</a> </li><li><a href="https://git.drupalcode.org/project/canvas/-/work_items/3472617" class="drupalorg-gitlab-link">https://git.drupalcode.org/project/canvas/-/work_items/3472617</a> </li><li><a href="https://git.drupalcode.org/project/canvas/-/work_items/3499809" class="drupalorg-gitlab-link">https://git.drupalcode.org/project/canvas/-/work_items/3499809</a> </li><li><a href="https://git.drupalcode.org/project/canvas/-/work_items/3507427" class="drupalorg-gitlab-link">https://git.drupalcode.org/project/canvas/-/work_items/3507427</a> </li><li><a href="https://www.drupal.org/project/experience_builder/issues/3541131" title="Status: Closed (fixed)">#3541131: DX: Rename `ComponentInputsForm` to `ComponentInstanceForm`</a> </li></ul> </li> <h2 id="post-stable-priorities">Post-stable priorities (after October 2025)</h2> Post-stable priorities (tag: <code>post-stable priority</code>) do not block any release, and are things we'd like to see happen, but are intentionally NOT happening any time soon. We're highly confident that these will be net additions without the need for backwards compatibility breaks. None yet. </ul> > Related issue: [Issue #3517941](https://www.drupal.org/node/3517941) > Related issue: [Issue #3520449](https://www.drupal.org/node/3520449) > Related issue: [Issue #3520484](https://www.drupal.org/node/3520484)

issue