Debugging

When running the command with the -vv option it tells us the specific file where the error occurred:

Shopware\Core\Framework\Plugin\PluginEntity->getLabel() at /srv/shopware/vendor/shopware/core/Framework/Plugin/Command/Lifecycle/AbstractPluginLifecycleCommand.php:230

This shows that the problem happens because the getLabel() method returnes null instead of the expected type, string.

To further debug the problem I tried wrapping it in a try .. catch block, filling out the label with the specific error message on problematic plugins. E.g.:

try {
 $pluginLabel = $plugin->getLabel();
} catch (\Throwable $th) {
 $pluginLabel = $th->getMessage();
}

Then I simply replaced $plugin->getLabel() with $pluginLabel where it was used.

Doing this finally allowed Shopware's plugin:list command to run, outputting the specific error message as label, if missing. But this was not very helpful to do, because I already knew what the error was; it did however send me down the right track in the debugging process, because I could see exactly which plugins had the problem.

Next I tried reading the composer.json file of the problematic plugins, but oddly, the label was not missing in the composer file, so this was clearly not the issue; this was then I realised something must have gone wrong in my Shopware installation.

The fix for the error turned out to be surprisingly simple; I just had to run a plugin:refresh command. Doing this somehow reintroduced or reloaded the plugin labels, and I was able to revert my changes to the core files.

With the console commmands, remember you can use echo, print and var_dump to show output in the terminal when running the command.

Tell us what you think: