[symfony] Async commands

[makasim]

Async commands

The enqueue/async-command package adds ability to run Symfony command async with ability to get output.

Installation

$ composer require enqueue/async-command:^0.9.x-dev

Configuration

# config/packages/enqueue_async_commands.yaml

enqueue:
   async_commands: true

Usage

<?php

use Enqueue\Client\ProducerInterface;
use Enqueue\AsyncCommand\Commands;
use Enqueue\AsyncCommand\RunCommand;
use Symfony\Component\DependencyInjection\ContainerInterface;

/** @var $container ContainerInterface */

/** @var ProducerInterface $producer */
$producer = $container->get(ProducerInterface::class);

$producer->sendCommand(Commands::RUN_COMMAND, new RunCommand('debug:container'));

optionally you can get a command execution result:

<?php

use Enqueue\Client\ProducerInterface;
use Enqueue\AsyncCommand\RunCommandResult;
use Enqueue\AsyncCommand\Commands;
use Enqueue\AsyncCommand\RunCommand;
use Symfony\Component\DependencyInjection\ContainerInterface;

/** @var $container ContainerInterface */

/** @var ProducerInterface $producer */
$producer = $container->get(ProducerInterface::class);

$promise = $producer->sendCommand(Commands::RUN_COMMAND, new RunCommand('debug:container'), true);

// do other stuff.

if ($replyMessage = $promise->receive(5000)) { 
    $result = RunCommandResult::jsonUnserialize($replyMessage->getBody());
    
    echo $result->getOutput();
}

back to index

[wesleylancel]

@makasim Hi, any word on this being merged? We would love to use this :)

[makasim]

@wesleylancel It needs some testing, not sure I can find time to finish this in near future.

[temp]

Has enqueue/async-command been removed? The link in the first post produces a 404...
Would love to test this!

[stephanvierkant]

Same here! See schmittjoh/JMSJobQueueBundle#208 btw, where some users are not satisfied with JMSJobQueueBundle right now, and maybe switch to enqueue-dev when a async function is available.

[makasim]

I've created a repo enqueue/async-command and published it to packagist https://packagist.org/packages/enqueue/async-command

you can require it in your composer json like this

{
  "require": {
    "enqueue/async-command": "dev-pr-250"
  }
}

That way you can test it.

[temp]

Thanks! Is there something like an example for a minimal setup/configuration for this? I'm new to enqueue, and just want to check wether or not to replace JmsJobQueue by this.

[makasim]

@temp the doc is in the PR https://github.com/php-enqueue/enqueue-dev/blob/ff43a41cee09ad81a86f14f488225de4031f55d9/docs/bundle/async_commands.md

[makasim]

and in PR's description.

[temp]

@makasim Hmm there is no *Bundle class, am I missing something?

[temp]

Won't the class constant lookup fail when the class is not available?

[makasim]

it wont

[temp]

Ok, got it. Had to manually edit the Configuration and the EnqueueExtension. Runs fine now, will report.

[rolandbrecht]

Maybe a small improvement we did:
We extended Enqueue\Client\Message, to have access to all message functions

<?php

namespace App\Async;

use Enqueue\Client\Message;

/**
 * Class RunCommand.
 */
final class RunCommand extends Message
{

    public function __construct(string $commandName, array $commandArguments = [], array $commandOptions = [], array $messageProperties = [], array $messageHeaders = [])
    {
        $argumentString = $this->createString($commandArguments);
        $optionsString = $this->createString($commandOptions);
        
        $message = sprintf('%s %s %s', $commandName, $argumentString, $optionsString);

        parent::__construct($message, $messageProperties, $messageHeaders);
    }

    private function createString(array $values): string
    {
        return implode(' ', $values);
    }
}

$command = new RunCommand('app:import-products', [$categoryId], ['--force']);
$command->setPriority(MessagePriority::HIGH);
$command->setDelay(60);
$this->producer->sendCommand(Commands::CONSOLE_COMMAND, $command);

[hslavich]

Any plan to merge this?

[makasim]

@hslavich today (: