Clock service and decorator

src/Clock/Clock.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\EventSourcing\Clock;
+
+use DateTimeImmutable;
+
+interface Clock
+{
+    public function create(): DateTimeImmutable;
+}

src/Clock/FreezeClock.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\EventSourcing\Clock;
+
+use DateTimeImmutable;
+
+use function sprintf;
+
+final class FreezeClock implements Clock
+{
+    public function __construct(private DateTimeImmutable $frozenDateTime)
+    {
+    }
+
+    public function update(DateTimeImmutable $frozenDateTime): void
+    {
+        $this->frozenDateTime = $frozenDateTime;
+    }
+
+    /**
+     * @param positive-int $seconds
+     */
+    public function sleep(int $seconds): void
+    {
+        $this->frozenDateTime = $this->frozenDateTime->modify(sprintf('+%s seconds', $seconds));
+    }
+
+    public function create(): DateTimeImmutable
+    {
+        return $this->frozenDateTime;
+    }
+}

src/Clock/SystemClock.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\EventSourcing\Clock;
+
+use DateTimeImmutable;
+
+final class SystemClock implements Clock
+{
+    public function create(): DateTimeImmutable
+    {
+        return new DateTimeImmutable();
+    }
+}

src/EventBus/Decorator/RecordedOnDecorator.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\EventSourcing\EventBus\Decorator;
+
+use Patchlevel\EventSourcing\Clock\Clock;
+use Patchlevel\EventSourcing\EventBus\Message;
+
+final class RecordedOnDecorator implements MessageDecorator
+{
+    public function __construct(private readonly Clock $clock)
+    {
+    }
+
+    public function __invoke(Message $message): Message
+    {
+        return $message->withRecordedOn($this->clock->create());
+    }
+}

src/Repository/DefaultRepository.php

@@ -5,8 +5,9 @@
 namespace Patchlevel\EventSourcing\Repository;
 
 use Patchlevel\EventSourcing\Aggregate\AggregateRoot;
-use Patchlevel\EventSourcing\Clock;
+use Patchlevel\EventSourcing\Clock\SystemClock;
 use Patchlevel\EventSourcing\EventBus\Decorator\MessageDecorator;
+use Patchlevel\EventSourcing\EventBus\Decorator\RecordedOnDecorator;
 use Patchlevel\EventSourcing\EventBus\EventBus;
 use Patchlevel\EventSourcing\EventBus\Message;
 use Patchlevel\EventSourcing\Metadata\AggregateRoot\AggregateRootMetadata;
@@ -37,7 +38,7 @@ final class DefaultRepository implements Repository
     private ?SnapshotStore $snapshotStore;
     private LoggerInterface $logger;
     private AggregateRootMetadata $metadata;
-    private ?MessageDecorator $messageDecorator;
+    private MessageDecorator $messageDecorator;
 
     /**
      * @param class-string<T> $aggregateClass
@@ -54,7 +55,7 @@ public function __construct(
         $this->eventBus = $eventBus;
         $this->aggregateClass = $aggregateClass;
         $this->snapshotStore = $snapshotStore;
-        $this->messageDecorator = $messageDecorator;
+        $this->messageDecorator = $messageDecorator ??  new RecordedOnDecorator(new SystemClock());
         $this->logger = $logger ?? new NullLogger();
         $this->metadata = $aggregateClass::metadata();
     }
@@ -128,14 +129,9 @@ static function (object $event) use ($aggregate, &$playhead, $messageDecorator)
                 $message = Message::create($event)
                     ->withAggregateClass($aggregate::class)
                     ->withAggregateId($aggregate->aggregateRootId())
-                    ->withPlayhead(++$playhead)
-                    ->withRecordedOn(Clock::createDateTimeImmutable());
+                    ->withPlayhead(++$playhead);
 
-                if ($messageDecorator) {
-                    $message = $messageDecorator($message);
-                }
-
-                return $message;
+                return $messageDecorator($message);
             },
             $events
         );

src/Repository/DefaultRepositoryManager.php

@@ -5,7 +5,9 @@
 namespace Patchlevel\EventSourcing\Repository;
 
 use Patchlevel\EventSourcing\Aggregate\AggregateRoot;
+use Patchlevel\EventSourcing\Clock\SystemClock;
 use Patchlevel\EventSourcing\EventBus\Decorator\MessageDecorator;
+use Patchlevel\EventSourcing\EventBus\Decorator\RecordedOnDecorator;
 use Patchlevel\EventSourcing\EventBus\EventBus;
 use Patchlevel\EventSourcing\Metadata\AggregateRoot\AggregateRootClassNotRegistered;
 use Patchlevel\EventSourcing\Metadata\AggregateRoot\AggregateRootRegistry;
@@ -22,7 +24,7 @@ final class DefaultRepositoryManager implements RepositoryManager
     private Store $store;
     private EventBus $eventBus;
     private ?SnapshotStore $snapshotStore;
-    private ?MessageDecorator $messageDecorator;
+    private MessageDecorator $messageDecorator;
     private LoggerInterface $logger;
 
     /** @var array<class-string<AggregateRoot>, Repository> */
@@ -40,7 +42,7 @@ public function __construct(
         $this->store = $store;
         $this->eventBus = $eventBus;
         $this->snapshotStore = $snapshotStore;
-        $this->messageDecorator = $messageDecorator;
+        $this->messageDecorator = $messageDecorator ??  new RecordedOnDecorator(new SystemClock());
         $this->logger = $logger ?? new NullLogger();
     }
 

tests/Integration/BasicImplementation/BasicIntegrationTest.php

@@ -5,12 +5,16 @@
 namespace Patchlevel\EventSourcing\Tests\Integration\BasicImplementation;
 
 use Doctrine\DBAL\Connection;
+use Patchlevel\EventSourcing\Clock\SystemClock;
+use Patchlevel\EventSourcing\EventBus\Decorator\ChainMessageDecorator;
+use Patchlevel\EventSourcing\EventBus\Decorator\RecordedOnDecorator;
 use Patchlevel\EventSourcing\EventBus\DefaultEventBus;
 use Patchlevel\EventSourcing\EventBus\SymfonyEventBus;
+use Patchlevel\EventSourcing\Metadata\AggregateRoot\AggregateRootRegistry;
 use Patchlevel\EventSourcing\Metadata\AggregateRoot\AttributeAggregateRootRegistryFactory;
 use Patchlevel\EventSourcing\Projection\MetadataAwareProjectionHandler;
 use Patchlevel\EventSourcing\Projection\ProjectionListener;
-use Patchlevel\EventSourcing\Repository\DefaultRepository;
+use Patchlevel\EventSourcing\Repository\DefaultRepositoryManager;
 use Patchlevel\EventSourcing\Schema\DoctrineSchemaManager;
 use Patchlevel\EventSourcing\Serializer\DefaultEventSerializer;
 use Patchlevel\EventSourcing\Snapshot\Adapter\InMemorySnapshotAdapter;
@@ -60,13 +64,14 @@ public function testSuccessful(): void
             'eventstore'
         );
 
-        $repository = new DefaultRepository(
+        $manager = new DefaultRepositoryManager(
+            new AggregateRootRegistry(['profile' => Profile::class]),
             $store,
             $eventStream,
-            Profile::class,
             null,
-            new FooMessageDecorator()
+            new ChainMessageDecorator([new RecordedOnDecorator(new SystemClock()), new FooMessageDecorator()])
         );
+        $repository = $manager->get(Profile::class);
 
         // create tables
         $profileProjection->create();
@@ -82,7 +87,14 @@ public function testSuccessful(): void
         self::assertSame('1', $result['id']);
         self::assertSame('John', $result['name']);
 
-        $repository = new DefaultRepository($store, $eventStream, Profile::class);
+        $manager = new DefaultRepositoryManager(
+            new AggregateRootRegistry(['profile' => Profile::class]),
+            $store,
+            $eventStream,
+            null,
+            new ChainMessageDecorator([new RecordedOnDecorator(new SystemClock())])
+        );
+        $repository = $manager->get(Profile::class);
         $profile = $repository->load('1');
 
         self::assertInstanceOf(Profile::class, $profile);
@@ -111,7 +123,14 @@ public function testWithSymfonySuccessful(): void
             'eventstore'
         );
 
-        $repository = new DefaultRepository($store, $eventStream, Profile::class);
+        $manager = new DefaultRepositoryManager(
+            new AggregateRootRegistry(['profile' => Profile::class]),
+            $store,
+            $eventStream,
+            null,
+            new ChainMessageDecorator([new RecordedOnDecorator(new SystemClock())])
+        );
+        $repository = $manager->get(Profile::class);
 
         // create tables
         $profileProjection->create();
@@ -127,13 +146,14 @@ public function testWithSymfonySuccessful(): void
         self::assertSame('1', $result['id']);
         self::assertSame('John', $result['name']);
 
-        $repository = new DefaultRepository(
+        $manager = new DefaultRepositoryManager(
+            new AggregateRootRegistry(['profile' => Profile::class]),
             $store,
             $eventStream,
-            Profile::class,
             null,
-            new FooMessageDecorator()
+            new ChainMessageDecorator([new RecordedOnDecorator(new SystemClock()), new FooMessageDecorator()])
         );
+        $repository = $manager->get(Profile::class);
 
         $profile = $repository->load('1');
 
@@ -161,13 +181,14 @@ public function testMultiTableSuccessful(): void
             (new AttributeAggregateRootRegistryFactory())->create([__DIR__ . '/Aggregate']),
         );
 
-        $repository = new DefaultRepository(
+        $manager = new DefaultRepositoryManager(
+            new AggregateRootRegistry(['profile' => Profile::class]),
             $store,
             $eventStream,
-            Profile::class,
             null,
-            new FooMessageDecorator()
+            new ChainMessageDecorator([new RecordedOnDecorator(new SystemClock()), new FooMessageDecorator()])
         );
+        $repository = $manager->get(Profile::class);
 
         // create tables
         $profileProjection->create();
@@ -183,7 +204,14 @@ public function testMultiTableSuccessful(): void
         self::assertSame('1', $result['id']);
         self::assertSame('John', $result['name']);
 
-        $repository = new DefaultRepository($store, $eventStream, Profile::class);
+        $manager = new DefaultRepositoryManager(
+            new AggregateRootRegistry(['profile' => Profile::class]),
+            $store,
+            $eventStream,
+            null,
+            new ChainMessageDecorator([new RecordedOnDecorator(new SystemClock())])
+        );
+        $repository = $manager->get(Profile::class);
         $profile = $repository->load('1');
 
         self::assertInstanceOf(Profile::class, $profile);
@@ -211,15 +239,14 @@ public function testSnapshot(): void
             'eventstore'
         );
 
-        $snapshotStore = new DefaultSnapshotStore(['default' => new InMemorySnapshotAdapter()]);
-
-        $repository = new DefaultRepository(
+        $manager = new DefaultRepositoryManager(
+            new AggregateRootRegistry(['profile' => Profile::class]),
             $store,
             $eventStream,
-            Profile::class,
-            $snapshotStore,
-            new FooMessageDecorator()
+            new DefaultSnapshotStore(['default' => new InMemorySnapshotAdapter()]),
+            new ChainMessageDecorator([new RecordedOnDecorator(new SystemClock()), new FooMessageDecorator()])
         );
+        $repository = $manager->get(Profile::class);
 
         // create tables
         $profileProjection->create();
@@ -235,7 +262,14 @@ public function testSnapshot(): void
         self::assertSame('1', $result['id']);
         self::assertSame('John', $result['name']);
 
-        $repository = new DefaultRepository($store, $eventStream, Profile::class, $snapshotStore);
+        $manager = new DefaultRepositoryManager(
+            new AggregateRootRegistry(['profile' => Profile::class]),
+            $store,
+            $eventStream,
+            null,
+            new ChainMessageDecorator([new RecordedOnDecorator(new SystemClock())])
+        );
+        $repository = $manager->get(Profile::class);
         $profile = $repository->load('1');
 
         self::assertInstanceOf(Profile::class, $profile);