1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
|
<?php
namespace Illuminate\Tests\Integration\Queue;
use Exception;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Cache\Repository as Cache;
use Illuminate\Contracts\Queue\ShouldBeUnique;
use Illuminate\Contracts\Queue\ShouldBeUniqueUntilProcessing;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Support\Facades\Bus;
use Orchestra\Testbench\Attributes\WithMigration;
#[WithMigration('cache')]
#[WithMigration('queue')]
class UniqueJobTest extends QueueTestCase
{
protected function defineEnvironment($app)
{
parent::defineEnvironment($app);
$app['config']->set('cache.default', 'database');
}
public function testUniqueJobsAreNotDispatched()
{
Bus::fake();
UniqueTestJob::dispatch();
$this->runQueueWorkerCommand(['--once' => true]);
Bus::assertDispatched(UniqueTestJob::class);
$this->assertFalse(
$this->app->get(Cache::class)->lock($this->getLockKey(UniqueTestJob::class), 10)->get()
);
Bus::assertDispatchedTimes(UniqueTestJob::class);
UniqueTestJob::dispatch();
$this->runQueueWorkerCommand(['--once' => true]);
Bus::assertDispatchedTimes(UniqueTestJob::class);
$this->assertFalse(
$this->app->get(Cache::class)->lock($this->getLockKey(UniqueTestJob::class), 10)->get()
);
}
public function testLockIsReleasedForSuccessfulJobs()
{
UniqueTestJob::$handled = false;
dispatch($job = new UniqueTestJob);
$this->runQueueWorkerCommand(['--once' => true]);
$this->assertTrue($job::$handled);
$this->assertTrue($this->app->get(Cache::class)->lock($this->getLockKey($job), 10)->get());
}
public function testLockIsReleasedForFailedJobs()
{
UniqueTestFailJob::$handled = false;
$this->expectException(Exception::class);
try {
dispatch_sync($job = new UniqueTestFailJob);
} finally {
$this->assertTrue($job::$handled);
$this->assertTrue($this->app->get(Cache::class)->lock($this->getLockKey($job), 10)->get());
}
}
public function testLockIsNotReleasedForJobRetries()
{
$this->markTestSkippedWhenUsingSyncQueueDriver();
UniqueTestRetryJob::$handled = false;
dispatch($job = new UniqueTestRetryJob);
$this->assertFalse($this->app->get(Cache::class)->lock($this->getLockKey($job), 10)->get());
$this->runQueueWorkerCommand(['--once' => true]);
$this->assertTrue($job::$handled);
$this->assertFalse($this->app->get(Cache::class)->lock($this->getLockKey($job), 10)->get());
UniqueTestRetryJob::$handled = false;
$this->runQueueWorkerCommand(['--once' => true]);
$this->assertTrue($job::$handled);
$this->assertTrue($this->app->get(Cache::class)->lock($this->getLockKey($job), 10)->get());
}
public function testLockIsNotReleasedForJobReleases()
{
$this->markTestSkippedWhenUsingSyncQueueDriver();
UniqueTestReleasedJob::$handled = false;
dispatch($job = new UniqueTestReleasedJob);
$this->assertFalse($this->app->get(Cache::class)->lock($this->getLockKey($job), 10)->get());
$this->runQueueWorkerCommand(['--once' => true]);
$this->assertTrue($job::$handled);
$this->assertFalse($this->app->get(Cache::class)->lock($this->getLockKey($job), 10)->get());
UniqueTestReleasedJob::$handled = false;
$this->runQueueWorkerCommand(['--once' => true]);
$this->assertFalse($job::$handled);
$this->assertTrue($this->app->get(Cache::class)->lock($this->getLockKey($job), 10)->get());
}
public function testLockCanBeReleasedBeforeProcessing()
{
$this->markTestSkippedWhenUsingSyncQueueDriver();
UniqueUntilStartTestJob::$handled = false;
dispatch($job = new UniqueUntilStartTestJob);
$this->assertFalse($this->app->get(Cache::class)->lock($this->getLockKey($job), 10)->get());
$this->runQueueWorkerCommand(['--once' => true]);
$this->assertTrue($job::$handled);
$this->assertTrue($this->app->get(Cache::class)->lock($this->getLockKey($job), 10)->get());
}
protected function getLockKey($job)
{
return 'laravel_unique_job:'.(is_string($job) ? $job : get_class($job));
}
}
class UniqueTestJob implements ShouldQueue, ShouldBeUnique
{
use InteractsWithQueue, Queueable, Dispatchable;
public static $handled = false;
public function handle()
{
static::$handled = true;
}
}
class UniqueTestFailJob implements ShouldQueue, ShouldBeUnique
{
use InteractsWithQueue, Queueable, Dispatchable;
public $tries = 1;
public static $handled = false;
public function handle()
{
static::$handled = true;
throw new Exception;
}
}
class UniqueTestReleasedJob extends UniqueTestFailJob
{
public $tries = 1;
public function handle()
{
static::$handled = true;
$this->release();
}
}
class UniqueTestRetryJob extends UniqueTestFailJob
{
public $tries = 2;
}
class UniqueUntilStartTestJob extends UniqueTestJob implements ShouldBeUniqueUntilProcessing
{
public $tries = 2;
}
|