Contrib.social

Make an intuitive layout builder diff layout

Open on Drupal.org →
Created on 27 January 2023, about 2 years ago
Updated 22 April 2024, 12 months ago

Problem/Motivation

Layout builder layouts don't have a proper diff plugin. As more and more sites transition to rely on layout builder, an intuitive way of inspecting changes between layout revisions is required.

Proposed resolution

Provide two different general diff classifications: Section changes and Component changes.

Section changes

Sections can't really be "properly" diff'd until they get dedicated UUID's over in https://www.drupal.org/project/drupal/issues/3208766 ✨ Add UUID to sections Needs work . As a result, this layout view probably won't be overly useful if sections are either re-ordered, or a new section is added toward the top of a piece of content.

For each section delta from 0 to the max delta of LHS / RHS, sequentially, assume LHS is the "left" revision and RHS is the "right" revision.

  1. If LHS[delta] does not exist, assume a new section was added. If RHS[delta] does not exist, assume a section was removed. Otherwise assume a section was modified.
  2. Dump the raw section configuration data into a table for the "left" and "right" revision (padding empty tables for any empty sections).
  3. Run the tables through caxy/php-htmldiff
  4. Render the data diff under the appropriate "Added", "Modified", "Removed" fieldsets.

Component setting changes

For each section delta from 0 to the max delta of LHS / RHS, gather up all LHS components and RHS components.

  1. Get new components by running array_diff_key($rhs_components, $lhs_components);.
  2. Get removed components by running array_diff_key($lhs_components, $rhs_components);.
  3. Get components that exist in both LHS + RHS by running array_intersect_key($lhs_components, $rhs_components.
  4. Get modified config components by running an array filter on the intersection that compares component data.
  5. Dump the raw component configuration data into a table (padding empty tables for any empty components).
  6. Run the tables through caxy/php-htmldiff
  7. Drop the data diff under the appropriate "Added", "Modified", "Removed" fieldsets.

Component output changes

For each section delta from 0 to the max delta of LHS / RHS, gather up all LHS components and RHS components.

  1. Get new components by running array_diff_key($rhs_components, $lhs_components);.
  2. Get removed components by running array_diff_key($lhs_components, $rhs_components);.
  3. Get components that exist in both LHS + RHS by running array_intersect_key($lhs_components, $rhs_components.
  4. Get modified config components by running an array filter on the intersection that compares component data.
  5. Render both LHS and RHS.
  6. Run the output through caxy/php-htmldiff
  7. Drop the visual diff under the appropriate "Added", "Modified", "Removed" fieldsets.

Remaining tasks

  1. Come up with a design.
  2. Implement design
  3. UAT

User interface changes

A new diff layout plugin type to review layout based changes.

API changes

None

Data model changes

None

✨ Feature request
Status

Postponed

Version

1.0

Component

Code

Created by

🇺🇸United States luke.leber Pennsylvania

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