https://github.com/ibrahimgunduz34/shepherdprocesspoolbundle

Another simple process pool for Symfony
https://github.com/ibrahimgunduz34/shepherdprocesspoolbundle

async library php process-manager symfony symfony-bundle

Last synced: about 1 month ago
JSON representation

Another simple process pool for Symfony

• Host: GitHub
• URL: https://github.com/ibrahimgunduz34/shepherdprocesspoolbundle
• Owner: ibrahimgunduz34
• Created: 2019-02-19T21:10:35.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-03-02T18:21:34.000Z (over 5 years ago)
• Last Synced: 2024-04-20T16:56:52.559Z (7 months ago)
• Topics: async, library, php, process-manager, symfony, symfony-bundle
• Language: PHP
• Size: 23.4 KB
• Stars: 4
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Shepherd Process Pool

[![Build Status](https://travis-ci.org/ibrahimgunduz34/ShepherdProcessPoolBundle.svg?branch=master)](https://travis-ci.org/ibrahimgunduz34/ShepherdProcessPoolBundle)

Shepherd is an easy way to run the processes in parallel. 

Also, you can control how many processes you can run in 

parallel or decide to stop all jobs in the queue if anyone 

is failed.   

## How To Install

Call the following command to add the package to your project as a composer dependency.

```$xslt

composer require ibrahimgunduz34/shepherd

```

## How To Configure 

You can simply define your process pools in `pools` section separately. 

Also, you can define some default options in `defaults` section and 

override them in each pool definition if it's needed.

  

```yaml

shepherd:

    defaults:

        max_processes: 4

        fail_on_error: true

    pools:

        foo:

            max_processes: 2

            fail_on_error: false

        bar:

            max_processes: 8

```

## How To Use 

Basically, Shepherd creates services for each pool definition. So 

you can simply inject the pools anywhere. It creates services 

with`shepherd.pool.` naming convention.

```yaml

App\Service\MyService:

    class: App\Service\MyService

    arguments:

        - '@shepherd.pool.foo'

```

You can keep adding new processes until starting the pool processing.

```php

pool = $pool; 

    }

    

    public function performSomething() {

        //...

        $this->pool->append(new Process([__DIR__ . '../bin/console', 'do:something', 'param1', 'param2']));

        $this->pool->append(new Process([__DIR__ . '../bin/console', 'do:something', 'param3', 'param4']));

        $this->pool->append(new Process([__DIR__ . '../bin/console', 'do:something', 'param5', 'param6']));

        //...

        //...

        //...

        $this->pool->start();

    }

}

```

## How To Stop The Flow If Anyone Of The Jobs Failed

To fail entire flow if anyone of the jobs failed, you must define `fail_on_error` as true 

when you defined the pool.

```yaml

shepherd:

    pools:

      foo:

        max_processes: 2

        fail_on_error: true        

```

Then you must handle the error which is thrown by `start()` method.

```php

pool->start();    

        } catch (Shepherd\Bundle\ProcessPoolBundle\Exception\ProcessExecutionError $exception) {

            //TODO: Do something...

        }

        //...

    }   

 //...

```

You can find an example use case in the [**this blog post**](https://medium.com/@ibrahimgunduz34/how-to-speed-up-multiple-file-transfer-process-by-parallelizing-the-downloads-in-symfony-1beb160771f0):