Skip to content

feat: add rich diff by default #346

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
merged 8 commits into from
Apr 9, 2025
Merged

feat: add rich diff by default #346

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
eefa3ad
feat: add rich diff by default
cedricziel Apr 8, 2025
ffaee2a
chore: add test covering multiple root spans
cedricziel Apr 8, 2025
8086656
chore: test more multiple root spans
cedricziel Apr 8, 2025
ca65103
chore: test missing nested span diff
cedricziel Apr 8, 2025
fe8124b
fix: dont use internal classes
cedricziel Apr 9, 2025
7f260de
fix: avoid possible type coercion
cedricziel Apr 9, 2025
78b41b1
chore: coverage
cedricziel Apr 9, 2025
22553f3
fix: add #Override
cedricziel Apr 9, 2025
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
298 changes: 181 additions & 117 deletions src/Utils/Test/src/Fluent/TraceAssertionFailedException.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,171 +60,187 @@ public function getActualStructure(): array
*/
private function formatDiff(array $expected, array $actual): string
{
$output = "\n\nExpected Trace Structure:\n";
$output .= $this->formatExpectedStructure($expected);
// First, convert the fluent assertion structures to a format suitable for diffing
$expectedStructure = $this->convertFluentStructureToArray($expected);
$actualStructure = $this->convertFluentStructureToArray($actual);

$output .= "\n\nActual Trace Structure:\n";
$output .= $this->formatActualStructure($actual);
// Generate a PHPUnit-style diff
$output = "\n\n--- Expected Trace Structure\n";
$output .= "+++ Actual Trace Structure\n";
$output .= "@@ @@\n";

// Generate the diff for the root level
$output .= $this->generateArrayDiff($expectedStructure, $actualStructure);

return $output;
}

/**
* Format the expected structure.
* Converts the fluent assertion structure to a format suitable for diffing.
*
* @param array $expected The expected structure
* @param int $indent The indentation level
* @return string
* @param array $structure The fluent assertion structure
* @return array The converted structure
*/
private function formatExpectedStructure(array $expected, int $indent = 0): string
private function convertFluentStructureToArray(array $structure): array
{
$output = '';
$indentation = str_repeat(' ', $indent);
$result = [];

foreach ($expected as $item) {
foreach ($structure as $item) {
if (!isset($item['type'])) {
continue;
}

switch ($item['type']) {
case 'root_span':
$output .= $indentation . "Root Span: \"{$item['name']}\"\n";
$result[] = [
'name' => $item['name'],
'type' => 'root',
];

break;
case 'root_span_count':
$output .= $indentation . "Root Span Count: {$item['count']}\n";

break;
case 'span_kind':
$output .= $indentation . 'Kind: ' . $this->formatKind($item['kind']) . "\n";
case 'child_span':
$result[] = [
'name' => $item['name'],
'type' => 'child',
];

break;
case 'span_attribute':
$output .= $indentation . "Attribute \"{$item['key']}\": " . $this->formatValue($item['value']) . "\n";

break;
case 'span_status':
$output .= $indentation . 'Status: Code=' . $this->formatValue($item['code']);
if (isset($item['description'])) {
$output .= ", Description=\"{$item['description']}\"";
}
$output .= "\n";
case 'missing_root_span':
$result[] = [
'name' => $item['expected_name'],
'type' => 'root',
'missing' => true,
'available' => $item['available_root_spans'] ?? [],
];

break;
case 'span_event':
$output .= $indentation . "Event: \"{$item['name']}\"\n";

break;
case 'span_event_attribute':
$output .= $indentation . "Event Attribute \"{$item['key']}\": " . $this->formatValue($item['value']) . "\n";
case 'missing_child_span':
$result[] = [
'name' => $item['expected_name'],
'type' => 'child',
'missing' => true,
'available' => $item['available_spans'] ?? [],
];

break;
case 'child_span':
$output .= $indentation . "Child Span: \"{$item['name']}\"\n";

break;
case 'child_span_count':
$output .= $indentation . "Child Span Count: {$item['count']}\n";
case 'root_span_count':
$result[] = [
'type' => 'count',
'count' => $item['count'],
'spans' => $item['spans'] ?? [],
];

break;

// Add other types as needed
}
}

return $output;
return $result;
}

/**
* Format the actual structure.
* Recursively generates a diff between two arrays.
*
* @param array $actual The actual structure
* @param int $indent The indentation level
* @return string
* @param array $expected The expected array
* @param array $actual The actual array
* @param int $depth The current depth for indentation
* @return string The formatted diff
*/
private function formatActualStructure(array $actual, int $indent = 0): string
private function generateArrayDiff(array $expected, array $actual, int $depth = 0): string
{
$output = '';
$indentation = str_repeat(' ', $indent);

foreach ($actual as $item) {
if (!isset($item['type'])) {
continue;
}

switch ($item['type']) {
case 'root_span':
$output .= $indentation . "Root Span: \"{$item['name']}\"\n";

break;
case 'missing_root_span':
$output .= $indentation . "Missing Root Span: \"{$item['expected_name']}\"\n";
if (!empty($item['available_root_spans'])) {
$output .= $indentation . ' Available Root Spans: ' . implode(', ', array_map(function ($name) {
return "\"$name\"";
}, $item['available_root_spans'])) . "\n";
}

break;
case 'root_span_count':
$output .= $indentation . "Root Span Count: {$item['count']}\n";
if (!empty($item['spans'])) {
$output .= $indentation . ' Root Spans: ' . implode(', ', array_map(function ($name) {
return "\"$name\"";
}, $item['spans'])) . "\n";
$indent = str_repeat(' ', $depth);

// If arrays are indexed numerically, compare them as lists
if ($this->isIndexedArray($expected) && $this->isIndexedArray($actual)) {
$output .= $indent . "Array (\n";

// Find the maximum index to iterate through
$maxIndex = max(count($expected), count($actual)) - 1;

for ($i = 0; $i <= $maxIndex; $i++) {
if (isset($expected[$i]) && isset($actual[$i])) {
// Both arrays have this index, compare the values
if (is_array($expected[$i]) && is_array($actual[$i])) {
// Both values are arrays, recursively compare
$output .= $indent . " [$i] => Array (\n";
$output .= $this->generateArrayDiff($expected[$i], $actual[$i], $depth + 2);
$output .= $indent . " )\n";
} elseif ($expected[$i] === $actual[$i]) {
// Values are the same
$output .= $indent . " [$i] => " . $this->formatValue($expected[$i]) . "\n";
} else {
// Values are different
$output .= $indent . "- [$i] => " . $this->formatValue($expected[$i]) . "\n";
$output .= $indent . "+ [$i] => " . $this->formatValue($actual[$i]) . "\n";
}
} elseif (isset($expected[$i])) {
// Only in expected
$output .= $indent . "- [$i] => " . $this->formatValue($expected[$i]) . "\n";
} else {
// Only in actual
$output .= $indent . "+ [$i] => " . $this->formatValue($actual[$i]) . "\n";
}
}

break;
case 'span_kind':
$output .= $indentation . 'Kind: ' . $this->formatKind($item['kind']) . "\n";

break;
case 'span_attribute':
$output .= $indentation . "Attribute \"{$item['key']}\": " . $this->formatValue($item['value']) . "\n";

break;
case 'missing_span_attribute':
$output .= $indentation . "Missing Attribute: \"{$item['key']}\"\n";

break;
case 'span_status':
$output .= $indentation . 'Status: Code=' . $this->formatValue($item['code']);
if (isset($item['description'])) {
$output .= ", Description=\"{$item['description']}\"";
$output .= $indent . ")\n";
} else {
// Compare as associative arrays
$output .= $indent . "Array (\n";

// Get all keys from both arrays
$allKeys = array_unique(array_merge(array_keys($expected), array_keys($actual)));
sort($allKeys);

foreach ($allKeys as $key) {
if (isset($expected[$key]) && isset($actual[$key])) {
// Both arrays have this key, compare the values
if (is_array($expected[$key]) && is_array($actual[$key])) {
// Both values are arrays, recursively compare
$output .= $indent . " ['$key'] => Array (\n";
$output .= $this->generateArrayDiff($expected[$key], $actual[$key], $depth + 2);
$output .= $indent . " )\n";
} elseif ($expected[$key] === $actual[$key]) {
// Values are the same
$output .= $indent . " ['$key'] => " . $this->formatValue($expected[$key]) . "\n";
} else {
// Values are different
$output .= $indent . "- ['$key'] => " . $this->formatValue($expected[$key]) . "\n";
$output .= $indent . "+ ['$key'] => " . $this->formatValue($actual[$key]) . "\n";
}
$output .= "\n";

break;
case 'span_event':
$output .= $indentation . "Event: \"{$item['name']}\"\n";

break;
case 'missing_span_event':
$output .= $indentation . "Missing Event: \"{$item['expected_name']}\"\n";

break;
case 'span_event_attribute':
$output .= $indentation . "Event Attribute \"{$item['key']}\": " . $this->formatValue($item['value']) . "\n";

break;
case 'child_span':
$output .= $indentation . "Child Span: \"{$item['name']}\"\n";

break;
case 'missing_child_span':
$output .= $indentation . "Missing Child Span: \"{$item['expected_name']}\"\n";
} elseif (isset($expected[$key])) {
// Only in expected
$output .= $indent . "- ['$key'] => " . $this->formatValue($expected[$key]) . "\n";
} else {
// Only in actual
$output .= $indent . "+ ['$key'] => " . $this->formatValue($actual[$key]) . "\n";
}
}

break;
case 'unexpected_child_span':
$output .= $indentation . "Unexpected Child Span: \"{$item['name']}\"\n";
$output .= $indent . ")\n";
}

break;
case 'child_span_count':
$output .= $indentation . "Child Span Count: {$item['count']}\n";
return $output;
}

break;
}
/**
* Checks if an array is indexed numerically (not associative).
*
* @param array $array The array to check
* @return bool True if the array is indexed, false if it's associative
*/
private function isIndexedArray(array $array): bool
{
if (empty($array)) {
return true;
}

return $output;
return array_keys($array) === range(0, count($array) - 1);
}

/**
Expand All @@ -242,14 +258,32 @@ private function formatValue($value): string
} elseif (null === $value) {
return 'null';
} elseif (is_array($value)) {
// Check if this array looks like a status
if (isset($value['code']) || isset($value['description'])) {
return $this->formatStatus($value);
}

$json = json_encode($value);

return $json === false ? '[unable to encode]' : $json;
} elseif (is_int($value) && $this->isSpanKind($value)) {
return $this->formatKind($value);
}

return (string) $value;
}

/**
* Checks if a value is a span kind.
*
* @param int $value The value to check
* @return bool True if the value is a span kind
*/
private function isSpanKind(int $value): bool
{
return $value >= 0 && $value <= 4;
}

/**
* Format a span kind for display.
*
Expand All @@ -268,4 +302,34 @@ private function formatKind(int $kind): string

return $kinds[$kind] ?? "UNKNOWN_KIND($kind)";
}

/**
* Format a span status for display.
*
* @param array $status The span status
* @return string
*/
private function formatStatus(array $status): string
{
$output = 'Status: Code=';

if (isset($status['code'])) {
$statusCodes = [
0 => 'STATUS_UNSET',
1 => 'STATUS_OK',
2 => 'STATUS_ERROR',
];

$code = $status['code'];
$output .= isset($statusCodes[$code]) ? $statusCodes[$code] : "UNKNOWN_STATUS($code)";
} else {
$output .= 'UNDEFINED';
}

if (isset($status['description']) && $status['description']) {
$output .= ", Description=\"{$status['description']}\"";
}

return $output;
}
}
Loading