Merge pull request #284 from patchlevel/add-table-options-and-clock

Add table options for subscription store, update docs & default config

Author: DanielBadura

docs/pages/configuration.md

@@ -340,6 +340,8 @@ patchlevel_event_sourcing:
     store: 
       type: 'custom' # default is 'dbal'
       service: 'my_subscription_store'
+      options:
+        table_name: 'my_subscription_store'
 ```
 !!! tip
 
@@ -670,7 +672,7 @@ For this you need to enable the crypto shredding.
 ```yaml
 patchlevel_event_sourcing:
     cryptography:
-      use_encrypted_field_name: true,
+      use_encrypted_field_name: true
 ```
 
 !!! tip

docs/pages/installation.md

@@ -37,6 +37,20 @@ patchlevel_event_sourcing:
     connection:
       url: '%env(EVENTSTORE_URL)%'
       provide_dedicated_connection: true
+    store:
+      type: dbal_stream
+      # if you are using doctrine bundle you should enable this
+      #merge_orm_schema: true
+    command_bus:
+      service: messenger.default_bus
+    query_bus:
+      service: messenger.default_bus
+    subscription:
+      gap_detection: ~
+
+    # enable this if you want to use sensitive data encryption
+    #cryptography: ~ 
+    #  use_encrypted_field_name: true
 
 when@dev:
   patchlevel_event_sourcing:
@@ -50,6 +64,8 @@ when@dev:
 when@test:
   patchlevel_event_sourcing:
     subscription:
+      store:
+        type: 'static_in_memory'
       catch_up: true
       throw_on_error: true
       run_after_aggregate_save: true

docs/pages/usage.md

@@ -1,7 +1,7 @@
 # Usage
 
 Here you will find some examples of how to use the bundle.
-But we provide only examples for specific symfo
+But we provide only examples for specific symfony features.
 
 !!! info
 

phpstan-baseline.neon

@@ -1,7 +1,67 @@
 parameters:
 	ignoreErrors:
+		-
+			message: '#^Parameter \#2 \$id of static method Patchlevel\\EventSourcingBundle\\DependencyInjection\\ServiceAliasResolver\:\:resolve\(\) expects string, array\|bool\|float\|int\|string\|null given\.$#'
+			identifier: argument.type
+			count: 1
+			path: src/DependencyInjection/CommandHandlerCompilerPass.php
+
 		-
 			message: '#^Parameter \#1 \$classString of static method Patchlevel\\EventSourcing\\QueryBus\\HandlerFinder\:\:findInClass\(\) expects class\-string, string given\.$#'
 			identifier: argument.type
 			count: 1
 			path: src/DependencyInjection/QueryHandlerCompilerPass.php
+
+		-
+			message: '#^Parameter \#2 \$id of static method Patchlevel\\EventSourcingBundle\\DependencyInjection\\ServiceAliasResolver\:\:resolve\(\) expects string, array\|bool\|float\|int\|string\|null given\.$#'
+			identifier: argument.type
+			count: 1
+			path: src/DependencyInjection/QueryHandlerCompilerPass.php
+
+		-
+			message: '#^Property Patchlevel\\EventSourcingBundle\\Tests\\Fixtures\\Profile\:\:\$id is never read, only written\.$#'
+			identifier: property.onlyWritten
+			count: 1
+			path: tests/Fixtures/Profile.php
+
+		-
+			message: '#^Property Patchlevel\\EventSourcingBundle\\Tests\\Fixtures\\SnapshotableProfile\:\:\$id is unused\.$#'
+			identifier: property.unused
+			count: 1
+			path: tests/Fixtures/SnapshotableProfile.php
+
+		-
+			message: '#^Call to an undefined method Symfony\\Component\\DependencyInjection\\ContainerBuilder\:\:getAutoconfiguredAttributes\(\)\.$#'
+			identifier: method.notFound
+			count: 1
+			path: tests/Unit/PatchlevelEventSourcingBundleTest.php
+
+		-
+			message: '#^Cannot access offset ''Patchlevel\\\\EventSourcing\\\\Attribute\\\\Aggregate''\|''Patchlevel\\\\EventSourcing\\\\Attribute\\\\Event'' on mixed\.$#'
+			identifier: offsetAccess.nonOffsetAccessible
+			count: 1
+			path: tests/Unit/PatchlevelEventSourcingBundleTest.php
+
+		-
+			message: '#^Cannot access offset ''bus'' on mixed\.$#'
+			identifier: offsetAccess.nonOffsetAccessible
+			count: 3
+			path: tests/Unit/PatchlevelEventSourcingBundleTest.php
+
+		-
+			message: '#^Cannot access offset ''handles'' on mixed\.$#'
+			identifier: offsetAccess.nonOffsetAccessible
+			count: 3
+			path: tests/Unit/PatchlevelEventSourcingBundleTest.php
+
+		-
+			message: '#^Cannot access offset ''method'' on mixed\.$#'
+			identifier: offsetAccess.nonOffsetAccessible
+			count: 2
+			path: tests/Unit/PatchlevelEventSourcingBundleTest.php
+
+		-
+			message: '#^Trying to invoke mixed but it''s not a callable\.$#'
+			identifier: callable.nonCallable
+			count: 1
+			path: tests/Unit/PatchlevelEventSourcingBundleTest.php

phpstan.neon.dist

@@ -6,3 +6,4 @@ parameters:
 	level: max
 	paths:
 		- src
+		- tests

src/DependencyInjection/CommandHandlerCompilerPass.php

@@ -25,7 +25,10 @@ public function process(ContainerBuilder $container): void
             return;
         }
 
-        $bus = $container->getParameter('patchlevel_event_sourcing.aggregate_handlers.bus');
+        $bus = ServiceAliasResolver::resolve(
+            $container,
+            $container->getParameter('patchlevel_event_sourcing.aggregate_handlers.bus'),
+        );
 
         /** @var AggregateRootRegistry $aggregateRootRegistry */
         $aggregateRootRegistry = $container->get(AggregateRootRegistry::class);

src/DependencyInjection/Configuration.php

@@ -22,7 +22,11 @@
  *      },
  *      query_bus: array{enabled: bool, service: string},
  *      subscription: array{
- *          store: array{type: string, service: string|null},
+ *          store: array{
+ *              type: string,
+ *              service: string|null,
+ *              options: array{table_name: string}
+ *          },
  *          retry_strategy?: array{base_delay: int, delay_factor: int, max_attempts: int},
  *          retry_strategies: array<string, array{type: string, service: string, options: array<string, mixed>}>,
  *          default_retry_strategy: string,
@@ -197,6 +201,12 @@ public function getConfigTreeBuilder(): TreeBuilder
                                 ->defaultValue('dbal')
                             ->end()
                             ->scalarNode('service')->defaultNull()->end()
+                            ->arrayNode('options')
+                                ->addDefaultsIfNotSet()
+                                ->children()
+                                    ->scalarNode('table_name')->defaultValue('subscriptions')->end()
+                                ->end()
+                            ->end()
                         ->end()
                     ->end()
 

src/DependencyInjection/PatchlevelEventSourcingExtension.php

@@ -488,6 +488,8 @@ static function (ChildDefinition $definition): void {
             $container->register(DoctrineSubscriptionStore::class)
                 ->setArguments([
                     new Reference('event_sourcing.dbal_connection'),
+                    new Reference('event_sourcing.clock'),
+                    $config['subscription']['store']['options']['table_name'],
                 ])
                 ->addTag('event_sourcing.doctrine_schema_configurator');
 

src/DependencyInjection/QueryHandlerCompilerPass.php

@@ -19,7 +19,10 @@ public function process(ContainerBuilder $container): void
             return;
         }
 
-        $bus = $container->getParameter('patchlevel_event_sourcing.query_handlers.bus');
+        $bus = ServiceAliasResolver::resolve(
+            $container,
+            $container->getParameter('patchlevel_event_sourcing.query_handlers.bus'),
+        );
         $subscribers = $container->findTaggedServiceIds('event_sourcing.subscriber');
 
         foreach (array_keys($subscribers) as $subscriberServiceName) {

src/DependencyInjection/ServiceAliasResolver.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\EventSourcingBundle\DependencyInjection;
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+/** @interal */
+final readonly class ServiceAliasResolver
+{
+    public static function resolve(ContainerBuilder $container, string $id): string
+    {
+        if ($container->hasAlias($id)) {
+            return self::resolve(
+                $container,
+                (string)$container->getAlias($id),
+            );
+        }
+
+        return $id;
+    }
+}