Plugin Lazy loading can cause usort warning

Seeing this too. For me it happened when I enabled Web Profiler.

Changing to Needs Work, as there's no patch here to review.

I'm getting something similar via a new view:

uasort(): Array was modified by the user comparison function', '..../core/lib/Drupal/Core/Plugin/DefaultLazyPluginCollection.php', 90, Array)
uasort(Array, Array) (Line: 90)
Drupal\Core\Plugin\DefaultLazyPluginCollection->sort() (Line: 84)
Drupal\filter\FilterPluginCollection->sort() (Line: 137)
Drupal\filter\Entity\FilterFormat->filters() (Line: 99)
Drupal\filter\Element\ProcessedText::preRenderText(Array)
call_user_func(Array, Array) (Line: 381)
Drupal\Core\Render\Renderer->doRender(Array, ) (Line: 195)
Drupal\Core\Render\Renderer->render(Array) (Line: 932)
render(Array) (Line: 889)
Drupal\views\Plugin\views\field\Field->render_item(0, Array) (Line: 1146)
Drupal\views\Plugin\views\field\FieldPluginBase->advancedRender(Object) (Line: 224)
template_preprocess_views_view_field(Array, 'views_view_field', Array) (Line: 287)
Drupal\Core\Theme\ThemeManager->render(Array, Array) (Line: 435)
Drupal\Core\Render\Renderer->doRender(Array, ) (Line: 195)
Drupal\Core\Render\Renderer->render(Array) (Line: 1703)
Drupal\views\Plugin\views\field\FieldPluginBase->theme(Object) (Line: 765)
Drupal\views\Plugin\views\style\StylePluginBase->elementPreRenderRow(Array)
call_user_func(Array, Array) (Line: 381)
Drupal\Core\Render\Renderer->doRender(Array, ) (Line: 195)
Drupal\Core\Render\Renderer->render(Array) (Line: 713)
Drupal\views\Plugin\views\style\StylePluginBase->renderFields(Array) (Line: 580)
Drupal\views\Plugin\views\style\StylePluginBase->renderGrouping(Array, Array, 1) (Line: 467)
Drupal\views\Plugin\views\style\StylePluginBase->render(Array) (Line: 2116)
Drupal\views\Plugin\views\display\DisplayPluginBase->render() (Line: 1518)
Drupal\views\ViewExecutable->render() (Line: 170)
Drupal\views\Plugin\views\display\Page->execute() (Line: 1615)
Drupal\views\ViewExecutable->executeDisplay('page_2', Array) (Line: 78)
Drupal\views\Element\View::preRenderViewElement(Array)
call_user_func(Array, Array) (Line: 381)
Drupal\Core\Render\Renderer->doRender(Array, ) (Line: 195)
Drupal\Core\Render\Renderer->render(Array, ) (Line: 226)
Drupal\Core\Render\MainContent\HtmlRenderer->Drupal\Core\Render\MainContent\{closure}() (Line: 574)
Drupal\Core\Render\Renderer->executeInRenderContext(Object, Object) (Line: 227)
Drupal\Core\Render\MainContent\HtmlRenderer->prepare(Array, Object, Object) (Line: 117)
Drupal\Core\Render\MainContent\HtmlRenderer->renderResponse(Array, Object, Object) (Line: 90)
Drupal\Core\EventSubscriber\MainContentViewSubscriber->onViewRenderArray(Object, 'kernel.view', Object) (Line: 111)
Drupal\Component\EventDispatcher\ContainerAwareEventDispatcher->dispatch('kernel.view', Object) (Line: 144)
Symfony\Component\HttpKernel\HttpKernel->handleRaw(Object, 1) (Line: 62)
Symfony\Component\HttpKernel\HttpKernel->handle(Object, 1, 1) (Line: 57)
Drupal\Core\StackMiddleware\Session->handle(Object, 1, 1) (Line: 47)
Drupal\Core\StackMiddleware\KernelPreHandle->handle(Object, 1, 1) (Line: 98)
Drupal\page_cache\StackMiddleware\PageCache->pass(Object, 1, 1) (Line: 77)
Drupal\page_cache\StackMiddleware\PageCache->handle(Object, 1, 1) (Line: 47)
Drupal\Core\StackMiddleware\ReverseProxyMiddleware->handle(Object, 1, 1) (Line: 50)
Drupal\Core\StackMiddleware\NegotiationMiddleware->handle(Object, 1, 1) (Line: 23)
Stack\StackedHttpKernel->handle(Object, 1, 1) (Line: 628)
Drupal\Core\DrupalKernel->handle(Object) (Line: 19)

Iterating the IDs through the array. Attaching patch. Please review.

Sporadically we get the following warning

Can you provide a test case to reproduce this problem, or step-by-step instructions so we can reproduce the problem manually? We would also need to know which versions of PHP cause problems and which ones don't.

In this patch, $this->get($id)->getPluginId() is iterated across, but it doesn't actually do anything with `$pluginId`. What does this actually accomplish?

Having this issue as well.

I can see the error when I try to add a Media entity(drupal/media_entity_image) to a node.

I can see the same uasort warning but in different classes in other places as well. Modules page /admin/modules and node save with tokens: #2671060: Use SortArray::stableUasort instead uasort to prevent warnings (Array was modified by the user comparison function)

PHP Version: PHP 5.5.9-1ubuntu4.14 (cli) (built: Oct 28 2015 01:34:46)
Drush version: 8.0.2.

#7 hides the warning in this place for me.

This issue is related to the PHP Bug #50688 Using exceptions inside usort() callback function causes a warning.

If you do not have this error, could you please write which PHP version do you use?

Is this patch gonna be include in core on day ?

It correct the functionnality with the media module.

I've noticed this warning when installing the Lightning module as part of a vanilla BLT configuration, either via a CI tool or locally using blt local:setup

@geerlingguy, unless I'm mistaken Lightning is a D8 profile and not a module.

I too just tried installing Lightning via composer and saw the same Warning

Other D8 modules using uasort() report a similar issue also mention this is a known php uasort bug():
https://www.drupal.org/node/2670942 [token module]

php issue:
https://bugs.php.net/bug.php?id=50688 [known php5 issue, fixed in php 7]

I'm not sure what the proper resolution is given it's resolved in some versions of php.

@tenken - Ah, didn't realize it's been fixed in PHP 7. Hopefully we'll be able to move this particular site I'm working on to PHP 7 soon... then this will be a non-issue :)

Hello

for a quick fix, add @ before uasort

@uasort($this->instanceIDs, array($this, 'sortHelper'));

related https://www.drupal.org/node/2628884

Restoring the version number.

Here is an update to this patch.

* Removed the un-needed variable assignment
* Improved the comment
* Re-rolled for 8.3.x

#23 Works for me to fix this error, when image was loading:
uasort(): Array was modified by the user comparison function in /home/devbwfu/public_html/core/lib/Drupal/Core/Plugin/DefaultLazyPluginCollection.php on line 90

Patch #23 fixed it for me.

This fix looks good. It will need test coverage though.

I guess it needs a re-roll again.

Patch #23 re-rolled for 8.9.x-dev.

It still needs test coverage, which the patch in the previous comment doesn't include.

One question, should change $instanceIDs to $instanceIds? could not find where it is documented, I remember, for abbreviation in class methods and properties, it should uppercase the first letter only.

Yes, it should be LazyPluginCollection::$instanceIds (see Object-oriented code, Naming conventions), but that can be fixed in a different issue.

Thanks, @kiamlaluno! A child issue added.

Reroll against latest 8.9.x (works for 8.9.0)

Ran into a new problem with this patch on D8.9.0. When creating a simple Functional test that inherits from `BrowserTestBase` if you tell it to install the `node` module, then even with an empty test I get the error:

1) Drupal\Tests\octane_ci_test\Functional\OctaneCiTest::testCi
Undefined property: Drupal\filter\FilterPluginCollection::$instanceIDs

/var/www/build/docroot/core/lib/Drupal/Core/Plugin/DefaultLazyPluginCollection.php:92
/var/www/build/docroot/core/modules/filter/src/FilterPluginCollection.php:84
/var/www/build/docroot/core/modules/filter/src/Entity/FilterFormat.php:144
/var/www/build/docroot/core/modules/filter/src/Entity/FilterFormat.php:205
/var/www/build/docroot/core/lib/Drupal/Core/Entity/EntityStorageBase.php:499
/var/www/build/docroot/core/lib/Drupal/Core/Entity/EntityStorageBase.php:454
/var/www/build/docroot/core/lib/Drupal/Core/Config/Entity/ConfigEntityStorage.php:263
/var/www/build/docroot/core/lib/Drupal/Core/Entity/EntityBase.php:395
/var/www/build/docroot/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:616
/var/www/build/docroot/core/lib/Drupal/Core/Config/ConfigInstaller.php:371
/var/www/build/docroot/core/lib/Drupal/Core/Config/ConfigInstaller.php:137
/var/www/build/docroot/core/lib/Drupal/Core/ProxyClass/Config/ConfigInstaller.php:75
/var/www/build/docroot/core/lib/Drupal/Core/Extension/ModuleInstaller.php:288
/var/www/build/docroot/core/lib/Drupal/Core/ProxyClass/Extension/ModuleInstaller.php:83
/var/www/build/docroot/core/lib/Drupal/Core/Test/FunctionalTestSetupTrait.php:476
/var/www/build/docroot/core/tests/Drupal/Tests/BrowserTestBase.php:578
/var/www/build/docroot/core/tests/Drupal/Tests/BrowserTestBase.php:406

Notice this error happens on line 92, which is the new line added by this patch:

    foreach ($this->instanceIDs as $id) {
      $this->get($id)->getPluginId();
    }

Not sure what could cause this since every instance of DefaultLazyPluginCollection should have an instanceIDs property. I'd have to look at what changed in core to understand this more. So just beware when using this patch in 8.9.x

@mpotter it looks like there was a change in the variable name to $this->instanceIds. I updated your patch with that change.

Is there a patch for 9.3.7?

#39 is not applying.

Resolved CSpell errors & added interdiff.

A related issue was a bugsmash target this week. Both lendude and I discussed it.

We concluded that this can be closed as outdated. The full details are in #2831964-19: Warning: uasort(): Array was modified by the user comparison function in Drupal\Core\Config\Entity\ConfigEntityListBuilder->load().