2017 © Pedro Peláez
 

library laravel-redlock

Redis distributed locks for laravel

image

thatsus/laravel-redlock

Redis distributed locks for laravel

  • Saturday, March 31, 2018
  • by thatsus
  • Repository
  • 4 Watchers
  • 17 Stars
  • 15,692 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 11 Forks
  • 0 Open issues
  • 13 Versions
  • 56 % Grown

The README.md

Laravel RedLock

Provides a generic locking mechanism using Redis. Implements the locking standard proposed by Redis., (*1)

Acknowledgements

This library was originally built by LibiChai based on the Redlock algorithm developed by antirez. The library was reworked by the team at That's Us, Inc., (*2)

Installation

  1. composer require thatsus/laravel-redlock
  2. Add ThatsUs\RedLock\RedLockServiceProvider::class, to the providers array in config/app.php
  3. Enjoy!

It's Simple!

Set a lock on any scalar. If the lock() method returns false, you did not acquire the lock., (*3)

Store results of the lock() method. Use this value to release the lock with unlock()., (*4)

Example

This example sets a lock on the key "1" with a 3 second expiration time., (*5)

If it acquired the lock, it does some work and releases the lock., (*6)

 use ThatsUs\RedLock\Facades\RedLock;

 $product_id = 1;

 $lock_token = RedLock::lock($product_id, 3000);

 if ($lock_token) {

     $order->submit($product_id);

     RedLock::unlock($lock_token);
 }

Refresh

Use refreshLock() to reacquire and extend the time of your lock., (*7)

 use ThatsUs\RedLock\Facades\RedLock;

 $product_ids = [1, 2, 3, 5, 7];

 $lock_token = RedLock::lock('order-submitter', 3000);

 while ($product_ids && $lock_token) {

     $order->submit(array_shift($product_ids));

     $lock_token = RedLock::refreshLock($lock_token);
 }

 RedLock::unlock($lock_token);

Even Easier with Closures

Use runLocked() for nicer syntax. The method returns the results of the closure, or else false if the lock could not be acquired., (*8)

 use ThatsUs\RedLock\Facades\RedLock;

 $product_id = 1;

 $result = RedLock::runLocked($product_id, 3000, function () use ($order, $product_id) {
     $order->submit($product_id);
     return true;
 });

 echo $result ? 'Worked!' : 'Lock not acquired.';

Refresh with Closures

You can easily refresh your tokens when using closures. The first parameter to your closure is $refresh. Simply call it when you want to refresh. If the lock cannot be refreshed, $refresh() will break out of the closure., (*9)

 use ThatsUs\RedLock\Facades\RedLock;

 $product_ids = [1, 2, 3, 5, 7];

 $result = RedLock::runLocked($product_id, 3000, function ($refresh) use ($order, $product_ids) {
     foreach ($product_ids as $product_id) {
         $refresh();
         $order->submit($product_id);
     }
     return true;
 });

 echo $result ? 'Worked!' : 'Lock lost or never acquired.';

Lock Queue Jobs Easily

If you're running jobs on a Laravel queue, you may want to avoid queuing up the same job more than once at a time., (*10)

The ThatsUs\RedLock\Traits\QueueWithoutOverlap trait provides this functionality with very few changes to your job. Usually only two changes are necessary., (*11)

  1. use ThatsUs\RedLock\Traits\QueueWithoutOverlap as a trait
  2. Change the handle() method to handleSync() 
use ThatsUs\RedLock\Traits\QueueWithoutOverlap;

class OrderProductJob
{
    use QueueWithoutOverlap;

    public function __construct($order, $product_id)
    {
        $this->order = $order;
        $this->product_id = $product_id;
    }

    public function handleSync()
    {
        $this->order->submit($this->product_id);
    }

}

Sometimes it's also necessary to specify a getLockKey() method. This method must return the string that needs to be locked., (*12)

This is typically unnecessary because the lock key can be generated automatically. But if the job's data is not easy to stringify, you must define the getLockKey() method., (*13)

This trait also provides a refresh method called refreshLock(). If refreshLock() is unable to refresh the lock, an exception is thrown and the job fails., (*14)

Finally, you can change the lock time-to-live from the default 300 seconds to another value using the $lock_time property., (*15)

use ThatsUs\RedLock\Traits\QueueWithoutOverlap;

class OrderProductsJob
{
    use QueueWithoutOverlap;

    protected $lock_time = 600; // 10 minutes in seconds

    public function __construct($order, array $product_ids)
    {
        $this->order = $order;
        $this->product_ids = $product_ids;
    }

    // We need to define getLockKey() because $product_ids is an array and the
    // automatic key generator can't deal with arrays.
    protected function getLockKey()
    {
        $product_ids = implode(',', $this->product_ids);
        return "OrderProductsJob:{$this->order->id}:{$product_ids}";
    }

    public function handleSync()
    {
        foreach ($this->product_ids as $product_id) {
            $this->refreshLock();
            $this->order->submit($product_id);
        }
    }

}

Contribution

If you find a bug or want to contribute to the code or documentation, you can help by submitting an issue or a pull request., (*16)

License

MIT, (*17)

The Versions

31/03 2018

dev-master

9999999-dev

Redis distributed locks for laravel

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar LibiChai
by Avatar potsky
by Daniel Kuck-Alvarez

redlock laravel redis lock redis lock

01/02 2018

v3.0.5

3.0.5.0

Redis distributed locks for laravel

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar LibiChai
by Avatar potsky
by Daniel Kuck-Alvarez

redlock laravel redis lock redis lock

30/01 2018

v3.0.4

3.0.4.0

Redis distributed locks for laravel

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar LibiChai
by Avatar potsky
by Daniel Kuck-Alvarez

redlock laravel redis lock redis lock

26/01 2018

dev-use-orchestral

dev-use-orchestral

Redis distributed locks for laravel

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar LibiChai
by Avatar potsky
by Daniel Kuck-Alvarez

redlock laravel redis lock redis lock

03/08 2017

v3.0.3

3.0.3.0

Redis distributed locks for laravel

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar LibiChai
by Avatar potsky
by Daniel Kuck-Alvarez

redlock laravel redis lock redis lock

03/08 2017

dev-fix-lock-time-override

dev-fix-lock-time-override

Redis distributed locks for laravel

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar LibiChai
by Avatar potsky
by Daniel Kuck-Alvarez

redlock laravel redis lock redis lock

11/07 2017

3.0.2

3.0.2.0

Redis distributed locks for laravel

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar LibiChai
by Avatar potsky
by Daniel Kuck-Alvarez

redlock laravel redis lock redis lock

30/05 2017

v3.0.1

3.0.1.0

Redis distributed locks for laravel

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar LibiChai
by Daniel Kuck-Alvarez

redlock laravel redis lock redis lock

26/05 2017

dev-lv-ise

dev-lv-ise

Redis distributed locks for laravel

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar LibiChai
by Daniel Kuck-Alvarez

redlock laravel redis lock redis lock

26/05 2017

dev-lv-v1.0.0

dev-lv-v1.0.0

Redis distributed locks for laravel

  Sources   Download

MIT

The Requires

 

by Avatar LibiChai

redlock laravel redis lock redis lock

14/12 2016

1.0.1

1.0.1.0

Redis distributed locks for laravel

  Sources   Download

MIT

The Requires

 

by Avatar LibiChai

redlock laravel redis lock redis lock

14/12 2016

1.0.2

1.0.2.0

Redis distributed locks for laravel

  Sources   Download

MIT

The Requires

 

by Avatar LibiChai

redlock laravel redis lock redis lock

14/12 2016

1.0.0

1.0.0.0

Redis distributed locks for laravel

  Sources   Download

MIT

The Requires

 

by Avatar LibiChai

redlock laravel redis lock redis lock