magento/magento2#24730: Fix Frontend Invoice PDF configured Logo image

[mozok]

Description (*)

According to #24730 Admin Configuration Stores -> Configuration -> Sales -> Sales ->'Invoice and Packaging Slip Design' -> 'Logo for HTML Print View' does not affect on logo on frontend invoice print page.

sales_order_printinvoice page use general theme class/template for Logo generation - app/code/Magento/Theme/Block/Html/Header/Logo.php

In Block 'logo_src' argument is checked, before logo path is generated, so I use it as extension point to insert logo configuration on print invoice page.
Changes affects only frontend sales order print invoice page through layout file. Similar approach can be used to change other print pages, like sales_order_print.

Related Pull Requests

no

Fixed Issues (if relevant)

1. Fixes Invoice PDF on frontend does not use configured logo image #24730

Manual testing scenarios (*)

1. Create Order from storefront.
2. Create Invoice from admin.
3. On storefront go to Customer Account > My Orders > View Order
4. Select Invoices Tab.
5. Select Print Invoice. By Default Logo is Luma.
6. In Admin Configuration go to Sales -> Sales ->'Invoice and Packaging Slip Design' -> 'Logo for HTML Print View' and upload custom image
7. Clear cache.
8. In customer account repeat steps 3-5. The Logo now should be your custom image.

Questions or comments

no

Contribution checklist (*)

• Pull request has a meaningful description of its purpose
• All commits are accompanied by meaningful commit messages
• All new or changed code is covered with unit/integration tests (if applicable)
• All automated tests passed successfully (all builds are green)

[m2-assistant]

Hi @mozok. Thank you for your contribution
Here is some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

• @magento give me test instance - deploy test instance based on PR changes
• @magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

• @magento run all tests - run or re-run all required tests against the PR changes
• @magento run <test-build(s)> - run or re-run specific test build(s)
  For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names. Allowed build names are:

1. Database Compare
2. Functional Tests CE
3. Functional Tests EE,
4. Functional Tests B2B
5. Integration Tests
6. Magento Health Index
7. Sample Data Tests CE
8. Sample Data Tests EE
9. Sample Data Tests B2B
10. Static Tests
11. Unit Tests
12. WebAPI Tests

You can find more information about the builds here

ℹ️ Please run only needed test builds instead of all when developing. Please run all test builds before sending your PR for review.

For more details, please, review the Magento Contributor Guide documentation.

⚠️ According to the Magento Contribution requirements, all Pull Requests must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 You can find the schedule on the Magento Community Calendar page.

📞 The triage of Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, please join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

[mozok]

@magento give me test instance

[magento-deployment-service]

Hi @mozok. Thank you for your request. I'm working on Magento instance for you.

[magento-deployment-service]

Hi @mozok, here is your Magento Instance: https://36f7c4dd56c3255766661f9a76fa8005.instances.magento-community.engineering
Admin access: https://36f7c4dd56c3255766661f9a76fa8005.instances.magento-community.engineering/admin_a28d
Login: 1cbed093
Password: 05d16208e412

[Stepa4man]

Hi @mozok
Thanks for your contribution

Please take a look at my comments and consider covering your functionality by tests. (I think integration test is the best fit here)

[Stepa4man]

Please change xsi:type, I believe it should be "object" instead of "helper"
Also for block it's better to use ViewModel

[mozok]

Here I rely on check in original Block class
\Magento\Theme\Block\Html\Header\Logo

public function getLogoSrc()
{
    if (empty($this->_data['logo_src'])) {
        $this->_data['logo_src'] = $this->_getLogoUrl();
    }
    return $this->_data['logo_src'];
}

So I want to inject result of my service class execution into 'logo_src' argument just in one layout.
I assume, that give me opportunity to change logo for one layout, and not modify original template/block class.

[mozok]

@magento run all tests

[mozok]

@magento run Integration Tests

[mozok]

@magento run Functional Tests EE

[mozok]

@magento run Functional Tests EE

[mozok]

@magento run Functional Tests EE

This test is failing on different 'flaky' tests (

[engcom-Bravo]

✔️ QA Passed

Manual testing scenario

1. Go to Storefront and Log In as Customer
2. Place an order
3. From Admin, Submit Invoice for the previously created order
4. Go to Customer Account - My Orders, and View the previously created order
5. Switch to Invoice tab, click Print Invoice
6. Observe the Logo in the printed file. Default Luma logo is displayed
   
7. From Admin, go to Stores - Configuration - Sales - Sales - 'Invoice and Packaging Slip Design' - 'Logo for HTML Print View' and Upload a custom image
8. Save config and clear Magento cache
9. Go to Storefront and Log in with the same Customer
10. Go to Customer Account - My Orders, and View the previously created order
11. Switch to Invoice tab, click Print Invoice
12. Observe the Logo in the printed file.

Before applying changes provided in the PR, the logo was the same Default Luma

Afters switching to the PR, the logo in the printed file has changed to the custom uploaded logo

[engcom-Bravo]

✔️ QA Passed

The result is the same as in the comment above

[gabrieldagama]

@magento run all tests

[mozok]

again error in "flaky" test)
@magento run Functional Tests B2B

[m2-assistant]

Hi @mozok, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.