verbb/parallel-process

run a pool of processes simultaneously

1.0.3 2024-05-26 12:20 UTC

Requires

• php: ^5.5 | ^7.0 | ^8.0
• graze/data-structure: ^2.0
• psr/log: ^1.0 | ^2.0 | ^3.0
• symfony/event-dispatcher: ^2.8 | ^3.2 | ^4.0 | ^5.0 | ^6.0 | ^7.0
• symfony/process: ^2.8 | ^3.2 | ^4.0 | ^5.0 | ^6.0 | ^7.0

Requires (Dev)

• graze/console-diff-renderer: ^0.6.1
• graze/standards: ^2
• mockery/mockery: ^1.0
• phpunit/phpunit: ^5.7.21 | ^6 | ^7
• squizlabs/php_codesniffer: ^3.3.1
• symfony/console: ^3.1 | ^4 | ^5

Suggests

• graze/console-diff-renderer: required to use Table and Lines
• symfony/console: To use the Table to print current runs

MIT

• Harry Bragg
• Graze Developers

• graze
• parallel-process

README

Run multiple Symfony\Process's at the same time.

Install

Via Composer

$ composer require graze/parallel-process

If you want to use Tables or Lines to output to the console, include:

$ composer require graze/console-diff-renderer

Usage

$pool = new Pool();
$pool->add(new Process('sleep 100'));
$pool->add(new Process('sleep 100'));
$pool->add(new Process('sleep 100'));
$pool->add(new Process('sleep 100'));
$pool->add(new ProcessRun(new Process('sleep 100')));
$pool->run(); // blocking that will run till it finishes

A Pool will run all child processes at the same time.

Priority Pool

A Priority pool will sort the runs to allow a prioritised list to be started. You can also limit the number of processes to run at a time.

$pool = new PriorityPool();
$pool->add(new Process('sleep 100'), [], 1);
$pool->add(new Process('sleep 100'), [], 0.1);
$pool->add(new Process('sleep 100'), [], 5);
$pool->add(new Process('sleep 100'), [], 10);
$pool->add(new CallbackRun(
    function () {
        return 'yarp';
    },
    [],
    2
);
$pool->run(); // blocking that will run till it finishes

Recursive Pools

You can add a Pool as a child to a parent pool. A Pool will act just like a standard run and hide the child runs.

If the parent is a PriorityPool, it will control all the child runs so that priorities and the max simultaneous configuration options still apply.

$pool = new Pool();
$pool->add(new Process('sleep 100'));
$pool2 = new Pool();
$pool2->add(new Process('sleep 100'));
$pool->add($pool2);
$pool->run(); // blocking that will run till it finishes

Display

You can output runs in a few different ways to the command line. These require the use of the package: graze/console-diff-renderer.

Table

Visual output of the parallel processes

$pool = new \Graze\ParallelProcess\PriorityPool();
for ($i = 0; $i < 5; $i++) {
    $time = $i + 5;
    $pool->add(new Process(sprintf('for i in `seq 1 %d` ; do date ; sleep 1 ; done', $time)), ['sleep' => $time]);
}
$output = new \Symfony\Component\Console\Output\ConsoleOutput();
$table = new \Graze\ParallelProcess\Display\Table($output, $pool);
$table->run();

Lines

Write the output of each process to the screen

$pool = new \Graze\ParallelProcess\PriorityPool();
$pool->setMaxSimultaneous(3);
for ($i = 0; $i < 5; $i++) {
    $time = $i + 5;
    $pool->add(new Process(sprintf('for i in `seq 1 %d` ; do date ; sleep 1 ; done', $time)), ['sleep' . $time]);
}
$output = new \Symfony\Component\Console\Output\ConsoleOutput();
$lines = new \Graze\ParallelProcess\Display\Lines($output, $pool);
$lines->run();

Testing

$ make test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Harry Bragg
• All Contributors

License

The MIT License (MIT). Please see License File for more information.