Invalid Block Mollie\Payment\Block\Adminhtml\Widget\Grid\PaypalReferenceColumn

[pointia]

Describe the bug
The new version of the Module tries to use a Block that is not inherited from the Abstract Block. The PaypalReferenceColumn whould be instantiated in vendor/magento/framework/View/Layout/Generator/Block.php:277 but as it is in an instance of the AbstractBlock it will throw an error.

if (!$block instanceof \Magento\Framework\View\Element\AbstractBlock) {
            throw new LocalizedException(
                new \Magento\Framework\Phrase(
                    'Invalid block type: %1',
                    [is_object($block) ? get_class($block) : (string) $block]
                ),
                $e
            );
        }

Used versions

• Magento Version number(eg 2.3.5): 2.4.7-p7
• Open source/Enterprise/B2b: OS
• Mollie version number (Check configuration): 2.47.0 (2.46.0 is working)

To Reproduce
Steps to reproduce the behavior:

1. Go to an order in the admin view

Expected behavior
Should display the order.

Actual behavior
Exception while loading order.

Additional context
Add any other context about the problem here.

Here is a Stacktrace:

Next Magento\Framework\Exception\LocalizedException: Invalid block type: Mollie\Payment\Block\Adminhtml\Widget\Grid\PaypalReferenceColumn in /var/www/htdocs/vendor/magento/framework/View/Layout/Generator/Block.php:278
Stack trace:
#0 /var/www/htdocs/vendor/magento/framework/View/Layout/Generator/Block.php(252): Magento\Framework\View\Layout\Generator\Block->getBlockInstance('Mollie\\Payment\\...', Array)
#1 /var/www/htdocs/generated/code/Magento/Framework/View/Layout/Generator/Block/Interceptor.php(41): Magento\Framework\View\Layout\Generator\Block->createBlock('Mollie\\Payment\\...', 'mollie_paypal_r...', Array)
#2 /var/www/htdocs/vendor/magento/framework/View/Layout/Generator/Block.php(225): Magento\Framework\View\Layout\Generator\Block\Interceptor->createBlock('Mollie\\Payment\\...', 'mollie_paypal_r...', Array)
#3 /var/www/htdocs/vendor/magento/framework/View/Layout/Generator/Block.php(134): Magento\Framework\View\Layout\Generator\Block->generateBlock(Object(Magento\Framework\View\Layout\ScheduledStructure), Object(Magento\Framework\View\Layout\Data\Structure), 'mollie_paypal_r...')
#4 /var/www/htdocs/generated/code/Magento/Framework/View/Layout/Generator/Block/Interceptor.php(32): Magento\Framework\View\Layout\Generator\Block->process(Object(Magento\Framework\View\Layout\Reader\Context), Object(Magento\Framework\View\Layout\Generator\Context))
#5 /var/www/htdocs/vendor/magento/framework/View/Layout/GeneratorPool.php(93): Magento\Framework\View\Layout\Generator\Block\Interceptor->process(Object(Magento\Framework\View\Layout\Reader\Context), Object(Magento\Framework\View\Layout\Generator\Context))
#6 /var/www/htdocs/vendor/magento/framework/View/Layout.php(365): Magento\Framework\View\Layout\GeneratorPool->process(Object(Magento\Framework\View\Layout\Reader\Context), Object(Magento\Framework\View\Layout\Generator\Context))
#7 /var/www/htdocs/generated/code/Magento/Framework/View/Layout/Interceptor.php(68): Magento\Framework\View\Layout->generateElements()
#8 /var/www/htdocs/vendor/magento/framework/View/Layout/Builder.php(129): 

[Frank-Magmodules]

Hi @pointia,

Thanks a lot for opening this issue! We looked into it right away and it seems this one is missed through both our manual QA and automated tests. With that in mind, I’d be very interested to learn the exact steps you took to reproduce the issue.

Also, and maybe even more importantly, we’ve just updated this PR.
Could you check and confirm whether it resolves the issue on your side as well?

Looking forward to your feedback!

[Frank-Magmodules]

Good morning @pointia, did you have a chance to review our PR and the comment above?
We’re happy to merge it, but would prefer your confirmation first.

Thanks!

[pointia]

When looking into the PR, I can't see that the Block is now extended from the AbstractBlock Class. So I don't think this could be the solution for it. The thing you did is adding an ifconfig to only display the block if the configuraiton is set which could lead to the same result but I don't think so.

The PR is working but only becaues of this line

<block class="Mollie\Payment\Block\Adminhtml\Widget\Grid\PaypalReferenceColumn" name="mollie_paypal_reference" ifconfig="payment/mollie_methods_paypal/show_reference_in_transactions_grid">

And only because this value can't be set somewhere:
payment/mollie_methods_paypal/show_reference_in_transactions_grid

if you enable this setting (e.g. in config or db) the problem is back

[Frank-Magmodules]

Hello @pointia,

Thank you for your response.
You are correct that if you re-enable this setting the problem might be back for you. That specific change is mainly for us to have a quick workaround for customers that are affected by this issue and want to continue their daily work.

For this specific issue, where you get the error that the class isn’t extended from the AbstractBlock, it’s a bit of a weird one. We have tested this in multiple Magento versions, but everywhere it is working as expected. When you look into the code, you will see this cascade of classes from the PayPalReferenceColumn:

\Mollie\Payment\Block\Adminhtml\Widget\Grid\PaypalReferenceColumn
\Magento\Backend\Block\Widget\Grid\Column
\Magento\Backend\Block\Widget
\Magento\Backend\Block\Template
\Magento\Framework\View\Element\Template
\Magento\Framework\View\Element\AbstractBlock

So it might not be extended from AbstractBlock directly, but with a few steps in between it should pass the failing if.
And in a plain Magento installation it does pass the validation. That’s why we have reason to believe that you have some custom- or third-party code that interferes with this somehow.

We can recommend you to either install the PR and disable the column, or track down the conflicting module by following the steps outlined here: https://github.com/mollie/magento2/wiki/Identifying-Module-Conflicts

[markvds]

Hi!

I also encountered this problem. It turns out that it has nothing to do with if the block does or does not extend from AbstractBlock, although I understand why it might appear that way. @pointia only quoted the 'Next exception' from the logs, not the original exception, which says:

ReflectionException: Class "Mollie\Payment\Block\Adminhtml\Widget\Grid\PaypalReferenceColumn\Interceptor" does not exist.

I didn’t really figure out why, but the problem is that Magento (2.4.8-p2, PHP 8.2) won't create the Interceptor with this method definition if (and only if) Magento is in Developer mode and the Interceptor must be created on-the-fly:

public function filterPaypalReference(Collection $collection, self $column)

I you remove self, everyting's fine. The strange thing is - and I think this is why it slipped through QA and automated tests -that the CLI command magento setup:di:compile doesn’t complain and simply creates the Interceptor.

TL;DR
Remove the self type from the $column argument of the filterPaypalReference method, and problem solved.

I will create a PR in a few moments.

[markvds]

I dug a little deeper and found that:

1. A clean Magento installation doesn’t include a plugin on a grid column block, so I imagine most people don’t encounter any errors, and tests don’t reveal any issues either.
2. Dynamic (on-the-fly) generation is problematic because it creates a 'wrapper method' for all methods in a class, whereas upfront compilation only creates wrapper methods for methods that actually have plugins defined.

So that resolves all the mysteries.

[Frank-Magmodules]

Awesome effort @markvds , we’ll dig into your second point for sure.
Your digging + proposed pull request = super helpful. Thanks again and have a good weekend ahead!