Magento2: Transport variable can not be altered in email_invoice_set_template_vars_before Event

[diybook]

We waht to change the payment_html for banktransfer invoices. Unfortunately the instruction is also sent in invioce email. And there the customer already has paid the bill.

Preconditions

1. Magento 2.1.7
2. PHP 7.0.2
3. MySql 5.7

Steps to reproduce

1. Declare the event

<event name="email_invoice_set_template_vars_before">
        <observer name="mod_mail_variables_of_Invoice" instance="Vendor\Module\Observer\ChangePaymentHtml" />
    </event>

1. Alter variable payment_html in Vendor\Module\Observer\ChangePaymentHtml like

<?php

namespace Venoor\Module\Observer;

use Magento\Framework\Event\ObserverInterface;
use Magento\Framework\Event\Observer;
use Magento\Framework\App\Request\DataPersistorInterface;
use Magento\Framework\App\ObjectManager;

use Vendor\Module\Helper\Data as PaymentHelper;
use Magento\Sales\Model\Order;

class ChangePaymentHtml implements ObserverInterface
{

    protected $paymentHelper;
    public $logger;

    public function __construct(
        PaymentHelper $paymentHelper,
        \Psr\Log\LoggerInterface $logger
    ) {
        $this->paymentHelper = $paymentHelper;
        $this->logger = $logger;
    }

    public function execute(\Magento\Framework\Event\Observer $observer)
    {
        $transport = $observer->getEvent()->getTransport();
        $paymentInfo = $this->getPayment($transport['order'], $transport['store']->getStoreId());

        if ($paymentInfo->getTemplate() == 'info/instructions.phtml') {
            $paymentInfo->setTemplate('Vendor_Module::payment/info/invoicepaymentinfo.phtml');
        }

        $transport['payment_html'] = $paymentInfo->toHtml();
        $observer->setData('transport', $transport);
    }

    protected function getPayment(Order $order, $storeid)
    {
        return $this->paymentHelper->getRawInfoBlock(
            $order->getPayment(),
            $storeid
        );
    }
}

Expected result

1. Email should be modified and new or changed variables should be output in email.

Actual result

1. Email is unchanged, and $transport variable seems not to be changed.

[magento-engcom-team]

@diybook, thank you for your report.
The issue is already fixed in develop branch
But we will consider to backport the fix to patch releases

[reviskar]

Hi.
Meanwhile could anyone pinpoint us to a patch for this?

[gwharton]

@reviskar Here is a link to the commit in the development branch that fixes this issue.

https://github.com/magento/magento2/commit/68e7d8bbd41fe3434ae2a4b85bb0fb8c67217a0b

[reviskar]

Hi, @gwharton!

Thanks very much, will check it out!

[gwharton]

@magento-engcom-team Is there a process to follow to request the backporting of the above commit into 2.1 and 2.2. Apologies if it is covered somewhere, but I did search to no avail.

[okorshenko]

The issue has been fixed and delivered to 2.2-develop branch

[aeno]

I encoutered this bug on a fresh 2.2.2 install. Did the fix not make it into this release?
I can not see the changes from #12132 in the source of module-sales (v101.0.2).

[gwharton]

This fix has been merged into 2.2-develop and will be available in the next 2.2.x release. Unfortunately it didn't make it in time for 2.2.2.

[dan-ding]

Unfortunately it didn't make it in time for 2.2.2.

or 2.2.3

[gwharton]

Although this fix has made it into 2.2.4 There is an error in the commit that was made to 2.2-develop.

The fix is missing for file app/code/Magento/Sales/Model/Order/Email/Sender/OrderSender.php

Infact, on further investigation this is still broken in 2.1-develop, 2.2-develop and 2.3-develop for the above reason.

[gwharton]

@RomaKis or @okorshenko can you look at this again and check the status of app/code/Magento/Sales/Model/Order/Email/Sender/OrderSender.php in 2.1, 2.2 and 2.3 Somethings gone wrong with the commit and the changes have been only partially applied for the above file.

[magento-engcom-team]

Hi @diybook. Thank you for your report.
The issue has been fixed in magento/magento2#15038 by @gwharton in 2.1-develop branch
Related commit(s):

• 9a95dae80232792eb5298b240f86b342c70a7341

The fix will be available with the upcoming 2.1.15 release.

[VladimirZaets]

Hi @diybook. Thank you for your report.
The issue has been fixed in magento/magento2#15039 by @gwharton in 2.3-develop branch
Related commit(s):

• 6dff3a53b1ac0df593163894fd57b8a36722450f

The fix will be available with the upcoming 2.3.0 release.

[magento-engcom-team]

Hi @diybook. Thank you for your report.
The issue has been fixed in magento/magento2#15040 by @gwharton in 2.2-develop branch
Related commit(s):

• ca3245fc9c80247dfd637e5699914bea1b1e8df8
• 874260d3bf90d51c003597d071392c14bad315cf

The fix will be available with the upcoming 2.2.5 release.

[mam08ixo]

@gwharton @magento-engcom-team

This is a backward incompatible change. Anyone who relied on transport being a \Magento\Framework\DataObject now receives a

Call to a member function getData() on array

fatal error, potentially breaking checkout.

[gwharton]

Ouch, yes you are right. Looking into it, prior to the changes implemented the events have inconsistent parameter types.

Event | Before Parameter 1 | Before Parameter 2 | After Parameter 1 | After Parameter 2 | After Parameter 3
-- | -- | -- | -- | -- | --
email_creditmemo_set_template_vars_before | Creditmemo/Sender/EmailSender | $transport array() | Creditmemo/Sender/EmailSender | $transport array() | $transportObject DataObject()
email_invoice_set_template_vars_before | Invoice/Sender/EmailSender | $transport array() | Invoice/Sender/EmailSender | $transport array() | $transportObject DataObject()
email_shipment_set_template_vars_before | Shipment/Sender/EmailSender | $transport array() | Shipment/Sender/EmailSender | $transport array() | $transportObject DataObject()
email_creditmemo_comment_set_template_vars_before | Email/Sender/CreditmemoCommentSender | $transport array() | Email/Sender/CreditmemoCommentSender | $transport array() | $transportObject DataObject()
email_creditmemo_set_template_vars_before | Email/Sender/CreditmemoSender | $transport array() | Email/Sender/CreditmemoSender | $transport array() | $transportObject DataObject()
email_invoice_comment_set_template_vars_before | Email/Sender/InvoiceCommentSender | $transport array() | Email/Sender/InvoiceCommentSender | $transport array() | $transportObject DataObject()
email_invoice_set_template_vars_before | Email/Sender/InvoiceSender | $transport array() | Email/Sender/InvoiceSender | $transport array() | $transportObject DataObject()
email_shipment_comment_set_template_vars_before | Email/Sender/ShipmentCommentSender | $transport array() | Email/Sender/ShipmentCommentSender | $transport array() | $transportObject DataObject()
email_shipmen_set_template_vars_before | Email/Sender/ShipmentSender | $transport array() | Email/Sender/ShipmentSender | $transport array() | $transportObject DataObject()
email_order_comment_set_template_vars_before | Email/Sender/OrderCommentSender | $transport array() | Email/Sender/OrderCommentSender | $transport array() | $transportObject DataObject()
email_order_set_template_vars_before | Email/Sender/OrderSender | $transport DataObject() | Email/Sender/OrderSender | $transport array() | $transportObject DataObject()

You can see that for the OrderSender the type of parameter "transport" was DataObject, whereas the type of parameter "transport" in all of the other email events is Array().

After the change, it was incorrectly changed to type Array(). I will create a PR to correct this.

[sidolov]

Hi @diybook. Thank you for your report.
The issue has been fixed in magento/magento2#16601 by @gwharton in 2.1-develop branch
Related commit(s):

• 390fc2f6ed3369554618d965a45985fe332b982d

The fix will be available with the upcoming 2.1.15 release.

[sidolov]

Hi @diybook. Thank you for your report.
The issue has been fixed in magento/magento2#16600 by @gwharton in 2.3-develop branch
Related commit(s):

• cdbd32412cd3497a9df8d961fda8c4ac386a33c7

The fix will be available with the upcoming 2.3.0 release.

[VladimirZaets]

Hi @diybook. Thank you for your report.
The issue has been fixed in magento/magento2#16599 by @gwharton in 2.2-develop branch
Related commit(s):

• 61b868ff4d6f2e85a9ff9e6621f774a98e1f0bd4

The fix will be available with the upcoming 2.2.6 release.

[topranavp]

@magento-engcom-team , issue still persists in Magento 2.2.4. have tried to append value to $transport['payment_html'] variable in extended class but still it is not allowing to alter.