9555551525

Committed 17 Jun 2024 10:16PM UTC coverage: 70.262% (-1.1%) from 71.395%

Build # 9555551525

Build Type

push

github

Committed by

prolic

Commit Message

update coveralls repo token

Run Details

3466 of 4933 relevant lines covered (70.26%)

67.7 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

79.55

/src/ClientOperations/CommitTransactionOperation.php

<?php

/**
 * This file is part of `prooph/event-store-client`.
 * (c) 2018-2024 Alexander Miertsch <kontakt@codeliner.ws>
 * (c) 2018-2024 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\EventStoreClient\ClientOperations;

use Amp\DeferredFuture;
use Google\Protobuf\Internal\Message;
use Prooph\EventStore\Exception\AccessDenied;
use Prooph\EventStore\Exception\InvalidTransaction;
use Prooph\EventStore\Exception\StreamDeleted;
use Prooph\EventStore\Exception\UnexpectedOperationResult;
use Prooph\EventStore\Exception\WrongExpectedVersion;
use Prooph\EventStore\Position;
use Prooph\EventStore\UserCredentials;
use Prooph\EventStore\WriteResult;
use Prooph\EventStoreClient\Messages\ClientMessages\OperationResult;
use Prooph\EventStoreClient\Messages\ClientMessages\TransactionCommit;
use Prooph\EventStoreClient\Messages\ClientMessages\TransactionCommitCompleted;
use Prooph\EventStoreClient\SystemData\InspectionDecision;
use Prooph\EventStoreClient\SystemData\InspectionResult;
use Prooph\EventStoreClient\SystemData\TcpCommand;
use Psr\Log\LoggerInterface as Logger;

/**
 * @internal
 * @extends AbstractOperation<TransactionCommitCompleted, WriteResult>
 */
class CommitTransactionOperation extends AbstractOperation
{
    public function __construct(
        Logger $logger,
        DeferredFuture $deferred,
        private readonly bool $requireMaster,
        private readonly int $transactionId,
        ?UserCredentials $userCredentials
    ) {
        parent::__construct(
            $logger,
            $deferred,
            $userCredentials,
            TcpCommand::TransactionCommit,
            TcpCommand::TransactionCommitCompleted,
            TransactionCommitCompleted::class
        );
    }

    protected function createRequestDto(): Message
    {
        $message = new TransactionCommit();
        $message->setRequireMaster($this->requireMaster);
        $message->setTransactionId($this->transactionId);

        return $message;
    }

    /**
     * @param TransactionCommitCompleted $response
     * @return InspectionResult
     */
    protected function inspectResponse(Message $response): InspectionResult
    {
        switch ($response->getResult()) {
            case OperationResult::Success:
                $this->succeed($response);

                return new InspectionResult(InspectionDecision::EndOperation, 'Success');
            case OperationResult::PrepareTimeout:
                return new InspectionResult(InspectionDecision::Retry, 'PrepareTimeout');
            case OperationResult::ForwardTimeout:
                return new InspectionResult(InspectionDecision::Retry, 'ForwardTimeout');
            case OperationResult::CommitTimeout:
                return new InspectionResult(InspectionDecision::Retry, 'CommitTimeout');
            case OperationResult::WrongExpectedVersion:
                $this->fail(new WrongExpectedVersion(\sprintf(
                    'Commit transaction failed due to WrongExpectedVersion. Transaction id: \'%s\'',
                    $this->transactionId
                )));

                return new InspectionResult(InspectionDecision::EndOperation, 'WrongExpectedVersion');
            case OperationResult::StreamDeleted:
                $this->fail(new StreamDeleted());

                return new InspectionResult(InspectionDecision::EndOperation, 'StreamDeleted');
            case OperationResult::InvalidTransaction:
                $this->fail(new InvalidTransaction());

                return new InspectionResult(InspectionDecision::EndOperation, 'InvalidTransaction');
            case OperationResult::AccessDenied:
                $exception = new AccessDenied('Write access denied');
                $this->fail($exception);

                return new InspectionResult(InspectionDecision::EndOperation, 'AccessDenied');
            default:
                throw new UnexpectedOperationResult();
        }
    }

    /**
     * @param TransactionCommitCompleted $response
     * @return WriteResult
     */
    protected function transformResponse(Message $response): WriteResult
    {
        /** @psalm-suppress DocblockTypeContradiction */
        return new WriteResult(
            (int) $response->getLastEventNumber(),
            new Position(
                (int) ($response->getCommitPosition() ?? -1),
                (int) ($response->getPreparePosition() ?? -1)
            )
        );
    }

    public function name(): string
    {
        return 'CommitTransaction';
    }

    public function __toString(): string
    {
        return \sprintf(
            'TransactionId: %s, RequireMaster: %s',
            $this->transactionId,
            $this->requireMaster ? 'yes' : 'no'
        );
    }
}

1	<?php
2
3	/**
4	* This file is part of `prooph/event-store-client`.
5	* (c) 2018-2024 Alexander Miertsch <kontakt@codeliner.ws>
6	* (c) 2018-2024 Sascha-Oliver Prolic <saschaprolic@googlemail.com>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11
12	declare(strict_types=1);
13
14	namespace Prooph\EventStoreClient\ClientOperations;
15
16	use Amp\DeferredFuture;
17	use Google\Protobuf\Internal\Message;
18	use Prooph\EventStore\Exception\AccessDenied;
19	use Prooph\EventStore\Exception\InvalidTransaction;
20	use Prooph\EventStore\Exception\StreamDeleted;
21	use Prooph\EventStore\Exception\UnexpectedOperationResult;
22	use Prooph\EventStore\Exception\WrongExpectedVersion;
23	use Prooph\EventStore\Position;
24	use Prooph\EventStore\UserCredentials;
25	use Prooph\EventStore\WriteResult;
26	use Prooph\EventStoreClient\Messages\ClientMessages\OperationResult;
27	use Prooph\EventStoreClient\Messages\ClientMessages\TransactionCommit;
28	use Prooph\EventStoreClient\Messages\ClientMessages\TransactionCommitCompleted;
29	use Prooph\EventStoreClient\SystemData\InspectionDecision;
30	use Prooph\EventStoreClient\SystemData\InspectionResult;
31	use Prooph\EventStoreClient\SystemData\TcpCommand;
32	use Psr\Log\LoggerInterface as Logger;
33
34	/**
35	* @internal
36	* @extends AbstractOperation<TransactionCommitCompleted, WriteResult>
37	*/
38	class CommitTransactionOperation extends AbstractOperation
39	{
40	public function __construct(
41	Logger $logger,
42	DeferredFuture $deferred,
43	private readonly bool $requireMaster,
44	private readonly int $transactionId,
45	?UserCredentials $userCredentials
46	) {
47	parent::__construct(	39✔
48	$logger,	39✔
49	$deferred,	39✔
50	$userCredentials,	39✔
51	TcpCommand::TransactionCommit,	39✔
52	TcpCommand::TransactionCommitCompleted,	39✔
53	TransactionCommitCompleted::class	39✔
54	);	39✔
55	}
56
57	protected function createRequestDto(): Message
58	{
59	$message = new TransactionCommit();	39✔
60	$message->setRequireMaster($this->requireMaster);	39✔
61	$message->setTransactionId($this->transactionId);	39✔
62
63	return $message;	39✔
64	}
65
66	/**
67	* @param TransactionCommitCompleted $response
68	* @return InspectionResult
69	*/
70	protected function inspectResponse(Message $response): InspectionResult
71	{
72	switch ($response->getResult()) {	39✔
73	case OperationResult::Success:
74	$this->succeed($response);	35✔
75
76	return new InspectionResult(InspectionDecision::EndOperation, 'Success');	35✔
77	case OperationResult::PrepareTimeout:
78	return new InspectionResult(InspectionDecision::Retry, 'PrepareTimeout');	×
79	case OperationResult::ForwardTimeout:
80	return new InspectionResult(InspectionDecision::Retry, 'ForwardTimeout');	×
81	case OperationResult::CommitTimeout:
82	return new InspectionResult(InspectionDecision::Retry, 'CommitTimeout');	×
83	case OperationResult::WrongExpectedVersion:
84	$this->fail(new WrongExpectedVersion(\sprintf(	6✔
85	'Commit transaction failed due to WrongExpectedVersion. Transaction id: \'%s\'',	6✔
86	$this->transactionId	6✔
87	)));	6✔
88
89	return new InspectionResult(InspectionDecision::EndOperation, 'WrongExpectedVersion');	6✔
90	case OperationResult::StreamDeleted:
91	$this->fail(new StreamDeleted());	1✔
92
93	return new InspectionResult(InspectionDecision::EndOperation, 'StreamDeleted');	1✔
94	case OperationResult::InvalidTransaction:
95	$this->fail(new InvalidTransaction());	×
96
97	return new InspectionResult(InspectionDecision::EndOperation, 'InvalidTransaction');	×
98	case OperationResult::AccessDenied:
99	$exception = new AccessDenied('Write access denied');	×
100	$this->fail($exception);	×
101
102	return new InspectionResult(InspectionDecision::EndOperation, 'AccessDenied');	×
103	default:
104	throw new UnexpectedOperationResult();	×
105	}
106	}
107
108	/**
109	* @param TransactionCommitCompleted $response
110	* @return WriteResult
111	*/
112	protected function transformResponse(Message $response): WriteResult
113	{
114	/** @psalm-suppress DocblockTypeContradiction */
115	return new WriteResult(	35✔
116	(int) $response->getLastEventNumber(),	35✔
117	new Position(	35✔
118	(int) ($response->getCommitPosition() ?? -1),	35✔
119	(int) ($response->getPreparePosition() ?? -1)	35✔
120	)	35✔
121	);	35✔
122	}
123
124	public function name(): string
125	{
126	return 'CommitTransaction';	39✔
127	}
128
129	public function __toString(): string
130	{
131	return \sprintf(	39✔
132	'TransactionId: %s, RequireMaster: %s',	39✔
133	$this->transactionId,	39✔
134	$this->requireMaster ? 'yes' : 'no'	39✔
135	);	39✔
136	}
137	}

prooph / event-store-client / 9555551525

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous