illuminated/console-mutex

Mutex for Laravel console commands.

Monday, July 23, 2018
by dmitry-ivanov
Repository
5 Watchers
45 Stars
24,651 Installations

PHP
2 Dependents
0 Suggesters
7 Forks
0 Open issues
68 Versions
24 % Grown

The README.md

Mutex for Laravel Console Commands , _(*1)

Laravel Console Mutex

, _(*2)

, _(*3)

Packagist Version Packagist Stars Packagist Downloads Packagist License , _(*4)

Mutex for Laravel Console Commands., _(*5)

Laravel	Console Mutex
11.x	Support ☕
10.x	10.x
9.x	9.x
8.x	8.x
7.x	7.x
6.x	6.x
5.8.*	5.8.*
5.7.*	5.7.*
5.6.*	5.6.*
5.5.*	5.5.*
5.4.*	5.4.*
5.3.*	5.3.*
5.2.*	5.2.*
5.1.*	5.1.*

Laravel Console Mutex - Demo , _(*6)

Usage
Strategies
Advanced
Troubleshooting
- Trait included, but nothing happens?
- Several traits conflict?
Sponsors
License

Usage

Install the package via Composer:, _(*7)

shell script composer require illuminated/console-mutex, _(*8)

Use Illuminated\Console\WithoutOverlapping trait:, _(*9)

use Illuminated\Console\WithoutOverlapping;

class ExampleCommand extends Command
{
    use WithoutOverlapping;

    // ...
}

Strategies

Mutex can prevent overlapping by using various strategies:, _(*10)

file (default)
mysql
redis
memcached

The default file strategy is acceptable for small applications, which are deployed on a single server. If your application is more complex and deployed on several nodes, you should consider using another mutex strategy., _(*11)

You can change strategy by using the $mutexStrategy field:, _(*12)

class ExampleCommand extends Command
{
    use WithoutOverlapping;

    protected string $mutexStrategy = 'mysql';

    // ...
}

Or by using the setMutexStrategy() method:, _(*13)

class ExampleCommand extends Command
{
    use WithoutOverlapping;

    public function __construct()
    {
        parent::__construct();

        $this->setMutexStrategy('mysql');
    }

    // ...
}

Advanced

Set custom timeout

By default, if mutex sees that the command is already running, it will immediately quit. You can change that behavior by setting a timeout in which mutex can wait for another running command to finish its execution., _(*14)

You can set the timeout by specifying the $mutexTimeout field:, _(*15)

class ExampleCommand extends Command
{
    use WithoutOverlapping;

    // In milliseconds
    protected ?int $mutexTimeout = 3000;

    // ...
}

Or by using the setMutexTimeout() method:, _(*16)

class ExampleCommand extends Command
{
    use WithoutOverlapping;

    public function __construct()
    {
        parent::__construct();

        // In milliseconds
        $this->setMutexTimeout(3000);
    }

    // ...
}

Here's how the $mutexTimeout field is treated:, _(*17)

0 - no waiting (default);
{int} - wait for the given number of milliseconds;
null - wait for the running command to finish its execution;

Handle multiple commands

Sometimes it might be useful to have a shared mutex for multiple commands. You can easily achieve that by setting the same mutex name for all of those commands., _(*18)

You should use the getMutexName() method for that:, _(*19)

class ExampleCommand extends Command
{
    use WithoutOverlapping;

    public function getMutexName()
    {
        return 'shared-for-command1-and-command2';
    }

    // ...
}

Set custom storage folder

If you're using the file strategy, mutex files would be stored in the storage/app folder., _(*20)

You can change that by overriding the getMutexFileStorage() method:, _(*21)

class ExampleCommand extends Command
{
    use WithoutOverlapping;

    public function getMutexFileStorage()
    {
        return storage_path('my/custom/path');
    }

    // ...
}

Troubleshooting

Trait included, but nothing happens?

WithoutOverlapping trait overrides the initialize() method:, _(*22)

trait WithoutOverlapping
{
    protected function initialize(InputInterface $input, OutputInterface $output)
    {
        $this->initializeMutex();

        parent::initialize($input, $output);
    }

    // ...
}

If your command overrides the initialize() method too, you have to call the initializeMutex() method by yourself:, _(*23)

class ExampleCommand extends Command
{
    use WithoutOverlapping;

    protected function initialize(InputInterface $input, OutputInterface $output)
    {
        // You have to call it first
        $this->initializeMutex();

        // Then goes your custom code
        $this->foo = $this->argument('foo');
        $this->bar = $this->argument('bar');
        $this->baz = $this->argument('baz');
    }

    // ...
}

Several traits conflict?

If you're using another illuminated/console-% package, you'll get the "traits conflict" error., _(*24)

For example, if you're building a loggable command, which doesn't allow overlapping:, _(*25)

class ExampleCommand extends Command
{
    use Loggable;
    use WithoutOverlapping;

    // ...
}

You'll get the traits conflict, because both of those traits are overriding the initialize() method:, _(*26)

If two traits insert a method with the same name, a fatal error is produced, if the conflict is not explicitly resolved., _(*27)

To fix that - override the initialize() method and resolve the conflict:, _(*28)

class ExampleCommand extends Command
{
    use Loggable;
    use WithoutOverlapping;

    protected function initialize(InputInterface $input, OutputInterface $output)
    {
        // Initialize conflicting traits
        $this->initializeMutex();
        $this->initializeLogging();
    }

    // ...
}

License

Laravel Console Mutex is open-sourced software licensed under the MIT license., _(*30)

, _(*31)

The Versions

23/07 2018

5.6.x-dev

5.6.9999999.9999999-dev

Mutex for Laravel console commands.

library console-mutex

Mutex for Laravel console commands.

illuminated/console-mutex

The README.md

Laravel Console Mutex

Table of contents

Usage

Strategies

Advanced

Set custom timeout

Handle multiple commands

Set custom storage folder

Troubleshooting

Trait included, but nothing happens?

Several traits conflict?

Sponsors

License

The Versions

5.6.x-dev

The Requires

The Development Requires

by Dmitry Ivanov

5.6.3

The Requires

The Development Requires

by Dmitry Ivanov

dev-master

The Requires

The Development Requires

by Dmitry Ivanov

5.5.x-dev

The Requires

The Development Requires

by Dmitry Ivanov

5.4.x-dev

The Requires

The Development Requires

by Dmitry Ivanov

5.3.x-dev

The Requires

The Development Requires

by Dmitry Ivanov

5.2.x-dev

The Requires

The Development Requires

by Dmitry Ivanov

5.1.x-dev

The Requires

The Development Requires

by Dmitry Ivanov

5.6.2

The Requires

The Development Requires

by Dmitry Ivanov

5.6.1

The Requires

The Development Requires

by Dmitry Ivanov

5.6.0

The Requires

The Development Requires

by Dmitry Ivanov

5.5.5

The Requires

The Development Requires

by Dmitry Ivanov

5.5.4

The Requires

The Development Requires

by Dmitry Ivanov

5.4.2

The Requires

The Development Requires

by Dmitry Ivanov

5.3.2

The Requires

The Development Requires

by Dmitry Ivanov

5.2.2

The Requires