Running a background task using Symfony Process without having to wait for the process to finish

Question

After a user submits a form, I want to render a view file, and right after that I want to initiate a background task to process five MS Excel files (each may have up to 2000 rows) , but in way so that the user don't have to wait for the process to finish in order to view the page. After the task is finished I will inform the user through an email.

I am using Symfony Framework 3. I have included my code below. Its not doing what I am trying to achieve. After submitting the form the page loads only when the entire background task is complete.

I am not sure but after googling a lot, I think The kernel.terminate Event could be useful here. But I can't seem to understand how to work with it.

Could you please tell me how to solve this problem ?

Here's my code:

I have created a Console Command:

class GreetCommand extends ContainerAwareCommand {

  protected function configure()
  {
    $this->setName('hello:world');
  }

  protected function execute(InputInterface $input, OutputInterface $output)
  {
   // My code to execute
  }

}

And in my controller I have

$process = new Process('ls -lsa');
$process->disableOutput();
$that = $this;

$process->start(function ($type, $buffer) use ($that) {
        $command = new GreetCommand();
        $command->setContainer($this->container);
        $input = new ArrayInput(array());
        $output = new NullOutput;
        $resultCode = $command->run($input, $output);

 });

 return $this->render('success.html.php',  array('msg' => 'Registraion Successful'));

Update

I have solved the problem using the connection-handling feature of PHP.

Thanks to this post

Answer 1

Running Processes Asynchronously

You can also start the subprocess and then let it run asynchronously, retrieving output and the status in your main process whenever you need it. Use the start() method to start an asynchronous process

documentation

so, to start your command asynchronously you should create new process with command and start it

$process = new Process('php bin/console hello:word');
$process->start();

Consider to change this to full paths like \usr\bin\php \var\www\html\bin\console hello:word

Also there is good bundle cocur/background-process you may use it, or at least read the docs to find out how it works.

Answer 2

I am a bit late to the game, but I just found a solution for this problem using the fromShellCommandLine() method:

use Symfony\Component\Process\Process;

Process::fromShellCommandline('/usr/bin/php /var/www/bin/console hello:world')->start();

This way it is possible to start a new process/run a command asynchronously.

Answer 3

For using in controller:

use Symfony\Component\HttpKernel\KernelEvents;
use Symfony\Component\HttpKernel\Event\PostResponseEvent;

$myVar = new MyObject();
$this->get('event_dispatcher')->addListener(KernelEvents::TERMINATE, function(PostResponseEvent $event) use($myVar) {
    //You logic here
    $request = $event->getRequest();
    $test = $myVar->getMyStuff();
});

But it is not a good practice, please read about normal registering event listeners

kernel.terminate event will be dispatched after sending the response to user.

Answer 4

There is a bundle called AsyncServiceCallBundle which allows you to call your service's methods in background.

You can refer this answer for more details about how it is done internally. Everything you need is to invoke your service's method as follows:

$this->get('krlove.async')->call('service_id', 'method', [$arg1, $arg2]);

Answer 5

Simple use Symfony Process Options

create_new_console

From Symfony Process Source:

 /**
  * Defines options to pass to the underlying proc_open().
  *
  * @see https://php.net/proc_open for the options supported by PHP.
  *
  * Enabling the "create_new_console" option allows a subprocess to continue
  * to run after the main process exited, on both Windows and *nix
  */
  public function setOptions(array $options)

So lets do it this way:

$process = new Process($cmds);
$process->setOptions(['create_new_console' => true]);
$process->start();

Answer 6

I guess what you want is to store the necessary data in a database and then have a cronjob/queue execute the actual command, instead of trying to execute it directly from your controller.

Add something like the following to your /etc/crontab to let it run your command every 5 minutes

*/5 * * * * root /usr/bin/php /path/to/bin/console hello:world

Then, let your command query the database for the stored data and have it process the excel files

Answer 7

Even though it's already answered,
I post here my working solution if any one is need of.
In my Controller

public function exportDossiersAction(Request $request)
{    
    $form = $this->createForm(ExportType::class, null, []);
    $form->handleRequest($request);

    if ($form->isSubmitted() && $form->isValid()) {
        $filters = ["status" => $form->get('status')->getData()];

        $phpBinaryFinder = new PhpExecutableFinder();
        $phpBinaryPath = $phpBinaryFinder->find();
        $projectRoot = $this->get('kernel')->getProjectDir();

        $process = new Process([$phpBinaryPath, $projectRoot . '/bin/console', 'myapp:files:export', json_encode($filters)]);
        $process->setTimeout(36000); //10min

        // let the process run in the background
        $this->get('event_dispatcher')->addListener(KernelEvents::TERMINATE, function() use($process) {
            $process->start();
            $process->wait();
        });

       // render this messsage in twig
        $this->addFlash("success", "The export files is initiated");

        return $this->redirectToRoute('home');
     }

   return $this->render('$PATH/export.html.twig', [
        'form' => $form->createView()
    ]);
}