Skip to content

Set a maximum level of encoding nested arguments of exception traces #28324

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
skjnldsv merged 2 commits into from
Aug 5, 2021
Merged

Set a maximum level of encoding nested arguments of exception traces #28324

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
950de74
Set a maximum level of encoding nested arguments of exception traces
juliusknorr Aug 5, 2021
b235a85
Always list the class of an object first
juliusknorr Aug 5, 2021
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
25 changes: 20 additions & 5 deletions lib/private/Log/ExceptionSerializer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,14 +228,27 @@ private function encodeTrace($trace) {
}, $filteredTrace);
}

private function encodeArg($arg) {
private function encodeArg($arg, $nestingLevel = 5) {
Copy link
Member Author

@juliusknorr juliusknorr Aug 5, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

5 is rather random, but that should be more than enough to get something meaningful out of the arguments. Also too large nesting here will make the log more unreadable.

if (is_object($arg)) {
$data = get_object_vars($arg);
$data['__class__'] = get_class($arg);
return array_map([$this, 'encodeArg'], $data);
if ($nestingLevel === 0) {
return [
'__class__' => get_class($arg),
'__properties__' => 'Encoding skipped as the maximum nesting level was reached',
];
}

$objectInfo = [ '__class__' => get_class($arg) ];
$objectVars = get_object_vars($arg);
return array_map(function ($arg) use ($nestingLevel) {
return $this->encodeArg($arg, $nestingLevel - 1);
}, array_merge($objectInfo, $objectVars));
}

if (is_array($arg)) {
if ($nestingLevel === 0) {
return ['Encoding skipped as the maximum nesting level was reached'];
}

// Only log the first 5 elements of an array unless we are on debug
if ((int)$this->systemConfig->getValue('loglevel', 2) !== 0) {
$elemCount = count($arg);
Expand All @@ -244,7 +257,9 @@ private function encodeArg($arg) {
$arg[] = 'And ' . ($elemCount - 5) . ' more entries, set log level to debug to see all entries';
}
}
return array_map([$this, 'encodeArg'], $arg);
return array_map(function ($e) use ($nestingLevel) {
return $this->encodeArg($e, $nestingLevel - 1);
}, $arg);
}

return $arg;
Expand Down