Skip to content

Extract fallback finding normalization #526

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chubes4 merged 1 commit into from
Jul 6, 2026
+229 −168
Merged

Extract fallback finding normalization #526

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions php-transformer/composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@
"php tests/unit/subtree-classifier.php",
"php tests/unit/custom-block-generator.php",
"php tests/unit/css-value-splitter.php",
"php tests/unit/fallback-finding-normalizer.php",
"php tests/unit/navigation-underline-color-resolver.php",
"php tests/unit/block-style-support-conversion.php",
"php tests/unit/content-round-trip-reporter.php",
Expand Down
169 changes: 1 addition & 168 deletions php-transformer/src/HtmlToBlocks/FallbackDiagnostic.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@

namespace Automattic\BlocksEngine\PhpTransformer\HtmlToBlocks;

use Automattic\BlocksEngine\PhpTransformer\Contract\ConversionFindingContract;

final class FallbackDiagnostic
{
/**
Expand All @@ -23,25 +21,7 @@ public static function build(array $fields, array $provenance = array()): array
*/
public static function withGenericFindingMetadata(array $fields): array
{
$selector = is_string($fields['selector'] ?? null) ? trim($fields['selector']) : '';
$context = is_array($fields['context'] ?? null) ? $fields['context'] : array();
$patternFamily = self::patternFamily($fields);

$metadata = array_filter(array(
'pattern_family' => $patternFamily,
'pattern_family_detail' => self::patternFamilyDetail($fields),
'source_selector' => $selector,
'source_selector_specificity' => '' !== $selector ? self::selectorSpecificity($selector) : array(),
'parent_reason' => self::parentReason($context),
'ancestor_reason' => self::ancestorReason($context),
'suggested_generic_repair_class' => self::genericRepairClass($fields, $patternFamily),
), static fn (mixed $value): bool => null !== $value && '' !== $value && array() !== $value);

// Stamp the canonical classification triplet (reason_code / repair_bucket
// / pattern_family) so every fallback/runtime-island finding clusters by
// root cause downstream. The contract honors the richer pattern_family and
// suggested_repair_class computed above and only fills what is missing.
return ConversionFindingContract::withClassification(array_merge($metadata, $fields));
return FallbackFindingNormalizer::normalize($fields);
}

/**
Expand Down Expand Up @@ -241,151 +221,4 @@ private static function defaults(array $fields): array
};
}

/**
* @param array<string, mixed> $fields
*/
private static function patternFamily(array $fields): string
{
$code = (string) ($fields['diagnostic_code'] ?? $fields['code'] ?? '');
$tag = (string) ($fields['tag'] ?? '');
$kind = (string) ($fields['kind'] ?? '');

if ( 'preserved_runtime_island' === $code && self::isInlineSemanticHtmlRuntimeIsland($fields) ) {
return 'inline_semantic_html';
}

return match ( $code ) {
'html_form_fallback' => 'interactive_form',
'html_product_grid_fallback' => 'commerce_product_grid',
'html_commerce_controls_fallback' => 'commerce_controls',
'html_script_fallback' => 'runtime_script',
'interactive_control_behavior_lost' => 'interactive_control',
'html_iframe_embed_fallback' => 'external_embed',
'html_canvas_runtime_fallback' => 'runtime_canvas',
'html_template_metadata' => 'inert_template_metadata',
'html_template_runtime_fallback' => 'runtime_template',
'html_inline_svg_fallback', 'html_unsafe_inline_svg' => 'inline_svg',
'html_unsupported_element' => '' !== $tag ? 'unsupported_' . $tag : 'unsupported_element',
default => match ( $kind ) {
'form', 'control' => 'interactive_form',
'script' => 'runtime_script',
'canvas' => 'runtime_canvas',
default => '' !== $tag ? 'html_' . $tag : 'html_fallback',
},
};
}

/**
* @param array<string, mixed> $fields
*/
private static function patternFamilyDetail(array $fields): string
{
$parts = array_filter(array(
(string) ($fields['tag'] ?? ''),
(string) ($fields['reason'] ?? $fields['preservation_reason'] ?? ''),
(string) ($fields['runtime_requirement'] ?? ''),
));

return implode(':', $parts);
}

/**
* @return array{ids: int, classes: int, attributes: int, pseudo_classes: int, elements: int, score: string}
*/
private static function selectorSpecificity(string $selector): array
{
preg_match_all('/#[A-Za-z0-9_-]+/', $selector, $ids);
preg_match_all('/\.[A-Za-z0-9_-]+/', $selector, $classes);
preg_match_all('/\[[^\]]+\]/', $selector, $attributes);
preg_match_all('/:nth-of-type\(/', $selector, $pseudoClasses);
preg_match_all('/(?:^|>\s*)([a-z][a-z0-9-]*)/i', $selector, $elements);

$idCount = count($ids[0]);
$classCount = count($classes[0]);
$attributeCount = count($attributes[0]);
$pseudoClassCount = count($pseudoClasses[0]);
$elementCount = count($elements[1]);

return array(
'ids' => $idCount,
'classes' => $classCount,
'attributes' => $attributeCount,
'pseudo_classes' => $pseudoClassCount,
'elements' => $elementCount,
'score' => $idCount . ',' . ($classCount + $attributeCount + $pseudoClassCount) . ',' . $elementCount,
);
}

/**
* @param array<string, mixed> $context
*/
private static function parentReason(array $context): string
{
$parent = is_string($context['parent_tag'] ?? null) ? trim($context['parent_tag']) : '';

return '' !== $parent ? 'inside_' . $parent : '';
}

/**
* @param array<string, mixed> $context
*/
private static function ancestorReason(array $context): string
{
$ancestors = is_array($context['ancestor_tags'] ?? null) ? array_values(array_filter($context['ancestor_tags'], 'is_string')) : array();

return array() !== $ancestors ? 'within_' . implode('_', $ancestors) : '';
}

/**
* @param array<string, mixed> $fields
*/
private static function genericRepairClass(array $fields, string $patternFamily): string
{
if ( is_string($fields['suggested_repair_class'] ?? null) && '' !== trim($fields['suggested_repair_class']) ) {
return (string) $fields['suggested_repair_class'];
}

if ( str_starts_with($patternFamily, 'runtime_') || in_array($patternFamily, array('interactive_form', 'external_embed', 'inline_semantic_html'), true) ) {
return 'preserve_runtime_island';
}

if ( str_starts_with($patternFamily, 'unsupported_') ) {
return 'add_generic_pattern_recognizer';
}

if ( 'inline_svg' === $patternFamily ) {
return 'materialize_static_asset';
}

return 'review_generic_mapping';
}

/**
* Inline elements with semantic/ARIA/class hooks cannot be represented as
* editable RichText without risking attribute loss, so preserved runtime
* islands should cluster separately from generic raw-HTML fallbacks.
*
* @param array<string, mixed> $fields
*/
private static function isInlineSemanticHtmlRuntimeIsland(array $fields): bool
{
if ( 'dom' !== (string) ($fields['kind'] ?? '') ) {
return false;
}

$tag = strtolower((string) ($fields['tag'] ?? ''));
if ( ! in_array($tag, array('a', 'abbr', 'b', 'cite', 'code', 'data', 'em', 'i', 'kbd', 'label', 'mark', 'q', 's', 'small', 'span', 'strong', 'sub', 'sup', 'time', 'u', 'var'), true) ) {
return false;
}

$attributes = is_array($fields['attributes'] ?? null) ? $fields['attributes'] : array();
foreach ( array_keys($attributes) as $name ) {
$attributeName = strtolower((string) $name);
if ( 'class' === $attributeName || 'id' === $attributeName || 'role' === $attributeName || str_starts_with($attributeName, 'aria-') || str_starts_with($attributeName, 'data-') ) {
return true;
}
}

return false;
}
}
184 changes: 184 additions & 0 deletions php-transformer/src/HtmlToBlocks/FallbackFindingNormalizer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,184 @@
<?php
declare(strict_types=1);

namespace Automattic\BlocksEngine\PhpTransformer\HtmlToBlocks;

use Automattic\BlocksEngine\PhpTransformer\Contract\ConversionFindingContract;

final class FallbackFindingNormalizer
{
/**
* @param array<string, mixed> $fields
* @return array<string, mixed>
*/
public static function normalize(array $fields): array
{
$selector = is_string($fields['selector'] ?? null) ? trim($fields['selector']) : '';
$context = is_array($fields['context'] ?? null) ? $fields['context'] : array();
$patternFamily = self::patternFamily($fields);

$metadata = array_filter(array(
'pattern_family' => $patternFamily,
'pattern_family_detail' => self::patternFamilyDetail($fields),
'source_selector' => $selector,
'source_selector_specificity' => '' !== $selector ? self::selectorSpecificity($selector) : array(),
'parent_reason' => self::parentReason($context),
'ancestor_reason' => self::ancestorReason($context),
'suggested_generic_repair_class' => self::genericRepairClass($fields, $patternFamily),
), static fn (mixed $value): bool => null !== $value && '' !== $value && array() !== $value);

// Stamp the canonical classification triplet (reason_code / repair_bucket
// / pattern_family) so every fallback/runtime-island finding clusters by
// root cause downstream. The contract honors the richer pattern_family and
// suggested_repair_class computed above and only fills what is missing.
return ConversionFindingContract::withClassification(array_merge($metadata, $fields));
}

/**
* @param array<string, mixed> $fields
*/
private static function patternFamily(array $fields): string
{
$code = (string) ($fields['diagnostic_code'] ?? $fields['code'] ?? '');
$tag = (string) ($fields['tag'] ?? '');
$kind = (string) ($fields['kind'] ?? '');

if ( 'preserved_runtime_island' === $code && self::isInlineSemanticHtmlRuntimeIsland($fields) ) {
return 'inline_semantic_html';
}

return match ( $code ) {
'html_form_fallback' => 'interactive_form',
'html_product_grid_fallback' => 'commerce_product_grid',
'html_commerce_controls_fallback' => 'commerce_controls',
'html_script_fallback' => 'runtime_script',
'interactive_control_behavior_lost' => 'interactive_control',
'html_iframe_embed_fallback' => 'external_embed',
'html_canvas_runtime_fallback' => 'runtime_canvas',
'html_template_metadata' => 'inert_template_metadata',
'html_template_runtime_fallback' => 'runtime_template',
'html_inline_svg_fallback', 'html_unsafe_inline_svg' => 'inline_svg',
'html_unsupported_element' => '' !== $tag ? 'unsupported_' . $tag : 'unsupported_element',
default => match ( $kind ) {
'form', 'control' => 'interactive_form',
'script' => 'runtime_script',
'canvas' => 'runtime_canvas',
default => '' !== $tag ? 'html_' . $tag : 'html_fallback',
},
};
}

/**
* @param array<string, mixed> $fields
*/
private static function patternFamilyDetail(array $fields): string
{
$parts = array_filter(array(
(string) ($fields['tag'] ?? ''),
(string) ($fields['reason'] ?? $fields['preservation_reason'] ?? ''),
(string) ($fields['runtime_requirement'] ?? ''),
));

return implode(':', $parts);
}

/**
* @return array{ids: int, classes: int, attributes: int, pseudo_classes: int, elements: int, score: string}
*/
private static function selectorSpecificity(string $selector): array
{
preg_match_all('/#[A-Za-z0-9_-]+/', $selector, $ids);
preg_match_all('/\.[A-Za-z0-9_-]+/', $selector, $classes);
preg_match_all('/\[[^\]]+\]/', $selector, $attributes);
preg_match_all('/:nth-of-type\(/', $selector, $pseudoClasses);
preg_match_all('/(?:^|>\s*)([a-z][a-z0-9-]*)/i', $selector, $elements);

$idCount = count($ids[0]);
$classCount = count($classes[0]);
$attributeCount = count($attributes[0]);
$pseudoClassCount = count($pseudoClasses[0]);
$elementCount = count($elements[1]);

return array(
'ids' => $idCount,
'classes' => $classCount,
'attributes' => $attributeCount,
'pseudo_classes' => $pseudoClassCount,
'elements' => $elementCount,
'score' => $idCount . ',' . ($classCount + $attributeCount + $pseudoClassCount) . ',' . $elementCount,
);
}

/**
* @param array<string, mixed> $context
*/
private static function parentReason(array $context): string
{
$parent = is_string($context['parent_tag'] ?? null) ? trim($context['parent_tag']) : '';

return '' !== $parent ? 'inside_' . $parent : '';
}

/**
* @param array<string, mixed> $context
*/
private static function ancestorReason(array $context): string
{
$ancestors = is_array($context['ancestor_tags'] ?? null) ? array_values(array_filter($context['ancestor_tags'], 'is_string')) : array();

return array() !== $ancestors ? 'within_' . implode('_', $ancestors) : '';
}

/**
* @param array<string, mixed> $fields
*/
private static function genericRepairClass(array $fields, string $patternFamily): string
{
if ( is_string($fields['suggested_repair_class'] ?? null) && '' !== trim($fields['suggested_repair_class']) ) {
return (string) $fields['suggested_repair_class'];
}

if ( str_starts_with($patternFamily, 'runtime_') || in_array($patternFamily, array('interactive_form', 'external_embed', 'inline_semantic_html'), true) ) {
return 'preserve_runtime_island';
}

if ( str_starts_with($patternFamily, 'unsupported_') ) {
return 'add_generic_pattern_recognizer';
}

if ( 'inline_svg' === $patternFamily ) {
return 'materialize_static_asset';
}

return 'review_generic_mapping';
}

/**
* Inline elements with semantic/ARIA/class hooks cannot be represented as
* editable RichText without risking attribute loss, so preserved runtime
* islands should cluster separately from generic raw-HTML fallbacks.
*
* @param array<string, mixed> $fields
*/
private static function isInlineSemanticHtmlRuntimeIsland(array $fields): bool
{
if ( 'dom' !== (string) ($fields['kind'] ?? '') ) {
return false;
}

$tag = strtolower((string) ($fields['tag'] ?? ''));
if ( ! in_array($tag, array('a', 'abbr', 'b', 'cite', 'code', 'data', 'em', 'i', 'kbd', 'label', 'mark', 'q', 's', 'small', 'span', 'strong', 'sub', 'sup', 'time', 'u', 'var'), true) ) {
return false;
}

$attributes = is_array($fields['attributes'] ?? null) ? $fields['attributes'] : array();
foreach ( array_keys($attributes) as $name ) {
$attributeName = strtolower((string) $name);
if ( 'class' === $attributeName || 'id' === $attributeName || 'role' === $attributeName || str_starts_with($attributeName, 'aria-') || str_starts_with($attributeName, 'data-') ) {
return true;
}
}

return false;
}
}
Loading
Loading