mage-os / mageos-common-async-events

This module implements the most common events like order creation or customer change for the Mage-OS Asynchronous Events module.

Mage-OS Common Asynchronous Events

Send REST requests to external endpoints asynchronously. This module implements the most common events like order creation and customer change.

This module uses the Mage-OS Asynchronous Events module as a basis.

Installation

composer require mage-os/mageos-common-async-events

If you run into an error like "Could not find a version of package mage-os/mageos-common-async-events matching your minimum-stability (stable).", run this command instead:

composer require mage-os/mageos-common-async-events @dev

Enable and install the module:

bin/magento setup:upgrade

Usage

You can now use the following events without having to implement them yourself.

Event identifier	Description	Remarks
customer.created	Whenever a customer is created
customer.updated	Whenever a customer is saved, except it's new
customer.address.created	Whenever a customer address is created
customer.address.updated	Whenever a customer address is saved, except it's new
sales.order.created	When a new order is created
sales.order.updated	When the state of an existing order is changed
sales.order.paid	When an order is fully paid
sales.order.shipped	When an order is fully shipped
sales.order.holded	When an order is set "on hold"
sales.order.unholded	When an order is released from "on hold"
sales.order.cancelled	When an order is cancelled
sales.shipment.created	When a new shipment is created
sales.invoice.created	When a new invoice is created
sales.invoice.paid	When an invoice is paid
sales.creditmemo.created	When a new creditmemo is created

You can use these events by

• creating a new subscription via Mage-OS REST API
• creating a new subscription with the Mage-OS Async Events Admin UI module

mageos-common-async-events's Issues

Use sales_order_save_commit_after event

Hi

I am using the mageos-common-async-events module to dispatch a webhook call when a new order is placed is.
The event sales_order_save_after fires, but it fails when the consumer is trying to fetch the order by order ID. Despite having the correct order ID in the observer, when the consumer is trying to fetch the order, it returns an error: The entity that was requested doesn't exist. Verify the entity and try again.

This is apparently because all *_save_after observers allow for modification of the entity in question before MySQL commits it to the database, where as *_save_commit_after observers waits until after the MySQL transaction has been committed.
Since we don't want to modify the order, and instead we want to wait until after it's been saved completely in the DB, it would be better to use sales_order_save_commit_after instead of order_save_after.

What do you think

Customer registry caching

The CustomerRepository uses a CustomerRegistry which will cache entities on load. If the updates happen in a
different thread, there is a possibility that stale data is returned.
However, we still want to use the repository instead of using the resource model to preserve modifications
added by plugins.

There are two solutions to this

• Instead of publishing the ID to the queue, publish it as serialized JSON and create a new service interface (StaticServiceInterface etc) with a get which will do nothing except take in the input and return it as is (unserialize maybe required)
• Recreate the customer repository's get just for the sake of publishing but do not use the internal cache and always load from DB. I can provide an example of this if you'd like. However with this approach, you might lose custom plugins that modify data on it.

Please see
aligent/magento2-default-async-events#1 (comment)

https://github.com/aligent/magento2-default-async-events/blob/54c2943b0f08a31e56527a5c21e90f259c7d9db0/Model/AsyncCustomerManagement.php#L39