Feature/clock interface issue 1902 #1938
Conversation
| @@ -164,21 +166,28 @@ class Logger implements LoggerInterface, ResettableInterface | |||
| */ | |||
| private bool $detectCycles = true; | |||
|
|
|||
| /** | |||
| * @var ClockInterface|null | |||
There was a problem hiding this comment.
this @var brings no value as it only repeat the native property type.
| use Throwable; | ||
| use Stringable; | ||
| use WeakMap; | ||
|
|
||
|
|
There was a problem hiding this comment.
should be removed. We don't need 2 empty lines.
| use Psr\Clock\ClockInterface; | ||
| use Monolog\JsonSerializableDateTimeImmutable; | ||
|
|
||
| class Clock implements ClockInterface |
There was a problem hiding this comment.
I suggest using a less specific name than Clock to avoid having it appearing high in IDE completion in projects using Monolog (while Monolog is not meant to become a library providing a clock for generic purposes that would involve making it more customizable)
| @@ -329,7 +338,7 @@ public function useLoggingLoopDetection(bool $detectCycles): self | |||
| * | |||
| * @phpstan-param value-of<Level::VALUES>|Level $level | |||
| */ | |||
| public function addRecord(int|Level $level, string $message, array $context = [], JsonSerializableDateTimeImmutable|null $datetime = null): bool | |||
| public function addRecord(int|Level $level, string $message, array $context = [], bool $useClock = false): bool | |||
There was a problem hiding this comment.
This signature change is a BC break, which is a no-go in a minor version (and a bad idea in a major version if we don't provide a migration path through deprecations first)
| @@ -356,8 +365,9 @@ public function addRecord(int|Level $level, string $message, array $context = [] | |||
| try { | |||
| $recordInitialized = \count($this->processors) === 0; | |||
|
|
|||
| $datetime = $useClock ? $this->clock->now() : new JsonSerializableDateTimeImmutable($this->microsecondTimestamps, $this->timezone); | |||
There was a problem hiding this comment.
phpstan is right about the issue reported here: if the caller passes true for $useClock, this will break when the clock is null.
And this is also quite useless when using the PSR-3 interface as those would never pass true there.
|
I'm closing the PR I'll create another one according to your review thank you @stof |
This PR introduces a new feature to allow users to specify a custom time for log records in Monolog. The enhancement involves integrating a Clock service that implements the PSR-20 ClockInterface, enabling more flexible and testable timestamp management.
Clock Integration: Added a Clock class that provides timestamps using JsonSerializableDateTimeImmutable. This allows for consistent and customizable time handling.
Logger Modification: Updated the Logger class to accept an optional ClockInterface parameter. The addRecord method now uses this clock to fetch timestamps when specified.
@Seldaek #1902 I saw this issue and I'm sending this PR