-
Notifications
You must be signed in to change notification settings - Fork 42
/
AggregateRepository.php
339 lines (283 loc) · 9.75 KB
/
AggregateRepository.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
<?php
/**
* This file is part of prooph/event-sourcing.
* (c) 2014-2021 Alexander Miertsch <kontakt@codeliner.ws>
* (c) 2015-2021 Sascha-Oliver Prolic <saschaprolic@googlemail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
declare(strict_types=1);
namespace Prooph\EventSourcing\Aggregate;
use ArrayIterator;
use Prooph\Common\Messaging\Message;
use Prooph\EventStore\EventStore;
use Prooph\EventStore\Exception\StreamNotFound;
use Prooph\EventStore\Metadata\MetadataMatcher;
use Prooph\EventStore\Metadata\Operator;
use Prooph\EventStore\Stream;
use Prooph\EventStore\StreamName;
use Prooph\SnapshotStore\SnapshotStore;
class AggregateRepository
{
/**
* @var EventStore
*/
protected $eventStore;
/**
* @var AggregateTranslator
*/
protected $aggregateTranslator;
/**
* @var AggregateType
*/
protected $aggregateType;
/**
* @var array
*/
protected $identityMap = [];
/**
* @var SnapshotStore|null
*/
protected $snapshotStore;
/**
* @var StreamName
*/
protected $streamName;
/**
* @var bool
*/
protected $oneStreamPerAggregate;
/**
* @var array
*/
protected $metadata;
/**
* @var bool
*/
protected $disableIdentityMap;
public function __construct(
EventStore $eventStore,
AggregateType $aggregateType,
AggregateTranslator $aggregateTranslator,
SnapshotStore $snapshotStore = null,
StreamName $streamName = null,
bool $oneStreamPerAggregate = false,
bool $disableIdentityMap = false,
array $metadata = []
) {
$this->eventStore = $eventStore;
$this->aggregateType = $aggregateType;
$this->aggregateTranslator = $aggregateTranslator;
$this->snapshotStore = $snapshotStore;
$this->streamName = $streamName;
$this->oneStreamPerAggregate = $oneStreamPerAggregate;
$this->disableIdentityMap = $disableIdentityMap;
$this->metadata = $metadata;
}
/**
* @param object $eventSourcedAggregateRoot
*/
public function saveAggregateRoot($eventSourcedAggregateRoot): void
{
$this->assertAggregateType($eventSourcedAggregateRoot);
$domainEvents = $this->aggregateTranslator->extractPendingStreamEvents($eventSourcedAggregateRoot);
$aggregateId = $this->aggregateTranslator->extractAggregateId($eventSourcedAggregateRoot);
$streamName = $this->determineStreamName($aggregateId);
$enrichedEvents = [];
$createStream = false;
$firstEvent = \reset($domainEvents);
if (false === $firstEvent) {
return;
}
if ($this->oneStreamPerAggregate && $this->isFirstEvent($firstEvent)) {
$createStream = true;
}
foreach ($domainEvents as $event) {
$enrichedEvents[] = $this->enrichEventMetadata($event, $aggregateId);
}
if ($createStream) {
$stream = new Stream($streamName, new ArrayIterator($enrichedEvents), $this->metadata);
$this->eventStore->create($stream);
} else {
$this->eventStore->appendTo($streamName, new ArrayIterator($enrichedEvents));
}
if (! $this->disableIdentityMap && isset($this->identityMap[$aggregateId])) {
unset($this->identityMap[$aggregateId]);
}
}
/**
* Returns null if no stream events can be found for aggregate root otherwise the reconstituted aggregate root
*
* @return null|object
*/
public function getAggregateRoot(string $aggregateId)
{
if (! $this->disableIdentityMap && isset($this->identityMap[$aggregateId])) {
return $this->identityMap[$aggregateId];
}
if ($this->snapshotStore) {
$eventSourcedAggregateRoot = $this->loadFromSnapshotStore($aggregateId);
if ($eventSourcedAggregateRoot && ! $this->disableIdentityMap) {
//Cache aggregate root in the identity map
$this->identityMap[$aggregateId] = $eventSourcedAggregateRoot;
}
return $eventSourcedAggregateRoot;
}
$streamName = $this->determineStreamName($aggregateId);
if ($this->oneStreamPerAggregate) {
try {
$streamEvents = $this->eventStore->load($streamName, 1);
} catch (StreamNotFound $e) {
return null;
}
} else {
$metadataMatcher = new MetadataMatcher();
$metadataMatcher = $metadataMatcher->withMetadataMatch(
'_aggregate_type',
Operator::EQUALS(),
$this->aggregateType->toString()
);
$metadataMatcher = $metadataMatcher->withMetadataMatch(
'_aggregate_id',
Operator::EQUALS(),
$aggregateId
);
try {
$streamEvents = $this->eventStore->load($streamName, 1, null, $metadataMatcher);
} catch (StreamNotFound $e) {
return null;
}
}
if (! $streamEvents->valid()) {
return null;
}
$eventSourcedAggregateRoot = $this->aggregateTranslator->reconstituteAggregateFromHistory(
$this->aggregateType,
$streamEvents
);
if (! $this->disableIdentityMap) {
//Cache aggregate root in the identity map but without pending events
$this->identityMap[$aggregateId] = $eventSourcedAggregateRoot;
}
return $eventSourcedAggregateRoot;
}
/**
* @param object $aggregateRoot
*/
public function extractAggregateVersion($aggregateRoot): int
{
return $this->aggregateTranslator->extractAggregateVersion($aggregateRoot);
}
/**
* Empties the identity map. Use this if you load thousands of aggregates to free memory e.g. modulo 500.
*/
public function clearIdentityMap(): void
{
$this->identityMap = [];
}
protected function isFirstEvent(Message $message): bool
{
return 1 === $message->metadata()['_aggregate_version'];
}
/**
* @return null|object
*/
protected function loadFromSnapshotStore(string $aggregateId)
{
$snapshot = $this->snapshotStore->get($this->aggregateType->toString(), $aggregateId);
if ($snapshot) {
$lastVersion = $snapshot->lastVersion();
$aggregateRoot = $snapshot->aggregateRoot();
} else {
$lastVersion = 0;
$aggregateRoot = null;
}
$streamName = $this->determineStreamName($aggregateId);
if ($this->oneStreamPerAggregate) {
try {
$streamEvents = $this->eventStore->load(
$streamName,
$lastVersion + 1
);
} catch (StreamNotFound $e) {
return $aggregateRoot;
}
} else {
$metadataMatcher = new MetadataMatcher();
$metadataMatcher = $metadataMatcher->withMetadataMatch(
'_aggregate_type',
Operator::EQUALS(),
$this->aggregateType->toString()
);
$metadataMatcher = $metadataMatcher->withMetadataMatch(
'_aggregate_id',
Operator::EQUALS(),
$aggregateId
);
$metadataMatcher = $metadataMatcher->withMetadataMatch(
'_aggregate_version',
Operator::GREATER_THAN(),
$lastVersion
);
try {
$streamEvents = $this->eventStore->load(
$streamName,
$lastVersion + 1,
null,
$metadataMatcher
);
} catch (StreamNotFound $e) {
return $aggregateRoot;
}
}
if (! $streamEvents->valid()) {
return $aggregateRoot;
}
if ($aggregateRoot) {
$this->aggregateTranslator->replayStreamEvents($aggregateRoot, $streamEvents);
} else {
$aggregateRoot = $this->aggregateTranslator->reconstituteAggregateFromHistory(
$this->aggregateType,
$streamEvents
);
}
return $aggregateRoot;
}
/**
* Default stream name generation.
* Override this method in an extending repository to provide a custom name
*/
protected function determineStreamName(string $aggregateId): StreamName
{
if ($this->oneStreamPerAggregate) {
if (null === $this->streamName) {
$prefix = $this->aggregateType->toString();
} else {
$prefix = $this->streamName->toString();
}
return new StreamName($prefix . '-' . $aggregateId);
}
if (null === $this->streamName) {
return new StreamName('event_stream');
}
return $this->streamName;
}
/**
* Add aggregate_id and aggregate_type as metadata to $domainEvent
* Override this method in an extending repository to add more or different metadata.
*/
protected function enrichEventMetadata(Message $domainEvent, string $aggregateId): Message
{
$domainEvent = $domainEvent->withAddedMetadata('_aggregate_id', $aggregateId);
$domainEvent = $domainEvent->withAddedMetadata('_aggregate_type', $this->aggregateType->toString());
return $domainEvent;
}
/**
* @param object $eventSourcedAggregateRoot
*/
protected function assertAggregateType($eventSourcedAggregateRoot)
{
$this->aggregateType->assert($eventSourcedAggregateRoot);
}
}