olafnorge/console-mutex

Prevents overlapping for Laravel console commands.

Wednesday, April 19, 2017
by olafnorge
Repository
1 Watchers
0 Stars
341 Installations

PHP
0 Dependents
0 Suggesters
7 Forks
0 Open issues
38 Versions
0 % Grown

The README.md

Laravel Console Mutex

, _(*1)

Prevents overlapping for Laravel console commands., _(*2)

Requirements
Usage
Strategies
Advanced
- Set custom timeout
- Handle several commands
Troubleshooting
- Trait included, but nothing happens?
- Several traits conflict?

Requirements

PHP >=5.5.9
Laravel >=5.1

Usage

Install package through composer:, _(*3)

composer require olafnorge/console-mutex

Use olafnorge\Console\WithoutOverlapping trait:, _(*4)

use olafnorge\Console\WithoutOverlapping;

class ExampleCommand extends Command
{
    use WithoutOverlapping;

    // ...
}

Strategies

Overlapping can be prevented by various strategies:, _(*5)

file (default)
mysql
redis
memcached

Default file strategy is fine for a small applications, which are deployed on a single server. If your application is more complex and, for example, is deployed on a several nodes, then you probably would like to use some other mutex strategy., _(*6)

You can change mutex strategy by specifying $mutexStrategy field:, _(*7)

class ExampleCommand extends Command
{
    use WithoutOverlapping;

    protected $mutexStrategy = 'mysql';

    // ...
}

Or by using setMutexStrategy method:, _(*8)

class ExampleCommand extends Command
{
    use WithoutOverlapping;

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

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

    // ...
}

Advanced

Set custom timeout

By default mutex is checking for a running command, and if it finds such, it just exits. However, you can manually set timeout for a mutex, so it can wait for another command to finish it's execution, instead of just quitting immediately., _(*9)

You can change mutex timeout by specifying $mutexTimeout field:, _(*10)

class ExampleCommand extends Command
{
    use WithoutOverlapping;

    protected $mutexTimeout = 3000; // milliseconds

    // ...
}

Or by using setMutexTimeout method:, _(*11)

class ExampleCommand extends Command
{
    use WithoutOverlapping;

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

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

    // ...
}

There are three possible options for $mutexTimeout field:, _(*12)

0 - check without waiting (default);
{milliseconds} - check, and wait for a maximum of milliseconds specified;
null - wait, till running command finish it's execution;

Handle several commands

Sometimes it is useful to set common mutex for a several commands. You can easily achieve this by setting them the same mutex name. By default, mutex name is generated based on a command's name and arguments. To change this, just override getMutexName method in your command:, _(*13)

class ExampleCommand extends Command
{
    use WithoutOverlapping;

    public function getMutexName()
    {
        return "icmutex-for-command1-and-command2";
    }

    // ...
}

Troubleshooting

Trait included, but nothing happens?

Note, that WithoutOverlapping trait is overriding initialize method:, _(*14)

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

    // ...
}

If your command is overriding initialize method too, then you should call initializeMutex method by yourself:, _(*15)

class ExampleCommand extends Command
{
    use WithoutOverlapping;

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

        $this->foo = $this->argument('foo');
        $this->bar = $this->argument('bar');
        $this->baz = $this->argument('baz');
    }

    // ...
}

Several traits conflict?

If you're using some other cool olafnorge/console-% packages, well, then you can find yourself getting "traits conflict". For example, if you're trying to build loggable command, which is protected against overlapping:, _(*16)

class ExampleCommand extends Command
{
    use Loggable;
    use WithoutOverlapping;

    // ...
}

You'll get fatal error, the "traits conflict", because both of these traits are overriding initialize method:, _(*17)

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

But don't worry, solution is very simple. Override initialize method by yourself, and initialize traits in required order:, _(*19)

class ExampleCommand extends Command
{
    use Loggable;
    use WithoutOverlapping;

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

    // ...
}

The Versions

19/04 2017

dev-master

9999999-dev

Prevents overlapping for Laravel console commands.

library console-mutex

Prevents overlapping for Laravel console commands.

olafnorge/console-mutex

The README.md

Laravel Console Mutex

Table of contents

Requirements

Usage

Strategies

Advanced

Set custom timeout

Handle several commands

Troubleshooting

Trait included, but nothing happens?

Several traits conflict?

The Versions

dev-master

The Requires

The Development Requires

by Dmitry Ivanov

by Volker Machon

1.4.5

The Requires

The Development Requires

by Dmitry Ivanov

by Volker Machon

1.4.4

The Requires

The Development Requires

by Dmitry Ivanov

1.4.3

The Requires

The Development Requires

by Dmitry Ivanov

1.4.2

The Requires

The Development Requires

by Dmitry Ivanov

1.4.1

The Requires

The Development Requires

by Dmitry Ivanov

1.4.0

The Requires

The Development Requires

by Dmitry Ivanov

1.3.2

The Requires

The Development Requires

by Dmitry Ivanov

1.3.1

The Requires

The Development Requires

by Dmitry Ivanov

1.3.0

The Requires

The Development Requires

by Dmitry Ivanov

1.2.1

The Requires

The Development Requires

by Dmitry Ivanov

1.2.0

The Requires

The Development Requires

by Dmitry Ivanov

1.1.13

The Requires

The Development Requires

by Dmitry Ivanov

1.1.12

The Requires

The Development Requires

by Dmitry Ivanov

1.1.11

The Requires

The Development Requires

by Dmitry Ivanov

1.1.10

The Requires