Skip to content

keep projections running as long events are loading #257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
basz merged 1 commit into from
Apr 22, 2025
Merged

keep projections running as long events are loading #257

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 5 additions & 10 deletions src/Projection/PdoEventStoreReadModelProjector.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,11 +132,6 @@ final class PdoEventStoreReadModelProjector implements MetadataAwareReadModelPro
*/
private $eventCounter = 0;

/**
* @var int
*/
private $loadedEvents = 0;

/**
* @var int
*/
Expand Down Expand Up @@ -529,7 +524,7 @@ public function run(bool $keepRunning = true): void
}

$streamEvents = new MergedStreamIterator(\array_keys($eventStreams), ...\array_values($eventStreams));
$this->loadedEvents = $streamEvents->count();
$loadedEvents = $streamEvents->count();

if ($singleHandler) {
$gapDetected = ! $this->handleStreamWithSingleHandler($streamEvents);
Expand Down Expand Up @@ -586,9 +581,9 @@ public function run(bool $keepRunning = true): void
}

$this->prepareStreamPositions();
} while ($keepRunning && ! $this->isStopped);
} while (($keepRunning || $loadedEvents > 0) && ! $this->isStopped);
} finally {
$this->releaseLock($keepRunning);
$this->releaseLock($keepRunning, $loadedEvents);
}
}

Expand Down Expand Up @@ -915,7 +910,7 @@ private function updateLock(): void
$this->lastLockUpdate = $now;
}

private function releaseLock(bool $keepRunning): void
private function releaseLock(bool $keepRunning, int $loadedEvents): void
{
$projectionsTable = $this->quoteTableName($this->projectionsTable);
$sql = <<<EOT
Expand All @@ -924,7 +919,7 @@ private function releaseLock(bool $keepRunning): void

$statement = $this->connection->prepare($sql);

$status = $keepRunning && $this->loadedEvents > 0 ? ProjectionStatus::RUNNING() : ProjectionStatus::IDLE();
$status = ($keepRunning || $loadedEvents > 0) ? ProjectionStatus::RUNNING() : ProjectionStatus::IDLE();

try {
$statement->execute([$status->getValue(), $this->name]);
Expand Down
126 changes: 84 additions & 42 deletions tests/Projection/AbstractPdoEventStoreReadModelProjectorTestCase.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
namespace ProophTest\EventStore\Pdo\Projection;

use ArrayIterator;
use Assert\Assertion;
use DateInterval;
use DateTimeImmutable;
use DateTimeZone;
Expand All @@ -27,6 +28,7 @@
use Prooph\EventStore\Pdo\Projection\GapDetection;
use Prooph\EventStore\Pdo\Projection\PdoEventStoreProjector;
use Prooph\EventStore\Pdo\Projection\PdoEventStoreReadModelProjector;
use Prooph\EventStore\Projection\ProjectionStatus;
use Prooph\EventStore\Projection\Projector;
use Prooph\EventStore\Projection\ReadModel;
use Prooph\EventStore\Stream;
Expand Down Expand Up @@ -456,27 +458,21 @@ public function it_detects_gap_and_performs_retry(): void
$projection
->fromStream('user')
->init(function () {
return [];
return ['iteration' => 0];
})
->when([
UserCreated::class => function (array $state, Message $event): array {
return $state;
},
UsernameChanged::class => function (array $state, Message $event): array {
return $state;
},
])
->run(false);

$this->assertEquals(1, $projectionManager->fetchProjectionStreamPositions('test_projection')['user']);

$this->assertTrue($gapDetection->isRetrying());
->whenAny(
function (array $state, Message $event) use ($projectionManager, $gapDetection, $parallelConnection): array {
if ($state['iteration'] === 1) {
Assertion::true($gapDetection->isRetrying());
$parallelConnection->commit();
Copy link
Member Author

@unixslayer unixslayer Apr 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had to change a little bit logic in this test due now each projection will try to finish by itself

}

// Fill the gap
$parallelConnection->commit();
++$state['iteration'];

// Run again with gap detection in retry mode
$projection->run(false);
return $state;
}
)
->run(false);

$this->assertEquals(3, $projectionManager->fetchProjectionStreamPositions('test_projection')['user']);

Expand Down Expand Up @@ -521,36 +517,25 @@ public function it_continues_when_retry_limit_is_reached_and_gap_not_filled(): v
$projection
->fromStream('user')
->init(function () {
return [];
return ['iteration' => 0];
})
->when([
UserCreated::class => function (array $state, Message $event): array {
return $state;
},
UsernameChanged::class => function (array $state, Message $event): array {
return $state;
},
])
->run(false);

$this->assertEquals(1, $projectionManager->fetchProjectionStreamPositions('test_projection')['user']);

$this->assertTrue($gapDetection->isRetrying());

// Force a real gap
$parallelConnection->rollBack();

// Run again with gap detection in retry mode
$projection->run(false);
->whenAny(
function (array $state, Message $event) use ($projectionManager, $gapDetection, $parallelConnection): array {
if ($state['iteration'] === 1) {
Assertion::true($gapDetection->isRetrying());
$parallelConnection->rollBack();
}

// Projection should not move forward, but instead retry a second time
$this->assertEquals(1, $projectionManager->fetchProjectionStreamPositions('test_projection')['user']);
++$state['iteration'];

// Third run with gap detection still in retry mode, but limit reached
$projection->run(false);
return $state;
}
)
->run(false);

//Projection should have moved forward
$this->assertEquals(3, $projectionManager->fetchProjectionStreamPositions('test_projection')['user']);
$this->assertEquals(ProjectionStatus::IDLE(), $projectionManager->fetchProjectionStatus('test_projection'));

$this->assertFalse($gapDetection->isRetrying());
}
Expand Down Expand Up @@ -632,4 +617,61 @@ protected function prepareEventStreamWithOneEvent(string $name, ?DateTimeImmutab

$this->eventStore->create(new Stream(new StreamName($name), new ArrayIterator($events)));
}

#[Test]
public function projection_should_run_until_end_of_stream(): void
{
$this->prepareEventStream('user-345');

$projectionManager = $this->projectionManager;
$projection = $projectionManager->createReadModelProjection('test_projection', new ReadModelMock(), [
Projector::OPTION_PERSIST_BLOCK_SIZE => 1,
PdoEventStoreReadModelProjector::OPTION_LOAD_COUNT => 1,
]);

$projection
->fromStream('user-345')
->whenAny(function () {
})
->run(false);

$this->assertEquals(50, $projectionManager->fetchProjectionStreamPositions('test_projection')['user-345']);
$this->assertEquals(ProjectionStatus::IDLE(), $projectionManager->fetchProjectionStatus('test_projection'));
}

#[Test]
public function when_failed_projection_should_release_lock_but_indicate_running_status(): void
{
$this->prepareEventStream('user-345');

$projectionManager = $this->projectionManager;
$projection = $projectionManager->createReadModelProjection('test_projection', new ReadModelMock(), [
Projector::OPTION_PERSIST_BLOCK_SIZE => 1,
PdoEventStoreReadModelProjector::OPTION_LOAD_COUNT => 1,
]);

$projection
->fromStream('user-345')
->init(function () {
return ['iteration' => 0];
})
->whenAny(function (array $state, Message $event): array {
++$state['iteration'];

if ($state['iteration'] > 5) {
throw new \RuntimeException('something happened');
}

return $state;
});

try {
$projection->run(false);
} catch (\Throwable) {
}

$this->assertEquals(5, $projectionManager->fetchProjectionStreamPositions('test_projection')['user-345']);
$this->assertEquals(ProjectionStatus::RUNNING(), $projectionManager->fetchProjectionStatus('test_projection'));
$this->assertNull($this->connection->query("select locked_until from projections where name = 'test_projection'")->fetch(PDO::FETCH_COLUMN));
}
}
Loading