filter events in subscription engine

[DavidBadura]

This PR adds the option to filter the stream by events. This allows us to optimize the subscription engine so that we only load the events that the subscriptions need.

In other words, before the stream is loaded, all subscriptions that are currently being used are checked to see which events are needed. This list is then used to load the stream with a filter. As soon as a subscriber hears * (all), all events are always loaded.

This strategy is optional and can be tried out with the changed typehint for the store parameter in the subscription engine. The MessageLoader interface was introduced for this purpose.

$engine = new DefaultSubscriptionEngine(
    new EventFilteredStoreMessageLoader(
        $store, 
        new AttributeEventMetadataFactory(), 
        $subscriberRepository,
    ),
    $subscriberRepository,
);

[github-actions]

Hello 👋

here is the most recent benchmark result:

SubscriptionEngineBench
=======================

+---------------------------+-----------------+-----------------+-----------+-----------------+------------+-------------+
|                           | time (kde mode)                               | memory                                     |
+---------------------------+-----------------+-----------------+-----------+-----------------+------------+-------------+
| subject                   | Tag: <current>  | Tag: base       | time-diff | Tag: <current>  | Tag: base  | memory-diff |
+---------------------------+-----------------+-----------------+-----------+-----------------+------------+-------------+
| benchHandle10000Events () | 3.105s (±0.00%) | 3.094s (±0.00%) | +0.34%    | 46.883mb        | 34.743mb   | +34.94%     |
+---------------------------+-----------------+-----------------+-----------+-----------------+------------+-------------+

SubscriptionEngineBatchBench
============================

+---------------------------+-------------------+-------------------+-----------+-----------------+------------+-------------+
|                           | time (kde mode)                                   | memory                                     |
+---------------------------+-------------------+-------------------+-----------+-----------------+------------+-------------+
| subject                   | Tag: <current>    | Tag: base         | time-diff | Tag: <current>  | Tag: base  | memory-diff |
+---------------------------+-------------------+-------------------+-----------+-----------------+------------+-------------+
| benchHandle10000Events () | 73.573ms (±0.00%) | 72.200ms (±0.00%) | +1.90%    | 34.234mb        | 34.234mb   | 0.00%       |
+---------------------------+-------------------+-------------------+-----------+-----------------+------------+-------------+

SimpleSetupStreamStoreBench
===========================

+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
|                                        | time (kde mode)                                     | memory                                     |
+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
| subject                                | Tag: <current>     | Tag: base          | time-diff | Tag: <current>  | Tag: base  | memory-diff |
+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
| benchLoad1Event ()                     | 886.200μs (±0.00%) | 933.300μs (±0.00%) | -5.05%    | 34.744mb        | 34.744mb   | 0.00%       |
| benchLoad10000Events ()                | 46.285ms (±0.00%)  | 47.781ms (±0.00%)  | -3.13%    | 34.745mb        | 34.745mb   | 0.00%       |
| benchSave1Event ()                     | 1.008ms (±0.00%)   | 1.072ms (±0.00%)   | -5.95%    | 34.744mb        | 34.744mb   | 0.00%       |
| benchSave10000Events ()                | 205.293ms (±0.00%) | 223.916ms (±0.00%) | -8.32%    | 34.745mb        | 34.745mb   | 0.00%       |
| benchSave10000Aggregates ()            | 8.337s (±0.00%)    | 8.202s (±0.00%)    | +1.64%    | 34.745mb        | 34.745mb   | 0.00%       |
| benchSave10000AggregatesTransaction () | 4.741s (±0.00%)    | 4.749s (±0.00%)    | -0.15%    | 34.745mb        | 34.745mb   | 0.00%       |
+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+

SnapshotsBench
==============

+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
|                                        | time (kde mode)                                     | memory                                     |
+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
| subject                                | Tag: <current>     | Tag: base          | time-diff | Tag: <current>  | Tag: base  | memory-diff |
+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
| benchLoad10000EventsMissingSnapshot () | 49.414ms (±0.00%)  | 48.507ms (±0.00%)  | +1.87%    | 33.836mb        | 33.836mb   | 0.00%       |
| benchLoad10000Events ()                | 929.600μs (±0.00%) | 925.100μs (±0.00%) | +0.49%    | 33.836mb        | 33.836mb   | 0.00%       |
+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+

SplitStreamBench
================

+-------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
|                         | time (kde mode)                                     | memory                                     |
+-------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
| subject                 | Tag: <current>     | Tag: base          | time-diff | Tag: <current>  | Tag: base  | memory-diff |
+-------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
| benchLoad10000Events () | 4.392ms (±0.00%)   | 4.324ms (±0.00%)   | +1.58%    | 37.072mb        | 37.072mb   | 0.00%       |
| benchSave10000Events () | 341.855ms (±0.00%) | 344.850ms (±0.00%) | -0.87%    | 37.144mb        | 37.145mb   | -0.00%      |
+-------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+

PersonalDataBench
=================

+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
|                                        | time (kde mode)                                     | memory                                     |
+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
| subject                                | Tag: <current>     | Tag: base          | time-diff | Tag: <current>  | Tag: base  | memory-diff |
+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
| benchLoad1Event ()                     | 900.100μs (±0.00%) | 884.900μs (±0.00%) | +1.72%    | 34.895mb        | 34.895mb   | 0.00%       |
| benchLoad10000Events ()                | 83.835ms (±0.00%)  | 83.836ms (±0.00%)  | -0.00%    | 34.895mb        | 34.895mb   | 0.00%       |
| benchSave1Event ()                     | 1.542ms (±0.00%)   | 1.534ms (±0.00%)   | +0.51%    | 34.895mb        | 34.895mb   | 0.00%       |
| benchSave10000Events ()                | 244.899ms (±0.00%) | 246.327ms (±0.00%) | -0.58%    | 34.897mb        | 34.897mb   | 0.00%       |
| benchSave10000Aggregates ()            | 12.413s (±0.00%)   | 12.366s (±0.00%)   | +0.38%    | 34.895mb        | 34.895mb   | 0.00%       |
| benchSave10000AggregatesTransaction () | 8.858s (±0.00%)    | 8.816s (±0.00%)    | +0.47%    | 35.396mb        | 35.396mb   | 0.00%       |
+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+

SimpleSetupBench
================

+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
|                                        | time (kde mode)                                     | memory                                     |
+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
| subject                                | Tag: <current>     | Tag: base          | time-diff | Tag: <current>  | Tag: base  | memory-diff |
+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
| benchLoad1Event ()                     | 907.300μs (±0.00%) | 946.800μs (±0.00%) | -4.17%    | 33.765mb        | 33.765mb   | 0.00%       |
| benchLoad10000Events ()                | 48.961ms (±0.00%)  | 50.245ms (±0.00%)  | -2.56%    | 33.765mb        | 33.765mb   | 0.00%       |
| benchSave1Event ()                     | 1.060ms (±0.00%)   | 1.195ms (±0.00%)   | -11.25%   | 33.765mb        | 33.765mb   | 0.00%       |
| benchSave10000Events ()                | 216.473ms (±0.00%) | 212.112ms (±0.00%) | +2.06%    | 33.765mb        | 33.765mb   | 0.00%       |
| benchSave10000Aggregates ()            | 8.323s (±0.00%)    | 8.364s (±0.00%)    | -0.49%    | 33.765mb        | 33.765mb   | 0.00%       |
| benchSave10000AggregatesTransaction () | 4.774s (±0.00%)    | 4.765s (±0.00%)    | +0.18%    | 33.765mb        | 33.765mb   | 0.00%       |
+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+

This comment gets update everytime a new commit comes in!

[DanielBadura]

Maybe we should also add a NOT IN event filter?

[DavidBadura]

For which use case 🤔

[DanielBadura]

Maybe for testing purposes, like checking what happens if an event will be dropped. It just came in my mind - nothing we need right away