[12.x] Replace logger helper and log function concrete return type ?LogManager with abstract ?LoggerInterface #57028
+6
−4
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.
Change
Change helper function
logger
return type to?LoggerInterface
instead of?LoggerManager
.LoggerManager
implementsLoggerInterface
, which means any code expecting aLogManager
should still work fine since this is the wider type.Motivation
The return type was introduced in a recent PR #56684 . Introducing the change to our codebase broke multiple tests where we mocked the logger function using a
LoggerInterface
mock instance.Programming for interfaces is a widely accepted practice in the industry, thus the function should be returning an Interface instead of a concrete type to be flexible enough for any more logger classes in the future.