WithoutOverlapping.php

TLDR

The WithoutOverlapping class in the Illuminate\Queue\Middleware namespace provides middleware functionality for preventing overlapping of jobs in a queue. It allows you to specify a unique key for each job and set the expiration time for the lock.

Methods

handle($job, $next)

Process the job. Acquires a lock using the cache implementation and executes the job. If the lock is acquired, the job is executed, and the lock is released afterward. If the lock cannot be acquired and the releaseAfter property is set, the job is released back to the queue with a delay.

releaseAfter($releaseAfter)

Set the delay (in seconds) to release the job back to the queue. This method returns the instance of the WithoutOverlapping class for method chaining.

dontRelease()

Do not release the job back to the queue if no lock can be acquired. This method returns the instance of the WithoutOverlapping class for method chaining.

expireAfter($expiresAfter)

Set the maximum number of seconds that can elapse before the lock is released. This method can accept an instance of \DateTimeInterface, \DateInterval, or an integer representing the number of seconds. It returns the instance of the WithoutOverlapping class for method chaining.

withPrefix(string $prefix)

Set the prefix of the lock key. This method takes a string argument and returns the instance of the WithoutOverlapping class for method chaining.

shared()

Indicate that the lock key should be shared across job classes. This method returns the instance of the WithoutOverlapping class for method chaining.

getLockKey($job)

Get the lock key for the given job. This method returns a string representing the lock key based on the job class and the unique key set in the instance.

END

<?php

namespace Illuminate\Queue\Middleware;

use Illuminate\Container\Container;
use Illuminate\Contracts\Cache\Repository as Cache;
use Illuminate\Support\InteractsWithTime;

class WithoutOverlapping
{
    use InteractsWithTime;

    /**
     * The job's unique key used for preventing overlaps.
     *
     * @var string
     */
    public $key;

    /**
     * The number of seconds before a job should be available again if no lock was acquired.
     *
     * @var \DateTimeInterface|int|null
     */
    public $releaseAfter;

    /**
     * The number of seconds before the lock should expire.
     *
     * @var int
     */
    public $expiresAfter;

    /**
     * The prefix of the lock key.
     *
     * @var string
     */
    public $prefix = 'laravel-queue-overlap:';

    /**
     * Share the key across different jobs.
     *
     * @var bool
     */
    public $shareKey = false;

    /**
     * Create a new middleware instance.
     *
     * @param  string  $key
     * @param  \DateTimeInterface|int|null  $releaseAfter
     * @param  \DateTimeInterface|int  $expiresAfter
     * @return void
     */
    public function __construct($key = '', $releaseAfter = 0, $expiresAfter = 0)
    {
        $this->key = $key;
        $this->releaseAfter = $releaseAfter;
        $this->expiresAfter = $this->secondsUntil($expiresAfter);
    }

    /**
     * Process the job.
     *
     * @param  mixed  $job
     * @param  callable  $next
     * @return mixed
     */
    public function handle($job, $next)
    {
        $lock = Container::getInstance()->make(Cache::class)->lock(
            $this->getLockKey($job), $this->expiresAfter
        );

        if ($lock->get()) {
            try {
                $next($job);
            } finally {
                $lock->release();
            }
        } elseif (! is_null($this->releaseAfter)) {
            $job->release($this->releaseAfter);
        }
    }

    /**
     * Set the delay (in seconds) to release the job back to the queue.
     *
     * @param  \DateTimeInterface|int  $releaseAfter
     * @return $this
     */
    public function releaseAfter($releaseAfter)
    {
        $this->releaseAfter = $releaseAfter;

        return $this;
    }

    /**
     * Do not release the job back to the queue if no lock can be acquired.
     *
     * @return $this
     */
    public function dontRelease()
    {
        $this->releaseAfter = null;

        return $this;
    }

    /**
     * Set the maximum number of seconds that can elapse before the lock is released.
     *
     * @param  \DateTimeInterface|\DateInterval|int  $expiresAfter
     * @return $this
     */
    public function expireAfter($expiresAfter)
    {
        $this->expiresAfter = $this->secondsUntil($expiresAfter);

        return $this;
    }

    /**
     * Set the prefix of the lock key.
     *
     * @param  string  $prefix
     * @return $this
     */
    public function withPrefix(string $prefix)
    {
        $this->prefix = $prefix;

        return $this;
    }

    /**
     * Indicate that the lock key should be shared across job classes.
     *
     * @return $this
     */
    public function shared()
    {
        $this->shareKey = true;

        return $this;
    }

    /**
     * Get the lock key for the given job.
     *
     * @param  mixed  $job
     * @return string
     */
    public function getLockKey($job)
    {
        return $this->shareKey
            ? $this->prefix.$this->key
            : $this->prefix.get_class($job).':'.$this->key;
    }
}