Merge pull request #758 from patchlevel/remove-legacy-store

Remove deprecated `DoctrineDbalStore` in favor of `StreamDoctrineDbalStore`

Author: DavidBadura

baseline.xml

@@ -82,9 +82,6 @@
     </MixedMethodCall>
   </file>
   <file src="src/Repository/DefaultRepository.php">
-    <PossiblyNullArgument>
-      <code><![CDATA[$streamName]]></code>
-    </PossiblyNullArgument>
     <PropertyTypeCoercion>
       <code><![CDATA[new WeakMap()]]></code>
     </PropertyTypeCoercion>
@@ -131,14 +128,6 @@
       <code><![CDATA[$streamName]]></code>
     </PropertyTypeCoercion>
   </file>
-  <file src="src/Store/DoctrineDbalStoreStream.php">
-    <ArgumentTypeCoercion>
-      <code><![CDATA[(int)$data['playhead']]]></code>
-    </ArgumentTypeCoercion>
-    <MixedArgument>
-      <code><![CDATA[$dateTimeType->convertToPHPValue($data['recorded_on'], $platform)]]></code>
-    </MixedArgument>
-  </file>
   <file src="src/Store/InMemoryStore.php">
     <MixedPropertyTypeCoercion>
       <code><![CDATA[$this->messages]]></code>

docs/pages/UPGRADE-4.0.md

@@ -4,13 +4,14 @@
 
 ### Child Aggregate
 
-We removed our experimental feature of child aggregates. 
+We removed our experimental feature of child aggregates.
 This was our first attempt to split aggregates into smaller parts,
 but we found a better way to do this with the `Micro Aggregate` feature.
 
 ## Subscription
 
 The constructor of the `DefaultSubscriptionEngine` class has been changed.
+
 * Instead of passing a `Store` instance, you now need to pass a `MessageLoader` instance.
 * Instead of passing a `RetryStrategy` instance, you now need to pass a `RetryStrategyRepository` instance.
 
@@ -59,4 +60,32 @@ $subscriptionEngine = new DefaultSubscriptionEngine(
     $subscriberAccessorRepository,
     RetryStrategyRepository::withDefault($retryStrategy),
 );
-```
+```
+
+## Store
+
+### DoctrineDbalStore
+
+`DoctrineDbalStore` has been removed in favor of `StreamDoctrineDbalStore`.
+And all the associated classes:
+
+* `Patchlevel\EventSourcing\Store\Criteria\AggregateNameCriterion`
+* `Patchlevel\EventSourcing\Store\Criteria\AggregateIdCriterion`
+* `Patchlevel\EventSourcing\Store\DoctrineDbalStore`
+* `Patchlevel\EventSourcing\Store\DoctrineDbalStoreStream`
+* `Patchlevel\EventSourcing\Store\ReadOnlyStore`
+
+## Message
+
+### AggregateHeader
+
+`Patchlevel\EventSourcing\Aggregate\AggregateHeader` has been removed
+and replaced with the following headers:
+
+* `Patchlevel\EventSourcing\Store\Header\StreamNameHeader`
+* `Patchlevel\EventSourcing\Store\Header\PlayheadHeader`
+* `Patchlevel\EventSourcing\Store\Header\RecordedOnHeader`
+
+### AggregateToStreamHeaderTranslator
+
+`Patchlevel\EventSourcing\Store\AggregateToStreamHeaderTranslator` has been removed.

docs/pages/aggregate.md

@@ -360,10 +360,6 @@ final class Profile extends BasicAggregateRoot
 
 ## Stream Name
 
-!!! warning
-
-    The `stream name` works only with the [StreamDoctrineDbalStore](./store.md#streamdoctrinedbalstore).
-    
 The stream name is the name of the stream in the event store.
 By default, the stream name has the format `aggregateName-aggregateId`.
 But you can also define your own stream name with the `Stream` attribute.
@@ -657,10 +653,6 @@ For these cases you can use Micro Aggregates.
 
 ### Micro Aggregates
 
-!!! warning
-
-    This feature works only with the [StreamDoctrineDbalStore](./store.md#streamdoctrinedbalstore).
-    
 Micro Aggregates are a pattern to split an aggregate into several smaller aggregates.
 Each of these aggregates is saved in the same stream.
 This gives the Micro Aggregates the ability to independently manage their state and trigger their events,
@@ -740,7 +732,6 @@ final class Shipping extends BasicAggregateRoot
     }
 }
 ```
-
 ## Aggregate Root Registry
 
 The library needs to know about all aggregates so that the correct aggregate class is used to load from the database.

docs/pages/getting_started.md

@@ -276,7 +276,7 @@ use Doctrine\DBAL\Tools\DsnParser;
 use Patchlevel\EventSourcing\Metadata\AggregateRoot\AttributeAggregateRootRegistryFactory;
 use Patchlevel\EventSourcing\Repository\DefaultRepositoryManager;
 use Patchlevel\EventSourcing\Serializer\DefaultEventSerializer;
-use Patchlevel\EventSourcing\Store\DoctrineDbalStore;
+use Patchlevel\EventSourcing\Store\StreamDoctrineDbalStore;
 use Patchlevel\EventSourcing\Subscription\Engine\DefaultSubscriptionEngine;
 use Patchlevel\EventSourcing\Subscription\Repository\RunSubscriptionEngineRepositoryManager;
 use Patchlevel\EventSourcing\Subscription\Store\DoctrineSubscriptionStore;
@@ -296,7 +296,7 @@ $mailer;
 $serializer = DefaultEventSerializer::createFromPaths(['src/Domain/Hotel/Event']);
 $aggregateRegistry = (new AttributeAggregateRootRegistryFactory())->create(['src/Domain/Hotel']);
 
-$eventStore = new DoctrineDbalStore(
+$eventStore = new StreamDoctrineDbalStore(
     $connection,
     $serializer,
 );

docs/pages/store.md

@@ -12,73 +12,10 @@ The store is optimized to efficiently store and load events for aggregates.
 ## Configure Store
 
 We offer different stores to store the messages.
-Two stores based on [doctrine dbal](https://www.doctrine-project.org/projects/dbal.html)
-and one in-memory store for testing purposes.
 
-### DoctrineDbalStore
-
-This is the current default store for event sourcing.
-You can create a store with the `DoctrineDbalStore` class.
-The store needs a dbal connection, an event serializer and has some optional parameters like options.
-
-```php
-use Doctrine\DBAL\DriverManager;
-use Doctrine\DBAL\Tools\DsnParser;
-use Patchlevel\EventSourcing\Serializer\DefaultEventSerializer;
-use Patchlevel\EventSourcing\Store\DoctrineDbalStore;
-
-$connection = DriverManager::getConnection(
-    (new DsnParser())->parse('pdo-pgsql://user:secret@localhost/app'),
-);
-
-$store = new DoctrineDbalStore(
-    $connection,
-    DefaultEventSerializer::createFromPaths(['src/Event']),
-);
-```
-!!! note
-
-    You can find out more about how to create a connection 
-    [here](https://www.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/configuration.html)
-    
-Following options are available in `DoctrineDbalStore`:
-
-| Option            | Type            | Default    | Description                                  |
-|-------------------|-----------------|------------|----------------------------------------------|
-| table_name        | string          | eventstore | The name of the table in the database        |
-| aggregate_id_type | "uuid"/"string" | uuid       | The type of the `aggregate_id` column        |
-| locking           | bool            | true       | If the store should use locking for writing  |
-| lock_id           | int             | 133742     | The id of the lock                           |
-| lock_timeout      | int             | -1         | The timeout of the lock. -1 means no timeout |
-
-The table structure of the `DoctrineDbalStore` looks like this:
-
-| Column           | Type        | Description                                      |
-|------------------|-------------|--------------------------------------------------|
-| id               | bigint      | The index of the whole stream (autoincrement)    |
-| aggregate        | string      | The name of the aggregate                        |
-| aggregate_id     | uuid/string | The id of the aggregate                          |
-| playhead         | int         | The current playhead of the aggregate            |
-| event            | string      | The name of the event                            |
-| payload          | json        | The payload of the event                         |
-| recorded_on      | datetime    | The date when the event was recorded             |
-| new_stream_start | bool        | If the event is the first event of the aggregate |
-| archived         | bool        | If the event is archived                         |
-| custom_headers   | json        | Custom headers for the event                     |
-
-!!! note
-
-    The default type of the `aggregate_id` column is `uuid` if the database supports it and `string` if not.
-    You can change the type with the `aggregate_id_type` to `string` if you want use custom id.
-    
 ### StreamDoctrineDbalStore
 
-We offer a new store called `StreamDoctrineDbalStore`.
-This store is decoupled from the aggregate and can be used to store events from other sources.
-The difference to the `DoctrineDbalStore` is that the `StreamDoctrineDbalStore` merge the aggregate id
-and the aggregate name into one column named `stream`. Additionally, the column `playhead` is nullable.
-This store introduces two new methods `streams` and `remove`.
-
+We offer a store called `StreamDoctrineDbalStore`.
 The store needs a dbal connection, an event serializer and has some optional parameters like options.
 
 ```php
@@ -139,22 +76,16 @@ $store = new InMemoryStore();
 
     You can pass messages to the constructor to initialize the store with some events.
 
-### ReadOnlyStore & StreamReadOnlyStore
+### StreamReadOnlyStore
 
-Last but not least, we offer two read-only stores.
-One for the `DoctrineDbalStore` and one for the `StreamDoctrineDbalStore`.
+Last but not least, we offer a read-only store named `StreamReadOnlyStore`.
 It passes all methods to the underlying store, but throws an `StoreIsReadOnly` exception when trying to execute write
 operations.
 
 ```php
-use Patchlevel\EventSourcing\Store\ReadOnlyStore;
-use Patchlevel\EventSourcing\Store\Store;
 use Patchlevel\EventSourcing\Store\StreamReadOnlyStore;
 use Patchlevel\EventSourcing\Store\StreamStore;
 
-/** @var Store $store */
-$readOnlyStore = new ReadOnlyStore($store);
-
 /** @var StreamStore $store */
 $readOnlyStore = new StreamReadOnlyStore($store);
 ```
@@ -456,10 +387,6 @@ use Patchlevel\EventSourcing\Store\StreamStore;
 /** @var StreamStore $store */
 $store->remove('profile-*');
 ```
-!!! note
-
-    The method is only available in the `StreamStore` like `StreamDoctrineDbalStore`.
-    
 ### List Streams
 
 You can list all streams with the `streams` method.
@@ -470,10 +397,6 @@ use Patchlevel\EventSourcing\Store\StreamStore;
 /** @var StreamStore $store */
 $streams = $store->streams(); // ['profile-1', 'profile-2', 'profile-3']
 ```
-!!! note
-
-    The method is only available in the `StreamStore` like `StreamDoctrineDbalStore`.
-    
 ### Transaction
 
 There is also the possibility of executing a function in a transaction.

infection.json.dist

@@ -14,7 +14,7 @@
   "mutators": {
     "@default": true
   },
-  "minMsi": 72,
-  "minCoveredMsi": 95,
+  "minMsi": 69,
+  "minCoveredMsi": 93,
   "testFrameworkOptions": "--testsuite=unit"
 }

phpstan-baseline.neon

@@ -48,12 +48,6 @@ parameters:
 			count: 1
 			path: src/Repository/DefaultRepository.php
 
-		-
-			message: '#^Parameter \#1 \.\.\.\$streamName of class Patchlevel\\EventSourcing\\Store\\Criteria\\StreamCriterion constructor expects string, string\|null given\.$#'
-			identifier: argument.type
-			count: 1
-			path: src/Repository/DefaultRepository.php
-
 		-
 			message: '#^Parameter \#2 \$data of method Patchlevel\\Hydrator\\Hydrator\:\:hydrate\(\) expects array\<string, mixed\>, mixed given\.$#'
 			identifier: argument.type
@@ -90,30 +84,6 @@ parameters:
 			count: 1
 			path: src/Store/Criteria/StreamCriterion.php
 
-		-
-			message: '#^Method Patchlevel\\EventSourcing\\Store\\DoctrineDbalStoreStream\:\:current\(\) never returns null so it can be removed from the return type\.$#'
-			identifier: return.unusedType
-			count: 1
-			path: src/Store/DoctrineDbalStoreStream.php
-
-		-
-			message: '#^Parameter \#3 \$playhead of class Patchlevel\\EventSourcing\\Aggregate\\AggregateHeader constructor expects int\<1, max\>, int given\.$#'
-			identifier: argument.type
-			count: 1
-			path: src/Store/DoctrineDbalStoreStream.php
-
-		-
-			message: '#^Parameter \#4 \$recordedOn of class Patchlevel\\EventSourcing\\Aggregate\\AggregateHeader constructor expects DateTimeImmutable, mixed given\.$#'
-			identifier: argument.type
-			count: 1
-			path: src/Store/DoctrineDbalStoreStream.php
-
-		-
-			message: '#^Ternary operator condition is always true\.$#'
-			identifier: ternary.alwaysTrue
-			count: 1
-			path: src/Store/DoctrineDbalStoreStream.php
-
 		-
 			message: '#^Method Patchlevel\\EventSourcing\\Store\\StreamDoctrineDbalStoreStream\:\:current\(\) never returns null so it can be removed from the return type\.$#'
 			identifier: return.unusedType
@@ -177,7 +147,7 @@ parameters:
 		-
 			message: '#^Call to static method PHPUnit\\Framework\\Assert\:\:assertInstanceOf\(\) with ''Patchlevel\\\\EventSourcing\\\\Tests\\\\Integration\\\\BankAccountSplitStream\\\\BankAccount'' and Patchlevel\\EventSourcing\\Tests\\Integration\\BankAccountSplitStream\\BankAccount will always evaluate to true\.$#'
 			identifier: staticMethod.alreadyNarrowedType
-			count: 6
+			count: 4
 			path: tests/Integration/BankAccountSplitStream/IntegrationTest.php
 
 		-