Removed ely/email-renderer package and implemented new emails renderer client [skip ci]

common/components/EmailRenderer.php

@@ -1,71 +0,0 @@
-<?php
-namespace common\components;
-
-use Ely\Email\Renderer;
-use Ely\Email\TemplateBuilder;
-use Yii;
-use yii\base\Component;
-use yii\base\InvalidConfigException;
-
-class EmailRenderer extends Component {
-
-    /**
-     * @var string базовый путь после хоста. Должен начинаться слешем и заканчиваться без него.
-     * Например "/email-images"
-     */
-    public $basePath = '';
-
-    /**
-     * @var Renderer
-     */
-    private $renderer;
-
-    /**
-     * @var string
-     */
-    private $_baseDomain;
-
-    public function __construct(array $config = []) {
-        parent::__construct($config);
-
-        if ($this->_baseDomain === null) {
-            $this->_baseDomain = Yii::$app->urlManager->getHostInfo();
-            if ($this->_baseDomain === null) {
-                throw new InvalidConfigException('Cannot automatically obtain base domain');
-            }
-        }
-
-        $this->renderer = new Renderer($this->buildBasePath());
-    }
-
-    public function setBaseDomain(string $baseDomain) {
-        $this->_baseDomain = $baseDomain;
-        $this->renderer->setBaseDomain($this->buildBasePath());
-    }
-
-    public function getBaseDomain(): string {
-        return $this->_baseDomain;
-    }
-
-    /**
-     * @param string $templateName
-     * @return TemplateBuilder
-     */
-    public function getTemplate(string $templateName): TemplateBuilder {
-        return $this->renderer->getTemplate($templateName);
-    }
-
-    /**
-     * @param TemplateBuilder $template
-     * @throws \Ely\Email\RendererException
-     * @return string
-     */
-    public function render(TemplateBuilder $template): string {
-        return $this->renderer->render($template);
-    }
-
-    private function buildBasePath(): string {
-        return $this->_baseDomain . $this->basePath;
-    }
-
-}

common/components/EmailsRenderer/Api.php

@@ -0,0 +1,59 @@
+<?php
+declare(strict_types=1);
+
+namespace common\components\EmailsRenderer;
+
+use GuzzleHttp\Client as GuzzleClient;
+use GuzzleHttp\ClientInterface;
+
+class Api {
+
+    private $baseUrl;
+
+    /**
+     * @var ClientInterface
+     */
+    private $client;
+
+    public function __construct(string $baseUrl) {
+        $this->baseUrl = $baseUrl;
+    }
+
+    public function setClient(ClientInterface $client): void {
+        $this->client = $client;
+    }
+
+    /**
+     * @param \common\components\EmailsRenderer\Request\TemplateRequest $request
+     *
+     * @return string
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     */
+    public function getTemplate(Request\TemplateRequest $request): string {
+        return $this->getClient()
+            ->request('GET', "/templates/{$request->getLocale()}/{$request->getName()}", [
+                'query' => $request->getParams(),
+            ])
+            ->getBody()
+            ->getContents();
+    }
+
+    /**
+     * @return ClientInterface
+     */
+    protected function getClient(): ClientInterface {
+        if ($this->client === null) {
+            $this->client = $this->createDefaultClient();
+        }
+
+        return $this->client;
+    }
+
+    private function createDefaultClient(): ClientInterface {
+        return new GuzzleClient([
+            'timeout' => 5,
+            'base_uri' => $this->baseUrl,
+        ]);
+    }
+
+}

common/components/EmailsRenderer/Component.php

@@ -0,0 +1,89 @@
+<?php
+declare(strict_types=1);
+
+namespace common\components\EmailsRenderer;
+
+use common\components\EmailsRenderer\Request\TemplateRequest;
+use Yii;
+use yii\base\InvalidConfigException;
+use yii\helpers\ArrayHelper;
+use yii\helpers\FileHelper;
+
+/**
+ * @property string $baseDomain
+ */
+class Component extends \yii\base\Component implements RendererInterface {
+
+    /**
+     * @var string The address of the templates rendering service.
+     */
+    public $serviceUrl;
+
+    /**
+     * @var string базовый путь после хоста. Должен начинаться слешем и заканчиваться без него.
+     * Например "/email-images"
+     */
+    public $basePath = '';
+
+    /**
+     * @var Api
+     */
+    private $api;
+
+    /**
+     * @var string
+     */
+    private $_baseDomain;
+
+    public function init(): void {
+        parent::init();
+
+        if ($this->serviceUrl === null) {
+            throw new InvalidConfigException('serviceUrl is required');
+        }
+
+        if ($this->_baseDomain === null) {
+            $this->_baseDomain = Yii::$app->urlManager->getHostInfo();
+            if ($this->_baseDomain === null) {
+                throw new InvalidConfigException('Cannot automatically obtain base domain');
+            }
+        }
+    }
+
+    public function setBaseDomain(string $baseDomain): void {
+        $this->_baseDomain = $baseDomain;
+    }
+
+    public function getBaseDomain(): string {
+        return $this->_baseDomain;
+    }
+
+    /**
+     * @param string $templateName
+     * @param string $locale
+     * @param array $params
+     *
+     * @return string
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     */
+    public function render(string $templateName, string $locale, array $params = []): string {
+        $request = new TemplateRequest($templateName, $locale, ArrayHelper::merge($params, [
+            'assetsHost' => $this->buildBasePath(),
+        ]));
+
+        return $this->getApi()->getTemplate($request);
+    }
+
+    private function getApi(): Api {
+        if ($this->api === null) {
+            $this->api = new Api($this->serviceUrl);
+        }
+
+        return $this->api;
+    }
+
+    private function buildBasePath(): string {
+        return FileHelper::normalizePath($this->_baseDomain . '/' . $this->basePath, '/');
+    }
+
+}

common/components/EmailsRenderer/RendererInterface.php

@@ -0,0 +1,10 @@
+<?php
+declare(strict_types=1);
+
+namespace common\components\EmailsRenderer;
+
+interface RendererInterface {
+
+    public function render(string $templateName, string $locale, array $params = []): string;
+
+}

common/components/EmailsRenderer/Request/TemplateRequest.php

@@ -0,0 +1,41 @@
+<?php
+declare(strict_types=1);
+
+namespace common\components\EmailsRenderer\Request;
+
+class TemplateRequest {
+
+    /**
+     * @var string
+     */
+    private $name;
+
+    /**
+     * @var string
+     */
+    private $locale;
+
+    /**
+     * @var array
+     */
+    private $params;
+
+    public function __construct(string $name, string $locale, array $params) {
+        $this->name = $name;
+        $this->locale = $locale;
+        $this->params = $params;
+    }
+
+    public function getName(): string {
+        return $this->name;
+    }
+
+    public function getLocale(): string {
+        return $this->locale;
+    }
+
+    public function getParams(): array {
+        return $this->params;
+    }
+
+}

common/config/config.php

@@ -89,8 +89,9 @@ return [
         'guzzle' => [
             'class' => GuzzleHttp\Client::class,
         ],
-        'emailRenderer' => [
-            'class' => common\components\EmailRenderer::class,
+        'emailsRenderer' => [
+            'class' => common\components\EmailsRenderer\Component::class,
+            'serviceUrl' => getenv('EMAILS_RENDERER_HOST'),
             'basePath' => '/images/emails',
         ],
         'oauth' => [

common/emails/EmailHelper.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 namespace common\emails;
 
 class EmailHelper {

common/emails/Template.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 namespace common\emails;
 
 use common\emails\exceptions\CannotSendEmailException;
@@ -20,7 +22,8 @@ abstract class Template {
     private $to;
 
     /**
-     * @param string|array $to получатель письма. Задаётся как Email или как массив [email => name]
+     * @param string|array $to message receiver. Can be passed as string (pure email)
+     *                         or as an array [email => user's name]
      */
     public function __construct($to) {
         $this->mailer = Yii::$app->mailer;

common/emails/TemplateWithRenderer.php

@@ -1,16 +1,19 @@
 <?php
+declare(strict_types=1);
+
 namespace common\emails;
 
-use common\components\EmailRenderer;
-use Yii;
+use common\components\EmailsRenderer\RendererInterface;
+use ErrorException;
+use Exception;
 use yii\mail\MessageInterface;
 
 abstract class TemplateWithRenderer extends Template {
 
     /**
-     * @var EmailRenderer
+     * @var RendererInterface
      */
-    private $emailRenderer;
+    private $renderer;
 
     /**
      * @var string
@@ -20,18 +23,18 @@ abstract class TemplateWithRenderer extends Template {
     /**
      * @inheritdoc
      */
-    public function __construct($to, string $locale) {
+    public function __construct($to, string $locale, RendererInterface $renderer) {
         parent::__construct($to);
-        $this->emailRenderer = Yii::$app->emailRenderer;
         $this->locale = $locale;
+        $this->renderer = $renderer;
     }
 
     public function getLocale(): string {
         return $this->locale;
     }
 
-    public function getEmailRenderer(): EmailRenderer {
-        return $this->emailRenderer;
+    public function getRenderer(): RendererInterface {
+        return $this->renderer;
     }
 
     /**
@@ -46,6 +49,10 @@ abstract class TemplateWithRenderer extends Template {
         return $this->getTemplateName();
     }
 
+    /**
+     * @return MessageInterface
+     * @throws ErrorException
+     */
     protected function createMessage(): MessageInterface {
         return $this->getMailer()
             ->compose()
@@ -55,12 +62,16 @@ abstract class TemplateWithRenderer extends Template {
             ->setSubject($this->getSubject());
     }
 
+    /**
+     * @return string
+     * @throws ErrorException
+     */
     private function render(): string {
-        return $this->getEmailRenderer()
-            ->getTemplate($this->getTemplateName())
-            ->setLocale($this->getLocale())
-            ->setParams($this->getParams())
-            ->render();
+        try {
+            return $this->getRenderer()->render($this->getTemplateName(), $this->getLocale(), $this->getParams());
+        } catch (Exception $e) {
+            throw new ErrorException('Unable to render the template', 0, 1, __FILE__, __LINE__, $e);
+        }
     }
 
 }

common/emails/exceptions/CannotSendEmailException.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 namespace common\emails\exceptions;
 
 use Exception;

common/emails/templates/ChangeEmailConfirmCurrentEmail.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 namespace common\emails\templates;
 
 use common\emails\Template;

common/emails/templates/ChangeEmailConfirmNewEmail.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 namespace common\emails\templates;
 
 use common\emails\Template;

common/emails/templates/ForgotPasswordEmail.php

@@ -1,6 +1,9 @@
 <?php
+declare(strict_types=1);
+
 namespace common\emails\templates;
 
+use common\components\EmailsRenderer\RendererInterface;
 use common\emails\TemplateWithRenderer;
 
 class ForgotPasswordEmail extends TemplateWithRenderer {
@@ -10,8 +13,8 @@ class ForgotPasswordEmail extends TemplateWithRenderer {
     /**
      * @inheritdoc
      */
-    public function __construct($to, string $locale, ForgotPasswordParams $params) {
-        TemplateWithRenderer::__construct($to, $locale);
+    public function __construct($to, string $locale, ForgotPasswordParams $params, RendererInterface $renderer) {
+        parent::__construct($to, $locale, $renderer);
         $this->params = $params;
     }
 

common/emails/templates/ForgotPasswordParams.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 namespace common\emails\templates;
 
 class ForgotPasswordParams {

common/emails/templates/RegistrationEmail.php

@@ -1,6 +1,9 @@
 <?php
+declare(strict_types=1);
+
 namespace common\emails\templates;
 
+use common\components\EmailsRenderer\RendererInterface;
 use common\emails\TemplateWithRenderer;
 
 class RegistrationEmail extends TemplateWithRenderer {
@@ -10,8 +13,8 @@ class RegistrationEmail extends TemplateWithRenderer {
     /**
      * @inheritdoc
      */
-    public function __construct($to, string $locale, RegistrationEmailParams $params) {
-        TemplateWithRenderer::__construct($to, $locale);
+    public function __construct($to, string $locale, RegistrationEmailParams $params, RendererInterface $renderer) {
+        parent::__construct($to, $locale, $renderer);
         $this->params = $params;
     }
 

common/emails/templates/RegistrationEmailParams.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 namespace common\emails\templates;
 
 class RegistrationEmailParams {

common/tasks/SendPasswordRecoveryEmail.php

@@ -50,7 +50,7 @@ class SendPasswordRecoveryEmail implements RetryableJobInterface {
         Yii::$app->statsd->inc('queue.sendPasswordRecovery.attempt');
         $params = new ForgotPasswordParams($this->username, $this->code, $this->link);
         $to = EmailHelper::buildTo($this->username, $this->email);
-        $template = new ForgotPasswordEmail($to, $this->locale, $params);
+        $template = new ForgotPasswordEmail($to, $this->locale, $params, Yii::$app->emailsRenderer);
         $template->send();
     }
 

common/tasks/SendRegistrationEmail.php

@@ -50,7 +50,7 @@ class SendRegistrationEmail implements RetryableJobInterface {
         Yii::$app->statsd->inc('queue.sendRegistrationEmail.attempt');
         $params = new RegistrationEmailParams($this->username, $this->code, $this->link);
         $to = EmailHelper::buildTo($this->username, $this->email);
-        $template = new RegistrationEmail($to, $this->locale, $params);
+        $template = new RegistrationEmail($to, $this->locale, $params, Yii::$app->emailsRenderer);
         $template->send();
     }
 

common/tests/unit/emails/TemplateWithRendererTest.php

@@ -1,7 +1,7 @@
 <?php
 namespace common\tests\unit\emails;
 
-use common\components\EmailRenderer;
+use common\components\EmailsRenderer\Component;
 use common\emails\TemplateWithRenderer;
 use common\tests\_support\ProtectedCaller;
 use common\tests\unit\TestCase;
@@ -18,7 +18,7 @@ class TemplateWithRendererTest extends TestCase {
         $this->assertSame('mock-to', $template->getTo());
         $this->assertSame('mock-locale', $template->getLocale());
         $this->assertInstanceOf(MailerInterface::class, $template->getMailer());
-        $this->assertInstanceOf(EmailRenderer::class, $template->getEmailRenderer());
+        $this->assertInstanceOf(Component::class, $template->getRenderer());
     }
 
     public function testCreateMessage() {
@@ -26,8 +26,8 @@ class TemplateWithRendererTest extends TestCase {
         $templateBuilder = mock(TemplateBuilder::class)->makePartial();
         $templateBuilder->shouldReceive('render')->andReturn('mock-html');
 
-        /** @var EmailRenderer|\Mockery\MockInterface $renderer */
-        $renderer = mock(EmailRenderer::class)->makePartial();
+        /** @var Component|\Mockery\MockInterface $renderer */
+        $renderer = mock(Component::class)->makePartial();
         $renderer->shouldReceive('getTemplate')->with('mock-template')->andReturn($templateBuilder);
 
         /** @var TemplateWithRenderer|\Mockery\MockInterface $template */