Allow configuring struture mutex timeout via config/app.php

[r-anwar]

We are importing several hundred entries into a structured section via the GraphQL interface.
Our middleware supports multiple parallel requests (several dozen at once), which generally works well. However, as the import progresses and the section structure grows, we increasingly run into MutexExceptions.

This is understandable, as the operations Craft performs under the structure mutex (e.g., adjusting lft/rgt values) naturally take longer as the tree expands. Still, we’d like to handle this more gracefully by configuring the mutex timeout ourselves.

Currently, the StructuresService uses a hardcoded mutex timeout of 3 seconds (see:

cms/src/services/Structures.php

Line 513 in 7a95af9

if (!$mutex->acquire($lockName, $this->mutexTimeout)) {

), which cannot be overridden via configuration. Would it be possible (and sensible) to allow defining the default timeout for mutex acquisition (e.g. for structure operations) via config/app.php? We’re using Craft CMS 4.16.5, and would really appreciate if this could be made configurable even within Craft 4.

'mutex' => [
    'class' => craft\mutex\Mutex::class,
    'mutex' => [
        'class' => yii\redis\Mutex::class,
        'timeout' => n, // seconds
        'expire' => 30,
    ],
],

Alternatively, if the $timeout parameter were set to null or empty string, the configured default could take effect.

Thanks for considering!

[brandonkelly]

You can override that via config/app.php:

return [
  'components' => [
    'structures' => [
      'mutexTimeout' => 10,
    ],
  ],
];

[r-anwar]

@brandonkelly even in Craft4?

[brandonkelly]

Yes, since 3.0.19.