Event-Sourcing Bundle

https://github.com/patchlevel/event-sourcing-bundle
Admin
This project provides an event sourcing bundle, offering essential features powered by the Doctrine...
Tokens:64,695
Snippets:560
Trust Score:7.5
License:MIT
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install Event-Sourcing-Bundle with Composer

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/README.md

Run this command in your Symfony project to install the bundle. If you don't use the Symfony Flex recipe, follow the installation documentation linked in the README.

```bash
composer require patchlevel/event-sourcing-bundle
```

--------------------------------

### Usage Example

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/query-bus.md

Example of using the QueryBus to dispatch a query and retrieve the result.

```APIDOC
## Usage Example

### Description
Example of using the QueryBus to dispatch a query and retrieve the result.

### Code
```php
use Patchlevel\EventSourcing\QueryBus\QueryBus;

final class GetHotelQuery
{
    public function __construct(public string $hotelId)
    {
    }
}

final class HotelQueryService
{
    public function __construct(private QueryBus $queryBus)
    {
    }

    public function getHotel(string $id): object
    {
        return $this->queryBus->dispatch(new GetHotelQuery($id)); // mixed, cast as needed
    }
}
```
```

--------------------------------

### Enable auto_setup

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/configuration.md

Activates automatic subscription engine setup before each HTTP request. Useful for development. Does not work with console commands.

```yaml
patchlevel_event_sourcing:
    subscription:
        auto_setup: true
```

--------------------------------

### Error Handling Example

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/query-bus.md

Example of handling the RuntimeException thrown when no query handler matches.

```APIDOC
## Error Handling Example

### Description
Example of handling the RuntimeException thrown when no query handler matches.

### Code
```php
use Patchlevel\EventSourcingBundle\QueryBus\SymfonyQueryBus;
use Patchlevel\EventSourcing\QueryBus\QueryBus;

final class StrictQueryDemand
{
    public function __construct(private QueryBus $bus)
    {
    }

    public function ask(object $query): mixed
    {
        try {
            return $this->bus->dispatch($query);
        } catch (\RuntimeException $e) {
            // 'No message handled yet' — no query handler matched
            return null;
        }
    }
}
```
```

--------------------------------

### Usage example with HotelController

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/value-resolver.md

Shows how to use the resolver in a controller. The argument name must match the route parameter.

```php
namespace App\Hotel\Infrastructure\Controller;

use Patchlevel\EventSourcing\Aggregate\Uuid;
use Patchlevel\EventSourcing\Repository\Repository;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Attribute\AsController;
use Symfony\Component\Routing\Attribute\Route;

#[AsController]
final class HotelController
{
    public function __construct(
        /** @var Repository<Hotel> */
        private readonly Repository $hotelRepository,
    ) {
    }

    #[Route('/hotel/{hotelId}')]
    public function doStuffAction(Uuid $hotelId): Response
    {
        $hotel = $this->hotelRepository->load($hotelId);
        $hotel->doStuff();
        $this->hotelRepository->save($hotel);

        return new Response();
    }
}
```

--------------------------------

### Symfony CLI configuration to auto-start database

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/installation.md

Add this configuration to .symfony.local.yaml to have the Symfony CLI automatically start the Docker Compose services when the server starts.

```yaml
workers:
  docker_compose: ~
```

--------------------------------

### Usage example

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/data-collectors.md

Shows how to access the collector from a profiler panel and iterate over messages, aggregates, and events. Intended for development only.

```php
use Patchlevel\EventSourcingBundle\DataCollector\EventSourcingCollector;

/** @var EventSourcingCollector $collector */
$collector = $profiler->get(EventSourcingCollector::class);

foreach ($collector->getMessages() as $messageData) {
    // $messageData['event_class'], $messageData['event_name'],
    // $messageData['event'] (Data), $messageData['headers'] (list<Data>)
}
$collector->getAggregates();
$collector->getEvents();
```

--------------------------------

### Usage example with GetHotelQuery and HotelQueryService

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/query-bus.md

Shows how to define a query object and a service that uses the QueryBus to dispatch it. The dispatch returns mixed, so casting is needed.

```php
use Patchlevel\EventSourcing\QueryBus\QueryBus;

final class GetHotelQuery
{
    public function __construct(public string $hotelId)
    {
    }
}

final class HotelQueryService
{
    public function __construct(private QueryBus $queryBus)
    {
    }

    public function getHotel(string $id): object
    {
        return $this->queryBus->dispatch(new GetHotelQuery($id)); // mixed, cast as needed
    }
}
```

--------------------------------

### Error handling example with StrictQueryDemand

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/query-bus.md

Shows how to catch the RuntimeException thrown when no handler matches the query, returning null instead.

```php
use Patchlevel\EventSourcingBundle\QueryBus\SymfonyQueryBus;
use Patchlevel\EventSourcing\QueryBus\QueryBus;

final class StrictQueryDemand
{
    public function __construct(private QueryBus $bus)
    {
    }

    public function ask(object $query): mixed
    {
        try {
            return $this->bus->dispatch($query);
        } catch (\RuntimeException $e) {
            // 'No message handled yet' — no query handler matched
            return null;
        }
    }
}
```

--------------------------------

### AutoSetupListener constructor

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/request-listeners.md

Constructor for AutoSetupListener. Accepts a SubscriptionEngine, optional ids and groups to restrict auto setup, and an optional excludeUrl regex. The excludeUrl default from config is '^/_(wdt|profiler|error)'.

```php
/**
 * @param list<string>|null $ids
 * @param list<string>|null $groups
 */
public function __construct(
    private readonly SubscriptionEngine $subscriptionEngine,
    private readonly array|null $ids,
    private readonly array|null $groups,
    private readonly string|null $excludeUrl = null,
)
```

--------------------------------

### SymfonyCommandBus usage example

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/command-bus.md

Shows how to instantiate SymfonyCommandBus with a MessageBusInterface and dispatch a command. The class can be injected as a service or created manually.

```php
use Patchlevel\EventSourcingBundle\CommandBus\SymfonyCommandBus;
use Symfony\Component\Messenger\MessageBusInterface;

final class SomeService
{
    public function __construct(private SymfonyCommandBus $commandBus)
    {
    }

    public function run(MessageBusInterface $bus, object $command): void
    {
        $bus = new SymfonyCommandBus($bus);
        $bus->dispatch($command);
    }
}
```

--------------------------------

### Docker compose.yaml for PostgreSQL

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/installation.md

Use this compose.yaml to start a PostgreSQL database for the event store. It defines an eventstore service with configurable environment variables and a volume for data persistence.

```yaml
services:
  eventstore:
    image: postgres:${POSTGRES_VERSION:-16}-alpine
    environment:
      POSTGRES_DB: ${POSTGRES_DB:-app}
      # You should definitely change the password in production
      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-!ChangeMe!}
      POSTGRES_USER: ${POSTGRES_USER:-app}
    volumes:
      - eventstore_data:/var/lib/postgresql/data:rw
      # You may use a bind-mounted host directory instead, so that it is harder to accidentally remove the volume and lose all your data!
      # - ./docker/db/data:/var/lib/postgresql/data:rw

volumes:
  eventstore_data:
```

--------------------------------

### Set EVENTSTORE_URL environment variable

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/installation.md

Add this line to your .env file to provide the database connection URL. The example uses a PostgreSQL URL with a placeholder password.

```dotenv
EVENTSTORE_URL="pdo-pgsql://app:!ChangeMe!@127.0.0.1:5432/app?serverVersion=16&charset=utf8"
```

--------------------------------

### YAML configuration for event sourcing connection

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/internal-services.md

Example configuration that registers the event_sourcing.dbal_connection service with the DbalConnectionFactory, using an environment variable for the event store URL.

```yaml
patchlevel_event_sourcing:
    connection:
        url: '%env(EVENTSTORE_URL)%'
```

--------------------------------

### Custom AggregateRootId implementation example

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/value-resolver.md

Shows a custom id class implementing AggregateRootId with fromString and toString methods, and how it can be used in a controller.

```php
use Patchlevel\EventSourcing\Aggregate\AggregateRootId;
use Patchlevel\EventSourcingBundle\ValueResolver\AggregateRootIdValueResolver;

final class MyId implements AggregateRootId
{
    private function __construct(private string $value)
    {
    }

    public static function fromString(string $value): static
    {
        // nullable/unit id: return static instance or throw
        return new self($value);
    }

    public function toString(): string
    {
        return $this->value;
    }
}
// controller: public function show(MyId $myId): Response
// route: /show/{myId}  → resolved by AggregateRootIdValueResolver
```

--------------------------------

### UidNormalizer usage example

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/normalizers.md

Shows how to apply the UidNormalizer attribute to a property of type Uuid.

```php
use Patchlevel\EventSourcingBundle\Normalizer\UidNormalizer;
use Symfony\Component\Uid\Uuid;

final class DTO
{
    #[UidNormalizer]
    public Uuid $id;
}
```

--------------------------------

### DatePointNormalizer usage example

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/normalizers.md

Shows how to apply the DatePointNormalizer attribute to a property in a DTO class.

```php
use Patchlevel\EventSourcingBundle\Normalizer\DatePointNormalizer;
use Symfony\Component\Clock\DatePoint;

final class DTO
{
    #[DatePointNormalizer]
    public DatePoint $createdAt;
}
```

--------------------------------

### Autowire projection connection in a service

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/configuration.md

Example of autowiring the dedicated projection connection in a service constructor. The parameter name 'projectionConnection' is used.

```php
use Doctrine\DBAL\Connection;

class YourService
{
    public function __construct(
        private readonly Connection $projectionConnection,
    ) {
    }
}
```

--------------------------------

### Attach Snapshot Store to Aggregate

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/configuration.md

PHP attribute example showing how to attach the 'default' snapshot store to an aggregate class using the #[Snapshot] attribute.

```php
namespace App\Profile\Domain;

use Patchlevel\EventSourcing\Aggregate\BasicAggregateRoot;
use Patchlevel\EventSourcing\Attribute\Aggregate;
use Patchlevel\EventSourcing\Attribute\Snapshot;

#[Aggregate(name: 'profile')]
#[Snapshot('default')]
final class Profile extends BasicAggregateRoot
{
    // ...
}
```

--------------------------------

### DatePointNormalizer Usage Example

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/normalizers.md

Shows how to apply the DatePointNormalizer attribute to a class property for automatic normalization.

```APIDOC
## DatePointNormalizer Usage

### Description
Demonstrates using the DatePointNormalizer attribute on a property to automatically normalize DatePoint objects.

### Example
```php
use Patchlevel\EventSourcingBundle\Normalizer\DatePointNormalizer;
use Symfony\Component\Clock\DatePoint;

final class DTO
{
    #[DatePointNormalizer]
    public DatePoint $createdAt;
}
```
```

--------------------------------

### Symfony event bus handler example

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/configuration.md

Example of a Symfony Messenger handler for the event bus. Uses the Symfony #[AsMessageHandler] attribute and checks the message type before processing.

```php
use Patchlevel\EventSourcing\EventBus\Message;
use Symfony\Component\Messenger\Attribute\AsMessageHandler;

#[AsMessageHandler('event.bus')]
class SmsNotificationHandler
{
    public function __invoke(Message $message): void
    {
        if (!$message instanceof GuestIsCheckedIn) {
            return;
        }

        // ... do some work - like sending an SMS message!
    }
}
```

--------------------------------

### Extend PatchlevelEventSourcingBundle in AppKernel

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/patchlevel-event-sourcing-bundle.md

Example of registering the bundle manually in a custom kernel by yielding it from registerBundles().

```php
use Patchlevel\EventSourcingBundle\PatchlevelEventSourcingBundle;
use Symfony\Component\HttpKernel\Kernel;

class AppKernel extends Kernel
{
    public function registerBundles(): iterable
    {
        yield new PatchlevelEventSourcingBundle();
        // ...
    }
}
```

--------------------------------

### Use projection connection in a projection class

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/configuration.md

Example of a projection class that injects the dedicated projection connection via autowiring. The parameter name 'projectionConnection' identifies the connection.

```php
namespace App\Projection;

use Doctrine\DBAL\Connection;
use Patchlevel\EventSourcing\Attribute\Projector;

#[Projector('my_projection')]
class MyProjection
{
    public function __construct(
        private readonly Connection $projectionConnection,
    ) {
    }
}
```

--------------------------------

### UidNormalizer error handling example

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/normalizers.md

Demonstrates catching InvalidArgument when normalizing a non-UID value.

```php
use Patchlevel\EventSourcingBundle\Normalizer\UidNormalizer;
use Patchlevel\Hydrator\Normalizer\InvalidArgument;

$normalizer = new UidNormalizer();

try {
    $result = $normalizer->normalize('not-a-uid');
} catch (InvalidArgument $e) {
    // expected: value was neither null nor AbstractUid
}
```

--------------------------------

### Configure Data Migration to dbal_stream

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/configuration.md

Configures migration from the current store to a new store. Registers a new store and the CLI command 'event-sourcing:store:migrate'. Example migrates from 'dbal_aggregate' to 'dbal_stream' using the 'AggregateToStreamHeaderTranslator'. Use different table names for old and new stores to avoid destroying the event store. Set 'read_only' to true for the old store to avoid side effects and missing events.

```yaml
patchlevel_event_sourcing:
    store:
        migrate_to_new_store:
            type: 'dbal_stream'
            options:
                table_name: 'my_stream_store'
            translators:
              - Patchlevel\EventSourcing\Message\Translator\AggregateToStreamHeaderTranslator
```

--------------------------------

### Messenger configuration for event.bus

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/event-bus.md

YAML configuration for the messenger bus with allow_no_handlers middleware, required for the event bus setup.

```yaml
# messenger.yaml
framework:
    messenger:
        buses:
            event.bus:
                default_middleware: allow_no_handlers
```

--------------------------------

### SymfonyCommandBus error handling example

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/command-bus.md

Demonstrates catching a DomainException when dispatching a command. The wrapped exception from the handler is rethrown, not the messenger HandlerFailedException.

```php
use Patchlevel\EventSourcingBundle\CommandBus\SymfonyCommandBus;
use Patchlevel\EventSourcing\CommandBus\CommandBus;

final class SendCommand
{
    public function __construct(private CommandBus $bus)
    {
    }

    public function run(object $command): void
    {
        try {
            $this->bus->dispatch($command);
        } catch (\DomainException $e) {
            // the wrapped exception from the handler is rethrown,
            // not the messenger HandlerFailedException
        }
    }
}
```

--------------------------------

### Configure gap_detection retries_in_ms

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/configuration.md

Defines how often gap detection re-checks the gap and how long it waits. In this example, it retries instantly, then after 500ms, and finally after 1 second.

```yaml
patchlevel_event_sourcing:
    subscription:
        gap_detection:
            retries_in_ms: [0, 500, 1000]
```

--------------------------------

### GuestProjection projector class

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/getting-started.md

Defines a projector for guest check-ins and check-outs. It subscribes to GuestIsCheckedIn and GuestIsCheckedOut events, updates a database table, and includes setup and teardown methods. Requires autoconfiguration or the event_sourcing.subscriber tag.

```php
namespace App\Hotel\Infrastructure\Projection;

use App\Hotel\Domain\Event\GuestIsCheckedIn;
use App\Hotel\Domain\Event\GuestIsCheckedOut;
use Doctrine\DBAL\Connection;
use Patchlevel\EventSourcing\Aggregate\Uuid;
use Patchlevel\EventSourcing\Attribute\Projector;
use Patchlevel\EventSourcing\Attribute\Setup;
use Patchlevel\EventSourcing\Attribute\Subscribe;
use Patchlevel\EventSourcing\Attribute\Teardown;

use function sprintf;

/**
 * @psalm-type GuestData = array{
 *     guest_name: string,
 *     hotel_id: string,
 *     check_in_date: string,
 *     check_out_date: string|null
 * }
 */
#[Projector(self::SUBSCRIBER_ID)]
final class GuestProjection
{
    private const SUBSCRIBER_ID = 'guests';

    public function __construct(
        private Connection $db,
    ) {
    }

    /** @return list<GuestData> */
    public function findGuestsByHotelId(Uuid $hotelId): array
    {
        return $this->db->createQueryBuilder()
            ->select('*')
            ->from(self::SUBSCRIBER_ID)
            ->where('hotel_id = :hotel_id')
            ->setParameter('hotel_id', $hotelId->toString())
            ->fetchAllAssociative();
    }

    #[Subscribe(GuestIsCheckedIn::class)]
    public function onGuestIsCheckedIn(
        GuestIsCheckedIn $event,
        DateTimeImmutable $recordedOn,
    ): void {
        $this->db->insert(
            self::SUBSCRIBER_ID,
            [
                'hotel_id' => $event->hotelId->toString(),
                'guest_name' => $event->guestName,
                'check_in_date' => $recordedOn->format('Y-m-d H:i:s'),
                'check_out_date' => null,
            ],
        );
    }

    #[Subscribe(GuestIsCheckedOut::class)]
    public function onGuestIsCheckedOut(
        GuestIsCheckedOut $event,
        DateTimeImmutable $recordedOn,
    ): void {
        $this->db->update(
            self::SUBSCRIBER_ID,
            [
                'check_out_date' => $recordedOn->format('Y-m-d H:i:s'),
            ],
            [
                'hotel_id' => $event->hotelId->toString(),
                'guest_name' => $event->guestName,
                'check_out_date' => null,
            ],
        );
    }

    #[Setup]
    public function create(): void
    {
        $this->db->executeStatement(sprintf(
            'CREATE TABLE %s (
                hotel_id VARCHAR(36) NOT NULL,
                guest_name VARCHAR(255) NOT NULL,
                check_in_date TIMESTAMP NOT NULL,
                check_out_date TIMESTAMP NULL
            );',
            self::SUBSCRIBER_ID,
        ));
    }

    #[Teardown]
    public function drop(): void
    {
        $this->db->executeStatement(sprintf('DROP TABLE IF EXISTS %s;', self::SUBSCRIBER_ID));
    }
}
```

--------------------------------

### Define the command bus in Symfony Messenger configuration

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/configuration.md

Required setup to define the command bus in the messenger configuration. The bundle only provides a Symfony Messenger integration, so you must define the bus here.

```yaml
framework:
    messenger:
        default_bus: command.bus
        buses:
            command.bus: ~
```

--------------------------------

### Implement an Upcaster to modify event payload

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/usage.md

Example upcaster that lowercases the email in a 'profile_created' event. It ignores other events and uses replacePayloadByKey to update the payload. With Symfony autowire and autoconfigure enabled, it is automatically registered; otherwise, define it as a service with the event_sourcing.upcaster tag.

```php
use Patchlevel\EventSourcing\Serializer\Upcast\Upcast;
use Patchlevel\EventSourcing\Serializer\Upcast\Upcaster;

final class ProfileCreatedEmailLowerCastUpcaster implements Upcaster
{
    public function __invoke(Upcast $upcast): Upcast
    {
        // ignore if other event is processed
        if ($upcast->eventName !== 'profile_created') {
            return $upcast;
        }

        return $upcast->replacePayloadByKey('email', strtolower($upcast->payload['email']));
    }
}
```

--------------------------------

### Create database and schema with event-sourcing CLI commands

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/getting-started.md

Commands to create the database and schema for the event sourcing bundle. Run these in order: first create the database, then create the schema.

```bash
bin/console event-sourcing:database:create
bin/console event-sourcing:schema:create
```

--------------------------------

### Process configuration with defaults

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/dependency-injection-configuration.md

Creates a Configuration instance and processes it with a Processor, providing sample values for connection, store, aggregates, and events. The resulting $config contains all defaults merged in.

```php
use Patchlevel\EventSourcingBundle\DependencyInjection\Configuration;
use Symfony\Component\Config\Definition\Processor;

$configuration = new Configuration();
$processor = new Processor();

$config = $processor->processConfiguration($configuration, [
    [
        'connection' => ['url' => 'pdo-pgsql://user:pass@127.0.0.1:5432/app'],
        'store' => ['type' => 'dbal_stream'],
        'aggregates' => '%kernel.project_dir%/src',
        'events' => '%kernel.project_dir%/src',
    ],
]);
// $config now contains all defaults merged in
```

--------------------------------

### Recommended configuration file

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/installation.md

Create this YAML configuration at config/packages/patchlevel_event_sourcing.yaml. It sets up aggregates, events, connection, store, command/query buses, and subscriptions. Note the commented options for doctrine bundle and cryptography.

```yaml
patchlevel_event_sourcing:
    aggregates: '%kernel.project_dir%/src'
    events: '%kernel.project_dir%/src'
    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:
    subscription:
      catch_up: true
      throw_on_error: true
      run_after_aggregate_save: true
      rebuild_after_file_change: true
      auto_setup: true

when@test:
  patchlevel_event_sourcing:
    subscription:
      store:
        type: 'static_in_memory'
      catch_up: true
      throw_on_error: true
      run_after_aggregate_save: true
```

--------------------------------

### MessageCollectorEventBus get method

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/data-collectors.md

Returns all messages collected since the last clear() call.

```php
/** @return list<Message<object>> */
public function get(): array
```

--------------------------------

### Standalone usage of MessageCollectorEventBus

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/data-collectors.md

Example of using the MessageCollectorEventBus standalone to record and inspect dispatched messages.

```php
use Patchlevel\EventSourcingBundle\DataCollector\MessageCollectorEventBus;

$bus = new MessageCollectorEventBus();
// ... aggregate operations that dispatch events ...
foreach ($bus->get() as $message) {
    // inspect recorded messages
}
$bus->clear();
```

--------------------------------

### Sequence of configure* method calls in load

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/dependency-injection-extension.md

These calls are executed in order after processing configuration and checking for a connection block. They wire all the bundle's services.

```php
$this->configureHydrator($config, $container);
$this->configureUpcaster($container);
$this->configureSerializer($config, $container);
$this->configureMessageDecorator($container);
$this->configureCommandBus($config, $container);
$this->configureEventBus($config, $container);
$this->configureQueryBus($config, $container);
$this->configureConnection($config, $container);
$this->configureStore($config, $container);
$this->configureSnapshots($config, $container);
$this->configureAggregates($config, $container);
$this->configureCommands($container);
$this->configureProfiler($container);
$this->configureClock($config, $container);
$this->configureSchema($config, $container);
$this->configureMessageLoader($config, $container);
$this->configureSubscription($config, $container);
$this->configureCryptography($config, $container);
$this->configureMigration($config, $container);
$this->configureValueResolver($container);
$this->configureStoreMigration($config, $container);
$this->configureMetadataCache($config, $container);
```

--------------------------------

### StoreMigrateCommand usage

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/internal-services.md

Command line usage to run the migration with a custom buffer size. The --buffer option defaults to 1000.

```bash
bin/console event-sourcing:store:migrate --buffer=500
```

--------------------------------

### Enable auto_setup in dev config

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/request-listeners.md

YAML configuration to enable auto_setup for the subscription in dev environment. This is typical dev config.

```yaml
when@dev:
  patchlevel_event_sourcing:
    subscription:
      auto_setup: true
```

--------------------------------

### StoreMigrateCommand constructor

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/internal-services.md

Constructor for StoreMigrateCommand. Takes the source store, target store, and an iterable of translators. The target store is configured via event_sourcing.store.new_store.

```php
/** @param iterable<int, Translator> $translators */
public function __construct(
    private readonly Store $store,
    private readonly Store $newStore,
    private readonly iterable $translators = [],
)
```

--------------------------------

### Create database and schema with Doctrine migrations

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/getting-started.md

Alternative to the direct schema creation commands, using Doctrine migrations to generate and apply migration files.

```bash
bin/console event-sourcing:migrations:diff
bin/console event-sourcing:migrations:migrate
```

--------------------------------

### Minimal working configuration (YAML)

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/configuration.md

Provides a minimal configuration for the Patchlevel Event Sourcing Bundle. It sets the aggregates and events directories, uses the EVENTSTORE_URL environment variable for the Doctrine DBAL connection, enables a dedicated connection, uses the dbal_stream store type, and configures the command and query buses to use the messenger default bus. The subscription gap detection is set to null.

```yaml
patchlevel_event_sourcing:
    aggregates: '%kernel.project_dir%/src'
    events: '%kernel.project_dir%/src'
    connection:
        url: '%env(EVENTSTORE_URL)%'
        provide_dedicated_connection: true
    store:
        type: dbal_stream
    command_bus:
        service: messenger.default_bus
    query_bus:
        service: messenger.default_bus
    subscription:
        gap_detection: ~
```

--------------------------------

### Error handling wrapper for SymfonyEventBus

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/event-bus.md

Example of a class that wraps SymfonyEventBus dispatch in a try/catch to handle messenger-level transport or handler errors.

```php
use Patchlevel\EventSourcingBundle\EventBus\SymfonyEventBus;
use Patchlevel\EventSourcing\Message\Message;

final class EventForwarder
{
    public function __construct(private SymfonyEventBus $bus)
    {
    }

    public function forward(Message ...$messages): void
    {
        try {
            $this->bus->dispatch(...$messages);
        } catch (\Throwable $e) {
            // messenger-level transport/handler errors
        }
    }
}
```

--------------------------------

### MetadataCacheWarmer methods

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/internal-services.md

Declares the isOptional and warmUp methods. isOptional returns true; warmUp returns an array of classes to preload and writes the metadata cache file.

```php
public function isOptional(): bool   // returns true
/** @return array<string> classes to preload */
public function warmUp(string $cacheDir, string|null $buildDir = null): array
```

--------------------------------

### Constructor for SubscriptionRebuildAfterFileChangeListener

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/request-listeners.md

Defines the constructor with parameters for the subscription engine, subscribers, cache, metadata factory, and exclude URL. The metadata factory defaults to AttributeSubscriberMetadataFactory, and excludeUrl defaults to null.

```php
/** @param iterable<object> $subscribers */
public function __construct(
    private readonly SubscriptionEngine $subscriptionEngine,
    private readonly iterable $subscribers,
    private readonly CacheItemPoolInterface $cache,
    private readonly SubscriberMetadataFactory $metadataFactory = new AttributeSubscriberMetadataFactory(),
    private readonly string|null $excludeUrl = null,
)
```

--------------------------------

### Restrict auto_setup with ids, groups, and exclude_url

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/request-listeners.md

YAML configuration to restrict auto_setup to specific subscription ids and groups, and to exclude URLs matching the given regex.

```yaml
patchlevel_event_sourcing:
    subscription:
        auto_setup:
            ids:
                - 'profile_projection'
            groups:
                - 'default'
            exclude_url: '^/_(wdt|profiler|error)'
```

--------------------------------

### Basic usage of AsListener with Subscribe

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/attribute-aslistener.md

Shows a listener class using #[AsListener] and #[Subscribe] to handle a domain event. The __invoke method receives a Message object.

```php
namespace App\Hotel\Application\Listener;

use App\Hotel\Domain\Event\GuestIsCheckedIn;
use Patchlevel\EventSourcing\Attribute\Subscribe;
use Patchlevel\EventSourcing\Message\Message;
use Patchlevel\EventSourcingBundle\Attribute\AsListener;

#[AsListener]
final class SendCheckInEmailListener
{
    #[Subscribe(GuestIsCheckedIn::class)]
    public function __invoke(Message $message): void
    {
        // handle the event
    }
}
```

--------------------------------

### Message handler using AsMessageHandler attribute

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/event-bus.md

Example of a message handler using Symfony's AsMessageHandler attribute for the event.bus, instead of the event-sourcing Subscribe attribute.

```php
use Patchlevel\EventSourcing\EventBus\Message;
use Symfony\Component\Messenger\Attribute\AsMessageHandler;

#[AsMessageHandler('event.bus')]
class SmsNotificationHandler
{
    public function __invoke(Message $message): void
    {
        // handle the message
    }
}
```

--------------------------------

### AutoSetupListener onKernelRequest method signature

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/request-listeners.md

Method signature for onKernelRequest, which is the kernel.request listener method. It skips non-main requests and URLs matching excludeUrl, then sets up new subscriptions.

```php
public function onKernelRequest(RequestEvent $event): void
```

--------------------------------

### Define an event bus listener with AsListener and Subscribe

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/usage.md

Creates a listener that sends an email when a guest is checked in. The listener is automatically registered if autowire and autoconfigure are enabled; otherwise, it must be tagged manually.

```php
namespace App\Hotel\Application\Listener;

use App\Hotel\Domain\Event\GuestIsCheckedIn;
use Patchlevel\EventSourcing\Attribute\Subscribe;
use Patchlevel\EventSourcing\Message\Message;
use Patchlevel\EventSourcingBundle\Attribute\AsListener;
use Symfony\Component\Mailer\MailerInterface;
use Symfony\Component\Mime\Email;

use function sprintf;

#[AsListener]
final class SendCheckInEmailListener
{
    private function __construct(private MailerInterface $mailer)
    {
    }

    #[Subscribe(GuestIsCheckedIn::class)]
    public function __invoke(Message $message): void
    {
        $event = $message->event();

        $email = (new Email())
            ->from('noreply@patchlevel.de')
            ->to('hq@patchlevel.de')
            ->subject('Guest is checked in')
            ->text(sprintf('A new guest named "%s" is checked in', $event->guestName()));

        $this->mailer->send($email);
    }
}
```

--------------------------------

### Catch normalizer type errors

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/errors.md

Catch InvalidArgument from the hydrator's normalizer exception base when normalizing a value that is neither null nor AbstractUid. Example uses UidNormalizer.

```php
use Patchlevel\EventSourcingBundle\Normalizer\UidNormalizer;
use Patchlevel\Hydrator\Normalizer\InvalidArgument;

try {
    (new UidNormalizer())->normalize('not a uid');
} catch (InvalidArgument $e) {
    // value neither null nor AbstractUid
}
```

--------------------------------

### build() method signature

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/patchlevel-event-sourcing-bundle.md

The build method registers all compiler passes on the container. It has no return value and only affects the container.

```php
public function build(ContainerBuilder $container): void
```

--------------------------------

### Configure custom subscription store

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/configuration.md

Changes the subscription store to a custom service with options. The default store is 'dbal'.

```yaml
patchlevel_event_sourcing:
  subscription:
    store: 
      type: 'custom' # default is 'dbal'
      service: 'my_subscription_store'
      options:
        table_name: 'my_subscription_store'
```

--------------------------------

### resolve method for SymfonyParameterResolver

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/command-bus.md

Resolves parameters for an aggregate handler method. For index 0 yields the command; for subsequent parameters yields container->get($prefix . $parameter->getName()) where $prefix is strtolower($method->getName()) . '.'. Throws whatever the container throws for missing keys. Declared at src/CommandBus/SymfonyParameterResolver.php:21.

```php
/** @return iterable<int, mixed> */
public function resolve(ReflectionMethod $method, object $command): iterable
```

--------------------------------

### AsListener constructor with priority parameter

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/attribute-aslistener.md

The constructor accepts an optional integer priority parameter with a default of 0. Higher values run earlier. The priority is forwarded to the event_sourcing.listener tag.

```php
public function __construct(
    public int $priority = 0,
)
```

--------------------------------

### YAML configuration for rebuild_after_file_change

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/request-listeners.md

Enables the rebuild_after_file_change option in the dev environment. This triggers the listener to rebuild FromBeginning subscriptions when subscriber files change.

```yaml
when@dev:
  patchlevel_event_sourcing:
    subscription:
      rebuild_after_file_change: true
```

--------------------------------

### Configure event paths with array

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/configuration.md

Use an array to specify multiple event paths explicitly.

```yaml
patchlevel_event_sourcing:
  events:
    - '%kernel.project_dir%/src/Hotel/Domain/Event'
    - '%kernel.project_dir%/src/Room/Domain/Event'
```

--------------------------------

### Configure custom headers with an array of paths

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/configuration.md

Specify multiple paths for custom headers using an array. Each path is relative to the kernel project directory.

```yaml
patchlevel_event_sourcing:
  headers:
    - '%kernel.project_dir%/src/Hotel/Domain/Header'
    - '%kernel.project_dir%/src/Room/Domain/Header'
```

--------------------------------

### Enable event bus with default configuration

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/configuration.md

Enables the event bus with default settings. The default is the Patchlevel event bus.

```yaml
patchlevel_event_sourcing:
    event_bus: ~
```

--------------------------------

### Configure migration namespace and path

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/configuration.md

Sets the namespace and path for Doctrine migrations in the bundle configuration.

```yaml
patchlevel_event_sourcing:
    migration:
        namespace: EventSourcingMigrations
        path: "%kernel.project_dir%/migrations"
```

--------------------------------

### Configure event store connection URL

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/configuration.md

Set the event store connection URL using an environment variable. This is the basic connection configuration.

```yaml
patchlevel_event_sourcing:
  connection:
    url: '%env(EVENTSTORE_URL)%'
```

--------------------------------

### Advanced usage with priority

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/attribute-aslistener.md

Shows how to set a custom priority value (16) using the AsListener attribute. Higher priority listeners run earlier.

```php
#[AsListener(priority: 16)]
final class HighPriorityListener
{
    // ...
}
```

--------------------------------

### StaticInMemorySubscriptionStoreFactory create method

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/internal-services.md

Creates a shared InMemorySubscriptionStore singleton per process. Used for the static_in_memory subscription store type, useful with doctrine-test-bundle. Returns the same instance on every call.

```php
final class StaticInMemorySubscriptionStoreFactory
{
    public static function create(): InMemorySubscriptionStore
```

--------------------------------

### StoreMigrateCommand class definition

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/internal-services.md

Defines the deprecated StoreMigrateCommand with the AsCommand attribute. The command is registered only when store.migrate_to_new_store is enabled.

```php
#[AsCommand(
    'event-sourcing:store:migrate',
    'migrate events from one store to another',
)]
final class StoreMigrateCommand extends Command
```

--------------------------------

### Configure default instant retry settings

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/configuration.md

Defines the default instant retry configuration for the command bus. Used when no retry configuration is specified for a specific command.

```yaml
patchlevel_event_sourcing:
    command_bus:
        instant_retry:
            default_max_retries: 3
            default_exceptions:
                - Patchlevel\EventSourcing\Repository\AggregateOutdated
```

--------------------------------

### Configure event paths with glob pattern

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/configuration.md

Specify a single glob pattern for event paths.

```yaml
patchlevel_event_sourcing:
  events: '%kernel.project_dir%/src/*/Domain/Event'
```

--------------------------------

### Enable catch_up option

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/configuration.md

Activates the catch_up option to process events generated during subscription runs.

```yaml
patchlevel_event_sourcing:
    subscription:
        catch_up: true
```

--------------------------------

### Configure gap_detection detection_window

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/configuration.md

Defines the timeframe from now to check for a gap. Must be a valid DateInterval string, e.g., 'PT5M'.

```yaml
patchlevel_event_sourcing:
    subscription:
        gap_detection:
            detection_window: 'PT5M'
```

--------------------------------

### Define Hotel Aggregate with create, checkIn, and checkOut Methods

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/getting-started.md

Defines the Hotel aggregate class with methods create, checkIn, and checkOut that enforce business rules and record events. Uses #[Aggregate(name: 'hotel')] and #[Id] attributes, and #[Apply] methods to update state. Throws GuestHasAlreadyCheckedIn and IsNotAGuest exceptions for invalid operations.

```php
namespace App\Hotel\Domain;

use App\Hotel\Domain\Event\GuestIsCheckedIn;
use App\Hotel\Domain\Event\GuestIsCheckedOut;
use App\Hotel\Domain\Event\HotelCreated;
use Patchlevel\EventSourcing\Aggregate\BasicAggregateRoot;
use Patchlevel\EventSourcing\Aggregate\Uuid;
use Patchlevel\EventSourcing\Attribute\Aggregate;
use Patchlevel\EventSourcing\Attribute\Apply;
use Patchlevel\EventSourcing\Attribute\Id;

use function array_filter;
use function array_values;
use function in_array;

#[Aggregate(name: 'hotel')]
final class Hotel extends BasicAggregateRoot
{
    #[Id]
    private Uuid $id;
    private string $name;

    /** @var list<string> */
    private array $guests;

    public function name(): string
    {
        return $this->name;
    }

    public function guests(): array
    {
        return $this->guests;
    }

    public static function create(Uuid $id, string $hotelName): self
    {
        $self = new self();
        $self->recordThat(new HotelCreated($id, $hotelName));

        return $self;
    }

    public function checkIn(string $guestName): void
    {
        if (in_array($guestName, $this->guests, true)) {
            throw new GuestHasAlreadyCheckedIn($guestName);
        }

        $this->recordThat(new GuestIsCheckedIn($this->id, $guestName));
    }

    public function checkOut(string $guestName): void
    {
        if (!in_array($guestName, $this->guests, true)) {
            throw new IsNotAGuest($guestName);
        }

        $this->recordThat(new GuestIsCheckedOut($this->id, $guestName));
    }

    #[Apply]
    protected function applyHotelCreated(HotelCreated $event): void
    {
        $this->id = $event->id;
        $this->name = $event->hotelName;
        $this->guests = [];
    }

    #[Apply]
    protected function applyGuestIsCheckedIn(GuestIsCheckedIn $event): void
    {
        $this->guests[] = $event->guestName;
    }

    #[Apply]
    protected function applyGuestIsCheckedOut(GuestIsCheckedOut $event): void
    {
        $this->guests = array_values(
            array_filter(
                $this->guests,
                static fn ($name) => $name !== $event->guestName,
            ),
        );
    }
}
```

--------------------------------

### GapResolverMessageLoaderFactory create method

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/internal-services.md

Internal factory that builds a GapResolverStoreMessageLoader from config values. Converts the detection window string into a DateInterval; throws DateMalformedStringException/Exception if invalid. Used when subscription.gap_detection is enabled.

```php
/** @internal */
final class GapResolverMessageLoaderFactory
{
    /** @param list<int> $retriesInMs in milliseconds */
    public static function create(
        Store $store,
        ClockInterface $clock,
        array $retriesInMs,
        string|null $detectionWindow,
    ): GapResolverStoreMessageLoader
```

--------------------------------

### Configure custom headers with a glob pattern

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/configuration.md

Specify a single path for custom headers using a glob pattern. The path is relative to the kernel project directory.

```yaml
patchlevel_event_sourcing:
  headers: '%kernel.project_dir%/src/*/Domain/Header'
```

--------------------------------

### Inject Repository via Argument Name

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/usage.md

Shows how to inject a repository for the Hotel aggregate by type-hinting the argument as Repository<Hotel> and naming it $hotelRepository. The repository is used to load and save the aggregate.

```php
namespace App\Hotel\Infrastructure\Controller;

use Patchlevel\EventSourcing\Aggregate\Uuid;
use Patchlevel\EventSourcing\Repository\Repository;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Attribute\AsController;

#[AsController]
final class HotelController
{
    public function __construct(
        /** @var Repository<Hotel> */
        private readonly Repository $hotelRepository,
    ) {
    }

    public function doStuffAction(Uuid $hotelId): Response
    {
        $hotel = $this->hotelRepository->load($hotelId);

        $hotel->doStuff();

        $hotelRepository->save($hotel);

        return new Response();
    }
}
```

--------------------------------

### Enable rebuild_after_file_change

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/configuration.md

Rebuilds the subscription engine after a file change. Useful for development. Works only before HTTP requests, not with console commands. Uses the cache system to store the latest file change time.

```yaml
patchlevel_event_sourcing:
    subscription:
        rebuild_after_file_change: true
```

--------------------------------

### Use Symfony clock service

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/configuration.md

Requires the symfony/clock package and configures the clock service to use the Symfony clock implementation.

```bash
composer require symfony/clock
```

```yaml
patchlevel_event_sourcing:
    clock:
        service: 'clock'
```

--------------------------------

### load method signature

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/dependency-injection-extension.md

The load method accepts normalized config arrays and the container being built. It is declared at line 188 of the source file.

```php
/** @param array<array-key, mixed> $configs */
public function load(array $configs, ContainerBuilder $container): void
```

--------------------------------

### Handle invalid configuration exception

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/dependency-injection-configuration.md

Shows how to catch InvalidConfigurationException when processing an invalid configuration, e.g., missing 'service' field when 'type' is 'custom'. The comment shows the expected error message.

```php
use Patchlevel\EventSourcingBundle\DependencyInjection\Configuration;
use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
use Symfony\Component\Config\Definition\Processor;

try {
    (new Processor())->processConfiguration(new Configuration(), [
        ['store' => ['type' => 'custom']], // missing service
    ]);
} catch (InvalidConfigurationException $e) {
    // 'The "service" field is required when "type" is set to "custom".'
}
```

--------------------------------

### Configure aggregate paths with array

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/configuration.md

Use an array to specify multiple aggregate paths explicitly.

```yaml
patchlevel_event_sourcing:
  aggregates:
    - '%kernel.project_dir%/src/Hotel/Domain'
    - '%kernel.project_dir%/src/Room/Domain'
```

--------------------------------

### Symfony controller for hotel management with Event Sourcing

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/getting-started.md

Defines a HotelController with routes for listing guests, creating a hotel, and handling check-in/check-out. Uses the Repository to load and save Hotel aggregates, and a GuestProjection for queries. Note that input validation is not implemented (comments indicate 'need validation!').

```php
namespace App\Hotel\Infrastructure\Controller;

use App\Hotel\Domain\Hotel;
use App\Hotel\Infrastructure\Projection\GuestProjection;
use Patchlevel\EventSourcing\Aggregate\Uuid;
use Patchlevel\EventSourcing\Repository\Repository;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Attribute\AsController;
use Symfony\Component\Routing\Annotation\Route;

#[AsController]
final class HotelController
{
    /** @param Repository<Hotel> $hotelRepository */
    public function __construct(
        private readonly Repository $hotelRepository,
        private readonly GuestProjection $guestProjection,
    ) {
    }

    #[Route('/{hotelId}/guests', methods:['GET'])]
    public function hotelGuestsAction(Uuid $hotelId): JsonResponse
    {
        return new JsonResponse(
            $this->guestProjection->findGuestsByHotelId($hotelId),
        );
    }

    #[Route('/create', methods:['POST'])]
    public function createAction(Request $request): JsonResponse
    {
        $hotelName = $request->getPayload()->get('name'); // need validation!
        $id = Uuid::generate();

        $hotel = Hotel::create($id, $hotelName);
        $this->hotelRepository->save($hotel);

        return new JsonResponse(['id' => $id->toString()]);
    }

    #[Route('/{hotelId}/check-in', methods:['POST'])]
    public function checkInAction(Uuid $hotelId, Request $request): JsonResponse
    {
        $guestName = $request->getPayload()->get('name'); // need validation!

        $hotel = $this->hotelRepository->load($hotelId);
        $hotel->checkIn($guestName);
        $this->hotelRepository->save($hotel);

        return new JsonResponse();
    }

    #[Route('/{hotelId}/check-out', methods:['POST'])]
    public function checkOutAction(Uuid $hotelId, Request $request): JsonResponse
    {
        $guestName = $request->getPayload()->get('name'); // need validation!

        $hotel = $this->hotelRepository->load($hotelId);
        $hotel->checkOut($guestName);
        $this->hotelRepository->save($hotel);

        return new JsonResponse();
    }
}
```

--------------------------------

### Enable lifecycle extension

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/docs/configuration.md

Enables the lifecycle extension to run lifecycle hooks during hydration.

```yaml
patchlevel_event_sourcing:
    hydrator:
        lifecycle:
            enabled: true
```

--------------------------------

### Envelope creation with DispatchAfterCurrentBusStamp

Source: https://github.com/patchlevel/event-sourcing-bundle/blob/3.19.x/_autodocs/api-reference/event-bus.md

Creates an envelope for each message and adds the DispatchAfterCurrentBusStamp to defer delivery until after the current bus handlers finish.

```php
$envelope = (new Envelope($message))
    ->with(new DispatchAfterCurrentBusStamp());

$this->bus->dispatch($envelope);
```
Tokens:
Raw