From 63db3adca9ead65f1c85590d8a939b5bc4d1d152 Mon Sep 17 00:00:00 2001
From: ErickSkrauch <erickskrauch@yandex.ru>
Date: Sun, 19 Nov 2017 18:32:51 +0300
Subject: [PATCH] =?UTF-8?q?=D0=94=D0=BE=D0=B1=D0=B0=D0=B2=D0=BB=D0=B5?=
 =?UTF-8?q?=D0=BD=D0=B0=20=D0=B0=D0=BD=D0=BD=D0=BE=D1=82=D0=B0=D1=86=D0=B8?=
 =?UTF-8?q?=D1=8F=20=D0=B4=D0=BB=D1=8F=20=D1=81=D0=B1=D0=BE=D1=80=D0=B0=20?=
 =?UTF-8?q?=D0=BC=D0=B5=D1=82=D1=80=D0=B8=D0=BA=20=D0=B8=D0=B7=20=D0=BC?=
 =?UTF-8?q?=D0=BE=D0=B4=D0=B5=D0=BB=D0=B5=D0=B9=20Yii2=20=D0=B8=20=D0=B8?=
 =?UTF-8?q?=D0=BD=D1=82=D0=B5=D0=B3=D1=80=D0=B8=D1=80=D0=BE=D0=B2=D0=B0?=
 =?UTF-8?q?=D0=BD=D0=B0=20=D0=B2=20=D1=84=D0=BE=D1=80=D0=BC=D1=8B=20=D0=B0?=
 =?UTF-8?q?=D0=B2=D1=82=D0=BE=D1=80=D0=B8=D0=B7=D0=B0=D1=86=D0=B8=D0=B8=20?=
 =?UTF-8?q?=D0=B8=20=D1=80=D0=B5=D0=B3=D0=B8=D1=81=D1=82=D1=80=D0=B0=D1=86?=
 =?UTF-8?q?=D0=B8=D0=B8?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 api/aop/AspectKernel.php                      |  1 +
 api/aop/annotations/CollectModelMetrics.php   | 19 +++++++++
 api/aop/aspects/CollectMetricsAspect.php      | 41 +++++++++++++++++++
 .../authentication/ConfirmEmailForm.php       |  2 +
 .../authentication/ForgotPasswordForm.php     |  6 +++
 api/models/authentication/LoginForm.php       |  2 +
 api/models/authentication/LogoutForm.php      |  8 +++-
 .../authentication/RecoverPasswordForm.php    |  2 +
 .../authentication/RefreshTokenForm.php       |  2 +
 .../authentication/RegistrationForm.php       |  2 +
 .../RepeatAccountActivationForm.php           |  6 +++
 11 files changed, 90 insertions(+), 1 deletion(-)
 create mode 100644 api/aop/annotations/CollectModelMetrics.php
 create mode 100644 api/aop/aspects/CollectMetricsAspect.php

diff --git a/api/aop/AspectKernel.php b/api/aop/AspectKernel.php
index 79cc8ed..fc30542 100644
--- a/api/aop/AspectKernel.php
+++ b/api/aop/AspectKernel.php
@@ -9,6 +9,7 @@ class AspectKernel extends BaseAspectKernel {
 
     protected function configureAop(AspectContainer $container): void {
         $container->registerAspect(new aspects\MockDataAspect());
+        $container->registerAspect(new aspects\CollectMetricsAspect());
     }
 
 }
diff --git a/api/aop/annotations/CollectModelMetrics.php b/api/aop/annotations/CollectModelMetrics.php
new file mode 100644
index 0000000..4614c91
--- /dev/null
+++ b/api/aop/annotations/CollectModelMetrics.php
@@ -0,0 +1,19 @@
+<?php
+namespace api\aop\annotations;
+
+use Doctrine\Common\Annotations\Annotation;
+use Doctrine\Common\Annotations\Annotation\Required;
+
+/**
+ * @Annotation
+ * @Target("METHOD")
+ */
+class CollectModelMetrics {
+
+    /**
+     * @Required()
+     * @var string задаёт префикс для отправки метрик. Задаётся без ведущей и без завершающей точки.
+     */
+    public $prefix = '';
+
+}
diff --git a/api/aop/aspects/CollectMetricsAspect.php b/api/aop/aspects/CollectMetricsAspect.php
new file mode 100644
index 0000000..6cd88b8
--- /dev/null
+++ b/api/aop/aspects/CollectMetricsAspect.php
@@ -0,0 +1,41 @@
+<?php
+namespace api\aop\aspects;
+
+use api\aop\annotations\CollectModelMetrics;
+use Go\Aop\Aspect;
+use Go\Aop\Intercept\MethodInvocation;
+use Go\Lang\Annotation\Around;
+use Yii;
+
+class CollectMetricsAspect implements Aspect {
+
+    /**
+     * @param MethodInvocation $invocation Invocation
+     * @Around("@execution(api\aop\annotations\CollectModelMetrics)")
+     */
+    public function sendMetrics(MethodInvocation $invocation) {
+        /** @var CollectModelMetrics $annotation */
+        $annotation = $invocation->getMethod()->getAnnotation(CollectModelMetrics::class);
+        $prefix = trim($annotation->prefix, '.');
+
+        Yii::$app->statsd->inc($prefix . '.attempt');
+        $result = $invocation->proceed();
+        if ($result !== false) {
+            Yii::$app->statsd->inc($prefix . '.success');
+            return $result;
+        }
+
+        /** @var \yii\base\Model $model */
+        $model = $invocation->getThis();
+        $errors = array_values($model->getFirstErrors());
+        if (!isset($errors[0])) {
+            Yii::error('Unsuccess result with empty errors list');
+            return false;
+        }
+
+        Yii::$app->statsd->inc($prefix . '.' . $errors[0]);
+
+        return false;
+    }
+
+}
diff --git a/api/models/authentication/ConfirmEmailForm.php b/api/models/authentication/ConfirmEmailForm.php
index ac5f78f..c813ac0 100644
--- a/api/models/authentication/ConfirmEmailForm.php
+++ b/api/models/authentication/ConfirmEmailForm.php
@@ -1,6 +1,7 @@
 <?php
 namespace api\models\authentication;
 
+use api\aop\annotations\CollectModelMetrics;
 use api\models\base\ApiForm;
 use api\modules\accounts\models\ChangeUsernameForm;
 use api\validators\EmailActivationKeyValidator;
@@ -20,6 +21,7 @@ class ConfirmEmailForm extends ApiForm {
     }
 
     /**
+     * @CollectModelMetrics(prefix="signup.confirmEmail")
      * @return \api\components\User\AuthenticationResult|bool
      * @throws ErrorException
      */
diff --git a/api/models/authentication/ForgotPasswordForm.php b/api/models/authentication/ForgotPasswordForm.php
index 4c92256..8b2f52b 100644
--- a/api/models/authentication/ForgotPasswordForm.php
+++ b/api/models/authentication/ForgotPasswordForm.php
@@ -1,6 +1,7 @@
 <?php
 namespace api\models\authentication;
 
+use api\aop\annotations\CollectModelMetrics;
 use api\components\ReCaptcha\Validator as ReCaptchaValidator;
 use api\models\base\ApiForm;
 use common\emails\EmailHelper;
@@ -55,6 +56,11 @@ class ForgotPasswordForm extends ApiForm {
         }
     }
 
+    /**
+     * @CollectModelMetrics(prefix="authentication.forgotPassword")
+     * @return bool
+     * @throws ErrorException
+     */
     public function forgotPassword() {
         if (!$this->validate()) {
             return false;
diff --git a/api/models/authentication/LoginForm.php b/api/models/authentication/LoginForm.php
index 1e51eed..c5a2948 100644
--- a/api/models/authentication/LoginForm.php
+++ b/api/models/authentication/LoginForm.php
@@ -1,6 +1,7 @@
 <?php
 namespace api\models\authentication;
 
+use api\aop\annotations\CollectModelMetrics;
 use api\models\base\ApiForm;
 use api\validators\TotpValidator;
 use common\helpers\Error as E;
@@ -87,6 +88,7 @@ class LoginForm extends ApiForm {
     }
 
     /**
+     * @CollectModelMetrics(prefix="authentication.login")
      * @return \api\components\User\AuthenticationResult|bool
      */
     public function login() {
diff --git a/api/models/authentication/LogoutForm.php b/api/models/authentication/LogoutForm.php
index 64daf42..8028c68 100644
--- a/api/models/authentication/LogoutForm.php
+++ b/api/models/authentication/LogoutForm.php
@@ -1,12 +1,18 @@
 <?php
 namespace api\models\authentication;
 
+use api\aop\annotations\CollectModelMetrics;
 use api\models\base\ApiForm;
+use Yii;
 
 class LogoutForm extends ApiForm {
 
+    /**
+     * @CollectModelMetrics(prefix="authentication.logout")
+     * @return bool
+     */
     public function logout() : bool {
-        $component = \Yii::$app->user;
+        $component = Yii::$app->user;
         $session = $component->getActiveSession();
         if ($session === null) {
             return true;
diff --git a/api/models/authentication/RecoverPasswordForm.php b/api/models/authentication/RecoverPasswordForm.php
index ce21498..358fec0 100644
--- a/api/models/authentication/RecoverPasswordForm.php
+++ b/api/models/authentication/RecoverPasswordForm.php
@@ -1,6 +1,7 @@
 <?php
 namespace api\models\authentication;
 
+use api\aop\annotations\CollectModelMetrics;
 use api\models\base\ApiForm;
 use api\validators\EmailActivationKeyValidator;
 use common\helpers\Error as E;
@@ -36,6 +37,7 @@ class RecoverPasswordForm extends ApiForm {
     }
 
     /**
+     * @CollectModelMetrics(prefix="authentication.recoverPassword")
      * @return \api\components\User\AuthenticationResult|bool
      * @throws ErrorException
      */
diff --git a/api/models/authentication/RefreshTokenForm.php b/api/models/authentication/RefreshTokenForm.php
index ece51da..378f3af 100644
--- a/api/models/authentication/RefreshTokenForm.php
+++ b/api/models/authentication/RefreshTokenForm.php
@@ -1,6 +1,7 @@
 <?php
 namespace api\models\authentication;
 
+use api\aop\annotations\CollectModelMetrics;
 use api\models\base\ApiForm;
 use common\helpers\Error as E;
 use common\models\AccountSession;
@@ -32,6 +33,7 @@ class RefreshTokenForm extends ApiForm {
     }
 
     /**
+     * @CollectModelMetrics(prefix="authentication.renew")
      * @return \api\components\User\AuthenticationResult|bool
      */
     public function renew() {
diff --git a/api/models/authentication/RegistrationForm.php b/api/models/authentication/RegistrationForm.php
index 40fb293..743b1e4 100644
--- a/api/models/authentication/RegistrationForm.php
+++ b/api/models/authentication/RegistrationForm.php
@@ -1,6 +1,7 @@
 <?php
 namespace api\models\authentication;
 
+use api\aop\annotations\CollectModelMetrics;
 use api\components\ReCaptcha\Validator as ReCaptchaValidator;
 use common\emails\EmailHelper;
 use api\models\base\ApiForm;
@@ -63,6 +64,7 @@ class RegistrationForm extends ApiForm {
     }
 
     /**
+     * @CollectModelMetrics(prefix="signup.register")
      * @return Account|null the saved model or null if saving fails
      * @throws Exception
      */
diff --git a/api/models/authentication/RepeatAccountActivationForm.php b/api/models/authentication/RepeatAccountActivationForm.php
index a687052..58d6c35 100644
--- a/api/models/authentication/RepeatAccountActivationForm.php
+++ b/api/models/authentication/RepeatAccountActivationForm.php
@@ -1,6 +1,7 @@
 <?php
 namespace api\models\authentication;
 
+use api\aop\annotations\CollectModelMetrics;
 use api\components\ReCaptcha\Validator as ReCaptchaValidator;
 use common\emails\EmailHelper;
 use api\models\base\ApiForm;
@@ -53,6 +54,11 @@ class RepeatAccountActivationForm extends ApiForm {
         }
     }
 
+    /**
+     * @CollectModelMetrics(prefix="signup.repeatEmail")
+     * @return bool
+     * @throws ErrorException
+     */
     public function sendRepeatMessage() {
         if (!$this->validate()) {
             return false;