Order management system multi-thread

Order management system (OMS) heavily relies on state machine-related concepts like event timeouts and conditions. When an order is managed, a lot of the timeout and condition entities are processed. The following two console command do the processsing of timeouts and conditions in Spryker:

• oms:check-timeout
• oms:check-condition

Out of the box, both of these commands process their respective entities sequentially. Each of them grabs and processes all the available entities one by one. Both commands support the limit option and thus can do the processing in batches. But still, all the work is done synchronously. Because of this, order management could become a bottleneck for shops with lots of orders being placed and managed. The OMS multi-thread improves this by introducing the ability to process both timeouts and conditions in parallel.

How OMS multi-thread works

Each order is assigned a randomly generated positive number called a processor identifier. This number is saved in the spy_sales_order table. During the order management processing, both preceding commands are triggered with the new command option processor-identifier (p). The value of this option must match a processor identifier from spy_sales_table. Then the commands process only those timeouts and conditions that are related to the orders with the matching processor identifier. This way, one can, for example, trigger the oms:check-timeout command several times simultaneously, each time providing different processor identifiers, thus creating several PHP processes for managing a large number of orders in parallel. With the new option in place, the command looks like this:

console oms:check-timeout -p 5 -l 10000

Instead of providing a single value as the processor-identifier option value, one can provide several values separated by a comma.

console oms:check-timeout -p 1,2,3 -l 10000

Enable OMS multi-thread

1. Install the spryker/oms-multi-thread module and update spryker/sales:

composer require spryker/oms-multi-thread

2. Apply the database changes:

console propel:install

3. In config/Shared/config_default.php, configure the maximum number of OMS process workers:

...
use Spryker\Shared\OmsMultiThread\OmsMultiThreadConstants;
...

$config[OmsMultiThreadConstants::OMS_PROCESS_WORKER_NUMBER] = 10;

This value serves as the upper boundary for a generated processor identifier. For example, if you want to process the orders in 10 simultaneous threads, set this value to 10. Then, each new order is assigned a number between 1 and 10 as the processor identifier.

4. Configure the OMS console commands. Let’s take oms:check-timeout as an example. Create as many cronjobs, as many process workers you have. Each cronjob must run the command with different processor identifiers within the boundaries defined in step 3. In the current example, the maximum number of OMS process workers is 10; thus, you must configure 10 distinct cronjobs each dealing with its own processor identifier:

config/Zed/cronjobs/jenkins.php

/* STATE MACHINE */
$jobs[] = [
    'name'     => 'check-statemachine-conditions-1',
    'command'  => '$PHP_BIN vendor/bin/console oms:check-condition -p 1 -l 10000',
    'schedule' => '*/10 * * * *',
    'enable'   => true,
    'run_on_non_production' => true,
    'stores'   => $allStores,
];

$jobs[] = [
    'name'     => 'check-statemachine-conditions-2',
    'command'  => '$PHP_BIN vendor/bin/console oms:check-condition -p 2 -l 10000',
    'schedule' => '*/10 * * * *',
    'enable'   => true,
    'run_on_non_production' => true,
    'stores'   => $allStores,
];

...

$jobs[] = [
    'name'     => 'check-statemachine-conditions-10',
    'command'  => '$PHP_BIN vendor/bin/console oms:check-condition -p 10 -l 10000',
    'schedule' => '*/10 * * * *',
    'enable'   => true,
    'run_on_non_production' => true,
    'stores'   => $allStores,
];

General performance recommendations

Regarding performance, there are a few things to keep in mind when running the OMS commands:

• The limit options: commands oms:check-timeout and oms:check-condition have an option that allows specifying the maximum number of order items to be handled during a single command run. It’s recommended to provide this option for speeding up the database-related activities.
• You can specify more than one processor identifier for a single command run. But for large databases, this is generally not recommended. Specifying more than one process identifier affects the SQL query running under the hood and might disable a table index needed for this query to be executed in the most performant way.