Skip to content

fix: report every failure from parallel saga compensation #786

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

Draft
xepozz wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

fix: report every failure from parallel saga compensation #786

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
19 changes: 17 additions & 2 deletions src/Workflow/Saga.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
namespace Temporal\Workflow;

use Temporal\Exception\CompensationException;
use Temporal\Promise;
use Temporal\Workflow;

final class Saga
Expand Down Expand Up @@ -67,7 +66,23 @@ function () {
$scopes[] = Workflow::asyncDetached($handler);
}

yield Promise::all($scopes);
$sagaException = null;
foreach ($scopes as $scope) {
try {
yield $scope;
} catch (\Exception $e) {
if ($sagaException === null) {
$sagaException = new CompensationException($e->getMessage(), (int) $e->getCode(), $e);
} else {
$sagaException->addSuppressed($e);
}
}
}

if ($sagaException !== null) {
throw $sagaException;
}

return;
}

Expand Down
236 changes: 236 additions & 0 deletions tests/Unit/Workflow/SagaParallelCompensationTestCase.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,236 @@
<?php

declare(strict_types=1);

namespace Temporal\Tests\Unit\Workflow;

use Temporal\Exception\CompensationException;
use Temporal\Tests\Unit\Framework\WorkerFactoryMock;
use Temporal\Tests\Unit\Framework\WorkerMock;
use Temporal\Tests\Unit\AbstractUnit;
use Temporal\Worker\WorkerFactoryInterface;
use Temporal\Worker\WorkerInterface;
use Temporal\Workflow;
use Temporal\Workflow\Saga;
use Temporal\Workflow\WorkflowMethod;

final class SagaParallelCompensationTestCase extends AbstractUnit
{
private WorkerFactoryInterface $factory;
/** @var WorkerMock|WorkerInterface */
private $worker;

protected function setUp(): void
{
$this->factory = WorkerFactoryMock::create();
$this->worker = $this->factory->newWorker();

parent::setUp();
}

public function testParallelCompensationHappyPathCompletes(): void
{
$this->addToAssertionCount(1);
$this->worker->registerWorkflowObject(
new
#[Workflow\WorkflowInterface]
class {
#[WorkflowMethod(name: 'SagaParallelWorkflow')]
public function handler(): iterable
{
$saga = new Saga();
$saga->setParallelCompensation(true);
$log = [];
$saga->addCompensation(static function () use (&$log): void {
$log[] = 'A';
});
$saga->addCompensation(static function () use (&$log): void {
$log[] = 'B';
});

yield $saga->compensate();

\sort($log);

return \implode('|', $log);
}
}
);

$this->worker->runWorkflow('SagaParallelWorkflow');
$this->worker->assertWorkflowReturns('A|B');
$this->factory->run($this->worker);
}

public function testParallelCompensationPropagatesRawErrorForRetry(): void
{
$this->addToAssertionCount(1);
$this->worker->registerWorkflowObject(
new
#[Workflow\WorkflowInterface]
class {
#[WorkflowMethod(name: 'SagaParallelWorkflow')]
public function handler(): iterable
{
$saga = new Saga();
$saga->setParallelCompensation(true);
$saga->addCompensation(static function (): void {
throw new \TypeError('deployment bug');
});

try {
yield $saga->compensate();
} catch (\Throwable $e) {
return $e::class . '|' . $e->getMessage();
}

return 'NO_THROW';
}
}
);

$this->worker->runWorkflow('SagaParallelWorkflow');
$this->worker->assertWorkflowReturns('TypeError|deployment bug');
$this->factory->run($this->worker);
}

public function testSequentialRunsCompensationsInReverseOrder(): void
{
$this->addToAssertionCount(1);
$this->worker->registerWorkflowObject(
new
#[Workflow\WorkflowInterface]
class {
#[WorkflowMethod(name: 'SagaParallelWorkflow')]
public function handler(): iterable
{
$saga = new Saga();
$saga->setParallelCompensation(false);

$order = [];
$saga->addCompensation(static function () use (&$order): void {
$order[] = 'first-added';
});
$saga->addCompensation(static function () use (&$order): void {
$order[] = 'second-added';
});

yield $saga->compensate();

return \implode(',', $order);
}
}
);

$this->worker->runWorkflow('SagaParallelWorkflow');
$this->worker->assertWorkflowReturns('second-added,first-added');
$this->factory->run($this->worker);
}

public function testSequentialStopsAtFirstFailureAndThrowsRaw(): void
{
$this->addToAssertionCount(1);
$this->worker->registerWorkflowObject(
new
#[Workflow\WorkflowInterface]
class {
#[WorkflowMethod(name: 'SagaParallelWorkflow')]
public function handler(): iterable
{
$saga = new Saga();
$saga->setParallelCompensation(false);

$ran = [];
$saga->addCompensation(static function () use (&$ran): void {
$ran[] = 'first-added';
});
$saga->addCompensation(static function (): void {
throw new \RuntimeException('boom-last');
});

try {
yield $saga->compensate();
} catch (\Throwable $e) {
return $e::class . '|' . $e->getMessage() . '|ran=' . \implode(',', $ran);
}

return 'NO_THROW';
}
}
);

$this->worker->runWorkflow('SagaParallelWorkflow');
$this->worker->assertWorkflowReturns('RuntimeException|boom-last|ran=');
$this->factory->run($this->worker);
}

public function testCompensateReturnValueProbe(): void
{
$this->addToAssertionCount(1);
$this->worker->registerWorkflowObject(
new
#[Workflow\WorkflowInterface]
class {
#[WorkflowMethod(name: 'SagaParallelWorkflow')]
public function handler(): iterable
{
$saga = new Saga();
$saga->setParallelCompensation(true);
$saga->addCompensation(static fn(): string => 'A');
$saga->addCompensation(static fn(): string => 'B');

$result = yield $saga->compensate();

return 'RET:' . \var_export($result, true);
}
}
);

$this->worker->runWorkflow('SagaParallelWorkflow');
$this->worker->assertWorkflowReturns('RET:NULL');
$this->factory->run($this->worker);
}

public function testParallelCompensationReportsEveryFailure(): void
{
$this->addToAssertionCount(1);
$this->worker->registerWorkflowObject(
new
#[Workflow\WorkflowInterface]
class {
#[WorkflowMethod(name: 'SagaParallelWorkflow')]
public function handler(): iterable
{
$saga = new Saga();
$saga->setParallelCompensation(true);
$saga->addCompensation(static function (): void {
throw new \RuntimeException('comp-A');
});
$saga->addCompensation(static function (): void {
throw new \RuntimeException('comp-B');
});

try {
yield $saga->compensate();
} catch (\Throwable $e) {
$seen = [$e->getMessage()];
if ($e instanceof CompensationException) {
foreach ($e->getSuppressed() as $suppressed) {
$seen[] = $suppressed->getMessage();
}
}
\sort($seen);

return \implode('|', \array_unique($seen));
}

return 'NO_THROW';
}
}
);

$this->worker->runWorkflow('SagaParallelWorkflow');
$this->worker->assertWorkflowReturns('comp-A|comp-B');
$this->factory->run($this->worker);
}
}
Loading