Merge pull request #761 from patchlevel/merge-stream-store-into-store-interface

Merge `StreamStore` into `Store` interface

Author: DavidBadura

baseline.xml

@@ -88,9 +88,6 @@
     <PropertyTypeCoercion>
       <code><![CDATA[new WeakMap()]]></code>
     </PropertyTypeCoercion>
-    <UndefinedInterfaceMethod>
-      <code><![CDATA[archive]]></code>
-    </UndefinedInterfaceMethod>
   </file>
   <file src="src/Schema/DoctrineHelper.php">
     <InternalMethod>

docs/pages/UPGRADE-4.0.md

@@ -85,6 +85,10 @@ $subscriptionEngine = new DefaultSubscriptionEngine(
 ```
 ## Store
 
+### StreamStore
+
+`StreamStore` interface was merged with `Store` interface.
+
 ### DoctrineDbalStore
 
 `DoctrineDbalStore` has been removed in favor of `StreamDoctrineDbalStore`.
@@ -94,7 +98,10 @@ And all the associated classes:
 * `Patchlevel\EventSourcing\Store\Criteria\AggregateIdCriterion`
 * `Patchlevel\EventSourcing\Store\DoctrineDbalStore`
 * `Patchlevel\EventSourcing\Store\DoctrineDbalStoreStream`
-* `Patchlevel\EventSourcing\Store\ReadOnlyStore`
+
+### StreamReadOnlyStore
+
+`StreamReadOnlyStore` was been merged in `ReadOnlyStore`.
 
 ## Message
 

docs/pages/store.md

@@ -83,11 +83,11 @@ It passes all methods to the underlying store, but throws an `StoreIsReadOnly` e
 operations.
 
 ```php
-use Patchlevel\EventSourcing\Store\StreamReadOnlyStore;
+use Patchlevel\EventSourcing\Store\ReadOnlyStore;
 use Patchlevel\EventSourcing\Store\StreamStore;
 
 /** @var StreamStore $store */
-$readOnlyStore = new StreamReadOnlyStore($store);
+$readOnlyStore = new ReadOnlyStore($store);
 ```
 ## Schema
 

src/Repository/DefaultRepository.php

@@ -25,7 +25,6 @@
 use Patchlevel\EventSourcing\Store\Store;
 use Patchlevel\EventSourcing\Store\Stream;
 use Patchlevel\EventSourcing\Store\StreamStartHeader;
-use Patchlevel\EventSourcing\Store\StreamStore;
 use Patchlevel\EventSourcing\Store\UniqueConstraintViolation;
 use Psr\Clock\ClockInterface;
 use Psr\Log\LoggerInterface;
@@ -253,7 +252,7 @@ static function (object $event) use (
             );
 
             try {
-                if ($archiveTo !== null && $this->store instanceof StreamStore) {
+                if ($archiveTo !== null) {
                     $this->store->transactional(
                         function () use ($messages, $streamName, $archiveTo): void {
                             $this->store->save(...$messages);

src/Store/InMemoryStore.php

@@ -30,7 +30,7 @@
 
 use const ARRAY_FILTER_USE_BOTH;
 
-final class InMemoryStore implements StreamStore
+final class InMemoryStore implements Store
 {
     /** @param array<positive-int|0, Message> $messages */
     public function __construct(

src/Store/StreamReadOnlyStore.php src/Store/ReadOnlyStore.phpsrc/Store/StreamReadOnlyStore.php renamed to src/Store/ReadOnlyStore.php

@@ -9,10 +9,10 @@
 use Patchlevel\EventSourcing\Store\Criteria\Criteria;
 use Psr\Log\LoggerInterface;
 
-final class StreamReadOnlyStore implements StreamStore
+final class ReadOnlyStore implements Store
 {
     public function __construct(
-        private readonly StreamStore $store,
+        private readonly Store $store,
         private readonly LoggerInterface|null $logger = null,
     ) {
     }

src/Store/Store.php

@@ -31,4 +31,11 @@ public function save(Message ...$messages): void;
      * @template ClosureReturn
      */
     public function transactional(Closure $function): void;
+
+    /** @return list<string> */
+    public function streams(): array;
+
+    public function remove(Criteria|null $criteria = null): void;
+
+    public function archive(Criteria|null $criteria = null): void;
 }

src/Store/StreamDoctrineDbalStore.php

@@ -58,7 +58,7 @@
 use function str_contains;
 use function str_replace;
 
-final class StreamDoctrineDbalStore implements StreamStore, SubscriptionStore, DoctrineSchemaConfigurator
+final class StreamDoctrineDbalStore implements Store, SubscriptionStore, DoctrineSchemaConfigurator
 {
     /**
      * PostgreSQL has a limit of 65535 parameters in a single query.

src/Store/StreamStore.php

@@ -19,8 +19,8 @@
 use Patchlevel\EventSourcing\Store\Header\PlayheadHeader;
 use Patchlevel\EventSourcing\Store\Header\RecordedOnHeader;
 use Patchlevel\EventSourcing\Store\Header\StreamNameHeader;
+use Patchlevel\EventSourcing\Store\Store;
 use Patchlevel\EventSourcing\Store\StreamDoctrineDbalStore;
-use Patchlevel\EventSourcing\Store\StreamStore;
 use Patchlevel\EventSourcing\Store\UniqueConstraintViolation;
 use Patchlevel\EventSourcing\Tests\DbalManager;
 use Patchlevel\EventSourcing\Tests\Integration\Store\Events\ExternEvent;
@@ -37,7 +37,7 @@
 final class StreamDoctrineDbalStoreTest extends TestCase
 {
     private Connection $connection;
-    private StreamStore $store;
+    private Store $store;
 
     private ClockInterface $clock;