jdavidbakr/multi-server-event

This package is abandoned and no longer maintained. The author suggests using the laravel/laravel:5.6 package instead.

This package extends Laravel's native Command Event class to allow for managing events fired on the same system with multiple servers, preventing an event from firing more than once

2.0.5 2018-02-10 15:50 UTC

Requires

• php: >=5.5.9
• laravel/framework: >=5.4.26 <5.6

Requires (Dev)

• orchestra/testbench: ^3.4
• phpunit/phpunit: ~4.0||~5.0

MIT

• Jon Baker

• laravel
• scheduler
• load balancing
• Multi-Server

README

This package extends Laravel's native Event class to include the ability to block events from occurring aross multiple servers, as would be the case if you have a laravel instance behind a load balancer in an auto-scaling situation.

It uses a database table to track the currently running process, and each server generates a unique key to lock the command. In order to prevent a condition where a short-running command's lock doesn't last long enough, we are implementing a minimum 10 second break between the completion of the command and its next execution time, so if a command runs every minute but takes between 50 and 59 seconds to complete, the next command will be delayed one more minute.

NOTE: Laravel 5.6 now contains a function onOneServer() that solves the issue that this package was built to fix. Therefore, it is recommended that you use the core function instead of this package.

For Laravel < 5.4, please use version 1.X

Upgrading from version 1.X

If upgrading from version 1.X, please note the change in the defineConsoleSchedule() command in app\Console\Kernel.php.

Installation

$ composer require jdavidbakr/multi-server-event

The new event structure uses a database table to track which server is currently executing an event. You must create the database table using the provided migration. To do this, add the following to the $commands array in \App\Console\Kernel.php:

\jdavidbakr\MultiServerEvent\Commands\MultiServerMigrationService::class,

then perform the migration

php artisan make:migration:multi-server-event
php artisan migrate

Now we want to change the default schedule IoC to use this alternate one. In app\Console\Kernel.php add the following function:

/**
 * Define the application's command schedule.
 *
 * @return void
 */
protected function defineConsoleSchedule()
{
    $this->app->instance(
        Schedule::class,
        $schedule = new \jdavidbakr\MultiServerEvent\Scheduling\Schedule()
    );

    $this->schedule($schedule);
}

Usage

When composing your schedule, simply add "withoutOverlappingMultiServer()" to the command, i.e.

$schedule->command('inspire')
    ->daily()
    ->withoutOverlappingMultiServer();

This will prevent multiple servers from executing the same event at the same time.

When composing your schedule, you can also ensure that cron is not stuck, simply add "ensureFinishedMultiServer()" to the command, i.e.

$schedule->command('inspire')
    ->daily()
    ->withoutOverlappingMultiServer()
    ->ensureFinishedMultiServer(30);

This will prevent from stuck commands during lost connection or deployment. Note, choose time to be enough to mark as "stuck", fox example, long running command should have bigger tolerance time. You can track such events how ofter it happens by binding listeners on EnsureCleanUpExecuted event

Testing

phpunit