Skip to content
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.

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

[9.x] Fix unique lock release for broadcast events #43738

Merged
merged 6 commits into from Aug 18, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 10 additions & 8 deletions src/Illuminate/Broadcasting/BroadcastManager.php
Expand Up @@ -168,13 +168,19 @@ public function queue($event)
$queue = $event->queue;
}

if ($this->mustBeUniqueAndCannotAcquireLock($event)) {
return;
$broadcastEvent = new BroadcastEvent(clone $event);

if ($event instanceof ShouldBeUnique) {
$broadcastEvent = new UniqueBroadcastEvent(clone $event);

if ($this->mustBeUniqueAndCannotAcquireLock($broadcastEvent)) {
return;
}
}

$this->app->make('queue')
->connection($event->connection ?? null)
->pushOn($queue, new BroadcastEvent(clone $event));
->connection($event->connection ?? null)
->pushOn($queue, $broadcastEvent);
}

/**
Expand All @@ -185,10 +191,6 @@ public function queue($event)
*/
protected function mustBeUniqueAndCannotAcquireLock($event)
{
if (! $event instanceof ShouldBeUnique) {
return false;
}

return ! (new UniqueLock(
method_exists($event, 'uniqueVia')
? $event->uniqueVia()
Expand Down
61 changes: 61 additions & 0 deletions src/Illuminate/Broadcasting/UniqueBroadcastEvent.php
@@ -0,0 +1,61 @@
<?php

namespace Illuminate\Broadcasting;

use Illuminate\Container\Container;
use Illuminate\Contracts\Cache\Repository;
use Illuminate\Contracts\Queue\ShouldBeUnique;

class UniqueBroadcastEvent extends BroadcastEvent implements ShouldBeUnique
{
/**
* The unique lock identifier.
*
* @var mixed
*/
public $uniqueId;

/**
* The number of seconds the unique lock should be maintained.
*
* @var int
*/
public $uniqueFor;

/**
* Create a new event instance.
*
* @param mixed $event
* @return void
*/
public function __construct($event)
{
$this->uniqueId = get_class($event);

if (method_exists($event, 'uniqueId')) {
$this->uniqueId .= $event->uniqueId();
} elseif (property_exists($event, 'uniqueId')) {
$this->uniqueId .= $event->uniqueId;
}

if (method_exists($event, 'uniqueFor')) {
$this->uniqueFor = $event->uniqueFor();
} elseif (property_exists($event, 'uniqueFor')) {
$this->uniqueFor = $event->uniqueFor;
}

parent::__construct($event);
}

/**
* Resolve the cache implementation that should manage the event's uniqueness.
*
* @return \Illuminate\Contracts\Cache\Repository
*/
public function uniqueVia()
{
return method_exists($this->event, 'uniqueVia')
? $this->event->uniqueVia()
: Container::getInstance()->make(Repository::class);
}
}
1 change: 1 addition & 0 deletions src/Illuminate/Broadcasting/composer.json
Expand Up @@ -19,6 +19,7 @@
"psr/log": "^1.0|^2.0|^3.0",
"illuminate/bus": "^9.0",
"illuminate/collections": "^9.0",
"illuminate/container": "^9.0",
"illuminate/contracts": "^9.0",
"illuminate/queue": "^9.0",
"illuminate/support": "^9.0"
Expand Down
7 changes: 4 additions & 3 deletions tests/Integration/Broadcasting/BroadcastManagerTest.php
Expand Up @@ -3,6 +3,7 @@
namespace Illuminate\Tests\Integration\Broadcasting;

use Illuminate\Broadcasting\BroadcastEvent;
use Illuminate\Broadcasting\UniqueBroadcastEvent;
use Illuminate\Contracts\Broadcasting\ShouldBeUnique;
use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
use Illuminate\Contracts\Broadcasting\ShouldBroadcastNow;
Expand Down Expand Up @@ -43,10 +44,10 @@ public function testUniqueEventsCanBeBroadcast()

Broadcast::queue(new TestEventUnique);

Bus::assertNotDispatched(BroadcastEvent::class);
Queue::assertPushed(BroadcastEvent::class);
Bus::assertNotDispatched(UniqueBroadcastEvent::class);
Queue::assertPushed(UniqueBroadcastEvent::class);

$lockKey = 'laravel_unique_job:'.TestEventUnique::class;
$lockKey = 'laravel_unique_job:'.UniqueBroadcastEvent::class.TestEventUnique::class;
$this->assertFalse($this->app->get(Cache::class)->lock($lockKey, 10)->get());
}
}
Expand Down