php-strict/cooperative-worker

Class for executing jobs from one list in several processes

dev-master 2024-06-03 12:11 UTC

Requires

• php: >=7.1

Requires (Dev)

• codeception/codeception: ^4.1.4
• codeception/module-asserts: ^1.0.0
• codeception/module-phpbrowser: ^1.0.0

GPL-2.0-or-later

• Enikeishik

• php
• worker
• cooperative
• cooperative worker

README

Class for executing jobs from one list in several processes. Class not have mechanism to create processes, consumer must create it by self. Each separate process can create instance of class wich will work with shared storage without collisions. Temporary storage of jobs (queue) will be created in first instance of class and it be use all of instances.

Requirements

• PHP >= 7.1

Install

Use class as standalone:

require 'CooperativeWorker.php';
use PhpStrict\CooperativeWorker\CooperativeWorker;

Install with Composer:

composer require php-strict/cooperative-worker

Usage

Before (all jobs running through one process):

//$jobs - list of commands, files to processing, ...
$jobs = ['job 1', 'job 2', 'job 3', 'job 4', 'job 5'];

foreach ($jobs as $job) {
    echo 'Start job: ' . $job . PHP_EOL;
    //do some job
}

With cooperative worker:

cw.php

use PhpStrict\CooperativeWorker\CooperativeWorker;

$cw = new CooperativeWorker(
    function() {
        return ['job 1', 'job 2', 'job 3', 'job 4', 'job 5'];
    }, 
    function(string $job) {
        echo 'Start job: ' . $job . PHP_EOL;
        //do some job
    }
);
$cw->run();

cw.bat (on Windows using start command to create a two separate processes)

start php -f cw.php
start php -f cw.php

cw.sh (on Linux using & at the end of command to create a two separate processes)

php -f cw.php &
php -f cw.php &

using ScriptRunner

use PhpStrict\ScriptRunner\ScriptRunner;

//path_to_script, processes count (if omitted then system CPU cores count will be used) 
$sr = new ScriptRunner('cw.php', 4);
$sr->run();

Processing images (log files, data files, etc.)

cw.php

use PhpStrict\CooperativeWorker\CooperativeWorker;

$cw = new CooperativeWorker(
    //returns array of images (with path to it) from dir
    function() {
        $images = glob('/path_to_images/*.jpg');
        array_walk(
            $images, 
            function(&$val, $key, $path) {
                $val = $path . '/' . $val;
            }, 
            '/path_to_images'
        );
        return $images;
    }, 
    function(string $image) {
        echo 'Processing image: ' . $image . PHP_EOL;
        //do some image operation (resizing, cropping, etc.)
    }
);
$cw->run();

Tests

To execute the test suite, you'll need Codeception.

vendor/bin/codecept run