tomatom/jobqueuebundle

JMSJobQueueBundle alternative for Symfony 6+

v1.0.5 2024-03-22 11:05 UTC

Requires

• php: >=8.1
• doctrine/doctrine-bundle: ^2.10
• doctrine/orm: ^2.15
• symfony/framework-bundle: ^6.4
• symfony/messenger: ^6.4
• symfony/process: ^6.4
• symfony/translation: ^6.4
• twig/twig: ^3.6

MIT

• Tom Atom

• symfony job queue bundle alternative messenger

README

Symfony Bundle which aims to replace JMSJobQueueBundle console commands scheduling, using Symfony messenger.

Dependencies:

• doctrine/doctrine-bundle: ^2.10
• doctrine/orm: ^2.15
• symfony/framework-bundle: ^6.4
• symfony/messenger: ^6.4
• symfony/process: ^6.4
• symfony/translation: ^6.4
• twig/twig: ^3.6

Installation:

composer require tomatom/jobqueuebundle

Configuration:

config/bundles.php:

TomAtom\JobQueueBundle\JobQueueBundle::class => ['all' => true]

config/services.yaml:

TomAtom\JobQueueBundle\:
  resource: '../vendor/tomatom/jobqueuebundle/src/*'
  exclude: '../vendor/tomatom/jobqueuebundle/src/{DependencyInjection,Entity,Tests,Kernel.php}'

config/routes.yaml:

jobqueue:
  resource:
    path: '../vendor/tomatom/jobqueuebundle/src/Controller'
    namespace: TomAtom\JobQueueBundle\Controller
  type: attribute

config/packages/messenger.yaml:

framework:
  messenger:
    ...
    routing:
      'TomAtom\JobQueueBundle\Message\JobMessage': async # or your own transport

config/packages/twig.yaml:

twig:
  ...
  paths:
    '%kernel.project_dir%/vendor/tomatom/jobqueuebundle/templates': TomAtomJobQueue

And update your database so the 'job' table is created

bin/console d:s:u --complete --force

Usage:

So far there is only one function createCommandJob, which accepts:

• command name,
• command parameters,
• ID of related entity (optional)
• Name of related entity class - self::class (optional)

and returns ID of the created job, for example:

$commandName = 'app:your:command';

$params = [
    '--param1=' . $request->get('param1'),
    '--param2=' . $request->get('param2'),
];

// Try to create the command job
try {
    $job = $this->commandJobFactory->createCommandJob($commandName, $params, $entity->getId(), Entity::class);
} catch (OptimisticLockException|ORMException|CommandJobException $e) {
    // Redirect back upon failure
    $this->logger->error('createCommandJob error: ' . $e->getMessage());
    return $this->redirectToRoute('your_route');
}

// Redirect to the command job detail
return $this->redirectToRoute('job_queue_detail', ['id' => $job->getId()]);

Create templates/job/ detail and list twig templates, which you will propably want to edit like this:

{# templates/job/detail.html.twig #}

{% extends "@TomAtomJobQueue/job/detail.html.twig" %}

{% block title %}...{% endblock %}

{% block header %}...{% endblock %}

{% block body %}...{% endblock %}

To change or add translations for a new locale, use those translation variables in your messages.{locale}.yaml:

job.detail: 'Detail'
job.detail.title: "Planned task"
job.detail.refresh: "Refresh"
job.detail.back.to.list: "Back to list"
job.detail.runtime: "Runtime"
job.detail.closed: "Closed"
job.detail.output: "Output"
job.list.title: "Planned tasks"
job.list.related.entity: "Entity ID"
job.list.back.to.list: "Back to tasks"
job.header.for.entity: "for entity with ID"
job.command: "Command"
job.state: "State"
job.created: "Created"
job.runtime.hours: "hours"
job.runtime.minutes: "minutes"
job.runtime.seconds: "seconds"
job.already.exists: "The same job is already planned."