Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Can't translate email templates sent via a CLI command #38202

Open
1 of 5 tasks
ioweb-gr opened this issue Nov 18, 2023 · 7 comments
Open
1 of 5 tasks

Can't translate email templates sent via a CLI command #38202

ioweb-gr opened this issue Nov 18, 2023 · 7 comments
Labels
Area: Framework Component: Translation Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed Priority: P3 May be fixed according to the position in the backlog. Progress: ready for dev Reported on 2.4.1 Indicates original Magento version for the Issue report. Reproduced on 2.4.x The issue has been reproduced on latest 2.4-develop branch Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it

Comments

@ioweb-gr
Copy link
Contributor

ioweb-gr commented Nov 18, 2023

Preconditions and environment

  • 2.4.1

Steps to reproduce

Here's a sample service class that sends an email using a template

<?php
/*
 * Copyright (c) 2022. IOWEB TECHNOLOGIES
 */

namespace Ioweb\Base\Service;

use Exception;
use Magento\Framework\App\Area;
use Magento\Framework\Escaper;
use Magento\Framework\Mail\MailMessageInterfaceFactory;
use Magento\Framework\Mail\MessageInterfaceFactory;
use Magento\Framework\Mail\Template\TransportBuilder;
use Magento\Framework\Mail\TransportInterfaceFactory;
use Magento\Framework\Translate\Inline\StateInterface;
use Magento\Store\Model\StoreManagerInterface;

class MailWithTemplate
{
    protected $escaper;
    protected $inlineTranslation;
    protected $mailTransportFactory;
    protected $messageInterfaceFactory;
    protected $storeManager;
    protected $transportBuilder;

    public function __construct(
        StateInterface            $inlineTranslation,
        Escaper                   $escaper,
        TransportBuilder          $transportBuilder,
        MessageInterfaceFactory   $messageInterfaceFactory,
        TransportInterfaceFactory $mailTransportFactory,
        StoreManagerInterface     $storeManager
    )
    {
        $this->inlineTranslation = $inlineTranslation;
        $this->escaper = $escaper;
        $this->transportBuilder = $transportBuilder;
        $this->messageInterfaceFactory = $messageInterfaceFactory;
        $this->mailTransportFactory = $mailTransportFactory;
        $this->storeManager = $storeManager;
    }

    /**
     * @param array $from [name, email]
     * @param $to
     * @param $templateIdentifier
     * @param $vars
     * @return void
     */
    public function execute($from, $to, $templateIdentifier, $vars, $storeId = null, $area = Area::AREA_FRONTEND)
    {
        try {
            $this->inlineTranslation->suspend();
            $this->transportBuilder->setTemplateIdentifier($templateIdentifier);
            $this->transportBuilder->setTemplateOptions(
                [
                    'area' => !empty($area) ? $area : Area::AREA_FRONTEND,
                    'store' => !empty($storeId) ? $storeId : $this->storeManager->getStore()->getId(),
                ]
            );
            $this->transportBuilder->setTemplateVars($vars);
            $this->transportBuilder
                ->setFromByScope($from)
                ->addTo($to, $to);

            $transport = $this->transportBuilder->getTransport();
            $transport->sendMessage();
            $this->inlineTranslation->resume();
        } catch (Exception $e) {
            return;
        }
    }
}

I'm now trying in a CLI command to send an email template using this service class for storeId 5 which is using Greek locale.

I've added the proper translation files but the message keeps sending in english.

Header / Footer are loaded from english store

Here's my email template

<!-- Email subject -->
<!--@subject {{trans "Enjoy Your Exclusive Black Friday Discount!"}}  @-->

{{template config_path="design/email/header_template"}}

<!-- Header -->
<h1 style="text-align: center">{{trans 'Black Friday Special!'}}</h1>

<!-- Main Content -->
<div>
    <div class="content io-content">
        <p>{{trans 'We are thrilled to offer you an exclusive Black Friday discount for your recent order %increment_id! Use the coupon code below to enjoy special savings on your next purchase.' increment_id=$increment_id}}</p>

        <!-- Coupon Code -->
        <p><strong>{{trans 'Coupon Code:'}}</strong> {{var coupon_code}}</p>

        <!-- Expiration Date -->
        <p><strong>{{trans 'Expires On:'}}</strong> {{var expiration_date|raw}}</p>
    </div>
</div>

<!-- Footer -->
{{template config_path="design/email/footer_template"}}

Expected result

Message is sent translated

Actual result

Message is using default English locale

Additional information

No response

Release note

No response

Triage and priority

  • Severity: S0 - Affects critical data or functionality and leaves users without workaround.
  • Severity: S1 - Affects critical data or functionality and forces users to employ a workaround.
  • Severity: S2 - Affects non-critical data or functionality and forces users to employ a workaround.
  • Severity: S3 - Affects non-critical data or functionality and does not force users to employ a workaround.
  • Severity: S4 - Affects aesthetics, professional look and feel, “quality” or “usability”.
Copy link

m2-assistant bot commented Nov 18, 2023

Hi @ioweb-gr. Thank you for your report.
To speed up processing of this issue, make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, Add a comment to the issue:


Join Magento Community Engineering Slack and ask your questions in #github channel.
⚠️ According to the Magento Contribution requirements, all issues 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 issues happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.

@ioweb-gr
Copy link
Contributor Author

It seems in order to make them translate I had to follow the solution from this commit for a similar issue

1455889

                $areaModel = $this->areaList->getArea($this->appState->getAreaCode());
                $areaModel->load(Area::PART_DESIGN);
                $areaModel->load(Area::PART_TRANSLATE);

I think this is missing from the template rendering where it's processing the design parameters added by

$this->transportBuilder->setTemplateOptions([])

@engcom-Bravo engcom-Bravo added Reported on 2.4.1 Indicates original Magento version for the Issue report. Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it labels Nov 20, 2023
@engcom-November engcom-November self-assigned this Nov 23, 2023
Copy link

m2-assistant bot commented Nov 23, 2023

Hi @engcom-November. 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).
  • 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue.
  • 3. Add Area: XXXXX label to the ticket, indicating the functional areas it may be related to.
  • 4. Verify that the issue is reproducible on 2.4-develop branch
    Details- Add the comment @magento give me 2.4-develop instance to deploy test instance on Magento infrastructure.
    - If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.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-November
Copy link
Contributor

engcom-November commented Nov 23, 2023

Hello @ioweb-gr,

Thank you for the report and collaboration!

We were able to reproduce this issue on 2.4-develop.
We created a custom module with German language pack installed.
Please take a look at the screenshot below:
image
Here we are sending the email through CLI for store id 2(which is German store), and we were not able to get the translated message.
Hence confirming the issue.

Please find the attached custom module used to reproduce this issue.
EmailVendor.zip

Thank you.

@engcom-November engcom-November added Component: Translation Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed Reproduced on 2.4.x The issue has been reproduced on latest 2.4-develop branch Area: Framework labels Nov 23, 2023
@github-jira-sync-bot
Copy link

✅ Jira issue https://jira.corp.adobe.com/browse/AC-10597 is successfully created for this GitHub issue.

Copy link

m2-assistant bot commented Nov 23, 2023

✅ Confirmed by @engcom-November. Thank you for verifying the issue.
Issue Available: @engcom-November, You will be automatically unassigned. Contributors/Maintainers can claim this issue to continue. To reclaim and continue work, reassign the ticket to yourself.

@ioweb-gr
Copy link
Contributor Author

Thanks for verifying. Also as a side note this is a bug that does not exist in 2.3.2

@engcom-November engcom-November added the Priority: P3 May be fixed according to the position in the backlog. label Nov 24, 2023
@engcom-Hotel engcom-Hotel moved this to Ready for Development in Low Priority Backlog Aug 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Framework Component: Translation Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed Priority: P3 May be fixed according to the position in the backlog. Progress: ready for dev Reported on 2.4.1 Indicates original Magento version for the Issue report. Reproduced on 2.4.x The issue has been reproduced on latest 2.4-develop branch Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it
Projects
Status: Ready for Development
Development

No branches or pull requests

4 participants