aligent / async-bundle
A bundle for extending Oro's Async processing
Installs: 1 129
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 28
Forks: 2
Open Issues: 1
Type:symfony-bundle
Requires
- oro/commerce: 5.0.*
- dev-master
- 5.0.3
- 5.0.2
- 5.0.1
- 5.0.0
- 4.2.x-dev
- 4.2.2
- 4.2.0
- 4.1.x-dev
- 4.1.1
- 4.1.0
- 3.1.x-dev
- 3.1.0
- dev-hotfix/remove-deleted-channel-from-cache
- dev-feature/CreateCustomWebhookEvent
- dev-hotfix/Oro5.0-Compatibilty_Fixes
- dev-feature/add-webhooks-and-oro-4.2-compatibility
- dev-feature/add-webhooks-and-oro-5.0-compatibility
- dev-hotfix/remove-version-from-composer-file
- dev-hotfix/replace-outdated-symfony-RegistryInterface-with-ManagerRegistry
- dev-hotfix/Update-Exception-To-Text-field
This package is auto-updated.
Last update: 2024-11-06 00:57:09 UTC
README
This bundle provides:
-
An Abstract Processor class that will catch RetryableExceptions and after 3 (default) retries place the failed jobs into the database so they can be reviewed, fixed and then requeued.
-
Webhook integration
Installation Instructions
-
Install this module via Composer
composer require aligent/async-bundle
-
Clear cache
php bin/console cache:clear
-
Run Migrations
php bin/console oro:migration:load --force
Usage
Make sure your class extends the AbstractRetryableProcessor and perform your normal job processing in the execute function.
class TestJobProcessor extends AbstractRetryableProcessor
{
/**
* @param MessageInterface $message
* @return string
* @throws RetryableException
*/
public function execute(MessageInterface $message)
{
$body = JSON::decode($message->getBody());
try {
// Process the job here
$this->importSomeEntities($body);
} catch (\Exception $e) {
throw new RetryableException(
'This job failed and needs a retry',
0,
$e
);
}
}
}
By default the AbstractRetryableProcessor will fetch the passed exception from the RetryableException and store the trace. However if you aren't catching an exception you can just use the RetryableException and it will store the trace and message generated at this point.
class TestJobProcessor extends AbstractRetryableProcessor
{
/**
* @param MessageInterface $message
* @return string
* @throws RetryableException
*/
public function execute(MessageInterface $message)
{
$body = JSON::decode($message->getBody());
// Process the job here
$success = $this->importSomeEntities($body);
if (!$success) {
throw new RetryableException('This job failed and needs a retry');
}
}
}
You can also increase or decrease the amount of retries by overriding const MAX_RETRIES = 3;
in your own class.
Set up Transport for Webhooks
Go to the "System -> Integrations -> Manage integrations" and click "Create Integration". Select "Webhook" as the integration type and fill all required fields.
To Enable set status as Active.
Once complete you must now receive webhook events to requested URL.
Dispatch webhook events
- EntityEventListener listens to any create/update/delete events; check if relevant webhook transport exists and active; if yes, pushes message to the queue
Aligent\AsyncEventsBundle\EventListener\EntityEventListener:
lazy: true
arguments:
- '@Aligent\AsyncEventsBundle\Provider\WebhookConfigProvider'
- '@oro_message_queue.client.message_producer'
- '@logger'
tags:
- { name: doctrine.event_listener, event: onFlush }
- { name: doctrine.event_listener, event: postFlush }
- WebhookEntityProcessor builds a payload and send a webhook event in response to the queued message.
Aligent\AsyncEventsBundle\Async\WebhookEntityProcessor:
parent: Aligent\AsyncEventsBundle\Async\AbstractRetryableProcessor
calls:
- [setConfigProvider, ['@Aligent\AsyncEventsBundle\Provider\WebhookConfigProvider']]
- [setTransport, ['@Aligent\AsyncEventsBundle\Integration\WebhookTransport']]
- [setSerializer, ['@oro_importexport.serializer']]
tags:
- { name: 'oro_message_queue.client.message_processor' }
- If you need to enrich payload data (ex., add addreses for the customer user), you can use OroImportExportBundle and add some custom normalizers to add/transform payload data.
Support
If you have any issues with this bundle, please create a GitHub issue.
Contribution
Any contribution is highly appreciated. The best way to contribute code is to open a pull request on GitHub.
Developer
Adam Hall adam.hall@aligent.com.au