Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit306a8e7

Browse files
Introduce LockMiddleware
1 parent272f021 commit306a8e7

File tree

7 files changed

+238
-0
lines changed

7 files changed

+238
-0
lines changed

‎src/Symfony/Bundle/FrameworkBundle/Resources/config/messenger.php

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
useSymfony\Component\Messenger\Middleware\DispatchAfterCurrentBusMiddleware;
2929
useSymfony\Component\Messenger\Middleware\FailedMessageProcessingMiddleware;
3030
useSymfony\Component\Messenger\Middleware\HandleMessageMiddleware;
31+
useSymfony\Component\Messenger\Middleware\LockMiddleware;
3132
useSymfony\Component\Messenger\Middleware\RejectRedeliveredMessageMiddleware;
3233
useSymfony\Component\Messenger\Middleware\RouterContextMiddleware;
3334
useSymfony\Component\Messenger\Middleware\SendMessageMiddleware;
@@ -86,6 +87,11 @@
8687
->tag('monolog.logger', ['channel' =>'messenger'])
8788
->call('setLogger', [service('logger')->ignoreOnInvalid()])
8889

90+
->set('messenger.middleware.lock_middleware', LockMiddleware::class)
91+
->args([
92+
service('lock.factory')->nullOnInvalid(),
93+
])
94+
8995
->set('messenger.middleware.add_bus_name_stamp_middleware', AddBusNameStampMiddleware::class)
9096
->abstract()
9197

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.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+
namespaceSymfony\Component\Messenger\Message;
13+
14+
useSymfony\Component\Lock\Key;
15+
16+
interface LockableMessage
17+
{
18+
/**
19+
* Returns null if you want to force the dispatch of the message.
20+
*/
21+
publicfunctiongetKey(): ?Key;
22+
}
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.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+
namespaceSymfony\Component\Messenger\Middleware;
13+
14+
useSymfony\Component\Lock\LockFactory;
15+
useSymfony\Component\Messenger\Envelope;
16+
useSymfony\Component\Messenger\Message\LockableMessage;
17+
useSymfony\Component\Messenger\Stamp\LockStamp;
18+
useSymfony\Component\Messenger\Stamp\ReceivedStamp;
19+
20+
finalclass LockMiddlewareimplements MiddlewareInterface
21+
{
22+
private ?LockFactory$lockFactory =null;
23+
24+
publicfunction__construct(
25+
?LockFactory$lockFactory,
26+
) {
27+
$this->lockFactory =$lockFactory;
28+
}
29+
30+
publicfunctionhandle(Envelope$envelope,StackInterface$stack):Envelope
31+
{
32+
if (null ===$this->lockFactory) {
33+
return$stack->next()->handle($envelope,$stack);
34+
}
35+
36+
$message =$envelope->getMessage();
37+
38+
// If we're trying to dispatch a lockable message.
39+
if ($messageinstanceof LockableMessage &&null ===$envelope->last(ReceivedStamp::class)) {
40+
$key =$message->getKey();
41+
42+
if (null !==$key) {
43+
// The acquire call must be done before stamping the message
44+
// in order to have the full state of the key in the stamp.
45+
$canAcquire =$this->lockFactory->createLockFromKey($key, autoRelease:false)->acquire();
46+
47+
$envelope =$envelope->with(newLockStamp($key));
48+
if (!$canAcquire) {
49+
return$envelope;
50+
}
51+
}
52+
}
53+
54+
try {
55+
$envelope =$stack->next()->handle($envelope,$stack);
56+
}finally {
57+
// If we've received a lockable message, we're releasing it.
58+
if (null !==$envelope->last(ReceivedStamp::class)) {
59+
$stamp =$envelope->last(LockStamp::class);
60+
if ($stampinstanceof LockStamp) {
61+
$this->lockFactory->createLockFromKey($stamp->getKey(), autoRelease:false)->release();
62+
}
63+
}
64+
}
65+
66+
return$envelope;
67+
}
68+
}
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.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+
namespaceSymfony\Component\Messenger\Stamp;
13+
14+
useSymfony\Component\Lock\Key;
15+
16+
finalclass LockStampimplements StampInterface
17+
{
18+
privateKey$key;
19+
20+
publicfunction__construct(Key$key)
21+
{
22+
$this->key =$key;
23+
}
24+
25+
publicfunctiongetKey():Key
26+
{
27+
return$this->key;
28+
}
29+
}
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<?php
2+
3+
namespaceSymfony\Component\Messenger\Tests\Fixtures;
4+
5+
useSymfony\Component\Lock\Key;
6+
useSymfony\Component\Messenger\Message\LockableMessage;
7+
8+
class DummyLockableMessageimplements DummyMessageInterface, LockableMessage
9+
{
10+
privatestring$message;
11+
12+
private ?Key$key;
13+
14+
publicfunction__construct(string$message, ?Key$key)
15+
{
16+
$this->message =$message;
17+
$this->key =$key;
18+
}
19+
20+
publicfunctiongetMessage():string
21+
{
22+
return$this->message;
23+
}
24+
25+
publicfunctiongetKey(): ?Key
26+
{
27+
return$this->key;
28+
}
29+
}
Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.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+
namespaceSymfony\Component\Messenger\Tests\Middleware;
13+
14+
useSymfony\Component\Lock\Key;
15+
useSymfony\Component\Lock\LockFactory;
16+
useSymfony\Component\Lock\Store\FlockStore;
17+
useSymfony\Component\Lock\Store\SemaphoreStore;
18+
useSymfony\Component\Messenger\Envelope;
19+
useSymfony\Component\Messenger\Middleware\LockMiddleware;
20+
useSymfony\Component\Messenger\Stamp\LockStamp;
21+
useSymfony\Component\Messenger\Stamp\ReceivedStamp;
22+
useSymfony\Component\Messenger\Test\Middleware\MiddlewareTestCase;
23+
useSymfony\Component\Messenger\Tests\Fixtures\DummyLockableMessage;
24+
useSymfony\Component\Messenger\Tests\Fixtures\DummyMessage;
25+
26+
finalclass LockMiddlewareTestextends MiddlewareTestCase
27+
{
28+
publicfunctiontestLockMiddlewareIgnoreIfMessageIsNotLockable()
29+
{
30+
$message =newDummyMessage('Hello');
31+
$envelope =newEnvelope($message);
32+
33+
$lockFactory =$this->createMock(LockFactory::class);
34+
$lockFactory->expects($this->never())->method('createLock');
35+
36+
$decorator =newLockMiddleware($lockFactory);
37+
38+
$decorator->handle($envelope,$this->getStackMock(true));
39+
}
40+
41+
publicfunctiontestLockMiddlewareIgnoreIfMessageHasNoKey()
42+
{
43+
$message =newDummyLockableMessage('Hello',null);
44+
$envelope =newEnvelope($message);
45+
46+
$lockFactory =$this->createMock(LockFactory::class);
47+
$lockFactory->expects($this->never())->method('createLock');
48+
49+
$decorator =newLockMiddleware($lockFactory);
50+
51+
$decorator->handle($envelope,$this->getStackMock(true));
52+
}
53+
54+
publicfunctiontestLockMiddlewareIfMessageHasKey()
55+
{
56+
$message =newDummyLockableMessage('Hello',newKey('id'));
57+
$envelope =newEnvelope($message);
58+
59+
if (SemaphoreStore::isSupported()) {
60+
$store =newSemaphoreStore();
61+
}else {
62+
$store =newFlockStore();
63+
}
64+
65+
$decorator =newLockMiddleware(newLockFactory($store));
66+
67+
$envelope =$decorator->handle($envelope,$this->getStackMock(true));
68+
$this->assertNotNull($envelope->last(LockStamp::class));
69+
70+
$message2 =newDummyLockableMessage('Hello',newKey('id'));
71+
$envelope2 =newEnvelope($message2);
72+
73+
$decorator->handle($envelope2,$this->getStackMock(false));
74+
75+
// Simulate receiving the first message
76+
$envelope =$envelope->with(newReceivedStamp('transport'));
77+
$decorator->handle($envelope,$this->getStackMock(true));
78+
79+
$message3 =newDummyLockableMessage('Hello',newKey('id'));
80+
$envelope3 =newEnvelope($message3);
81+
$decorator->handle($envelope3,$this->getStackMock(true));
82+
}
83+
}

‎src/Symfony/Component/Messenger/composer.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
"symfony/http-kernel":"^6.4|^7.0",
2929
"symfony/process":"^6.4|^7.0",
3030
"symfony/property-access":"^6.4|^7.0",
31+
"symfony/lock":"^6.4|^7.0",
3132
"symfony/rate-limiter":"^6.4|^7.0",
3233
"symfony/routing":"^6.4|^7.0",
3334
"symfony/serializer":"^6.4|^7.0",

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp