[VUFIND-1793] Logger improvements - #5609
Open
meganschanz wants to merge 4 commits into
Open
Conversation
Contributor
Author
|
No urgency at all to review this (it's not blocking any other work). I just had some free time this afternoon and thought I'd get this off my to-do list. |
demiankatz
requested changes
Sep 6, 2026
demiankatz
left a comment
demiankatz
left a comment
Member
There was a problem hiding this comment.
Thanks, @meganschanz, this looks good to me -- see below for a few nitpicks and suggested simplifications (I just can't resist compacting or null coalescing when I see an opportunity).
| */ | ||
| protected function fillInMissingDetails(array $context = []): array | ||
| { | ||
| if (!array_key_exists('details', $context) || !is_array($context['details'])) { |
Member
There was a problem hiding this comment.
This might be a little simpler:
Suggested change
| if (!array_key_exists('details', $context) || !is_array($context['details'])) { | |
| if (!is_array($context['details'] ?? null)) { |
|
|
||
| foreach ($levels as $level) { | ||
| // This level has data, no need to look further | ||
| if (isset($details[$level]) && $details[$level] !== '') { |
Member
There was a problem hiding this comment.
Slightly more concise:
Suggested change
| if (isset($details[$level]) && $details[$level] !== '') { | |
| if (($details[$level] ?? '') !== '') { |
| } | ||
|
|
||
| // Try prior index (Backfill) | ||
| if (isset($details[$level - 1]) && $details[$level - 1] !== '') { |
Member
There was a problem hiding this comment.
Suggested change
| if (isset($details[$level - 1]) && $details[$level - 1] !== '') { | |
| if (($details[$level - 1] ?? '') !== '') { |
| } | ||
|
|
||
| // Try next index (Frontfill) | ||
| if (isset($details[$level + 1]) && $details[$level + 1] !== '') { |
Member
There was a problem hiding this comment.
Suggested change
| if (isset($details[$level + 1]) && $details[$level + 1] !== '') { | |
| if (($details[$level + 1] ?? '') !== '') { |
Comment on lines
+356
to
+358
| [ | ||
| 'details' => $details, | ||
| ] |
Member
There was a problem hiding this comment.
More concise:
Suggested change
| [ | |
| 'details' => $details, | |
| ] | |
| compact('details') |
| * | ||
| * @param \Exception $exception Exception to log | ||
| * @param \Exception $exception Exception to log | ||
| * @param \Laminas\Stdlib\Parameters $server Optional server metadata |
Member
There was a problem hiding this comment.
This appears to support array format and null as well; might as well document that.
Suggested change
| * @param \Laminas\Stdlib\Parameters $server Optional server metadata | |
| * @param \Laminas\Stdlib\Parameters|array|null $server Optional server metadata |
Contributor
Author
|
The suggested changes have been applied. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This implements the changes discussed in VUFIND-1793 which add some quality of life improvements to logging. I updated the log calls that were added in #4678 as a sample of usage going forward.
I also have a draft ready of updates to include on https://vufind.org/wiki/development:architecture:logging once this is merged.