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 locking on broadcast events #43516

Merged
merged 7 commits into from Aug 3, 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
34 changes: 28 additions & 6 deletions src/Illuminate/Broadcasting/BroadcastManager.php
Expand Up @@ -10,10 +10,12 @@
use Illuminate\Broadcasting\Broadcasters\NullBroadcaster;
use Illuminate\Broadcasting\Broadcasters\PusherBroadcaster;
use Illuminate\Broadcasting\Broadcasters\RedisBroadcaster;
use Illuminate\Bus\UniqueLock;
use Illuminate\Contracts\Broadcasting\Factory as FactoryContract;
use Illuminate\Contracts\Broadcasting\ShouldBeUnique;
use Illuminate\Contracts\Broadcasting\ShouldBroadcastNow;
use Illuminate\Contracts\Bus\Dispatcher as BusDispatcherContract;
use Illuminate\Contracts\Cache\Repository as Cache;
use Illuminate\Contracts\Foundation\CachesRoutes;
use InvalidArgumentException;
use Psr\Log\LoggerInterface;
Expand Down Expand Up @@ -166,12 +168,32 @@ public function queue($event)
$queue = $event->queue;
}

$this->app->make('queue')->connection($event->connection ?? null)->pushOn(
$queue,
$event instanceof ShouldBeUnique
? new UniqueBroadcastEvent(clone $event)
: new BroadcastEvent(clone $event)
);
if ($this->mustBeUniqueAndCannotAcquireLock($event)) {
return;
}

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

/**
* Determine if the broadcastable event must be unique and determine if we can acquire the necessary lock.
*
* @param mixed $event
* @return bool
*/
protected function mustBeUniqueAndCannotAcquireLock($event)
{
if (! $event instanceof ShouldBeUnique) {
return false;
}

return ! (new UniqueLock(
method_exists($event, 'uniqueVia')
? $event->uniqueVia()
: $this->app->make(Cache::class)
))->acquire($event);
}

/**
Expand Down
60 changes: 0 additions & 60 deletions src/Illuminate/Broadcasting/UniqueBroadcastEvent.php

This file was deleted.

9 changes: 4 additions & 5 deletions tests/Integration/Broadcasting/BroadcastManagerTest.php
Expand Up @@ -3,7 +3,6 @@
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 @@ -44,11 +43,11 @@ public function testUniqueEventsCanBeBroadcast()

Broadcast::queue(new TestEventUnique);

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

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

Expand Down