Skip to content

Harden php-transformer plugin helper contract #36

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
Jun 21, 2026
Merged

Harden php-transformer plugin helper contract #36

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
51 changes: 40 additions & 11 deletions php-transformer/tests/contract/plugin-bootstrap.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,43 @@
assertSame('0.1.0', blocks_engine_php_transformer_version(), 'Plugin helper exposes version.');
assertSame(dirname(__DIR__, 2), blocks_engine_php_transformer_path(), 'Plugin helper exposes package path.');

$htmlResult = blocks_engine_php_transformer_transform_html(
'<main><h1>Plugin bootstrap</h1><p>Ready.</p></main>',
array(
'source' => 'fixture:plugin-bootstrap',
'scope' => 'contract-test',
)
$htmlInput = '<main><h1>Plugin bootstrap</h1><p>Ready.</p></main>';
$htmlOptions = array(
'source' => 'fixture:plugin-bootstrap',
'scope' => 'contract-test',
);
$htmlResult = blocks_engine_php_transformer_transform_html($htmlInput, $htmlOptions);

$canonicalHtmlResult = ( new Automattic\BlocksEngine\PhpTransformer\HtmlToBlocks\HtmlTransformer() )
->transform($htmlInput, $htmlOptions)
->toArray();

assertSame('success', $htmlResult['status'] ?? '', 'HTML helper returns a successful canonical result.');
assertSame('fixture:plugin-bootstrap', $htmlResult['provenance'][0]['source'] ?? '', 'HTML helper preserves provenance source.');
assertSame(normalizeTransformerResult($canonicalHtmlResult), normalizeTransformerResult($htmlResult), 'HTML helper matches the canonical class result envelope.');

$formatInput = '# Plugin bootstrap';
$formatResult = blocks_engine_php_transformer_convert_format($formatInput, 'markdown', 'blocks');

$canonicalFormatResult = ( new Automattic\BlocksEngine\PhpTransformer\FormatBridge\FormatBridge() )
->convertResult($formatInput, 'markdown', 'blocks')
->toArray();

$formatResult = blocks_engine_php_transformer_convert_format('# Plugin bootstrap', 'markdown', 'blocks');
assertSame('success', $formatResult['status'] ?? '', 'Format helper returns a successful canonical result.');
assertSame(normalizeTransformerResult($canonicalFormatResult), normalizeTransformerResult($formatResult), 'Format helper matches the canonical class result envelope.');

$artifactResult = blocks_engine_php_transformer_compile_artifact(
array(
'generated_html' => '<main><h1>Plugin artifact</h1></main>',
)
$artifactInput = array(
'generated_html' => '<main><h1>Plugin artifact</h1></main>',
);
$artifactResult = blocks_engine_php_transformer_compile_artifact($artifactInput);

$canonicalArtifactResult = ( new Automattic\BlocksEngine\PhpTransformer\ArtifactCompiler\ArtifactCompiler() )
->compile($artifactInput)
->toArray();

assertSame('success', $artifactResult['status'] ?? '', 'Artifact helper returns a successful canonical result.');
assertSame('index.html', $artifactResult['source_reports']['artifact']['entry_path'] ?? '', 'Artifact helper exposes canonical source reports.');
assertSame(normalizeTransformerResult($canonicalArtifactResult), normalizeTransformerResult($artifactResult), 'Artifact helper matches the canonical class result envelope.');

fwrite(STDOUT, "Plugin bootstrap contract passed.\n");

Expand All @@ -38,3 +53,17 @@ function assertSame(mixed $expected, mixed $actual, string $message): void
exit(1);
}
}

/**
* Remove per-call timing before comparing otherwise identical result envelopes.
*
* @param array<string, mixed> $result Transformer result envelope.
* @return array<string, mixed>
*/
function normalizeTransformerResult(array $result): array
{
unset($result['metrics']['transform_duration_ms']);
unset($result['source_reports']['conversion_report']['metrics']['transform_duration_ms']);

return $result;
}
Loading