Custom attributes of images generated by Block\Product\ImageFactory don't render correctly

[chris-pook]

(i) This ticket is created automatically based on a verified GitHub issue.

{panel}
If you are starting to work on this Jira ticket, please notify issue reporter and authors of related community pull requests (if any) that you are going to work on this issue:

1. Assign #25219 issue to yourself on Magento GitHub
2. Add comment "Internal Magento team is working on this issue right now."
   {panel}
   When using the core product image factory it is no longer possible to add your own custom attributes to the markup produced, due to incorrect escaping of the html output.

######Preconditions

1. Install Magento 2.3.3 & 2.3-develop

######Steps to reproduce (*)

1. Within a block or viewModel use the \Magento\Catalog\Block\Product\ImageFactory class to create a Magento\Catalog\Block\Product\Image. Set a custom attribute "data-sku" with the value of the product's sku and render the image in a frontend template:

$attributes = <
    'data-sku' => $product->getSku()
>;

$image = $this->imageFactory->create($product, $imageId, $attributes);

######Expected result
The image html should render with each of the custom attribute values returned by getCustomAttributes() escaped. In this example <img data-sku="<sku>" />.

######Actual result (*)
The image renders with the entire getCustomAttributes() string escaped meaning the html is invalid and the attribute is not available on the html element. In this example <img &#x20;data-sku&#x3d;&quot;<sku>&quot; />.

This stems from an over zealous use of escapeHtmlAttr() here: f40f24c#diff-eed94ca7983b385a07b8fb5ee2dbc20d

[m2-assistant]

Hi @chris-pook. Thank you for your report.
To help us process this issue please make sure that you provided the following information:

• Summary of the issue
• Information on your environment
• Steps to reproduce
• Expected and actual results

Please make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, please, add a comment to the issue:

@magento give me 2.3-develop instance - upcoming 2.3.x release

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

@chris-pook do you confirm that you were able to reproduce the issue on vanilla Magento instance following steps to reproduce?

• yes
• no

---

• Join Magento Community Engineering Slack and ask your questions in #github channel.

[m2-assistant]

Hi @engcom-Charlie. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

• 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).

  Details

  If the issue has a valid description, the label Issue: Format is valid will be added to the issue automatically. Please, edit issue description if needed, until label Issue: Format is valid appears.

• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add Issue: Clear Description label to the issue by yourself.

• 3. Add Component: XXXXX label(s) to the ticket, indicating the components it may be related to.

• 4. Verify that the issue is reproducible on 2.3-develop branch

  Details

  - Add the comment @magento give me 2.3-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.3-develop branch, please, add the label Reproduced on 2.3.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!

• 5. Add label Issue: Confirmed once verification is complete.

• 6. Make sure that automatic system confirms that report has been added to the backlog.

[engcom-Charlie]

Hello @chris-pook
ImageBuilder class is deprecated(will be deleted at next release).

Please use ImageFactory for your actions.

So i have to close this issue.
Thanks for your report!

[chris-pook]

Fair enough. Thanks.

[chris-pook]

This still seems to be an issue with ImageFactory. The same template vendor/magento/module-catalog/view/frontend/templates/product/image_with_borders.phtml will render the image and this is where the escaping issue is happening.

[engcom-Charlie]

@chris-pook could you update the description of issue and add new steps?

[engcom-Charlie]

We are closing this issue due to inactivity. If you'd like to update it, please reopen the issue.

[chris-pook]

Updated description and description to reflect use of ImageFactory to replicate this issue.

[engcom-Charlie]

@chris-pook Thank you for contribution and collaboration!
I can confirm this issue now.

[magento-engcom-team]

✅ Confirmed by @engcom-Charlie
Thank you for verifying the issue. Based on the provided information internal tickets MC-23137 were created

Issue Available: @engcom-Charlie, You will be automatically unassigned. Contributors/Maintainers can claim this issue to continue. To reclaim and continue work, reassign the ticket to yourself.

[magento-engcom-team]

Hi @chris-pook. Thank you for your report.
The issue has been fixed in #26959 by @alexander-aleman in 2.4-develop branch
Related commit(s):

• 6a8a103ce27d872e5687402a50ba6e594ae82194
• 4d3a05d101723432d8610160552b563c25cc3703
• b0ccd4f9fed45147101195d71a7af298d4d8ff4b
• 79025f879e94c8b409a7d792588e4fe30ea14f36
• 5e84595da92ba3788edac27d8f35bc9a0e0e9d27
• afac7ead70c7c11329c56d3264ee51df655dc995
• c9ad76f5aaa100ff676eb52470e2136236b85249
• 9fa7ece9756d255cb11aee0a0489d631e36f91c1

The fix will be available with the upcoming 2.4.0 release.