Drupal\Component\Plugin\Exception\PluginException: The plugin (svg) did not specify an instance class.

Problem/Motivation

In version 2.3.4 of SVG Image Field, we renamed SVG.php to Svg.php to pass GitLab CI phpstan codesniff Drupal.NamingConventions.ValidClassName.NoUpperAcronyms in commit 454081d39.

In some scenarios, case insensitive file systems have trouble upgrading from version 2.3.3 to 2.3.4. If the filename is not properly renamed during the module update process, users may be presented with a WSOD containing one of the two following error messages on screen or in logs:

Drupal\Component\Plugin\Exception\PluginException: The plugin (svg) did not specify an instance class. in Drupal\Component\Plugin\Factory\DefaultFactory::getPluginClass() (line 79 of core/lib/Drupal/Component/Plugin/Factory/DefaultFactory.php).

Or the error message from #3504935:

Drupal\Component\Plugin\Exception\PluginException: Plugin (svg) instance class "Drupal\svg_image_field\Plugin\media\Source\SVG" does not exist. in Drupal\Component\Plugin\Factory\DefaultFactory::getPluginClass() (line 97 of core/lib/Drupal/Component/Plugin/Factory/DefaultFactory.php).

Steps to reproduce

• Updated SVG Image Field from 2.3.3 to 2.3.4 and now receiving the above error.
• Using Drupal version 10.3.6.

Proposed resolution

• Rename class filename from src/Plugin/media/Source/Svg.php to src/Plugin/media/Source/ScalableVectorGraphic.php.
• Provide a class_alias in the module file so that Drupal\svg_image_field\Plugin\media\Source\SVG still works.

Remaining tasks

• Pass CI.
• Get someone that is experiencing the bug to confirm that the Classname change solves the issue.

User interface changes

None.

API changes

Class Drupal\svg_image_field\Plugin\media\Source\SVG will become Drupal\svg_image_field\Plugin\media\Source\ScalableVectorGraphic

Drupal\svg_image_field\Plugin\media\Source\SVG remains available as an alias for backward compatibility.

Data model changes

None.

Full stack trace:

Drupal\Core\Plugin\Factory\ContainerFactory->createInstance() (Line: 83)
Drupal\Component\Plugin\PluginManagerBase->createInstance() (Line: 62)
Drupal\Core\Plugin\DefaultSingleLazyPluginCollection->initializePlugin() (Line: 80)
Drupal\Component\Plugin\LazyPluginCollection->get() (Line: 88)
Drupal\Core\Plugin\DefaultSingleLazyPluginCollection->setConfiguration() (Line: 104)
Drupal\Core\Plugin\DefaultSingleLazyPluginCollection->addInstanceId() (Line: 55)
Drupal\Core\Plugin\DefaultSingleLazyPluginCollection->__construct() (Line: 204)
Drupal\media\Entity\MediaType->sourcePluginCollection() (Line: 193)
Drupal\media\Entity\MediaType->getSource() (Line: 48)
media_entity_file_replace_entity_extra_field_info()
call_user_func_array() (Line: 416)
Drupal\Core\Extension\ModuleHandler->Drupal\Core\Extension\{closure}() (Line: 395)
Drupal\Core\Extension\ModuleHandler->invokeAllWith() (Line: 423)
Drupal\Core\Extension\ModuleHandler->invokeAll() (Line: 676)
Drupal\Core\Entity\EntityFieldManager->loadExtraFields() (Line: 649)
Drupal\Core\Entity\EntityFieldManager->getExtraFields() (Line: 173)
Drupal\Core\Entity\EntityDisplayBase->init() (Line: 155)
Drupal\Core\Entity\EntityDisplayBase->__construct() (Line: 181)
Drupal\Core\Entity\Entity\EntityViewDisplay->__construct() (Line: 48)
Drupal\layout_builder\Entity\LayoutBuilderEntityViewDisplay->__construct() (Line: 418)
Drupal\Core\Entity\EntityStorageBase->mapFromStorageRecords() (Line: 41)
Drupal\layout_builder\Entity\LayoutBuilderEntityViewDisplayStorage->mapFromStorageRecords() (Line: 186)
Drupal\Core\Config\Entity\ConfigEntityStorage->doLoadMultiple() (Line: 312)
Drupal\Core\Entity\EntityStorageBase->loadMultiple() (Line: 121)
Drupal\Core\Entity\Entity\EntityViewDisplay::collectRenderDisplays() (Line: 281)
Drupal\Core\Entity\EntityViewBuilder->buildMultiple() (Line: 239)
Drupal\Core\Entity\EntityViewBuilder->build()
call_user_func_array() (Line: 113)
Drupal\Core\Render\Renderer->doTrustedCallback() (Line: 870)
Drupal\Core\Render\Renderer->doCallback() (Line: 432)
Drupal\Core\Render\Renderer->doRender() (Line: 248)
Drupal\Core\Render\Renderer->render() (Line: 238)
Drupal\Core\Render\MainContent\HtmlRenderer->Drupal\Core\Render\MainContent\{closure}() (Line: 638)
Drupal\Core\Render\Renderer->executeInRenderContext() (Line: 239)
Drupal\Core\Render\MainContent\HtmlRenderer->prepare() (Line: 128)
Drupal\Core\Render\MainContent\HtmlRenderer->renderResponse() (Line: 90)
Drupal\Core\EventSubscriber\MainContentViewSubscriber->onViewRenderArray()
call_user_func() (Line: 111)
Drupal\Component\EventDispatcher\ContainerAwareEventDispatcher->dispatch() (Line: 186)
Symfony\Component\HttpKernel\HttpKernel->handleRaw() (Line: 76)
Symfony\Component\HttpKernel\HttpKernel->handle() (Line: 53)
Drupal\Core\StackMiddleware\Session->handle() (Line: 48)
Drupal\Core\StackMiddleware\KernelPreHandle->handle() (Line: 28)
Drupal\Core\StackMiddleware\ContentLength->handle() (Line: 106)
Drupal\page_cache\StackMiddleware\PageCache->pass() (Line: 85)
Drupal\page_cache\StackMiddleware\PageCache->handle() (Line: 48)
Drupal\Core\StackMiddleware\ReverseProxyMiddleware->handle() (Line: 51)
Drupal\Core\StackMiddleware\NegotiationMiddleware->handle() (Line: 36)
Drupal\Core\StackMiddleware\AjaxPageState->handle() (Line: 51)
Drupal\Core\StackMiddleware\StackedHttpKernel->handle() (Line: 741)
Drupal\Core\DrupalKernel->handle() (Line: 19)